Skip to content
Browse files

Importing initial version

  • Loading branch information...
0 parents commit b27de3caf5e995c60059c8417a3027296b256f93 @deplinenoise committed Feb 3, 2010
674 COPYING
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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 <http://www.gnu.org/licenses/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<http://www.gnu.org/licenses/>.
+
+ 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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
103 TODO
@@ -0,0 +1,103 @@
+* Comma operator doesn't paren correctly inside funcall:
+ (foo (comma 1 2)) generates foo(1,2) rather than foo((1, 2)) as it should
+
+* Array types and declarations. Make aref work with arrays too
+ (possibly via pointer decay).
+
+* Switch/case AST - should be easy
+
+* Language concerns:
+
+ - Currently hijacking e.g. ptr, aref and other short words as part
+ of the grammar. Can they still be used as variable names without
+ breaking anything? Maybe, because the type grammar is separate
+ from the names. Is c-amplify a c-2 or c-1? :P
+
+* Make the pretty printer work better:
+
+ - Don't introduce new blocks when there's already a fresh block to use:
+ (progn (progn (progn (printf "foo"))))
+ should generate { printf("foo"); }
+ but currently generates { { { printf("foo"); } } }
+
+ Maybe something along the lines of freshline? (fresh-block?)
+
+ This could be extended to lexical declarations that must appear at
+ the top of a scope. Maybe a simplify-scopes funtion could be
+ devised for this that stops simplifying the structure if it sees a
+ shadowing variable declaration.
+
+ (progn (declare (a int))
+ (progn (declare b int)
+ (= b a)))
+
+ currently: { int a; { int b; b = a; } }
+ want: { int a; int b; b = a; }
+
+ If b is renamed to a, the nested block must reappear.
+
+ - Fix so null statements are dropped when they appear outside single
+ statement positions:
+
+ (when 1 *null-statement*) => if (1) ;
+ (when 1 (progn *null-statement*)) => if {}
+
+The semicolon is important in the first case
+
+(progn
+(= a 1)
+(*null-statement*)
+(= a 1)) => { a=1; a=1; }
+
+Don't know the rules for this yet, either it's that the null
+statement appears at progn scope that makes us want it dropped, or
+it's that it appears as the single statement of a control
+structure (if, while, ...)
+
+* Database serialization
+
+* Reamplifying just enough every run (track dependencies)
+
+* External declarations and linkage -- hairy
+
+- Import windows.h and entire CRT into x86, x64 packages as proof of
+concept (need a set of defines to import the correct definitions)
+
+- Translate preprocessor #defines to either constants or macros,
+whine about token pasting we can't map
+
+- Header importer:
+
+ Inputs:
+
+ - A set of defines that will match the intended backend compiler
+ (some defines may have values)
+
+ - A set of include paths (to look for additional includes)
+
+ - The root header file(s) to scan.
+
+ Outputs:
+
+ - A c-amplify file of extern declarations
+
+ Algorithm:
+
+ - Preprocess the file using the specified defines, include
+ paths. Parse the preprocessed output to get a complete list of
+ types and functions with the correct linkage (declspec, ...).
+
+ - Scan the headers for function-like macros; emit these as
+ c-macros in a best-effort way.
+
+- Lambdas
+
+ Accept an expression type matching (lambda <sig-list> <body>) which
+ evaluates to a function pointer of the lambda's signature.
+ Initially, we will just hoist the code out to a gensymd function and
+ use that name instead, but it would be cool to get limited lexical
+ capture later (similar to c++0x closures where the captures must be
+ specified). In the case where it makes sense to close over some
+ variables they are to be used in the callback immediately, and must
+ be passed in some userdata pointer. Think about how these things
+ would fit together.
24 code/c-amplify.asd
@@ -0,0 +1,24 @@
+
+(asdf:defsystem
+ :c-amplify
+
+ ;; System meta-data
+ :name "S-expression C development system"
+ :version "0.1"
+ :maintainer "dep"
+ :author "dep"
+ :license "GPL"
+
+ :depends-on (:cl-match)
+
+ ;; Components
+ :serial t
+ :components ((:file "package")
+ (:file "utils")
+ (:file "globals")
+ (:file "typesys")
+ (:file "macroexpand")
+ (:file "c-read")
+ (:file "clang")
+ (:file "main")))
+
14 code/c-read.lisp
@@ -0,0 +1,14 @@
+(in-package #:se.defmacro.c-amplify)
+
+(defparameter *c-readtable* (copy-readtable))
+
+(setf (readtable-case *c-readtable*) :preserve)
+
+(defparameter *read-end* (gensym "end"))
+
+(defun read-ca-file (path)
+ (with-open-file (stream path)
+ (let ((*readtable* *c-readtable*))
+ (let ((*package* (find-package :se.defmacro.c-amplify.csym)))
+ (loop for x = (read stream nil *read-end*)
+ while (not (eq x *read-end*)) collect x)))))
953 code/clang.lisp
@@ -0,0 +1,953 @@
+
+;;;; C language parser
+
+(in-package #:se.defmacro.c-amplify)
+
+(defgeneric generate-code (ast)
+ (:documentation
+"Print code for the datum passed which may be a c-type or ast-node or
+a list of such objects for convenience."))
+
+;;; Lexical scoping works by associating each ast-node instance with a
+;;; list that is the start of the search tree for that node. The macro
+;;; WITH-LEXICAL-SCOPE establishes a new binding for the *lexical-env*
+;;; variable. The lexical scope shared structure all the way back to
+;;; the top.
+
+(defparameter *lexical-scope-active* nil
+ "Sanity check for when %PUSH-LEXICAL-BINDING can be used")
+
+(defparameter *lexical-env* nil
+ "An alist (id . type) of variables currently in lexical
+scope (including formal arguments) in innermost-first order.")
+
+(defun %push-lexical-binding (id type)
+ "Push a binding of the symbol ID to the type TYPE on the current
+lexical scope chain."
+ (assert *lexical-scope-active*)
+ (push (cons id type) *lexical-env*))
+
+(defmacro with-lexical-scope (&rest body)
+ "Limit the lexical environment manipulations done by BODY to the
+BODY forms. For instance, the parser for a C compound statement should
+be wrapped in an WITH-LEXICAL-SCOPE macro."
+ `(let ((*lexical-scope-active* t)
+ (*lexical-env* *lexical-env*))
+ ,@body))
+
+(defun %env-lookup (symbol env-alist)
+ (cdr (assoc symbol env-alist)))
+
+(defun %type-of-lexical-symbol (symbol env-alist)
+ "Look up the type of SYMBOL lexically (and then globally, if a
+lexical binding cannot be found). Calls ERROR if the symbol isn't bound."
+ (let ((result (%env-lookup symbol env-alist)))
+ (if result
+ result
+ (let ((gv (lookup-gval symbol)))
+ (if gv
+ (gval-type gv)
+ (error "symbol is not bound lexically or globally: ~a" symbol))))))
+
+;;; AST nodes
+
+(defgeneric simplify (ast)
+ (:documentation "Visit the ast-node AST and try to simplify it"))
+
+(defclass ast-node ()
+ ((env
+ :type list
+ :accessor ast-env
+ :initform *lexical-env*
+ :documentation "Set to the state of the lexical environment alist
+ when the node is created, reflecting the lexical bindings
+ available at that point in the program."))
+ (:documentation "The base class for AST nodes."))
+
+(defmethod simplify ((self ast-node))
+ (dolist (child (ast-children self))
+ (simplify child)
+ self))
+
+(defun c-expr-p (datum)
+ (typep datum 'c-expr))
+
+(defun c-expr-list-p (datum)
+ (and (listp datum)
+ (every #'c-expr-p datum)))
+
+(defun c-type-p (datum)
+ (typep datum 'c-type))
+
+(defun c-stmt-p (datum)
+ (typep datum 'c-stmt))
+
+(defun c-stmt-list-p (datum)
+ (and (listp datum)
+ (every #'c-stmt-p datum)))
+
+(deftype c-expr-list () '(satisfies c-expr-list-p))
+(deftype c-stmt-list () '(satisfies c-stmt-list-p))
+
+(defclass c-expr (ast-node) ()
+ (:documentation "The base class for AST nodes representing expressions."))
+
+(defgeneric expr-typeof (expr)
+ (:documentation "Returns the type (a C-TYPE instance) of EXPR,
+ taking into account rules such as arithmetic type promotion."))
+
+(defclass c-unary-expr (c-expr)
+ ((operand :type c-expr :initarg :operand :accessor operand))
+ (:documentation "Base class for unary operators"))
+
+(defclass c-binary-expr (c-expr)
+ ((lhs :type c-expr :initarg :lhs :accessor lhs)
+ (rhs :type c-expr :initarg :rhs :accessor rhs))
+ (:documentation "Base class for binary operators"))
+
+(defvar *cg-newline* (gensym "newline-symbol")
+ "Symbol used to represent newlines")
+
+(defvar *cg-optional-separator* (gensym "optional-separator")
+ "Symbol used to represent optional spaces before opening
+ braces (those we don't want printed at the start of a fresh line)")
+
+(defvar *cg-freshline* (gensym "freshline-symbol")
+ "Symbol used to represent newlines on non-blank lines")
+
+(defparameter *outer-precedence* 1000)
+(defparameter *cg-print-depth* 0)
+(defparameter *cg-indent-str* " ")
+(defparameter *pending-indent* t)
+(defparameter *stmt-depth* 0)
+(defparameter *expr-depth* 0)
+(defparameter *compound-depth* 0)
+
+(defparameter *cg-toplevel-spacing* (list *cg-newline* *cg-newline*))
+(defparameter *cg-begin-block* (list *cg-freshline* *cg-optional-separator* "{" *cg-newline*))
+(defparameter *cg-end-block* (list *cg-freshline* "}"))
+(defparameter *cg-defun-return-type-separator* (list *cg-newline*))
+
+(defun %cg-print (&rest items)
+ "Pretty-print one or more ITEMS, taking indentation into account."
+ (labels ((indent-level ()
+ (+ (* 0 *stmt-depth*) *compound-depth*))
+ (finish-line ()
+ (princ #\newline)
+ (setf *pending-indent* t))
+ (fresh-line ()
+ (unless *pending-indent* (finish-line)))
+ (really-print (datum)
+ (when *pending-indent*
+ ;; (format t "/*~a/~a*/ " *stmt-depth* *compound-depth*)
+ (dotimes (x (indent-level)) (princ *cg-indent-str*))
+ (setf *pending-indent* nil))
+ (princ datum)))
+ (dolist (item items)
+ (cond ((eq *cg-freshline* item) (fresh-line))
+ ((eq *cg-newline* item) (finish-line))
+ ((eq *cg-optional-separator* item) (unless *pending-indent* (princ " ")))
+ ((listp item) (dolist (i item) (%cg-print i)))
+ ((typep item 'c-stmt) (let ((*stmt-depth* (1+ *stmt-depth*)))
+ (fresh-line)
+ (generate-code item)))
+ ((typep item 'ast-node) (generate-code item))
+ ((typep item 'c-type) (emit-c-type item #'%cg-print))
+ ((stringp item) (really-print item))
+ ((or (integerp item) (floatp item)) (really-print (format nil "~a" item)))
+ ((symbolp item) (really-print (format nil "~a" item)))
+ (t (error "unsupported item: ~a" item)))))
+ (values))
+
+(defmacro %cg-block-around (&rest body)
+ `(progn
+ (%cg-print *cg-begin-block*)
+ (let ((*compound-depth* (1+ *compound-depth*)))
+ ,@body)
+ (%cg-print *cg-end-block*)))
+
+(defmacro %cg-stmt-around (&rest body)
+ `(let ((*stmt-depth* (1+ *stmt-depth*)))
+ (%cg-print *cg-freshline*)
+ ,@body))
+
+(defmacro %cg-expr-scope (prec &rest body)
+ (with-gensyms (need-parens prec-once)
+ `(let* ((,prec-once ,prec)
+ (*expr-depth* (1+ *expr-depth*))
+ (,need-parens (> ,prec-once *outer-precedence*))
+ (*outer-precedence* ,prec-once))
+ (when ,need-parens
+ (%cg-print "("))
+ (progn
+ ,@body)
+ (when ,need-parens
+ (%cg-print ")")))))
+
+(defun %emit-comma-sequence (args)
+ (loop
+ for emit-comma = nil then t
+ for operand in args
+ do (progn
+ (when emit-comma
+ (%cg-print ", "))
+ (%cg-print operand)))
+ (values))
+
+(defun %quote-c-string (str)
+ (with-output-to-string (quoted-value)
+ (princ #\")
+ (loop for ch across str
+ do (cond ((eql #\\ ch) (princ "\\\\"))
+ ((eql #\" ch) (princ "\\\""))
+ (t (princ ch))))
+ (princ #\")
+ quoted-value))
+
+(defun %parse-type (e)
+ (match e
+ ((list 'type-of expr) (expr-typeof (parse-c-expr expr)))
+ (_ (eval-c-type e))))
+
+(defun %select-field (struct-type field)
+ (let ((base-type (base-type-of struct-type)))
+ (when (typep base-type 'c-pointer-type)
+ (setf base-type (base-type-of (remove-ptr base-type))))
+ (unless (typep base-type 'c-structured-type)
+ (error "cannot select field ~a from non-structured type ~a" field base-type))
+ (get-struct-field-type base-type field)))
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (defparameter *expression-types* nil))
+
+(defun/compile-time %gen-printer (self-sym class-name clauses slot-names)
+ (unless (getf clauses :precedence)
+ (error "no precedence specified for ~a" class-name))
+ `(defmethod generate-code ((,self-sym ,class-name))
+ (let ((*outer-precedence* ,(getf clauses :precedence)))
+ ,(let ((emit-expr (getf clauses :emit)))
+ (cond
+ ((null emit-expr) (error "no :emit clause specified"))
+ ((eq 'function (car emit-expr)) ; if :emit specifies a function, use that
+ `(funcall ,emit-expr ,self-sym))
+ (t `(with-slots ,slot-names ,self-sym
+ (%cg-print ,@emit-expr))))))))
+
+(defun/compile-time %gen-expr-type (base-type self-sym class-name clauses slot-names)
+ (let ((expr (getf clauses :expr-type)))
+ `(defmethod expr-typeof ((,self-sym ,class-name))
+ (with-slots ,slot-names ,self-sym
+ ,(cond
+ ((eq :promote expr)
+ (ecase base-type
+ (c-unary-expr '(arit-promote-unary (expr-typeof operand)))
+ (c-binary-expr '(arit-promote-binary (expr-typeof lhs) (expr-typeof rhs)))))
+ ((and (listp expr) (eq 'function (car expr)))
+ `(funcall ,expr ,self-sym))
+ ((not (null expr)) expr)
+ (t (error "no suitable expr-type expression defined for ~a" class-name)))))))
+
+(defun/compile-time %record-expr-type (base-type class-name clauses)
+ (pushnew class-name *expression-types*)
+ (setf (get class-name 'c-amplify-parse-order) (eval (getf clauses :parse-order 0)))
+ (with-gensyms (lhs rhs operand)
+ (let ((parse-clause (getf clauses :parse))
+ (symbol-clause (getf clauses :symbol)))
+ (setf (get class-name 'c-amplify-parser)
+ (cond (parse-clause parse-clause)
+ ((and (eq 'c-unary-expr base-type) symbol-clause)
+ `((list ',symbol-clause ,operand) (make-instance ',class-name
+ :operand (parse-c-expr ,operand))))
+ ((and (eq 'c-binary-expr base-type) symbol-clause)
+ `((list ',symbol-clause ,lhs ,rhs) (make-instance ',class-name
+ :lhs (parse-c-expr ,lhs)
+ :rhs (parse-c-expr ,rhs))))
+ (t (error "unsupported kind ~a" base-type)))))))
+
+(defmacro %def-n-ary-expr (base-type class-name clauses)
+ (with-gensyms (self)
+ (let ((slot-names (if (eq base-type 'c-unary-expr) '(operand) '(lhs rhs))))
+ `(progn
+ (eval-when (:compile-toplevel :load-toplevel :execute)
+ (%record-expr-type ',base-type ',class-name ',clauses)
+ (export-symbol-to-c ',(getf clauses :symbol)))
+ (defclass ,class-name (,base-type) ())
+ ,(%gen-printer self class-name clauses slot-names)
+ ,(%gen-expr-type base-type self class-name clauses slot-names)))))
+
+(defmacro def-unary-expr (class-name &rest clauses)
+ `(%def-n-ary-expr c-unary-expr ,class-name ,clauses))
+
+(defmacro def-binary-expr (class-name &rest clauses)
+ `(%def-n-ary-expr c-binary-expr ,class-name ,clauses))
+
+(defmacro def-custom-expr (class-name &rest clauses)
+ (with-gensyms (self)
+ (let ((slot-names (loop for slot-spec in (getf clauses :slots) collecting (car slot-spec))))
+ `(progn
+ (eval-when (:compile-toplevel :load-toplevel :execute)
+ (%record-expr-type 'c-expr ',class-name ',clauses))
+ (defclass ,class-name (c-expr) ,(getf clauses :slots))
+ ,(%gen-printer self class-name clauses slot-names)
+ ,(%gen-expr-type 'c-expr self class-name clauses slot-names)))))
+
+(defun/compile-time %get-parse-order-vec ()
+ (sort (coerce *expression-types* 'vector)
+ #'(lambda (a b)
+ (<
+ (get a 'c-amplify-parse-order)
+ (get b 'c-amplify-parse-order)))))
+
+(defmacro emit-expr-parser (function-name)
+ (with-gensyms (expr)
+ `(defun ,function-name (,expr)
+ (match ,expr ,@(loop for type-name across (%get-parse-order-vec)
+ collecting (get type-name 'c-amplify-parser))))))
+
+(def-custom-expr c-string-literal-expr
+ :precedence 1
+ :slots ((value :type string :initarg :value :accessor literal-value))
+ :parse ((type string a) (make-instance 'c-string-literal-expr :value a))
+ :expr-type (eval-c-type '(ptr const char))
+ :emit #'(lambda (self) (%cg-print (%quote-c-string (slot-value self 'value)))))
+
+(def-custom-expr c-integer-literal-expr
+ :precedence 1
+ :slots ((value :type integer :initarg :value :accessor literal-value))
+ :parse ((type integer a) (make-instance 'c-integer-literal-expr :value a))
+ :expr-type (eval-c-type 'int)
+ :emit (value))
+
+(def-custom-expr c-float-literal-expr
+ :precedence 1
+ :slots ((value :type float :initarg :value :accessor literal-value))
+ :parse ((type float a) (make-instance 'c-float-literal-expr :value a))
+ :expr-type (eval-c-type 'float)
+ :emit (value))
+
+(def-custom-expr c-variable-expr
+ :precedence 1
+ :slots ((var-name :type symbol :initarg :var-name :accessor var-name))
+ :parse ((type symbol a) (make-instance 'c-variable-expr :var-name a))
+ :expr-type #'(lambda (self)
+ (%type-of-lexical-symbol (slot-value self 'var-name) (ast-env self)))
+ :emit (var-name))
+
+(def-custom-expr c-member-expr
+ :precedence 1
+ :slots ((struct-expr :type c-expr :initarg :struct-expr :accessor struct-expr)
+ (member-names :type list :initarg :member-names :accessor member-names))
+ :parse ((list* '-> struct-expr symbols)
+ (make-instance 'c-member-expr
+ :struct-expr (parse-c-expr struct-expr)
+ :member-names symbols))
+ :expr-type #'(lambda (self)
+ (with-slots (struct-expr member-names) self
+ (let* ((btype (base-type-of (expr-typeof struct-expr)))
+ (struct-type btype))
+ (loop for symbol in member-names
+ do (setf struct-type (%select-field struct-type symbol)))
+ struct-type)))
+
+ :emit #'(lambda (self)
+ (with-slots (struct-expr member-names) self
+ (%cg-expr-scope
+ 1
+ (%cg-print struct-expr)
+ (let* ((et (expr-typeof struct-expr))
+ (ct (base-type-of et)))
+ (loop for symbol in member-names
+ do (progn
+ (if (typep (base-type-of ct) 'c-pointer-type)
+ (%cg-print "->" symbol)
+ (%cg-print "." symbol))
+ (setf ct (%select-field ct symbol)))))))))
+
+(def-unary-expr c-post-increment-expr :precedence 1 :symbol ++post :emit (operand "++") :expr-type (expr-typeof operand))
+(def-unary-expr c-post-decrement-expr :precedence 1 :symbol --post :emit (operand "--") :expr-type (expr-typeof operand))
+
+(def-binary-expr c-subscript-expr
+ :precedence 1
+ :symbol aref
+ :emit (lhs "[" rhs "]")
+ :expr-type #'(lambda (self)
+ (with-slots (lhs) self
+ (let ((lt (expr-typeof lhs)))
+ (remove-ptr lt))))) ; fixme: support arrays
+
+(def-unary-expr c-pre-increment-expr :precedence 2 :symbol ++ :assoc right :emit ("++" operand) :expr-type (expr-typeof operand))
+(def-unary-expr c-pre-decrement-expr :precedence 2 :symbol -- :assoc right :emit ("--" operand) :expr-type (expr-typeof operand))
+(def-unary-expr c-plus-expr :precedence 2 :symbol + :assoc right :emit ("+" operand) :expr-type :promote)
+(def-unary-expr c-minus-expr :precedence 2 :symbol - :assoc right :emit ("-" operand) :expr-type :promote)
+(def-unary-expr c-not-expr :precedence 2 :symbol ! :assoc right :emit ("!" operand) :expr-type (eval-c-type 'int))
+(def-unary-expr c-complement-expr :precedence 2 :symbol ~ :assoc right :emit ("~" operand) :expr-type :promote)
+(def-unary-expr c-dereference-expr :precedence 2 :symbol * :assoc right :emit ("*" operand) :expr-type (remove-ptr (expr-typeof operand)))
+(def-unary-expr c-address-of-expr :precedence 2 :symbol & :assoc right :emit ("&" operand) :expr-type (add-ptr (expr-typeof operand)))
+
+(def-custom-expr c-sizeof-type-expr
+ :precedence 2
+ :slots ((source-type :accessor source-type :type c-type :initarg :source-type))
+ :parse ((list* 'sizeof-type type-spec)
+ (make-instance 'c-sizeof-type-expr
+ :source-type (eval-c-type type-spec)))
+ :expr-type (eval-c-type 'size-t)
+ :emit ("sizeof(" source-type ")"))
+
+(def-custom-expr c-cast-expr
+ :precedence 2
+ :slots ((target-type :accessor target-type :type c-type :initarg :target-type)
+ (operand :accessor operand :type c-expr :initarg :operand))
+ :parse ((list 'cast type expr)
+ (make-instance 'c-cast-expr
+ :target-type (eval-c-type type)
+ :operand (parse-c-expr expr)))
+ :expr-type target-type
+ :emit ("(" target-type ") " operand))
+
+(def-binary-expr c-multiply-expr :precedence 3 :symbol * :emit (lhs " * " rhs) :expr-type :promote)
+(def-binary-expr c-divide-expr :precedence 3 :symbol / :emit (lhs " / " rhs) :expr-type :promote)
+(def-binary-expr c-modulo-expr :precedence 3 :symbol % :emit (lhs " % " rhs) :expr-type :promote)
+
+(def-binary-expr c-add-expr :precedence 4 :symbol + :emit (lhs " + " rhs) :expr-type :promote)
+(def-binary-expr c-subtract-expr :precedence 4 :symbol - :emit (lhs " - " rhs) :expr-type :promote)
+
+(def-binary-expr c-shift-left-expr :precedence 5 :symbol << :emit (lhs " << " rhs) :expr-type :promote)
+(def-binary-expr c-shift-right-expr :precedence 5 :symbol >> :emit (lhs " >> " rhs) :expr-type :promote)
+
+(def-binary-expr c-less-expr :precedence 5 :symbol < :emit (lhs " < " rhs) :expr-type (eval-c-type 'int))
+(def-binary-expr c-less-equal-expr :precedence 5 :symbol <= :emit (lhs " <= " rhs) :expr-type (eval-c-type 'int))
+(def-binary-expr c-greater-expr :precedence 5 :symbol > :emit (lhs " > " rhs) :expr-type (eval-c-type 'int))
+(def-binary-expr c-greater-equal-expr :precedence 5 :symbol >= :emit (lhs " >= " rhs) :expr-type (eval-c-type 'int))
+
+(def-binary-expr c-equals-expr :precedence 7 :symbol == :emit (lhs " == " rhs) :expr-type (eval-c-type 'int))
+(def-binary-expr c-not-equals-expr :precedence 7 :symbol != :emit (lhs " != " rhs) :expr-type (eval-c-type 'int))
+
+(def-binary-expr c-bitwise-and-expr :precedence 8 :symbol bit-and :emit (lhs " & " rhs) :expr-type :promote)
+(def-binary-expr c-bitwise-xor-expr :precedence 9 :symbol bit-xor :emit (lhs " ^ " rhs) :expr-type :promote)
+(def-binary-expr c-bitwise-or-expr :precedence 10 :symbol bit-or :emit (lhs " | " rhs) :expr-type :promote)
+
+(def-binary-expr c-logical-and-expr :precedence 11 :symbol and :emit (lhs " && " rhs) :expr-type (eval-c-type 'int))
+(def-binary-expr c-logical-or-expr :precedence 12 :symbol or :emit (lhs " || " rhs) :expr-type (eval-c-type 'int))
+
+
+(def-binary-expr c-assign-expr :precedence 13 :symbol = :assoc right :emit (lhs " = " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-add-assign-expr :precedence 13 :symbol += :assoc right :emit (lhs " += " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-subtract-assign-expr :precedence 13 :symbol -= :assoc right :emit (lhs " -= " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-multiply-assign-expr :precedence 13 :symbol *= :assoc right :emit (lhs " *= " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-divide-assign-expr :precedence 13 :symbol /= :assoc right :emit (lhs " /= " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-modulus-assign-expr :precedence 13 :symbol %= :assoc right :emit (lhs " %= " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-bitwise-and-assign-expr :precedence 13 :symbol bit-and-= :assoc right :emit (lhs " &= " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-bitwise-xor-assign-expr :precedence 13 :symbol bit-xor-= :assoc right :emit (lhs " ^= " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-bitwise-or-assign-expr :precedence 13 :symbol bit-or-= :assoc right :emit (lhs " -= " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-shift-left-assign-expr :precedence 13 :symbol <<= :assoc right :emit (lhs " <<= " rhs) :expr-type (expr-typeof lhs))
+(def-binary-expr c-shift-right-assign-expr :precedence 13 :symbol >>= :assoc right :emit (lhs " >>= " rhs) :expr-type (expr-typeof lhs))
+
+(def-custom-expr c-comma-expr
+ :precedence 13
+ :slots ((operands :type c-expr-list :accessor operands :initarg :operands))
+ :parse ((list* 'comma operands)
+ (make-instance 'c-comma-expr
+ :operands (mapcar #'parse-c-expr operands)))
+ :expr-type (expr-typeof (last operands))
+ :emit #'(lambda (self)
+ (%cg-expr-scope
+ 13
+ (%emit-comma-sequence (slot-value self 'operands)))))
+
+(def-custom-expr c-ternary-expr
+ :precedence 13
+ :slots ((test-expr :type c-expr :accessor test-expr :initarg :test-expr)
+ (true-expr :type c-expr :accessor true-expr :initarg :true-expr)
+ (false-expr :type c-expr :accessor false-expr :initarg :false-expr))
+ :expr-type (expr-typeof true-expr)
+ :parse ((list '? test-expr true-expr false-expr)
+ (make-instance 'c-ternary-expr
+ :test-expr (parse-c-expr test-expr)
+ :true-expr (parse-c-expr true-expr)
+ :false-expr (parse-c-expr false-expr)))
+ :emit (test-expr "? " true-expr " : " false-expr))
+
+(def-custom-expr c-funcall-expr
+ :precedence 1
+ :slots ((fun-expr :type c-expr :accessor fun-expr :initarg :fun-expr :accessor fun-expr)
+ (args :type c-expr-list :accessor args :initarg :args :accessor fun-args))
+ :parse ((list* fun-expr args)
+ (make-instance 'c-funcall-expr
+ :fun-expr (parse-c-expr fun-expr)
+ :args (mapcar #'parse-c-expr args)))
+ :parse-order 100 ; keep this last to avoid clobbering builtins
+ :expr-type #'(lambda (self)
+ (with-slots (fun-expr) self
+ (let ((tt (expr-typeof fun-expr)))
+ (unless (typep tt 'c-function-type)
+ (error "can only call function type value: ~a" tt))
+ (return-type tt))))
+ :emit #'(lambda (self)
+ (%cg-expr-scope
+ 1
+ (with-slots (fun-expr args) self
+ (%cg-print fun-expr "(")
+ (let ((*outer-precedence* 13))
+ (%emit-comma-sequence args))
+ (princ ")")))))
+
+(emit-expr-parser parse-c-expr)
+
+(defclass c-stmt (ast-node) ())
+
+(defclass c-null-stmt (c-stmt) ())
+
+(defmethod ast-children ((self c-null-stmt))
+ nil)
+
+(defmethod generate-code ((self c-null-stmt))
+ (when (> *stmt-depth* 0)
+ (princ ";")))
+
+(defclass c-compound-stmt-base (c-stmt)
+ ((body :type c-stmt-list :initarg :body :accessor c-compound-body))
+ (:documentation "Superclass for statements that contain other statements."))
+
+(defun %emit-compound-body (compound-stmt)
+ (%cg-block-around
+ (%cg-print (c-compound-body compound-stmt))))
+
+(defclass c-compound-stmt (c-compound-stmt-base) ())
+
+(defmethod generate-code ((self c-compound-stmt))
+ (%emit-compound-body self))
+
+(defun inline-compound-bodies (stmt-list outer-env)
+ (let ((only-declarations-so-far t))
+ (labels ((compound-declarations (compound) ; => list of c-declarator instances for compound
+ (loop for stmt in (c-compound-body compound)
+ while (typep stmt 'c-declare-stmt)
+ appending (declarators stmt)))
+ (will-shadow-p (compound) ; => t if any declaration in the compound will shadow outer-env
+ (some #'(lambda (decl) (%env-lookup (name decl) outer-env))
+ (compound-declarations compound)))
+ (mergable-p (compound) ; => t if the sub-compound can be merged
+ (and (typep compound 'c-compound-stmt)
+ only-declarations-so-far
+ (not (will-shadow-p compound))))
+ ;; Try to merge the contents of stmt if it is
+ (simplify-stmt (stmt)
+ (simplify stmt)
+ (cond ((mergable-p stmt) (copy-list (c-compound-body stmt)))
+ ((typep stmt 'c-declare-stmt) (setf outer-env (ast-env stmt)) (list stmt))
+ (t (setf only-declarations-so-far nil)
+ (list stmt)))))
+ (if (some #'(lambda (x) (typep x 'c-compound-stmt)) stmt-list)
+ (loop for stmt in stmt-list appending (simplify-stmt stmt))
+ stmt-list))))
+
+(defmethod simplify ((self c-compound-stmt))
+ (with-slots (body) self
+ (setf body (inline-compound-bodies body (ast-env self))))
+ self)
+
+(defclass c-break-stmt (c-stmt) ())
+
+(defmethod generate-code ((self c-break-stmt))
+ (%cg-print "break;"))
+
+(defclass c-continue-stmt (c-stmt) ())
+
+(defmethod generate-code ((self c-continue-stmt))
+ (%cg-print "continue;"))
+
+(defclass c-do-while-stmt (c-stmt)
+ ((test-expr :initarg :test-expr :accessor test-expr :type c-expr)
+ (stmt :initarg :stmt :accessor stmt :type c-stmt)))
+
+(defmethod generate-code ((self c-do-while-stmt))
+ (with-slots (test-expr stmt) self
+ (%cg-print "do" stmt "while (" test-expr ");")))
+
+(defclass c-expr-stmt (c-stmt)
+ ((expr :type c-expr :initarg :expr :accessor expr)))
+
+(defmethod generate-code ((self c-expr-stmt))
+ (with-slots (expr) self
+ (%cg-stmt-around
+ (%cg-print expr ";"))))
+
+(defclass c-for-stmt (c-compound-stmt-base)
+ ((init-expr :type c-expr :initarg :init-expr :accessor init-expr)
+ (test-expr :type c-expr :initarg :test-expr :accessor test-expr)
+ (iter-expr :type c-expr :initarg :iter-expr :accessor iter-expr)))
+
+(defmethod generate-code ((self c-for-stmt))
+ (with-slots (init-expr test-expr iter-expr) self
+ (%cg-stmt-around
+ (%cg-print "for (" init-expr "; " test-expr "; " iter-expr ")")
+ (%emit-compound-body self))))
+
+(defclass c-goto-stmt (c-stmt)
+ ((label :type symbol :initarg :label :accessor label)))
+
+(defmethod generate-code ((self c-goto-stmt))
+ (with-slots (label) self
+ (%cg-stmt-around
+ (%cg-print "goto " label ";"))))
+
+(defmethod ast-children ((self c-goto-stmt))
+ nil)
+
+(defclass c-label-stmt (c-stmt)
+ ((label :type symbol :initarg :label :accessor label)))
+
+(defmethod generate-code ((self c-label-stmt))
+ (with-slots (label) self
+ (%cg-stmt-around
+ (%cg-print *cg-freshline* label ":"))))
+
+(defmethod ast-children ((self c-label-stmt))
+ nil)
+
+(defclass c-if-stmt (c-stmt)
+ ((test-expr :type c-expr :initarg :test-expr :accessor test-expr)
+ (true-stmt :type c-stmt :initarg :true-stmt :accessor true-stmt)
+ (false-stmt :type (or c-stmt null) :initform nil :initarg :false-stmt :accessor false-stmt)))
+
+(defmethod generate-code ((self c-if-stmt))
+ (with-slots (test-expr true-stmt false-stmt) self
+ (%cg-stmt-around
+ (%cg-print "if (" test-expr ")" true-stmt)
+ (when false-stmt
+ (%cg-print "else" false-stmt)))))
+
+(defclass c-return-stmt (c-stmt)
+ ((expr :type (or c-expr null) :initarg :expr :initform nil :accessor expr)))
+
+(defmethod generate-code ((self c-return-stmt))
+ (with-slots (expr) self
+ (%cg-stmt-around
+ (%cg-print "return")
+ (when expr
+ (%cg-print " " expr))
+ (%cg-print ";"))))
+
+(defclass c-declarator (ast-node)
+ ((name :type symbol :initarg :name :accessor name)
+ (decl-type :type c-type :initarg :decl-type :accessor decl-type)
+ (init-expr :type (or c-expr null) :initarg :init-expr :initform nil :accessor init-expr)))
+
+(defmethod generate-code ((self c-declarator))
+ (with-slots (name decl-type init-expr) self
+ ;; FIXME: need a (emit-declaration ...) to make function types
+ ;; work, because there the type surrounds the identifier
+ (%cg-stmt-around
+ (%cg-print decl-type " " name)
+ (when init-expr
+ (%cg-print " = " init-expr)))))
+
+(defclass c-declare-stmt (c-stmt)
+ ((declarators :type list :initarg :declarators :accessor declarators)))
+
+(defmethod generate-code ((self c-declare-stmt))
+ (with-slots (declarators) self
+ (dolist (d declarators)
+ (%cg-print d ";"))))
+
+(defclass c-defstruct-node (ast-node)
+ ((struct-type :type c-structured-type :initarg :struct-type :accessor struct-type)))
+
+(defmethod generate-code ((self c-defstruct-node))
+ (with-slots (struct-type) self
+ (with-slots (fields kind name) struct-type
+ (%cg-print *cg-toplevel-spacing* (format nil "~(~a~)" kind) " " name)
+ (%cg-block-around
+ (dolist (f fields)
+ (%cg-print *cg-freshline* (cdr f) " " (car f) ";")))
+ (%cg-print ";"))))
+
+(defclass c-defun-node (c-compound-stmt-base)
+ ((gv :type gval :initarg :gval)
+ (formals :type list :initarg :formals)))
+
+(defmethod generate-code ((self c-defun-node))
+ (with-slots (gv body formals) self
+ (assert (eq (gval-kind gv) :defun))
+ (let* ((symbol (gval-sym gv))
+ (ftype (gval-type gv))
+ (return-type (return-type ftype))
+ (argument-types (argument-types ftype))
+ (variadic-p (variadic-p ftype)))
+ (%cg-print *cg-toplevel-spacing*)
+ (%cg-print return-type)
+ (%cg-print *cg-defun-return-type-separator*)
+ (%cg-print symbol "(")
+ (loop
+ for formal in formals
+ for argtype in argument-types
+ for comma-required-p = nil then t
+ do (progn
+ (when comma-required-p
+ (%cg-print ", "))
+ (%cg-print argtype " " formal)))
+ (when variadic-p
+ (when (not (null formals))
+ (%cg-print ", "))
+ (%cg-print "..."))
+ (%cg-print ")")
+ (%cg-block-around
+ (%cg-print body)))))
+
+(defmethod simplify ((self c-defun-node))
+ (with-slots (body) self
+ (setf body (inline-compound-bodies body (ast-env self))))
+ self)
+
+(defmethod generate-code ((list list))
+ (%cg-print list)
+ (values))
+
+(defun flatten-field-list (clauses)
+ "Flatten CLAUSES into a list of id . type conses. Each clause can
+either be a single symbol or have the format (id type) or ((id1 ...)
+type)."
+ (loop for clause in clauses
+ nconcing
+ (multiple-value-bind (ids type-spec)
+ (match clause
+ ((list* (and (list* sym _) syms) type-spec) (values (copy-list syms) type-spec))
+ ((list* sym type-spec) (values (list sym) type-spec))
+ (sym (values (list sym) nil)))
+ (mapcar #'(lambda (x) (cons x type-spec)) ids))))
+
+(defun %parse-field-list (context clauses)
+ "Parse the list CLAUSES as a field/parameter specification, using
+CONTEXT as an error reporting string. Struct fields and defun
+parameters lists share the same format. Each item is a sublist of the
+format (id type) or ((id1 id2 ...) type). The function flattens the
+nested id structure, returning a list of pairs (id . resolved-type)
+for each id declared."
+ (loop for clause in clauses
+ nconcing
+ (multiple-value-bind (ids type-spec)
+ (match clause
+ ((list* sym type-spec)
+ (values (if (listp sym) (copy-list sym) (list sym)) type-spec))
+ (_ (error "illegal ~a clause: ~a" context clause)))
+ (let ((type-node (eval-c-type type-spec)))
+ (mapcar #'(lambda (x) (cons x type-node)) ids)))))
+
+(defun %parse-defstruct-fields (clauses)
+ (%parse-field-list "defstruct" clauses))
+
+(defparameter *c-keyword-symbols*
+ '(if for return aref and or xor
+ progn break continue goto label declare defstruct defunion defun
+ deftype cast sizeof sizeof-type struct union ptr const volatile
+ restrict ->))
+
+(dolist (sym *c-keyword-symbols*) (export-symbol-to-c sym))
+
+(defun %phase2-defun (id prototype-clauses body)
+ (multiple-value-bind (return-type formals variadic-p)
+ (analyze-defun-prototype prototype-clauses)
+ (declare (ignore variadic-p return-type))
+ (let ((my-gv (lookup-gval id)))
+ (unless my-gv
+ (error "~a is not bound" id))
+ (let ((*current-return-type* (return-type (gval-type my-gv))))
+ (setf (gval-ast my-gv)
+ (make-instance 'c-defun-node
+ :gval my-gv
+ :formals (loop for cons in formals collecting (car cons))
+ :body (with-lexical-scope
+ (loop for cons in formals
+ do (%push-lexical-binding (car cons) (cdr cons)))
+ (mapcar #'parse-c-stmt body))))))))
+
+(defun current-defun-void-p ()
+ (unless *current-return-type*
+ (error "current-defun-void-p can only be used in a defun context"))
+ (eq *void-type-instance* *current-return-type*))
+
+(defun %parse-structured-c-stmt (decl)
+ (let ((candidate (%parse-structured-c-stmt-opt decl)))
+ (if candidate
+ candidate
+ (make-instance 'c-null-stmt))))
+
+(defun %parse-structured-c-stmt-opt (decl)
+ "Parse a list DECL starting with a symbol into a proper AST object
+representing the statement"
+ ;; TODO: This function is going to be called very often so it could
+ ;; be optimized. The match macro generates a bunch of redundant
+ ;; consp tests and tries all the clauses in order. It would perhaps
+ ;; be more efficient to dispatch on the first symbol of the list
+ ;; using e.g. a hash table to find the alternatives.
+ (declare (type list decl))
+ (match decl
+ ((list* 'for init-expr test-expr iter-expr body)
+ (make-instance 'c-for-stmt
+ :init-expr (parse-c-expr init-expr)
+ :test-expr (parse-c-expr test-expr)
+ :iter-expr (parse-c-expr iter-expr)
+ :body (with-lexical-scope (mapcar #'parse-c-stmt body))))
+ ((list* 'progn body)
+ (make-instance 'c-compound-stmt :body (with-lexical-scope (mapcar #'parse-c-stmt body))))
+ ((list 'break) (make-instance 'c-break-stmt))
+ ((list 'continue) (make-instance 'c-continue-stmt))
+ ((list 'do stmt 'while expr)
+ (make-instance 'c-do-while-stmt :test-expr (parse-c-expr expr) :stmt (parse-c-stmt stmt)))
+ ((list 'goto label) (make-instance 'c-goto-stmt :label label))
+ ((list 'label label) (make-instance 'c-label-stmt :label label))
+ ((list 'if expr stmt) (make-instance 'c-if-stmt
+ :test-expr (parse-c-expr expr)
+ :true-stmt (parse-c-stmt stmt)))
+ ((list 'if expr t-stmt f-stmt) (make-instance 'c-if-stmt
+ :test-expr (parse-c-expr expr)
+ :true-stmt (parse-c-stmt t-stmt)
+ :false-stmt (parse-c-stmt f-stmt)))
+ ((list 'return) (make-instance 'c-return-stmt))
+ ((list 'return expr) (make-instance 'c-return-stmt :expr (parse-c-expr expr)))
+ ((list* 'declare forms)
+ (make-instance 'c-declare-stmt :declarators
+ (loop for form in forms collect
+ (match form
+ ((list var-name type-name)
+ (let ((type-obj (eval-c-type type-name)))
+ (%push-lexical-binding var-name type-obj)
+ (make-instance 'c-declarator :name var-name :decl-type type-obj)))
+ ((list var-name '= init-expr)
+ (let* ((expr-obj (parse-c-expr init-expr))
+ (expr-type (expr-typeof expr-obj)))
+ (%push-lexical-binding var-name expr-type)
+ (make-instance 'c-declarator
+ :name var-name
+ :init-expr (parse-c-expr init-expr)
+ :decl-type expr-type)))
+ (_ (error "illegal declarator: ~a" form))))))
+ ((list* 'defun id prototype body)
+ (%phase2-defun id prototype body))
+ ((list* (and (or 'defstruct 'defunion) k/w) id _)
+ (make-instance 'c-defstruct-node
+ :struct-type (%lookup-tagged-type (case k/w
+ (defstruct 'struct)
+ (defunion 'union)) id)))
+ ((list 'ast-stmt-if expr data) (if (eval expr)
+ (%parse-structured-c-stmt (c-macroexpand data))
+ nil))
+ ((list 'ast-stmt expr) (%parse-structured-c-stmt (c-macroexpand (eval expr))))
+ ((list* 'deftype _) nil)
+ (_ (make-instance 'c-expr-stmt :expr (parse-c-expr decl)))))
+
+(defun analyze-defun-prototype (proto)
+ (let ((proto-pairs (flatten-field-list proto))
+ return-type
+ formals
+ variadic-p)
+ (dolist (pair proto-pairs)
+ (cond ((eq '|...| (car pair))
+ (setf variadic-p t))
+ ((eq 'return (car pair))
+ (setf return-type (eval-c-type (cdr pair))))
+ (t
+ (push (cons (car pair) (eval-c-type (cdr pair))) formals))))
+ (values (or return-type *void-type-instance*)
+ (nreverse formals)
+ variadic-p)))
+
+(defun %phase1-defun (id prototype)
+ (multiple-value-bind (return-type formals variadic-p)
+ (analyze-defun-prototype prototype)
+ (let* ((arg-types (loop for x in formals collect (cdr x)))
+ (fn-type (get-function-type arg-types return-type variadic-p))
+ (gval (make-instance 'gval
+ :symbol id
+ :kind :defun
+ :type fn-type)))
+ (set-global-gv gval))))
+
+(defun %phase1-tagged-type (k/w id clauses)
+ (let ((kind (ecase k/w (defstruct :struct) (defunion :union))))
+ (add-tagged-type kind id (%parse-defstruct-fields clauses))))
+
+(defun %phase1-deftype (id type-decl)
+ (let ((gv (make-instance 'gval
+ :kind :type
+ :type (eval-c-type type-decl)
+ :symbol id)))
+ (set-global-gv gv)))
+
+(defun parse-c-stmt-phase1 (decl)
+ "Populate the global namespace with type information about functions and types from DECL."
+ (match decl
+ ;; FIXME: Variadic support
+ ((list* 'defun id (and (list* _) proto) _) (%phase1-defun id proto))
+ ((list* (and (or 'defstruct 'defunion) k/w) id clauses) (%phase1-tagged-type k/w id clauses))
+ ((list* 'deftype id type-decl) (%phase1-deftype id type-decl)))
+ (values))
+
+(defparameter *dump-ast-level* 0)
+
+(defgeneric ast-children (ast)
+ (:documentation "Return a list of child nodes for the specified AST."))
+
+(defmethod ast-children ((ast c-unary-expr))
+ (with-slots (operand) ast
+ (list operand)))
+
+(defmethod ast-children ((ast c-funcall-expr))
+ (cons (fun-expr ast) (fun-args ast)))
+
+(defmethod ast-children ((ast c-binary-expr))
+ (with-slots (lhs rhs) ast
+ (list lhs rhs)))
+
+(defmethod ast-children ((ast c-compound-stmt-base))
+ (with-slots (body) ast
+ body))
+
+(defmethod ast-children ((ast c-defstruct-node)) nil)
+
+(defmethod ast-children ((ast c-if-stmt))
+ (with-slots (test-expr true-stmt false-stmt) ast
+ (if false-stmt
+ (list test-expr true-stmt false-stmt)
+ (list test-expr true-stmt))))
+
+(defmethod ast-children ((ast c-expr))
+ nil)
+
+(defmethod ast-children ((ast c-declare-stmt))
+ (loop for decl in (declarators ast)
+ when (init-expr decl)
+ collect it))
+
+(defmethod ast-children ((ast c-return-stmt))
+ (list (expr ast)))
+
+(defmethod ast-children ((ast c-expr-stmt))
+ (list (expr ast)))
+
+(defun dump-ast (ast)
+ (labels ((indent (level)
+ (dotimes (x level) (princ " ")))
+ (walk (node level)
+ (indent level)
+ (format t "~a~%" (class-name (class-of node)))
+ (let ((children (ast-children node)))
+ (if (null children)
+ (values)
+ (progn
+ (loop for binding on (ast-env (car children))
+ until (equal binding (ast-env node))
+ do (progn
+ (indent level)
+ (format t " Lexical: ~a ~a~%" (caar binding) (cdar binding))))
+ (loop for child in (ast-children node)
+ do (walk child (1+ level))))))))
+ (walk ast 0))
+ (values))
+
+(defun parse-c-stmt (decl)
+ "Parse the statment DECL into a proper c-stmt AST node. Alias
+symbols will be resolved."
+ (if (not (listp decl))
+ (make-instance 'c-expr-stmt :expr (parse-c-expr decl))
+ (%parse-structured-c-stmt decl)))
97 code/globals.lisp
@@ -0,0 +1,97 @@
+(in-package :se.defmacro.c-amplify)
+
+(defparameter *c-namespace* (make-hash-table)
+ "The global namespace of functions and types. Maps symbols to gval instances.")
+
+(defparameter *current-source-file* nil
+ "Bound to the current source file; automatically stuck onto gvals to track their home files.")
+
+(defparameter *csym-package* (find-package :se.defmacro.c-amplify.csym))
+
+(defmacro with-gensyms ((&rest names) &body body)
+ `(let ,(loop for n in names collect `(,n (gensym ,(symbol-name n))))
+ ,@body))
+
+(defclass source-file ()
+ ((path :reader source-file-path :initarg :path)
+ (gvals :reader defined-gvals :initform (make-array 8 :adjustable t :fill-pointer t)))
+ (:documentation "Represents a source file."))
+
+(defclass gval ()
+ ((sym :type symbol :reader gval-sym :initarg :symbol)
+ (kind :type symbol :reader gval-kind :initarg :kind)
+ (type-obj :accessor gval-type :initarg :type)
+ (ast :accessor gval-ast :initarg :ast)
+ (source :type (or source-file null) :accessor gval-source :initarg :source)))
+
+(defun set-global-gv (gv)
+ (declare (type gval gv))
+ (setf (gval-source gv) *current-source-file*)
+ (setf (gethash (gval-sym gv) *c-namespace*) gv))
+
+(defun lookup-gval (sym)
+ (declare (type symbol sym))
+ (gethash sym *c-namespace*))
+
+(defvar *c-aliases* (make-hash-table)
+ "Maps symbols from the CSYM package back to their (usually
+ uppercased) versions in C-AMPLIFY.")
+
+(defun/compile-time make-c-sym (&rest datums)
+ (intern
+ (with-output-to-string (stream)
+ (dolist (a datums) (princ a stream)))
+ *csym-package*))
+
+(defparameter *eof* (gensym "eof"))
+
+(defun/compile-time read-c-sym (stream subchar arg)
+ (declare (ignore subchar arg))
+ (let ((name (make-array 32 :element-type 'character :adjustable t :fill-pointer 0)))
+ (loop for ch = (peek-char nil stream nil *eof* nil)
+ until (or (eq ch *eof*)
+ (eql #\) ch)
+ (eql #\space ch)
+ (eql #\tab ch)
+ (eql #\newline ch))
+ do (progn
+ (read-char stream nil nil nil)
+ (vector-push-extend ch name)))
+ (when (= (fill-pointer name) 0)
+ (error "null C-symbols are not allowed"))
+ (make-c-sym name)))
+
+;; Install #$ as a reader macro for reading case-sensitive symbols in
+;; the C-SYM package. This is very useful in macros.
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (set-dispatch-macro-character #\# #\$ #'read-c-sym))
+
+(defun symbol-name-downcase (symbol)
+ (string-downcase (symbol-name symbol)))
+
+(defun export-symbol-to-c (symbol)
+ "Make SYMBOL available in in C code by means of shadowing-import
+into the CSYM package. If the symbol isn't lowercase, also install a
+lower-case alias that maps back to the original symbol via the
+*c-aliases* hash table."
+ ;; (format t "Exporting ~a~%" symbol)
+ (shadowing-import symbol *csym-package*)
+ (let* ((symbol-name (symbol-name symbol))
+ (symbol-lower (string-downcase symbol-name)))
+ (unless (string= symbol-name symbol-lower)
+ (export-symbol-alias symbol-lower symbol))))
+
+(defun export-symbol-alias (sym-string aliased-symbol)
+ "Create a symbol in the CSYM package with the name SYM-STRING,
+mapping back to the symbol ALIASED-SYMBOL."
+ ;; (format t "Aliasing ~a = ~a~%" sym-string aliased-symbol)
+ (setf (gethash (make-c-sym sym-string) *c-aliases*)
+ aliased-symbol))
+
+(defun resolve-symbol-aliases (decl)
+ "Replace any aliased symbols in DECL with their Lisp variants. In
+effect this converts keywords from lowercase form to Lisp uppercase
+form."
+ (cond ((symbolp decl) (or (gethash decl *c-aliases*) decl))
+ ((listp decl) (mapcar #'resolve-symbol-aliases decl))
+ (t decl)))
154 code/macroexpand.lisp
@@ -0,0 +1,154 @@
+(in-package :se.defmacro.c-amplify)
+
+(defvar *macro-result-symbol* (gensym "macro-result"))
+
+(defparameter *c-macros* (make-hash-table :test 'equalp)
+ "Maps strings case insensitively to global C macros")
+
+(defparameter *quoting-c-forms* '(ast-expr ast-expr-if ast-stmt ast-stmt-if)
+ "Keywords for forms that are not macroexpanded but passed straight to the ast evaluator.")
+
+(defvar *c-gensym-counter* 1)
+
+(defun c-gensym (&optional label)
+ (let ((hint-text (if label
+ (substitute #\_ #\- (format nil "~(~a~)" label))
+ "gensym_")))
+ (intern (format nil "~a_~d_" hint-text (incf *c-gensym-counter*)))))
+
+(defmacro with-c-gensyms (symbols &body body)
+ `(let ,(loop for s in symbols collect `(,s (c-gensym ',s)))
+ ,@body))
+
+(defun %c-eval-macrolet-form (form)
+ (destructuring-bind (name lambda-list &body body) form
+ (with-gensyms (args env)
+ (let* ((expander-code `#'(lambda (,args ,env)
+ (destructuring-bind ,lambda-list ,args
+ (values ,@body ,env))))
+ (expander-proc (eval expander-code)))
+ (values name expander-proc)))))
+
+(defun %c-install-expander (symbol proc)
+ (setf (gethash (symbol-name symbol) *c-macros*) proc))
+
+(defmacro def-c-macro (macro-name lambda-list &body body)
+ (with-gensyms (g-form g-env g-lambda g-datum)
+ `(%c-install-expander ',macro-name
+ #'(lambda (,g-form ,g-env)
+ (let ((,g-lambda
+ #'(lambda (,g-datum)
+ (destructuring-bind ,lambda-list ,g-datum
+ ,@body))))
+ (values (funcall ,g-lambda ,g-form) ,g-env))))))
+
+(defun %c-expand-macrolet (l env)
+ (destructuring-bind (macrolet-form &body body-forms) l
+ (let ((new-env env))
+ (multiple-value-bind (symbol expander-proc) (%c-eval-macrolet-form macrolet-form)
+ (push (cons (string-downcase (symbol-name symbol)) expander-proc) new-env))
+ (values `(,*macro-result-symbol* ,@body-forms) new-env))))
+
+(%c-install-expander 'macrolet #'%c-expand-macrolet)
+
+(defun %c-env-lookup (env symbol)
+ (let ((key (symbol-name symbol)))
+ (or (cdr (assoc key env :test #'string-equal))
+ (gethash key *c-macros*))))
+
+(defun %c-expand-list (l env)
+ (let ((head (car l)))
+ (when (consp head)
+ (return-from %c-expand-list (mapcar #'(lambda (x) (%c-macroexpand x env)) l)))
+ (when (member head *quoting-c-forms*)
+ (return-from %c-expand-list l))
+ (let* ((tail (cdr l)))
+ (when (symbolp head)
+ (let ((expander (%c-env-lookup env head)))
+ (when expander
+ (multiple-value-bind (inner-form inner-env) (funcall expander tail env)
+ (return-from %c-expand-list (%c-macroexpand inner-form inner-env))))))
+ (cons head (mapcar #'(lambda (x) (%c-macroexpand x env)) tail)))))
+
+(defun %c-macroexpand (l env)
+ (cond
+ ((listp l) (%c-expand-list l env))
+ ((symbolp l) (resolve-symbol-aliases l))
+ ; TODO: add test for symbol macros (symbol-macrolet.. and friends)
+ (t l)))
+
+(defun %drop-expansion-artefacts (form)
+ "Recursively splice nested (<macro-result> ...) forms into their outer lists."
+ (labels ((simple-result (x)
+ (let ((cell (cons x nil)))
+ (values cell cell)))
+ (freshen (x)
+ (let ((cells (loop for item in x collect item)))
+ (values cells (last cells))))
+ (map-value (x)
+ (cond
+ ((atom x) (simple-result x))
+ ((eq (car x) *macro-result-symbol*) (freshen (%drop-expansion-artefacts (cdr x))))
+ (t (simple-result (freshen (%drop-expansion-artefacts x)))))))
+ (if (listp form)
+ (let ((result nil)
+ (next-cell nil))
+ (dolist (x form)
+ (multiple-value-bind (head tail) (map-value x)
+ (when (null result)
+ (setf result head))
+ (when next-cell
+ (setf (cdr next-cell) head))
+ (setf next-cell tail)))
+ result)
+ form)))
+
+(defun c-macroexpand (datum)
+ "Macro-expand DATUM (which can be any lisp object) using the global macro environment"
+ (%drop-expansion-artefacts
+ (%c-macroexpand datum nil)))
+
+(def-c-macro unwind-protect (form &body cleanup-forms)
+ (with-c-gensyms (cleanup result)
+ `(progn
+ (ast-stmt-if (not (current-defun-void-p))
+ (declare (,result *current-return-type*)))
+ (macrolet (return (&optional expr)
+ `(progn
+ (ast-stmt
+ (if (not (current-defun-void-p))
+ `(= ,',',result ,,expr)
+ `(cast void ,,expr)))
+ (goto ,',cleanup)))
+ ,form)
+ (label ,cleanup)
+ ,@cleanup-forms
+ (return ,result))))
+
+(def-c-macro with-open-file ((var file-name mode) &body body)
+ `(progn
+ (declare (,var = (cast (ptr #$FILE) 0)))
+ (unwind-protect
+ (progn
+ (= ,var (#$fopen ,file-name ,mode))
+ ,@body)
+ (when ,var
+ (#$fclose ,var)))))
+
+(def-c-macro when (expr &body body)
+ `(if ,expr
+ (progn
+ ,@body)))
+
+(def-c-macro with-lock-held (lock-expr &body body)
+ `(unwind-protect
+ (progn
+ (#$lock-mutex ,lock-expr)
+ ,@body)
+ (#$unlock-mutex ,lock-expr)))
+
+(def-c-macro let ((&rest bindings) &body body)
+ `(progn
+ (declare ,@(loop for (var expr) in bindings collect `(,var = ,expr)))
+ ,@body))
+
114 code/main.lisp
@@ -0,0 +1,114 @@
+(in-package :se.defmacro.c-amplify)
+
+(defvar *c-systems* (make-hash-table))
+
+(defparameter *output-extension* "c"
+ "File extension of files produced.")
+
+(defparameter *input-extension* "ca"
+ "File extension of files read.")
+
+(defun %eval-ca-phase1 (expanded-forms)
+ (dolist (form expanded-forms)
+ (parse-c-stmt-phase1 form)))
+
+(defun %eval-ca-phase2 (expanded-forms)
+ (mapcar #'(lambda (form)
+ (let ((result (parse-c-stmt form)))
+ (simplify result)
+ result))
+ expanded-forms))
+
+(defun eval-ca-forms (forms)
+ (let ((expansions (loop for form in forms collecting (resolve-symbol-aliases (c-macroexpand form)))))
+ (%eval-ca-phase1 expansions)
+ (%eval-ca-phase2 expansions)))
+
+(defun read-csys-file (fn)
+ "Read a bunch of forms from FN to be parsed as a defsystem group."
+ (with-open-file (sysdef-stream fn)
+ (let ((sys-forms (loop
+ for datum = (read sysdef-stream nil nil)
+ unless datum do (loop-finish)
+ collecting datum)))
+ sys-forms)))
+
+(defstruct c-system
+ (id nil :type symbol)
+ (output-file nil :type pathname)
+ (files nil :type list)
+ (deps nil :type list))
+
+(defun systems-connected-p (source-sys dest-sys)
+ "Return t if DEST-SYS can be reached from SOURCE-SYS. Useful to
+detect cyclic dependencies."
+ (let ((dep-list (c-system-deps source-sys)))
+ (cond ((null dep-list) nil)
+ ((member dest-sys dep-list) t)
+ (t (some #'(lambda (d) (systems-connected-p d dest-sys)) dep-list)))))
+
+(defun eval-defsystem (system-fn id clauses)
+ "Evaluate a defsystem form for the system ID, read from SYSTEM-FN
+with the specified CLAUSES. If the function succeeds, ID will be
+associated with the resulting c-system object in *c-systems* for later
+retreival. Returns the resulting c-system object."
+ (let* ((default-output-file (make-pathname :defaults system-fn
+ :name (string-downcase (symbol-name id))
+ :type *output-extension*))
+ (system (make-c-system :id id :output-file default-output-file)))
+ (labels ((resolve-system-file (name)
+ (make-pathname :name name :type *input-extension* :defaults system-fn))
+ (resolve-system-files (names)
+ (mapcar #'(lambda (name) (resolve-system-file name)) names))
+ (resolve-system-deps (dep-systems)
+ (loop for sym in dep-systems
+ collect (multiple-value-bind (target exists) (gethash sym *c-systems*)
+ (unless exists
+ (error "~a: ~a depends on undefined system ~a" system-fn id sym))
+ (when (systems-connected-p target system)
+ (error "~a: cyclic dependency: ~a <-> ~a" system-fn id (c-system-id target)))
+ target))))
+ (dolist (clause clauses)
+ (unless (listp clause)
+ (error "defsystem clauses must be lists: ~a" clause))
+ (ecase (car clause)
+ (:files (setf (c-system-files system) (resolve-system-files (cdr clause))))
+ (:depends (setf (c-system-deps system) (resolve-system-deps (cdr clause))))))
+ (setf (gethash id *c-systems*) system)
+ system)))
+
+(defun update-system (system)
+ "Given the c-system SYSTEM; load, macro-expand and evaluate all its
+source files and then generate a single output file."
+ (let* ((filenames (c-system-files system))
+ (input (loop for fn in filenames appending (read-ca-file fn)))
+ (expansion (resolve-symbol-aliases (c-macroexpand input))))
+ (%eval-ca-phase1 expansion)
+ (let ((ast-nodes (%eval-ca-phase2 expansion)))
+ (with-open-file (*standard-output* (c-system-output-file system) :direction :output :if-exists :supersede)
+ (generate-code ast-nodes)))))
+
+(defun find-system (id)
+ (multiple-value-bind (system exists-p) (gethash id *c-systems*)
+ (unless exists-p
+ (error "~a: no such system" id))
+ system))
+
+(defun load-csys-file (fn)
+ "Load the c system definition file FN, parsing and binding the
+systems defined therein in *C-SYSTEMS* for future use. Returns a list
+of systems which are to be updated by default."
+ (let* ((systems-to-update nil)
+ (sys-forms (read-csys-file fn)))
+ (dolist (sys-def sys-forms)
+ (match sys-def
+ ((list* 'defsystem id clauses) (eval-defsystem fn id clauses))
+ ((list 'update id) (push (find-system id) systems-to-update))
+ (_ (error "expected defsystem clause: ~a" sys-def))))
+ systems-to-update))
+
+(defun parse-ca-file (fn)
+ (eval-ca-forms (read-ca-file fn)))
+
+(init-typesys)
+
14 code/package.lisp
@@ -0,0 +1,14 @@
+
+(in-package #:common-lisp-user)
+
+(defpackage #:se.defmacro.c-amplify
+ (:use :common-lisp)
+ (:import-from :cl-match match))
+
+(defpackage #:se.defmacro.c-amplify.csym
+ (:use)
+ (:documentation
+ "The package where C symbols are interned as ca files are
+ read. Macros and special operators will also be inserted into this
+ package."))
+
427 code/typesys.lisp
@@ -0,0 +1,427 @@
+(in-package :se.defmacro.c-amplify)
+
+(defconstant +const-bit+ 1)
+(defconstant +volatile-bit+ 2)
+(defconstant +restrict-bit+ 4)
+
+(defparameter *current-struct-type* nil
+ "Set to the type of the current defstruct in 2nd-phase defstruct, defunion parsing")
+
+(defparameter *current-return-type* nil
+ "Set to the type of the current function in 2nd-phase defun parsing")
+
+(defparameter *c-struct-namespace* (make-hash-table) "Namespace for structures and unions")
+
+(defparameter *c-int-rank* 3)
+
+(defparameter *c-basic-types* `((char 1 :unspecified "char")
+ (s-char 1 :signed "signed char")
+ (u-char 1 :unsigned "unsigned char")
+ (short 2 :signed "short")
+ (u-short 2 :signed "short")
+ (int ,*c-int-rank* :signed "int")
+ (u-int 4 :unsigned "unsigned int")
+ (long 5 :signed "long")
+ (u-long 6 :unsigned "unsigned long")
+ (float 10 :signed "float")
+ (double 11 :signed "double")
+ (long-double 11 :signed "long double")))
+
+;;; C type classes
+
+(defparameter *type-index* 0)
+
+(defun %next-type-index ()
+ (incf *type-index*))
+
+(defclass c-type ()
+ ((derivations
+ :initform nil
+ :documentation "Optional hash table mapping variation keys (integer bit fields) to derived and pointer types.")
+ (pointer-type
+ :initform nil
+ :documentation "The type of a pointer to this type, created on demand.")
+ (%type-index
+ :type integer
+ :initform (%next-type-index)))
+ (:documentation "Abstract base class for type expressions."))
+
+(defclass c-void-type (c-type)
+ ())
+
+(defclass c-basic-type (c-type)
+ ((name
+ :type symbol
+ :initarg :name
+ :reader name
+ :documentation "The symbol representing this basic type, e.g. char")
+ (rank
+ :type fixnum
+ :initarg :rank
+ :reader rank
+ :documentation "The rank of this type in artihmetic conversions.")
+ (sign-type
+ :type symbol
+ :initarg :sign-type
+ :reader sign-type
+ :documentation "One of :signed, :unsigned or :unspecified")
+ (appearance
+ :type string
+ :initarg :appearance
+ :reader appearance
+ :documentation "The printed appearance of the type.")))
+
+(defclass c-derived-type (c-type)
+ ((qualifier-mask
+ :type integer
+ :initarg :qualifier-mask)
+ (base-type
+ :type c-type
+ :initarg :base-type
+ :documentation "The basic or structured type this derivation stems from")))
+
+(defclass c-pointer-type (c-type)
+ ((pointed-to-type
+ :type c-type
+ :initarg :pointed-to-type
+ :documentation "The pointer's underlying type"
+ :reader pointed-to-type)))
+
+(defclass c-function-type (c-type)
+ ((return-type
+ :type c-type
+ :reader return-type
+ :initarg :return-type)
+ (argument-types
+ :type list
+ :initarg :argument-types
+ :reader argument-types
+ :documentation "List of argument types")
+ (is-variadic
+ :type boolean
+ :reader variadic-p
+ :initarg :is-variadic
+ :documentation "True if the function type accepts vararg-style arguments."))
+ (:documentation "Describes the type of a function."))
+
+(defclass c-structured-type (c-type)
+ ((fields
+ :type list
+ :initarg :fields
+ :accessor struct-fields
+ :documentation "A list of fields of the type; each field is represented by a cons (name . type)")
+ (kind
+ :type symbol
+ :initarg :kind
+ :accessor struct-kind
+ :documentation "The kind of structured type, either STRUCT or UNION")
+ (name
+ :type symbol
+ :initarg :name))
+ (:documentation "Describes a structured type (union or struct)"))
+
+(defun get-struct-field-type (struct-type symbol)
+ (declare (type c-structured-type struct-type) (type symbol symbol))
+ (let ((field (assoc symbol (struct-fields struct-type))))
+ (unless field
+ (error "->: ~a has no field ~a" struct-type symbol))
+ (cdr field)))
+
+;;; Printing objects in the REPL
+
+(defmethod print-object ((self c-type) stream)
+ (format stream "#<~a \"" (class-name (class-of self)))
+ (emit-c-type self #'(lambda (arg) (princ arg stream)))
+ (format stream "\">"))
+
+(defun lisp-id->string (symbol)
+ (map 'string
+ (lambda (ch) (if (eql ch #\-) #\_ ch))
+ (string-downcase (symbol-name symbol))))
+
+;;; Formatted type emission
+
+(defgeneric emit-c-type (object write-fn)
+ (:documentation "Emit a c-type subtype OBJECT using the specified WRITE-FN function to output string data"))
+
+(defmethod emit-c-type ((self c-void-type) write-fn)
+ (funcall write-fn "void"))
+
+(defmethod emit-c-type ((self c-basic-type) write-fn)
+ (with-slots (appearance) self
+ (funcall write-fn appearance)))
+
+(defmethod emit-c-type ((self c-derived-type) write-fn)
+ (with-slots (qualifier-mask base-type) self
+ (emit-c-type base-type write-fn)
+ (when (/= 0 (logand +const-bit+ qualifier-mask))
+ (funcall write-fn " const"))
+ (when (/= 0 (logand +volatile-bit+ qualifier-mask))
+ (funcall write-fn " volatile"))
+ (when (/= 0 (logand +restrict-bit+ qualifier-mask))
+ (funcall write-fn " restrict"))))
+
+(defmethod emit-c-type ((self c-pointer-type) write-fn)
+ (with-slots (pointed-to-type) self
+ (emit-c-type pointed-to-type write-fn)
+ (funcall write-fn " *")))
+
+(defmethod emit-c-type ((self c-function-type) write-fn)
+ (with-slots (return-type argument-types is-variadic) self
+ (emit-c-type return-type write-fn)
+ (funcall write-fn " (*)(")
+ (let ((first-arg t))
+ (dolist (arg-type argument-types)
+ (if first-arg
+ (setf first-arg nil)
+ (funcall write-fn ", "))
+ (emit-c-type arg-type write-fn))
+ (when is-variadic
+ (unless first-arg
+ (funcall write-fn ", "))
+ (funcall write-fn "..."))
+ (funcall write-fn ")"))))
+
+(defmethod emit-c-type ((self c-structured-type) write-fn)
+ (with-slots (kind name) self
+ (funcall write-fn (lisp-id->string kind))
+ (funcall write-fn " ")
+ (funcall write-fn (lisp-id->string name))))
+
+(defgeneric base-type-of (type))
+
+(defmethod base-type-of ((self c-derived-type))
+ (with-slots (base-type) self
+ base-type))
+
+(defmethod base-type-of ((self c-basic-type)) self)
+(defmethod base-type-of ((self c-pointer-type)) self)
+(defmethod base-type-of ((self c-void-type)) self)
+(defmethod base-type-of ((self c-function-type)) self)
+(defmethod base-type-of ((self c-structured-type)) self)
+
+(defparameter *void-type-instance* (make-instance 'c-void-type))
+
+(defun add-ptr (type-obj)
+ "Given a c-type instance TYPE-OBJ, return the type representing a pointer to that type."
+ (declare (type c-type type-obj))
+ (with-slots (pointer-type) type-obj
+ (unless pointer-type
+ (setf pointer-type (make-instance 'c-pointer-type :pointed-to-type type-obj)))
+ pointer-type))
+
+(defun remove-ptr (ptr-type)
+ "Given a c-pointer-type instance PTR-TYPE, return the type
+dereferencing that pointer would yield."
+ (declare (type c-type ptr-type))
+ (let ((base-ptr-type (base-type-of ptr-type)))
+ (unless (typep base-ptr-type 'c-pointer-type)
+ (error "~a cannot be dereferenced as a pointer type" ptr-type))
+ (pointed-to-type base-ptr-type)))
+
+(defun add-cv (type-obj qualifier-mask)
+ "Given a c-type instance TYPE, create a new (or find an existing)
+variation of it using the specified QUALIFIERS."
+ (declare (type c-type type-obj)
+ (type integer qualifier-mask))
+ (if (= 0 qualifier-mask)
+ type-obj ; no qualifiers added -- same type
+ (let ((base-type (base-type-of type-obj)))
+ (declare (type c-type base-type))
+ (with-slots (derivations) base-type
+ (unless derivations
+ (setf derivations (make-hash-table)))
+ (multiple-value-bind (derived-type exists) (gethash qualifier-mask derivations)
+ (if exists
+ derived-type
+ (setf (gethash qualifier-mask derivations)
+ (make-instance 'c-derived-type
+ :base-type base-type
+ :qualifier-mask qualifier-mask))))))))
+
+(defun lookup-type (sym)
+ (macrolet ((test-special-var (sym special-var)
+ `(when (eq ,sym ',special-var)
+ (unless ,special-var
+ (error "~a is not currently bound" ',special-var))
+ (return-from lookup-type ,special-var))))
+ (test-special-var sym *current-return-type*)
+ (test-special-var sym *current-struct-type*))
+ (let ((gv (lookup-gval sym)))
+ (unless gv
+ (error "~a: undefined symbol" sym))
+ (unless (eq (gval-kind gv) :type)
+ (error "~a: not a type" gv))
+ (gval-type gv)))
+
+(defun %scan-qualifiers (decl)
+ "Parse leading const, volatile, restrict keywords from DECL, evaluating to two values. The first is a qualifier mask for the parsed keywords, and the second is the rest of DECL following the keywords."
+ (let* ((qualifiers 0)
+ (rest 0))
+ (loop for cons on decl for kw in decl
+ do (progn
+ (setf rest cons)
+ (cond
+ ((eq 'const kw) (setf qualifiers (logor qualifiers +const-bit+)))
+ ((eq 'volatile kw) (setf qualifiers (logor qualifiers +volatile-bit+)))
+ ((eq 'restrict kw) (setf qualifiers (logor qualifiers +restrict-bit+)))
+ (t (loop-finish)))))
+ (values qualifiers rest)))
+
+(defun %ftype-key (arg-types return-type is-variadic)
+ (append arg-types (list return-type is-variadic)))
+
+(defun %hash-cfun-key (key)
+ (let ((result 0))
+ (declare (type fixnum result))
+ (loop for item in key
+ do (let ((iter (+ result (* 33
+ (if (typep item 'c-type)
+ (sxhash (slot-value item '%type-index))
+ (sxhash item))))))
+ (setf result (coerce (mod iter most-positive-fixnum) 'fixnum))))
+ result))
+
+(defparameter *c-function-types*
+ (make-hash-table :test 'equal
+ :hash-function
+ #+sbcl #'%hash-cfun-key
+ #+clozure '%hash-cfun-key )
+ "Maintains a mapping of signature lists to function types to enforce the c-type eq guarantee")
+
+(defun get-function-type (arg-types return-type is-variadic)
+ (let* ((key (%ftype-key arg-types return-type is-variadic))
+ (existing (gethash key *c-function-types*)))
+ ;; (format t "key: ~a (hash ~a)~%" key (%hash-cfun-key key))
+ (if existing
+ existing
+ (setf (gethash key *c-function-types*)
+ (make-instance 'c-function-type
+ :argument-types arg-types
+ :return-type return-type
+ :is-variadic is-variadic)))))
+
+; (fn int (ptr const char) [...] => int)
+
+(defun %parse-fn-type (decl)
+ "Parse a list of the form ([<args=type-decl> ...] ['...] [=>
+<return=type-decl>]), looking up (or creating a new) instance of
+c-function-type."
+ (let ((args nil)
+ (return-type nil)
+ (is-variadic nil))
+ (loop for cons on decl for item in decl
+ do (cond
+ ((eq '=> item) (progn
+ (let ((tail (cdr cons)))
+ (unless tail
+ (error "=> designator not followed by a type in ~a" decl))
+ (setf return-type (eval-c-type tail))
+ (loop-finish))))
+ ((eq '|...| item) (setf is-variadic t))
+ (t (push (eval-c-type item) args))))
+ (get-function-type (nreverse args) (or return-type *void-type-instance*) is-variadic)))
+
+(defun %add-pointer (type-obj)
+ (with-slots (pointer-type) type-obj
+ (if pointer-type
+ pointer-type
+ (setf pointer-type
+ (make-instance 'c-pointer-type
+ :pointed-to-type type-obj)))))
+
+(defun %lookup-tagged-type (kind name)
+ (let ((kind (ecase kind
+ (struct :struct)
+ (union :union))))
+ (let ((type (gethash name *c-struct-namespace*)))
+ (unless type
+ (error "no such tagged type: ~a" name))
+ (unless (eq (slot-value type 'kind) kind)
+ (error "tagged type kind mismatch: ~a; expected ~a but found ~a" name (slot-value type 'kind) kind))
+ type)))
+
+(defun %eval-c-type-list (decl)
+ (multiple-value-bind (qualifiers type-data) (%scan-qualifiers decl)
+ (let* ((head (car type-data))
+ (result (cond
+ ((listp head) (%eval-c-type-list head))
+ ((not (symbolp head)) (error "illegal type declaration: ~a (~a)" decl head))
+ ((eq head 'ptr) (%add-pointer (eval-c-type (cdr type-data))))
+ ((member head '(struct union)) (%lookup-tagged-type (car type-data) (cadr type-data)))
+ ((eq head 'fn) (%parse-fn-type (cdr type-data)))
+ (t (lookup-type head)))))
+ (unless result
+ (error "couldn't resolve type declaration: ~a" decl))
+ (add-cv result qualifiers))))
+
+(defun eval-c-type (decl)
+ "Parse a type declaration DECL which may be either 1) a single
+symbol indicating a typedef or builtin type 2) a list of possibly
+nested lists combining the keywords const, volatile, restrict, ptr,
+struct and union or 3) a c-type instance."
+ (cond
+ ((c-type-p decl) decl)
+ ((symbolp decl) (lookup-type decl))
+ ((listp decl) (%eval-c-type-list decl))
+ (t (error "illegal type declaration: ~a" decl))))
+
+(defun add-tagged-type (kind name fields)
+ (assert (or (eq kind :struct) (eq kind :union)))
+ (let ((obj (make-instance 'c-structured-type :name name :kind kind :fields fields)))
+ (setf (gethash name *c-struct-namespace*) obj)))
+
+(defun arit-promote-unary (ct)
+ "Given a basic type CT, compute its promoted integer type."
+ (declare (type c-type ct))
+ (let ((real-type (base-type-of ct)))
+ (unless (typep real-type 'c-basic-type)
+ (error "~a is not a type suitable for arithmetic promotion" ct))
+ (let ((rank (rank real-type)))
+ (if (< rank *c-int-rank*)
+ (eval-c-type 'int)
+ real-type))))
+
+(defun arit-promote-binary (ltype-in rtype-in)
+ "Given two basic types LTYPE and TYPE, compute the promoted
+arithmetic type of a binary expression involving them."
+ (declare (type c-type ltype-in rtype-in))
+ (let ((ltype (base-type-of ltype-in))
+ (rtype (base-type-of rtype-in)))
+ (flet ((verify-type (type-obj)
+ (unless (typep ltype 'c-basic-type)
+ (error "~a is not a type suitable for arithmetic promotion" type-obj))))
+ (verify-type ltype)
+ (verify-type rtype))
+ (let ((lrank (rank ltype))
+ (rrank (rank rtype)))
+ (cond
+ ;; If both types rank lower than int, the result is of type int.
+ ((and (< lrank *c-int-rank*)
+ (< rrank *c-int-rank*))
+ (eval-c-type 'int))
+ ;; Otherwise, just select the highest rank.
+ ((> lrank rrank) ltype)
+ (t rtype)))))