diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,119 @@ +# c2ats - generate ATS interface from C code [![Build Status](https://travis-ci.org/metasepi/c2ats.svg)](https://travis-ci.org/metasepi/c2ats) + +## What's this? + +[ATS](http://www.ats-lang.org/) is a statically typed programming language that unifies implementation with formal specification. It can powerfully capture invariant in program. + +However, don't you feel frustration to use API of many C language libraries from ATS code? Don't you manually import such API into ATS code? + +The c2ats is an utility to generate ATS's sats file importing from C language header, semi-automatically. + +## Requirements + +* [GCC](https://gcc.gnu.org/) to parse C language header +* [cabal](https://www.haskell.org/cabal/) or [stack](https://haskellstack.org/) to build [Haskell](https://www.haskell.org/) code + +We are testing this tool on [Debian GNU/Linux](https://www.debian.org/). + +## Install + +Checkout source code of the c2ats: + +``` +$ git clone https://github.com/metasepi/c2ats.git +$ cd c2ats +``` + +Then install using cabal: + +``` +$ cabal install +$ which c2ats +/home/YourName/.cabal/bin/c2ats +``` + +or install using stack: + +``` +$ stack install +$ which c2ats +/home/YourName/.local/bin/c2ats +``` + +## Usage + +Start from [Hello World example](./example/hello). Create following fake C language header to use `printf(3)` function in C language: + +``` +$ vi example.h +#include +``` + +Next, let the c2ats to generate ATS sats file from above header: + +``` +$ c2ats gen example.h > example.sats +$ wc -l example.sats +318 example.sats +$ grep _printf example.sats +fun fun_c2ats_printf: {l1:addr} (!ptr_v_1(char, l1) | ptr l1) -> int = "mac#printf" +``` + +The sats file has many ATS declarations generated from the C header. It includes a declaration of `printf(3)` which can be used as following in dats: + +``` +$ vi main.dats +#include "share/atspre_define.hats" +#include "share/atspre_staload.hats" + +staload UN = "prelude/SATS/unsafe.sats" + +staload "example.sats" + +fun my_printf (s: string): void = { + val p = string2ptr s + val (pfat, fpfat | p) = $UN.ptr_vtake p + val ret = fun_c2ats_printf (pfat | p) + prval () = fpfat pfat +} + +implement main0 () = { + val s = "Hello, world!\n" + val () = my_printf s +} +$ patscc main.dats +$ ./a.out +Hello, world! +``` + +Of course, above code is so messy. It's caused by assigning a bad signature to `fun_c2ats_printf` function. You can get better dats code, if modify sats file as following: + +``` +$ vi example.sats +--snip-- +fun fun_c2ats_printf: (string) -> int = "mac#printf" +--snip-- +$ vi main.dats +#include "share/atspre_define.hats" +#include "share/atspre_staload.hats" + +staload UN = "prelude/SATS/unsafe.sats" + +staload "example.sats" + +implement main0 () = { + val s = "Hello, world!\n" + val _ = fun_c2ats_printf s +} +$ patscc main.dats +$ ./a.out +Hello, world! +``` + +Totally, the c2ats generates a scaffold (you may be familiar with [Ruby on Rails](http://rubyonrails.org/)) to build ATS application. Sometimes, it's useful to create application rapidly. However, such scaffold should be replaced with better signature until shipping your product. + +The other examples are found at [example](./example/) directory. + +## License + +GPLv3 or later. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,31 @@ +module Main where + +import Control.Monad (when) +import System.Environment (getArgs) +import System.IO (stderr, hPutStrLn) +import System.Exit (exitFailure) +import Language.C2ATS + +getOpts :: [String] -> (String, [String]) +getOpts (gcc:copts) = (gcc, copts) +getOpts [] = ("gcc", []) + +main :: IO () +main = do + let usage = hPutStrLn stderr + "Usage: c2ats gen C_HEADER_PATH [GCC_PATH [COMPILE_OPTS...]]" + >> exitFailure + args <- getArgs + when (length args < 2) usage + let cmd:fn:opts = args + when (cmd /= "gen") usage + let (gcc, copts) = getOpts opts + + (files, globals) <- parseMkGlobal gcc copts fn + let global = injectForwardDecl . injectIncludes + [ -- Includes + ] + [ -- Excludes + ".*" + ] . sortFlatGlobal . flatGlobal $ globals + preDefineGlobal fn >>= print >> print (atsPrettyGlobal global) diff --git a/c2ats.cabal b/c2ats.cabal new file mode 100644 --- /dev/null +++ b/c2ats.cabal @@ -0,0 +1,52 @@ +name: c2ats +version: 0.1.0.1 +synopsis: Translate C code into ATS +description: Please see README.md +homepage: https://github.com/metasepi/c2ats#readme +license: GPL-3 +license-file: COPYING +author: Kiwamu Okabe +maintainer: kiwamu@debian.or.jp +copyright: 2016 Kiwamu Okabe +category: Language +build-type: Simple +extra-source-files: README.md +cabal-version: >=1.10 + +library + hs-source-dirs: src + exposed-modules: Language.C2ATS + , Language.C2ATS.Parser + , Language.C2ATS.Process + , Language.C2ATS.Pretty + build-depends: base >= 4.6 && < 5 + , language-c >= 0.5.0 + , containers + , pretty >= 1.1.3.1 + , regex-posix + default-language: Haskell2010 + +executable c2ats + hs-source-dirs: app + main-is: Main.hs + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: base + , c2ats + default-language: Haskell2010 + +test-suite c2ats-test + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: Main.hs + build-depends: base + , HUnit + , test-framework + , test-framework-hunit + , test-framework-th + , c2ats + ghc-options: -threaded -rtsopts -with-rtsopts=-N + default-language: Haskell2010 + +source-repository head + type: git + location: https://github.com/metasepi/c2ats diff --git a/src/Language/C2ATS.hs b/src/Language/C2ATS.hs new file mode 100644 --- /dev/null +++ b/src/Language/C2ATS.hs @@ -0,0 +1,10 @@ +module Language.C2ATS + ( + module Language.C2ATS.Parser + , module Language.C2ATS.Process + , module Language.C2ATS.Pretty + ) where + +import Language.C2ATS.Parser +import Language.C2ATS.Process +import Language.C2ATS.Pretty diff --git a/src/Language/C2ATS/Parser.hs b/src/Language/C2ATS/Parser.hs new file mode 100644 --- /dev/null +++ b/src/Language/C2ATS/Parser.hs @@ -0,0 +1,26 @@ +module Language.C2ATS.Parser + ( parseMkGlobal + , GlobalDecls + ) where + +import System.IO +import Control.Arrow hiding ((<+>)) +import Data.List +import Language.C +import Language.C.Analysis +import Language.C.System.GCC + +parseMkGlobal :: String -> [String] -> FilePath -> IO ([FilePath], GlobalDecls) +parseMkGlobal gcc opts input_file = do + let compiler = newGCC gcc + ast <- parseCFile compiler Nothing opts input_file >>= checkResult "[parsing]" + (globals, warnings) <- (runTrav_ >>> checkResult "[analysis]") $ analyseAST ast + mapM_ (hPutStrLn stderr . show) warnings + return (filesInAST ast, globals) + where + checkResult :: (Show a) => String -> (Either a b) -> IO b + checkResult label = either (error . (label++) . show) return + +filesInAST :: CTranslUnit -> [FilePath] +filesInAST (CTranslUnit ds n) = + delete "" . nub $ map (maybe "" id) (fileOfNode n : map fileOfNode ds) diff --git a/src/Language/C2ATS/Pretty.hs b/src/Language/C2ATS/Pretty.hs new file mode 100644 --- /dev/null +++ b/src/Language/C2ATS/Pretty.hs @@ -0,0 +1,499 @@ +{-# LANGUAGE FlexibleInstances, TypeSynonymInstances #-} +module Language.C2ATS.Pretty + ( atsPrettyGlobal + , preDefineGlobal + , AtsPretty (..) + , CPretty (..) + ) where + +import Data.List +import Data.Map (Map) +import qualified Data.Map as Map +import Text.PrettyPrint.HughesPJ +import Debug.Trace {- for warnings -} + +import Language.C +import Language.C.Analysis +import Language.C.Data.Ident + +import Language.C2ATS.Process + +instance Pretty FlatGlobalDecl where + pretty (FGObj d) = pretty d + pretty (FGTag d) = pretty d + pretty (FGType d) = pretty d + pretty (FGRaw s) = text s + +predef_c2ats_gnuc_va_list = "type_c2ats___gnuc_va_list" +predef_c2ats_any = "type_c2ats___any" + +preDefineGlobal :: FilePath -> IO Doc +preDefineGlobal f = do + s <- readFile f + return $ text ("// File: " ++ f) $+$ text "%{#" $+$ text s $+$ text "%}" $+$ + text "abst@ype" <+> text predef_c2ats_gnuc_va_list $+$ -- can't use in ATS + text "abst@ype" <+> text predef_c2ats_any $+$ -- can't use in ATS + text (init $ unlines [ + "viewdef ptr_v_1 (a:t@ype, l:addr) = a @ l", + "dataview ptr_v_2 (a:t@ype+, l0: addr, l1: addr) =", + " | ptr_v_2_cons(a, l0, l1) of (ptr l1 @ l0, ptr_v_1 (a, l1))", + "dataview ptr_v_3 (a:t@ype+, l0:addr, l1:addr, l2:addr) =", + " | ptr_v_3_cons(a, l0, l1, l2) of (ptr l1 @ l0, ptr_v_2 (a, l1, l2))" + -- Need dataview ptr_v_4, and more? + ]) + +-------------------------------------------------------------------------------- +type AtsPrettyMap = Map SUERef FlatGlobalDecl + +atsPrettyGlobal :: [FlatG] -> Doc +atsPrettyGlobal m = (vcat . map f $ m) + where + f :: FlatG -> Doc + f (_, d) = atsPretty (Map.fromList m) d + +class AtsPretty p where + atsPretty :: AtsPrettyMap -> p -> Doc + atsPrettyPrec :: AtsPrettyMap -> Int -> p -> Doc + atsPretty m = atsPrettyPrec m 0 + atsPrettyPrec m _ = atsPretty m + +instance AtsPretty FlatGlobalDecl where + atsPretty m (FGObj d) = atsPretty m d + atsPretty m (FGTag d) = atsPretty m d + atsPretty m (FGType d) = atsPretty m d + atsPretty m (FGRaw s) = text s + +instance AtsPretty TypeDef where + atsPretty m (TypeDef ident ty _ _) = + text "typedef type" <> atsPretty m ident <+> text "=" <+> atsPretty m ty + +instance AtsPretty Ident where + atsPretty m (Ident s _ _) = text "_c2ats_" <> text s + +instance AtsPretty Type where + atsPretty m (DirectType t _ _) = atsPretty m t + atsPretty m (PtrType (FunctionType t _) _ _) = atsPretty m t + atsPretty m (PtrType (DirectType TyVoid _ _) _ _) = text "ptr" + atsPretty m (PtrType t _ _) = text "cPtr0(" <> atsPretty m t <> text ")" + atsPretty m (ArrayType t s _ _) = text "@[" <> atsPretty m t <> text "][" <> atsPretty m s <> text "]" + atsPretty m (FunctionType f _) = atsPretty m f + atsPretty m (TypeDefType t _ _) = text "type" <> atsPretty m t + +instance AtsPretty TypeName where + atsPretty m TyVoid = text "void" + atsPretty m (TyComp (CompTypeRef s c _)) = atsPretty m c <> atsPretty m s + atsPretty m (TyEnum e) = atsPretty m e + atsPretty m (TyComplex _) = + let msg = text "Not support TyComplex" + in trace ("*** " ++ show msg) $ text "(*" <+> msg <+> text "*)" + atsPretty m (TyBuiltin TyVaList) = text predef_c2ats_gnuc_va_list + atsPretty m (TyBuiltin TyAny) = text predef_c2ats_any + atsPretty m (TyIntegral t) = f t + where + f TyBool = text "bool" + f TyChar = text "char" + f TySChar = text "schar" + f TyUChar = text "uchar" + f TyShort = text "sint" + f TyUShort = text "usint" + f TyInt = text "int" + f TyUInt = text "uint" + f TyInt128 = trace "*** \"int128\" not implemented in ATS" $ text "int128" + f TyUInt128 = trace "*** \"uint128\" not implemented in ATS" $ text "uint128" + f TyLong = text "lint" + f TyULong = text "ulint" + f TyLLong = text "llint" + f TyULLong = text "ullint" + atsPretty m (TyFloating t) = f t + where + f TyFloat = text "float" + f TyDouble = text "double" + f TyLDouble = text "ldouble" + +instance AtsPretty CompTyKind where + atsPretty m StructTag = text "struct" + atsPretty m UnionTag = text "union" + +instance AtsPretty SUERef where + atsPretty m (AnonymousRef name) = text "_c2ats_anon_" <> int (nameId name) + atsPretty m (NamedRef ident) = atsPretty m ident + +instance AtsPretty EnumTypeRef where + atsPretty m (EnumTypeRef _ _ ) = text "int" -- ATS does not have enum + +instance AtsPretty ArraySize where + atsPretty m (UnknownArraySize _) = text "0" -- ATS does not support UnknownArraySize + atsPretty m (ArraySize _ e) = atsPretty m e + +instance AtsPretty TypeDefRef where + atsPretty m (TypeDefRef ident _ _) = atsPretty m ident + +instance AtsPretty FunType where + atsPretty m (FunTypeIncomplete t) = text "() ->" <+> atsPretty m t + atsPretty m (FunType t ps _) = + addrs <> text "(" <> views <> args <> text ")" <+> text "->" <+> raddrs <+> ret + where + paramDeclType :: ParamDecl -> Type + paramDeclType (ParamDecl (VarDecl _ _ ty) _) = ty + paramDeclType (AbstractParamDecl (VarDecl _ _ ty) _) = ty + isViewPointer :: Type -> Bool + isViewPointer (PtrType (FunctionType _ _) _ _) = False + isViewPointer (PtrType (DirectType TyVoid _ _) _ _) = False + isViewPointer (PtrType _ _ _) = True + isViewPointer _ = False + isViewPointer' :: ParamDecl -> Bool + isViewPointer' = isViewPointer . paramDeclType + atviewToList :: AtsPrettyMap -> Type -> (Int, Int) -> [Doc] -> [Doc] + atviewToList m (PtrType (FunctionType t _) _ _) _ d = (atsPretty m t) : d + atviewToList m (PtrType (DirectType TyVoid _ _) _ _) _ d = text "ptr" : d + atviewToList m (PtrType t _ _) (i,j) d = + let minor = if j == 0 then empty else text "_" <> int j + in atviewToList m t (i,j+1) (d ++ [text "l" <> int i <> minor]) + atviewToList m t _ d = (atsPretty m t) : d + atviewShow :: AtsPrettyMap -> Type -> Int -> Doc + atviewShow m t n = + let l = atviewToList m t (n, 0) [] + in text "ptr_v_" <> int (length l - 1) <> text "(" <> + (hcat $ punctuate (text ", ") l) <> text ")" + argf :: AtsPrettyMap -> (Int, [Doc]) -> ParamDecl -> (Int, [Doc]) + argf m (n, ps) pd | isViewPointer' pd = + (n + 1, ps ++ [text "ptr l" <> int n]) + argf m (n, ps) p = (n, ps ++ [atsPretty m p]) + args = hcat $ punctuate (text ", ") $ snd (foldl (argf m) (1, []) ps) + addrf :: AtsPrettyMap -> (Int, [Doc]) -> ParamDecl -> (Int, [Doc]) + addrf m (n, ps) pd | isViewPointer' pd = + (n + 1, ps ++ (tail $ atviewToList m (paramDeclType pd) (n, 0) [])) + addrf m l p = l + addrs = let a = snd (foldl (addrf m) (1, []) ps) + in if null a then empty + else text "{" <> (hcat $ punctuate (text ",") a) <> text ":addr} " + viewf :: AtsPrettyMap -> (Int, [Doc]) -> ParamDecl -> (Int, [Doc]) + viewf m (n, ps) pd | isViewPointer' pd = + (n + 1, ps ++ [text "!" <> atviewShow m (paramDeclType pd) n]) + viewf m l p = l + views = let v = snd (foldl (viewf m) (1, []) ps) + in if null v then empty + else text "" <> (hcat $ punctuate (text ", ") v) <+> text "| " + ri = fst (foldl (addrf m) (1, []) ps) + rviews = if not (isViewPointer t) then empty + else atviewShow m t ri <+> text "| " + raddrs = if not (isViewPointer t) then empty + else text "[" <> (hcat $ punctuate (text ",") (tail $ atviewToList m t (ri,0) [])) <> text ":addr]" + ret = if not (isViewPointer t) then atsPretty m t + else text "(" <> rviews <> text "ptr l" <> int ri <> text ")" + +instance AtsPretty ParamDecl where + atsPretty m (ParamDecl (VarDecl _ _ ty) _) = atsPretty m ty + atsPretty m (AbstractParamDecl (VarDecl _ _ ty) _) = atsPretty m ty + +instance AtsPretty TagDef where + atsPretty m (CompDef compty) = atsPretty m compty + atsPretty m (EnumDef enumty) = empty -- ATS does not have enum + +instance AtsPretty CompType where + atsPretty m (CompType sue_ref tag members attrs node) = + tdef <> ext sue_ref <> text "\" of {" $+$ (nest 2 $ vcat (atsPretty' members)) $+$ text "}" + where + tdef = text "typedef" <+> atsPretty m tag <> atsPretty m sue_ref <+> text "= $extype_struct\"" + ext (NamedRef ident) = atsPretty m tag <+> pretty ident + ext (AnonymousRef _) = atsPretty m tag <+> text "{" <+> hcat (map (cPretty m) members) <> text "}" + atsPretty' :: [MemberDecl] -> [Doc] + atsPretty' md = + punctuate (text ",") $ filter (not . isEmpty) . map (atsPretty m) $ md + +instance AtsPretty MemberDecl where -- Ignore bit field + atsPretty m (MemberDecl (VarDecl name _ ty) _ _) = + if keyword name then empty else atsPretty m name <+> text "=" <+> atsPretty' m ty + where + atsPretty' :: AtsPrettyMap -> Type -> Doc + atsPretty' m (PtrType (FunctionType t _) _ _) = atsPretty m t + atsPretty' m (PtrType t _ _) = text "ptr (* cPtr0(" <> atsPretty m t <> text ") *)" + atsPretty' m t = atsPretty m t + -- xxx `keyword` func should be remove! https://github.com/metasepi/c2ats/issues/7 + keyword :: VarName -> Bool + keyword (VarName (Ident "begin" _ _) _) = True + keyword (VarName (Ident "end" _ _) _) = True + keyword (VarName (Ident "in" _ _) _) = True + keyword (VarName (Ident "prefix" _ _) _) = True + keyword _ = False + atsPretty m (AnonBitField ty _ _) = empty -- Ignore AnonBitField + +instance AtsPretty VarName where + atsPretty m (VarName i _) = pretty i + atsPretty m NoName = text "_c2ats_anonymous" + +instance AtsPretty IdentDecl where + atsPretty m (Declaration (Decl (VarDecl (VarName ident _) _ (FunctionType ty _)) _)) = + text "fun fun" <> atsPretty m ident <> text ":" <+> atsPretty m ty <+> text "= \"mac#" <> pretty ident <> text "\"" + atsPretty m (Declaration (Decl (VarDecl (VarName ident _) _ ty) _)) = + text "macdef extval" <> atsPretty m ident <+> text "= $extval(" <> atsPretty m ty <> text ", \"" <> pretty ident <> text "\")" + atsPretty m (ObjectDef (ObjDef (VarDecl (VarName ident _) _ ty) _ _)) = + text "macdef extval" <> atsPretty m ident <+> text "= $extval(" <> atsPretty m ty <> text ", \"" <> pretty ident <> text "\")" + atsPretty m (FunctionDef (FunDef (VarDecl (VarName ident _) _ ty) _ _)) = + text "fun fun" <> atsPretty m ident <> text ":" <+> atsPretty m ty <+> text "= \"mac#" <> pretty ident <> text "\"" + atsPretty m (EnumeratorDef (Enumerator i e _ _)) = + text "#define enum" <> atsPretty m i <+> atsPretty m e + +maybeP :: (p -> Doc) -> Maybe p -> Doc +maybeP = maybe empty + +identP :: Ident -> Doc +identP = text . identToString + +parenPrec :: Int -> Int -> Doc -> Doc +parenPrec prec prec2 t = if prec <= prec2 then t else parens t + +instance AtsPretty CExpr where + atsPrettyPrec m p (CComma exprs _) = + parenPrec p (-1) $ hsep (punctuate comma (map (atsPrettyPrec m 2) exprs)) + atsPrettyPrec m p (CAssign op expr1 expr2 _) = + parenPrec p 2 $ atsPrettyPrec m 3 expr1 <+> pretty op <+> atsPrettyPrec m 2 expr2 + atsPrettyPrec m p (CCond expr1 expr2 expr3 _) = + parenPrec p 2 $ atsPrettyPrec m 4 expr1 <+> text "?" -- NB: assignment only has a higher precedence if cond is on the rhs + <+> maybeP pretty expr2 <+> text ":" <+> atsPrettyPrec m 4 expr3 + atsPrettyPrec m p (CBinary op@COrOp expr1 expr2 _) = + let prec = binPrec op + in parenPrec p prec $ atsPrettyPrec m prec expr1 + <+> text "lor" <+> atsPrettyPrec m (prec + 1) expr2 + atsPrettyPrec m p (CBinary op@CAndOp expr1 expr2 _) = + let prec = binPrec op + in parenPrec p prec $ atsPrettyPrec m prec expr1 + <+> text "land" <+> atsPrettyPrec m (prec + 1) expr2 + atsPrettyPrec m p (CBinary op@CXorOp expr1 expr2 _) = + let prec = binPrec op + in parenPrec p prec $ atsPrettyPrec m prec expr1 + <+> text "lxor" <+> atsPrettyPrec m (prec + 1) expr2 + atsPrettyPrec m p (CBinary op expr1 expr2 _) = + let prec = binPrec op + in parenPrec p prec $ atsPrettyPrec m prec expr1 + <+> pretty op <+> atsPrettyPrec m (prec + 1) expr2 + atsPrettyPrec m p (CCast decl expr _) = + atsPrettyPrec m 25 expr + atsPrettyPrec m p (CUnary CPostIncOp expr _) = + parenPrec p 26 $ atsPrettyPrec m 26 expr <> text "++" + atsPrettyPrec m p (CUnary CPostDecOp expr _) = + parenPrec p 26 $ atsPrettyPrec m 26 expr <> text "--" + atsPrettyPrec m p (CUnary CMinOp expr _) = + parenPrec p 25 $ text "~" <> atsPrettyPrec m 25 expr + atsPrettyPrec m p (CUnary op expr@(CUnary _ _ _) _) = + -- parens aren't necessary, but look nicer imho + parenPrec p 25 $ pretty op <+> parens (atsPrettyPrec m 25 expr) + atsPrettyPrec m p (CUnary op expr _) = + parenPrec p 25 $ pretty op <> atsPrettyPrec m 25 expr + atsPrettyPrec m p (CSizeofExpr expr _) = + parenPrec p 25 $ text "sizeof" <> parens (atsPretty m expr) + atsPrettyPrec m p (CSizeofType decl _) = + parenPrec p 25 $ text "sizeof" <> parens (atsPretty m decl) + atsPrettyPrec m p (CAlignofExpr expr _) = + parenPrec p 25 $ text "__alignof" <> parens (atsPretty m expr) + atsPrettyPrec m p (CAlignofType decl _) = + parenPrec p 25 $ text "__alignof" <> parens (atsPretty m decl) + atsPrettyPrec m p (CComplexReal expr _) = + parenPrec p 25 $ text "__real" <+> atsPrettyPrec m 25 expr + atsPrettyPrec m p (CComplexImag expr _) = + parenPrec p 25 $ text "__imag" <+> atsPrettyPrec m 25 expr + atsPrettyPrec m p (CIndex expr1 expr2 _) = + parenPrec p 26 $ atsPrettyPrec m 26 expr1 + <> text "[" <> atsPretty m expr2 <> text "]" + atsPrettyPrec m p (CCall expr args _) = + parenPrec p 30 $ atsPrettyPrec m 30 expr <> text "(" + <> (sep . punctuate comma . map (atsPretty m)) args <> text ")" + atsPrettyPrec m p (CMember expr ident deref _) = + parenPrec p 26 $ atsPrettyPrec m 26 expr + <> text (if deref then "->" else ".") <> identP ident + atsPrettyPrec m _p (CVar ident _) = identP ident + atsPrettyPrec m _p (CConst (CCharConst (CChar '(' _) _)) = text "'\\('" + atsPrettyPrec m _p (CConst (CCharConst (CChar '{' _) _)) = text "'\\{'" + atsPrettyPrec m _p (CConst (CCharConst (CChar '[' _) _)) = text "'\\['" + atsPrettyPrec m _p (CConst constant) = pretty constant + atsPrettyPrec m _p (CCompoundLit decl initl _) = + parens (pretty decl) <+> (braces . hsep . punctuate comma) (map p initl) where + p ([], initializer) = pretty initializer + p (mems, initializer) = hcat (punctuate (text ".") (map pretty mems)) <+> text "=" <+> pretty initializer + atsPrettyPrec m _p (CStatExpr stat _) = + text "(" <> pretty stat <> text ")" + atsPrettyPrec m _p (CLabAddrExpr ident _) = text "&&" <> identP ident + atsPrettyPrec m _p (CBuiltinExpr builtin) = pretty builtin + +binPrec :: CBinaryOp -> Int +binPrec CMulOp = 20 +binPrec CDivOp = 20 +binPrec CRmdOp = 20 +binPrec CAddOp = 19 +binPrec CSubOp = 19 +binPrec CShlOp = 18 +binPrec CShrOp = 18 +binPrec CLeOp = 17 +binPrec CGrOp = 17 +binPrec CLeqOp = 17 +binPrec CGeqOp = 17 +binPrec CEqOp = 16 +binPrec CNeqOp = 16 +binPrec CAndOp = 15 +binPrec CXorOp = 14 +binPrec COrOp = 13 +binPrec CLndOp = 12 +binPrec CLorOp = 11 + +instance AtsPretty CDecl where + atsPretty m (CDecl t _ _) = atsPretty m t + +instance AtsPretty [CDeclarationSpecifier NodeInfo] where + atsPretty m [(CTypeSpec (CVoidType _))] = text "ptr" + atsPretty m [(CTypeSpec (CCharType _))] = text "char" + atsPretty m [(CTypeSpec (CShortType _))] = text "short" + atsPretty m [(CTypeSpec (CIntType _))] = text "int" + atsPretty m [(CTypeSpec (CFloatType _))] = text "float" + atsPretty m [(CTypeSpec (CDoubleType _))] = text "double" + atsPretty m [(CTypeSpec (CBoolType _))] = text "bool" + atsPretty m [(CTypeSpec (CEnumType enum _))] = text "int" + atsPretty m [(CTypeSpec (CSignedType _)), + (CTypeSpec (CCharType _))] = text "schar" + atsPretty m [(CTypeSpec (CUnsigType _)), + (CTypeSpec (CCharType _))] = text "uchar" + atsPretty m [(CTypeSpec (CSignedType _)), + (CTypeSpec (CShortType _))] = text "sint" + atsPretty m [(CTypeSpec (CUnsigType _)), + (CTypeSpec (CShortType _))] = text "usint" + atsPretty m [(CTypeSpec (CUnsigType _)), + (CTypeSpec (CIntType _))] = text "uint" + atsPretty m [(CTypeSpec (CLongType _)), + (CTypeSpec (CIntType _))] = text "lint" + atsPretty m [(CTypeSpec (CUnsigType _)), + (CTypeSpec (CLongType _)), + (CTypeSpec (CIntType _))] = text "ulint" + atsPretty m [(CTypeSpec (CLongType _)), + (CTypeSpec (CLongType _)), + (CTypeSpec (CIntType _))] = text "llint" + atsPretty m [(CTypeSpec (CUnsigType _)), + (CTypeSpec (CLongType _)), + (CTypeSpec (CLongType _)), + (CTypeSpec (CIntType _))] = text "ullint" + atsPretty m [(CTypeSpec (CLongType _)), + (CTypeSpec (CDoubleType _))] = text "ldouble" + atsPretty m [(CTypeSpec (CTypeDef ident _))] = text "type" <> atsPretty m ident + +-------------------------------------------------------------------------------- +class CPretty p where + cPretty :: AtsPrettyMap -> p -> Doc + cPrettyPrec :: AtsPrettyMap -> Int -> p -> Doc + cPretty m = cPrettyPrec m 0 + cPrettyPrec m _ = cPretty m + +subscriptArray :: AtsPrettyMap -> Type -> Doc +subscriptArray m (ArrayType t s _ _) = (brackets $ cPretty m s) <> subscriptArray m t +subscriptArray m t = empty + +instance CPretty ArraySize where + cPretty m (UnknownArraySize _) = empty + cPretty m (ArraySize _ e) = pretty e + +instance CPretty FlatGlobalDecl where + -- cPretty m (FGObj d) = cPretty m d + cPretty m (FGTag d) = cPretty m d + cPretty m (FGType d) = cPretty m d + +instance CPretty TagDef where + cPretty m (CompDef compty) = cPretty m compty + cPretty m (EnumDef enumty) = text "int" -- ATS does not have enum + +instance CPretty TypeDef where + cPretty m (TypeDef ident ty _ _) = + text "typedef" <+> cPretty m ty <+> cPretty m ident + +instance CPretty CompType where + cPretty m (CompType sue_ref tag members attrs node) = + ext sue_ref + where + ext (NamedRef ident) = cPretty m tag <+> pretty ident + ext (AnonymousRef _) = cPretty m tag <+> text "{" <+> hcat (map (cPretty m) members) <> text "}" + +instance CPretty MemberDecl where + cPretty m (MemberDecl (VarDecl name _ (PtrType (FunctionType (FunType ty para _) _) _ _)) _ _) = + cPretty m ty <+> text "(*" <> pretty name <> text ")(" <> hcat (punctuate (text ", ") $ map (cPretty m) para) <> text ")" <> text "; " + cPretty m (MemberDecl (VarDecl name declattrs ty) bitfield _) = + pretty declattrs <+> cPretty m ty <+> pretty name <> subscriptArray m ty <+> + (maybe empty (\bf -> text ":" <+> pretty bf) bitfield) <> text "; " + cPretty m (AnonBitField ty bitfield_sz _) = + cPretty m ty <+> text ":" <+> pretty bitfield_sz <> text "; " + +instance CPretty Type where + cPretty m (DirectType t _ _) = cPretty m t + cPretty m (PtrType t _ _) = cPretty m t <> text "*" + cPretty m (ArrayType t _ _ _) = cPretty m t + cPretty m (TypeDefType t _ _) = cPretty m t + -- Do not print function type directly + +instance CPretty TypeName where + cPretty m TyVoid = text "void" + cPretty m (TyComp (CompTypeRef s@(NamedRef _) c _)) = cPretty m c <+> cPretty m s + cPretty m (TyComp (CompTypeRef s@(AnonymousRef _) c _)) = cPretty m s + cPretty m (TyEnum e) = cPretty m e + cPretty m t@(TyComplex _) = + let msg = text "Not support TyComplex" + in trace ("*** " ++ show msg) $ text "/*" <+> msg <+> text "*/" + cPretty m (TyBuiltin TyVaList) = text "__gnuc_va_list" -- gcc specific + cPretty m (TyBuiltin TyAny) = + let msg = text "Not support TyBuiltin TyAny" + in trace ("*** " ++ show msg) $ text "2/*" <+> msg <+> text "*/" + cPretty m (TyIntegral t) = f t + where + f TyBool = text "bool" + f TyChar = text "char" + f TySChar = text "signed char" + f TyUChar = text "unsigned char" + f TyShort = text "short" + f TyUShort = text "unsigned short" + f TyInt = text "int" + f TyUInt = text "unsigned int" + f TyInt128 = text "int128_t" + f TyUInt128 = text "uint128_t" + f TyLong = text "long int" + f TyULong = text "unsigned long int" + f TyLLong = text "long long int" + f TyULLong = text "unsigned long long int" + cPretty m (TyFloating t) = f t + where + f TyFloat = text "float" + f TyDouble = text "double" + f TyLDouble = text "long double" + +instance CPretty CompTyKind where + cPretty m StructTag = text "struct" + cPretty m UnionTag = text "union" + +instance CPretty SUERef where + cPretty m (NamedRef ident) = cPretty m ident + cPretty m s@(AnonymousRef _) = + let Just g = Map.lookup s m in cPretty m g + +instance CPretty EnumTypeRef where + cPretty m (EnumTypeRef _ _ ) = text "int" -- ATS does not have enum + +instance CPretty Ident where + cPretty m (Ident s _ _) = text s + +instance CPretty TypeDefRef where + cPretty m (TypeDefRef ident _ _) = cPretty m ident + +prettyCParamFun :: AtsPrettyMap -> Ident -> Type -> [ParamDecl] -> Doc +prettyCParamFun m n ty para = + cPretty m ty <+> cPretty m n <> parens (hcat $ punctuate (text ", ") $ map (cPretty m) para) +prettyCParam :: AtsPrettyMap -> Ident -> Type -> Doc +prettyCParam m n ty = cPretty m ty <+> cPretty m n <> subscriptArray m ty +prettyCParamNoname :: AtsPrettyMap -> Type -> Doc +prettyCParamNoname m ty = cPretty m ty <> subscriptArray m ty + +instance CPretty ParamDecl where + cPretty m (ParamDecl (VarDecl (VarName n _) _ (FunctionType (FunType ty para _) _)) _) = + prettyCParamFun m n ty para + cPretty m (AbstractParamDecl (VarDecl (VarName n _) _ (FunctionType (FunType ty para _) _)) _) = + prettyCParamFun m n ty para + cPretty m (ParamDecl (VarDecl (VarName n _) _ ty) _) = + prettyCParam m n ty + cPretty m (AbstractParamDecl (VarDecl (VarName n _) _ ty) _) = + prettyCParam m n ty + cPretty m (ParamDecl (VarDecl NoName _ ty) _) = + prettyCParamNoname m ty + cPretty m (AbstractParamDecl (VarDecl NoName _ ty) _) = + prettyCParamNoname m ty diff --git a/src/Language/C2ATS/Process.hs b/src/Language/C2ATS/Process.hs new file mode 100644 --- /dev/null +++ b/src/Language/C2ATS/Process.hs @@ -0,0 +1,224 @@ +{-# LANGUAGE FlexibleInstances, TypeSynonymInstances #-} +module Language.C2ATS.Process + ( flatGlobal + , injectForwardDecl + , sortFlatGlobal + , injectIncludes + , FlatGlobalDecl (..) + , FlatG (..) + ) where + +import Data.Maybe +import Data.List +import Data.Set (Set) +import qualified Data.Set as Set +import Data.Map (Map) +import qualified Data.Map as Map +import Text.Regex.Posix +import Debug.Trace {- for warnings -} + +import Language.C +import Language.C.Analysis +import Language.C.Data.Ident + +data FlatGlobalDecl = FGObj IdentDecl + | FGTag TagDef + | FGType TypeDef + | FGRaw String + +instance CNode FlatGlobalDecl where + nodeInfo (FGObj d) = nodeInfo d + nodeInfo (FGTag d) = nodeInfo d + nodeInfo (FGType d) = nodeInfo d + nodeInfo (FGRaw _) = undefNode + +type FlatG = (SUERef, FlatGlobalDecl) + +flatGlobal :: GlobalDecls -> [FlatG] +flatGlobal gmap = theTags ++ theObjs ++ theTypeDefs + where + theTags = Map.assocs $ Map.map FGTag $ gTags gmap + theObjs = Map.assocs $ Map.map FGObj $ Map.mapKeys NamedRef $ gObjs gmap + theTypeDefs = Map.assocs $ Map.map FGType $ Map.mapKeys NamedRef $ gTypeDefs gmap + +injectIncludes :: [String] -> [String] -> [FlatG] -> [FlatG] +injectIncludes includes excludes m = + concat . map incl . map reverse . sortElems . foldl go ([], Map.empty) $ m + where + f :: String -> Maybe FilePath + f ('<':_) = Nothing + f xs = Just . filter (\c -> c /= '"' && c /= ':' && c /= '(') . head . words $ xs + getFile :: FlatG -> Maybe FilePath + getFile = f . show . posOfNode . nodeInfo . snd + sortElems :: ([Maybe FilePath], Map (Maybe FilePath) [FlatG]) -> [[FlatG]] + sortElems (file:files,mp) = + sortElems (files, Map.delete file mp) ++ [fromJust $ Map.lookup file mp] + sortElems ([], _) = [] + go :: ([Maybe FilePath], Map (Maybe FilePath) [FlatG]) -> FlatG + -> ([Maybe FilePath], Map (Maybe FilePath) [FlatG]) + go (files,mp) fg = + let file = getFile fg + files' = if file `elem` files then files else file:files + in (files', Map.insertWith (++) file [fg] mp) + incl :: [FlatG] -> [FlatG] + incl fgs@((s,fg):_) = case getFile (s,fg) of + Nothing -> + (s, FGRaw $ "// No file"):fgs + (Just file) | (or $ map (=~ file) includes) || (not . or $ map ((=~) file) excludes) -> + (s, FGRaw $ init $ unlines [ + "// File: " ++ file, + "%{#", + "#include \"" ++ file ++ "\"", + "%}" + ]):fgs + (Just file) -> + (s, FGRaw $ "// File: " ++ file):fgs + +-------------------------------------------------------------------------------- +sortFlatGlobal :: [FlatG] -> [FlatG] +sortFlatGlobal = (\(a,_,_,b) -> reverse a ++ b) . foldl go ([], Set.empty, Set.empty, []) . sortBy order + where + order :: FlatG -> FlatG -> Ordering + order (_, a) (_, b) = nodeInfo a `compare` nodeInfo b + go :: ([FlatG], Set Int, Set Int, [FlatG]) -> FlatG -> + ([FlatG], Set Int, Set Int, [FlatG]) + go (out, knowns, deps, ks) fg@(s,_) = + let knowns' = Set.insert (nodeSUERef s) knowns + deps' = Set.difference (Set.union deps $ anons fg) knowns' + out' = (if Set.null deps' then reverse ks ++ [fg] else []) ++ out + ks' = if Set.null deps' then [] else fg : ks + in (out', knowns', deps', ks') + anons :: FlatG -> Set Int + anons (_, g) = anonRefs g + +nodeSUERef :: SUERef -> Int +nodeSUERef (AnonymousRef n) = nameId n +nodeSUERef (NamedRef (Ident _ _ (NodeInfo _ _ n))) = nameId n +nodeSUERef _ = -1 + +class AnonRefs p where + anonRefs :: p -> Set Int + +instance AnonRefs FlatGlobalDecl where + anonRefs (FGObj d) = anonRefs d + anonRefs (FGTag d) = anonRefs d + anonRefs (FGType d) = anonRefs d + +instance AnonRefs IdentDecl where + anonRefs (Declaration (Decl v _)) = anonRefs v + anonRefs (ObjectDef (ObjDef v _ _)) = anonRefs v + anonRefs (FunctionDef (FunDef v _ _)) = anonRefs v + anonRefs (EnumeratorDef _) = Set.empty -- ATS does not have enum + +instance AnonRefs MemberDecl where + anonRefs (MemberDecl v _ _) = anonRefs v + anonRefs (AnonBitField t _ _) = anonRefs t + +instance AnonRefs VarDecl where + anonRefs (VarDecl _ _ t) = anonRefs t + +instance AnonRefs TagDef where + anonRefs (EnumDef _) = Set.empty -- ATS does not have enum + anonRefs (CompDef (CompType _ _ m _ _)) = Set.unions $ map anonRefs m + +instance AnonRefs TypeDef where + anonRefs (TypeDef _ t _ _) = anonRefs t + +instance AnonRefs Type where + anonRefs (PtrType t _ _) = anonRefs t + anonRefs (ArrayType t _ _ _) = anonRefs t + anonRefs (FunctionType ft _) = anonRefs ft + anonRefs (DirectType tn _ _) = anonRefs tn + anonRefs _ = Set.empty + +instance AnonRefs TypeName where + anonRefs (TyComp (CompTypeRef s _ _)) = anonRefs s + anonRefs _ = Set.empty + +instance AnonRefs FunType where + anonRefs (FunTypeIncomplete t) = anonRefs t + anonRefs (FunType t p _) = + Set.union (anonRefs t) (Set.unions $ map anonRefs p) + +instance AnonRefs ParamDecl where + anonRefs (ParamDecl v _) = anonRefs v + anonRefs (AbstractParamDecl v _) = anonRefs v + +instance AnonRefs SUERef where + anonRefs s@(AnonymousRef _) = Set.singleton $ nodeSUERef s + anonRefs (NamedRef _) = Set.empty + +-------------------------------------------------------------------------------- +type IndentsMap = (Maybe String, Set String) + +injectForwardDecl :: [FlatG] -> [FlatG] +injectForwardDecl = reverse . fst . foldl f ([], Set.empty) + where + f :: ([FlatG], Set String) -> FlatG -> ([FlatG], Set String) + f (fgs, is) fg@(s,g) = + let (i, is') = idents g + knownis = maybe is (\a -> Set.insert a is) i + fds = forwardDecls $ Set.elems $ Set.difference is' knownis + is'' = Set.union is' knownis + in (fg : fds ++ fgs, is'') + +forwardDecls :: [String] -> [FlatG] +forwardDecls = map f + where + f i = (NamedRef $ mkIdent nopos i (Name (-1)), FGRaw $ "abst@ype " ++ i ++ " // FIXME! Forward declaration.") + +identsAppend :: IndentsMap -> IndentsMap -> IndentsMap +identsAppend (i_a@(Just _), is_a) (i_b, is_b) = (i_a, Set.union is_a is_b) +identsAppend (Nothing, is_a) (i_b, is_b) = (i_b, Set.union is_a is_b) + +class Idents p where + idents :: p -> IndentsMap + +instance Idents FlatGlobalDecl where + idents (FGObj d) = idents d + idents (FGTag d) = idents d + idents (FGType d) = idents d + idents (FGRaw _) = (Nothing, Set.empty) + +instance Idents IdentDecl where + idents (Declaration (Decl v _)) = idents v + idents (ObjectDef (ObjDef v _ _)) = idents v + idents (FunctionDef (FunDef v _ _)) = idents v + idents _ = (Nothing, Set.empty) + +instance Idents MemberDecl where + idents (MemberDecl v _ _) = idents v + idents (AnonBitField t _ _) = idents t + +instance Idents VarDecl where + idents (VarDecl _ _ t) = idents t + +instance Idents TagDef where + idents (CompDef (CompType (NamedRef i) k m _ _)) = + foldl (\a b -> a `identsAppend` idents b) (Just $ show k ++ "_c2ats_" ++ identToString i, Set.empty) m + idents (CompDef (CompType (AnonymousRef _) _ m _ _)) = + foldl (\a b -> a `identsAppend` idents b) (Nothing, Set.empty) m + idents _ = (Nothing, Set.empty) + +instance Idents TypeDef where + idents (TypeDef i t _ _) = + (Just $ "type_c2ats_" ++ identToString i, Set.empty) `identsAppend` idents t + +instance Idents Type where + idents (PtrType t _ _) = idents t + idents (ArrayType t _ _ _) = idents t + idents (FunctionType ft _) = idents ft + idents (DirectType (TyComp (CompTypeRef (NamedRef i) k _)) _ _) = + (Nothing, Set.singleton $ show k ++ "_c2ats_" ++ identToString i) + idents (TypeDefType (TypeDefRef i _ _) _ _) = + (Nothing, Set.singleton $ "type_c2ats_" ++ identToString i) + idents _ = (Nothing, Set.empty) + +instance Idents FunType where + idents (FunTypeIncomplete t) = idents t + idents (FunType t pd _) = + foldl (\a b -> a `identsAppend` idents b) (idents t) pd + +instance Idents ParamDecl where + idents (ParamDecl v _) = idents v + idents (AbstractParamDecl v _) = idents v diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,14 @@ +{-# LANGUAGE TemplateHaskell #-} +module Main where + +import Test.Framework.TH +import Test.Framework +import Test.HUnit +import Test.Framework.Providers.HUnit + +import Language.C2ATS + +main :: IO () +main = $(defaultMainGenerator) + +case_1 = 1 @=? 1