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/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/Text/CTPL.hs b/Text/CTPL.hs new file mode 100644 --- /dev/null +++ b/Text/CTPL.hs @@ -0,0 +1,563 @@ +module Text.CTPL where + +import Control.Monad +import Data.Char +import Data.Monoid +import Text.Chatty.Parser +import Text.Chatty.Parser.Carrier +import qualified Text.CTPL0 as Null + +data Procedure = Procedure { procName :: String, procInstr :: Instruction, procAddr :: Int } +data CTPLState = CTPLState { definedProcs :: [Procedure] } +data Exec a = Succ a | NoSuchProc String | SyntaxFault deriving Show +data CTPL a = CTPL { runCTPL :: CTPLState -> Exec (a, CTPLState, String -> String) } + +instance Monad Exec where + return a = Succ a + (Succ a) >>= f = f a + (NoSuchProc s) >>= f = NoSuchProc s + SyntaxFault >>= f = SyntaxFault + +instance Monad CTPL where + return a = CTPL $ \s -> return (a, s, id) + m >>= f = CTPL $ \s -> do + (a', s', f') <- runCTPL m s + (a'', s'', f'') <- runCTPL (f a') s' + return (a'', s'', f' . f'') + +getState :: (CTPLState -> a) -> CTPL a +getState f = CTPL $ \s -> return (f s, s, id) + +modState :: (CTPLState -> CTPLState) -> CTPL () +modState f = CTPL $ \s -> return ((), f s, id) + +emit :: String -> CTPL () +emit str = CTPL $ \s -> return ((), s, (str++)) + +getProc :: String -> (Procedure -> a) -> CTPL a +getProc nm f = do + ps <- getState definedProcs + case filter (\p -> procName p == nm) ps of + [] -> CTPL $ \_ -> NoSuchProc nm + [p] -> return (f p) + +catchEmission :: CTPL () -> CTPL String +catchEmission m = CTPL $ \s -> do + (_,s',f') <- runCTPL m s + return (f' [], s', id) + +discardEmission :: CTPL a -> CTPL a +discardEmission m = CTPL $ \s -> do + (a,s',_) <- runCTPL m s + return (a, s', id) + +data NumSource = AX Int | CK0 Int | Buf NumSource Int | Const Int | Len Int | CP Int deriving Show +data Instruction = SetAX NumSource + | SetCK0 NumSource + | SetBuf NumSource NumSource + | Call String + | PopAX + | PopCK + | PushAX + | PushCK + | AXToTape + | CK0ToTape + | AXFromTape + | CK0FromTape + | PushTape + | PopTape + | Walk NumSource + | Remove NumSource + | Insert NumSource String + | Return + | IfThenElse Condition Instruction Instruction + | UntilDo Condition Instruction + | Compound [Instruction] + deriving Show +data Condition = EqAX NumSource + | EqCK0 NumSource + | LtAX NumSource + | LtCK0 NumSource + | GtAX NumSource + | GtCK0 NumSource + | IsUpper NumSource + | IsLower NumSource + | IsDigit NumSource + | IsEob NumSource + | Negation Condition + | EqCh NumSource [Char] + deriving Show + +allocProcs :: Int -> [Procedure] -> CTPL [Procedure] +allocProcs cur [] = return [] +allocProcs cur (Procedure n i _:ps) = do + sp <- predictSpace i + ps' <- allocProcs (cur+sp) ps + return (Procedure n i cur : ps') + +-- Always include sign! Don't dump anything if 0 +dumpIncop :: String -> Int -> CTPL () +dumpIncop p 0 = return () +dumpIncop p i + | i < 0 = emit (p ++ show i) + | i > 0 = emit (p ++ ['+'] ++ show i) + +-- Pad to four digits. That should be sufficient unless you write crazily huge scripts... +dumpAddr :: Int -> CTPL () +dumpAddr i = emit $ let s0 = show i in replicate (4-length s0) '0' ++ s0 + +predictSpace :: Instruction -> CTPL Int +predictSpace = liftM length . catchEmission . dumpInstr + +splitStr :: String -> [String] +splitStr [] = [] +splitStr ('$':ss) = "$" : splitStr ss +splitStr str = + let t = takeWhile (/='$') str + in if t == str + then [t] + else t : "$" : splitStr (tail $ dropWhile (/='$') str) + +arepl i + | i >= 0 = replicate i '>' + | otherwise = replicate (-i) '<' + +dumpInstr :: Instruction -> CTPL () +dumpInstr instr = case instr of + -- +#, -# + SetAX (AX i) -> dumpIncop [] i + -- Dd + SetAX (CK0 i) -> emit "Dd" >> dumpIncop [] i + -- l + SetAX (Buf (CP j) i) -> emit (arepl j) >> emit "l" >> dumpIncop [] i + -- Split + SetAX (Buf d i) -> dumpInstr (SetAX d) >> emit "ml" >> dumpIncop [] i + -- Q0+# + SetAX (Const i) -> emit "Q0" >> dumpIncop [] i + -- Q0+7Je>0-7J!eQ + SetAX (Len i) -> emit "Q0+7Je>0-7J!eQ" >> dumpIncop [] i + -- Q + SetAX (CP i) -> emit "Q" >> dumpIncop [] i + -- C+#, C-# + SetCK0 (CK0 i) -> dumpIncop "C" i + -- kd + SetCK0 (AX i) -> emit "kd" >> dumpIncop "C" i + -- Cl + SetCK0 (Buf (CP j) i) -> emit (arepl j) >> emit "Cl" >> dumpIncop "C" i + -- Split + SetCK0 (Buf d i) -> dumpInstr (SetCK0 d) >> emit "CmCl" >> dumpIncop "C" i + -- C0C+# + SetCK0 (Const i) -> emit "C0" >> dumpIncop "C" i + -- C0C+11CJe>C0C-11CJ!eCQ (yeeees, this iiiis long...) + SetCK0 (Len i) -> emit "C0C+11CJe>C0C-11CJ!eCQ" >> dumpIncop "C" i + -- CQ + SetCK0 (CP i) -> emit "CQ" >> dumpIncop "C" i + -- Cd [ldck0] Csk + SetBuf (CP i) f -> emit "Cd" >> dumpInstr (SetCK0 f) >> emit (arepl i) >> emit "Csk" + -- Cd [ldck0] i/ emit "Cd" >> dumpInstr (SetCK0 f) >> emit "i/> dumpInstr (SetCK0 d) >> emit "CmkPpx" + -- d0+#ct + Call str -> do + a <- getProc str procAddr + emit "d0+" + dumpAddr a + emit "ct" + -- D + PopAX -> emit "D" + -- k + PopCK -> emit "k" + -- d + PushAX -> emit "d" + -- Cd + PushCK -> emit "Cd" + -- f + Return -> emit "f" + -- i/ emit "i/ emit "lx" + -- i/ emit "i/ emit "Clx" + -- x + Remove (CP i) -> emit (arepl i) >> emit "x" + -- Cd[ldbuf]Cmkx + Remove d -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmkx" + -- Nothing :) + Walk (CP i) -> emit (arepl i) + -- Cd[ldbuf]Cmk + Walk d -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmk" + -- yx + PushTape -> emit "yx" + -- Pp< + PopTape -> emit "Pp<" + -- I...$ + Insert (CP i) str -> emit (arepl i) >> forM_ (splitStr str) (\s -> if s=="$" then emit "i$" else emit ('I':s++"$")) + -- Cd[ldbuf]CmkI...$ + Insert d str -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmk" >> forM_ (splitStr str) (\s -> if s=="$" then emit "i$" else emit ('I':s++"$")) + -- condInit CdC0C+#CJCk cond condClean elseBranch d0+#Jt condClean ifBranch dD + IfThenElse c y n -> do + condClean <- discardEmission (dumpCond c "") + elseBranch <- catchEmission (emit condClean >> dumpInstr n) + ifBranch <- catchEmission (emit condClean >> dumpInstr y >> emit "d") + elseBranch2 <- catchEmission (emit "d0" >> dumpIncop [] (length ifBranch) >> emit "Jt") + jumper <- catchEmission (emit "CdC0" >> dumpIncop "C" (length elseBranch+length elseBranch2) >> emit "CJCk") + dumpCond c jumper + emit elseBranch + emit elseBranch2 + emit ifBranch + emit "D" + -- dD condInit CdC0C+#CJCk cond condClean body d0-#Jt condClean + UntilDo c b -> do + condClean <- discardEmission (dumpCond c "") + bodyPrev <- catchEmission (emit condClean >> dumpInstr b >> emit "d0-XXXXJt") + jumper <- catchEmission (emit "CdC0" >> dumpIncop "C" (length bodyPrev) >> emit "CJCk") + cond <- catchEmission (dumpCond c jumper >> return ()) + emit "dD" + emit cond + emit condClean + dumpInstr b + emit "d0-" + dumpAddr (length cond + length bodyPrev + 1) + emit "Jt" + emit condClean + -- Dispatch Compound + Compound is -> mapM_ dumpInstr is + +dumpCond :: Condition -> String -> CTPL String +dumpCond cond jumper = case cond of + -- jt (pointless!? -- oh wait, we'll use this for the true const :)) + EqAX (AX 0) -> emit jumper >> emit "t" >> return "" + LtAX (AX i) | i > 0 -> emit jumper >> emit "t" >> return "" + GtAX (AX i) | i < 0 -> emit jumper >> emit "t" >> return "" + EqCK0 (CK0 0) -> emit jumper >> emit "t" >> return "" + LtCK0 (CK0 i) | i > 0 -> emit jumper >> emit "t" >> return "" + GtCK0 (CK0 i) | i < 0 -> emit jumper >> emit "t" >> return "" + -- j!t (even more pointless!? -- we'll use it for the false const though :)) + EqAX (AX _) -> emit jumper >> emit "!t" >> return "" + LtAX (AX i) | i <= 0 -> emit jumper >> emit "!t" >> return "" + GtAX (AX i) | i >= 0 -> emit jumper >> emit "!t" >> return "" + EqCK0 (CK0 _) -> emit jumper >> emit "!t" >> return "" + LtCK0 (CK0 i) | i <= 0 -> emit jumper >> emit "!t" >> return "" + GtCK0 (CK0 i) | i >= 0 -> emit jumper >> emit "!t" >> return "" + -- -#j= +# + EqAX (CK0 i) -> dumpIncop [] (-i) >> emit jumper >> emit "=" >> catchEmission (dumpIncop [] i) + LtAX (CK0 i) -> dumpIncop [] (-i) >> emit jumper >> emit "<" >> catchEmission (dumpIncop [] i) + GtAX (CK0 i) -> dumpIncop [] (-i) >> emit jumper >> emit ">" >> catchEmission (dumpIncop [] i) + EqCK0 (AX i) -> dumpIncop [] i >> emit jumper >> emit "=" >> catchEmission (dumpIncop [] (-i)) + LtCK0 (AX i) -> dumpIncop [] i >> emit jumper >> emit ">" >> catchEmission (dumpIncop [] (-i)) + GtCK0 (AX i) -> dumpIncop [] i >> emit jumper >> emit "<" >> catchEmission (dumpIncop [] (-i)) + -- -#jz +# + EqAX (Const i) -> dumpIncop [] (-i) >> emit jumper >> emit "z" >> catchEmission (dumpIncop [] i) + -- CdC0C+#j< k + LtAX (Const i) -> emit "CdC0" >> dumpIncop "C" i >> emit jumper >> emit "<" >> return "k" + GtAX (Const i) -> emit "CdC0" >> dumpIncop "C" i >> emit jumper >> emit ">" >> return "k" + -- C-#jCz C+# + EqCK0 (Const i) -> dumpIncop "C" (-i) >> emit jumper >> emit "Cz" >> catchEmission (dumpIncop "C" i) + -- i/ lx + LtCK0 (Const i) -> emit "i/> dumpIncop [] i >> emit jumper >> emit ">" >> return "lx" + GtCK0 (Const i) -> emit "i/> dumpIncop [] i >> emit jumper >> emit "<" >> return "lx" + -- Cd[ldbuf]CmClC+#j= k + EqAX (Buf d i) -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "CmCl" >> dumpIncop "C" i >> emit jumper >> emit "=" >> return "k" + LtAX (Buf d i) -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "CmCl" >> dumpIncop "C" i >> emit jumper >> emit "<" >> return "k" + GtAX (Buf d i) -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "CmCl" >> dumpIncop "C" i >> emit jumper >> emit ">" >> return "k" + -- Cd[ldbuf]Cmi/l+#j= emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmi/l" >> dumpIncop [] i >> emit jumper >> emit "=" >> return " emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmi/l" >> dumpIncop [] i >> emit jumper >> emit "<" >> return " emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmi/l" >> dumpIncop [] i >> emit jumper >> emit ">" >> return "0-7J!eD-#jE +# + EqAX (Len i) -> emit "d0+7Je>0-7J!eD" >> dumpIncop [] (-i) >> emit jumper >> emit "E" >> catchEmission (dumpIncop [] i) + LtAX (Len i) -> emit "d0+7Je>0-7J!eD" >> dumpIncop [] (-i) >> emit jumper >> emit "g" >> catchEmission (dumpIncop [] i) + GtAX (Len i) -> emit "d0+7Je>0-7J!eD" >> dumpIncop [] (-i) >> emit jumper >> emit "l" >> catchEmission (dumpIncop [] i) + -- CdC0C+11CJe>C0C-11CJ!ekC-#jCE C+# (no, this is noooot long :p) + EqCK0 (Len i) -> emit "CdC0C+11CJe>C0C-11CJ!ek" >> dumpIncop "C" (-i) >> emit jumper >> emit "CE" >> catchEmission (dumpIncop "C" i) + LtCK0 (Len i) -> emit "CdC0C+11CJe>C0C-11CJ!ek" >> dumpIncop "C" (-i) >> emit jumper >> emit "Cg" >> catchEmission (dumpIncop "C" i) + GtCK0 (Len i) -> emit "CdC0C+11CJe>C0C-11CJ!ek" >> dumpIncop "C" (-i) >> emit jumper >> emit "Cl" >> catchEmission (dumpIncop "C" i) + -- Cd[ldbuf]CmkjU, Cd[ldbuf]CmkjL, Cd[ldbuf]CmkjN + IsUpper (CP i) -> emit (arepl i) >> emit jumper >> emit "U" >> return "" + IsUpper d -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmk" >> emit jumper >> emit "U" >> return "" + IsLower (CP i) -> emit (arepl i) >> emit jumper >> emit "L" >> return "" + IsLower d -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmk" >> emit jumper >> emit "L" >> return "" + IsDigit (CP i) -> emit (arepl i) >> emit jumper >> emit "N" >> return "" + IsDigit d -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmk" >> emit jumper >> emit "N" >> return "" + IsEob (CP i) -> emit (arepl i) >> emit jumper >> emit "e" >> return "" + IsEob d -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmk" >> emit jumper >> emit "e" >> return "" + -- j! + Negation c -> dumpCond c (jumper++"!") + -- j|q#!t + EqCh (CP i) chs -> emit (arepl i) >> emit jumper >> emit (foldr q "!t" chs) >> return "" where q a b = "|q"++[a]++b + -- Cd[ldbuf]Cmkj|q#!t + EqCh d chs -> emit "Cd" >> dumpInstr (SetCK0 d) >> emit "Cmk" >> emit jumper >> emit (foldr q "!t" chs) >> return "" where q a b = "|q"++[a]++b + +compile :: [Procedure] -> Instruction -> Exec String +compile ps main = do + let s0 = CTPLState (ps++[Procedure [] main 0]) + (_, _, out) <- flip runCTPL s0 $ do + ps <- getState definedProcs + ps' <- allocProcs 7 ps + modState $ \s -> s{definedProcs=ps'} + amain <- getProc [] procAddr + emit "+" + dumpAddr amain + emit "jt" + forM_ ps' $ \p -> dumpInstr $ procInstr p + return $ out [] + +multiParse :: ChParser m => m ([Procedure], [Instruction]) +multiParse = do + let parseStep = liftM (\p -> ([p],[])) parseProc ??? liftM (\i -> ([],[i])) parseInstr + parts <- many parseStep + return $ mconcat parts + +parseInstr :: ChParser m => m Instruction +parseInstr = parseAssignment + ??? parseReturn + ??? parseInsert + ??? parseCall + ??? parseIf + ??? parseLoop + ??? parseFor + ??? parseWalk + ??? parseRemove + +parseString :: ChParser m => m String +parseString = do + many white + match '"' + let char = do + k <- request + case k of + '"' -> pabort + '\\' -> request + k -> return k + cs <- many char + match '"' + return cs + +parseReturn :: ChParser m => m Instruction +parseReturn = do + many white + matchs "return" + many white + match ';' + return Return + +parseInsert :: ChParser m => m Instruction +parseInsert = do + many white + matchs "insert" + cs <- parseString + many white + matchs "at" + many white + match '[' + ns <- parseNumSource + many white + match ']' + many white + match ';' + return $ Insert ns cs + +parseRemove :: ChParser m => m Instruction +parseRemove = do + many white + matchs "remove"; + many white + match '['; + ns <- parseNumSource + many white + match ']' + many white + match ';' + return $ Remove ns + +parseWalk :: ChParser m => m Instruction +parseWalk = do + many white + match '[' + ns <- parseNumSource + many white + match ']' + many white + match ';' + return $ Walk ns + +parseCall :: ChParser m => m Instruction +parseCall = do + many white + matchs "call"; + many white + nm <- (:) `liftM` alpha `ap` many anum + many white + match ';' + return $ Call nm + +parseAssignment :: ChParser m => m Instruction +parseAssignment = do + many white + target <- (matchs "AX" >> return SetAX) + ??? (matchs "CK0" >> return SetCK0) + ??? do + match '[' + s <- parseNumSource + many white + match ']' + return $ SetBuf s + many white + match '=' + ns <- parseNumSource + many white + match ';' + return $ target ns + +parseNumSource :: ChParser m => m NumSource +parseNumSource = do + let num = (many white >> match '-' >> liftM negate number) + ?? number + summand = (many white >> match '-' >> liftM negate number) + ?? (many white >> match '+' >> number) + ?? (return 0) + ax = many white >> matchs "AX" >> liftM AX summand + ck0 = many white >> matchs "CK0" >> liftM CK0 summand + len = many white >> matchs "LEN" >> liftM Len summand + clt = many white >> match '\\' >> liftM (Const . ord) request + cst = liftM Const num + cp = many white >> matchs "CP" >> liftM CP summand + buf = do + many white + match '[' + n <- parseNumSource + many white + match ']' + liftM (Buf n) summand + ax ??? ck0 ??? cp ??? cst ??? clt ??? buf ??? len + +parseProc :: ChParser m => m Procedure +parseProc = do + many white + matchs "proc" + some white + nm <- liftM (:) alpha `ap` many anum + many white + match '{' + is <- many parseInstr + many white + match '}' + let is' = PopAX : is ++ [Return] + return $ Procedure nm (Compound is') 0 + +parseIf :: ChParser m => m Instruction +parseIf = do + many white + matchs "if" + c <- parseCond + many white + match '{' + ifBranch <- many parseInstr + many white + match '}' + let parseElse = do + many white + matchs "else" + many white + match '{' + elseBranch <- many parseInstr + many white + match '}' + return elseBranch + elseBranch <- parseElse ??? return [] + return $ IfThenElse c (Compound ifBranch) (Compound elseBranch) + +parseLoop :: ChParser m => m Instruction +parseLoop = do + many white + lt <- (matchs "until" >> return UntilDo) ??? (matchs "while" >> return (UntilDo . Negation)) + c <- parseCond + many white + match '{' + body <- many parseInstr + many white + match '}' + return $ lt c $ Compound body + +parseFor :: ChParser m => m Instruction +parseFor = do + many white + matchs "for" + start <- parseNumSource + many white + (step, cond) <- (matchs "to" >> return (1, GtAX)) ??? (matchs "downto" >> return (-1, LtAX)) + end <- parseNumSource + many white + match '{' + body <- many parseInstr + many white + match '}' + return $ Compound [PushCK, SetCK0 end, AXToTape, PushTape, CK0ToTape, PushTape, PopCK, PushCK, SetAX start, PopTape, CK0FromTape, PopTape, + UntilDo (cond $ CK0 0) $ Compound ([PushAX, AXFromTape]++body++[SetCK0 $ CK0 step, AXToTape, PopAX]), AXFromTape, PopCK] + +parseCond :: ChParser m => m Condition +parseCond = parseNot ??? parseIsLower ??? parseEq ??? parseEqCh ??? parseLt ??? parseGt + where + parseIsLower = do + many white + ctr <- (matchs "lowercase?" >> return IsLower) + ??? (matchs "uppercase?" >> return IsUpper) + ??? (matchs "digit?" >> return IsDigit) + ??? (matchs "end?" >> return IsEob) + many white + match '[' + ns <- parseNumSource + many white + match ']' + return $ ctr ns + parseNot = do + many white + matchs "not" + Negation `liftM` parseCond + parseEq = do + many white + reg <- (matchs "AX" >> return EqAX) ??? (matchs "CK0" >> return EqCK0) + many white + match '=' + ns <- parseNumSource + return $ reg ns + parseLt = do + many white + reg <- (matchs "AX" >> return LtAX) ??? (matchs "CK0" >> return LtCK0) + many white + match '<' + ns <- parseNumSource + return $ reg ns + parseGt = do + many white + reg <- (matchs "AX" >> return GtAX) ??? (matchs "CK0" >> return GtCK0) + many white + match '>' + ns <- parseNumSource + return $ reg ns + parseEqCh = do + many white + match '[' + ns <- parseNumSource + many white + match ']' + many white + matchs "in" + chs <- parseString + return $ EqCh ns chs + +parse :: String -> [] ([Procedure], [Instruction]) +parse s = runCarrierT s multiParse + +compileCTPL :: String -> Exec String +compileCTPL s = case parse s of + [] -> SyntaxFault + (ps, is):_ -> compile ps (Compound is) + +evalCTPL :: String -> String -> Int -> Null.Exec String +evalCTPL program buffer limit = + case compileCTPL program of + Succ bc -> Null.evalCTPL0 bc buffer limit + _ -> Null.SynViol diff --git a/Text/CTPL0.hs b/Text/CTPL0.hs new file mode 100644 --- /dev/null +++ b/Text/CTPL0.hs @@ -0,0 +1,361 @@ +module Text.CTPL0 where + +import Control.Monad +import Data.Char +import Data.Chatty.AVL +import Data.List + +data BufferState = BufferState { leftBehind :: String, thisChar :: Char, rightPending :: String } +data RegisterState = RegisterState { ax :: Integer, mk :: [String], rk :: [Int], ck :: [Int], cp :: Bool } +data InfoState = InfoState { instrStats :: AVL (Char, Int) } +data CTPL0State = CTPL0State { bufferState :: BufferState, programState :: BufferState, registerState :: RegisterState, infoState :: InfoState } +data Exec a = Succ a | Expired | ConfViol | SynViol deriving Show +newtype CTPL0 a = CTPL0 { runCTPL0 :: Int -> CTPL0State -> Exec (a, CTPL0State, Int) } + +instance Monad CTPL0 where + return a = CTPL0 $ \i k -> Succ (a, k, i) + m >>= f = CTPL0 $ \i k -> + case runCTPL0 m i k of + Succ (a, k', i') -> runCTPL0 (f a) i' k' + Expired -> Expired + ConfViol -> ConfViol + SynViol -> SynViol + +getState :: (CTPL0State -> a) -> CTPL0 a +getState f = CTPL0 $ \i k -> Succ (f k, k, i) + +modState :: (CTPL0State -> CTPL0State) -> CTPL0 () +modState f = CTPL0 $ \i k -> Succ ((), f k, i) + +consumeTime :: CTPL0 () +consumeTime = CTPL0 $ \i k -> if i >= 1 then Succ ((), k, i-1) else Expired + +confViol :: CTPL0 a +confViol = CTPL0 $ \_ _ -> ConfViol + +synViol :: CTPL0 a +synViol = CTPL0 $ \_ _ -> SynViol + +modBufferState :: (BufferState -> BufferState) -> CTPL0 () +modBufferState f = modState $ \s -> s{bufferState = f $ bufferState s} + +modProgramState :: (BufferState -> BufferState) -> CTPL0 () +modProgramState f = modState $ \s -> s{programState = f $ programState s} + +modRegisterState :: (RegisterState -> RegisterState) -> CTPL0 () +modRegisterState f = modState $ \s -> s{registerState = f $ registerState s} + +walkBuffer :: Int -> BufferState -> BufferState +walkBuffer 0 s = s +walkBuffer i s + | i < 0 = BufferState (drop (-i) $ leftBehind s) (head $ drop (-i-1) $ leftBehind s) (reverse (take (-i-1) $ leftBehind s) ++ [thisChar s] ++ rightPending s) + | i > 0 = BufferState (reverse (take (i-1) (rightPending s)) ++ [thisChar s] ++ leftBehind s) (head $ drop (i-1) $ rightPending s) (drop i $ rightPending s) + +getInstr :: CTPL0 Char +getInstr = do + k <- getState $ thisChar . programState + modProgramState $ walkBuffer 1 + return k + +endOfInstr :: CTPL0 Bool +endOfInstr = getState $ null . rightPending . programState + +instrNumArg :: CTPL0 Int +instrNumArg = do + ks <- getState $ \s -> takeWhile isDigit (thisChar (programState s) : rightPending (programState s)) + when (null ks) synViol + modProgramState $ walkBuffer $ length ks + return $ read ks + +instrDelimArg :: CTPL0 String +instrDelimArg = do + ks <- getState $ \s -> takeWhile (/='$') (thisChar (programState s) : rightPending (programState s)) + modProgramState $ walkBuffer $ length ks + k' <- getState $ (=='$') . thisChar . programState + unless k' synViol + modProgramState $ walkBuffer 1 + return ks + +getIP :: CTPL0 Int +getIP = getState $ length . leftBehind . programState + +getCP :: CTPL0 Int +getCP = getState $ length . leftBehind . bufferState + +canRelJump :: Int -> CTPL0 Bool +canRelJump 0 = return True +canRelJump i + | i < 0 = getState $ (>= -i) . length . leftBehind . programState + | i > 0 = getState $ (>= i) . length . rightPending . programState + +canRelWalk :: Int -> CTPL0 Bool +canRelWalk 0 = return True +canRelWalk i + | i < 0 = getState $ (>= -i) . length . leftBehind . bufferState + | i > 0 = getState $ (>= i) . length . rightPending . bufferState + +provided :: CTPL0 a -> CTPL0 Bool -> CTPL0 a +provided act test = do + b <- test + if b + then act + else confViol + +-- SX points to AX by default, but to CK(0) after 'C' +sx :: RegisterState -> Integer +sx r | cp r = fromIntegral $ head $ ck r +sx r = ax r + +setSX :: Integer -> RegisterState -> RegisterState +setSX i r | cp r = r{ck=fromIntegral i : tail (ck r)} +setSX i r = r{ax=i} + +singleInstr :: CTPL0 () +singleInstr = do + i <- getInstr + consumeTime + f <- getState $ instrStats . infoState + let f' = case avlLookup i f of + Nothing -> avlInsert (i,1) f + Just j -> avlInsert (i,j+1) f + modState $ \s -> s{infoState=InfoState f'} + case i of + -- Walk left + '<' -> modBufferState (walkBuffer (-1)) + `provided` getState (not . null . leftBehind . bufferState) + -- Walk right + '>' -> modBufferState (walkBuffer 1) + `provided` getState (not . null . rightPending . bufferState) + -- Inc AX (CK(0)) + '+' -> do + num <- liftM fromIntegral instrNumArg + modRegisterState $ \s -> setSX (sx s + num) s + -- Dec AX (CK(0)) + '-' -> do + num <- liftM fromIntegral instrNumArg + modRegisterState $ \s -> setSX (sx s - num) s + -- Insert char, go after + 'i' -> do + ch <- getInstr `provided` liftM not endOfInstr + modBufferState $ \s -> s{leftBehind=ch : leftBehind s} + -- Replace char + 'r' -> do + ch <- getInstr `provided` liftM not endOfInstr + modBufferState $ \s -> s{thisChar=ch} + -- Delete char + 'x' -> modBufferState (\s -> s{thisChar=head $ rightPending s, rightPending=tail $ rightPending s}) + `provided` getState (not . null . rightPending . bufferState) + -- Insert chars delimited by $, go after + 'I' -> do + cs <- instrDelimArg + modBufferState $ \s -> s{leftBehind = reverse cs ++ leftBehind s} + -- Append char at the end, don't walk + 'a' -> do + ch <- getInstr `provided` liftM not endOfInstr + modBufferState $ \s -> s{rightPending=appendBeforeETX (rightPending s) [ch]} + -- Append chars delimited by $, don't walk + 'A' -> do + cs <- instrDelimArg + modBufferState $ \s -> s{rightPending=appendBeforeETX (rightPending s) cs} + -- Push [CP] to MK + 'y' -> do + ch <- getState $ thisChar . bufferState + modRegisterState $ \s -> s{mk=[ch]:mk s} + -- Append [CP] to MK(0) + 'Y' -> do + ch <- getState $ thisChar . bufferState + modRegisterState (\s -> s{mk=(appendBeforeETX (head $ mk s) [ch]):tail (mk s)}) + `provided` getState (not . null . mk . registerState) + -- Pop MK(0), discard + 'p' -> modRegisterState (\s -> s{mk=tail $ mk s}) + `provided` getState (not . null . mk . registerState) + -- Peek MK(0), insert, go after + 'P' -> do + cs <- getState (head . mk . registerState) + `provided` getState (not . null . mk . registerState) + modBufferState $ \s -> s{leftBehind = reverse (unetx cs) ++ leftBehind s} + -- Set IP = AX (CK(0)) + 'j' -> do + ax <- getState $ sx . registerState + b <- singleCond + when b $ do + ip <- getIP + let rel = fromIntegral ax - ip + modProgramState (walkBuffer rel) `provided` canRelJump rel + -- Set IP += AX (CK(0)) + 'J' -> do + ax <- getState $ sx . registerState + b <- singleCond + when b $ do + let rel = fromIntegral ax + modProgramState (walkBuffer rel) `provided` canRelJump rel + -- Set IP = AX (CK(0)), push IP onto RK + 'c' -> do + ax <- getState $ sx . registerState + b <- singleCond + when b $ do + ip <- getIP + let rel = fromIntegral ax - ip + modProgramState (walkBuffer rel) `provided` canRelJump rel + modRegisterState $ \s -> s{rk=ip:rk s} + -- Return to RK(0), pop RK + 'f' -> do + r0 <- getState (head . rk . registerState) + `provided` getState (not . null . rk . registerState) + ip <- getIP + let rel = r0 - ip + modProgramState (walkBuffer rel) `provided` canRelJump rel + modRegisterState $ \s -> s{rk=tail $ rk s} + -- Set AX (CK(0)) = 0 + '0' -> modRegisterState $ setSX 0 + -- Set AX (CK(0)) = CP + 'Q' -> do + cp <- getCP + modRegisterState $ setSX $ fromIntegral cp + -- Set CP = AX (CK(0)) + 'm' -> do + ax <- getState $ fromIntegral . sx . registerState + cp <- getCP + let rel = ax - cp + modBufferState (walkBuffer rel) `provided` canRelWalk rel + -- Select CK(0) instead of AX for next operation + 'C' -> modRegisterState (\s -> s{cp=True}) + `provided` getState (not . null . ck . registerState) + -- Load ord[CP] into AX (CK(0)) + 'l' -> do + ch <- getState $ ord . thisChar . bufferState + modRegisterState $ setSX $ fromIntegral ch + -- Save ascii(AX) (CK(0)) to [CP] + 's' -> do + ax <- getState $ fromIntegral . sx . registerState + modBufferState $ \s -> s{thisChar=chr ax} + -- Push AX onto CK (or duplicate CK0, if SX->CK0) + 'd' -> do + ax <- getState $ fromIntegral . sx . registerState + modRegisterState $ \s -> s{ck=ax:ck s} + -- Pop AX from CK + 'D' -> do + ax' <- getState (fromIntegral . head . ck . registerState) + `provided` getState (not . null . ck . registerState) + modRegisterState $ \s -> s{ax=ax',ck=tail (ck s)} + -- Pop CK, discard + 'k' -> modRegisterState (\s -> s{ck=tail (ck s)}) + `provided` getState (not . null . ck . registerState) + -- Catch others + o -> synViol + unless (i=='C') $ modRegisterState $ \s -> s{cp=False} + +singleCond :: CTPL0 Bool +singleCond = do + i <- getInstr `provided` liftM not endOfInstr + case i of + -- Is Uppercase? + 'U' -> getState $ isUpper . thisChar . bufferState + -- Is Lowercase? + 'L' -> getState $ isLower . thisChar . bufferState + -- AX (CK(0)) = 0 ? + 'z' -> getState $ (==0) . sx . registerState + -- Always true + 't' -> return True + -- Is Digit? + 'N' -> getState $ isDigit . thisChar . bufferState + -- Is End of Buffer? + 'e' -> getState $ null . rightPending . bufferState + -- Negation + '!' -> liftM not singleCond + -- Disjunction + '|' -> liftM2 (||) singleCond singleCond + -- Conjunction + '&' -> liftM2 (&&) singleCond singleCond + -- Given char equals [CP] + 'q' -> do + ch <- getInstr `provided` liftM not endOfInstr + getState $ (==ch) . thisChar . bufferState + -- CP < AX (CK(0)) + 'l' -> do + cp <- getCP + getState $ (cp <) . fromIntegral . sx . registerState + -- CP > AX (CK(0)) + 'g' -> do + cp <- getCP + getState $ (cp >) . fromIntegral . sx . registerState + -- CP = AX (CK(0)) + 'E' -> do + cp <- getCP + getState $ (cp ==) . fromIntegral . sx . registerState + -- If SX->AX then make SX->CK(0), otherwise make SX->AX + 'C' -> do + sxp <- getState $ cp . registerState + if sxp + then modRegisterState (\s -> s{cp=False}) + else modRegisterState (\s -> s{cp=True}) + `provided` getState (not . null . ck . registerState) + singleCond + -- AX = CK(0)? + '=' -> liftM2 (==) + (getState $ ax . registerState) + (getState $ fromIntegral . head . ck . registerState) + `provided` getState (not . null . ck . registerState) + -- AX < CK(0)? + '<' -> liftM2 (<) + (getState $ ax . registerState) + (getState $ fromIntegral . head . ck . registerState) + `provided` getState (not . null . ck . registerState) + -- AX > CK(0)? + '>' -> liftM2 (>) + (getState $ ax . registerState) + (getState $ fromIntegral . head . ck . registerState) + `provided` getState (not . null . ck . registerState) + -- Pop CK, discard, then continue evaluation + 'k' -> do + modRegisterState (\s -> s{ck=tail $ ck s}) + `provided` getState (not . null . ck . registerState) + singleCond + -- Catch others + o -> synViol + +procInstrs :: CTPL0 () +procInstrs = singleInstr `asLongAs` liftM not endOfInstr + where asLongAs act test = do + b <- test + when b $ act >> asLongAs act test + +evalCTPL0' :: String -> String -> Int -> Exec (String, Int, Integer, Int, [] (Char, Int)) +evalCTPL0' program buffer limit = + let state0 = CTPL0State buffer0 program0 register0 info0 + buffer0 + | null buffer = BufferState [] (chr 3) [] + | otherwise = BufferState [] (head buffer) (tail buffer ++ [chr 3]) + program0 + | null program = BufferState [] (chr 3) [] + | otherwise = BufferState [] (head program) (tail program ++ [chr 3]) + register0 = RegisterState 0 [] [length program] [0] False + info0 = InfoState EmptyAVL + imprf avl = sortBy (\b a -> snd a `compare` snd b) $ avlInorder avl + in case runCTPL0 procInstrs limit state0 of + Succ (_, CTPL0State b p r f, i) -> Succ (unetx (reverse (leftBehind b) ++ [thisChar b] ++ rightPending b), i, ax r, head $ ck r, imprf $ instrStats f) + ConfViol -> ConfViol + SynViol -> SynViol + Expired -> Expired + +evalCTPL0 :: String -> String -> Int -> Exec String +evalCTPL0 program buffer limit = + case evalCTPL0' program buffer limit of + Succ (s,_,_,_,_) -> Succ s + ConfViol -> ConfViol + SynViol -> SynViol + Expired -> Expired + +unetx :: String -> String +unetx [] = [] +unetx s + | s == [chr 3] = [] + | last s == chr 3 = init s + | otherwise = s + +appendBeforeETX :: String -> String -> String +appendBeforeETX [] t = t +appendBeforeETX s t + | s == [chr 3] = t++[chr 3] + | last s == chr 3 = init s ++ t ++ [chr 3] + | otherwise = s ++ t diff --git a/ctpl.cabal b/ctpl.cabal new file mode 100644 --- /dev/null +++ b/ctpl.cabal @@ -0,0 +1,67 @@ +-- Initial ctpl.cabal generated by cabal init. For further documentation, +-- see http://haskell.org/cabal/users-guide/ + +-- The name of the package. +name: ctpl + +-- The package version. See the Haskell package versioning policy (PVP) +-- for standards guiding when and how versions should be incremented. +-- http://www.haskell.org/haskellwiki/Package_versioning_policy +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.1.0.1 + +-- A short (one-line) description of the package. +synopsis: A programming language for text modification. + +-- A longer description of the package. +-- description: + +-- The license under which the package is released. +license: GPL-3 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: Marvin Cohrs + +-- An email address to which users can send suggestions, bug reports, and +-- patches. +maintainer: m@doomanddarkness.eu + +-- A copyright notice. +-- copyright: + +category: Text + +build-type: Simple + +-- Extra files to be distributed with the package, such as examples or a +-- README. +-- extra-source-files: + +-- Constraint on the version of Cabal needed to build this package. +cabal-version: >=1.10 + + +library + -- Modules exported by the library. + exposed-modules: Text.CTPL, Text.CTPL0 + + -- Modules included in this library but not exported. + -- other-modules: + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + + -- Other library packages from which modules are imported. + build-depends: base >=4.6 && <4.8, chatty-text >=0.6 && <0.7, chatty-utils >=0.7.1.2 && <0.8 + + -- Directories containing source files. + -- hs-source-dirs: + + -- Base language which the package is written in. + default-language: Haskell2010 +