diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 0000000..32b38d4 --- /dev/null +++ b/COPYING.md @@ -0,0 +1,636 @@ +# 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like +this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w` and `show c` should show the appropriate +parts of the General Public License. Of course, your program's commands might +be different; for a GUI interface, you would use an *about box*. + +You should also get your employer (if you work as a programmer) or school, if +any, to sign a *copyright disclaimer* for the program, if necessary. For more +information on this, and how to apply and follow the GNU GPL, see +[http://www.gnu.org/licenses/](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](http://www.gnu.org/philosophy/why-not-lgpl.html). diff --git a/README.md b/README.md new file mode 100644 index 0000000..572233f --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +## XT Toolchain +This is a GNU-based mingw-w64 toolchain. It currently supports C and C++, and provides a variety of +tools including IDL, message and resource compilers. The XT Toolchain is also the official build +environment for compiling XT software, including the FerretOS. Currently, it is targeted at Linux +host only, however it should be possible to build it in MSYS2 as well. + +This software includes: + * Binutils + * CMake + * GCC + * Make + * Mingw-w64 + * Ninja + * Wine + +## Licensing +The XTchain project includes the scripts for building and assembling a toolchain as well as +environmental shell. These are licensed under the GPLv3 license. It covers only mentioned +components that are provided by XTchain directly. For more information on that, refer to the +COPYING.md file. The final pre-built toolchain is covered by the licenses of the individual, +external projects. The full list of software incorporated into this toolchain is available in the +README.md file. diff --git a/build-linux.sh b/build-linux.sh index 8d0c94f..ad714d7 100755 --- a/build-linux.sh +++ b/build-linux.sh @@ -1,5 +1,10 @@ #!/bin/bash -set -e +# PROJECT: XTchain +# LICENSE: See the COPYING.md in the top level directory +# FILE: build-linux.sh +# DESCRIPTION: Toolchain building and assembly script +# DEVELOPERS: Rafal Kupiec + # Working Directories BINDIR="$(pwd)/binaries" @@ -7,6 +12,10 @@ PCHDIR="$(pwd)/patches" SRCDIR="$(pwd)/sources" WRKDIR="$(pwd)" +# Architecture Settings +ARCHS="i686 x86_64" +GENERIC="generic-w64-mingw32" + # Compiler Flags CFLAGS="-march=x86-64 -mtune=generic -O2 -s -pipe" CXXFLAGS="${CFLAGS}" @@ -26,9 +35,16 @@ GCCDIR="${SRCDIR}/gcc" GCCTAG="releases/gcc-9.3.0" GCCVCS="git://gcc.gnu.org/git/gcc.git" +# Make Settings +MAKEDIR="${SRCDIR}/make" +MAKETAG="4.3" +MAKEVCS="git://git.savannah.gnu.org/make" + # Mingw-w64 Settings MINGWDIR="${SRCDIR}/mingw-w64" +MINGWLIB="msvcrt" MINGWTAG="v6.0.0" +MINGWNTV="0x502" MINGWVCS="https://github.com/mirror/mingw-w64.git" # Ninja Settings @@ -36,11 +52,13 @@ NINJADIR="${SRCDIR}/ninja" NINJATAG="v1.10.0" NINJAVCS="https://github.com/ninja-build/ninja.git" -# Architecture Settings -ARCHS="i686 x86_64" -GENERIC="generic-w64-mingw32" +# Wine Settings +WINEDIR="${SRCDIR}/wine" +WINETAG="wine-5.15" +WINEVCS="git://source.winehq.org/git/wine.git" +# This function applies a patches to the 3rd party project apply_patches() { local PACKAGE="${1}" @@ -65,6 +83,7 @@ apply_patches() fi } +# This function compiles and installs BINUTILS binutils_build() { for ARCH in ${ARCHS}; do @@ -89,6 +108,7 @@ binutils_build() cd ${WRKDIR} } +# This function downloads BINUTILS from VCS binutils_fetch() { if [ ! -d ${BINUTILSDIR} ]; then @@ -101,6 +121,7 @@ binutils_fetch() fi } +# This function compiles and installs CMAKE cmake_build() { echo ">>> Building CMAKE ..." @@ -116,6 +137,7 @@ cmake_build() cd ${WRKDIR} } +# This function downloads CMAKE from VCS cmake_fetch() { if [ ! -d ${CMAKEDIR} ]; then @@ -128,6 +150,7 @@ cmake_fetch() fi } +# This function compiles and install GCC (phase 1) gcc_build_phase1() { for ARCH in ${ARCHS}; do @@ -159,6 +182,7 @@ gcc_build_phase1() cd ${WRKDIR} } +# This function compiles and install GCC (phase 2) gcc_build_phase2() { for ARCH in ${ARCHS}; do @@ -170,6 +194,7 @@ gcc_build_phase2() cd ${WRKDIR} } +# This function downloads GCC from VCS gcc_fetch() { if [ ! -d ${GCCDIR} ]; then @@ -183,6 +208,44 @@ gcc_fetch() fi } +# This function compiles and install MAKE +make_build() +{ + echo ">>> Building Make ..." + [ -z ${CLEAN} ] || rm -rf ${MAKEDIR}/build + cd ${MAKEDIR} + ./bootstrap + sed -i "s/-Werror//" maintMakefile + mkdir -p ${MAKEDIR}/build + cd ${MAKEDIR}/build + ../configure \ + --prefix=${BINDIR} \ + --disable-dependency-tracking \ + --disable-silent-rules \ + --program-prefix=g \ + --without-guile + make -j${CORES} + make install + if [ ! -e ${BINDIR}/bin/make ]; then + ln -sf gmake ${BINDIR}/bin/make + fi + cd ${WRKDIR} +} + +# This function downloads MAKE from VCS +make_fetch() +{ + if [ ! -d ${MAKEDIR} ]; then + echo ">>> Downloading Make ..." + git clone ${MAKEVCS} ${MAKEDIR} + cd ${MAKEDIR} + git checkout tags/${MAKETAG} + apply_patches ${MAKEDIR##*/} ${MAKETAG} + cd ${WRKDIR} + fi +} + +# This function compiles and installs MINGW CRT mingw_build_crt() { for ARCH in ${ARCHS}; do @@ -204,7 +267,7 @@ mingw_build_crt() --host=${ARCH}-w64-mingw32 \ --prefix=${BINDIR}/${ARCH}-w64-mingw32 \ --with-sysroot=${BINDIR} \ - --with-default-msvcrt=msvcrt \ + --with-default-msvcrt=${MINGWLIB} \ ${FLAGS} make -j${CORES} make install @@ -213,6 +276,7 @@ mingw_build_crt() cd ${WRKDIR} } +# This function compiles and installs MINGW headers mingw_build_headers() { echo ">>> Building Mingw-w64 (headers) ..." @@ -222,8 +286,8 @@ mingw_build_headers() ../configure \ --prefix=${BINDIR}/${GENERIC} \ --enable-idl \ - --with-default-msvcrt=msvcrt \ - --with-default-win32-winnt=0x502 + --with-default-msvcrt=${MINGWLIB} \ + --with-default-win32-winnt=${MINGWNTV} make -j${CORES} make install mkdir -p ${BINDIR}/mingw @@ -239,6 +303,7 @@ mingw_build_headers() cd ${WRKDIR} } +# This function compiles and install MINGW libraries mingw_build_libs() { for LIB in libmangle winstorecompat; do @@ -261,6 +326,7 @@ mingw_build_libs() cd ${WRKDIR} } +# This function compiles and installs MINGW tools mingw_build_tools() { for TOOL in gendef genidl genlib genpeimg widl; do @@ -282,6 +348,7 @@ mingw_build_tools() cd ${WRKDIR} } +# This function downloads MINGW from VCS mingw_fetch() { if [ ! -d ${MINGWDIR} ]; then @@ -294,6 +361,7 @@ mingw_fetch() fi } +# This function compiles and installs NINJA ninja_build() { echo ">>> Building NINJA ..." @@ -305,6 +373,7 @@ ninja_build() cd ${WRKDIR} } +# This function downloads NINJA from VCS ninja_fetch() { if [ ! -d ${NINJADIR} ]; then @@ -317,6 +386,63 @@ ninja_fetch() fi } +# This function compiles and install WINE tools +wine_build() +{ + echo ">>> Building Wine ..." + mkdir -p ${WINEDIR}/build + cd ${WINEDIR}/build + ../configure \ + -enable-win64 + for TOOL in winedump wmc wrc; do + make -j${CORES} tools/${TOOL} + cp tools/${TOOL}/${TOOL} ${BINDIR}/bin/ + for ARCH in ${ARCHS}; do + if [ ! -e ${BINDIR}/bin/${ARCH}-w64-mingw32-${TOOL} ]; then + ln -sf ${TOOL} ${BINDIR}/bin/${ARCH}-w64-mingw32-${TOOL} + fi + done + done + cd ${WRKDIR} +} + +# This function downloads WINE from VCS +wine_fetch() +{ + if [ ! -d ${WINEDIR} ]; then + echo ">>> Downloading WINE ..." + git clone ${WINEVCS} ${WINEDIR} + cd ${WINEDIR} + git checkout tags/${WINETAG} + apply_patches ${WINEDIR##*/} ${WINETAG##*-} + cd ${WRKDIR} + fi +} + +# This function installs XTCHAIN scripts, wrappers and symlinks +xtchain_build() +{ + echo ">>> Building XTchain ..." + mkdir -p ${BINDIR}/bin + mkdir -p ${BINDIR}/lib/xtchain + mkdir -p ${BINDIR}/${GENERIC}/bin + for ARCH in ${ARCHS}; do + for EXEC in xtcspecc; do + if [ ! -e ${BINDIR}/bin/${EXEC} ]; then + gcc ${WRKDIR}/tools/${EXEC}.c -o ${BINDIR}/bin/${EXEC} + fi + ln -sf ${EXEC} ${BINDIR}/bin/${ARCH}-w64-mingw32-${EXEC} + done + done + cp ${WRKDIR}/scripts/xtclib ${BINDIR}/lib/xtchain/ + cp ${WRKDIR}/scripts/xtchain ${BINDIR}/ + cd ${WRKDIR} +} + + +# Exit immediately on any failure +set -e + # Check if script launched as root if [ "$(whoami)" = "root" ]; then echo "This script cannot be run as root!" @@ -336,6 +462,9 @@ mkdir -p ${SRCDIR} export CFLAGS export CXXFLAGS +# XTchain +xtchain_build + # Download Mingw-W64 mingw_fetch @@ -366,6 +495,18 @@ mingw_build_libs # Build and install Mingw-W64 tools mingw_build_tools +# Download Wine +wine_fetch + +# Build and install Wine tools +wine_build + +# Download Make +make_fetch + +# Build and install Make +make_build + # Download CMake cmake_fetch @@ -382,16 +523,12 @@ ninja_build echo ">>> Removing unneeded files to save disk space ..." rm -rf ${BINDIR}/{doc,include,mingw,share/{bash-completion,emacs,gcc*,info,man,vim}} -# Copy all scripts -echo ">>> Copying scripts ..." -cp -apf ${WRKDIR}/scripts/* ${BINDIR}/ - -# Save FBE version +# Save XT Toolchain version cd ${WRKDIR} -: ${FBEVER:=$(git describe --exact-match --tags 2>/dev/null)} -: ${FBEVER:=DEV} -echo "${FBEVER}" > ${BINDIR}/Version +: ${XTCVER:=$(git describe --exact-match --tags 2>/dev/null)} +: ${XTCVER:=DEV} +echo "${XTCVER}" > ${BINDIR}/Version # Prepare archive echo ">>> Creating toolchain archive ..." -tar -I 'zstd -19' -cpf fbe-${FBEVER}-linux.tar.zst -C ${BINDIR} . +tar -I 'zstd -19' -cpf xtchain-${XTCVER}-linux.tar.zst -C ${BINDIR} . diff --git a/patches/binutils/2_35/001-add-coffpe-xt-support.patch b/patches/binutils/2_35/001-add-coffpe-xt-support.patch index 69a8bb3..fc4250b 100644 --- a/patches/binutils/2_35/001-add-coffpe-xt-support.patch +++ b/patches/binutils/2_35/001-add-coffpe-xt-support.patch @@ -23,7 +23,7 @@ index 5149ef582b..f09e4b7382 100644 + subsystem_name = "XT PSX application"; + break; + case IMAGE_SUBSYSTEM_XT_DYNLIB: -+ subsystem_name = "XT dynamic library" ++ subsystem_name = "XT dynamic library"; + break; /* Added default case for clarity - subsystem_name is NULL anyway. */ default: diff --git a/readme.md b/readme.md deleted file mode 100644 index 069e322..0000000 --- a/readme.md +++ /dev/null @@ -1,11 +0,0 @@ -## FerretOS Build Environment (FBE) -The FerretOS Build Environment (FBE) is the official build environment for compiling FerretOS. -Currently, it is targeted at Linux only, however a Windows and FerretOS versions will be available -in the future as well. - -This software includes: - * Binutils - * GCC - * Mingw-w64 - * CMake - * Ninja diff --git a/scripts/fbe.sh b/scripts/xtchain similarity index 56% rename from scripts/fbe.sh rename to scripts/xtchain index 9b8d988..63f6015 100755 --- a/scripts/fbe.sh +++ b/scripts/xtchain @@ -1,4 +1,10 @@ #!/usr/bin/env bash +# PROJECT: XTchain +# LICENSE: See the COPYING.md in the top level directory +# FILE: scripts/xtchain +# DESCRIPTION: XTchain Entry Script +# DEVELOPERS: Rafal Kupiec + # Check if script launched as root if [ "$(whoami)" = "root" ]; then @@ -6,18 +12,18 @@ if [ "$(whoami)" = "root" ]; then exit 1 fi -# Get the absolute path to the FBE -export FBEDIR="$(realpath $(dirname ${0}))" +# Get the absolute path to the XTchain +export XTCDIR="$(realpath $(dirname ${0}))" -# Read the FBE version -export FBEVER="$(cat ${FBEDIR}/Version)" +# Read the XTchain version +export XTCVER="$(cat ${XTCDIR}/Version)" # Load the library -source ${FBEDIR}/fbelib.sh +source ${XTCDIR}/lib/xtchain/xtclib # Set the target architecture : ${TARGET:=${1}} -: ${TARGET:=i386} +: ${TARGET:=amd64} # Save the source directory export SRCDIR="${2:-${PWD}}" @@ -29,7 +35,7 @@ export CXXFLAGS= export LDFLAGS= # Update PATH -export PATH="${FBEDIR}/bin:${PATH}" +export PATH="${XTCDIR}/bin:${PATH}" # Display banner version @@ -40,5 +46,5 @@ export PFMAT2="\[\033[0;34;104m\]" export PFMAT3="\[\033[0;1;97;104m\]" export PFMAT4="\[\033[0;94;49m\]" export PFMAT5="\[\033[1;38;5;74m\]" -export PROMPT="\n${PFMAT1} FerretOS BE ${PFMAT2}${PFMAT3} \w ${PFMAT4}${PFMAT5} " +export PROMPT="\n${PFMAT1} XT Toolchain ${PFMAT2}${PFMAT3} \w ${PFMAT4}${PFMAT5} " bash --rcfile <(echo 'source ~/.bashrc && export PS1="${PROMPT}" && cd ${SRCDIR}') diff --git a/scripts/fbelib.sh b/scripts/xtclib similarity index 59% rename from scripts/fbelib.sh rename to scripts/xtclib index fc4fd66..bb27126 100755 --- a/scripts/fbelib.sh +++ b/scripts/xtclib @@ -1,4 +1,10 @@ #!/usr/bin/env bash +# PROJECT: XTchain +# LICENSE: See the COPYING.md in the top level directory +# FILE: scripts/xtclib +# DESCRIPTION: XTchain library +# DEVELOPERS: Rafal Kupiec + # Sets the target architecture charch() @@ -25,14 +31,17 @@ export -f charch version() { echo "###############################################################################" - echo "# FerretOS Build Environment v${FBEVER} for Linux #" + echo "# FerretOS Build Environment v${XTCVER} for Linux #" echo "# by Rafal Kupiec #" echo "###############################################################################" echo echo - echo "Binutils Version: $(${FBEDIR}/bin/i686-w64-mingw32-ld -v | cut -d' ' -f5)" - echo "GCC Version: $(${FBEDIR}/bin/i686-w64-mingw32-gcc -v 2>&1| grep 'gcc version' | cut -d' ' -f3)" - echo "IDL Compiler Version: $(${FBEDIR}/bin/i686-w64-mingw32-widl -V | grep 'version' | cut -d' ' -f5)" + echo "Binutils Version: $(${XTCDIR}/bin/i686-w64-mingw32-ld -v | cut -d' ' -f5)" + echo "GCC Version: $(${XTCDIR}/bin/i686-w64-mingw32-gcc -v 2>&1| grep 'gcc version' | cut -d' ' -f3)" + echo "IDL Compiler Version: $(${XTCDIR}/bin/i686-w64-mingw32-widl -V | grep 'version' | cut -d' ' -f5)" + echo "Wine Message Compiler Version: $(${XTCDIR}/bin/wmc -V | grep 'version' | cut -d' ' -f5)" + echo "Wine Resource Compiler Version: $(${XTCDIR}/bin/wrc --version | grep 'version' | cut -d' ' -f5)" + echo charch ${TARGET} echo echo diff --git a/tools/xtchain.h b/tools/xtchain.h new file mode 100644 index 0000000..be7e22f --- /dev/null +++ b/tools/xtchain.h @@ -0,0 +1,162 @@ +/** + * PROJECT: XTchain + * LICENSE: See COPYING.md in the top level directory + * FILE: tools/xtchain.h + * DESCRIPTION: Common header for XTchain tools + * DEVELOPERS: Martin Storsjo + * Rafal Kupiec + */ + +#ifdef UNICODE +#define _UNICODE +#endif + +#include +#include +#include +#include +#include +#include + +#define _T(x) x + +#ifdef _UNICODE +#define TS "%ls" +#else +#define TS "%s" +#endif + +static +inline +int +_tcsicmp(const char *a, + const char *b) +{ + while(*a && tolower(*a) == tolower(*b)) + { + a++; + b++; + } + + return *a - *b; +} + +static +inline +char * +concat(const char *prefix, + const char *suffix) +{ + int prefixlen = strlen(prefix); + int suffixlen = strlen(suffix); + + char *buf = malloc((prefixlen + suffixlen + 1) * sizeof(*buf)); + + strcpy(buf, prefix); + strcpy(buf + prefixlen, suffix); + + return buf; +} + +static +inline +char * +_tcsrchrs(const char *str, + char char1, + char char2) +{ + char *ptr1 = strrchr(str, char1); + char *ptr2 = strrchr(str, char2); + + if(!ptr1) + { + return ptr2; + } + + if(!ptr2) + { + return ptr1; + } + + if(ptr1 < ptr2) + { + return ptr2; + } + + return ptr1; +} + +static +inline +void +split_argv(const char *argv0, + char **dir_ptr, + char **basename_ptr, + char **target_ptr, + char **exe_ptr) +{ + const char *sep = _tcsrchrs(argv0, '/', '\\'); + char *dir = strdup(_T("")); + const char *basename = argv0; + + if(sep) + { + dir = strdup(argv0); + dir[sep + 1 - argv0] = '\0'; + basename = sep + 1; + } + + basename = strdup(basename); + char *period = strchr(basename, '.'); + + if(period) + { + *period = '\0'; + } + + char *target = strdup(basename); + char *dash = strrchr(target, '-'); + const char *exe = basename; + + if(dash) + { + *dash = '\0'; + exe = dash + 1; + } + else + { + target = NULL; + } + + if(dir_ptr) + { + *dir_ptr = dir; + } + + if(basename_ptr) + { + *basename_ptr = basename; + } + + if(target_ptr) + { + *target_ptr = target; + } + + if(exe_ptr) + { + *exe_ptr = exe; + } +} + +static +inline +int +run_final(const char *executable, + const char *const *argv) +{ + execvp(executable, (char **) argv); + perror(executable); + + return 1; +} diff --git a/tools/xtcspecc.c b/tools/xtcspecc.c new file mode 100644 index 0000000..d65f39f --- /dev/null +++ b/tools/xtcspecc.c @@ -0,0 +1,1573 @@ +/** + * PROJECT: XTchain + * LICENSE: See COPYING.md in the top level directory + * FILE: tools/xtcspecc.c + * DESCRIPTION: SPEC Compiler + * DEVELOPERS: Timo Kreuzer + * Mark Jansen + * Amine Khaldi + * Thomas Faber + * Cameron Gutman + * Jerome Gardou + * Rafal Kupiec + */ + +#include "xtchain.h" + +#define XTCSPECC_VERSION "1.2" + +#define ARRAYSIZE(a) (sizeof(a) / sizeof((a)[0])) + +typedef struct _STRING +{ + const char *buf; + int len; +} STRING, *PSTRING; + +typedef struct +{ + STRING strName; + STRING strTarget; + int nCallingConvention; + int nOrdinal; + int nStackBytes; + int nArgCount; + int anArgs[30]; + unsigned int uFlags; + int nNumber; + unsigned nStartVersion; + unsigned nEndVersion; + int bVersionIncluded; +} EXPORT; + +enum _ARCH +{ + ARCH_X86, + ARCH_AMD64, + ARCH_ARM, + ARCH_ARM64 +}; + +typedef int (*PFNOUTLINE)(FILE *, EXPORT *); +int gbMSComp = 0; +int gbImportLib = 0; +int gbNotPrivateNoWarn = 0; +int gbTracing = 0; +int giArch = ARCH_X86; +char *pszArchString; +char *pszArchString2; +char *pszExecName; +char *pszSourceFileName = NULL; +char *pszDllName = NULL; +char *gpszUnderscore = ""; +int gbDebug; +unsigned guOsVersion = 0x502; + +#define DbgPrint(...) (!gbDebug || fprintf(stderr, __VA_ARGS__)) + +enum +{ + FL_PRIVATE = 1, + FL_STUB = 2, + FL_NONAME = 4, + FL_ORDINAL = 8, + FL_NORELAY = 16, + FL_RET64 = 32, + FL_REGISTER = 64, +}; + +enum +{ + CC_STDCALL, + CC_CDECL, + CC_FASTCALL, + CC_THISCALL, + CC_EXTERN, + CC_STUB, +}; + +enum +{ + ARG_LONG, + ARG_PTR, + ARG_STR, + ARG_WSTR, + ARG_DBL, + ARG_INT64, + ARG_INT128, + ARG_FLOAT +}; + +const char* astrCallingConventions[] = +{ + "STDCALL", + "CDECL", + "FASTCALL", + "THISCALL", + "EXTERN" +}; + +/* + * List of OLE exports that should be PRIVATE and not be assigned an ordinal. + * In case these conditions are not met when linking with MS LINK.EXE, warnings + * LNK4104 and LNK4222 respectively are emitted. + */ +static const char* astrOlePrivateExports[] = +{ + "DllCanUnloadNow", + "DllGetClassObject", + "DllGetClassFactoryFromClassString", + "DllGetDocumentation", + "DllInitialize", + "DllInstall", + "DllRegisterServer", + "DllRegisterServerEx", + "DllRegisterServerExW", + "DllUnload", + "DllUnregisterServer", + "RasCustomDeleteEntryNotify", + "RasCustomDial", + "RasCustomDialDlg", + "RasCustomEntryDlg", +}; + +static +int +IsSeparator(char chr) +{ + return ((chr <= ',' && chr != '$' && chr != '#') || + (chr >= ':' && chr < '?') ); +} + +int +CompareToken(const char *token, + const char *comparand) +{ + while(*comparand) + { + if(*token != *comparand) return 0; + token++; + comparand++; + } + + if(IsSeparator(comparand[-1])) + { + return 1; + } + + if(!IsSeparator(*token)) + { + return 0; + } + + return 1; +} + +const char * +ScanToken(const char *token, + char chr) +{ + while(!IsSeparator(*token)) + { + if(*token == chr) + { + return token; + } + token++; + } + return 0; +} + +const char * +NextLine(const char *pc) +{ + while(*pc != 0) + { + if(pc[0] == '\n' && pc[1] == '\r') return pc + 2; + else if(pc[0] == '\n') return pc + 1; + pc++; + } + return pc; +} + +int +TokenLength(const char *pc) +{ + int length = 0; + + while(!IsSeparator(*pc++)) + { + length++; + } + + return length; +} + +const char * +NextToken(const char *pc) +{ + /* Skip token */ + while(!IsSeparator(*pc)) + { + pc++; + } + + /* Skip white spaces */ + while(*pc == ' ' || *pc == '\t') + { + pc++; + } + + /* Check for end of line */ + if(*pc == '\n' || *pc == '\r' || *pc == 0) + { + return 0; + } + + /* Check for comment */ + if(*pc == '#' || *pc == ';') + { + return 0; + } + + return pc; +} + +void +OutputHeader_stub(FILE *file) +{ + fprintf(file, "/* This file is generated automatically by %s, do not edit! */\n\n" + "#include \n", + pszExecName); + + if(gbTracing) + { + fprintf(file, "#include \n"); + fprintf(file, "#include \n"); + fprintf(file, "WINE_DECLARE_DEBUG_CHANNEL(relay);\n"); + } + + fprintf(file, "\n"); +} + +int +OutputLine_stub(FILE *file, + EXPORT *pexp) +{ + int i; + int bRelay = 0; + int bInPrototype = 0; + + if(pexp->nCallingConvention != CC_STUB && + (pexp->uFlags & FL_STUB) == 0) + { + /* Only relay trace stdcall C functions */ + if(!gbTracing || (pexp->nCallingConvention != CC_STDCALL) || + (pexp->uFlags & FL_NORELAY) || + (pexp->strName.buf[0] == '?')) + { + return 0; + } + bRelay = 1; + } + + /* Declare the "real" function */ + if(bRelay) + { + fprintf(file, "extern "); + bInPrototype = 1; + } + + do + { + if(pexp->uFlags & FL_REGISTER) + { + /* FIXME: Not sure this is right */ + fprintf(file, "void "); + } + else if(pexp->uFlags & FL_RET64) + { + fprintf(file, "__int64 "); + } + else + { + fprintf(file, "int "); + } + + if((giArch == ARCH_X86) && + pexp->nCallingConvention == CC_STDCALL) + { + fprintf(file, "__stdcall "); + } + + /* Check for C++ */ + if(pexp->strName.buf[0] == '?') + { + fprintf(file, "stub_function%d(", pexp->nNumber); + } + else + { + if(!bRelay || bInPrototype) + { + fprintf(file, "%.*s(", pexp->strName.len, pexp->strName.buf); + } + else + { + fprintf(file, "$relaytrace$%.*s(", pexp->strName.len, pexp->strName.buf); + } + } + + for(i = 0; i < pexp->nArgCount; i++) + { + if(i != 0) fprintf(file, ", "); + switch(pexp->anArgs[i]) + { + case ARG_LONG: fprintf(file, "long"); break; + case ARG_PTR: fprintf(file, "void*"); break; + case ARG_STR: fprintf(file, "char*"); break; + case ARG_WSTR: fprintf(file, "wchar_t*"); break; + case ARG_DBL: fprintf(file, "double"); break; + case ARG_INT64 : fprintf(file, "__int64"); break; + /* __int128 is not supported on x86, and int128 in spec files most often represents a GUID */ + case ARG_INT128 : fprintf(file, "GUID"); break; + case ARG_FLOAT: fprintf(file, "float"); break; + } + fprintf(file, " a%d", i); + } + + if(bInPrototype) + { + fprintf(file, ");\n\n"); + } + } while(bInPrototype--); + + if(!bRelay) + { + fprintf(file, ")\n{\n\tDbgPrint(\"WARNING: calling stub %.*s(", + pexp->strName.len, pexp->strName.buf); + } + else + { + fprintf(file, ")\n{\n"); + if(pexp->uFlags & FL_REGISTER) + { + /* No return value */ + } + else if(pexp->uFlags & FL_RET64) + { + fprintf(file, "\t__int64 retval;\n"); + } + else + { + fprintf(file, "\tint retval;\n"); + } + fprintf(file, "\tif(TRACE_ON(relay))\n\t\tDPRINTF(\"%s: %.*s(", + pszDllName, pexp->strName.len, pexp->strName.buf); + } + + for(i = 0; i < pexp->nArgCount; i++) + { + if(i != 0) fprintf(file, ","); + switch(pexp->anArgs[i]) + { + case ARG_LONG: fprintf(file, "0x%%lx"); break; + case ARG_PTR: fprintf(file, "0x%%p"); break; + case ARG_STR: fprintf(file, "'%%s'"); break; + case ARG_WSTR: fprintf(file, "'%%ws'"); break; + case ARG_DBL: fprintf(file, "%%f"); break; + case ARG_INT64: fprintf(file, "%%\"PRIx64\""); break; + case ARG_INT128: fprintf(file, "'%%s'"); break; + case ARG_FLOAT: fprintf(file, "%%f"); break; + } + } + fprintf(file, ")\\n\""); + + for(i = 0; i < pexp->nArgCount; i++) + { + fprintf(file, ", "); + switch(pexp->anArgs[i]) + { + case ARG_LONG: fprintf(file, "(long)a%d", i); break; + case ARG_PTR: fprintf(file, "(void*)a%d", i); break; + case ARG_STR: fprintf(file, "(char*)a%d", i); break; + case ARG_WSTR: fprintf(file, "(wchar_t*)a%d", i); break; + case ARG_DBL: fprintf(file, "(double)a%d", i); break; + case ARG_INT64: fprintf(file, "(__int64)a%d", i); break; + case ARG_INT128: fprintf(file, "wine_dbgstr_guid(&a%d)", i); break; + case ARG_FLOAT: fprintf(file, "(float)a%d", i); break; + } + } + fprintf(file, ");\n"); + + if(pexp->nCallingConvention == CC_STUB) + { + fprintf(file, "\t__wine_spec_unimplemented_stub(\"%s\", __FUNCTION__);\n", pszDllName); + } + else if(bRelay) + { + if(pexp->uFlags & FL_REGISTER) + { + fprintf(file,"\t"); + } + else + { + fprintf(file, "\tretval = "); + } + fprintf(file, "%.*s(", pexp->strName.len, pexp->strName.buf); + + for(i = 0; i < pexp->nArgCount; i++) + { + if(i != 0) fprintf(file, ", "); + fprintf(file, "a%d", i); + } + fprintf(file, ");\n"); + } + + if(!bRelay) + { + fprintf(file, "\treturn 0;\n}\n\n"); + } + else if((pexp->uFlags & FL_REGISTER) == 0) + { + if(pexp->uFlags & FL_RET64) + { + fprintf(file, "\tif(TRACE_ON(relay))\n\t\tDPRINTF(\"%s: %.*s: retval = %%\"PRIx64\"\\n\", retval);\n", + pszDllName, pexp->strName.len, pexp->strName.buf); + } + else + { + fprintf(file, "\tif(TRACE_ON(relay))\n\t\tDPRINTF(\"%s: %.*s: retval = 0x%%lx\\n\", retval);\n", + pszDllName, pexp->strName.len, pexp->strName.buf); + } + fprintf(file, "\treturn retval;\n}\n\n"); + } + + return 1; +} + +void +Output_stublabel(FILE *fileDest, + char* pszSymbolName) +{ + if((giArch == ARCH_ARM) || (giArch == ARCH_ARM64)) + { + fprintf(fileDest, + "\tEXPORT |%s| [FUNC]\n|%s|\n", + pszSymbolName, + pszSymbolName); + } + else + { + fprintf(fileDest, + "PUBLIC %s\n%s: nop\n", + pszSymbolName, + pszSymbolName); + } +} + +void +OutputHeader_def(FILE *file, + char *libname) +{ + fprintf(file, + "; This file is generated automatically by %s, do not edit!\n\n" + "NAME %s\n\n" + "EXPORTS\n", + pszExecName, + libname); +} + +void +PrintName(FILE *fileDest, + EXPORT *pexp, + PSTRING pstr, + int fDeco) +{ + const char *pcName = pstr->buf; + int nNameLength = pstr->len; + const char* pcDot, *pcAt; + char namebuffer[19]; + + if((nNameLength == 1) && (pcName[0] == '@')) + { + sprintf(namebuffer, "ordinal%d", pexp->nOrdinal); + pcName = namebuffer; + nNameLength = strlen(namebuffer); + } + + /* Check for non-x86 first */ + if(giArch != ARCH_X86) + { + /* Does the string already have stdcall decoration? */ + pcAt = ScanToken(pcName, '@'); + if(pcAt && (pcAt < (pcName + nNameLength)) && (pcName[0] == '_')) + { + /* Skip leading underscore and remove trailing decoration */ + pcName++; + nNameLength = (int)(pcAt - pcName); + } + + /* Print the undecorated function name */ + fprintf(fileDest, "%.*s", nNameLength, pcName); + } + else if(fDeco && + ((pexp->nCallingConvention == CC_STDCALL) || + (pexp->nCallingConvention == CC_FASTCALL))) + { + /* Scan for a dll forwarding dot */ + pcDot = ScanToken(pcName, '.'); + if(pcDot) + { + /* First print the dll name, followed by a dot */ + nNameLength = (int)(pcDot - pcName); + fprintf(fileDest, "%.*s.", nNameLength, pcName); + + /* Now the actual function name */ + pcName = pcDot + 1; + nNameLength = pexp->strTarget.len - nNameLength - 1; + } + + /* Does the string already have decoration? */ + pcAt = ScanToken(pcName, '@'); + if(pcAt && (pcAt < (pcName + nNameLength))) + { + /* On GCC, we need to remove the leading stdcall underscore */ + if(!gbMSComp && (pexp->nCallingConvention == CC_STDCALL)) + { + pcName++; + nNameLength--; + } + + /* Print the already decorated function name */ + fprintf(fileDest, "%.*s", nNameLength, pcName); + } + else + { + /* Print the prefix, but skip it for (GCC && stdcall) */ + if(gbMSComp || (pexp->nCallingConvention != CC_STDCALL)) + { + fprintf(fileDest, "%c", pexp->nCallingConvention == CC_FASTCALL ? '@' : '_'); + } + + /* Print the name with trailing decoration */ + fprintf(fileDest, "%.*s@%d", nNameLength, pcName, pexp->nStackBytes); + } + } + else + { + /* Print the undecorated function name */ + fprintf(fileDest, "%.*s", nNameLength, pcName); + } +} + +void +OutputLine_def_MS(FILE *fileDest, + EXPORT *pexp) +{ + PrintName(fileDest, pexp, &pexp->strName, 0); + + if(gbImportLib) + { + /* Redirect to a stub function, to get the right decoration in the lib */ + fprintf(fileDest, "=_stub_"); + PrintName(fileDest, pexp, &pexp->strName, 0); + } + else if(pexp->strTarget.buf) + { + if(pexp->strName.buf[0] == '?') + { + //fprintf(stderr, "warning: ignoring C++ redirection %.*s -> %.*s\n", + // pexp->strName.len, pexp->strName.buf, pexp->strTarget.len, pexp->strTarget.buf); + } + else + { + fprintf(fileDest, "="); + + /* If the original name was decorated, use decoration in the forwarder as well */ + if((giArch == ARCH_X86) && ScanToken(pexp->strName.buf, '@') && + !ScanToken(pexp->strTarget.buf, '@') && + ((pexp->nCallingConvention == CC_STDCALL) || + (pexp->nCallingConvention == CC_FASTCALL)) ) + { + PrintName(fileDest, pexp, &pexp->strTarget, 1); + } + else + { + /* Write the undecorated redirection name */ + fprintf(fileDest, "%.*s", pexp->strTarget.len, pexp->strTarget.buf); + } + } + } + else if(((pexp->uFlags & FL_STUB) || (pexp->nCallingConvention == CC_STUB)) && + (pexp->strName.buf[0] == '?')) + { + /* C++ stubs are forwarded to C stubs */ + fprintf(fileDest, "=stub_function%d", pexp->nNumber); + } + else if(gbTracing && ((pexp->uFlags & FL_NORELAY) == 0) && (pexp->nCallingConvention == CC_STDCALL) && + (pexp->strName.buf[0] != '?')) + { + /* Redirect it to the relay-tracing trampoline */ + fprintf(fileDest, "=$relaytrace$%.*s", pexp->strName.len, pexp->strName.buf); + } +} + +void +OutputLine_def_GCC(FILE *fileDest, + EXPORT *pexp) +{ + int bTracing = 0; + /* Print the function name, with decoration for export libs */ + PrintName(fileDest, pexp, &pexp->strName, gbImportLib); + DbgPrint("Generating def line for '%.*s'\n", pexp->strName.len, pexp->strName.buf); + + /* Check if this is a forwarded export */ + if(pexp->strTarget.buf) + { + int fIsExternal = !!ScanToken(pexp->strTarget.buf, '.'); + DbgPrint("Got redirect '%.*s'\n", pexp->strTarget.len, pexp->strTarget.buf); + + /* print the target name, don't decorate if it is external */ + fprintf(fileDest, "="); + PrintName(fileDest, pexp, &pexp->strTarget, !fIsExternal); + } + else if(((pexp->uFlags & FL_STUB) || (pexp->nCallingConvention == CC_STUB)) && + (pexp->strName.buf[0] == '?')) + { + /* C++ stubs are forwarded to C stubs */ + fprintf(fileDest, "=stub_function%d", pexp->nNumber); + } + else if(gbTracing && ((pexp->uFlags & FL_NORELAY) == 0) && + (pexp->nCallingConvention == CC_STDCALL) && + (pexp->strName.buf[0] != '?')) + { + /* Redirect it to the relay-tracing trampoline */ + char buf[256]; + STRING strTarget; + fprintf(fileDest, "="); + sprintf(buf, "$relaytrace$%.*s", pexp->strName.len, pexp->strName.buf); + strTarget.buf = buf; + strTarget.len = pexp->strName.len + 12; + PrintName(fileDest, pexp, &strTarget, 1); + bTracing = 1; + } + + /* Special handling for stdcall and fastcall */ + if((giArch == ARCH_X86) && + ((pexp->nCallingConvention == CC_STDCALL) || + (pexp->nCallingConvention == CC_FASTCALL))) + { + /* Is this the import lib? */ + if(gbImportLib) + { + /* Is the name in the spec file decorated? */ + const char* pcDeco = ScanToken(pexp->strName.buf, '@'); + if(pcDeco && + (pexp->strName.len > 1) && + (pcDeco < pexp->strName.buf + pexp->strName.len)) + { + /* Write the name including the leading @ */ + fprintf(fileDest, "==%.*s", pexp->strName.len, pexp->strName.buf); + } + } + else if((!pexp->strTarget.buf) && !(bTracing)) + { + /* Write a forwarder to the actual decorated symbol */ + fprintf(fileDest, "="); + PrintName(fileDest, pexp, &pexp->strName, 1); + } + } +} + +int +OutputLine_def(FILE *fileDest, + EXPORT *pexp) +{ + DbgPrint("OutputLine_def: '%.*s'...\n", pexp->strName.len, pexp->strName.buf); + fprintf(fileDest, " "); + + if(gbMSComp) + OutputLine_def_MS(fileDest, pexp); + else + OutputLine_def_GCC(fileDest, pexp); + + /* On GCC builds we force ordinals */ + if((pexp->uFlags & FL_ORDINAL) || (!gbMSComp && !gbImportLib)) + { + fprintf(fileDest, " @%d", pexp->nOrdinal); + } + + if(pexp->uFlags & FL_NONAME) + { + fprintf(fileDest, " NONAME"); + } + + /* Either PRIVATE or DATA */ + if(pexp->uFlags & FL_PRIVATE) + { + fprintf(fileDest, " PRIVATE"); + } + else if(pexp->nCallingConvention == CC_EXTERN) + { + fprintf(fileDest, " DATA"); + } + + fprintf(fileDest, "\n"); + + return 1; +} + +void +Fatalv(const char* filename, + unsigned nLine, + const char *pcLine, + const char *pc, + size_t errorlen, + const char *format, + va_list argptr) +{ + unsigned i, errorpos, len; + const char* pcLineEnd; + + /* Get the length of the line */ + pcLineEnd = strpbrk(pcLine, "\r\n"); + len = (unsigned)(pcLineEnd - pcLine); + + if(pc == NULL) + { + pc = pcLine + len - 1; + errorlen = 1; + } + + errorpos = (unsigned)(pc - pcLine); + + /* Output the error message */ + fprintf(stderr, "ERROR: (%s:%u:%u): ", filename, nLine, errorpos); + vfprintf(stderr, format, argptr); + fprintf(stderr, "\n"); + + /* Output the line with the error */ + fprintf(stderr, "> %.*s\n", len, pcLine); + + if(errorlen == 0) + { + errorlen = TokenLength(pc); + } + + for(i = 0; i < errorpos + 2; i++) + { + fprintf(stderr, " "); + } + for(i = 0; i < errorlen; i++) + { + fprintf(stderr, "~"); + } + fprintf(stderr, "\n"); + exit(-1); +} + +void +Fatal(const char* filename, + unsigned nLine, + const char *pcLine, + const char *pc, + size_t errorlen, + const char *format, + ...) +{ + va_list argptr; + + va_start(argptr, format); + Fatalv(filename, nLine, pcLine, pc, errorlen, format, argptr); + va_end(argptr); +} + +EXPORT * +ParseFile(char* pcStart, + FILE *fileDest, + unsigned *cExports) +{ + EXPORT *pexports; + const char *pc, *pcLine; + int cLines, nLine; + EXPORT exp; + int included; + unsigned int i; + + *cExports = 0; + + //fprintf(stderr, "info: line %d, pcStart:'%.30s'\n", nLine, pcStart); + + /* Count the lines */ + for(cLines = 1, pcLine = pcStart; *pcLine; pcLine = NextLine(pcLine), cLines++) + { + /* Nothing */ + } + + /* Allocate an array of EXPORT structures */ + pexports = malloc(cLines * sizeof(EXPORT)); + if(pexports == NULL) + { + fprintf(stderr, "ERROR: %s: failed to allocate EXPORT array of %u elements\n", pszSourceFileName, cLines); + return NULL; + } + + /* Loop all lines */ + nLine = 1; + exp.nNumber = 0; + for(pcLine = pcStart; *pcLine; pcLine = NextLine(pcLine), nLine++) + { + pc = pcLine; + + exp.strName.buf = NULL; + exp.strName.len = 0; + exp.strTarget.buf = NULL; + exp.strTarget.len = 0; + exp.nArgCount = 0; + exp.uFlags = 0; + exp.nNumber++; + exp.nStartVersion = 0; + exp.nEndVersion = 0xFFFFFFFF; + exp.bVersionIncluded = 1; + + /* Skip white spaces */ + while(*pc == ' ' || *pc == '\t') pc++; + + /* Check for line break or comment */ + if((*pc == '\r') || (*pc == '\n') || + (*pc == ';') || (*pc == '#')) + { + continue; + } + + /* On EOF we are done */ + if(*pc == 0) + { + return pexports; + } + + /* Now we should get either an ordinal or @ */ + if(*pc == '@') + { + exp.nOrdinal = -1; + } + else if((*pc >= '0') && (*pc <= '9')) + { + char* end; + long int number = strtol(pc, &end, 10); + if((*end != ' ') && (*end != '\t')) + { + Fatal(pszSourceFileName, nLine, pcLine, end, 0, "Unexpected character(s) after ordinal"); + } + + if((number < 0) || (number > 0xFFFE)) + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 0, "Invalid value for ordinal"); + } + + exp.nOrdinal = number; + + /* The import lib should contain the ordinal only if -ordinal was specified */ + if(!gbImportLib) + { + exp.uFlags |= FL_ORDINAL; + } + } + else + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 0, "Expected '@' or ordinal"); + } + + /* Go to next token (type) */ + if(!(pc = NextToken(pc))) + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 1, "Unexpected end of line"); + } + + //fprintf(stderr, "info: Token:'%.*s'\n", TokenLength(pc), pc); + + /* Now we should get the type */ + if(CompareToken(pc, "stdcall")) + { + exp.nCallingConvention = CC_STDCALL; + } + else if(CompareToken(pc, "cdecl") || + CompareToken(pc, "varargs")) + { + exp.nCallingConvention = CC_CDECL; + } + else if(CompareToken(pc, "fastcall")) + { + exp.nCallingConvention = CC_FASTCALL; + } + else if(CompareToken(pc, "thiscall")) + { + exp.nCallingConvention = CC_THISCALL; + } + else if(CompareToken(pc, "extern")) + { + exp.nCallingConvention = CC_EXTERN; + } + else if(CompareToken(pc, "stub")) + { + exp.nCallingConvention = CC_STUB; + } + else + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 0, "Invalid calling convention"); + } + + /* Go to next token (options or name) */ + if(!(pc = NextToken(pc))) + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 1, "Unexpected end of line"); + } + + /* Handle options */ + included = 1; + while(*pc == '-') + { + if(CompareToken(pc, "-arch=")) + { + /* Default to not included */ + included = 0; + pc += 5; + + /* Look if we are included */ + do + { + pc++; + if(CompareToken(pc, pszArchString) || + CompareToken(pc, pszArchString2)) + { + included = 1; + } + + /* Skip to next arch or end */ + while(*pc > ',') + { + pc++; + } + } while(*pc == ','); + } + else if(CompareToken(pc, "-i386")) + { + if(giArch != ARCH_X86) + { + included = 0; + } + } + else if(CompareToken(pc, "-version=")) + { + const char *pcVersionStart = pc + 9; + + /* Default to not included */ + exp.bVersionIncluded = 0; + pc += 8; + + /* Look if we are included */ + do + { + unsigned version, endversion; + + /* Optionally skip leading '0x' */ + pc++; + if((pc[0] == '0') && (pc[1] == 'x')) pc += 2; + + /* Now get the version number */ + endversion = version = strtoul(pc, (char**)&pc, 16); + + /* Check if it's a range */ + if(pc[0] == '+') + { + endversion = 0xFFF; + pc++; + } + else if(pc[0] == '-') + { + /* Optionally skip leading '0x' */ + pc++; + if((pc[0] == '0') && (pc[1] == 'x')) pc += 2; + endversion = strtoul(pc, (char**)&pc, 16); + } + + /* Check for degenerate range */ + if(version > endversion) + { + Fatal(pszSourceFileName, + nLine, + pcLine, + pcVersionStart, + pc - pcVersionStart, + "Invalid version range"); + } + + exp.nStartVersion = version; + exp.nEndVersion = endversion; + + /* Now compare the range with our version */ + if((guOsVersion >= version) && + (guOsVersion <= endversion)) + { + exp.bVersionIncluded = 1; + } + + /* Skip to next arch or end */ + while(*pc > ',') pc++; + + } while(*pc == ','); + } + else if(CompareToken(pc, "-private")) + { + exp.uFlags |= FL_PRIVATE; + } + else if(CompareToken(pc, "-noname")) + { + exp.uFlags |= FL_ORDINAL | FL_NONAME; + } + else if(CompareToken(pc, "-ordinal")) + { + exp.uFlags |= FL_ORDINAL; + /* GCC doesn't automatically import by ordinal if an ordinal + * is found in the def file. Force it. */ + if(gbImportLib && !gbMSComp) + exp.uFlags |= FL_NONAME; + } + else if(CompareToken(pc, "-stub")) + { + exp.uFlags |= FL_STUB; + } + else if(CompareToken(pc, "-norelay")) + { + exp.uFlags |= FL_NORELAY; + } + else if(CompareToken(pc, "-ret64")) + { + exp.uFlags |= FL_RET64; + } + else if(CompareToken(pc, "-register")) + { + exp.uFlags |= FL_REGISTER; + } + else + { + fprintf(stdout, + "INFO: %s line %d: Ignored option: '%.*s'\n", + pszSourceFileName, + nLine, + TokenLength(pc), + pc); + } + + /* Go to next token */ + pc = NextToken(pc); + } + + /* If arch didn't match ours, skip this entry */ + if(!included) + { + continue; + } + + /* Get name */ + exp.strName.buf = pc; + exp.strName.len = TokenLength(pc); + + /* Check for autoname */ + if((exp.strName.len == 1) && (exp.strName.buf[0] == '@')) + { + exp.uFlags |= FL_ORDINAL | FL_NONAME; + } + + /* Handle parameters */ + exp.nStackBytes = 0; + if(exp.nCallingConvention != CC_EXTERN && + exp.nCallingConvention != CC_STUB) + { + /* Go to next token */ + if(!(pc = NextToken(pc))) + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 1, "Unexpected end of line"); + } + + /* Verify syntax */ + if(*pc++ != '(') + { + Fatal(pszSourceFileName, nLine, pcLine, pc - 1, 0, "Expected '('"); + } + + /* Skip whitespaces */ + while(*pc == ' ' || *pc == '\t') pc++; + + exp.nStackBytes = 0; + while(*pc >= '0') + { + if(CompareToken(pc, "long")) + { + exp.nStackBytes += 4; + exp.anArgs[exp.nArgCount] = ARG_LONG; + } + else if(CompareToken(pc, "double")) + { + exp.nStackBytes += 8; + exp.anArgs[exp.nArgCount] = ARG_DBL; + } + else if(CompareToken(pc, "ptr")) + { + exp.nStackBytes += 4; // sizeof(void*) on x86 + exp.anArgs[exp.nArgCount] = ARG_PTR; + } + else if(CompareToken(pc, "str")) + { + exp.nStackBytes += 4; // sizeof(void*) on x86 + exp.anArgs[exp.nArgCount] = ARG_STR; + } + else if(CompareToken(pc, "wstr")) + { + exp.nStackBytes += 4; // sizeof(void*) on x86 + exp.anArgs[exp.nArgCount] = ARG_WSTR; + } + else if(CompareToken(pc, "int64")) + { + exp.nStackBytes += 8; + exp.anArgs[exp.nArgCount] = ARG_INT64; + } + else if(CompareToken(pc, "int128")) + { + exp.nStackBytes += 16; + exp.anArgs[exp.nArgCount] = ARG_INT128; + } + else if(CompareToken(pc, "float")) + { + exp.nStackBytes += 4; + exp.anArgs[exp.nArgCount] = ARG_FLOAT; + } + else + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 0, "Unrecognized type"); + } + + exp.nArgCount++; + + /* Go to next parameter */ + if(!(pc = NextToken(pc))) + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 1, "Unexpected end of line"); + } + } + + /* Check syntax */ + if(*pc++ != ')') + { + Fatal(pszSourceFileName, nLine, pcLine, pc - 1, 0, "Expected ')'"); + } + } + + /* Handle special stub cases */ + if(exp.nCallingConvention == CC_STUB) + { + /* Check for c++ mangled name */ + if(pc[0] == '?') + { + //printf("Found c++ mangled name...\n"); + // + } + else + { + /* Check for stdcall name */ + const char *p = ScanToken(pc, '@'); + if(p && (p - pc < exp.strName.len)) + { + int i; + + /* Truncate the name to before the @ */ + exp.strName.len = (int)(p - pc); + if(exp.strName.len < 1) + { + Fatal(pszSourceFileName, nLine, pcLine, p, 1, "Unexpected @"); + } + exp.nStackBytes = atoi(p + 1); + exp.nArgCount = exp.nStackBytes / 4; + exp.nCallingConvention = CC_STDCALL; + exp.uFlags |= FL_STUB; + for(i = 0; i < exp.nArgCount; i++) + { + exp.anArgs[i] = ARG_LONG; + } + } + } + } + + /* Get optional redirection */ + pc = NextToken(pc); + if(pc) + { + exp.strTarget.buf = pc; + exp.strTarget.len = TokenLength(pc); + + /* Check syntax (end of line) */ + if(NextToken(pc)) + { + Fatal(pszSourceFileName, nLine, pcLine, NextToken(pc), 0, "Excess token(s) at end of definition"); + } + + /* Don't relay-trace forwarded functions */ + exp.uFlags |= FL_NORELAY; + } + else + { + exp.strTarget.buf = NULL; + exp.strTarget.len = 0; + } + + /* Check for no-name without ordinal */ + if((exp.uFlags & FL_ORDINAL) && (exp.nOrdinal == -1)) + { + Fatal(pszSourceFileName, nLine, pcLine, pc, 0, "Ordinal export without ordinal"); + } + + /* + * Check for special handling of OLE exports, only when MSVC + * is not used, since otherwise this is handled by MS LINK.EXE. + */ + if(!gbMSComp) + { + /* Check whether the current export is not PRIVATE, or has an ordinal */ + int bIsNotPrivate = (!gbNotPrivateNoWarn && /*gbImportLib &&*/ !(exp.uFlags & FL_PRIVATE)); + int bHasOrdinal = (exp.uFlags & FL_ORDINAL); + + /* Check whether the current export is an OLE export, in case any of these tests pass */ + if(bIsNotPrivate || bHasOrdinal) + { + for(i = 0; i < ARRAYSIZE(astrOlePrivateExports); ++i) + { + if(strlen(astrOlePrivateExports[i]) == exp.strName.len && + strncmp(exp.strName.buf, astrOlePrivateExports[i], exp.strName.len) == 0) + { + /* The current export is an OLE export: display the corresponding warning */ + if(bIsNotPrivate) + { + fprintf(stderr, "WARNING: %s line %d: Exported symbol '%.*s' should be PRIVATE\n", + pszSourceFileName, nLine, exp.strName.len, exp.strName.buf); + } + if(bHasOrdinal) + { + fprintf(stderr, "WARNING: %s line %d: exported symbol '%.*s' should not be assigned an ordinal\n", + pszSourceFileName, nLine, exp.strName.len, exp.strName.buf); + } + break; + } + } + } + } + + pexports[*cExports] = exp; + (*cExports)++; + gbDebug = 0; + } + + return pexports; +} + +int +ApplyOrdinals(EXPORT* pexports, + unsigned cExports) +{ + unsigned short i, j; + char* used; + + /* Allocate a table to mark used ordinals */ + used = malloc(65536); + if(used == NULL) + { + fprintf(stderr, "Failed to allocate memory for ordinal use table\n"); + return -1; + } + memset(used, 0, 65536); + + /* Pass 1: mark the ordinals that are already used */ + for(i = 0; i < cExports; i++) + { + if(pexports[i].uFlags & FL_ORDINAL) + { + if(used[pexports[i].nOrdinal] != 0) + { + fprintf(stderr, "Found duplicate ordinal: %u\n", pexports[i].nOrdinal); + return -1; + } + used[pexports[i].nOrdinal] = 1; + } + } + + /* Pass 2: apply available ordinals */ + for(i = 0, j = 1; i < cExports; i++) + { + if((pexports[i].uFlags & FL_ORDINAL) == 0 && pexports[i].bVersionIncluded) + { + while(used[j] != 0) + { + j++; + } + + pexports[i].nOrdinal = j; + used[j] = 1; + } + } + + free(used); + return 0; +} + +void usage(void) +{ + printf("XTchain SPEC Compiler Version %s\n" + "Syntax: %s [ ...] \n\n" + "Possible options:\n" + " -h --help print this help screen\n" + " -d= generate a def file\n" + " -s= generate a stub file\n" + " -n= name of the dll\n" + " -a= set architecture to one of: aarch64, armv7, i686, x86_64\n" + " --implib generate a def file for an import library\n" + " --msvc MSVC compatibility\n" + " --no-private-warnings suppress warnings about symbols that should be private\n" + " --with-tracing generate wine-like \"+relay\" trace trampolines (needs -s)\n", + XTCSPECC_VERSION, + pszExecName); +} + +int main(int argc, + char *argv[]) +{ + size_t nFileSize; + char *pszSource, *pszDefFileName = NULL, *pszStubFileName = NULL; + const char* pszVersionOption = "--version=0x"; + char achDllName[40]; + FILE *file; + unsigned cExports = 0, i; + EXPORT *pexports; + + /* Read architecture from executable name */ + split_argv(argv[0], NULL, NULL, &pszArchString, &pszExecName); + if(pszArchString) + { + pszArchString = strtok(pszArchString, "-"); + } + + if(argc < 2) + { + usage(); + return -1; + } + + /* Read options */ + for(i = 1; i < (unsigned)argc && *argv[i] == '-'; i++) + { + if((strcasecmp(argv[i], "--help") == 0) || + (strcasecmp(argv[i], "-h") == 0)) + { + usage(); + return 0; + } + else if(argv[i][1] == 'd' && argv[i][2] == '=') + { + pszDefFileName = argv[i] + 3; + } + else if(argv[i][1] == 's' && argv[i][2] == '=') + { + pszStubFileName = argv[i] + 3; + } + else if(argv[i][1] == 'n' && argv[i][2] == '=') + { + pszDllName = argv[i] + 3; + } + else if(argv[i][1] == 'a' && argv[i][2] == '=') + { + pszArchString = argv[i] + 3; + } + else if(strncasecmp(argv[i], pszVersionOption, strlen(pszVersionOption)) == 0) + { + guOsVersion = strtoul(argv[i] + strlen(pszVersionOption), NULL, 16); + } + else if(strcasecmp(argv[i], "--implib") == 0) + { + gbImportLib = 1; + } + else if(strcasecmp(argv[i], "--msvc") == 0) + { + gbMSComp = 1; + } + else if(strcasecmp(argv[i], "--no-private-warnings") == 0) + { + gbNotPrivateNoWarn = 1; + } + else if(strcasecmp(argv[i], "--with-tracing") == 0) + { + if(!pszStubFileName) + { + fprintf(stderr, "Error: cannot use --with-tracing without -s option.\n"); + return -1; + } + gbTracing = 1; + } + else + { + fprintf(stderr, "Unrecognized option: %s\n", argv[i]); + return -1; + } + } + + if(pszArchString) + { + if((strcasecmp(pszArchString, "i386") == 0) || (strcasecmp(pszArchString, "i686") == 0)) + { + giArch = ARCH_X86; + gpszUnderscore = "_"; + } + else if((strcasecmp(pszArchString, "x86_64") == 0) || (strcasecmp(pszArchString, "amd64") == 0)) + { + giArch = ARCH_AMD64; + } + else if((strcasecmp(pszArchString, "arm") == 0) || (strcasecmp(pszArchString, "armv7") == 0)) + { + giArch = ARCH_ARM; + } + else if((strcasecmp(pszArchString, "aarch64") == 0) || (strcasecmp(pszArchString, "arm64") == 0)) + { + giArch = ARCH_ARM64; + } + else + { + printf("Invalid architecture specified.\n"); + exit(-1); + } + } + else + { + printf("No architecture specified.\n"); + exit(-1); + } + + if((giArch == ARCH_AMD64) || (giArch == ARCH_ARM64)) + { + pszArchString2 = "win64"; + } + else + { + pszArchString2 = "win32"; + } + /* Set a default dll name */ + if(!pszDllName) + { + char *p1, *p2; + size_t len; + + p1 = strrchr(argv[i], '\\'); + if(!p1) p1 = strrchr(argv[i], '/'); + p2 = p1 = p1 ? p1 + 1 : argv[i]; + + /* walk up to '.' */ + while(*p2 != '.' && *p2 != 0) p2++; + len = p2 - p1; + if(len >= sizeof(achDllName) - 5) + { + fprintf(stderr, "name too long: %s\n", p1); + return -2; + } + + strncpy(achDllName, p1, len); + strncpy(achDllName + len, ".dll", sizeof(achDllName) - len); + pszDllName = achDllName; + } + + /* Open input file */ + pszSourceFileName = argv[i]; + file = fopen(pszSourceFileName, "r"); + if(!file) + { + fprintf(stderr, "error: could not open file %s\n", pszSourceFileName); + return -3; + } + + /* Get file size */ + fseek(file, 0, SEEK_END); + nFileSize = ftell(file); + rewind(file); + + /* Allocate memory buffer */ + pszSource = malloc(nFileSize + 1); + if(!pszSource) + { + fclose(file); + return -4; + } + + /* Load input file into memory */ + nFileSize = fread(pszSource, 1, nFileSize, file); + fclose(file); + + /* Zero terminate the source */ + pszSource[nFileSize] = '\0'; + + pexports = ParseFile(pszSource, file, &cExports); + if(pexports == NULL) + { + fprintf(stderr, "error: could not parse file!\n"); + return -1; + } + + if(!gbMSComp) + { + if(ApplyOrdinals(pexports, cExports) < 0) + { + fprintf(stderr, "error: could not apply ordinals!\n"); + return -1; + } + } + + if(pszDefFileName) + { + /* Open output file */ + file = fopen(pszDefFileName, "w"); + if(!file) + { + fprintf(stderr, "error: could not open output file %s\n", argv[i + 1]); + return -5; + } + + OutputHeader_def(file, pszDllName); + + for(i = 0; i < cExports; i++) + { + if(pexports[i].bVersionIncluded) + OutputLine_def(file, &pexports[i]); + } + + fclose(file); + } + + if(pszStubFileName) + { + /* Open output file */ + file = fopen(pszStubFileName, "w"); + if(!file) + { + fprintf(stderr, "error: could not open output file %s\n", argv[i + 1]); + return -5; + } + + OutputHeader_stub(file); + + for(i = 0; i < cExports; i++) + { + if(pexports[i].bVersionIncluded) + OutputLine_stub(file, &pexports[i]); + } + + fclose(file); + } + + free(pexports); + + return 0; +}