From: David Kerkeslager Date: Mon, 30 May 2016 20:58:56 +0000 (-0400) Subject: Moving things into a subdirectory in preparation to merge into my sandbox project X-Git-Url: https://code.kerkeslager.com/?p=sandbox;a=commitdiff_plain;h=45d5a3ef2178b0ee76e0d756f55e2544f1515edf Moving things into a subdirectory in preparation to merge into my sandbox project --- diff --git a/LICENSE b/LICENSE deleted file mode 100644 index dba13ed..0000000 --- a/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 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 Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are 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. - - 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. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - 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 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 work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - 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 AGPL, see -. diff --git a/README.md b/README.md deleted file mode 100644 index 6875343..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# stutter - -This is my second attempt at writing a lisp in Python. The two major differences between this and Mini (the first attempt) are a) this hopes to be compiled and b) this integrates vau from John Shutt's [Kernel](http://web.cs.wpi.edu/~jshutt/kernel.html). diff --git a/integration_tests/0001_integer_literal.stt b/integration_tests/0001_integer_literal.stt deleted file mode 100644 index 573541a..0000000 --- a/integration_tests/0001_integer_literal.stt +++ /dev/null @@ -1 +0,0 @@ -0 diff --git a/integration_tests/0001_integer_literal.txt b/integration_tests/0001_integer_literal.txt deleted file mode 100644 index e69de29..0000000 diff --git a/integration_tests/0002_hello_world.stt b/integration_tests/0002_hello_world.stt deleted file mode 100644 index c4cb438..0000000 --- a/integration_tests/0002_hello_world.stt +++ /dev/null @@ -1,2 +0,0 @@ -(print "Hello, world") -0 diff --git a/integration_tests/0002_hello_world.txt b/integration_tests/0002_hello_world.txt deleted file mode 100644 index dbe9dba..0000000 --- a/integration_tests/0002_hello_world.txt +++ /dev/null @@ -1 +0,0 @@ -Hello, world \ No newline at end of file diff --git a/integration_tests/0003_define.stt b/integration_tests/0003_define.stt deleted file mode 100644 index a0d8b77..0000000 --- a/integration_tests/0003_define.stt +++ /dev/null @@ -1,3 +0,0 @@ -(define hello-world "Hello, world") -(print hello-world) -0 diff --git a/integration_tests/0003_define.txt b/integration_tests/0003_define.txt deleted file mode 100644 index dbe9dba..0000000 --- a/integration_tests/0003_define.txt +++ /dev/null @@ -1 +0,0 @@ -Hello, world \ No newline at end of file diff --git a/integration_tests/0004_define_evaluates_definition.stt b/integration_tests/0004_define_evaluates_definition.stt deleted file mode 100644 index 17afe15..0000000 --- a/integration_tests/0004_define_evaluates_definition.stt +++ /dev/null @@ -1,4 +0,0 @@ -(define hello-world "Hello, world") -(define hello-world-copy hello-world) -(print hello-world-copy) -0 diff --git a/integration_tests/0004_define_evaluates_definition.txt b/integration_tests/0004_define_evaluates_definition.txt deleted file mode 100644 index dbe9dba..0000000 --- a/integration_tests/0004_define_evaluates_definition.txt +++ /dev/null @@ -1 +0,0 @@ -Hello, world \ No newline at end of file diff --git a/stutter.py b/stutter.py deleted file mode 100644 index c2139e5..0000000 --- a/stutter.py +++ /dev/null @@ -1,749 +0,0 @@ -#!/usr/bin/env python - -''' -To run this file: - - python stutter.py stutter_code.stt > c_code.c -''' - -import itertools -import re -import string - -# Utility functions - -def is_integer(s_expression): - return isinstance(s_expression, int) \ - and not s_expression is True \ - and not s_expression is False - -ESCAPE_CHARACTERS = { - '\\' : '\\', - 'n' : '\n', -} - -def undelimit_string(s): - assert len(s) >= 2 - - delimiter = s[0] - assert delimiter == '"' # This is temporary, " is currently the only delimiter - assert s[-1] == delimiter - - escape_characters = dict(ESCAPE_CHARACTERS) - escape_characters[delimiter] = delimiter - - s = s[1:-1] - - index = 0 - result = '' - - while index < len(s): - ch = s[index] - - if ch == '\\': - index += 1 - - # TODO Handle when it's not a valid escape character - ch = escape_characters[s[index]] - - index += 1 - result += ch - - return result - -TAB_WIDTH = 4 - -def indent(string): - assert isinstance(string, str) - - def indent_line(line): - line = line.rstrip() - - if line == '': - return line - - return ' ' * TAB_WIDTH + line - - return '\n'.join(indent_line(line) for line in string.splitlines()) - -# String to s-expressions - -class Symbol(object): - def __init__(self, string): - self.string = string - - def __eq__(self, other): - return self.string == other.string - -TOKEN = re.compile(r'\s*({})'.format('|'.join('(?P<{}>{})'.format(*token) for token in [ - ('open_parenthese', r'\('), - ('close_parenthese', r'\)'), - ('identifier', r'[a-z\-]+'), # We can expand this as needed - ('integer_literal', r'\d+'), - ('string_literal', r'"(\\"|[^"])*"'), - ('unexpected_character', r'.'), -]))) - -def parse_all(source): - stack = [] - items = [] - - for token in TOKEN.finditer(source): - if token.group('open_parenthese'): - stack.append(items) - items = [] - - elif token.group('close_parenthese'): - if len(stack) == 0: - raise Exception('Parenthese closed but not opened') - - stack[-1].append(tuple(items)) - items = stack.pop() - - elif token.group('identifier'): - items.append(Symbol(token.group('identifier'))) - - elif token.group('integer_literal'): - items.append(int(token.group('integer_literal'))) - - elif token.group('string_literal'): - items.append(undelimit_string(token.group('string_literal'))) - - elif token.group('unexpected_character'): - raise Exception('Unexpected character {}'.format( - token.group('unexpected_character'), - )) - - else: - raise Exception() - - if len(stack) > 0: - raise Exception('Parenthese opened but not closed') - - return items - -# C AST Objects - -class CType(object): - def __init__(self, name): - self.name = name - -class CPointerType(CType): - def __init__(self, pointer_to): - self.pointer_to = pointer_to - -class CArgumentDeclaration(object): - def __init__(self, _type, name): - assert isinstance(_type, CType) - self._type = _type - self.name = name - -class CExpression(object): - pass - -class CIntegerLiteralExpression(CExpression): - def __init__(self, integer): - assert is_integer(integer) - self.integer = integer - - def __eq__(self, other): - assert isinstance(other, CIntegerLiteralExpression) - return self.integer == other.integer - -class CStringLiteralExpression(CExpression): - def __init__(self, string): - assert isinstance(string, str) - self.string = string - - def __eq__(self, other): - assert isinstance(other, CStringLiteralExpression) - return self.string == other.string - -class CVariableExpression(CExpression): - def __init__(self, name): - assert isinstance(name, str) - self.name = name - - def __eq__(self, other): - assert isinstance(other, CVariableExpression) - return self.name == other.name - -class CReferenceExpression(CExpression): - def __init__(self, referee): - assert isinstance(referee, CVariableExpression) - self.referee = referee - -class CFunctionCallExpression(CExpression): - def __init__(self, name, arguments): - assert all(isinstance(argument, CExpression) for argument in arguments) - self.name = name - self.arguments = arguments - - def __eq__(self, other): - assert isinstance(other, CFunctionCallExpression) - return self.name == other.name and self.arguments == other.arguments - -class CStatement(object): - pass - -class CExpressionStatement(CStatement): - def __init__(self, expression): - self.expression = expression - -class CReturnStatement(CStatement): - def __init__(self, expression): - self.expression = expression - -class CDefinitionStatement(CStatement): - def __init__(self, _type, name, definition): - assert isinstance(_type, CType) - assert isinstance(name, str) - assert isinstance(definition, CExpression) - - self._type = _type - self.name = name - self.definition = definition - -class CFunctionBody(object): - def __init__(self, statements): - statements = list(statements) - assert all(isinstance(s, CStatement) for s in statements) - self.statements = statements - -class CFunctionDeclaration(object): - def __init__(self, return_type, name, argument_declaration_list, body): - assert isinstance(return_type, CType) - assert isinstance(argument_declaration_list, list) - assert all(isinstance(ad, CArgumentDeclaration) for ad in argument_declaration_list) - assert isinstance(body, CFunctionBody) - - self.return_type = return_type - self.name = name - self.argument_declaration_list = argument_declaration_list - self.body = body - -# BEGIN S-expression to C AST layer - -def quote_to_c(s_expression): - if is_integer(s_expression): - return CFunctionCallExpression( - 'makeObjectPointerFromInteger', - [CIntegerLiteralExpression(s_expression)], - ) - - if isinstance(s_expression, str): - return CFunctionCallExpression( - 'makeObjectPointerFromString', - [CStringLiteralExpression(s_expression)], - ) - - if isinstance(s_expression, Symbol): - return CFunctionCallExpression( - 'getSymbol', - [CStringLiteralExpression(s_expression.string)], - ) - - raise Exception('Not implemented for type {}'.format(type(s_expression))) - -def evaluate_application_arguments_to_c( - arguments, - quote_to_c = quote_to_c, - ): - - if len(arguments) == 0: - return CVariableExpression('NULL') - - return CFunctionCallExpression( - 'c_cons', - ( - quote_to_c(arguments[0]), - evaluate_application_arguments_to_c(arguments[1:]), - ), - ) - -def evaluate_application_to_c( - s_expression, - evaluate_application_arguments_to_c = evaluate_application_arguments_to_c, - ): - - assert isinstance(s_expression, tuple) - if isinstance(s_expression[0], Symbol): - return CFunctionCallExpression( - s_expression[0].string, - ( - CReferenceExpression(CVariableExpression('env')), - evaluate_application_arguments_to_c(s_expression[1:]), - ), - ) - - raise Exception('Not implemented') - -def evaluate_to_c( - s_expression, - evaluate_application_to_c = evaluate_application_to_c, - ): - - if isinstance(s_expression, tuple): - return evaluate_application_to_c(s_expression) - - if is_integer(s_expression): - return CIntegerLiteralExpression(s_expression) - - if isinstance(s_expression, str): - return CStringLiteralExpression(s_expression) - - raise Exception('Unable to evaluate expression {} to C'.format(s_expression)) - -def evaluate_all_to_c(s_expressions): - c_expressions = list(map(evaluate_to_c, s_expressions)) - - return CFunctionBody(itertools.chain( - [CDefinitionStatement( - CPointerType(CType('Environment')), - 'env', - CVariableExpression('NULL'), - )], - map(CExpressionStatement, c_expressions[:-1]), - [CReturnStatement(c_expressions[-1])], - )) - -# BEGIN C AST to C source layer - -def generate_pointer_type(pointer_type): - assert isinstance(pointer_type, CPointerType) - return '{}*'.format(generate_type(pointer_type.pointer_to)) - -def generate_type( - type, - generate_pointer_type = generate_pointer_type): - assert isinstance(type, CType) - - if isinstance(type, CPointerType): - return generate_pointer_type(type) - - return type.name - -def generate_argument_declaration(argument_declaration): - assert isinstance(argument_declaration, CArgumentDeclaration) - return '{} {}'.format( - generate_type(argument_declaration._type), - argument_declaration.name, - ) - -def generate_argument_declaration_list(argument_declarations): - return ', '.join(generate_argument_declaration(ad) for ad in argument_declarations) - -def generate_integer_literal_expression(expression): - assert isinstance(expression, CIntegerLiteralExpression) - return str(expression.integer) - -C_ESCAPE_SEQUENCES = { - # Taken from https://en.wikipedia.org/wiki/Escape_sequences_in_C - '\x07' : r'\a', - '\x08' : r'\b', - '\x0c' : r'\f', - '\x0a' : r'\n', - '\x0d' : r'\r', - '\x09' : r'\t', - '\x0b' : r'\v', - '\x5c' : r'\\', - '\x27' : r"\'", - '\x22' : r'\"', - '\x3f' : r'\?', -} - -def generate_string_literal_expression(expression): - assert isinstance(expression, CStringLiteralExpression) - - result = '"' - - for ch in expression.string: - result += C_ESCAPE_SEQUENCES.get(ch, ch) - - result += '"' - - return result - -def generate_variable_expression(expression): - assert isinstance(expression, CVariableExpression) - return expression.name - -def generate_reference_expression(expression): - assert isinstance(expression, CReferenceExpression) - return '&{}'.format(generate_variable_expression(expression.referee)) - -def generate_function_call_expression(expression): - assert isinstance(expression, CFunctionCallExpression) - return '{}({})'.format( - expression.name, - ', '.join(generate_expression(e) for e in expression.arguments), - ) - -def generate_expression( - expression, - generate_integer_literal_expression = generate_integer_literal_expression, - generate_string_literal_expression = generate_string_literal_expression, - generate_variable_expression = generate_variable_expression, - generate_reference_expression = generate_reference_expression, - generate_function_call_expression = generate_function_call_expression, - ): - - if isinstance(expression, CIntegerLiteralExpression): - return generate_integer_literal_expression(expression) - - if isinstance(expression, CStringLiteralExpression): - return generate_string_literal_expression(expression) - - if isinstance(expression, CVariableExpression): - return generate_variable_expression(expression) - - if isinstance(expression, CReferenceExpression): - return generate_reference_expression(expression) - - if isinstance(expression, CFunctionCallExpression): - return generate_function_call_expression(expression) - - raise Exception('Expression type {} not implemented'.format(type(expression))) - -def generate_expression_statement(statement): - return '{};'.format(generate_expression(statement.expression)) - -def generate_return_statement(statement): - return 'return {};'.format(generate_expression(statement.expression)) - -def generate_definition_statement(statement): - return '{} {} = {};'.format( - generate_type(statement._type), - statement.name, - generate_expression(statement.definition), - ) - -def generate_statement( - statement, - generate_expression_statement = generate_expression_statement, - generate_return_statement = generate_return_statement, - generate_definition_statement = generate_definition_statement): - - if isinstance(statement, CExpressionStatement): - return generate_expression_statement(statement) - - if isinstance(statement, CReturnStatement): - return generate_return_statement(statement) - - if isinstance(statement, CDefinitionStatement): - return generate_definition_statement(statement) - - raise Exception('Handling for statements of type {} not implemented'.format(type(statement))) - -def generate_function_body(function_body): - assert isinstance(function_body, CFunctionBody) - return '\n'.join(generate_statement(s) for s in function_body.statements) - -FUNCTION_DEFINITION_TEMPLATE = string.Template( -''' -$return_type $name($argument_declaration_list) -{ -$body -} -'''.strip()) - -def generate_function_declaration(function_declaration): - assert isinstance(function_declaration, CFunctionDeclaration) - return FUNCTION_DEFINITION_TEMPLATE.substitute( - return_type = generate_type(function_declaration.return_type), - name = function_declaration.name, - argument_declaration_list = generate_argument_declaration_list(function_declaration.argument_declaration_list), - body = indent(generate_function_body(function_declaration.body)), - ) - -PROGRAM_TEMPLATE = string.Template( -''' -#include -#include -#include -#include -#include - -struct Object; -typedef struct Object Object; - -enum Type -{ - CELL, - STRING, - SYMBOL -}; -typedef enum Type Type; - -#define MAX_TYPE_STRING_LENGTH 7 - -void typeToString(Type type, char* target) -{ - switch(type) - { - case CELL: - snprintf(target, MAX_TYPE_STRING_LENGTH, "CELL"); - return; - - case STRING: - snprintf(target, MAX_TYPE_STRING_LENGTH, "STRING"); - return; - - case SYMBOL: - snprintf(target, MAX_TYPE_STRING_LENGTH, "%s", "SYMBOL"); - return; - - default: - fprintf(stderr, "ERROR: Unknown type"); - exit(1); - } -} - -struct Cell; -typedef struct Cell Cell; -struct Cell -{ - Object* left; - Object* right; -}; - -struct Environment; -typedef struct Environment Environment; -struct Environment -{ - char* key; - Object* value; - Environment* next; -}; - -Environment makeEnvironment(char* key, Object* value, Environment* next) -{ - Environment result; - result.key = key; - result.value = value; - result.next = next; - return result; -} - -Environment* makeEnvironmentPointerFromEnvironment(Environment env) -{ - Environment* result = malloc(sizeof(Environment)); - *result = env; - return result; -} - -Environment* makeEnvironmentPointer(char* key, Object* value, Environment* next) -{ - return makeEnvironmentPointerFromEnvironment(makeEnvironment(key, value, next)); -} - -union Instance -{ - Cell cell; - char* string; - char* symbol; -}; -typedef union Instance Instance; - -Instance makeInstanceFromCell(Cell cell) -{ - Instance result; - result.cell = cell; - return result; -} - -Instance makeInstanceFromString(char* string) -{ - Instance result; - result.string = string; - return result; -} - -Instance makeInstanceFromSymbol(char* symbol) -{ - Instance result; - result.symbol = symbol; - return result; -} - -struct Object -{ - Type type; - Instance instance; -}; - -Object makeObject(Type t, Instance i) -{ - Object result; - result.type = t; - result.instance = i; - return result; -} - -Object makeObjectFromCell(Cell cell) -{ - return makeObject(CELL, makeInstanceFromCell(cell)); -} - -Object makeObjectFromString(char* string) -{ - return makeObject(STRING, makeInstanceFromString(string)); -} - -Object makeObjectFromSymbol(char* symbol) -{ - return makeObject(SYMBOL, makeInstanceFromSymbol(symbol)); -} - -Object* makeObjectPointerFromObject(Object o) -{ - Object* result = malloc(sizeof(Object)); - *result = o; - return result; -} - -Object* makeObjectPointerFromCell(Cell cell) -{ - return makeObjectPointerFromObject(makeObjectFromCell(cell)); -} - -Object* makeObjectPointerFromString(char* string) -{ - return makeObjectPointerFromObject(makeObjectFromString(string)); -} - -Object* makeObjectPointerFromSymbol(char* symbol) -{ - return makeObjectPointerFromObject(makeObjectFromSymbol(symbol)); -} - -Object* getSymbol(char* symbol) -{ - // This will not always be how this is implemented - return makeObjectPointerFromSymbol(symbol); -} - -Cell makeCell(Object* left, Object* right) -{ - Cell result; - result.left = left; - result.right = right; - return result; -} - -Object* c_cons(Object* left, Object* right) -{ - Cell cell = makeCell(left, right); - return makeObjectPointerFromCell(cell); -} - -void c_print(Object* stutter_string) -{ - if(stutter_string->type != STRING) - { - char typeName[MAX_TYPE_STRING_LENGTH]; - typeToString(stutter_string->type, typeName); - fprintf(stderr, "ERROR: Expected type STRING, got type %s.", typeName); - exit(1); - } - - char* c_string = stutter_string->instance.string; - printf("%s", c_string); -} - -bool c_symbol_equal(char* left, char* right) -{ - return strcmp(left, right) == 0; -} - -Object* c_evaluate_symbol(Environment* env, Object* s) -{ - if(env == NULL) - { - fprintf(stderr, "ERROR: symbol %s not found.", s->instance.symbol); - exit(1); - } - - if(c_symbol_equal(env->key, s->instance.symbol)) - { - return env->value; - } - - return c_evaluate_symbol(env->next, s); -} - -Object* c_evaluate(Environment** env, Object* o) -{ - switch(o->type) - { - case STRING: - return o; - - case SYMBOL: - return c_evaluate_symbol(*env, o); - - default: - break; - } - - char typeName[MAX_TYPE_STRING_LENGTH]; - typeToString(o->type, typeName); - fprintf(stderr, "ERROR: Could not evaluate type %s.", typeName); - exit(1); -} - -int countArgs(Object* args) -{ - if(args == NULL) return 0; - - assert(args->type == CELL); - return 1 + countArgs(args->instance.cell.right); -} - -Object* getArg(int index, Object* args) -{ - if(index == 0) return args->instance.cell.left; - - return getArg(index - 1, args->instance.cell.right); -} - -void print(Environment** parent, Object* args) -{ - assert(countArgs(args) == 1); - Object* stutter_string = c_evaluate(parent, getArg(0, args)); - c_print(stutter_string); -} - -void define(Environment** parent, Object* args) -{ - assert(countArgs(args) == 2); - Object* name = getArg(0, args); - Object* value = c_evaluate(parent, getArg(1, args)); - - assert(name->type == SYMBOL); - *parent = makeEnvironmentPointer(name->instance.symbol, value, *parent); -} - -int main(int argc, char** argv) -{ -$body -} -'''.strip()) - -def generate_program(body): - return PROGRAM_TEMPLATE.substitute( - body = body, - ) - -if __name__ == '__main__': - import sys - source_file_name = sys.argv[1] - - with open(source_file_name, 'r') as source_file: - source = source_file.read() - - result = generate_program( - indent(generate_function_body(evaluate_all_to_c(parse_all(source)))), - ) - - print(result) diff --git a/stutter/LICENSE b/stutter/LICENSE new file mode 100644 index 0000000..dba13ed --- /dev/null +++ b/stutter/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/stutter/README.md b/stutter/README.md new file mode 100644 index 0000000..6875343 --- /dev/null +++ b/stutter/README.md @@ -0,0 +1,3 @@ +# stutter + +This is my second attempt at writing a lisp in Python. The two major differences between this and Mini (the first attempt) are a) this hopes to be compiled and b) this integrates vau from John Shutt's [Kernel](http://web.cs.wpi.edu/~jshutt/kernel.html). diff --git a/stutter/integration_tests/0001_integer_literal.stt b/stutter/integration_tests/0001_integer_literal.stt new file mode 100644 index 0000000..573541a --- /dev/null +++ b/stutter/integration_tests/0001_integer_literal.stt @@ -0,0 +1 @@ +0 diff --git a/stutter/integration_tests/0001_integer_literal.txt b/stutter/integration_tests/0001_integer_literal.txt new file mode 100644 index 0000000..e69de29 diff --git a/stutter/integration_tests/0002_hello_world.stt b/stutter/integration_tests/0002_hello_world.stt new file mode 100644 index 0000000..c4cb438 --- /dev/null +++ b/stutter/integration_tests/0002_hello_world.stt @@ -0,0 +1,2 @@ +(print "Hello, world") +0 diff --git a/stutter/integration_tests/0002_hello_world.txt b/stutter/integration_tests/0002_hello_world.txt new file mode 100644 index 0000000..dbe9dba --- /dev/null +++ b/stutter/integration_tests/0002_hello_world.txt @@ -0,0 +1 @@ +Hello, world \ No newline at end of file diff --git a/stutter/integration_tests/0003_define.stt b/stutter/integration_tests/0003_define.stt new file mode 100644 index 0000000..a0d8b77 --- /dev/null +++ b/stutter/integration_tests/0003_define.stt @@ -0,0 +1,3 @@ +(define hello-world "Hello, world") +(print hello-world) +0 diff --git a/stutter/integration_tests/0003_define.txt b/stutter/integration_tests/0003_define.txt new file mode 100644 index 0000000..dbe9dba --- /dev/null +++ b/stutter/integration_tests/0003_define.txt @@ -0,0 +1 @@ +Hello, world \ No newline at end of file diff --git a/stutter/integration_tests/0004_define_evaluates_definition.stt b/stutter/integration_tests/0004_define_evaluates_definition.stt new file mode 100644 index 0000000..17afe15 --- /dev/null +++ b/stutter/integration_tests/0004_define_evaluates_definition.stt @@ -0,0 +1,4 @@ +(define hello-world "Hello, world") +(define hello-world-copy hello-world) +(print hello-world-copy) +0 diff --git a/stutter/integration_tests/0004_define_evaluates_definition.txt b/stutter/integration_tests/0004_define_evaluates_definition.txt new file mode 100644 index 0000000..dbe9dba --- /dev/null +++ b/stutter/integration_tests/0004_define_evaluates_definition.txt @@ -0,0 +1 @@ +Hello, world \ No newline at end of file diff --git a/stutter/stutter.py b/stutter/stutter.py new file mode 100644 index 0000000..c2139e5 --- /dev/null +++ b/stutter/stutter.py @@ -0,0 +1,749 @@ +#!/usr/bin/env python + +''' +To run this file: + + python stutter.py stutter_code.stt > c_code.c +''' + +import itertools +import re +import string + +# Utility functions + +def is_integer(s_expression): + return isinstance(s_expression, int) \ + and not s_expression is True \ + and not s_expression is False + +ESCAPE_CHARACTERS = { + '\\' : '\\', + 'n' : '\n', +} + +def undelimit_string(s): + assert len(s) >= 2 + + delimiter = s[0] + assert delimiter == '"' # This is temporary, " is currently the only delimiter + assert s[-1] == delimiter + + escape_characters = dict(ESCAPE_CHARACTERS) + escape_characters[delimiter] = delimiter + + s = s[1:-1] + + index = 0 + result = '' + + while index < len(s): + ch = s[index] + + if ch == '\\': + index += 1 + + # TODO Handle when it's not a valid escape character + ch = escape_characters[s[index]] + + index += 1 + result += ch + + return result + +TAB_WIDTH = 4 + +def indent(string): + assert isinstance(string, str) + + def indent_line(line): + line = line.rstrip() + + if line == '': + return line + + return ' ' * TAB_WIDTH + line + + return '\n'.join(indent_line(line) for line in string.splitlines()) + +# String to s-expressions + +class Symbol(object): + def __init__(self, string): + self.string = string + + def __eq__(self, other): + return self.string == other.string + +TOKEN = re.compile(r'\s*({})'.format('|'.join('(?P<{}>{})'.format(*token) for token in [ + ('open_parenthese', r'\('), + ('close_parenthese', r'\)'), + ('identifier', r'[a-z\-]+'), # We can expand this as needed + ('integer_literal', r'\d+'), + ('string_literal', r'"(\\"|[^"])*"'), + ('unexpected_character', r'.'), +]))) + +def parse_all(source): + stack = [] + items = [] + + for token in TOKEN.finditer(source): + if token.group('open_parenthese'): + stack.append(items) + items = [] + + elif token.group('close_parenthese'): + if len(stack) == 0: + raise Exception('Parenthese closed but not opened') + + stack[-1].append(tuple(items)) + items = stack.pop() + + elif token.group('identifier'): + items.append(Symbol(token.group('identifier'))) + + elif token.group('integer_literal'): + items.append(int(token.group('integer_literal'))) + + elif token.group('string_literal'): + items.append(undelimit_string(token.group('string_literal'))) + + elif token.group('unexpected_character'): + raise Exception('Unexpected character {}'.format( + token.group('unexpected_character'), + )) + + else: + raise Exception() + + if len(stack) > 0: + raise Exception('Parenthese opened but not closed') + + return items + +# C AST Objects + +class CType(object): + def __init__(self, name): + self.name = name + +class CPointerType(CType): + def __init__(self, pointer_to): + self.pointer_to = pointer_to + +class CArgumentDeclaration(object): + def __init__(self, _type, name): + assert isinstance(_type, CType) + self._type = _type + self.name = name + +class CExpression(object): + pass + +class CIntegerLiteralExpression(CExpression): + def __init__(self, integer): + assert is_integer(integer) + self.integer = integer + + def __eq__(self, other): + assert isinstance(other, CIntegerLiteralExpression) + return self.integer == other.integer + +class CStringLiteralExpression(CExpression): + def __init__(self, string): + assert isinstance(string, str) + self.string = string + + def __eq__(self, other): + assert isinstance(other, CStringLiteralExpression) + return self.string == other.string + +class CVariableExpression(CExpression): + def __init__(self, name): + assert isinstance(name, str) + self.name = name + + def __eq__(self, other): + assert isinstance(other, CVariableExpression) + return self.name == other.name + +class CReferenceExpression(CExpression): + def __init__(self, referee): + assert isinstance(referee, CVariableExpression) + self.referee = referee + +class CFunctionCallExpression(CExpression): + def __init__(self, name, arguments): + assert all(isinstance(argument, CExpression) for argument in arguments) + self.name = name + self.arguments = arguments + + def __eq__(self, other): + assert isinstance(other, CFunctionCallExpression) + return self.name == other.name and self.arguments == other.arguments + +class CStatement(object): + pass + +class CExpressionStatement(CStatement): + def __init__(self, expression): + self.expression = expression + +class CReturnStatement(CStatement): + def __init__(self, expression): + self.expression = expression + +class CDefinitionStatement(CStatement): + def __init__(self, _type, name, definition): + assert isinstance(_type, CType) + assert isinstance(name, str) + assert isinstance(definition, CExpression) + + self._type = _type + self.name = name + self.definition = definition + +class CFunctionBody(object): + def __init__(self, statements): + statements = list(statements) + assert all(isinstance(s, CStatement) for s in statements) + self.statements = statements + +class CFunctionDeclaration(object): + def __init__(self, return_type, name, argument_declaration_list, body): + assert isinstance(return_type, CType) + assert isinstance(argument_declaration_list, list) + assert all(isinstance(ad, CArgumentDeclaration) for ad in argument_declaration_list) + assert isinstance(body, CFunctionBody) + + self.return_type = return_type + self.name = name + self.argument_declaration_list = argument_declaration_list + self.body = body + +# BEGIN S-expression to C AST layer + +def quote_to_c(s_expression): + if is_integer(s_expression): + return CFunctionCallExpression( + 'makeObjectPointerFromInteger', + [CIntegerLiteralExpression(s_expression)], + ) + + if isinstance(s_expression, str): + return CFunctionCallExpression( + 'makeObjectPointerFromString', + [CStringLiteralExpression(s_expression)], + ) + + if isinstance(s_expression, Symbol): + return CFunctionCallExpression( + 'getSymbol', + [CStringLiteralExpression(s_expression.string)], + ) + + raise Exception('Not implemented for type {}'.format(type(s_expression))) + +def evaluate_application_arguments_to_c( + arguments, + quote_to_c = quote_to_c, + ): + + if len(arguments) == 0: + return CVariableExpression('NULL') + + return CFunctionCallExpression( + 'c_cons', + ( + quote_to_c(arguments[0]), + evaluate_application_arguments_to_c(arguments[1:]), + ), + ) + +def evaluate_application_to_c( + s_expression, + evaluate_application_arguments_to_c = evaluate_application_arguments_to_c, + ): + + assert isinstance(s_expression, tuple) + if isinstance(s_expression[0], Symbol): + return CFunctionCallExpression( + s_expression[0].string, + ( + CReferenceExpression(CVariableExpression('env')), + evaluate_application_arguments_to_c(s_expression[1:]), + ), + ) + + raise Exception('Not implemented') + +def evaluate_to_c( + s_expression, + evaluate_application_to_c = evaluate_application_to_c, + ): + + if isinstance(s_expression, tuple): + return evaluate_application_to_c(s_expression) + + if is_integer(s_expression): + return CIntegerLiteralExpression(s_expression) + + if isinstance(s_expression, str): + return CStringLiteralExpression(s_expression) + + raise Exception('Unable to evaluate expression {} to C'.format(s_expression)) + +def evaluate_all_to_c(s_expressions): + c_expressions = list(map(evaluate_to_c, s_expressions)) + + return CFunctionBody(itertools.chain( + [CDefinitionStatement( + CPointerType(CType('Environment')), + 'env', + CVariableExpression('NULL'), + )], + map(CExpressionStatement, c_expressions[:-1]), + [CReturnStatement(c_expressions[-1])], + )) + +# BEGIN C AST to C source layer + +def generate_pointer_type(pointer_type): + assert isinstance(pointer_type, CPointerType) + return '{}*'.format(generate_type(pointer_type.pointer_to)) + +def generate_type( + type, + generate_pointer_type = generate_pointer_type): + assert isinstance(type, CType) + + if isinstance(type, CPointerType): + return generate_pointer_type(type) + + return type.name + +def generate_argument_declaration(argument_declaration): + assert isinstance(argument_declaration, CArgumentDeclaration) + return '{} {}'.format( + generate_type(argument_declaration._type), + argument_declaration.name, + ) + +def generate_argument_declaration_list(argument_declarations): + return ', '.join(generate_argument_declaration(ad) for ad in argument_declarations) + +def generate_integer_literal_expression(expression): + assert isinstance(expression, CIntegerLiteralExpression) + return str(expression.integer) + +C_ESCAPE_SEQUENCES = { + # Taken from https://en.wikipedia.org/wiki/Escape_sequences_in_C + '\x07' : r'\a', + '\x08' : r'\b', + '\x0c' : r'\f', + '\x0a' : r'\n', + '\x0d' : r'\r', + '\x09' : r'\t', + '\x0b' : r'\v', + '\x5c' : r'\\', + '\x27' : r"\'", + '\x22' : r'\"', + '\x3f' : r'\?', +} + +def generate_string_literal_expression(expression): + assert isinstance(expression, CStringLiteralExpression) + + result = '"' + + for ch in expression.string: + result += C_ESCAPE_SEQUENCES.get(ch, ch) + + result += '"' + + return result + +def generate_variable_expression(expression): + assert isinstance(expression, CVariableExpression) + return expression.name + +def generate_reference_expression(expression): + assert isinstance(expression, CReferenceExpression) + return '&{}'.format(generate_variable_expression(expression.referee)) + +def generate_function_call_expression(expression): + assert isinstance(expression, CFunctionCallExpression) + return '{}({})'.format( + expression.name, + ', '.join(generate_expression(e) for e in expression.arguments), + ) + +def generate_expression( + expression, + generate_integer_literal_expression = generate_integer_literal_expression, + generate_string_literal_expression = generate_string_literal_expression, + generate_variable_expression = generate_variable_expression, + generate_reference_expression = generate_reference_expression, + generate_function_call_expression = generate_function_call_expression, + ): + + if isinstance(expression, CIntegerLiteralExpression): + return generate_integer_literal_expression(expression) + + if isinstance(expression, CStringLiteralExpression): + return generate_string_literal_expression(expression) + + if isinstance(expression, CVariableExpression): + return generate_variable_expression(expression) + + if isinstance(expression, CReferenceExpression): + return generate_reference_expression(expression) + + if isinstance(expression, CFunctionCallExpression): + return generate_function_call_expression(expression) + + raise Exception('Expression type {} not implemented'.format(type(expression))) + +def generate_expression_statement(statement): + return '{};'.format(generate_expression(statement.expression)) + +def generate_return_statement(statement): + return 'return {};'.format(generate_expression(statement.expression)) + +def generate_definition_statement(statement): + return '{} {} = {};'.format( + generate_type(statement._type), + statement.name, + generate_expression(statement.definition), + ) + +def generate_statement( + statement, + generate_expression_statement = generate_expression_statement, + generate_return_statement = generate_return_statement, + generate_definition_statement = generate_definition_statement): + + if isinstance(statement, CExpressionStatement): + return generate_expression_statement(statement) + + if isinstance(statement, CReturnStatement): + return generate_return_statement(statement) + + if isinstance(statement, CDefinitionStatement): + return generate_definition_statement(statement) + + raise Exception('Handling for statements of type {} not implemented'.format(type(statement))) + +def generate_function_body(function_body): + assert isinstance(function_body, CFunctionBody) + return '\n'.join(generate_statement(s) for s in function_body.statements) + +FUNCTION_DEFINITION_TEMPLATE = string.Template( +''' +$return_type $name($argument_declaration_list) +{ +$body +} +'''.strip()) + +def generate_function_declaration(function_declaration): + assert isinstance(function_declaration, CFunctionDeclaration) + return FUNCTION_DEFINITION_TEMPLATE.substitute( + return_type = generate_type(function_declaration.return_type), + name = function_declaration.name, + argument_declaration_list = generate_argument_declaration_list(function_declaration.argument_declaration_list), + body = indent(generate_function_body(function_declaration.body)), + ) + +PROGRAM_TEMPLATE = string.Template( +''' +#include +#include +#include +#include +#include + +struct Object; +typedef struct Object Object; + +enum Type +{ + CELL, + STRING, + SYMBOL +}; +typedef enum Type Type; + +#define MAX_TYPE_STRING_LENGTH 7 + +void typeToString(Type type, char* target) +{ + switch(type) + { + case CELL: + snprintf(target, MAX_TYPE_STRING_LENGTH, "CELL"); + return; + + case STRING: + snprintf(target, MAX_TYPE_STRING_LENGTH, "STRING"); + return; + + case SYMBOL: + snprintf(target, MAX_TYPE_STRING_LENGTH, "%s", "SYMBOL"); + return; + + default: + fprintf(stderr, "ERROR: Unknown type"); + exit(1); + } +} + +struct Cell; +typedef struct Cell Cell; +struct Cell +{ + Object* left; + Object* right; +}; + +struct Environment; +typedef struct Environment Environment; +struct Environment +{ + char* key; + Object* value; + Environment* next; +}; + +Environment makeEnvironment(char* key, Object* value, Environment* next) +{ + Environment result; + result.key = key; + result.value = value; + result.next = next; + return result; +} + +Environment* makeEnvironmentPointerFromEnvironment(Environment env) +{ + Environment* result = malloc(sizeof(Environment)); + *result = env; + return result; +} + +Environment* makeEnvironmentPointer(char* key, Object* value, Environment* next) +{ + return makeEnvironmentPointerFromEnvironment(makeEnvironment(key, value, next)); +} + +union Instance +{ + Cell cell; + char* string; + char* symbol; +}; +typedef union Instance Instance; + +Instance makeInstanceFromCell(Cell cell) +{ + Instance result; + result.cell = cell; + return result; +} + +Instance makeInstanceFromString(char* string) +{ + Instance result; + result.string = string; + return result; +} + +Instance makeInstanceFromSymbol(char* symbol) +{ + Instance result; + result.symbol = symbol; + return result; +} + +struct Object +{ + Type type; + Instance instance; +}; + +Object makeObject(Type t, Instance i) +{ + Object result; + result.type = t; + result.instance = i; + return result; +} + +Object makeObjectFromCell(Cell cell) +{ + return makeObject(CELL, makeInstanceFromCell(cell)); +} + +Object makeObjectFromString(char* string) +{ + return makeObject(STRING, makeInstanceFromString(string)); +} + +Object makeObjectFromSymbol(char* symbol) +{ + return makeObject(SYMBOL, makeInstanceFromSymbol(symbol)); +} + +Object* makeObjectPointerFromObject(Object o) +{ + Object* result = malloc(sizeof(Object)); + *result = o; + return result; +} + +Object* makeObjectPointerFromCell(Cell cell) +{ + return makeObjectPointerFromObject(makeObjectFromCell(cell)); +} + +Object* makeObjectPointerFromString(char* string) +{ + return makeObjectPointerFromObject(makeObjectFromString(string)); +} + +Object* makeObjectPointerFromSymbol(char* symbol) +{ + return makeObjectPointerFromObject(makeObjectFromSymbol(symbol)); +} + +Object* getSymbol(char* symbol) +{ + // This will not always be how this is implemented + return makeObjectPointerFromSymbol(symbol); +} + +Cell makeCell(Object* left, Object* right) +{ + Cell result; + result.left = left; + result.right = right; + return result; +} + +Object* c_cons(Object* left, Object* right) +{ + Cell cell = makeCell(left, right); + return makeObjectPointerFromCell(cell); +} + +void c_print(Object* stutter_string) +{ + if(stutter_string->type != STRING) + { + char typeName[MAX_TYPE_STRING_LENGTH]; + typeToString(stutter_string->type, typeName); + fprintf(stderr, "ERROR: Expected type STRING, got type %s.", typeName); + exit(1); + } + + char* c_string = stutter_string->instance.string; + printf("%s", c_string); +} + +bool c_symbol_equal(char* left, char* right) +{ + return strcmp(left, right) == 0; +} + +Object* c_evaluate_symbol(Environment* env, Object* s) +{ + if(env == NULL) + { + fprintf(stderr, "ERROR: symbol %s not found.", s->instance.symbol); + exit(1); + } + + if(c_symbol_equal(env->key, s->instance.symbol)) + { + return env->value; + } + + return c_evaluate_symbol(env->next, s); +} + +Object* c_evaluate(Environment** env, Object* o) +{ + switch(o->type) + { + case STRING: + return o; + + case SYMBOL: + return c_evaluate_symbol(*env, o); + + default: + break; + } + + char typeName[MAX_TYPE_STRING_LENGTH]; + typeToString(o->type, typeName); + fprintf(stderr, "ERROR: Could not evaluate type %s.", typeName); + exit(1); +} + +int countArgs(Object* args) +{ + if(args == NULL) return 0; + + assert(args->type == CELL); + return 1 + countArgs(args->instance.cell.right); +} + +Object* getArg(int index, Object* args) +{ + if(index == 0) return args->instance.cell.left; + + return getArg(index - 1, args->instance.cell.right); +} + +void print(Environment** parent, Object* args) +{ + assert(countArgs(args) == 1); + Object* stutter_string = c_evaluate(parent, getArg(0, args)); + c_print(stutter_string); +} + +void define(Environment** parent, Object* args) +{ + assert(countArgs(args) == 2); + Object* name = getArg(0, args); + Object* value = c_evaluate(parent, getArg(1, args)); + + assert(name->type == SYMBOL); + *parent = makeEnvironmentPointer(name->instance.symbol, value, *parent); +} + +int main(int argc, char** argv) +{ +$body +} +'''.strip()) + +def generate_program(body): + return PROGRAM_TEMPLATE.substitute( + body = body, + ) + +if __name__ == '__main__': + import sys + source_file_name = sys.argv[1] + + with open(source_file_name, 'r') as source_file: + source = source_file.read() + + result = generate_program( + indent(generate_function_body(evaluate_all_to_c(parse_all(source)))), + ) + + print(result) diff --git a/stutter/stutter_integration_tests.py b/stutter/stutter_integration_tests.py new file mode 100644 index 0000000..0838da0 --- /dev/null +++ b/stutter/stutter_integration_tests.py @@ -0,0 +1,69 @@ +import errno +import os +import os.path +import subprocess +import unittest + +CC = 'gcc-4.9' + +FILE_PATH = os.path.dirname(os.path.realpath(__file__)) +INTEGRATION_TEST_DIRECTORY_PATH = os.path.join(FILE_PATH, 'integration_tests') +os.chdir(FILE_PATH) + +integration_test_file_names = [ + fn + for fn in os.listdir(INTEGRATION_TEST_DIRECTORY_PATH) \ + if fn.endswith('.stt') +] + +C_SOURCE_FILE_PATH = os.path.join(FILE_PATH, 'a.c') +BINARY_PATH = os.path.join(FILE_PATH, 'a.out') + +def generate_test(input_file_name): + input_file_path = os.path.join(INTEGRATION_TEST_DIRECTORY_PATH, input_file_name) + expected_output_file_path = input_file_path[:-4] + '.txt' + + def test(self): + c_source = subprocess.check_output(['python','stutter.py',input_file_path]) + + self.assertIsNotNone(c_source) + self.assertNotEqual(0, len(c_source)) + + with open(C_SOURCE_FILE_PATH,'wb') as c_source_file: + c_source_file.write(c_source) + + cc_result = subprocess.call([CC, C_SOURCE_FILE_PATH]) + + self.assertEqual(0, cc_result) + + with open(expected_output_file_path, 'rb') as expected_output_file: + expected_output = expected_output_file.read() + + actual_output = subprocess.check_output(BINARY_PATH) + + self.assertEqual(expected_output, actual_output) + + return test + +class IntegrationTests(unittest.TestCase): + def tearDown(self): + try: + os.remove(C_SOURCE_FILE_PATH) + + except OSError as e: + if e.errno != errno.ENOENT: + raise + + try: + os.remove(BINARY_PATH) + + except OSError as e: + if e.errno != errno.ENOENT: + raise + +for integration_test_file_name in integration_test_file_names: + test = generate_test(integration_test_file_name) + test_name = 'test_{}'.format(integration_test_file_name[:-4]) + setattr(IntegrationTests, test_name, test) + +unittest.main() diff --git a/stutter/stutter_test.py b/stutter/stutter_test.py new file mode 100644 index 0000000..12c4a2f --- /dev/null +++ b/stutter/stutter_test.py @@ -0,0 +1,530 @@ +#!/usr/bin/env python + +import stutter +import unittest + +class IsIntegerTests(unittest.TestCase): + def test_returns_true_for_integers(self): + for i in range(10): + self.assertTrue(stutter.is_integer(i)) + + def test_returns_false_for_booleans(self): + self.assertFalse(stutter.is_integer(True)) + self.assertFalse(stutter.is_integer(False)) + + def test_returns_false_for_other_types(self): + for o in [object(), '', 0.1, [], (), {}, set()]: + self.assertFalse(stutter.is_integer(o)) + +class UndelimitStringTests(unittest.TestCase): + def test_returns_empty_strings(self): + expected = '' + actual = stutter.undelimit_string('""') + + self.assertEqual(expected, actual) + + def test_returns_strings_without_escapes(self): + expected = 'Hello, world' + actual = stutter.undelimit_string('"Hello, world"') + + self.assertEqual(expected, actual) + + def test_returns_strings_with_newlines(self): + expected = 'Hello, world\nGoodbye, cruel world' + actual = stutter.undelimit_string('"Hello, world\\nGoodbye, cruel world"') + + self.assertEqual(expected, actual) + + def test_returns_strings_with_escaped_delimiters(self): + expected = '"Hello, world"' + actual = stutter.undelimit_string('"\\"Hello, world\\""') + + self.assertEqual(expected, actual) + + def test_returns_strings_with_escaped_escape_characters(self): + expected = '\\no' + actual = stutter.undelimit_string('"\\\\no"') + + self.assertEqual(expected, actual) + +class IndentTests(unittest.TestCase): + def test_indents_single_line(self): + expected = ' Hello, world' + actual = stutter.indent('Hello, world') + self.assertEqual(expected, actual) + + def test_indents_multiple_lines(self): + expected = ' Hello, world\n Goodbye, cruel world' + actual = stutter.indent('Hello, world\nGoodbye, cruel world') + self.assertEqual(expected, actual) + + def test_leaves_empty_lines_empty(self): + expected = ' Hello, world\n\n Goodbye, cruel world' + actual = stutter.indent('Hello, world\n \nGoodbye, cruel world') + self.assertEqual(expected, actual) + + def test_indents_already_indented_lines(self): + expected = ' Hello, world\n\n Goodbye, cruel world' + actual = stutter.indent(' Hello, world\n\n Goodbye, cruel world') + self.assertEqual(expected, actual) + +class ParseAllTests(unittest.TestCase): + def test_parses_integers(self): + expected = [0] + actual = stutter.parse_all('0') + + self.assertEqual(expected, actual) + + def test_parses_identifiers(self): + expected = [stutter.Symbol('print')] + actual = stutter.parse_all('print') + + self.assertEqual(expected, actual) + + def test_parses_identifiers_with_dashes(self): + expected = [stutter.Symbol('hello-world')] + actual = stutter.parse_all('hello-world') + + self.assertEqual(expected, actual) + + def test_parses_strings(self): + expected = ['Hello, world'] + actual = stutter.parse_all('"Hello, world"') + + self.assertEqual(expected, actual) + + def test_parses_strings_with_escaped_delimiters(self): + expected = ['"Hello, world"'] + actual = stutter.parse_all('"\\"Hello, world\\""') + + self.assertEqual(expected, actual) + + def test_parses_empty_s_expressions(self): + expected = [()] + actual = stutter.parse_all('()') + + self.assertEqual(expected, actual) + + def test_parses_s_expressions(self): + expected = [(0, 1, 2)] + actual = stutter.parse_all('(0 1 2)') + + self.assertEqual(expected, actual) + + def test_parses_nested_s_expressions(self): + expected = [(0, (1, (2,)))] + actual = stutter.parse_all('(0 (1 (2)))') + + self.assertEqual(expected, actual) + + def test_parses_multiple_expressions(self): + expected = [0, ()] + actual = stutter.parse_all('0 ()') + + self.assertEqual(expected, actual) + + def test_raises_exception_for_unclosed_parenthese(self): + self.assertRaises(Exception, stutter.parse_all, '(') + + def test_raises_exception_for_unopened_parenthese(self): + self.assertRaises(Exception, stutter.parse_all, ')') + +class QuoteToCTests(unittest.TestCase): + def test_quotes_integer_literals(self): + for i in range(5): + expected = stutter.CFunctionCallExpression( + 'makeObjectPointerFromInteger', + [stutter.CIntegerLiteralExpression(i)], + ) + + actual = stutter.quote_to_c(i) + + self.assertEqual(expected, actual) + + def test_quotes_string_literals(self): + s = 'Hello, world' + expected = stutter.CFunctionCallExpression( + 'makeObjectPointerFromString', + [stutter.CStringLiteralExpression(s)], + ) + + actual = stutter.quote_to_c(s) + + self.assertEqual(expected, actual) + + def test_quotes_symbols(self): + s = 'symbol' + expected = stutter.CFunctionCallExpression( + 'getSymbol', + [stutter.CStringLiteralExpression(s)], + ) + + actual = stutter.quote_to_c(stutter.Symbol(s)) + + self.assertEqual(expected, actual) + +class EvaluateApplicationArgumentsToCTests(unittest.TestCase): + def test_evaluates_empty_to_null(self): + expected = stutter.CVariableExpression('NULL') + actual = stutter.evaluate_application_arguments_to_c(()) + + self.assertEqual(expected, actual) + + def test_evaluates_one_argument_to_cons(self): + argument = 42 + + sentinel = stutter.CStringLiteralExpression('1bd9707e76f8f807f3bad3e39049fea4a36d8ef2f8e2ed471ec755f7adb291d5') + + def mock(argument_to_quote): + if argument_to_quote == argument: + return sentinel + + expected = stutter.CFunctionCallExpression( + 'c_cons', + (sentinel, stutter.CVariableExpression('NULL')), + ) + + actual = stutter.evaluate_application_arguments_to_c( + (argument,), + quote_to_c = mock, + ) + + self.assertEqual(expected, actual) + +class EvaluateApplicationToCTests(unittest.TestCase): + def test_evaluates_function_calls_with_no_arguments(self): + name = 'name' + + sentinel = stutter.CVariableExpression('NULL') + + def mock(arguments): + assert arguments == () + return sentinel + + result = stutter.evaluate_application_to_c( + (stutter.Symbol(name),), + evaluate_application_arguments_to_c = mock, + ) + + self.assertEqual(result.name, name) + self.assertEqual(len(result.arguments), 2) + self.assertTrue(isinstance( + result.arguments[0], + stutter.CReferenceExpression, + )) + self.assertIs(result.arguments[1], sentinel) + + def test_evaluates_function_calls_with_arguments(self): + name = 'print' + argument = 42 + + sentinel = stutter.CFunctionCallExpression( + 'cons', + [ + stutter.CFunctionCallExpression( + 'makeObjectPointerFromInteger', + [stutter.CIntegerLiteralExpression(argument)], + ), + ], + ) + + def mock(arguments): + assert arguments == (argument,) + return sentinel + + result = stutter.evaluate_application_to_c( + (stutter.Symbol(name), argument), + evaluate_application_arguments_to_c = mock, + ) + + self.assertEqual(result.name, name) + self.assertEqual(len(result.arguments), 2) + self.assertTrue(isinstance( + result.arguments[0], + stutter.CReferenceExpression, + )) + self.assertIs(result.arguments[1], sentinel) + +class EvaluateToCTests(unittest.TestCase): + def test_evaluates_integers(self): + for i in range(5): + result = stutter.evaluate_to_c(i) + self.assertIsInstance(result, stutter.CIntegerLiteralExpression) + self.assertEqual(result.integer, i) + + def test_evaluates_string_literals(self): + s = 'Hello, world' + result = stutter.evaluate_to_c(s) + + self.assertIsInstance(result, stutter.CStringLiteralExpression) + self.assertEqual(result.string, s) + + def test_calls_evaluate_application_when_given_an_application(self): + sentinel = object() + application = (stutter.Symbol('print'), 'Hello, world') + + def mock(argument): + if argument == application: + return sentinel + + result = stutter.evaluate_to_c( + application, + evaluate_application_to_c = mock, + ) + + self.assertIs(result, sentinel) + +class EvaluateAllToCTests(unittest.TestCase): + def test_returns_function_body(self): + result = stutter.evaluate_all_to_c([0]) + + self.assertIsInstance(result, stutter.CFunctionBody) + + def test_main_contains_expression_statements_followed_by_return_statement(self): + result = stutter.evaluate_all_to_c([0,0,0]) + + self.assertIsInstance(result.statements[0],stutter.CDefinitionStatement) + self.assertIsInstance(result.statements[1],stutter.CExpressionStatement) + self.assertIsInstance(result.statements[2],stutter.CExpressionStatement) + self.assertIsInstance(result.statements[3],stutter.CReturnStatement) + +class GeneratePointerTypeTests(unittest.TestCase): + def test_basic(self): + expected = 'int*' + actual = stutter.generate_pointer_type(stutter.CPointerType(stutter.CType('int'))) + self.assertEqual(expected, actual) + +class GenerateTypeTests(unittest.TestCase): + def test_basic(self): + expected = 'int' + actual = stutter.generate_type(stutter.CType('int')) + self.assertEqual(expected, actual) + + def test_generates_pointer_types(self): + expected = object() + actual = stutter.generate_type( + stutter.CPointerType(stutter.CType('int')), + generate_pointer_type = lambda x : expected) + + self.assertIs(expected, actual) + +class GenerateArgumentDeclarationTests(unittest.TestCase): + def test_basic(self): + expected = 'int argc' + actual = stutter.generate_argument_declaration( + stutter.CArgumentDeclaration(stutter.CType('int'), 'argc')) + self.assertEqual(expected, actual) + +class GenerateArgumentDeclarationListTests(unittest.TestCase): + def test_basic(self): + argument_declarations = [ + stutter.CArgumentDeclaration(stutter.CType('int'),'argc'), + stutter.CArgumentDeclaration(stutter.CPointerType(stutter.CPointerType(stutter.CType('char'))), 'argv'), + ] + expected = 'int argc, char** argv' + actual = stutter.generate_argument_declaration_list(argument_declarations) + self.assertEqual(expected, actual) + +class GenerateIntegerLiteralExpressionTests(unittest.TestCase): + def test_basic(self): + expected = '0' + actual = stutter.generate_integer_literal_expression( + stutter.CIntegerLiteralExpression(0), + ) + self.assertEqual(expected, actual) + +class GenerateStringLiteralExpressionTests(unittest.TestCase): + def test_basic(self): + expected = '"Hello, world"' + actual = stutter.generate_string_literal_expression( + stutter.CStringLiteralExpression('Hello, world'), + ) + self.assertEqual(expected, actual) + + def test_escapes(self): + expected = r'"\\\n\"\t"' + actual = stutter.generate_string_literal_expression( + stutter.CStringLiteralExpression('\\\n"\t'), + ) + self.assertEqual(expected, actual) + +class GenerateVariableExpressionTests(unittest.TestCase): + def test_generates(self): + expected = 'name' + actual = stutter.generate_variable_expression( + stutter.CVariableExpression(expected), + ) + + self.assertEqual(expected, actual) + +class GenerateReferenceExpressionTests(unittest.TestCase): + def test_generates(self): + expected = '&name'; + actual = stutter.generate_reference_expression( + stutter.CReferenceExpression(stutter.CVariableExpression('name')), + ) + + self.assertEqual(expected, actual) + +class GenerateFunctionCallExpressionTests(unittest.TestCase): + def test_no_arguments(self): + expected = 'name()' + actual = stutter.generate_function_call_expression( + stutter.CFunctionCallExpression('name', []), + ) + self.assertEqual(expected, actual) + + def test_one_argument(self): + expected = 'name(0)' + actual = stutter.generate_function_call_expression( + stutter.CFunctionCallExpression( + 'name', + [ + stutter.CIntegerLiteralExpression(0), + ], + ), + ) + self.assertEqual(expected, actual) + + def test_many_arguments(self): + expected = 'name(0, 1)' + actual = stutter.generate_function_call_expression( + stutter.CFunctionCallExpression( + 'name', + [ + stutter.CIntegerLiteralExpression(0), + stutter.CIntegerLiteralExpression(1), + ], + ), + ) + self.assertEqual(expected, actual) + +class GenerateExpressionTests(unittest.TestCase): + def test_generates_integer_literal_expressions(self): + expected = object() + actual = stutter.generate_expression( + stutter.CIntegerLiteralExpression(0), + generate_integer_literal_expression = lambda x : expected) + + self.assertIs(expected, actual) + + def test_generates_string_literal_expressions(self): + expected = object() + actual = stutter.generate_expression( + stutter.CStringLiteralExpression('Hello, world'), + generate_string_literal_expression = lambda x : expected) + + self.assertIs(expected, actual) + + def test_generates_variable_expression(self): + expected = object() + actual = stutter.generate_expression( + stutter.CVariableExpression('name'), + generate_variable_expression = lambda x : expected) + + self.assertIs(expected, actual) + + def test_generates_variable_expression(self): + expected = object() + actual = stutter.generate_expression( + stutter.CReferenceExpression(stutter.CVariableExpression('name')), + generate_reference_expression = lambda x : expected) + + self.assertIs(expected, actual) + + def test_generates_function_call_expression(self): + expected = object() + actual = stutter.generate_expression( + stutter.CFunctionCallExpression('name',[]), + generate_function_call_expression = lambda x : expected) + + self.assertIs(expected, actual) + +class GenerateStatement(unittest.TestCase): + def test_generates_expression_statement(self): + return_statement = stutter.CExpressionStatement('0') + + expected = object() + actual = stutter.generate_statement( + return_statement, + generate_expression_statement = lambda _ : expected) + + self.assertIs(expected, actual) + + def test_generates_return_statement(self): + return_statement = stutter.CReturnStatement(stutter.CIntegerLiteralExpression(0)) + + expected = object() + actual = stutter.generate_statement( + return_statement, + generate_return_statement = lambda _ : expected) + + self.assertIs(expected, actual) + + def test_generates_definition_statement(self): + definition_statement = stutter.CDefinitionStatement( + stutter.CType('int'), + 'number', + stutter.CIntegerLiteralExpression(0), + ) + + expected = object() + actual = stutter.generate_statement( + definition_statement, + generate_definition_statement = lambda _ : expected) + + self.assertIs(expected, actual) + +class GenerateExpressionStatementTests(unittest.TestCase): + def test_generates_return_statement(self): + expression_statement = stutter.CExpressionStatement(stutter.CIntegerLiteralExpression(0)) + + expected = '0;' + actual = stutter.generate_expression_statement(expression_statement) + + self.assertEqual(expected, actual) + +class GenerateReturnStatementTests(unittest.TestCase): + def test_generates_return_statement(self): + return_statement = stutter.CReturnStatement(stutter.CIntegerLiteralExpression(0)) + + expected = 'return 0;' + actual = stutter.generate_return_statement(return_statement) + + self.assertEqual(expected, actual) + +class GenerateDefinitionStatementTests(unittest.TestCase): + def test_generates_definition_statement(self): + definition_statement = stutter.CDefinitionStatement( + stutter.CType('int'), + 'number', + stutter.CIntegerLiteralExpression(0), + ) + + expected = 'int number = 0;' + actual = stutter.generate_definition_statement(definition_statement) + + self.assertEqual(expected, actual) + +class GenerateFunctionDeclarationTests(unittest.TestCase): + def test_basic(self): + return_type = stutter.CType('int') + argument_declarations = [ + stutter.CArgumentDeclaration(stutter.CType('int'),'argc'), + stutter.CArgumentDeclaration(stutter.CPointerType(stutter.CPointerType(stutter.CType('char'))), 'argv'), + ] + + function_declaration = stutter.CFunctionDeclaration( + return_type, + 'main', + argument_declarations, + stutter.CFunctionBody( + [stutter.CReturnStatement(stutter.CIntegerLiteralExpression(0))], + ), + ) + + expected = 'int main(int argc, char** argv)\n{\n return 0;\n}' + actual = stutter.generate_function_declaration(function_declaration) + self.assertEqual(expected, actual) + +unittest.main() diff --git a/stutter_integration_tests.py b/stutter_integration_tests.py deleted file mode 100644 index 0838da0..0000000 --- a/stutter_integration_tests.py +++ /dev/null @@ -1,69 +0,0 @@ -import errno -import os -import os.path -import subprocess -import unittest - -CC = 'gcc-4.9' - -FILE_PATH = os.path.dirname(os.path.realpath(__file__)) -INTEGRATION_TEST_DIRECTORY_PATH = os.path.join(FILE_PATH, 'integration_tests') -os.chdir(FILE_PATH) - -integration_test_file_names = [ - fn - for fn in os.listdir(INTEGRATION_TEST_DIRECTORY_PATH) \ - if fn.endswith('.stt') -] - -C_SOURCE_FILE_PATH = os.path.join(FILE_PATH, 'a.c') -BINARY_PATH = os.path.join(FILE_PATH, 'a.out') - -def generate_test(input_file_name): - input_file_path = os.path.join(INTEGRATION_TEST_DIRECTORY_PATH, input_file_name) - expected_output_file_path = input_file_path[:-4] + '.txt' - - def test(self): - c_source = subprocess.check_output(['python','stutter.py',input_file_path]) - - self.assertIsNotNone(c_source) - self.assertNotEqual(0, len(c_source)) - - with open(C_SOURCE_FILE_PATH,'wb') as c_source_file: - c_source_file.write(c_source) - - cc_result = subprocess.call([CC, C_SOURCE_FILE_PATH]) - - self.assertEqual(0, cc_result) - - with open(expected_output_file_path, 'rb') as expected_output_file: - expected_output = expected_output_file.read() - - actual_output = subprocess.check_output(BINARY_PATH) - - self.assertEqual(expected_output, actual_output) - - return test - -class IntegrationTests(unittest.TestCase): - def tearDown(self): - try: - os.remove(C_SOURCE_FILE_PATH) - - except OSError as e: - if e.errno != errno.ENOENT: - raise - - try: - os.remove(BINARY_PATH) - - except OSError as e: - if e.errno != errno.ENOENT: - raise - -for integration_test_file_name in integration_test_file_names: - test = generate_test(integration_test_file_name) - test_name = 'test_{}'.format(integration_test_file_name[:-4]) - setattr(IntegrationTests, test_name, test) - -unittest.main() diff --git a/stutter_test.py b/stutter_test.py deleted file mode 100644 index 12c4a2f..0000000 --- a/stutter_test.py +++ /dev/null @@ -1,530 +0,0 @@ -#!/usr/bin/env python - -import stutter -import unittest - -class IsIntegerTests(unittest.TestCase): - def test_returns_true_for_integers(self): - for i in range(10): - self.assertTrue(stutter.is_integer(i)) - - def test_returns_false_for_booleans(self): - self.assertFalse(stutter.is_integer(True)) - self.assertFalse(stutter.is_integer(False)) - - def test_returns_false_for_other_types(self): - for o in [object(), '', 0.1, [], (), {}, set()]: - self.assertFalse(stutter.is_integer(o)) - -class UndelimitStringTests(unittest.TestCase): - def test_returns_empty_strings(self): - expected = '' - actual = stutter.undelimit_string('""') - - self.assertEqual(expected, actual) - - def test_returns_strings_without_escapes(self): - expected = 'Hello, world' - actual = stutter.undelimit_string('"Hello, world"') - - self.assertEqual(expected, actual) - - def test_returns_strings_with_newlines(self): - expected = 'Hello, world\nGoodbye, cruel world' - actual = stutter.undelimit_string('"Hello, world\\nGoodbye, cruel world"') - - self.assertEqual(expected, actual) - - def test_returns_strings_with_escaped_delimiters(self): - expected = '"Hello, world"' - actual = stutter.undelimit_string('"\\"Hello, world\\""') - - self.assertEqual(expected, actual) - - def test_returns_strings_with_escaped_escape_characters(self): - expected = '\\no' - actual = stutter.undelimit_string('"\\\\no"') - - self.assertEqual(expected, actual) - -class IndentTests(unittest.TestCase): - def test_indents_single_line(self): - expected = ' Hello, world' - actual = stutter.indent('Hello, world') - self.assertEqual(expected, actual) - - def test_indents_multiple_lines(self): - expected = ' Hello, world\n Goodbye, cruel world' - actual = stutter.indent('Hello, world\nGoodbye, cruel world') - self.assertEqual(expected, actual) - - def test_leaves_empty_lines_empty(self): - expected = ' Hello, world\n\n Goodbye, cruel world' - actual = stutter.indent('Hello, world\n \nGoodbye, cruel world') - self.assertEqual(expected, actual) - - def test_indents_already_indented_lines(self): - expected = ' Hello, world\n\n Goodbye, cruel world' - actual = stutter.indent(' Hello, world\n\n Goodbye, cruel world') - self.assertEqual(expected, actual) - -class ParseAllTests(unittest.TestCase): - def test_parses_integers(self): - expected = [0] - actual = stutter.parse_all('0') - - self.assertEqual(expected, actual) - - def test_parses_identifiers(self): - expected = [stutter.Symbol('print')] - actual = stutter.parse_all('print') - - self.assertEqual(expected, actual) - - def test_parses_identifiers_with_dashes(self): - expected = [stutter.Symbol('hello-world')] - actual = stutter.parse_all('hello-world') - - self.assertEqual(expected, actual) - - def test_parses_strings(self): - expected = ['Hello, world'] - actual = stutter.parse_all('"Hello, world"') - - self.assertEqual(expected, actual) - - def test_parses_strings_with_escaped_delimiters(self): - expected = ['"Hello, world"'] - actual = stutter.parse_all('"\\"Hello, world\\""') - - self.assertEqual(expected, actual) - - def test_parses_empty_s_expressions(self): - expected = [()] - actual = stutter.parse_all('()') - - self.assertEqual(expected, actual) - - def test_parses_s_expressions(self): - expected = [(0, 1, 2)] - actual = stutter.parse_all('(0 1 2)') - - self.assertEqual(expected, actual) - - def test_parses_nested_s_expressions(self): - expected = [(0, (1, (2,)))] - actual = stutter.parse_all('(0 (1 (2)))') - - self.assertEqual(expected, actual) - - def test_parses_multiple_expressions(self): - expected = [0, ()] - actual = stutter.parse_all('0 ()') - - self.assertEqual(expected, actual) - - def test_raises_exception_for_unclosed_parenthese(self): - self.assertRaises(Exception, stutter.parse_all, '(') - - def test_raises_exception_for_unopened_parenthese(self): - self.assertRaises(Exception, stutter.parse_all, ')') - -class QuoteToCTests(unittest.TestCase): - def test_quotes_integer_literals(self): - for i in range(5): - expected = stutter.CFunctionCallExpression( - 'makeObjectPointerFromInteger', - [stutter.CIntegerLiteralExpression(i)], - ) - - actual = stutter.quote_to_c(i) - - self.assertEqual(expected, actual) - - def test_quotes_string_literals(self): - s = 'Hello, world' - expected = stutter.CFunctionCallExpression( - 'makeObjectPointerFromString', - [stutter.CStringLiteralExpression(s)], - ) - - actual = stutter.quote_to_c(s) - - self.assertEqual(expected, actual) - - def test_quotes_symbols(self): - s = 'symbol' - expected = stutter.CFunctionCallExpression( - 'getSymbol', - [stutter.CStringLiteralExpression(s)], - ) - - actual = stutter.quote_to_c(stutter.Symbol(s)) - - self.assertEqual(expected, actual) - -class EvaluateApplicationArgumentsToCTests(unittest.TestCase): - def test_evaluates_empty_to_null(self): - expected = stutter.CVariableExpression('NULL') - actual = stutter.evaluate_application_arguments_to_c(()) - - self.assertEqual(expected, actual) - - def test_evaluates_one_argument_to_cons(self): - argument = 42 - - sentinel = stutter.CStringLiteralExpression('1bd9707e76f8f807f3bad3e39049fea4a36d8ef2f8e2ed471ec755f7adb291d5') - - def mock(argument_to_quote): - if argument_to_quote == argument: - return sentinel - - expected = stutter.CFunctionCallExpression( - 'c_cons', - (sentinel, stutter.CVariableExpression('NULL')), - ) - - actual = stutter.evaluate_application_arguments_to_c( - (argument,), - quote_to_c = mock, - ) - - self.assertEqual(expected, actual) - -class EvaluateApplicationToCTests(unittest.TestCase): - def test_evaluates_function_calls_with_no_arguments(self): - name = 'name' - - sentinel = stutter.CVariableExpression('NULL') - - def mock(arguments): - assert arguments == () - return sentinel - - result = stutter.evaluate_application_to_c( - (stutter.Symbol(name),), - evaluate_application_arguments_to_c = mock, - ) - - self.assertEqual(result.name, name) - self.assertEqual(len(result.arguments), 2) - self.assertTrue(isinstance( - result.arguments[0], - stutter.CReferenceExpression, - )) - self.assertIs(result.arguments[1], sentinel) - - def test_evaluates_function_calls_with_arguments(self): - name = 'print' - argument = 42 - - sentinel = stutter.CFunctionCallExpression( - 'cons', - [ - stutter.CFunctionCallExpression( - 'makeObjectPointerFromInteger', - [stutter.CIntegerLiteralExpression(argument)], - ), - ], - ) - - def mock(arguments): - assert arguments == (argument,) - return sentinel - - result = stutter.evaluate_application_to_c( - (stutter.Symbol(name), argument), - evaluate_application_arguments_to_c = mock, - ) - - self.assertEqual(result.name, name) - self.assertEqual(len(result.arguments), 2) - self.assertTrue(isinstance( - result.arguments[0], - stutter.CReferenceExpression, - )) - self.assertIs(result.arguments[1], sentinel) - -class EvaluateToCTests(unittest.TestCase): - def test_evaluates_integers(self): - for i in range(5): - result = stutter.evaluate_to_c(i) - self.assertIsInstance(result, stutter.CIntegerLiteralExpression) - self.assertEqual(result.integer, i) - - def test_evaluates_string_literals(self): - s = 'Hello, world' - result = stutter.evaluate_to_c(s) - - self.assertIsInstance(result, stutter.CStringLiteralExpression) - self.assertEqual(result.string, s) - - def test_calls_evaluate_application_when_given_an_application(self): - sentinel = object() - application = (stutter.Symbol('print'), 'Hello, world') - - def mock(argument): - if argument == application: - return sentinel - - result = stutter.evaluate_to_c( - application, - evaluate_application_to_c = mock, - ) - - self.assertIs(result, sentinel) - -class EvaluateAllToCTests(unittest.TestCase): - def test_returns_function_body(self): - result = stutter.evaluate_all_to_c([0]) - - self.assertIsInstance(result, stutter.CFunctionBody) - - def test_main_contains_expression_statements_followed_by_return_statement(self): - result = stutter.evaluate_all_to_c([0,0,0]) - - self.assertIsInstance(result.statements[0],stutter.CDefinitionStatement) - self.assertIsInstance(result.statements[1],stutter.CExpressionStatement) - self.assertIsInstance(result.statements[2],stutter.CExpressionStatement) - self.assertIsInstance(result.statements[3],stutter.CReturnStatement) - -class GeneratePointerTypeTests(unittest.TestCase): - def test_basic(self): - expected = 'int*' - actual = stutter.generate_pointer_type(stutter.CPointerType(stutter.CType('int'))) - self.assertEqual(expected, actual) - -class GenerateTypeTests(unittest.TestCase): - def test_basic(self): - expected = 'int' - actual = stutter.generate_type(stutter.CType('int')) - self.assertEqual(expected, actual) - - def test_generates_pointer_types(self): - expected = object() - actual = stutter.generate_type( - stutter.CPointerType(stutter.CType('int')), - generate_pointer_type = lambda x : expected) - - self.assertIs(expected, actual) - -class GenerateArgumentDeclarationTests(unittest.TestCase): - def test_basic(self): - expected = 'int argc' - actual = stutter.generate_argument_declaration( - stutter.CArgumentDeclaration(stutter.CType('int'), 'argc')) - self.assertEqual(expected, actual) - -class GenerateArgumentDeclarationListTests(unittest.TestCase): - def test_basic(self): - argument_declarations = [ - stutter.CArgumentDeclaration(stutter.CType('int'),'argc'), - stutter.CArgumentDeclaration(stutter.CPointerType(stutter.CPointerType(stutter.CType('char'))), 'argv'), - ] - expected = 'int argc, char** argv' - actual = stutter.generate_argument_declaration_list(argument_declarations) - self.assertEqual(expected, actual) - -class GenerateIntegerLiteralExpressionTests(unittest.TestCase): - def test_basic(self): - expected = '0' - actual = stutter.generate_integer_literal_expression( - stutter.CIntegerLiteralExpression(0), - ) - self.assertEqual(expected, actual) - -class GenerateStringLiteralExpressionTests(unittest.TestCase): - def test_basic(self): - expected = '"Hello, world"' - actual = stutter.generate_string_literal_expression( - stutter.CStringLiteralExpression('Hello, world'), - ) - self.assertEqual(expected, actual) - - def test_escapes(self): - expected = r'"\\\n\"\t"' - actual = stutter.generate_string_literal_expression( - stutter.CStringLiteralExpression('\\\n"\t'), - ) - self.assertEqual(expected, actual) - -class GenerateVariableExpressionTests(unittest.TestCase): - def test_generates(self): - expected = 'name' - actual = stutter.generate_variable_expression( - stutter.CVariableExpression(expected), - ) - - self.assertEqual(expected, actual) - -class GenerateReferenceExpressionTests(unittest.TestCase): - def test_generates(self): - expected = '&name'; - actual = stutter.generate_reference_expression( - stutter.CReferenceExpression(stutter.CVariableExpression('name')), - ) - - self.assertEqual(expected, actual) - -class GenerateFunctionCallExpressionTests(unittest.TestCase): - def test_no_arguments(self): - expected = 'name()' - actual = stutter.generate_function_call_expression( - stutter.CFunctionCallExpression('name', []), - ) - self.assertEqual(expected, actual) - - def test_one_argument(self): - expected = 'name(0)' - actual = stutter.generate_function_call_expression( - stutter.CFunctionCallExpression( - 'name', - [ - stutter.CIntegerLiteralExpression(0), - ], - ), - ) - self.assertEqual(expected, actual) - - def test_many_arguments(self): - expected = 'name(0, 1)' - actual = stutter.generate_function_call_expression( - stutter.CFunctionCallExpression( - 'name', - [ - stutter.CIntegerLiteralExpression(0), - stutter.CIntegerLiteralExpression(1), - ], - ), - ) - self.assertEqual(expected, actual) - -class GenerateExpressionTests(unittest.TestCase): - def test_generates_integer_literal_expressions(self): - expected = object() - actual = stutter.generate_expression( - stutter.CIntegerLiteralExpression(0), - generate_integer_literal_expression = lambda x : expected) - - self.assertIs(expected, actual) - - def test_generates_string_literal_expressions(self): - expected = object() - actual = stutter.generate_expression( - stutter.CStringLiteralExpression('Hello, world'), - generate_string_literal_expression = lambda x : expected) - - self.assertIs(expected, actual) - - def test_generates_variable_expression(self): - expected = object() - actual = stutter.generate_expression( - stutter.CVariableExpression('name'), - generate_variable_expression = lambda x : expected) - - self.assertIs(expected, actual) - - def test_generates_variable_expression(self): - expected = object() - actual = stutter.generate_expression( - stutter.CReferenceExpression(stutter.CVariableExpression('name')), - generate_reference_expression = lambda x : expected) - - self.assertIs(expected, actual) - - def test_generates_function_call_expression(self): - expected = object() - actual = stutter.generate_expression( - stutter.CFunctionCallExpression('name',[]), - generate_function_call_expression = lambda x : expected) - - self.assertIs(expected, actual) - -class GenerateStatement(unittest.TestCase): - def test_generates_expression_statement(self): - return_statement = stutter.CExpressionStatement('0') - - expected = object() - actual = stutter.generate_statement( - return_statement, - generate_expression_statement = lambda _ : expected) - - self.assertIs(expected, actual) - - def test_generates_return_statement(self): - return_statement = stutter.CReturnStatement(stutter.CIntegerLiteralExpression(0)) - - expected = object() - actual = stutter.generate_statement( - return_statement, - generate_return_statement = lambda _ : expected) - - self.assertIs(expected, actual) - - def test_generates_definition_statement(self): - definition_statement = stutter.CDefinitionStatement( - stutter.CType('int'), - 'number', - stutter.CIntegerLiteralExpression(0), - ) - - expected = object() - actual = stutter.generate_statement( - definition_statement, - generate_definition_statement = lambda _ : expected) - - self.assertIs(expected, actual) - -class GenerateExpressionStatementTests(unittest.TestCase): - def test_generates_return_statement(self): - expression_statement = stutter.CExpressionStatement(stutter.CIntegerLiteralExpression(0)) - - expected = '0;' - actual = stutter.generate_expression_statement(expression_statement) - - self.assertEqual(expected, actual) - -class GenerateReturnStatementTests(unittest.TestCase): - def test_generates_return_statement(self): - return_statement = stutter.CReturnStatement(stutter.CIntegerLiteralExpression(0)) - - expected = 'return 0;' - actual = stutter.generate_return_statement(return_statement) - - self.assertEqual(expected, actual) - -class GenerateDefinitionStatementTests(unittest.TestCase): - def test_generates_definition_statement(self): - definition_statement = stutter.CDefinitionStatement( - stutter.CType('int'), - 'number', - stutter.CIntegerLiteralExpression(0), - ) - - expected = 'int number = 0;' - actual = stutter.generate_definition_statement(definition_statement) - - self.assertEqual(expected, actual) - -class GenerateFunctionDeclarationTests(unittest.TestCase): - def test_basic(self): - return_type = stutter.CType('int') - argument_declarations = [ - stutter.CArgumentDeclaration(stutter.CType('int'),'argc'), - stutter.CArgumentDeclaration(stutter.CPointerType(stutter.CPointerType(stutter.CType('char'))), 'argv'), - ] - - function_declaration = stutter.CFunctionDeclaration( - return_type, - 'main', - argument_declarations, - stutter.CFunctionBody( - [stutter.CReturnStatement(stutter.CIntegerLiteralExpression(0))], - ), - ) - - expected = 'int main(int argc, char** argv)\n{\n return 0;\n}' - actual = stutter.generate_function_declaration(function_declaration) - self.assertEqual(expected, actual) - -unittest.main()