diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/Setup.lhs b/Setup.lhs new file mode 100644 --- /dev/null +++ b/Setup.lhs @@ -0,0 +1,3 @@ +#!/usr/bin/env runhaskell +> import Distribution.Simple +> main = defaultMain diff --git a/cimple.cabal b/cimple.cabal new file mode 100644 --- /dev/null +++ b/cimple.cabal @@ -0,0 +1,89 @@ +name: cimple +version: 0.0.1 +synopsis: Simple C-like programming language +homepage: https://toktok.github.io/ +license: GPL-3 +license-file: LICENSE +author: Iphigenia Df +maintainer: Iphigenia Df +copyright: Copyright (c) 2016-2020, Iphigenia Df +category: Data +stability: Experimental +cabal-version: >= 1.10 +build-type: Simple +description: + Parser and AST for Cimple, a simple C-like programming language. + +source-repository head + type: git + location: https://github.com/TokTok/hs-cimple + +library + default-language: Haskell2010 + hs-source-dirs: + src + ghc-options: + -Wall + build-tools: alex, happy + exposed-modules: + Language.Cimple + , Language.Cimple.Diagnostics + , Language.Cimple.IO + , Language.Cimple.TraverseAst + other-modules: + Language.Cimple.AST + , Language.Cimple.Lexer + , Language.Cimple.Parser + , Language.Cimple.Tokens + build-depends: + base < 5 + , aeson + , array + , bytestring + , compact + , containers + , mtl + , text + +executable dump-ast + default-language: Haskell2010 + hs-source-dirs: + tools + ghc-options: + -Wall + main-is: dump-ast.hs + build-depends: + base < 5 + , bytestring + , cimple + , groom + , text + +executable dump-tokens + default-language: Haskell2010 + hs-source-dirs: + tools + ghc-options: + -Wall + main-is: dump-tokens.hs + build-depends: + base < 5 + , bytestring + , cimple + , groom + , text + +test-suite testsuite + type: exitcode-stdio-1.0 + default-language: Haskell2010 + hs-source-dirs: test + main-is: testsuite.hs + other-modules: + Language.CimpleSpec + ghc-options: + -Wall + -fno-warn-unused-imports + build-depends: + base < 5 + , cimple + , hspec diff --git a/src/Language/Cimple.hs b/src/Language/Cimple.hs new file mode 100644 --- /dev/null +++ b/src/Language/Cimple.hs @@ -0,0 +1,6 @@ +module Language.Cimple (module X) where + +import Language.Cimple.AST as X +import Language.Cimple.Lexer as X +import Language.Cimple.Parser as X +import Language.Cimple.Tokens as X diff --git a/src/Language/Cimple/AST.hs b/src/Language/Cimple/AST.hs new file mode 100644 --- /dev/null +++ b/src/Language/Cimple/AST.hs @@ -0,0 +1,189 @@ +{-# LANGUAGE DeriveFunctor #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE DeriveTraversable #-} +module Language.Cimple.AST + ( AssignOp (..) + , BinaryOp (..) + , UnaryOp (..) + , LiteralType (..) + , Node (..) + , Scope (..) + ) where + +import Data.Aeson (FromJSON, ToJSON) +import GHC.Generics (Generic) + +data Node lexeme + -- Preprocessor + = PreprocInclude lexeme + | PreprocDefine lexeme + | PreprocDefineConst lexeme (Node lexeme) + | PreprocDefineMacro lexeme [Node lexeme] (Node lexeme) + | PreprocIf (Node lexeme) [Node lexeme] (Node lexeme) + | PreprocIfdef lexeme [Node lexeme] (Node lexeme) + | PreprocIfndef lexeme [Node lexeme] (Node lexeme) + | PreprocElse [Node lexeme] + | PreprocElif (Node lexeme) [Node lexeme] (Node lexeme) + | PreprocError lexeme + | PreprocUndef lexeme + | PreprocDefined lexeme + | PreprocScopedDefine (Node lexeme) [Node lexeme] (Node lexeme) + | MacroBodyStmt [Node lexeme] + | MacroBodyFunCall (Node lexeme) + | MacroParam lexeme + -- Comments + | Comment [Node lexeme] + | CommentBlock lexeme + | CommentWord lexeme + | Commented (Node lexeme) (Node lexeme) + -- Namespace-like blocks + | ExternC [Node lexeme] + | Class Scope lexeme [Node lexeme] [Node lexeme] + | Namespace Scope lexeme [Node lexeme] + -- Statements + | CompoundStmt [Node lexeme] + | Break + | Goto lexeme + | Continue + | Return (Maybe (Node lexeme)) + | Switch (Node lexeme) [Node lexeme] + | IfStmt (Node lexeme) [Node lexeme] (Maybe (Node lexeme)) + | ForStmt (Maybe (Node lexeme)) (Maybe (Node lexeme)) (Maybe (Node lexeme)) [Node lexeme] + | WhileStmt (Node lexeme) [Node lexeme] + | DoWhileStmt [Node lexeme] (Node lexeme) + | Case (Node lexeme) (Node lexeme) + | Default (Node lexeme) + | Label lexeme (Node lexeme) + -- Variable declarations + | VLA (Node lexeme) lexeme (Node lexeme) + | VarDecl (Node lexeme) [Node lexeme] + | Declarator (Node lexeme) (Maybe (Node lexeme)) + | DeclSpecVar lexeme + | DeclSpecArray (Node lexeme) (Maybe (Node lexeme)) + -- Expressions + | InitialiserList [Node lexeme] + | UnaryExpr UnaryOp (Node lexeme) + | BinaryExpr (Node lexeme) BinaryOp (Node lexeme) + | TernaryExpr (Node lexeme) (Node lexeme) (Node lexeme) + | AssignExpr (Node lexeme) AssignOp (Node lexeme) + | ParenExpr (Node lexeme) + | CastExpr (Node lexeme) (Node lexeme) + | SizeofExpr (Node lexeme) + | LiteralExpr LiteralType lexeme + | VarExpr lexeme + | MemberAccess (Node lexeme) lexeme + | PointerAccess (Node lexeme) lexeme + | ArrayAccess (Node lexeme) (Node lexeme) + | FunctionCall (Node lexeme) [Node lexeme] + | CommentExpr (Node lexeme) (Node lexeme) + -- Type definitions + | EnumClass lexeme [Node lexeme] + | EnumConsts (Maybe lexeme) [Node lexeme] + | EnumDecl lexeme [Node lexeme] lexeme + | Enumerator lexeme (Maybe (Node lexeme)) + | ClassForward lexeme [Node lexeme] + | Typedef (Node lexeme) lexeme + | TypedefFunction (Node lexeme) + | Struct lexeme [Node lexeme] + | Union lexeme [Node lexeme] + | MemberDecl (Node lexeme) (Node lexeme) (Maybe lexeme) + | TyConst (Node lexeme) + | TyPointer (Node lexeme) + | TyStruct lexeme + | TyFunc lexeme + | TyStd lexeme + | TyVar lexeme + | TyUserDefined lexeme + -- Functions + | FunctionDecl Scope (Node lexeme) (Maybe (Node lexeme)) + | FunctionDefn Scope (Node lexeme) [Node lexeme] + | FunctionPrototype (Node lexeme) lexeme [Node lexeme] + | FunctionParam (Node lexeme) (Node lexeme) + | Event lexeme (Node lexeme) + | EventParams [Node lexeme] + | Property (Node lexeme) (Node lexeme) [Node lexeme] + | Accessor lexeme [Node lexeme] (Maybe (Node lexeme)) + | ErrorDecl lexeme [Node lexeme] + | ErrorList [Node lexeme] + | ErrorFor lexeme + | Ellipsis + -- Constants + | ConstDecl (Node lexeme) lexeme + | ConstDefn Scope (Node lexeme) lexeme (Node lexeme) + deriving (Show, Eq, Generic, Functor, Foldable, Traversable) + +instance FromJSON lexeme => FromJSON (Node lexeme) +instance ToJSON lexeme => ToJSON (Node lexeme) + +data AssignOp + = AopEq + | AopMul + | AopDiv + | AopPlus + | AopMinus + | AopBitAnd + | AopBitOr + | AopBitXor + | AopMod + | AopLsh + | AopRsh + deriving (Show, Eq, Generic) + +instance FromJSON AssignOp +instance ToJSON AssignOp + +data BinaryOp + = BopNe + | BopEq + | BopOr + | BopBitXor + | BopBitOr + | BopAnd + | BopBitAnd + | BopDiv + | BopMul + | BopMod + | BopPlus + | BopMinus + | BopLt + | BopLe + | BopLsh + | BopGt + | BopGe + | BopRsh + deriving (Show, Eq, Generic) + +instance FromJSON BinaryOp +instance ToJSON BinaryOp + +data UnaryOp + = UopNot + | UopNeg + | UopMinus + | UopAddress + | UopDeref + | UopIncr + | UopDecr + deriving (Show, Eq, Generic) + +instance FromJSON UnaryOp +instance ToJSON UnaryOp + +data LiteralType + = Char + | Int + | Bool + | String + | ConstId + deriving (Show, Eq, Generic) + +instance FromJSON LiteralType +instance ToJSON LiteralType + +data Scope + = Global + | Static + deriving (Show, Eq, Generic) + +instance FromJSON Scope +instance ToJSON Scope diff --git a/src/Language/Cimple/Diagnostics.hs b/src/Language/Cimple/Diagnostics.hs new file mode 100644 --- /dev/null +++ b/src/Language/Cimple/Diagnostics.hs @@ -0,0 +1,17 @@ +{-# LANGUAGE OverloadedStrings #-} +module Language.Cimple.Diagnostics (Diagnostics, warn) where + +import Control.Monad.State.Lazy (State) +import qualified Control.Monad.State.Lazy as State +import Data.Text (Text) +import qualified Data.Text as Text +import Language.Cimple.Lexer (Lexeme (..), lexemeLine) + +type Diagnostics a = State [Text] a + +warn :: FilePath -> Lexeme Text -> Text -> Diagnostics () +warn file l w = do + diags <- State.get + State.put $ diag : diags + where + diag = Text.pack file <> ":" <> Text.pack (show (lexemeLine l)) <> ": " <> w diff --git a/src/Language/Cimple/IO.hs b/src/Language/Cimple/IO.hs new file mode 100644 --- /dev/null +++ b/src/Language/Cimple/IO.hs @@ -0,0 +1,51 @@ +module Language.Cimple.IO + ( parseFile + , parseText + ) where + +import Control.Monad.State.Lazy (State, get, put, runState) +import qualified Data.ByteString as BS +import qualified Data.Compact as Compact +import Data.Map.Strict (Map) +import qualified Data.Map.Strict as Map +import Data.Text (Text) +import qualified Data.Text as Text +import qualified Data.Text.Encoding as Text +import Language.Cimple.AST (Node (..)) +import Language.Cimple.Lexer (Lexeme, runAlex) +import Language.Cimple.Parser (parseCimple) + + +type CompactState a = State (Map String Text) a + +cacheText :: String -> CompactState Text +cacheText s = do + m <- get + case Map.lookup s m of + Nothing -> do + let text = Text.pack s + put $ Map.insert s text m + return text + Just text -> + return text + + +process :: [Node (Lexeme String)] -> IO [Node (Lexeme Text)] +process stringAst = do + let (textAst, _) = runState (mapM (mapM (mapM cacheText)) stringAst) Map.empty + Compact.getCompact <$> Compact.compactWithSharing textAst + + +parseText :: Text -> IO (Either String [Node (Lexeme Text)]) +parseText contents = + mapM process res + where + res :: Either String [Node (Lexeme String)] + res = runAlex (Text.unpack contents) parseCimple + + +parseFile :: FilePath -> IO (Either String [Node (Lexeme Text)]) +parseFile source = do + putStrLn $ "Processing " ++ source + contents <- Text.decodeUtf8 <$> BS.readFile source + parseText contents diff --git a/src/Language/Cimple/Lexer.x b/src/Language/Cimple/Lexer.x new file mode 100644 --- /dev/null +++ b/src/Language/Cimple/Lexer.x @@ -0,0 +1,293 @@ +{ +{-# LANGUAGE DeriveFunctor #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE DeriveTraversable #-} +{-# LANGUAGE StandaloneDeriving #-} +module Language.Cimple.Lexer + ( Alex + , AlexPosn (..) + , alexError + , alexScanTokens + , alexMonadScan + , Lexeme (..) + , lexemeClass + , lexemePosn + , lexemeText + , lexemeLine + , mkL + , runAlex + ) where + +import Data.Aeson (FromJSON, ToJSON) +import GHC.Generics (Generic) +import Language.Cimple.Tokens (LexemeClass (..)) +} + +%wrapper "monad" + +tokens :- + +-- Ignore attributes. +<0> "GNU_PRINTF("[^\)]+")" ; +<0> "VLA" { mkL KwVla } + +-- Winapi functions. +<0> "WSAAddressToString" { mkL IdVar } +<0> "LocalFree" { mkL IdVar } +<0> "FormatMessageA" { mkL IdVar } +<0> "WSAGetLastError" { mkL IdVar } +<0> "WSAStringToAddress" { mkL IdVar } +<0> "WSAStartup" { mkL IdVar } +<0> "GetAdaptersInfo" { mkL IdVar } +<0> "WSACleanup" { mkL IdVar } +<0> "GetSystemTimeAsFileTime" { mkL IdVar } +<0> "GetTickCount" { mkL IdVar } +<0> "SecureZeroMemory" { mkL IdVar } + +-- Winapi struct members. +<0> "GatewayList" { mkL IdVar } +<0> "Next" { mkL IdVar } +<0> "IpAddress" { mkL IdVar } +<0> "IpAddressList" { mkL IdVar } +<0> "IpMask" { mkL IdVar } +<0> "String" { mkL IdVar } + +-- Windows typedefs. +<0> "DWORD" { mkL IdStdType } +<0> "FILETIME" { mkL IdStdType } +<0> "INT" { mkL IdStdType } +<0> "LPSOCKADDR" { mkL IdStdType } +<0> "IP_ADAPTER_INFO" { mkL IdStdType } +<0> "LPTSTR" { mkL IdStdType } +<0> "u_long" { mkL IdStdType } +<0> "WSADATA" { mkL IdStdType } + +-- System struct types. +<0> "addrinfo" { mkL IdSueType } +<0> "ifconf" { mkL IdSueType } +<0> "ifreq" { mkL IdSueType } +<0> "epoll_event" { mkL IdSueType } +<0> "in_addr" { mkL IdSueType } +<0> "in6_addr" { mkL IdSueType } +<0> "ipv6_mreq" { mkL IdSueType } +<0> "sockaddr" { mkL IdSueType } +<0> "sockaddr_in" { mkL IdSueType } +<0> "sockaddr_in6" { mkL IdSueType } +<0> "sockaddr_storage" { mkL IdSueType } +<0> "timespec" { mkL IdSueType } +<0> "timeval" { mkL IdSueType } + +-- Sodium constants. +<0,ppSC> "crypto_auth_"[A-Z][A-Z0-9_]* { mkL IdConst } +<0,ppSC> "crypto_box_"[A-Z][A-Z0-9_]* { mkL IdConst } +<0,ppSC> "crypto_hash_sha256_"[A-Z][A-Z0-9_]* { mkL IdConst } +<0,ppSC> "crypto_hash_sha512_"[A-Z][A-Z0-9_]* { mkL IdConst } +<0,ppSC> "crypto_sign_"[A-Z][A-Z0-9_]* { mkL IdConst } +<0> "MAX" { mkL IdConst } +<0> "MIN" { mkL IdConst } + +-- Standard C (ish). + defined { mkL PpDefined } + \"[^\"]*\" { mkL LitString } + \n { mkL PpNewline `andBegin` 0 } + \\\n ; + $white ; + + "//!TOKSTYLE+" { start 0 } + [.\n] ; + +<0,ppSC> "//"\n ; +<0,ppSC> "// ".* ; +<0> $white+ ; +<0> "//!TOKSTYLE-" { start ignoreSC } +<0> "/*""*"? { mkL CmtStart `andBegin` cmtSC } +<0> "/""*"+\n" *"\n" * :: ".+\n" *"\n" ""*"+"/" { mkL CmtBlock } +<0,cmtSC> \"(\\.|[^\"])*\" { mkL LitString } +<0> '(\\|[^'])*' { mkL LitChar } +<0> "<"[a-z0-9\.\/_]+">" { mkL LitSysInclude } +<0> "#if" { mkL PpIf `andBegin` ppSC } +<0> "#ifdef" { mkL PpIfdef } +<0> "#ifndef" { mkL PpIfndef } +<0> "#elif" { mkL PpElif `andBegin` ppSC } +<0> "#else" { mkL PpElse } +<0> "#endif" { mkL PpEndif } +<0> "#define" { mkL PpDefine `andBegin` ppSC } +<0> "#undef" { mkL PpUndef } +<0> "#include" { mkL PpInclude } +<0> "#error" { mkL PpError } +<0,ppSC> "bitmask" { mkL KwBitmask } +<0,ppSC> "break" { mkL KwBreak } +<0,ppSC> "case" { mkL KwCase } +<0,ppSC> "class" { mkL KwClass } +<0,ppSC> "const" { mkL KwConst } +<0,ppSC> "continue" { mkL KwContinue } +<0,ppSC> "default" { mkL KwDefault } +<0,ppSC> "do" { mkL KwDo } +<0,ppSC> "else" { mkL KwElse } +<0,ppSC> "enum" { mkL KwEnum } +<0,ppSC> "error" { mkL KwError } +<0,ppSC> "event" { mkL KwEvent } +<0,ppSC> "extern" { mkL KwExtern } +<0,ppSC> "for" { mkL KwFor } +<0,ppSC> "goto" { mkL KwGoto } +<0,ppSC> "if" { mkL KwIf } +<0,ppSC> "namespace" { mkL KwNamespace } +<0,ppSC> "return" { mkL KwReturn } +<0,ppSC> "sizeof" { mkL KwSizeof } +<0,ppSC> "static" { mkL KwStatic } +<0,ppSC> "struct" { mkL KwStruct } +<0,ppSC> "switch" { mkL KwSwitch } +<0,ppSC> "this" { mkL KwThis } +<0,ppSC> "typedef" { mkL KwTypedef } +<0,ppSC> "union" { mkL KwUnion } +<0,ppSC> "void" { mkL KwVoid } +<0,ppSC> "while" { mkL KwWhile } +<0,ppSC> "with" { mkL KwWith } +<0,ppSC> "bool" { mkL IdStdType } +<0,ppSC> "char" { mkL IdStdType } +<0,ppSC> "double" { mkL IdStdType } +<0,ppSC> "float" { mkL IdStdType } +<0,ppSC> "int" { mkL IdStdType } +<0,ppSC> "long int" { mkL IdStdType } +<0,ppSC> "long signed int" { mkL IdStdType } +<0,ppSC> "long" { mkL IdStdType } +<0,ppSC> "signed int" { mkL IdStdType } +<0,ppSC> "unsigned int" { mkL IdStdType } +<0,ppSC> "unsigned long" { mkL IdStdType } +<0,ppSC> "unsigned long long" { mkL IdStdType } +<0,ppSC> "unsigned" { mkL IdStdType } +<0,ppSC> "va_list" { mkL IdStdType } +<0,ppSC> "false" { mkL LitFalse } +<0,ppSC> "true" { mkL LitTrue } +<0,ppSC> "`"[a-z]+ { mkL IdTyVar } +<0,ppSC> "__func__" { mkL IdVar } +<0,ppSC> "__"[a-zA-Z]+"__"? { mkL IdConst } +<0,ppSC> [A-Z][A-Z0-9_]{1,2} { mkL IdSueType } +<0,ppSC> _*[A-Z][A-Z0-9_]* { mkL IdConst } +<0,ppSC> [A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]* { mkL IdSueType } +<0,ppSC> [a-z][a-z0-9_]*_t { mkL IdStdType } +<0,ppSC> [a-z][a-z0-9_]*_cb { mkL IdFuncType } +<0,ppSC> [a-z][A-Za-z0-9_]* { mkL IdVar } +<0,ppSC,cmtSC> [0-9]+[LU]* { mkL LitInteger } +<0,ppSC> [0-9]+"."[0-9]+f? { mkL LitInteger } +<0,ppSC> 0x[0-9a-fA-F]+[LU]* { mkL LitInteger } +<0,ppSC,cmtSC> "=" { mkL PctEq } +<0,ppSC> "==" { mkL PctEqEq } +<0,ppSC> "&" { mkL PctAmpersand } +<0,ppSC> "&&" { mkL PctAmpersandAmpersand } +<0,ppSC> "&=" { mkL PctAmpersandEq } +<0,ppSC> "->" { mkL PctArrow } +<0,ppSC,cmtSC> "," { mkL PctComma } +<0,ppSC,cmtSC> "+" { mkL PctPlus } +<0,ppSC> "++" { mkL PctPlusPlus } +<0,ppSC> "+=" { mkL PctPlusEq } +<0,ppSC,cmtSC> "-" { mkL PctMinus } +<0,ppSC> "--" { mkL PctMinusMinus } +<0,ppSC> "-=" { mkL PctMinusEq } +<0,ppSC> "~" { mkL PctTilde } +<0,ppSC,cmtSC> "/" { mkL PctSlash } +<0,ppSC> "/=" { mkL PctSlashEq } +<0,ppSC,cmtSC> "." { mkL PctPeriod } +<0,ppSC> "..." { mkL PctEllipsis } +<0,ppSC> "%" { mkL PctPercent } +<0,ppSC> "%=" { mkL PctPercentEq } +<0,ppSC,cmtSC> ";" { mkL PctSemicolon } +<0,ppSC,cmtSC> ":" { mkL PctColon } +<0,ppSC,cmtSC> "<" { mkL PctLess } +<0,ppSC> "<<" { mkL PctLessLess } +<0,ppSC> "<<=" { mkL PctLessLessEq } +<0,ppSC> "<=" { mkL PctLessEq } +<0,ppSC,cmtSC> ">" { mkL PctGreater } +<0,ppSC> ">>" { mkL PctGreaterGreater } +<0,ppSC> ">>=" { mkL PctGreaterGreaterEq } +<0,ppSC> ">=" { mkL PctGreaterEq } +<0,ppSC> "|" { mkL PctPipe } +<0,ppSC> "||" { mkL PctPipePipe } +<0,ppSC> "|=" { mkL PctPipeEq } +<0,ppSC> "[" { mkL PctLBrack } +<0,ppSC> "]" { mkL PctRBrack } +<0,ppSC> "{" { mkL PctLBrace } +<0,ppSC> "}" { mkL PctRBrace } +<0,ppSC,cmtSC> "(" { mkL PctLParen } +<0,ppSC,cmtSC> ")" { mkL PctRParen } +<0,ppSC,cmtSC> "?" { mkL PctQMark } +<0,ppSC,cmtSC> "!" { mkL PctEMark } +<0,ppSC> "!=" { mkL PctEMarkEq } +<0,ppSC> "*" { mkL PctAsterisk } +<0,ppSC> "*=" { mkL PctAsteriskEq } +<0,ppSC> "^" { mkL PctCaret } +<0,ppSC> "^=" { mkL PctCaretEq } + +-- Comments. + "Copyright ©" { mkL CmtSpdxCopyright } + "SPDX-License-Identifier:" { mkL CmtSpdxLicense } + "GPL-3.0-or-later" { mkL CmtWord } + "TODO("[^\)]+"):" { mkL CmtWord } + "@code" { mkL CmtCode `andBegin` codeSC } + "" { mkL CmtCode `andBegin` codeSC } + [@\\][a-z]+ { mkL CmtWord } + "*"[A-Za-z][A-Za-z0-9_']*"*" { mkL CmtWord } + "#"[A-Za-z][A-Za-z0-9_]* { mkL CmtRef } + [A-Za-z][A-Za-z0-9_']* { mkL CmtWord } + "#"[0-9]+ { mkL CmtWord } + "http://"[^ ]+ { mkL CmtWord } + [0-9]+"%" { mkL LitInteger } + "`"([^`]|"\`")+"`" { mkL CmtCode } + "*/" { mkL CmtEnd `andBegin` 0 } + \n" "+"*/" { mkL CmtEnd `andBegin` 0 } + \n" "+"*" { mkL PpNewline } + \n { mkL PpNewline } + " "+ ; + +-- blocks in comments. + "@endcode" { mkL CmtCode `andBegin` cmtSC } + "" { mkL CmtCode `andBegin` cmtSC } + [^@\<]+ { mkL CmtCode } + +-- Error handling. +<0,ppSC,cmtSC,codeSC> . { mkL Error } + +{ +deriving instance Generic AlexPosn +instance FromJSON AlexPosn +instance ToJSON AlexPosn + +data Lexeme text = L AlexPosn LexemeClass text + deriving (Show, Eq, Generic, Functor, Foldable, Traversable) + +instance FromJSON text => FromJSON (Lexeme text) +instance ToJSON text => ToJSON (Lexeme text) + +mkL :: Applicative m => LexemeClass -> AlexInput -> Int -> m (Lexeme String) +mkL c (p, _, _, str) len = pure $ L p c (take len str) + +lexemePosn :: Lexeme text -> AlexPosn +lexemePosn (L p _ _) = p + +lexemeClass :: Lexeme text -> LexemeClass +lexemeClass (L _ c _) = c + +lexemeText :: Lexeme text -> text +lexemeText (L _ _ s) = s + +lexemeLine :: Lexeme text -> Int +lexemeLine (L (AlexPn _ l _) _ _) = l + +start :: Int -> AlexInput -> Int -> Alex (Lexeme String) +start code _ _ = do + alexSetStartCode code + alexMonadScan + +alexEOF :: Alex (Lexeme String) +alexEOF = return (L (AlexPn 0 0 0) Eof "") + +alexScanTokens :: String -> Either String [Lexeme String] +alexScanTokens str = + runAlex str $ loop [] + where + loop toks = do + tok@(L _ cl _) <- alexMonadScan + if cl == Eof + then return $ reverse toks + else loop $! (tok:toks) +} diff --git a/src/Language/Cimple/Parser.y b/src/Language/Cimple/Parser.y new file mode 100644 --- /dev/null +++ b/src/Language/Cimple/Parser.y @@ -0,0 +1,694 @@ +{ +module Language.Cimple.Parser where + +import Language.Cimple.AST (AssignOp (..), BinaryOp (..), + LiteralType (..), Node (..), + Scope (..), UnaryOp (..)) +import Language.Cimple.Lexer (Alex, AlexPosn, Lexeme (..), alexError, + alexMonadScan) +import Language.Cimple.Tokens (LexemeClass (..)) +} + +-- Conflict between (static) FunctionDecl and (static) ConstDecl. +%expect 2 + +%name parseCimple +%error {parseError} +%lexer {lexwrap} {L _ Eof _} +%monad {Alex} +%tokentype {Lexeme String} +%token + ID_CONST { L _ IdConst _ } + ID_FUNC_TYPE { L _ IdFuncType _ } + ID_STD_TYPE { L _ IdStdType _ } + ID_SUE_TYPE { L _ IdSueType _ } + ID_TYVAR { L _ IdTyVar _ } + ID_VAR { L _ IdVar _ } + bitmask { L _ KwBitmask _ } + break { L _ KwBreak _ } + case { L _ KwCase _ } + class { L _ KwClass _ } + const { L _ KwConst _ } + continue { L _ KwContinue _ } + default { L _ KwDefault _ } + do { L _ KwDo _ } + else { L _ KwElse _ } + enum { L _ KwEnum _ } + 'error' { L _ KwError _ } + event { L _ KwEvent _ } + extern { L _ KwExtern _ } + for { L _ KwFor _ } + goto { L _ KwGoto _ } + if { L _ KwIf _ } + namespace { L _ KwNamespace _ } + return { L _ KwReturn _ } + sizeof { L _ KwSizeof _ } + static { L _ KwStatic _ } + struct { L _ KwStruct _ } + switch { L _ KwSwitch _ } + this { L _ KwThis _ } + typedef { L _ KwTypedef _ } + union { L _ KwUnion _ } + VLA { L _ KwVla _ } + void { L _ KwVoid _ } + while { L _ KwWhile _ } + with { L _ KwWith _ } + LIT_CHAR { L _ LitChar _ } + LIT_FALSE { L _ LitFalse _ } + LIT_TRUE { L _ LitTrue _ } + LIT_INTEGER { L _ LitInteger _ } + LIT_STRING { L _ LitString _ } + LIT_SYS_INCLUDE { L _ LitSysInclude _ } + '&' { L _ PctAmpersand _ } + '&&' { L _ PctAmpersandAmpersand _ } + '&=' { L _ PctAmpersandEq _ } + '->' { L _ PctArrow _ } + '*' { L _ PctAsterisk _ } + '*=' { L _ PctAsteriskEq _ } + '^' { L _ PctCaret _ } + '^=' { L _ PctCaretEq _ } + ':' { L _ PctColon _ } + ',' { L _ PctComma _ } + '!' { L _ PctEMark _ } + '!=' { L _ PctEMarkEq _ } + '=' { L _ PctEq _ } + '==' { L _ PctEqEq _ } + '>' { L _ PctGreater _ } + '>=' { L _ PctGreaterEq _ } + '>>' { L _ PctGreaterGreater _ } + '>>=' { L _ PctGreaterGreaterEq _ } + '{' { L _ PctLBrace _ } + '[' { L _ PctLBrack _ } + '<' { L _ PctLess _ } + '<=' { L _ PctLessEq _ } + '<<' { L _ PctLessLess _ } + '<<=' { L _ PctLessLessEq _ } + '(' { L _ PctLParen _ } + '-' { L _ PctMinus _ } + '-=' { L _ PctMinusEq _ } + '--' { L _ PctMinusMinus _ } + '%' { L _ PctPercent _ } + '%=' { L _ PctPercentEq _ } + '.' { L _ PctPeriod _ } + '...' { L _ PctEllipsis _ } + '|' { L _ PctPipe _ } + '|=' { L _ PctPipeEq _ } + '||' { L _ PctPipePipe _ } + '+' { L _ PctPlus _ } + '+=' { L _ PctPlusEq _ } + '++' { L _ PctPlusPlus _ } + '?' { L _ PctQMark _ } + '}' { L _ PctRBrace _ } + ']' { L _ PctRBrack _ } + ')' { L _ PctRParen _ } + ';' { L _ PctSemicolon _ } + '/' { L _ PctSlash _ } + '/=' { L _ PctSlashEq _ } + '~' { L _ PctTilde _ } + 'defined' { L _ PpDefined _ } + '#define' { L _ PpDefine _ } + '#elif' { L _ PpElif _ } + '#else' { L _ PpElse _ } + '#endif' { L _ PpEndif _ } + '#error' { L _ PpError _ } + '#if' { L _ PpIf _ } + '#ifdef' { L _ PpIfdef _ } + '#ifndef' { L _ PpIfndef _ } + '#include' { L _ PpInclude _ } + '#undef' { L _ PpUndef _ } + '\n' { L _ PpNewline _ } + '/**/' { L _ CmtBlock _ } + '/*' { L _ CmtStart _ } + '*/' { L _ CmtEnd _ } + 'Copyright' { L _ CmtSpdxCopyright _ } + 'License' { L _ CmtSpdxLicense _ } + COMMENT_CODE { L _ CmtCode _ } + COMMENT_WORD { L _ CmtWord _ } + COMMENT_REF { L _ CmtRef _ } + +%left ',' +%right '=' '+=' '-=' '*=' '/=' '%=' '<<=' '>>=' '&=' '^=' '|=' +%right '?' ':' +%left '||' +%left '&&' +%left '|' +%left '^' +%left '&' +%left '!=' '==' +%left '<' '<=' '>' '>=' +%left '<<' '>>' +%left '+' '-' +%left '*' '/' '%' +%right CAST ADDRESS NEG DEREF sizeof '!' '~' '++' '--' +%left '->' '.' '(' '[' + +%% + +TranslationUnit :: { [StringNode] } +TranslationUnit +: ToplevelDecls { reverse $1 } + +ToplevelDecls :: { [StringNode] } +ToplevelDecls +: ToplevelDecl { [$1] } +| ToplevelDecls ToplevelDecl { $2 : $1 } + +ToplevelDecl :: { StringNode } +ToplevelDecl +: PreprocIfdef(ToplevelDecls) { $1 } +| PreprocIf(ToplevelDecls) { $1 } +| PreprocInclude { $1 } +| PreprocDefine { $1 } +| PreprocUndef { $1 } +| PreprocError { $1 } +| ExternC { $1 } +| TypedefDecl { $1 } +| AggregateDecl { $1 } +| EnumDecl { $1 } +| FunctionDecl { $1 } +| ConstDecl { $1 } +| Comment { $1 } +| Namespace { $1 } +| Event { $1 } +| ErrorDecl { $1 } + +Namespace :: { StringNode } +Namespace +: NamespaceDeclarator { $1 Global } +| static NamespaceDeclarator { $2 Static } + +NamespaceDeclarator :: { Scope -> StringNode } +NamespaceDeclarator +: class ID_SUE_TYPE TypeParams '{' ToplevelDecls '}' { \s -> Class s $2 $3 $5 } +| namespace IdVar '{' ToplevelDecls '}' { \s -> Namespace s $2 $4 } + +TypeParams :: { [StringNode] } +TypeParams +: { [] } +| '<' ID_TYVAR '>' { [TyVar $2] } + +Event :: { StringNode } +Event +: event IdVar '{' EventType '}' { Event $2 $4 } +| event IdVar const '{' EventType '}' { Event $2 $5 } + +EventType :: { StringNode } +EventType +: Comment typedef void EventParams ';' { Commented $1 $4 } + +EventParams :: { StringNode } +EventParams +: FunctionParamList { EventParams $1 } + +ErrorDecl :: { StringNode } +ErrorDecl +: 'error' for IdVar EnumeratorList { ErrorDecl $3 $4 } + +Comment :: { StringNode } +Comment +: '/*' CommentBody '*/' { Comment (reverse $2) } +| '/**/' { CommentBlock $1 } + +CommentBody :: { [StringNode] } +CommentBody +: CommentWord { [$1] } +| CommentBody CommentWord { $2 : $1 } + +CommentWord :: { StringNode } +CommentWord +: COMMENT_WORD { CommentWord $1 } +| COMMENT_REF { CommentWord $1 } +| COMMENT_CODE { CommentWord $1 } +| LIT_INTEGER { CommentWord $1 } +| LIT_STRING { CommentWord $1 } +| 'Copyright' { CommentWord $1 } +| 'License' { CommentWord $1 } +| '.' { CommentWord $1 } +| '?' { CommentWord $1 } +| '!' { CommentWord $1 } +| ',' { CommentWord $1 } +| ';' { CommentWord $1 } +| ':' { CommentWord $1 } +| '(' { CommentWord $1 } +| ')' { CommentWord $1 } +| '<' { CommentWord $1 } +| '>' { CommentWord $1 } +| '/' { CommentWord $1 } +| '+' { CommentWord $1 } +| '-' { CommentWord $1 } +| '=' { CommentWord $1 } +| '\n' { CommentWord $1 } + +PreprocIfdef(decls) +: '#ifdef' ID_CONST decls PreprocElse(decls) '#endif' { PreprocIfdef $2 $3 $4 } +| '#ifndef' ID_CONST decls PreprocElse(decls) '#endif' { PreprocIfndef $2 $3 $4 } + +PreprocIf(decls) +: '#if' ConstExpr '\n' decls PreprocElse(decls) '#endif' { PreprocIf $2 $4 $5 } + +PreprocElse(decls) +: { PreprocElse [] } +| '#else' decls { PreprocElse $2 } +| '#elif' ConstExpr '\n' decls PreprocElse(decls) { PreprocElif $2 $4 $5 } + +PreprocError :: { StringNode } +PreprocError +: '#error' LIT_STRING { PreprocError $2 } + +PreprocInclude :: { StringNode } +PreprocInclude +: '#include' LIT_STRING { PreprocInclude $2 } +| '#include' LIT_SYS_INCLUDE { PreprocInclude $2 } + +PreprocDefine :: { StringNode } +PreprocDefine +: '#define' ID_CONST '\n' { PreprocDefine $2 } +| '#define' ID_CONST ConstExpr '\n' { PreprocDefineConst $2 $3 } +| '#define' ID_CONST MacroParamList MacroBody '\n' { PreprocDefineMacro $2 $3 $4 } + +PreprocUndef :: { StringNode } +PreprocUndef +: '#undef' ID_CONST { PreprocUndef $2 } + +ConstExpr :: { StringNode } +ConstExpr +: LiteralExpr { $1 } +| 'defined' '(' ID_CONST ')' { PreprocDefined $3 } +| PureExpr(ConstExpr) { $1 } + +MacroParamList :: { [StringNode] } +MacroParamList +: '(' ')' { [] } +| '(' MacroParams ')' { reverse $2 } +| '(' MacroParams ',' '...' ')' { reverse $ Ellipsis : $2 } + +MacroParams :: { [StringNode] } +MacroParams +: MacroParam { [$1] } +| MacroParams ',' MacroParam { $3 : $1 } + +MacroParam :: { StringNode } +MacroParam +: IdVar { MacroParam $1 } + +MacroBody :: { StringNode } +MacroBody +: do CompoundStmt while '(' LIT_INTEGER ')' {% macroBodyStmt $2 $5 } +| FunctionCall { MacroBodyFunCall $1 } + +ExternC :: { StringNode } +ExternC +: '#ifdef' ID_CONST + extern LIT_STRING '{' + '#endif' + ToplevelDecls + '#ifdef' ID_CONST + '}' + '#endif' {% externC $2 $4 $7 $9 } + +Stmts :: { [StringNode] } +Stmts +: Stmt { [$1] } +| Stmts Stmt { $2 : $1 } + +Stmt :: { StringNode } +Stmt +: PreprocIfdef(Stmts) { $1 } +| PreprocIf(Stmts) { $1 } +| PreprocDefine Stmts PreprocUndef { PreprocScopedDefine $1 $2 $3 } +| LabelStmt { $1 } +| DeclStmt { $1 } +| CompoundStmt { CompoundStmt $1 } +| IfStmt { $1 } +| ForStmt { $1 } +| WhileStmt { $1 } +| DoWhileStmt { $1 } +| AssignExpr ';' { $1 } +| ExprStmt ';' { $1 } +| FunctionCall ';' { $1 } +| break ';' { Break } +| goto ID_CONST ';' { Goto $2 } +| continue ';' { Continue } +| return ';' { Return Nothing } +| return Expr ';' { Return (Just $2) } +| switch '(' Expr ')' CompoundStmt { Switch $3 $5 } +| Comment { $1 } + +IfStmt :: { StringNode } +IfStmt +: if '(' Expr ')' CompoundStmt { IfStmt $3 $5 Nothing } +| if '(' Expr ')' CompoundStmt else IfStmt { IfStmt $3 $5 (Just $7) } +| if '(' Expr ')' CompoundStmt else CompoundStmt { IfStmt $3 $5 (Just (CompoundStmt $7)) } + +ForStmt :: { StringNode } +ForStmt +: for '(' ForInit Opt(Expr) ';' Opt(ForNext) ')' CompoundStmt { ForStmt $3 $4 $6 $8 } + +ForInit :: { Maybe (StringNode) } +ForInit +: ';' { Nothing } +| AssignExpr ';' { Just $1 } +| SingleVarDecl { Just $1 } + +ForNext :: { StringNode } +ForNext +: ExprStmt { $1 } +| AssignExpr { $1 } + +Opt(x) +: { Nothing } +| x { Just $1 } + +WhileStmt :: { StringNode } +WhileStmt +: while '(' Expr ')' CompoundStmt { WhileStmt $3 $5 } + +DoWhileStmt :: { StringNode } +DoWhileStmt +: do CompoundStmt while '(' Expr ')' ';' { DoWhileStmt $2 $5 } + +LabelStmt :: { StringNode } +LabelStmt +: case Expr ':' Stmt { Case $2 $4 } +| default ':' Stmt { Default $3 } +| ID_CONST ':' Stmt { Label $1 $3 } + +DeclStmt :: { StringNode } +DeclStmt +: VarDecl { $1 } +| VLA '(' Type ',' IdVar ',' Expr ')' ';' { VLA $3 $5 $7 } + +SingleVarDecl :: { StringNode } +SingleVarDecl +: QualType Declarator ';' { VarDecl $1 [$2] } + +VarDecl :: { StringNode } +VarDecl +: QualType Declarators ';' { VarDecl $1 (reverse $2) } + +Declarators :: { [StringNode] } +Declarators +: Declarator { [$1] } +| Declarators ',' Declarator { $3 : $1 } + +Declarator :: { StringNode } +Declarator +: DeclSpec '=' InitialiserExpr { Declarator $1 (Just $3) } +| DeclSpec { Declarator $1 Nothing } + +InitialiserExpr :: { StringNode } +InitialiserExpr +: InitialiserList { InitialiserList $1 } +| Expr { $1 } + +DeclSpec :: { StringNode } +DeclSpec +: IdVar { DeclSpecVar $1 } +| DeclSpec '[' ']' { DeclSpecArray $1 Nothing } +| DeclSpec '[' Expr ']' { DeclSpecArray $1 (Just $3) } + +IdVar :: { Lexeme String } +IdVar +: ID_VAR { $1 } +| default { $1 } +| 'error' { $1 } + +InitialiserList :: { [StringNode] } +InitialiserList +: '{' Initialisers '}' { reverse $2 } +| '{' Initialisers ',' '}' { reverse $2 } + +Initialisers :: { [StringNode] } +Initialisers +: Initialiser { [$1] } +| Initialisers ',' Initialiser { $3 : $1 } + +Initialiser :: { StringNode } +Initialiser +: Expr { $1 } +| InitialiserList { InitialiserList $1 } + +CompoundStmt :: { [StringNode] } +CompoundStmt +: '{' Stmts '}' { $2 } + +PureExpr(x) +: x '!=' x { BinaryExpr $1 BopNe $3 } +| x '==' x { BinaryExpr $1 BopEq $3 } +| x '||' x { BinaryExpr $1 BopOr $3 } +| x '^' x { BinaryExpr $1 BopBitXor $3 } +| x '|' x { BinaryExpr $1 BopBitOr $3 } +| x '&&' x { BinaryExpr $1 BopAnd $3 } +| x '&' x { BinaryExpr $1 BopBitAnd $3 } +| x '/' x { BinaryExpr $1 BopDiv $3 } +| x '*' x { BinaryExpr $1 BopMul $3 } +| x '%' x { BinaryExpr $1 BopMod $3 } +| x '+' x { BinaryExpr $1 BopPlus $3 } +| x '-' x { BinaryExpr $1 BopMinus $3 } +| x '<' x { BinaryExpr $1 BopLt $3 } +| x '<=' x { BinaryExpr $1 BopLe $3 } +| x '<<' x { BinaryExpr $1 BopLsh $3 } +| x '>' x { BinaryExpr $1 BopGt $3 } +| x '>=' x { BinaryExpr $1 BopGe $3 } +| x '>>' x { BinaryExpr $1 BopRsh $3 } +| x '?' x ':' x { TernaryExpr $1 $3 $5 } +| '(' x ')' { ParenExpr $2 } +| '!' x { UnaryExpr UopNot $2 } +| '~' x { UnaryExpr UopNeg $2 } +| '-' x %prec NEG { UnaryExpr UopMinus $2 } +| '&' x %prec ADDRESS { UnaryExpr UopAddress $2 } +| '(' QualType ')' x %prec CAST { CastExpr $2 $4 } +| sizeof '(' x ')' { SizeofExpr $3 } +| sizeof '(' Type ')' { SizeofExpr $3 } + +LiteralExpr :: { StringNode } +LiteralExpr +: LIT_CHAR { LiteralExpr Char $1 } +| LIT_INTEGER { LiteralExpr Int $1 } +| LIT_FALSE { LiteralExpr Bool $1 } +| LIT_TRUE { LiteralExpr Bool $1 } +| LIT_STRING { LiteralExpr String $1 } +| ID_CONST { LiteralExpr ConstId $1 } + +Expr :: { StringNode } +Expr +: LhsExpr { $1 } +| ExprStmt { $1 } +| LiteralExpr { $1 } +| FunctionCall { $1 } +| PureExpr(Expr) { $1 } + +AssignExpr :: { StringNode } +AssignExpr +: LhsExpr AssignOperator Expr { AssignExpr $1 $2 $3 } + +AssignOperator :: { AssignOp } +AssignOperator +: '=' { AopEq } +| '*=' { AopMul } +| '/=' { AopDiv } +| '+=' { AopPlus } +| '-=' { AopMinus } +| '&=' { AopBitAnd } +| '|=' { AopBitOr } +| '^=' { AopBitXor } +| '%=' { AopMod } +| '<<=' { AopLsh } +| '>>=' { AopRsh } + +ExprStmt :: { StringNode } +ExprStmt +: '++' Expr { UnaryExpr UopIncr $2 } +| '--' Expr { UnaryExpr UopDecr $2 } + +LhsExpr :: { StringNode } +LhsExpr +: IdVar { VarExpr $1 } +| '*' LhsExpr %prec DEREF { UnaryExpr UopDeref $2 } +| LhsExpr '.' IdVar { MemberAccess $1 $3 } +| LhsExpr '->' IdVar { PointerAccess $1 $3 } +| LhsExpr '[' Expr ']' { ArrayAccess $1 $3 } + +FunctionCall :: { StringNode } +FunctionCall +: Expr ArgList { FunctionCall $1 $2 } + +ArgList :: { [StringNode] } +ArgList +: '(' ')' { [] } +| '(' Args ')' { reverse $2 } + +Args :: { [StringNode] } +Args +: Arg { [$1] } +| Args ',' Arg { $3 : $1 } + +Arg :: { StringNode } +Arg +: Expr { $1 } +| Comment Expr { CommentExpr $1 $2 } + +EnumDecl :: { StringNode } +EnumDecl +: enum class ID_SUE_TYPE EnumeratorList { EnumClass $3 $4 } +| enum ID_SUE_TYPE EnumeratorList { EnumConsts (Just $2) $3 } +| enum EnumeratorList ';' { EnumConsts Nothing $2 } +| typedef enum ID_SUE_TYPE EnumeratorList ID_SUE_TYPE ';' { EnumDecl $3 $4 $5 } +| bitmask ID_SUE_TYPE EnumeratorList { EnumDecl $2 $3 $2 } + +EnumeratorList :: { [StringNode] } +EnumeratorList +: '{' Enumerators '}' { $2 } + +Enumerators :: { [StringNode] } +Enumerators +: Enumerator { [$1] } +| Enumerators Enumerator { $2 : $1 } + +Enumerator :: { StringNode } +Enumerator +: EnumeratorName ',' { Enumerator $1 Nothing } +| EnumeratorName '=' ConstExpr ',' { Enumerator $1 (Just $3) } +| namespace ID_CONST '{' Enumerators '}' { Namespace Global $2 $4 } +| Comment { $1 } + +EnumeratorName :: { Lexeme String } +EnumeratorName +: ID_CONST { $1 } +| ID_SUE_TYPE { $1 } + +AggregateDecl :: { StringNode } +AggregateDecl +: AggregateType ';' { $1 } +| class ID_SUE_TYPE TypeParams ';' { ClassForward $2 $3 } +| typedef AggregateType ID_SUE_TYPE ';' { Typedef $2 $3 } + +AggregateType :: { StringNode } +AggregateType +: struct ID_SUE_TYPE '{' MemberDecls '}' { Struct $2 $4 } +| struct this '{' MemberDecls '}' { Struct $2 $4 } +| union ID_SUE_TYPE '{' MemberDecls '}' { Union $2 $4 } + +MemberDecls :: { [StringNode] } +MemberDecls +: MemberDecl { [$1] } +| MemberDecls MemberDecl { $2 : $1 } + +MemberDecl :: { StringNode } +MemberDecl +: QualType DeclSpec ';' { MemberDecl $1 $2 Nothing } +| QualType DeclSpec ':' LIT_INTEGER ';' { MemberDecl $1 $2 (Just $4) } +| namespace IdVar '{' MemberDecls '}' { Namespace Global $2 $4 } +| PreprocIfdef(MemberDecls) { $1 } +| Comment { $1 } + +TypedefDecl :: { StringNode } +TypedefDecl +: typedef QualType ID_SUE_TYPE ';' { Typedef $2 $3 } +| typedef FunctionPrototype(ID_FUNC_TYPE) ';' { TypedefFunction $2 } + +QualType :: { StringNode } +QualType +: Type { $1 } +| const Type { TyConst $2 } + +Type :: { StringNode } +Type +: LeafType { $1 } +| Type '*' { TyPointer $1 } +| Type const { TyConst $1 } + +LeafType :: { StringNode } +LeafType +: struct ID_SUE_TYPE { TyStruct $2 } +| void { TyStd $1 } +| this { TyStd $1 } +| ID_FUNC_TYPE { TyFunc $1 } +| ID_STD_TYPE { TyStd $1 } +| ID_SUE_TYPE { TyUserDefined $1 } +| ID_TYVAR { TyVar $1 } + +FunctionDecl :: { StringNode } +FunctionDecl +: FunctionDeclarator { $1 Global } +| static FunctionDeclarator { $2 Static } + +FunctionDeclarator :: { Scope -> StringNode } +FunctionDeclarator +: FunctionPrototype(IdVar) WithError { \s -> FunctionDecl s $1 $2 } +| FunctionPrototype(IdVar) CompoundStmt { \s -> FunctionDefn s $1 $2 } +| QualType DeclSpec '{' Accessors '}' { \s -> Property $1 $2 $4 } + +Accessors :: { [StringNode] } +Accessors +: Accessor { [$1] } +| Accessors Accessor { $2 : $1 } + +Accessor :: { StringNode } +Accessor +: IdVar FunctionParamList WithError { Accessor $1 $2 $3 } +| Comment { $1 } + +WithError :: { Maybe StringNode } +WithError +: ';' { Nothing } +| with 'error' EnumeratorList { Just (ErrorList $3) } +| with 'error' for IdVar ';' { Just (ErrorFor $4) } + +FunctionPrototype(id) +: QualType id FunctionParamList { FunctionPrototype $1 $2 $3 } +| QualType id FunctionParamList const { FunctionPrototype $1 $2 $3 } + +FunctionParamList :: { [StringNode] } +FunctionParamList +: '(' ')' { [] } +| '(' void ')' { [TyStd $2] } +| '(' FunctionParams ')' { reverse $2 } +| '(' FunctionParams ',' '...' ')' { reverse $ Ellipsis : $2 } + +FunctionParams :: { [StringNode] } +FunctionParams +: FunctionParam { [$1] } +| FunctionParams ',' FunctionParam { $3 : $1 } + +FunctionParam :: { StringNode } +FunctionParam +: QualType DeclSpec { FunctionParam $1 $2 } + +ConstDecl :: { StringNode } +ConstDecl +: extern const LeafType ID_VAR ';' { ConstDecl $3 $4 } +| const LeafType ID_VAR '=' InitialiserExpr ';' { ConstDefn Global $2 $3 $5 } +| static const LeafType ID_VAR '=' InitialiserExpr ';' { ConstDefn Static $3 $4 $6 } + +{ +type StringNode = Node (Lexeme String) + +parseError :: Show text => Lexeme text -> Alex a +parseError token = alexError $ "Parse error near token: " <> show token + +lexwrap :: (Lexeme String -> Alex a) -> Alex a +lexwrap = (alexMonadScan >>=) + +externC + :: Lexeme String + -> Lexeme String + -> [StringNode] + -> Lexeme String + -> Alex StringNode +externC (L _ _ "__cplusplus") (L _ _ "\"C\"") decls (L _ _ "__cplusplus") = + return $ ExternC decls +externC _ lang _ _ = + alexError $ show lang + <> ": extern \"C\" declaration invalid (did you spell __cplusplus right?)" + +macroBodyStmt + :: [StringNode] + -> Lexeme String + -> Alex StringNode +macroBodyStmt decls (L _ _ "0") = + return $ MacroBodyStmt decls +macroBodyStmt _ cond = + alexError $ show cond + <> ": macro do-while body must end in 'while (0)'" +} diff --git a/src/Language/Cimple/Tokens.hs b/src/Language/Cimple/Tokens.hs new file mode 100644 --- /dev/null +++ b/src/Language/Cimple/Tokens.hs @@ -0,0 +1,123 @@ +{-# LANGUAGE DeriveGeneric #-} +module Language.Cimple.Tokens + ( LexemeClass (..) + ) where + +import Data.Aeson (FromJSON, ToJSON) +import GHC.Generics (Generic) + +data LexemeClass + = IdConst + | IdFuncType + | IdStdType + | IdSueType + | IdTyVar + | IdVar + | KwBitmask + | KwBreak + | KwCase + | KwClass + | KwConst + | KwContinue + | KwDefault + | KwDo + | KwElse + | KwEnum + | KwError + | KwEvent + | KwExtern + | KwFor + | KwGoto + | KwIf + | KwNamespace + | KwReturn + | KwSizeof + | KwStatic + | KwStruct + | KwSwitch + | KwThis + | KwTypedef + | KwUnion + | KwVla + | KwVoid + | KwWhile + | KwWith + | LitFalse + | LitTrue + | LitChar + | LitInteger + | LitString + | LitSysInclude + | PctAmpersand + | PctAmpersandAmpersand + | PctAmpersandEq + | PctArrow + | PctAsterisk + | PctAsteriskEq + | PctCaret + | PctCaretEq + | PctColon + | PctComma + | PctEllipsis + | PctEMark + | PctEMarkEq + | PctEq + | PctEqEq + | PctGreater + | PctGreaterEq + | PctGreaterGreater + | PctGreaterGreaterEq + | PctLBrace + | PctLBrack + | PctLess + | PctLessEq + | PctLessLess + | PctLessLessEq + | PctLParen + | PctMinus + | PctMinusEq + | PctMinusMinus + | PctPeriod + | PctPercent + | PctPercentEq + | PctPipe + | PctPipeEq + | PctPipePipe + | PctPlus + | PctPlusEq + | PctPlusPlus + | PctQMark + | PctRBrace + | PctRBrack + | PctRParen + | PctSemicolon + | PctSlash + | PctSlashEq + | PctTilde + | PpDefine + | PpDefined + | PpElif + | PpElse + | PpEndif + | PpError + | PpIf + | PpIfdef + | PpIfndef + | PpInclude + | PpNewline + | PpUndef + | CmtBlock + | CmtStart + | CmtSpdxCopyright + | CmtSpdxLicense + | CmtCode + | CmtWord + | CmtRef + | CmtEnd + + | Error + | Eof + deriving (Show, Eq, Generic, Ord) + +instance FromJSON LexemeClass +instance ToJSON LexemeClass diff --git a/src/Language/Cimple/TraverseAst.hs b/src/Language/Cimple/TraverseAst.hs new file mode 100644 --- /dev/null +++ b/src/Language/Cimple/TraverseAst.hs @@ -0,0 +1,236 @@ +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE InstanceSigs #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE ScopedTypeVariables #-} +module Language.Cimple.TraverseAst + ( TraverseAst (..) + , AstActions (..) + , defaultActions + ) where + +import Data.Text (Text) +import Language.Cimple.AST (Node (..)) +import Language.Cimple.Lexer (Lexeme (..)) + +class TraverseAst a where + traverseAst :: Applicative f => AstActions f Text -> a -> f a + +data AstActions f text = AstActions + { doNodes :: [Node (Lexeme text)] -> f [Node (Lexeme text)] -> f [Node (Lexeme text)] + , doNode :: Node (Lexeme text) -> f (Node (Lexeme text)) -> f (Node (Lexeme text)) + , doLexeme :: Lexeme text -> f (Lexeme text) -> f (Lexeme text) + , doText :: text -> f text -> f text + } + +instance TraverseAst a => TraverseAst (Maybe a) where + traverseAst _ Nothing = pure Nothing + traverseAst astActions (Just x) = Just <$> traverseAst astActions x + +defaultActions :: Applicative f => AstActions f lexeme +defaultActions = AstActions + { doNodes = const id + , doNode = const id + , doLexeme = const id + , doText = const id + } + +instance TraverseAst Text where + traverseAst :: forall f . Applicative f + => AstActions f Text -> Text -> f Text + traverseAst astActions = doText astActions <*> pure + +instance TraverseAst (Lexeme Text) where + traverseAst :: forall f . Applicative f + => AstActions f Text -> Lexeme Text -> f (Lexeme Text) + traverseAst astActions = doLexeme astActions <*> \case + L p c s -> L p c <$> recurse s + where + recurse :: TraverseAst a => a -> f a + recurse = traverseAst astActions + +instance TraverseAst (Node (Lexeme Text)) where + traverseAst :: forall f . Applicative f + => AstActions f Text -> Node (Lexeme Text) -> f (Node (Lexeme Text)) + traverseAst astActions = doNode astActions <*> \case + PreprocInclude path -> + PreprocInclude <$> recurse path + PreprocDefine name -> + PreprocDefine <$> recurse name + PreprocDefineConst name value -> + PreprocDefineConst <$> recurse name <*> recurse value + PreprocDefineMacro name params body -> + PreprocDefineMacro <$> recurse name <*> recurse params <*> recurse body + PreprocIf cond thenDecls elseBranch -> + PreprocIf <$> recurse cond <*> recurse thenDecls <*> recurse elseBranch + PreprocIfdef name thenDecls elseBranch -> + PreprocIfdef <$> recurse name <*> recurse thenDecls <*> recurse elseBranch + PreprocIfndef name thenDecls elseBranch -> + PreprocIfndef <$> recurse name <*> recurse thenDecls <*> recurse elseBranch + PreprocElse decls -> + PreprocElse <$> recurse decls + PreprocElif cond decls elseBranch -> + PreprocElif <$> recurse cond <*> recurse decls <*> recurse elseBranch + PreprocError msg -> + PreprocError <$> recurse msg + PreprocUndef name -> + PreprocUndef <$> recurse name + PreprocDefined name -> + PreprocDefined <$> recurse name + PreprocScopedDefine define stmts undef -> + PreprocScopedDefine <$> recurse define <*> recurse stmts <*> recurse undef + MacroBodyStmt stmts -> + MacroBodyStmt <$> recurse stmts + MacroBodyFunCall expr -> + MacroBodyFunCall <$> recurse expr + MacroParam name -> + MacroParam <$> recurse name + Comment contents -> + Comment <$> recurse contents + CommentBlock comment -> + CommentBlock <$> recurse comment + CommentWord word -> + CommentWord <$> recurse word + Commented comment node -> + Commented <$> recurse comment <*> recurse node + ExternC decls -> + ExternC <$> recurse decls + CompoundStmt stmts -> + CompoundStmt <$> recurse stmts + Break -> + pure Break + Goto label -> + Goto <$> recurse label + Continue -> + pure Continue + Return value -> + Return <$> recurse value + Switch value cases -> + Switch <$> recurse value <*> recurse cases + IfStmt cond thenStmts elseStmt -> + IfStmt <$> recurse cond <*> recurse thenStmts <*> recurse elseStmt + ForStmt initStmt cond next stmts -> + ForStmt <$> recurse initStmt <*> recurse cond <*> recurse next <*> recurse stmts + WhileStmt cond stmts -> + WhileStmt <$> recurse cond <*> recurse stmts + DoWhileStmt stmts cond -> + DoWhileStmt <$> recurse stmts <*> recurse cond + Case value stmt -> + Case <$> recurse value <*> recurse stmt + Default stmt -> + Default <$> recurse stmt + Label label stmt -> + Label <$> recurse label <*> recurse stmt + VLA ty name size -> + VLA <$> recurse ty <*> recurse name <*> recurse size + VarDecl ty decls -> + VarDecl <$> recurse ty <*> recurse decls + Declarator spec value -> + Declarator <$> recurse spec <*> recurse value + DeclSpecVar name -> + DeclSpecVar <$> recurse name + DeclSpecArray spec size -> + DeclSpecArray <$> recurse spec <*> recurse size + InitialiserList values -> + InitialiserList <$> recurse values + UnaryExpr op expr -> + UnaryExpr op <$> recurse expr + BinaryExpr lhs op rhs -> + BinaryExpr <$> recurse lhs <*> pure op <*> recurse rhs + TernaryExpr cond thenExpr elseExpr -> + TernaryExpr <$> recurse cond <*> recurse thenExpr <*> recurse elseExpr + AssignExpr lhs op rhs -> + AssignExpr <$> recurse lhs <*> pure op <*> recurse rhs + ParenExpr expr -> + ParenExpr <$> recurse expr + CastExpr ty expr -> + CastExpr <$> recurse ty <*> recurse expr + SizeofExpr expr -> + SizeofExpr <$> recurse expr + LiteralExpr ty value -> + LiteralExpr ty <$> recurse value + VarExpr name -> + VarExpr <$> recurse name + MemberAccess name field -> + MemberAccess <$> recurse name <*> recurse field + PointerAccess name field -> + PointerAccess <$> recurse name <*> recurse field + ArrayAccess arr idx -> + ArrayAccess <$> recurse arr <*> recurse idx + FunctionCall callee args -> + FunctionCall <$> recurse callee <*> recurse args + CommentExpr comment expr -> + CommentExpr <$> recurse comment <*> recurse expr + EnumClass name members -> + EnumClass <$> recurse name <*> recurse members + EnumConsts name members -> + EnumConsts <$> recurse name <*> recurse members + EnumDecl name members tyName -> + EnumDecl <$> recurse name <*> recurse members <*> recurse tyName + Enumerator name value -> + Enumerator <$> recurse name <*> recurse value + Typedef ty name -> + Typedef <$> recurse ty <*> recurse name + TypedefFunction ty -> + TypedefFunction <$> recurse ty + Namespace scope name members -> + Namespace scope <$> recurse name <*> recurse members + Class scope name tyvars members -> + Class scope <$> recurse name <*> recurse tyvars <*> recurse members + ClassForward name tyvars -> + ClassForward <$> recurse name <*> recurse tyvars + Struct name members -> + Struct <$> recurse name <*> recurse members + Union name members -> + Union <$> recurse name <*> recurse members + MemberDecl ty decl width -> + MemberDecl <$> recurse ty <*> recurse decl <*> recurse width + TyConst ty -> + TyConst <$> recurse ty + TyPointer ty -> + TyPointer <$> recurse ty + TyStruct name -> + TyStruct <$> recurse name + TyFunc name -> + TyFunc <$> recurse name + TyVar name -> + TyVar <$> recurse name + TyStd name -> + TyStd <$> recurse name + TyUserDefined name -> + TyUserDefined <$> recurse name + FunctionDecl scope proto errors -> + FunctionDecl scope <$> recurse proto <*> recurse errors + FunctionDefn scope proto body -> + FunctionDefn scope <$> recurse proto <*> recurse body + FunctionPrototype ty name params -> + FunctionPrototype <$> recurse ty <*> recurse name <*> recurse params + FunctionParam ty decl -> + FunctionParam <$> recurse ty <*> recurse decl + Event name params -> + Event <$> recurse name <*> recurse params + EventParams params -> + EventParams <$> recurse params + Property ty decl accessors -> + Property <$> recurse ty <*> recurse decl <*> recurse accessors + Accessor name params errors -> + Accessor <$> recurse name <*> recurse params <*> recurse errors + ErrorDecl name errors -> + ErrorDecl <$> recurse name <*> recurse errors + ErrorList errors -> + ErrorList <$> recurse errors + ErrorFor name -> + ErrorFor <$> recurse name + Ellipsis -> + pure Ellipsis + ConstDecl ty name -> + ConstDecl <$> recurse ty <*> recurse name + ConstDefn scope ty name value -> + ConstDefn scope <$> recurse ty <*> recurse name <*> recurse value + + where + recurse :: TraverseAst a => a -> f a + recurse = traverseAst astActions + +instance TraverseAst [Node (Lexeme Text)] where + traverseAst astActions = doNodes astActions <*> + traverse (traverseAst astActions) diff --git a/test/Language/CimpleSpec.hs b/test/Language/CimpleSpec.hs new file mode 100644 --- /dev/null +++ b/test/Language/CimpleSpec.hs @@ -0,0 +1,68 @@ +{-# LANGUAGE OverloadedStrings #-} +module Language.CimpleSpec where + +import Test.Hspec (Spec, describe, it, shouldBe) + +import Language.Cimple (AlexPosn (..), Lexeme (..), + LexemeClass (..), LiteralType (..), + Node (..), Scope (..)) +import Language.Cimple.IO (parseText) + + +spec :: Spec +spec = + describe "C parsing" $ do + it "should parse a simple function" $ do + ast <- parseText "int a(void) { return 3; }" + ast `shouldBe` Right + [ FunctionDefn + Global + (FunctionPrototype + (TyStd (L (AlexPn 0 1 1) IdStdType "int")) + (L (AlexPn 4 1 5) IdVar "a") + [TyStd (L (AlexPn 6 1 7) KwVoid "void")] + ) + [ Return + (Just + (LiteralExpr + Int + (L (AlexPn 21 1 22) LitInteger "3") + ) + ) + ] + ] + + it "should parse a type declaration" $ do + ast <- parseText "typedef struct Foo { int x; } Foo;" + ast `shouldBe` Right + [ Typedef + (Struct + (L (AlexPn 15 1 16) IdSueType "Foo") + [ MemberDecl + (TyStd (L (AlexPn 21 1 22) IdStdType "int")) + (DeclSpecVar (L (AlexPn 25 1 26) IdVar "x")) + Nothing + ] + ) + (L (AlexPn 30 1 31) IdSueType "Foo") + ] + + it "should parse a struct with bit fields" $ do + ast <- parseText "typedef struct Foo { int x : 123; } Foo;" + ast `shouldBe` Right + [ Typedef + (Struct + (L (AlexPn 15 1 16) IdSueType "Foo") + [ MemberDecl + (TyStd (L (AlexPn 21 1 22) IdStdType "int")) + (DeclSpecVar (L (AlexPn 25 1 26) IdVar "x")) + (Just (L (AlexPn 29 1 30) LitInteger "123")) + ] + ) + (L (AlexPn 36 1 37) IdSueType "Foo") + ] + + it "should parse a comment" $ do + ast <- parseText "/* hello */" + ast `shouldBe` Right + [Comment [CommentWord (L (AlexPn 3 1 4) CmtWord "hello")]] diff --git a/test/testsuite.hs b/test/testsuite.hs new file mode 100644 --- /dev/null +++ b/test/testsuite.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-} diff --git a/tools/dump-ast.hs b/tools/dump-ast.hs new file mode 100644 --- /dev/null +++ b/tools/dump-ast.hs @@ -0,0 +1,23 @@ +{-# LANGUAGE OverloadedStrings #-} +module Main (main) where + +import Language.Cimple.IO (parseFile) +import System.Environment (getArgs) +import Text.Groom (groom) + + +processFile :: FilePath -> IO () +processFile source = do + putStrLn $ "Processing " ++ source + ast <- parseFile source + case ast of + Left err -> fail err + Right ok -> putStrLn $ groom ok + + +main :: IO () +main = do + args <- getArgs + case args of + [src] -> processFile src + _ -> fail "Usage: dump-ast " diff --git a/tools/dump-tokens.hs b/tools/dump-tokens.hs new file mode 100644 --- /dev/null +++ b/tools/dump-tokens.hs @@ -0,0 +1,23 @@ +module Main (main) where + +import qualified Data.ByteString as BS +import qualified Data.Text as Text +import qualified Data.Text.Encoding as Text +import Language.Cimple (alexScanTokens) +import System.Environment (getArgs) +import Text.Groom (groom) + +processFile :: FilePath -> IO () +processFile source = do + putStrLn $ "Processing " ++ source + contents <- Text.unpack . Text.decodeUtf8 <$> BS.readFile source + case alexScanTokens contents of + Left err -> fail err + Right ok -> putStrLn $ groom ok + +main :: IO () +main = do + args <- getArgs + case args of + [src] -> processFile src + _ -> fail "Usage: dump-tokens "