diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,202 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ - 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. + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - 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. + 1. Definitions. - 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. + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. - 12. No Surrender of Others' Freedom. + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. - 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. + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. - 13. Use with the GNU Affero General Public License. + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this 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. + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. - 14. Revised Versions of this License. + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. - 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. + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). - 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. + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. - 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. + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." - 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. + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. - 15. Disclaimer of Warranty. + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. - 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. + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. - 16. Limitation of Liability. + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: - 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. + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and - 17. Interpretation of Sections 15 and 16. + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and - 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. + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and - END OF TERMS AND CONDITIONS + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. - How to Apply These Terms to Your New Programs + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. - 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. + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. - 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. + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. - - Copyright (C) + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. - 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. + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. - 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. + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. - You should have received a copy of the GNU General Public License - along with this program. If not, see . + END OF TERMS AND CONDITIONS -Also add information on how to contact you by electronic and paper mail. + APPENDIX: How to apply the Apache License to your work. - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. - 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. + Copyright [yyyy] [name of copyright owner] -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". + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at - 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.apache.org/licenses/LICENSE-2.0 - 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 -. + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,25 +1,121 @@ -# cabal-helper -[![build status](https://gitlab.com/dxld/cabal-helper/badges/master/build.svg)](https://gitlab.com/dxld/cabal-helper/commits/master) +# The `cabal-helper` library +[![build status](https://gitlab.com/dxld/cabal-helper/badges/master/pipeline.svg)](https://gitlab.com/dxld/cabal-helper/commits/master) -Cabal's little helper provides access to build information gathered by `cabal` -when configuring a project. Specifically we're interested in retrieving enough -information to bring up a compiler session, using the GHC API, which is similar -to running `cabal repl` in a project. +The purpose of the `cabal-helper` library is to give Haskell development +tools access to the same environment which build tools such as +[cabal](https://www.haskell.org/cabal) and +[stack](https://www.haskellstack.org) normally provide to the compiler. -While simple in principle this is complicated by the fact that the information -Cabal writes to disk is in an unstable format and only really accessible through -the Cabal API itself. +## Introduction -Since we do not want to bind the user of a development tool which utilises this -library to a specific version of Cabal we compile the code which interfaces with -the Cabal library's API on the user's machine, at runtime, against whichever -version of Cabal was used to write the on disk information for a given project. +In the Haskell ecosystem the most widely used [build system](#build-system) is +the [`Cabal` library](https://hackage.haskell.org/package/Cabal), not to be +confused with the `cabal` *build tool* which is usually refered to by it's +package-name: `cabal-install` to disambiguate. -If this version of Cabal is not available on the users machine anymore, which is -fairly likely since cabal-install is usually linked statically, we have support -for compiling the Cabal library also. In this case the library is installed into -a private, isolated, package database in `$XDG_CACHE_HOME/cabal-helper` so as to -not interfere with the user's package database. +All contemporary meta *build tools* such as `cabal` and `stack` as well as some +custom Haskell [build systems](#build-system) use the `Cabal` library as their +foundation. For example the Glasgow Haskell Compiler's bespoke GNU Make based +build system also utilises the `Cabal` library at its core. + +We capitalize on this fact by using build information `Cabal` writes to disk as +the common denominator between all Haskell *build tools*. This allows us to +easily support a variety of *build tools* without incuring significant +additional complexity. + +## Technical Background + +### Haskell Packages and `Setup.hs` + +Essentially all Haskell packages implement +["The Haskell Cabal" (pdf)](https://www.haskell.org/cabal/proposal/pkg-spec.pdf) +packaging specification. The `Cabal` library and `cabal-install` *build tool* +are named after this specification. Yes we really love confusing naming in +Haskell land. + +The specification revolves around this `Setup.hs` script file you might +have seen before. Basically the idea is a Haskell source package consists +of, at the very least, a `Setup.hs` file, which is a Haskell program that +provides a well defined command-line interface for configuring, building +and installing it. Haskell developers can use *build tools*, such as +`cabal`, which interface with `Setup.hs` and provide functionality on top +it. + +Note that even though originally packages were meant to be free to +implement the `Setup.hs` interface however they like, this hasn't been +supported by build tools for a long time. In practice use of the `Cabal` +library in `Setup.hs` is mandatory. + +Now, the first step of building a package in "The Haskell Cabal" is to call +`Setup.hs`'s `configure` command: + + $ runhaskell Setup.hs configure + +When invoking `Setup.hs` the default behaviour of the `Cabal` library is to +first read the `.cabal` configuration file to determine how the +project is structured and what dependencies it has. In the case of +`configure` it will then probe the system it's running on about: + + - the list of available Haskell packages, + - system package dependencies (using pkg-config) and + - Haskell compiler type, version and supported language extensions (among + other things). + +Finally Haskell package dependency resolution is also run. + +`Cabal` then writes all the gathered information on the concrete +configuration of the package into a file called `setup-config`. Subsequent +steps, such as`runhaskell Setup.hs build`, will then read this state file +instead of `.cabal` to avoid having to probe the system or +run dependency resolution again. + +It is this file that `cabal-helper` is primarily concerned with reading and +presenting in a usable manner. Reading this file essentially means that all +the complicated work has already been done for us and we can get straight +to running the compiler. + +### Multi-package projects + +So far so good. That's pretty much the end of the story for the traditional +`cabal build` commands but what about `cabal new-build` and Stack I hear +you asking? + +Well, essentially both new-build and Stack simply build on top of the +traditional `Setup.hs` interface. So the `setup-config` file is still there +in all it's glory, we just have to deal with more than one of it since both +build-tools support multiple packages and `Setup.hs` only knows how to deal +with a single package at a time. + +To support this cabal-helper has grown a representation of what a project +is in it's API starting with the 1.0 series. We currently support both +new-build and Stack. The API is designed to allow extending support to +custom build systems such as GHC's but we have not done this yet. + +### The "Helper" in cabal-helper + +In the API docs you will find frequent mentions of "the helper executable" +so I'll explain what that is here because it is quite fundamental to how +things work in the codebase. + +The fundamental problem cabal-helper solves is the fact that in order to +access the data Cabal stores in the `setup-config` file we have to link +against `lib:Cabal`. However the binary format of this file is unstable and +there is no backwards compatibility mechanism in the library. So to read a +`setup-config` file produced by a certain version of Cabal we have to link +against exactly that version. + +Not only that but usally the `cabal` commandline tool controls which Cabal +library version is used, so we really just have to deal with whatever we +get. + +To solve this problem the cabal-helper library builds a small executable at +runtime who's only purpose is to link against `lib:Cabal`, read the +contents of `setup-config` and present the data there in a Cabal version +independent format for consumption by the cabal-helper library. + +Recently some work was merged into cabal to have `Setup.hs` to do this +natively (https://github.com/haskell/cabal/pull/5954), we're planning to +use this eventually to replace our "helper". ## IRC diff --git a/cabal-helper.cabal b/cabal-helper.cabal --- a/cabal-helper.cabal +++ b/cabal-helper.cabal @@ -1,62 +1,67 @@ +cabal-version: 2.2 name: cabal-helper -version: 0.8.2.0 +version: 1.0.0.0 synopsis: - Simple interface to some of Cabal's configuration state, mainly used by ghc-mod + Give Haskell development tools access to Cabal project environment description: - Cabal's little helper provides access to build information gathered by - @cabal@ when configuring a project. Specifically we're interested in - retrieving enough information to bring up a compiler session, using the GHC - API, which is similar to running @cabal repl@ in a project. - . - While simple in principle this is complicated by the fact that the - information Cabal writes to disk is in an unstable format and only really - accessible through the Cabal API itself. - . - Since we do not want to bind the user of a development tool which utilises - this library to a specific version of Cabal we compile the code which - interfaces with the Cabal library's API on the user's machine, at runtime, - against whichever version of Cabal was used to write the on disk information - for a given project. - . - If this version of Cabal is not available on the users machine anymore, - which is fairly likely since cabal-install is usually linked statically, we - have support for compiling the Cabal library also. In this case the library - is installed into a private, isolated, package database in - @$XDG_CACHE_HOME/cabal-helper@ so as to not interfere with the user's - package database. -license: GPL-3 + The purpose of the @cabal-helper@ library is to give Haskell development + tools access to the same environment which build tools such as @cabal@ and + @stack@ normally provide to the compiler. +license: Apache-2.0 license-file: LICENSE author: Daniel Gröber maintainer: cabal-helper@dxld.at category: Distribution -build-type: Custom -cabal-version: 2.0 +build-type: Simple extra-source-files: README.md src/CabalHelper/Runtime/*.hs tests/*.hs + tests/stack-resolvers + tests/cabal-versions tests/exelib/*.hs tests/exelib/*.cabal + tests/exelib/packages.list + tests/exelib/stack.yaml tests/exelib/lib/*.hs tests/exeintlib/*.hs tests/exeintlib/*.cabal + tests/exeintlib/packages.list + tests/exeintlib/stack.yaml tests/exeintlib/lib/*.hs tests/exeintlib/intlib/*.hs tests/fliblib/*.hs tests/fliblib/*.cabal + tests/fliblib/packages.list + tests/fliblib/stack.yaml tests/fliblib/lib/*.hs - tests/bkpregex/*.cabal tests/bkpregex/*.hs + tests/bkpregex/*.cabal + tests/bkpregex/packages.list + tests/bkpregex/stack.yaml tests/bkpregex/regex-example/*.hs tests/bkpregex/regex-indef/*.hs tests/bkpregex/regex-indef/*.hsig tests/bkpregex/regex-types/Regex/*.hs tests/bkpregex/str-impls/Str/*.hs + tests/multipkg/packages.list + tests/multipkg/pkg-oot/*.cabal + tests/multipkg/pkg-oot/*.hs + tests/multipkg/proj/*.cabal + tests/multipkg/proj/*.hs + tests/multipkg/proj/cabal.project + tests/multipkg/proj/pkg-a/*.cabal + tests/multipkg/proj/pkg-a/*.hs + tests/multipkg/proj/pkg-b/*.cabal + tests/multipkg/proj/pkg-b/*.hs + tests/multipkg/proj/stack.yaml + + source-repository head type: git location: https://github.com/DanielG/cabal-helper.git @@ -66,202 +71,129 @@ default: False manual: True -custom-setup - setup-depends: base - , Cabal < 3 && >= 2.0.0.0 --- [Note test dependencies] Vaious tests need access to modules used in other --- components, unfortunately we can't use Cabal 2.0's new internal libraries for --- this because we'd like to support ancient Cabal versions. Instead we just --- copy 'hs-source-dirs', 'build-depends' and 'other-modules' fields as --- appropriate. --- --- The following awk command will copy paragraphs starting with: --- -- Common some-name --- to following paragraphs starting with: --- -- Instantiate common some-name --- --- $ gawk -i inplace -f scripts/update-cabal-common-section-instantiations.awk cabal-helper.cabal --- --- FIXME: We can use Cabal 2.0 features now, yey! - -library +common extensions default-language: Haskell2010 default-extensions: NondecreasingIndentation - hs-source-dirs: lib, src - exposed-modules: Distribution.Helper - other-modules: - CabalHelper.Shared.InterfaceTypes - CabalHelper.Shared.Sandbox - Paths_cabal_helper - autogen-modules: Paths_cabal_helper - - ghc-options: -Wall - - -- well actually this is a "runtime"-tool-depends :) - build-tool-depends: cabal-helper:cabal-helper-wrapper + ImplicitParams + NamedFieldPuns RecordWildCards + FlexibleContexts + ConstraintKinds + other-extensions: TemplateHaskell - build-depends: base < 5 && >= 4.7 - build-depends: Cabal < 2.5 && >= 2.0 || < 1.26 && >= 1.14 - , cabal-plan < 0.5 && >= 0.3.0.0 - , containers < 1 && >= 0.5.5.1 - , directory < 1.4 && >= 1.2.1.0 - , filepath < 1.5 && >= 1.3.0.0 - , transformers < 0.6 && >= 0.3.0.0 +common build-deps + build-depends: base < 5 && >= 4.9.1.0 + , Cabal < 3.1 && >= 3.0 + || < 2.5 && >= 2.0 + || < 1.26 && >= 1.24.2.0 + , cabal-plan < 0.6 && >= 0.5.0.0 + , clock < 0.8 && >= 0.7.2 + , containers < 1 && >= 0.5.7.1 + , bytestring < 0.11 && >= 0.10.8.1 + , directory < 1.4 && >= 1.3.0.0 + , filepath < 1.5 && >= 1.4.1.1 , mtl < 2.3 && >= 2.0 - , process < 1.7 && >= 1.1.0.1 - if !os(windows) - build-depends: unix < 2.8 && >= 2.5.1.1 - build-depends: unix-compat < 0.6 && >= 0.4.3.1 + , process < 1.7 && >= 1.4.3.0 + , semigroups < 0.19 && >= 0.18 , semigroupoids < 5.4 && >= 5.2 - - + , SHA < 1.7 && >= 1.6.4.4 + , text < 1.3 && >= 1.0.0.0 + , template-haskell < 2.15 && >= 2.11.1.0 + , temporary < 1.3 && >= 1.2.1 + , time < 1.9 && >= 1.6.0.1 + , transformers < 0.6 && >= 0.5.2.0 + , utf8-string < 1.1 && >= 1.0.1.1 + if os(windows) + build-depends: Win32 < 2.9 && >= 2.5.4.1 + else + build-depends: unix < 2.8 && >= 2.7.2.1 + build-depends: unix-compat < 0.6 && >= 0.4.3.1 -executable cabal-helper-wrapper - main-is: CabalHelper/Compiletime/Wrapper.hs if flag(dev) - ghc-options: -Wall - scope: private + ghc-options: -Wall - -- Common c-h-wrapper-fields -- See [Note test dependencies] - default-language: Haskell2010 - default-extensions: NondecreasingIndentation - other-extensions: TemplateHaskell - hs-source-dirs: src - other-modules: + +library c-h-internal + import: build-deps, extensions + exposed-modules: + CabalHelper.Compiletime.Cabal + CabalHelper.Compiletime.CompPrograms CabalHelper.Compiletime.Compat.Environment - CabalHelper.Compiletime.Compat.ProgramDb CabalHelper.Compiletime.Compat.Version + CabalHelper.Compiletime.Compat.Parsec CabalHelper.Compiletime.Compile CabalHelper.Compiletime.Data CabalHelper.Compiletime.Log + CabalHelper.Compiletime.Process + CabalHelper.Compiletime.Program.CabalInstall + CabalHelper.Compiletime.Program.Stack + CabalHelper.Compiletime.Program.GHC + CabalHelper.Compiletime.Sandbox CabalHelper.Compiletime.Types + CabalHelper.Compiletime.Types.RelativePath + CabalHelper.Runtime.Compat + CabalHelper.Runtime.HelperMain CabalHelper.Shared.Common CabalHelper.Shared.InterfaceTypes - CabalHelper.Shared.Sandbox + other-modules: Paths_cabal_helper - build-tool-depends: cabal-install:cabal - build-depends: base < 5 && >= 4.7 + autogen-modules: + Paths_cabal_helper + exposed-modules: + Symlink if os(windows) - build-depends: base >= 4.7 - build-depends: Cabal < 2.5 && >= 2.0 || < 1.26 && >= 1.14 - , cabal-plan < 0.5 && >= 0.3.0.0 - , containers < 1 && >= 0.5.5.1 - , bytestring < 0.11 && >= 0.9.2.1 - , directory < 1.4 && >= 1.2.1.0 - , filepath < 1.5 && >= 1.3.0.0 - , mtl < 2.3 && >= 2.0 - , process < 1.7 && >= 1.1.0.1 - , pretty-show < 1.9 && >= 1.7 - , text < 1.3 && >= 1.0.0.0 - , template-haskell < 2.15 && >= 2.7.0.0 - , temporary < 1.4 && >= 1.2.1 - , transformers < 0.6 && >= 0.3.0.0 - if !os(windows) - build-depends: unix < 2.8 && >= 2.5.1.1 - build-depends: unix-compat < 0.6 && >= 0.4.3.1 - , utf8-string < 1.1 && >= 1.0.1.1 - build-tools: cabal + hs-source-dirs: os/win + else + hs-source-dirs: os/posix + hs-source-dirs: src +library + import: build-deps, extensions + exposed-modules: Distribution.Helper + Distribution.Helper.Discover + other-modules: + Paths_cabal_helper + autogen-modules: + Paths_cabal_helper + hs-source-dirs: lib + build-depends: c-h-internal test-suite compile-test + import: build-deps, extensions type: exitcode-stdio-1.0 main-is: CompileTest.hs hs-source-dirs: tests ghc-options: -Wall - build-tools: cabal - - -- Instantiate common c-h-wrapper-fields -- See [Note test dependencies] - default-language: Haskell2010 - default-extensions: NondecreasingIndentation - other-extensions: TemplateHaskell - hs-source-dirs: src - other-modules: - CabalHelper.Compiletime.Compat.Environment - CabalHelper.Compiletime.Compat.ProgramDb - CabalHelper.Compiletime.Compat.Version - CabalHelper.Compiletime.Compile - CabalHelper.Compiletime.Data - CabalHelper.Compiletime.Log - CabalHelper.Compiletime.Types - CabalHelper.Shared.Common - CabalHelper.Shared.InterfaceTypes - CabalHelper.Shared.Sandbox - Paths_cabal_helper - build-tool-depends: cabal-install:cabal - build-depends: base < 5 && >= 4.7 - if os(windows) - build-depends: base >= 4.7 - build-depends: Cabal < 2.5 && >= 2.0 || < 1.26 && >= 1.14 - , cabal-plan < 0.5 && >= 0.3.0.0 - , containers < 1 && >= 0.5.5.1 - , bytestring < 0.11 && >= 0.9.2.1 - , directory < 1.4 && >= 1.2.1.0 - , filepath < 1.5 && >= 1.3.0.0 - , mtl < 2.3 && >= 2.0 - , process < 1.7 && >= 1.1.0.1 - , pretty-show < 1.9 && >= 1.7 - , text < 1.3 && >= 1.0.0.0 - , template-haskell < 2.15 && >= 2.7.0.0 - , temporary < 1.4 && >= 1.2.1 - , transformers < 0.6 && >= 0.3.0.0 - if !os(windows) - build-depends: unix < 2.8 && >= 2.5.1.1 - build-depends: unix-compat < 0.6 && >= 0.4.3.1 - , utf8-string < 1.1 && >= 1.0.1.1 - build-tools: cabal + build-depends: c-h-internal +test-suite programs-test + import: build-deps, extensions + type: exitcode-stdio-1.0 + main-is: ProgramsTest.hs + hs-source-dirs: tests + ghc-options: -Wall + build-depends: c-h-internal + , pretty-show test-suite ghc-session + import: build-deps, extensions type: exitcode-stdio-1.0 main-is: GhcSession.hs hs-source-dirs: tests ghc-options: -Wall - build-depends: base < 5 && >= 4.7 - , ghc < 8.7 && >= 7.8 + build-depends: ghc < 8.7 && >= 8.0.2 , ghc-paths < 0.2 && >= 0.1.0.9 + , pretty-show < 1.9 && >= 1.8.1 , cabal-helper - - -- Instantiate common c-h-wrapper-fields -- See [Note test dependencies] - default-language: Haskell2010 - default-extensions: NondecreasingIndentation - other-extensions: TemplateHaskell - hs-source-dirs: src - other-modules: - CabalHelper.Compiletime.Compat.Environment - CabalHelper.Compiletime.Compat.ProgramDb - CabalHelper.Compiletime.Compat.Version - CabalHelper.Compiletime.Compile - CabalHelper.Compiletime.Data - CabalHelper.Compiletime.Log - CabalHelper.Compiletime.Types - CabalHelper.Shared.Common - CabalHelper.Shared.InterfaceTypes - CabalHelper.Shared.Sandbox - Paths_cabal_helper - build-tool-depends: cabal-install:cabal - build-depends: base < 5 && >= 4.7 - if os(windows) - build-depends: base >= 4.7 - build-depends: Cabal < 2.5 && >= 2.0 || < 1.26 && >= 1.14 - , cabal-plan < 0.5 && >= 0.3.0.0 - , containers < 1 && >= 0.5.5.1 - , bytestring < 0.11 && >= 0.9.2.1 - , directory < 1.4 && >= 1.2.1.0 - , filepath < 1.5 && >= 1.3.0.0 - , mtl < 2.3 && >= 2.0 - , process < 1.7 && >= 1.1.0.1 - , pretty-show < 1.9 && >= 1.7 - , text < 1.3 && >= 1.0.0.0 - , template-haskell < 2.15 && >= 2.7.0.0 - , temporary < 1.4 && >= 1.2.1 - , transformers < 0.6 && >= 0.3.0.0 - if !os(windows) - build-depends: unix < 2.8 && >= 2.5.1.1 - build-depends: unix-compat < 0.6 && >= 0.4.3.1 - , utf8-string < 1.1 && >= 1.0.1.1 - build-tools: cabal + , c-h-internal +test-suite examples + import: build-deps, extensions + type: exitcode-stdio-1.0 + main-is: Examples.hs + hs-source-dirs: tests + ghc-options: -Wall + build-depends: cabal-helper executable cabal-helper-main default-language: Haskell2010 @@ -269,20 +201,21 @@ main-is: CabalHelper/Runtime/Main.hs hs-source-dirs: src other-modules: + CabalHelper.Runtime.HelperMain + CabalHelper.Runtime.Compat CabalHelper.Shared.Common CabalHelper.Shared.InterfaceTypes - CabalHelper.Shared.Sandbox + CabalHelper.Shared.Common - -- This component is usually built at runtime by cabal-helper-wrapper but - -- during development it's convinient to build it via cabal + -- This component is usually built at runtime but during development it's + -- convinient to build it via cabal if flag(dev) buildable: True else buildable: False - -- Common c-h-main-fields -- See [Note test dependencies] ghc-options: -Wall -fno-warn-unused-imports - build-depends: base < 5 && >= 4.7 + build-depends: base < 5 && >= 4.9.1.0 , Cabal , containers , bytestring diff --git a/lib/Distribution/Helper.hs b/lib/Distribution/Helper.hs --- a/lib/Distribution/Helper.hs +++ b/lib/Distribution/Helper.hs @@ -1,591 +1,853 @@ -- cabal-helper: Simple interface to Cabal's configuration state --- Copyright (C) 2015-2018 Daniel Gröber --- --- 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 . - -{-# LANGUAGE CPP, RecordWildCards, FlexibleContexts, ConstraintKinds, - GeneralizedNewtypeDeriving, DeriveDataTypeable, DeriveGeneric, DeriveFunctor, - NamedFieldPuns, OverloadedStrings - #-} - -{-| -Module : Distribution.Helper -License : GPL-3 -Maintainer : cabal-helper@dxld.at -Portability : POSIX --} - -module Distribution.Helper ( - -- * Running Queries - Query - , runQuery - - -- * Queries against Cabal\'s on disk state - - -- ** Package queries - , packageId - , packageDbStack - , packageFlags - , compilerVersion - - , ghcMergedPkgOptions - - -- ** cabal-install queries - , configFlags - , nonDefaultConfigFlags - - - -- ** Component queries - , ComponentQuery - , components - - , ghcSrcOptions - , ghcPkgOptions - , ghcLangOptions - , ghcOptions - , sourceDirs - , entrypoints - , needsBuildOutput - - -- * Query environment - , QueryEnv - , mkQueryEnv - , qeReadProcess - , qePrograms - , qeProjectDir - , qeDistDir - , qeCabalPkgDb - , qeCabalVer - - , Programs(..) - , defaultPrograms - - - -- * Result types - , ChModuleName(..) - , ChComponentName(..) - , ChPkgDb(..) - , ChEntrypoint(..) - , NeedsBuildOutput(..) - - -- * General information - , buildPlatform - - -- * Stuff that cabal-install really should export - , Distribution.Helper.getSandboxPkgDb - - -- * Managing @dist/@ - , prepare - , reconfigure - , writeAutogenFiles - - -- * $libexec related error handling - , LibexecNotFoundError(..) - , libexecNotFoundError - - -- * Reexports - , module Data.Functor.Apply - ) where - -import Cabal.Plan -import Control.Applicative -import Control.Monad -import Control.Monad.IO.Class -import Control.Monad.State.Strict -import Control.Monad.Reader -import Control.Exception as E -import Data.Char -import Data.List -import Data.Maybe -import qualified Data.Map as Map -import Data.Version -import Data.Typeable -import Data.Function -import Data.Functor.Apply -import Distribution.System (buildOS, OS(Windows)) -import System.Environment -import System.FilePath hiding ((<.>)) -import qualified System.FilePath as FP -import System.Directory -import System.Process -import System.IO.Unsafe -import Text.Printf -import GHC.Generics -import Prelude - -import Paths_cabal_helper (getLibexecDir) -import CabalHelper.Shared.InterfaceTypes -import CabalHelper.Shared.Sandbox - --- | Paths or names of various programs we need. -data Programs = Programs { - -- | The path to the @cabal@ program. - cabalProgram :: FilePath, - - -- | The path to the @ghc@ program. - ghcProgram :: FilePath, - - -- | The path to the @ghc-pkg@ program. If - -- not changed it will be derived from the path to 'ghcProgram'. - ghcPkgProgram :: FilePath - } deriving (Eq, Ord, Show, Read, Generic, Typeable) - --- | Default all programs to their unqualified names, i.e. they will be searched --- for on @PATH@. -defaultPrograms :: Programs -defaultPrograms = Programs "cabal" "ghc" "ghc-pkg" - --- | Environment for running a 'Query'. The real constructor is not exposed, --- the field accessors are however. See below. Use the 'mkQueryEnv' smart --- constructor to construct one. -data QueryEnv = QueryEnv { - -- | Field accessor for 'QueryEnv'. Defines how to start the cabal-helper - -- process. Useful if you need to capture stderr output from the helper. - qeReadProcess :: FilePath -> [String] -> String -> IO String, - - -- | Field accessor for 'QueryEnv'. - qePrograms :: Programs, - - -- | Field accessor for 'QueryEnv'. Defines path to the project directory, - -- i.e. a directory containing a @project.cabal@ file - qeProjectDir :: FilePath, - - - -- | Field accessor for 'QueryEnv'. Defines path to the @dist/@ directory, - -- /builddir/ in Cabal terminology. - qeDistDir :: FilePath, - - -- | Field accessor for 'QueryEnv'. Defines where to look for the Cabal - -- library when linking the helper. - qeCabalPkgDb :: Maybe FilePath, - - -- | Field accessor for 'QueryEnv'. If @dist/setup-config@ wasn\'t written - -- by this version of Cabal an error is thrown when running the query. - qeCabalVer :: Maybe Version - } - --- | @mkQueryEnv projdir distdir@. Smart constructor for 'QueryEnv'. --- Sets fields 'qeProjectDir' and 'qeDistDir' to @projdir@ and @distdir@ --- respectively and provides sensible defaults for the other fields. -mkQueryEnv :: FilePath - -- ^ Path to the project directory, i.e. the directory containing a - -- @project.cabal@ file - -> FilePath - -- ^ Path to the @dist/@ directory, called /builddir/ in Cabal - -- terminology. - -> QueryEnv -mkQueryEnv projdir distdir = QueryEnv { - qeReadProcess = readProcess - , qePrograms = defaultPrograms - , qeProjectDir = projdir - , qeDistDir = distdir - , qeCabalPkgDb = Nothing - , qeCabalVer = Nothing - } - -data SomeLocalBuildInfo = SomeLocalBuildInfo { - slbiPackageDbStack :: [ChPkgDb], - slbiPackageFlags :: [(String, Bool)], - slbiCompilerVersion :: (String, Version), - - slbiGhcMergedPkgOptions :: [String], - - slbiConfigFlags :: [(String, Bool)], - slbiNonDefaultConfigFlags :: [(String, Bool)], - - slbiGhcSrcOptions :: [(ChComponentName, [String])], - slbiGhcPkgOptions :: [(ChComponentName, [String])], - slbiGhcLangOptions :: [(ChComponentName, [String])], - slbiGhcOptions :: [(ChComponentName, [String])], - - slbiSourceDirs :: [(ChComponentName, [String])], - slbiEntrypoints :: [(ChComponentName, ChEntrypoint)], - slbiNeedsBuildOutput :: [(ChComponentName, NeedsBuildOutput)] - } deriving (Eq, Ord, Read, Show) - --- | A lazy, cached, query against a package's Cabal configuration. Use --- 'runQuery' to execute it. -newtype Query m a = Query { unQuery :: StateT (Maybe SomeLocalBuildInfo) - (ReaderT QueryEnv m) a } - deriving (Functor, Applicative, Monad, MonadIO) - -instance MonadTrans Query where - lift = Query . lift . lift - -type MonadQuery m = ( MonadIO m - , MonadState (Maybe SomeLocalBuildInfo) m - , MonadReader QueryEnv m) - --- | A 'Query' to run on all components of a package. Use 'components' to get a --- regular 'Query'. -newtype ComponentQuery m a = ComponentQuery (Query m [(ChComponentName, a)]) - deriving (Functor) - -instance (Functor m, Monad m) => Apply (ComponentQuery m) where - ComponentQuery flab <.> ComponentQuery fla = - ComponentQuery $ liftM2 go flab fla - where - go :: [(ChComponentName, a -> b)] - -> [(ChComponentName, a)] - -> [(ChComponentName, b)] - go lab la = - [ (cn, ab a) - | (cn, ab) <- lab - , (cn', a) <- la - , cn == cn' - ] - -run :: Monad m => QueryEnv -> Maybe SomeLocalBuildInfo -> Query m a -> m a -run e s action = flip runReaderT e (flip evalStateT s (unQuery action)) - --- | @runQuery env query@. Run a 'Query' under a given 'QueryEnv'. -runQuery :: Monad m - => QueryEnv - -> Query m a - -> m a -runQuery qe action = run qe Nothing action - -getSlbi :: MonadQuery m => m SomeLocalBuildInfo -getSlbi = do - s <- get - case s of - Nothing -> do - slbi <- getSomeConfigState - put (Just slbi) - return slbi - Just slbi -> return slbi - --- | List of package databases to use. -packageDbStack :: MonadIO m => Query m [ChPkgDb] - --- | Like @ghcPkgOptions@ but for the whole package not just one component -ghcMergedPkgOptions :: MonadIO m => Query m [String] - --- | Flag definitions from cabal file -packageFlags :: MonadIO m => Query m [(String, Bool)] - --- | Flag assignments from setup-config -configFlags :: MonadIO m => Query m [(String, Bool)] - --- | Flag assignments from setup-config which differ from the default --- setting. This can also include flags which cabal decided to modify, --- i.e. don't rely on these being the flags set by the user directly. -nonDefaultConfigFlags :: MonadIO m => Query m [(String, Bool)] - --- | The version of GHC the project is configured to use -compilerVersion :: MonadIO m => Query m (String, Version) - --- | Package identifier, i.e. package name and version -packageId :: MonadIO m => Query m (String, Version) - --- | Run a ComponentQuery on all components of the package. -components :: Monad m => ComponentQuery m (ChComponentName -> b) -> Query m [b] -components (ComponentQuery sc) = map (\(cn, f) -> f cn) `liftM` sc - --- | Modules or files Cabal would have the compiler build directly. Can be used --- to compute the home module closure for a component. -entrypoints :: MonadIO m => ComponentQuery m ChEntrypoint - --- | The component has a non-default module renaming, so needs build output (). -needsBuildOutput :: MonadIO m => ComponentQuery m NeedsBuildOutput - --- | A component's @source-dirs@ field, beware since if this is empty implicit --- behaviour in GHC kicks in. -sourceDirs :: MonadIO m => ComponentQuery m [FilePath] - --- | All options Cabal would pass to GHC. -ghcOptions :: MonadIO m => ComponentQuery m [String] - --- | Only search path related GHC options. -ghcSrcOptions :: MonadIO m => ComponentQuery m [String] - --- | Only package related GHC options, sufficient for things don't need to --- access any home modules. -ghcPkgOptions :: MonadIO m => ComponentQuery m [String] - --- | Only language related options, i.e. @-XSomeExtension@ -ghcLangOptions :: MonadIO m => ComponentQuery m [String] - -packageId = Query $ getPackageId -packageDbStack = Query $ slbiPackageDbStack `liftM` getSlbi -packageFlags = Query $ slbiPackageFlags `liftM` getSlbi -compilerVersion = Query $ slbiCompilerVersion `liftM` getSlbi -ghcMergedPkgOptions = Query $ slbiGhcMergedPkgOptions `liftM` getSlbi -configFlags = Query $ slbiConfigFlags `liftM` getSlbi -nonDefaultConfigFlags = Query $ slbiNonDefaultConfigFlags `liftM` getSlbi - -ghcSrcOptions = ComponentQuery $ Query $ slbiGhcSrcOptions `liftM` getSlbi -ghcPkgOptions = ComponentQuery $ Query $ slbiGhcPkgOptions `liftM` getSlbi -ghcOptions = ComponentQuery $ Query $ slbiGhcOptions `liftM` getSlbi -ghcLangOptions = ComponentQuery $ Query $ slbiGhcLangOptions `liftM` getSlbi -sourceDirs = ComponentQuery $ Query $ slbiSourceDirs `liftM` getSlbi -entrypoints = ComponentQuery $ Query $ slbiEntrypoints `liftM` getSlbi -needsBuildOutput = ComponentQuery $ Query $ slbiNeedsBuildOutput `liftM` getSlbi - --- | Run @cabal configure@ -reconfigure :: MonadIO m - => (FilePath -> [String] -> String -> IO String) - -> Programs -- ^ Program paths - -> [String] -- ^ Command line arguments to be passed to @cabal@ - -> m () -reconfigure readProc progs cabalOpts = do - let progOpts = - [ "--with-ghc=" ++ ghcProgram progs ] - -- Only pass ghc-pkg if it was actually set otherwise we - -- might break cabal's guessing logic - ++ if ghcPkgProgram progs /= "ghc-pkg" - then [ "--with-ghc-pkg=" ++ ghcPkgProgram progs ] - else [] - ++ cabalOpts - _ <- liftIO $ readProc (cabalProgram progs) ("configure":progOpts) "" - return () - -readHelper :: (MonadIO m, MonadQuery m) => [String] -> m [Maybe ChResponse] -readHelper args = ask >>= \qe -> liftIO $ do - out <- either error id <$> invokeHelper qe args - let res = read out - liftIO $ evaluate res `E.catch` \se@(SomeException _) -> do - md <- lookupEnv' "CABAL_HELPER_DEBUG" - let msg = "readHelper: exception: '" ++ show se ++ "'" - error $ msg ++ case md of - Nothing -> ", for more information set the environment variable CABAL_HELPER_DEBUG" - Just _ -> ", output: '"++ out ++"'" - -invokeHelper :: QueryEnv -> [String] -> IO (Either String String) -invokeHelper QueryEnv {..} args = do - let progArgs = [ "--with-ghc=" ++ ghcProgram qePrograms - , "--with-ghc-pkg=" ++ ghcPkgProgram qePrograms - , "--with-cabal=" ++ cabalProgram qePrograms - ] - exe <- findLibexecExe - let args' = progArgs ++ "v1-style":qeProjectDir:qeDistDir:args - out <- qeReadProcess exe args' "" - (Right <$> evaluate out) `E.catch` \(SomeException _) -> - return $ Left $ concat - ["invokeHelper", ": ", exe, " " - , intercalate " " (map show args') - , " failed" - ] - -getPackageId :: MonadQuery m => m (String, Version) -getPackageId = ask >>= \QueryEnv {..} -> do - pkgId <- readHelper [ "package-id" ] - case pkgId of - [ Just (ChResponseVersion pkgName pkgVer) ] -> return (pkgName, pkgVer) - _ -> error "getPackageId: unexpected response" - -getSomeConfigState :: MonadQuery m => m SomeLocalBuildInfo -getSomeConfigState = ask >>= \QueryEnv {..} -> do - res <- readHelper - [ "package-db-stack" - , "flags" - , "compiler-version" - - , "ghc-merged-pkg-options" - - , "config-flags" - , "non-default-config-flags" - - , "ghc-src-options" - , "ghc-pkg-options" - , "ghc-lang-options" - , "ghc-options" - - , "source-dirs" - , "entrypoints" - , "needs-build-output" - ] - let [ Just (ChResponsePkgDbs slbiPackageDbStack), - Just (ChResponseFlags slbiPackageFlags), - Just (ChResponseVersion comp compVer), - - Just (ChResponseList slbiGhcMergedPkgOptions), - - Just (ChResponseFlags slbiConfigFlags), - Just (ChResponseFlags slbiNonDefaultConfigFlags), - - Just (ChResponseCompList slbiGhcSrcOptions), - Just (ChResponseCompList slbiGhcPkgOptions), - Just (ChResponseCompList slbiGhcLangOptions), - Just (ChResponseCompList slbiGhcOptions), - - Just (ChResponseCompList slbiSourceDirs), - Just (ChResponseEntrypoints slbiEntrypoints), - Just (ChResponseNeedsBuild slbiNeedsBuildOutput) - ] = res - slbiCompilerVersion = (comp, compVer) - return $ SomeLocalBuildInfo {..} - - --- | Make sure the appropriate helper executable for the given project is --- installed and ready to run queries. -prepare :: MonadIO m => QueryEnv -> m () -prepare qe = - liftIO $ void $ invokeHelper qe [] - --- | Create @cabal_macros.h@ and @Paths_\@ possibly other generated files --- in the usual place. -writeAutogenFiles :: MonadIO m => QueryEnv -> m () -writeAutogenFiles qe = - liftIO $ void $ invokeHelper qe ["write-autogen-files"] - --- | Get the path to the sandbox package-db in a project -getSandboxPkgDb :: (FilePath -> [String] -> String -> IO String) - -> String - -- ^ Cabal build platform, i.e. @buildPlatform@ - -> Version - -- ^ GHC version (@cProjectVersion@ is your friend) - -> IO (Maybe FilePath) -getSandboxPkgDb readProc = - CabalHelper.Shared.Sandbox.getSandboxPkgDb $ unsafePerformIO $ buildPlatform readProc - -buildPlatform :: (FilePath -> [String] -> String -> IO String) -> IO String -buildPlatform readProc = do - exe <- findLibexecExe - CabalHelper.Shared.Sandbox.dropWhileEnd isSpace <$> readProc exe ["print-build-platform"] "" - --- | This exception is thrown by all 'runQuery' functions if the internal --- wrapper executable cannot be found. You may catch this and present the user --- an appropriate error message however the default is to print --- 'libexecNotFoundError'. -data LibexecNotFoundError = LibexecNotFoundError String FilePath - deriving (Typeable) -instance Exception LibexecNotFoundError -instance Show LibexecNotFoundError where - show (LibexecNotFoundError exe dir) = - libexecNotFoundError exe dir "https://github.com/DanielG/cabal-helper/issues" - -findLibexecExe :: IO FilePath -findLibexecExe = do - libexecdir <- getLibexecDir - let exeName = "cabal-helper-wrapper" - exe = libexecdir exeName FP.<.> exeExtension' - - exists <- doesFileExist exe - - if exists - then return exe - else do - mdir <- tryFindCabalHelperTreeDistDir - dir <- case mdir of - Nothing -> - throwIO $ LibexecNotFoundError exeName libexecdir - Just dir -> - return dir - - return $ dir "build" exeName exeName - -findPlanJson :: FilePath -> IO (Maybe FilePath) -findPlanJson base = - findFile (map ( "cache") $ parents base) "plan.json" - -parents :: FilePath -> [FilePath] -parents path = takeWhile (not . (`elem` ["", "."]) . dropDrive) dirs - where dirs = iterate takeDirectory path - -data DistDir = DistDir { ddType :: DistDirType, unDistDir :: FilePath } - deriving (Eq, Ord, Read, Show) -data DistDirType = NewBuildDist | OldBuildDist - deriving (Eq, Ord, Read, Show) - -tryFindCabalHelperTreeDistDir :: IO (Maybe FilePath) -tryFindCabalHelperTreeDistDir = do - exe <- canonicalizePath =<< getExecutablePath' - mplan <- findPlanJson exe - let mdistdir = takeDirectory . takeDirectory <$> mplan - cwd <- getCurrentDirectory - - let candidates = sortBy (compare `on` ddType) $ concat - [ maybeToList $ DistDir NewBuildDist <$> mdistdir - , [ DistDir OldBuildDist $ (!!3) $ iterate takeDirectory exe ] - , if takeFileName exe == "ghc" -- we're probably in ghci; try CWD - then [ DistDir NewBuildDist $ cwd "dist-newstyle" - , DistDir NewBuildDist $ cwd "dist" - , DistDir OldBuildDist $ cwd "dist" - ] - else [] - ] - - distdirs - <- filterM isDistDir candidates - >>= mapM toOldBuildDistDir - - return $ fmap unDistDir $ join $ listToMaybe $ distdirs - -isCabalHelperSourceDir :: FilePath -> IO Bool -isCabalHelperSourceDir dir = - doesFileExist $ dir "cabal-helper.cabal" - -isDistDir :: DistDir -> IO Bool -isDistDir (DistDir NewBuildDist dir) = - doesFileExist (dir "cache" "plan.json") -isDistDir (DistDir OldBuildDist dir) = - doesFileExist (dir "setup-config") - -toOldBuildDistDir :: DistDir -> IO (Maybe DistDir) -toOldBuildDistDir (DistDir NewBuildDist dir) = do - PlanJson {pjUnits} <- decodePlanJson $ dir "cache" "plan.json" - let munit = find isCabalHelperUnit $ Map.elems pjUnits - return $ DistDir OldBuildDist <$> join ((\Unit { uDistDir = mdistdir } -> mdistdir) <$> munit) - where - isCabalHelperUnit - Unit { uPId = PkgId (PkgName n) _ - , uType = UnitTypeLocal - , uComps - } | n == "cabal-helper" && - Map.member (CompNameExe "cabal-helper-wrapper") uComps - = True - isCabalHelperUnit _ = False -toOldBuildDistDir x = return $ Just x - - - - -libexecNotFoundError :: String -- ^ Name of the executable we were trying to - -- find - -> FilePath -- ^ Path to @$libexecdir@ - -> String -- ^ URL the user will be directed towards to - -- report a bug. - -> String -libexecNotFoundError exe dir reportBug = printf - ( "Could not find $libexecdir/%s\n" - ++"\n" - ++"If you are a cabal-helper developer you can set the environment variable\n" - ++"`cabal_helper_libexecdir' to override $libexecdir[1]. The following will\n" - ++"work in the cabal-helper source tree:\n" - ++"\n" - ++" $ export cabal_helper_libexecdir=$PWD/dist/build/%s\n" - ++"\n" - ++"[1]: %s\n" - ++"\n" - ++"If you don't know what I'm talking about something went wrong with your\n" - ++"installation. Please report this problem here:\n" - ++"\n" - ++" %s") exe exe dir reportBug - -getExecutablePath' :: IO FilePath -getExecutablePath' = -#if MIN_VERSION_base(4,6,0) - getExecutablePath -#else - getProgName -#endif - -lookupEnv' :: String -> IO (Maybe String) -lookupEnv' k = lookup k <$> getEnvironment - -exeExtension' :: FilePath -exeExtension' - | Windows <- buildOS = "exe" - | otherwise = "" +-- Copyright (C) 2015-2019 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-# LANGUAGE RecordWildCards, FlexibleContexts, ConstraintKinds, + GeneralizedNewtypeDeriving, DeriveDataTypeable, DeriveGeneric, DeriveFunctor, + StandaloneDeriving, NamedFieldPuns, OverloadedStrings, ViewPatterns, + TupleSections, TypeFamilies, DataKinds, GADTs, ScopedTypeVariables, + ImplicitParams, RankNTypes, MultiWayIf #-} + +{-# OPTIONS_GHC -fno-warn-name-shadowing #-} + +{-| +Module : Distribution.Helper +License : Apache-2.0 +Maintainer : cabal-helper@dxld.at +Portability : POSIX +-} + +module Distribution.Helper ( + -- * Type Variable Naming Conventions + -- $type-conventions + + -- * Running Queries + Query + , runQuery + + -- * Queries against Cabal\'s on disk state + + -- ** Project queries + , compilerVersion + , projectPackages + + -- ** 'Package' queries + , Package -- abstract + , pPackageName + , pSourceDir + , pUnits + + -- ** 'Unit' queries + , Unit -- abstract + , uComponentName + , UnitId -- abstract + , UnitInfo(..) + , unitInfo + + -- ** Convenience Queries + , allUnits + + -- * Query environment + , QueryEnv + , QueryEnvI -- abstract + , mkQueryEnv + , qeReadProcess + , qeCallProcess + , qePrograms + , qeProjLoc + , qeDistDir + + -- * GADTs + , ProjType(..) + , CabalProjType(..) + , ProjLoc(..) + , DistDir(..) + , SProjType(..) + , demoteSProjType + , projTypeOfDistDir + , projTypeOfProjLoc + , SCabalProjType(..) + , Ex(..) + + -- * Programs + , Programs(..) + , defaultPrograms + , EnvOverride(..) + + -- * Query result types + , ChComponentInfo(..) + , ChComponentName(..) + , ChLibraryName(..) + , ChModuleName(..) + , ChPkgDb(..) + , ChEntrypoint(..) + + -- * General information + , Distribution.Helper.buildPlatform + + -- * Legacy v1-build helpers + , Distribution.Helper.getSandboxPkgDb + + -- * Build actions + , prepare + , writeAutogenFiles + , buildProject + , buildUnits + ) where + +import Cabal.Plan hiding (Unit, UnitId, uDistDir) +import Control.Applicative +import Control.Monad +import Control.Monad.Trans.Maybe +import Control.Monad.IO.Class +import Control.Exception as E +import qualified Data.ByteString.Char8 as BS8 +import qualified Data.ByteString.UTF8 as BSU +import Data.IORef +import Data.List hiding (filter) +import Data.String +import qualified Data.Text as Text +import Data.Maybe +import Data.Either +import Data.Map.Strict (Map) +import qualified Data.Map.Strict as Map +import Data.Set (Set) +import qualified Data.Set as Set +import qualified Data.Traversable as T +import Data.List.NonEmpty (NonEmpty(..)) +import qualified Data.List.NonEmpty as NonEmpty +import Data.Version +import Data.Function +import System.Clock as Clock +import System.IO +import System.Environment +import System.FilePath +import System.Directory +import System.Process +import System.Posix.Types +import System.PosixCompat.Files +import Text.Printf +import Text.Read +import Prelude + +import CabalHelper.Compiletime.Compile +import qualified CabalHelper.Compiletime.Program.Stack as Stack +import qualified CabalHelper.Compiletime.Program.GHC as GHC +import qualified CabalHelper.Compiletime.Program.CabalInstall as CabalInstall +import CabalHelper.Compiletime.Cabal +import CabalHelper.Compiletime.CompPrograms +import CabalHelper.Compiletime.Log +import CabalHelper.Compiletime.Process +import CabalHelper.Compiletime.Sandbox +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.Types.RelativePath +import CabalHelper.Shared.InterfaceTypes +import CabalHelper.Shared.Common +import CabalHelper.Runtime.HelperMain (helper_main) + +import CabalHelper.Compiletime.Compat.Version + +import Distribution.System (buildPlatform) +import Distribution.Text (display) + +-- $type-conventions +-- Throughout the API we use the following conventions for type variables: +-- +-- * @pt@ stands for "project type", when instantiated it is always of kind +-- 'ProjType'. +-- +-- * @c@ stands for "cache". It is used internally to make the cache +-- inaccessible for some parts of the implementation. Users of the API may +-- completely ignore this parameter. See the internal 'qeCacheRef' field +-- accessor of 'QueryEnv' for details. + + +-- | A query against a package's Cabal configuration. Use 'runQuery' to +-- execute it. +newtype Query pt a = Query + { unQuery :: QueryEnv pt -> IO a + -- ^ @runQuery env query@. Run a 'Query' under a given 'QueryEnv. + } + +instance Functor (Query pt) where + fmap = liftM + +instance Applicative (Query pt) where + (<*>) = ap + pure = return + +instance Monad (Query pt) where + (Query ma) >>= amb = Query $ \qe -> ma qe >>= \a -> unQuery (amb a) qe + return a = Query $ const $ return a + +runQuery :: Query pt a -> QueryEnv pt -> IO a +runQuery (Query action) qe = do + ckr <- newIORef $ CacheKeyCache Nothing + let qe' = qe { qeCacheKeys = ckr } + conf_progs <- getConfProgs qe' + action qe' { qePrograms = conf_progs } + +-- | @mkQueryEnv projdir distdir@. Smart constructor for 'QueryEnv'. +-- Sets fields 'qeProjLoc' and 'qeDistDir' to @projdir@ and @distdir@ +-- respectively and provides sensible defaults for the other fields. +mkQueryEnv + :: ProjLoc pt + -- ^ Location of the project. + -> DistDir pt + -- ^ Path to the @dist/@ or @dist-newstyle/@ directory, called + -- /builddir/ in Cabal terminology. + -> IO (QueryEnv pt) +mkQueryEnv projloc distdir = do + cr <- newIORef $ QueryCache Nothing Nothing Nothing Map.empty + return $ QueryEnv + { qeReadProcess = \stdin mcwd env exe args -> do + withVerbosity $ readProcessStderr mcwd env exe args "" + , qeCallProcess = \mcwd env exe args -> + withVerbosity $ callProcessStderr mcwd env exe args + , qePrograms = defaultPrograms + , qeProjLoc = projloc + , qeDistDir = distdir + , qeCacheRef = cr + , qeCacheKeys = error "mkQuery: qeCacheKeys is uninitialized!" + } + +-- | Construct paths to project configuration files given where the project is. +projConf :: ProjLoc pt -> IO (ProjConf pt) +projConf (ProjLocV1Dir pkgdir) = + ProjConfV1 <$> (complainIfNoCabalFile pkgdir =<< findCabalFile pkgdir) +projConf (ProjLocV1CabalFile cabal_file _) = return $ + ProjConfV1 cabal_file +projConf (ProjLocV2Dir projdir_path) = + projConf $ ProjLocV2File (projdir_path "cabal.project") projdir_path +projConf (ProjLocV2File proj_file _) = return $ + ProjConfV2 + { pcV2CabalProjFile = proj_file + , pcV2CabalProjLocalFile = proj_file <.> "local" + , pcV2CabalProjFreezeFile = proj_file <.> "freeze" + } +projConf (ProjLocStackYaml stack_yaml) = return $ + ProjConfStack + { pcStackYaml = stack_yaml } + +-- | Get the current modification-time for each file involved in configuring a +-- project. Optional files in 'ProjConf' are handled by not including them in +-- the result list in 'ProjConfModTimes' if they don\'t exist. This causes the +-- lists to be different if the files end up existing later, which is all we +-- need for cache invalidation. +getProjConfModTime :: ProjConf pt -> IO ProjConfModTimes +getProjConfModTime ProjConfV1{pcV1CabalFile} = + fmap ProjConfModTimes $ mapM getFileModTime + [ pcV1CabalFile + ] +getProjConfModTime ProjConfV2{..} = do + fmap (ProjConfModTimes . catMaybes) $ + mapM (traverse getFileModTime <=< mightExist) + [ pcV2CabalProjFile + , pcV2CabalProjLocalFile + , pcV2CabalProjFreezeFile + ] +getProjConfModTime ProjConfStack{..} = + fmap ProjConfModTimes $ mapM getFileModTime + [ pcStackYaml + ] + +getUnitModTimes :: Unit pt -> IO UnitModTimes +getUnitModTimes + Unit + { uDistDir=DistDirLib distdirv1 + , uPackage=Package + { pCabalFile=CabalFile cabal_file_path + , pSourceDir + } + , uImpl + } + = do + umtPkgYaml <- + case uImpl of + UnitImplStack{} + -> traverse getFileModTime =<< mightExist package_yaml_path + _ -> return Nothing + umtCabalFile <- getFileModTime cabal_file_path + umtSetupConfig <- (traverse getFileModTime <=< mightExist) setup_config_path + return UnitModTimes {..} + where + package_yaml_path = pSourceDir "package.yaml" + setup_config_path = distdirv1 "setup-config" + + +-- | The version of GHC the project is configured to use for compilation. +compilerVersion :: Query pt (String, Version) +compilerVersion = Query $ \qe -> + getProjInfo qe >>= \proj_info -> + let someUnit = NonEmpty.head $ pUnits $ + NonEmpty.head $ piPackages proj_info in + -- ^ ASSUMPTION: Here we assume the compiler version is uniform across all + -- units so we just pick any one. + case piImpl proj_info of + ProjInfoV1 {} -> uiCompilerId <$> getUnitInfo qe someUnit + ProjInfoV2 { piV2CompilerId } -> return piV2CompilerId + ProjInfoStack {} -> uiCompilerId <$> getUnitInfo qe someUnit + +-- | All local packages currently active in a project\'s build plan. +projectPackages :: Query pt (NonEmpty (Package pt)) +projectPackages = Query $ \qe -> piPackages <$> getProjInfo qe + +-- | Get the 'UnitInfo' for a given 'Unit'. To get a 'Unit' see 'projectUnits'. +unitInfo :: Unit pt -> Query pt UnitInfo +unitInfo u = Query $ \qe -> getUnitInfo qe u + +-- | Get information on all units in a project. +allUnits :: (UnitInfo -> a) -> Query pt (NonEmpty a) +allUnits f = do + fmap f <$> (T.mapM unitInfo =<< join . fmap pUnits <$> projectPackages) + + +data Cached c ckc k v = Cached + { cGet :: !(c -> Maybe (k, v)) + , cSet :: !(c -> (k, v) -> c) + + , cGetKey :: !(ckc -> Maybe k) + , cSetKey :: !(ckc -> k -> ckc) + + , cCheckKey :: !(IO k) + , cKeyValid :: !(k -> k -> Bool) + -- ^ @cKeyValid old new@ should return 'True' if 'old' is still valid + -- relative to the value of 'new'. + + , cRegen :: !(k -> IO v) + } + +-- | Simple caching scheme. Invalidation is based on equality of a "cache +-- key" the current value of which can be got with the IO action 'cGetKey'. +-- +-- Note that we only check the actual value of the cache key once per +-- 'runQuery' call by saving the cache key in an ephemeral map. +cached :: QueryEnvI (QueryCacheI a b c d) pt + -> Cached (QueryCacheI a b c d pt) (CacheKeyCache pt) k v + -> IO v +cached qe Cached{..} = do + c <- readIORef (qeCacheRef qe) + (c', v) <- checkUpdate c (cGet c) + writeIORef (qeCacheRef qe) c' + return v + where + checkUpdate c m = do + ckc <- readIORef (qeCacheKeys qe) + let regen ck = (ck,) <$> cRegen ck + n <- case m of + Nothing -> do + ck <- cCheckKey + writeIORef (qeCacheKeys qe) (cSetKey ckc ck) + regen ck + Just old@(old_ck, old_v) -> do + ck <- case cGetKey ckc of + Just cck -> + return cck -- TODO: skip valid check below in this case + Nothing -> do + ck <- cCheckKey + writeIORef (qeCacheKeys qe) (cSetKey ckc ck) + return ck + if + | cKeyValid old_ck ck -> return old + | otherwise -> regen ck + return (cSet c n, snd n) + +getProjConfAndModTime :: QueryEnvI c pt -> IO (ProjConf pt, ProjConfModTimes) +getProjConfAndModTime qe = do + proj_conf <- projConf (qeProjLoc qe) + mtime <- getProjConfModTime proj_conf + return (proj_conf, mtime) + +getPreInfo :: QueryEnvI (QCPreInfo a b c) pt -> IO (PreInfo pt) +getPreInfo qe = + cached qe $ Cached + { cGet = qcPreInfo + , cSet = \a b -> a { qcPreInfo = Just b } + , cGetKey = ckcProjConf + , cSetKey = \a b -> a { ckcProjConf = Just b } + , cCheckKey = getProjConfAndModTime qe + , cKeyValid = (==) `on` snd + , cRegen = \_k -> readPreInfo qe + } + +readPreInfo :: QueryEnvI c pt -> IO (PreInfo pt) +readPreInfo qe = do + case projTypeOfQueryEnv qe of + SStack -> do + piStackProjPaths <- Stack.projPaths qe + return PreInfoStack + { piStackProjPaths + } + (SCabal _) -> + return PreInfoCabal + +getProjInfo :: QueryEnv pt -> IO (ProjInfo pt) +getProjInfo qe = do + pre_info <- getPreInfo qe + cached qe $ Cached + { cGet = qcProjInfo + , cSet = \c n@(_, proj_info) -> + let active_units = NonEmpty.toList $ join $ + fmap pUnits $ piPackages proj_info in + c { qcProjInfo = Just n + , qcUnitInfos = + discardInactiveUnitInfos active_units (qcUnitInfos c) + } + , cGetKey = ckcProjConf + , cSetKey = \a b -> a { ckcProjConf = Just b } + , cCheckKey = getProjConfAndModTime qe + , cKeyValid = (==) `on` snd + , cRegen = \(proj_conf, mtime) -> do + shallowReconfigureProject qe + readProjInfo qe proj_conf mtime pre_info + } + +getUnitInfo :: QueryEnv pt -> Unit pt -> IO UnitInfo +getUnitInfo qe@QueryEnv{..} unit@Unit{uDistDir} = do + pre_info <- getPreInfo qe + proj_info <- getProjInfo qe + cached qe $ Cached + { cGet = \c -> do + ui <- Map.lookup uDistDir (qcUnitInfos c) + return (uiModTimes ui, ui) + , cSet = \c (_mtimes, unit_info) -> c { qcUnitInfos = + Map.insert uDistDir unit_info (qcUnitInfos c) } + + , cGetKey = const Nothing + , cSetKey = const + , cCheckKey = getUnitModTimes unit + , cKeyValid = (==) + + , cRegen = \mtimes -> do + reconfigureUnit qe unit + helper <- getHelper pre_info proj_info qe + readUnitInfo helper unit mtimes + } + +-- | Restrict 'UnitInfo' cache to units that are still active +discardInactiveUnitInfos + :: [Unit pt] + -> Map DistDirLib UnitInfo + -> Map DistDirLib UnitInfo +discardInactiveUnitInfos active_units uis0 = + restrictKeysMap uis0 $ Set.fromList $ map uDistDir active_units + where + restrictKeysMap :: Ord k => Map k a -> Set k -> Map k a + restrictKeysMap m s = Map.filterWithKey (\k _ -> Set.member k s) m + + +-- | Regenerate project-level information by calling the appropriate build +-- system. +shallowReconfigureProject :: QueryEnvI (QCProgs a b) pt -> IO () +shallowReconfigureProject QueryEnv + { qeProjLoc = ProjLocStackYaml _stack_yaml, .. } = do + -- Stack's dry-run only generates the cabal file from package.yaml (or + -- well that's the only thing we would care about). reconfigureUnit + -- will take care of this though and we don't need the cabal files + -- before the Unit stage anyways. + return () +shallowReconfigureProject qe = do + buildProjectTarget qe Nothing DryRun + +reconfigureUnit :: QueryEnvI c pt -> Unit pt -> IO () +reconfigureUnit qe u = buildProjectTarget qe (Just u) OnlyCfg + +buildUnits :: [Unit pt] -> Query pt () +buildUnits units = Query $ \qe -> do + conf_progs <- getConfProgs qe + forM_ units $ \u -> + buildProjectTarget qe { qePrograms = conf_progs } (Just u) DoBuild + +buildProject :: Query pt () +buildProject = Query $ \qe -> do + conf_progs <- getConfProgs qe + buildProjectTarget qe { qePrograms = conf_progs } Nothing DoBuild + +data BuildStage = DryRun | OnlyCfg | DoBuild + +buildProjectTarget + :: QueryEnvI c pt -> Maybe (Unit pt) -> BuildStage -> IO () +buildProjectTarget qe mu stage = do + -- Stack and cabal just happen to have the same stage options, totally by + -- accident :) + stage_opts :: [String] <- return $ case stage of + DryRun -> ["--dry-run"] + OnlyCfg -> ["--only-configure"] + DoBuild -> [] + -- TODO: version check for cabal's --only-configure + case qe of + QueryEnv { qeDistDir = DistDirCabal cpt distdir, qeProjLoc } -> do + let projdir = plCabalProjectDir qeProjLoc + cmd <- return $ case stage of + DryRun | SCV1 <- cpt -> + CabalInstall.CIConfigure + OnlyCfg -> + CabalInstall.CIConfigure + _ -> + CabalInstall.CIBuild + CabalInstall.callCabalInstallCmd qe (Just projdir) cmd $ + case cpt of + SCV1 -> + [ "--builddir="++distdir ] + SCV2 -> do + targets <- return $ case mu of + Nothing -> ["all"] + Just Unit{uImpl} -> concat + [ if uiV2OnlyDependencies uImpl + then ["--only-dependencies"] else [] + , uiV2Components uImpl + ] + case qeProjLoc of + ProjLocV2File {plCabalProjectFile} -> + [ "--project-file="++plCabalProjectFile + , "--builddir="++distdir + ] ++ stage_opts ++ targets + ProjLocV2Dir {} -> + [ "--builddir="++distdir + ] ++ stage_opts ++ targets + + QueryEnv { qeDistDir = DistDirStack mworkdir + , qeProjLoc = qeProjLoc@ProjLocStackYaml {plStackYaml} + } -> do + let projdir = plStackProjectDir qeProjLoc + let workdir_opts = Stack.workdirArg qe + case mu of + Just Unit{uPackage=Package{pSourceDir}} -> + Stack.callStackCmd qe (Just pSourceDir) $ + workdir_opts ++ + [ "--stack-yaml="++plStackYaml, "build", "." + ] ++ stage_opts + Nothing -> + Stack.callStackCmd qe (Just projdir) $ + workdir_opts ++ + [ "--stack-yaml="++plStackYaml, "build" + ] ++ stage_opts + +getFileModTime :: FilePath -> IO (FilePath, EpochTime) +getFileModTime f = do + t <- modificationTime <$> getFileStatus f + return (f, t) + +readProjInfo + :: QueryEnvI c pt -> ProjConf pt -> ProjConfModTimes -> PreInfo pt -> IO (ProjInfo pt) +readProjInfo qe pc pcm pi = withVerbosity $ do + let projloc = qeProjLoc qe + case (qeDistDir qe, pc) of + (DistDirCabal SCV1 distdir, ProjConfV1{pcV1CabalFile}) -> do + setup_config_path <- canonicalizePath (distdir "setup-config") + mhdr <- readSetupConfigHeader setup_config_path + case mhdr of + Just hdr@(UnitHeader (pkg_name_bs, _pkg_ver) ("Cabal", hdrCabalVersion) _compId) -> do + let + v3_0_0_0 = makeVersion [3,0,0,0] + pkg_name + | hdrCabalVersion >= v3_0_0_0 = BSU.toString pkg_name_bs + | otherwise = BS8.unpack pkg_name_bs + pkg = Package + { pPackageName = pkg_name + , pSourceDir = plCabalProjectDir projloc + , pCabalFile = CabalFile pcV1CabalFile + , pFlags = [] + , pUnits = (:|[]) Unit + { uUnitId = UnitId pkg_name + , uPackage = pkg { pUnits = () } + , uDistDir = DistDirLib distdir + , uImpl = UnitImplV1 + } + } + piImpl = ProjInfoV1 { piV1SetupHeader = hdr } + return ProjInfo + { piCabalVersion = hdrCabalVersion + , piProjConfModTimes = pcm + , piPackages = pkg :| [] + , piImpl + } + Just UnitHeader {uhSetupId=(setup_name, _)} -> + panicIO $ printf "Unknown Setup package-id in setup-config header '%s': '%s'" + (BS8.unpack setup_name) setup_config_path + Nothing -> + panicIO $ printf "Could not read '%s' header" setup_config_path + + (DistDirCabal SCV2 distdirv2, _) -> do + let plan_path = distdirv2 "cache" "plan.json" + plan_mtime <- modificationTime <$> getFileStatus plan_path + plan@PlanJson { pjCabalLibVersion=Ver pjCabalLibVersion + , pjCabalVersion + , pjCompilerId=PkgId (PkgName compName) (Ver compVer) + } + <- decodePlanJson plan_path + when (pjCabalVersion < Ver [2,4,1,0]) $ + panicIO $ "plan.json was produced by too-old a version of\ + \cabal-install. The 'dist-dir' keys will be missing. \ + \Please upgrade to at least cabal-instal-2.4.1.0" + + Just pkgs <- NonEmpty.nonEmpty <$> CabalInstall.planPackages plan + return ProjInfo + { piCabalVersion = makeDataVersion pjCabalLibVersion + , piProjConfModTimes = pcm + , piPackages = NonEmpty.sortWith pPackageName pkgs + , piImpl = ProjInfoV2 + { piV2Plan = plan + , piV2PlanModTime = plan_mtime + , piV2CompilerId = (Text.unpack compName, makeDataVersion compVer) + } + } + (DistDirStack{}, _) -> do + Just cabal_files <- NonEmpty.nonEmpty <$> Stack.listPackageCabalFiles qe + pkgs <- mapM (Stack.getPackage qe) cabal_files + Just (cabalVer:_) <- runMaybeT $ + let ?progs = qePrograms qe in + let PreInfoStack {piStackProjPaths} = pi in + GHC.listCabalVersions (Just (sppGlobalPkgDb piStackProjPaths)) + -- ^ See [Note Stack Cabal Version] + return ProjInfo + { piCabalVersion = cabalVer + , piProjConfModTimes = pcm + , piPackages = NonEmpty.sortWith pPackageName pkgs + , piImpl = ProjInfoStack + } + +-- [Note Stack Cabal Version] +-- +-- Stack just uses ghc-pkg on the global-pkg-db to determine the +-- appropriate Cabal version for a resolver when building, see +-- Stack.Setup.pathsFromCompiler(cabalPkgVer). We do essentially the same +-- thing here. +-- +-- The code for building Setup.hs is in Stack.Build.Execute and the version +-- of cabal is set in withSingleContext.withCabal.getPackageArgs. +-- +-- Note there is some special casing going on (see 'depsMinusCabal'), they +-- use the packages from the snapshot pkg-db except Cabal which comes from +-- the global pkg-db. + +readUnitInfo :: Helper pt -> Unit pt -> UnitModTimes -> IO UnitInfo +readUnitInfo helper unit@Unit {uUnitId=uiUnitId} uiModTimes = do + res <- runHelper helper unit + [ "package-id" + , "compiler-id" + , "flags" + , "config-flags" + , "non-default-config-flags" + , "component-info" + ] + let [ Just (ChResponseVersion uiPackageId), + Just (ChResponseVersion uiCompilerId), + Just (ChResponseFlags uiPackageFlags), + Just (ChResponseFlags uiConfigFlags), + Just (ChResponseFlags uiNonDefaultConfigFlags), + Just (ChResponseComponentsInfo uiComponents) + ] = res + return $ UnitInfo {..} + +readHelper + :: QueryEnvI c pt + -> FilePath + -> CabalFile + -> DistDirLib + -> [String] + -> IO [Maybe ChResponse] +readHelper qe exe cabal_file distdir args = do + out <- invokeHelper qe exe cabal_file distdir args + let res :: [Maybe ChResponse] + res = read out + liftIO $ evaluate res `E.catch` \ex@ErrorCall{} -> do + md <- lookupEnv' "CABAL_HELPER_DEBUG" + let msg = "readHelper: exception: '" ++ show ex ++ "'" + panicIO $ msg ++ case md of + Nothing -> "\n for more information set the environment variable CABAL_HELPER_DEBUG and try again" + Just _ -> "\n output:\n'"++ out ++"'" + +invokeHelper + :: QueryEnvI c pt + -> FilePath + -> CabalFile + -> DistDirLib + -> [String] + -> IO String +invokeHelper + QueryEnv {..} + exe + (CabalFile cabal_file_path) + (DistDirLib distdir) + args0 + = do + let args1 = cabal_file_path : distdir : args0 + evaluate =<< qeReadProcess "" Nothing [] exe args1 `E.catch` + \(_ :: E.IOException) -> + panicIO $ concat + ["invokeHelper", ": ", exe, " " + , intercalate " " (map show args1) + , " failed!" + ] + +-- | Make sure the appropriate helper executable for the given project is +-- installed and ready to run queries. +-- +-- The idea is you can run this at a convinient time instead of having the +-- helper compilation happen during a time-sensitive user interaction. This +-- will however happen automatically as needed if you don't run it first. +prepare :: Query pt () +prepare = Query $ \qe -> do + pre_info <- getPreInfo qe + proj_info <- getProjInfo qe + void $ getHelper pre_info proj_info qe + +-- | Create @cabal_macros.h@, @Paths_\.hs@ and other generated files +-- in the usual place. See 'Distribution.Simple.Build.initialBuildSteps'. +-- +-- This is usually only needed on the first load of a unit or after the +-- cabal file changes. +writeAutogenFiles :: Unit pt -> Query pt () +writeAutogenFiles unit = Query $ \qe -> do + pre_info <- getPreInfo qe + proj_info <- getProjInfo qe + helper <- getHelper pre_info proj_info qe + void $ runHelper helper unit ["write-autogen-files"] + +-- | Get the path to the sandbox package-db in a project +getSandboxPkgDb + :: String + -- ^ Cabal build platform, i.e. @buildPlatform@ + -> GHC.GhcVersion + -- ^ GHC version (@cProjectVersion@ is your friend) + -> FilePath + -- ^ Path to the project directory, i.e. a directory containing a + -- @cabal.sandbox.config@ file + -> IO (Maybe FilePath) +getSandboxPkgDb buildPlat ghcVer projdir = + CabalHelper.Compiletime.Sandbox.getSandboxPkgDb buildPlat ghcVer projdir + +buildPlatform :: String +buildPlatform = display Distribution.System.buildPlatform + +lookupEnv' :: String -> IO (Maybe String) +lookupEnv' k = lookup k <$> getEnvironment + +withVerbosity :: (Verbose => IO a) -> IO a +withVerbosity act = do + x <- lookup "CABAL_HELPER_DEBUG" <$> getEnvironment + let ?verbose = \level -> + case x >>= readMaybe of + Just x | x >= level -> True + _ -> False + act + +getConfProgs :: QueryEnvI (QCProgs a b) pt -> IO Programs +getConfProgs qe = do + pre_info <- getPreInfo qe + cached qe $ Cached + { cGet = qcConfProgs + , cSet = \a b -> a { qcConfProgs = Just b } + , cGetKey = const Nothing + , cSetKey = const + , cCheckKey = return (qePrograms qe) + , cKeyValid = (==) + , cRegen = \_k -> configurePrograms qe pre_info + } + +-- | Fixup program paths as appropriate for current project-type and bring +-- 'Programs' into scope as an implicit parameter. +configurePrograms :: QueryEnvI c pt -> PreInfo pt -> IO Programs +configurePrograms qe@QueryEnv{..} pre_info = withVerbosity $ do + patchBuildToolProgs (projTypeOfQueryEnv qe) <=< guessCompProgramPaths $ + case pre_info of + PreInfoStack projPaths -> + Stack.patchCompPrograms projPaths qePrograms + _ -> qePrograms + +newtype Helper pt + = Helper { runHelper :: Unit pt -> [String] -> IO [Maybe ChResponse] } + +getHelper :: PreInfo pt -> ProjInfo pt -> QueryEnvI c pt -> IO (Helper pt) +getHelper _pre_info ProjInfo{piCabalVersion} qe@QueryEnv{..} + | piCabalVersion == bultinCabalVersion = return $ Helper $ + \Unit{ uDistDir=DistDirLib distdir + , uPackage=Package{pCabalFile=CabalFile cabal_file} + } args -> + let pt = dispHelperProjectType (projTypeOfQueryEnv qe) in + helper_main $ cabal_file : distdir : pt : args +getHelper pre_info proj_info qe@QueryEnv{..} = do + withVerbosity $ do + let ?progs = qePrograms + t0 <- Clock.getTime Monotonic + eexe <- compileHelper $ mkCompHelperEnv qeProjLoc qeDistDir pre_info proj_info + t1 <- Clock.getTime Monotonic + let dt = (/10^9) $ fromInteger $ Clock.toNanoSecs $ Clock.diffTimeSpec t0 t1 + dt :: Float + vLog $ printf "compileHelper took %.5fs" dt + case eexe of + Left rv -> + panicIO $ "compileHelper': compiling helper failed! exit code "++ show rv + Right exe -> + let pt = dispHelperProjectType (projTypeOfQueryEnv qe) in + return $ Helper $ \Unit{uDistDir, uPackage=Package{pCabalFile}} args -> + readHelper qe exe pCabalFile uDistDir (pt : args) + +dispHelperProjectType :: SProjType pt -> String +dispHelperProjectType (SCabal SCV1) = "v1" +-- ^ v1-build needs a last minute addition of the inplace package-db +-- beyond what lbi has +dispHelperProjectType (SCabal SCV2) = "v2" +dispHelperProjectType SStack = "v2" +-- ^ stack also embeds all necessary options into lbi like v2 + +mkCompHelperEnv + :: Verbose + => ProjLoc pt + -> DistDir pt + -> PreInfo pt + -> ProjInfo pt + -> CompHelperEnv +mkCompHelperEnv + projloc + (DistDirCabal SCV1 distdir) + PreInfoCabal + ProjInfo{piCabalVersion} + = CompHelperEnv + { cheCabalVer = CabalVersion piCabalVersion + , cheProjDir = plCabalProjectDir projloc + , cheProjLocalCacheDir = distdir + , chePkgDb = Nothing + , chePlanJson = Nothing + , cheDistV2 = Nothing + } +mkCompHelperEnv + projloc + (DistDirCabal SCV2 distdir) + PreInfoCabal + ProjInfo{piImpl=ProjInfoV2{piV2Plan=plan}} + = CompHelperEnv {..} + where + cheProjDir = plCabalProjectDir projloc + cheCabalVer = CabalVersion $ makeDataVersion pjCabalLibVersion + cheProjLocalCacheDir = distdir "cache" + chePkgDb = Nothing + chePlanJson = Just plan + cheDistV2 = Just distdir + PlanJson {pjCabalLibVersion=Ver pjCabalLibVersion } = plan +mkCompHelperEnv + (ProjLocStackYaml stack_yaml) + (DistDirStack mworkdir) + PreInfoStack + { piStackProjPaths=StackProjPaths + { sppGlobalPkgDb } + } + ProjInfo { piCabalVersion } + = let workdir = fromMaybe ".stack-work" $ unRelativePath <$> mworkdir in + let projdir = takeDirectory stack_yaml in + CompHelperEnv + { cheCabalVer = CabalVersion $ piCabalVersion + , cheProjDir = projdir + , cheProjLocalCacheDir = projdir workdir + , chePkgDb = Just sppGlobalPkgDb + , chePlanJson = Nothing + , cheDistV2 = Nothing + } diff --git a/lib/Distribution/Helper/Discover.hs b/lib/Distribution/Helper/Discover.hs new file mode 100644 --- /dev/null +++ b/lib/Distribution/Helper/Discover.hs @@ -0,0 +1,96 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2019 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-# LANGUAGE GADTs, TypeFamilies, DataKinds #-} + +{-| +Module : Distribution.Helper.Discover +Description : Finding project contexts +License : Apache-2.0 +Maintainer : cabal-helper@dxld.at +Portability : portable +-} + +-- TODO: $ sed -e s/DistDir/BuildDir/ + +module Distribution.Helper.Discover + ( findProjects + , getDefaultDistDir + , isValidDistDir + ) where + +import Control.Monad.Writer +import System.Directory +import System.FilePath + +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.Cabal + +-- | @findProjects dir@. Find available project instances in @dir@. +-- +-- For example, if the given directory contains both a @cabal.project@ and +-- a @stack.yaml@ file: +-- +-- >>> findProjects "." +-- [ Ex (ProjLocStackYaml "./stack.yaml"), Ex (ProjLocCabalV2File "./cabal.project") ] +-- +-- Note that this function only looks for "default" project markers. If you +-- want to for example support the common pattern of having multiple +-- @stack-.yaml@ files simply fill out a 'ProjLoc' yourself. In +-- this case 'ProjLocStackYaml'. +findProjects :: FilePath -> IO [Ex ProjLoc] +findProjects dir = execWriterT $ do + let cabalProject = dir "cabal.project" + whenM (liftIO $ doesFileExist cabalProject) $ + tell [Ex $ ProjLocV2File cabalProject dir] + let stackYaml = dir "stack.yaml" + whenM (liftIO $ doesFileExist stackYaml) $ + tell [Ex $ ProjLocStackYaml stackYaml] + maybeCabalDir <- liftIO (fmap takeDirectory <$> findCabalFile dir) + forM_ [Ex . ProjLocV2Dir, Ex . ProjLocV1Dir] $ \proj -> traverse (tell . pure . proj) maybeCabalDir + + +-- | @getDefaultDistDir pl@. Get the default dist-dir for the given project. +-- +-- Note that the path in the returned dist-dir might not exist yet if the +-- build-tool has never been run for this project before. This is fine as +-- far as @cabal-helper@ is concerned. It will simply invoke the build-tool +-- as needed to answer the requested queries. +getDefaultDistDir :: ProjLoc pt -> DistDir pt +getDefaultDistDir (ProjLocV1CabalFile _cabal_file pkgdir) = + DistDirCabal SCV1 $ pkgdir "dist" +getDefaultDistDir (ProjLocV1Dir pkgdir) = + DistDirCabal SCV1 $ pkgdir "dist" +getDefaultDistDir (ProjLocV2File _cabal_project projdir) = + DistDirCabal SCV2 $ projdir "dist-newstyle" +getDefaultDistDir (ProjLocV2Dir projdir) = + DistDirCabal SCV2 $ projdir "dist-newstyle" +getDefaultDistDir (ProjLocStackYaml _) = + DistDirStack Nothing + +-- | @isValidDistDir distdir@. Check if @distdir@ looks like a valid +-- build-dir for it's project type. We just check if characteristic marker +-- files for the associated project type exist. +-- +-- If the project type does not have a way to do this (for example +-- 'DistDirStack') check we return 'Nothing'. +isValidDistDir :: DistDir pt -> IO (Maybe Bool) +isValidDistDir (DistDirCabal cpt dir) = do + fmap Just $ doesFileExist $ dir cabalProjTypeMarkerFile cpt +isValidDistDir DistDirStack{} = + return Nothing + +cabalProjTypeMarkerFile :: SCabalProjType pt -> FilePath +cabalProjTypeMarkerFile SCV1 = "setup-config" +cabalProjTypeMarkerFile SCV2 = "cache" "plan.json" + +whenM :: Monad m => m Bool -> m () -> m () +whenM p x = p >>= (`when` x) diff --git a/os/posix/Symlink.hs b/os/posix/Symlink.hs new file mode 100644 --- /dev/null +++ b/os/posix/Symlink.hs @@ -0,0 +1,2 @@ +module Symlink (createSymbolicLink) where +import System.Posix.Files (createSymbolicLink) diff --git a/os/win/Symlink.hs b/os/win/Symlink.hs new file mode 100644 --- /dev/null +++ b/os/win/Symlink.hs @@ -0,0 +1,3 @@ +module Symlink (createSymbolicLink) where +import System.Win32.SymbolicLink (createSymbolicLinkFile) +createSymbolicLink = createSymbolicLinkFile diff --git a/src/CabalHelper/Compiletime/Cabal.hs b/src/CabalHelper/Compiletime/Cabal.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/Cabal.hs @@ -0,0 +1,291 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-| +Module : CabalHelper.Compiletime.Program.Cabal +Description : Cabal library source unpacking +License : Apache-2.0 +-} + +{-# LANGUAGE DeriveFunctor, ViewPatterns, OverloadedStrings, CPP #-} + +module CabalHelper.Compiletime.Cabal where + +import Data.Char +import Control.Exception +import Data.List +import Data.Maybe +import Data.Time.Calendar +import Data.Time.Clock +import Data.Time.Clock.POSIX +import Data.Version +import System.Directory +import System.FilePath +import System.IO +import Text.Printf + +import Distribution.Verbosity (Verbosity, silent, normal, verbose, deafening) + +import qualified Data.ByteString as BS +import qualified Data.ByteString.Char8 as BS8 + +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.Process +import CabalHelper.Shared.Common (replace, parseVer, parseVerMay, parsePkgIdBS, panicIO) + +type UnpackedCabalVersion = CabalVersion' (CommitId, CabalSourceDir) +type ResolvedCabalVersion = CabalVersion' CommitId +type CabalVersion = CabalVersion' () + +unpackedToResolvedCabalVersion :: UnpackedCabalVersion -> ResolvedCabalVersion +unpackedToResolvedCabalVersion (CabalHEAD (commit, _)) = CabalHEAD commit +unpackedToResolvedCabalVersion (CabalVersion ver) = CabalVersion ver + +-- | Cabal library version we're compiling the helper exe against. +data CabalVersion' a + = CabalHEAD a + | CabalVersion { cvVersion :: Version } + deriving (Eq, Ord, Functor) + +newtype CommitId = CommitId { unCommitId :: String } + +showUnpackedCabalVersion :: UnpackedCabalVersion -> String +showUnpackedCabalVersion (CabalHEAD (commitid, _)) = + "HEAD-" ++ unCommitId commitid +showUnpackedCabalVersion CabalVersion {cvVersion} = + showVersion cvVersion + +showResolvedCabalVersion :: ResolvedCabalVersion -> String +showResolvedCabalVersion (CabalHEAD commitid) = + "HEAD-" ++ unCommitId commitid +showResolvedCabalVersion CabalVersion {cvVersion} = + showVersion cvVersion + +showCabalVersion :: CabalVersion -> String +showCabalVersion (CabalHEAD ()) = + "HEAD" +showCabalVersion CabalVersion {cvVersion} = + showVersion cvVersion + +data CabalPatchDescription = CabalPatchDescription + { cpdVersions :: [Version] + , cpdUnpackVariant :: UnpackCabalVariant + , cpdPatchFn :: FilePath -> IO () + } + +nopCabalPatchDescription :: CabalPatchDescription +nopCabalPatchDescription = + CabalPatchDescription [] LatestRevision (const (return ())) + +patchyCabalVersions :: [CabalPatchDescription] +patchyCabalVersions = [ + let versions = [ Version [1,18,1] [] ] + variant = Pristine + patch = fixArrayConstraint + in CabalPatchDescription versions variant patch, + + let versions = [ Version [1,18,0] [] ] + variant = Pristine + patch dir = do + fixArrayConstraint dir + fixOrphanInstance dir + in CabalPatchDescription versions variant patch, + + let versions = [ Version [1,24,1,0] [] ] + variant = Pristine + patch _ = return () + in CabalPatchDescription versions variant patch + ] + where + fixArrayConstraint dir = do + let cabalFile = dir "Cabal.cabal" + cabalFileTmp = cabalFile ++ ".tmp" + + cf <- readFile cabalFile + writeFile cabalFileTmp $ replace "&& < 0.5" "&& < 0.6" cf + renameFile cabalFileTmp cabalFile + + fixOrphanInstance dir = do + let versionFile = dir "Distribution/Version.hs" + versionFileTmp = versionFile ++ ".tmp" + + let languagePragma = + "{-# LANGUAGE DeriveDataTypeable, StandaloneDeriving #-}" + languagePragmaCPP = + "{-# LANGUAGE CPP, DeriveDataTypeable, StandaloneDeriving #-}" + + derivingDataVersion = + "deriving instance Data Version" + derivingDataVersionCPP = unlines [ + "#if __GLASGOW_HASKELL__ < 707", + derivingDataVersion, + "#endif" + ] + + vf <- readFile versionFile + writeFile versionFileTmp + $ replace derivingDataVersion derivingDataVersionCPP + $ replace languagePragma languagePragmaCPP vf + + renameFile versionFileTmp versionFile + +unpackPatchedCabal :: Env => Version -> FilePath -> IO CabalSourceDir +unpackPatchedCabal cabalVer tmpdir = do + res@(CabalSourceDir dir) <- unpackCabalHackage cabalVer tmpdir variant + patch dir + return res + where + CabalPatchDescription _ variant patch = fromMaybe nopCabalPatchDescription $ + find ((cabalVer `elem`) . cpdVersions) patchyCabalVersions + +-- legacy, for `installCabalLib` v1 +unpackCabalV1 + :: Env + => UnpackedCabalVersion + -> FilePath + -> IO CabalSourceDir +unpackCabalV1 (CabalVersion ver) tmpdir = do + csdir <- unpackPatchedCabal ver tmpdir + return csdir +unpackCabalV1 (CabalHEAD (_commit, csdir)) _tmpdir = + return csdir + +unpackCabal :: Env => CabalVersion -> FilePath -> IO UnpackedCabalVersion +unpackCabal (CabalVersion ver) _tmpdir = do + return $ CabalVersion ver +unpackCabal (CabalHEAD ()) tmpdir = do + (commit, csdir) <- unpackCabalHEAD tmpdir + return $ CabalHEAD (commit, csdir) + +data UnpackCabalVariant = Pristine | LatestRevision +newtype CabalSourceDir = CabalSourceDir { unCabalSourceDir :: FilePath } +unpackCabalHackage + :: (Verbose, Progs) + => Version + -> FilePath + -> UnpackCabalVariant + -> IO CabalSourceDir +unpackCabalHackage cabalVer tmpdir variant = do + let cabal = "Cabal-" ++ showVersion cabalVer + dir = tmpdir cabal + variant_opts = case variant of Pristine -> [ "--pristine" ]; _ -> [] + args = [ "get", cabal ] ++ variant_opts + callProcessStderr (Just tmpdir) [] (cabalProgram ?progs) args + return $ CabalSourceDir dir + +unpackCabalHEAD :: Env => FilePath -> IO (CommitId, CabalSourceDir) +unpackCabalHEAD tmpdir = do + let dir = tmpdir "cabal-head.git" + url = "https://github.com/haskell/cabal.git" + callProcessStderr (Just "/") [] "git" [ "clone", "--depth=1", url, dir] + callProcessStderr (Just (dir "Cabal")) [] "cabal" + [ "act-as-setup", "--", "sdist" + , "--output-directory=" ++ tmpdir "Cabal" ] + commit <- takeWhile isHexDigit <$> + readCreateProcess (proc "git" ["rev-parse", "HEAD"]){ cwd = Just dir } "" + ts <- + readCreateProcess (proc "git" [ "show", "-s", "--format=%ct", "HEAD" ]) + { cwd = Just dir } "" + let ut = posixSecondsToUTCTime $ fromInteger (read ts) + (y,m,d) = toGregorian $ utctDay ut + sec = round $ utctDayTime ut + datecode = + read $ show y ++ printf "%02d" m ++ printf "%02d" d ++ printf "%05d" sec + sec :: Int; datecode :: Int + let cabal_file = tmpdir "Cabal/Cabal.cabal" + cf0 <- readFile cabal_file + let Just cf1 = replaceVersionDecl (setVersion datecode) cf0 + writeFile (cabal_file<.>"tmp") cf1 + renameFile (cabal_file<.>"tmp") cabal_file + return (CommitId commit, CabalSourceDir $ tmpdir "Cabal") + where + -- If the released version of cabal has 4 components but we use only three + -- theirs will always be larger than this one here. That's not really + -- critical though. + setVersion i (versionBranch -> mj:mi:_:_:[]) = + Just $ makeVersion $ mj:mi:[i] + setVersion _ v = + error $ "unpackCabalHEAD.setVersion: Wrong version format" ++ show v + +-- | Replace the version declaration in a cabal file +replaceVersionDecl :: (Version -> Maybe Version) -> String -> Maybe String +replaceVersionDecl ver_fn cf = let + isVersionDecl ([],t) = "version:" `isPrefixOf` t + isVersionDecl (i,t) = "\n" `isSuffixOf` i && "version:" `isPrefixOf` t + Just (before_ver,m) = find isVersionDecl $ splits cf + Just (ver_decl,after_ver) + = find (\s -> case s of (_i,'\n':x:_) -> not $ isSpace x; _ -> False) + $ filter (\(_i,t) -> "\n" `isPrefixOf` t) + $ splits m + Just vers0 = dropWhile isSpace <$> stripPrefix "version:" ver_decl + (vers1,rest) = span (\c -> isDigit c || c == '.') vers0 + Just verp | all isSpace rest = parseVerMay $ vers1 in do + new_ver <- ver_fn verp + return $ concat + [ before_ver, "version: ", showVersion new_ver, after_ver ] + where + splits xs = inits xs `zip` tails xs + +resolveCabalVersion :: Verbose => CabalVersion -> IO ResolvedCabalVersion +resolveCabalVersion (CabalVersion ver) = return $ CabalVersion ver +resolveCabalVersion (CabalHEAD ()) = do + out <- readProcess' "git" + [ "ls-remote", "https://github.com/haskell/cabal.git", "-h", "master" ] "" + let commit = takeWhile isHexDigit out + return $ CabalHEAD $ CommitId commit + +findCabalFile :: FilePath -> IO (Maybe FilePath) +findCabalFile pkgdir = do + cfiles <- filter isCabalFile <$> getDirectoryContents pkgdir + case cfiles of + [] -> return Nothing + [cfile] -> return $ Just $ pkgdir cfile + _ -> panicIO $ "Multiple cabal-files found in directory '" + ++pkgdir++"': " ++ show cfiles + where + isCabalFile :: FilePath -> Bool + isCabalFile f = takeExtension' f == ".cabal" + + takeExtension' :: FilePath -> String + takeExtension' p = + if takeFileName p == takeExtension p + then "" -- just ".cabal" is not a valid cabal file + else takeExtension p + +complainIfNoCabalFile :: FilePath -> Maybe FilePath -> IO FilePath +complainIfNoCabalFile _ (Just cabal_file) = return cabal_file +complainIfNoCabalFile pkgdir Nothing = + panicIO $ "No cabal file found in package-dir: '"++pkgdir++"'" + +bultinCabalVersion :: Version +bultinCabalVersion = parseVer VERSION_Cabal + +readSetupConfigHeader :: FilePath -> IO (Maybe UnitHeader) +readSetupConfigHeader file = bracket (openFile file ReadMode) hClose $ \h -> do + parseSetupHeader <$> BS.hGetLine h + +parseSetupHeader :: BS.ByteString -> Maybe UnitHeader +parseSetupHeader header = case BS8.words header of + ["Saved", "package", "config", "for", pkgId , + "written", "by", setupId, + "using", compId] + -> UnitHeader + <$> parsePkgIdBS pkgId + <*> parsePkgIdBS setupId + <*> parsePkgIdBS compId + _ -> Nothing + +getCabalVerbosity :: Verbose => Verbosity +getCabalVerbosity + | ?verbose 2 = normal + | ?verbose 3 = verbose + | ?verbose 4 = deafening + | otherwise = silent diff --git a/src/CabalHelper/Compiletime/CompPrograms.hs b/src/CabalHelper/Compiletime/CompPrograms.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/CompPrograms.hs @@ -0,0 +1,99 @@ +{-# LANGUAGE GADTs #-} + +module CabalHelper.Compiletime.CompPrograms where + +import Data.List +import Data.Maybe +import System.Directory +import System.FilePath +import System.IO.Temp + +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.Cabal (getCabalVerbosity) +import Symlink (createSymbolicLink) + +import Distribution.Simple.GHC as GHC (configure) + +import qualified Distribution.Simple.Program as ProgDb + ( lookupProgram, lookupKnownProgram, programPath + , configureProgram, userMaybeSpecifyPath + , ghcProgram, ghcPkgProgram, haddockProgram ) +import qualified Distribution.Simple.Program.Db as ProgDb + +-- | Determine ghc-pkg/haddock path from ghc path +guessCompProgramPaths :: Verbose => Programs -> IO Programs +guessCompProgramPaths progs = do + let v = getCabalVerbosity + getMaybeProg' = getMaybeProg progs + progdb = + ProgDb.userMaybeSpecifyPath "ghc" (getMaybeProg' ghcProgram) $ + ProgDb.userMaybeSpecifyPath "ghc-pkg" (getMaybeProg' ghcPkgProgram) $ + ProgDb.userMaybeSpecifyPath "haddock" (getMaybeProg' haddockProgram) $ + ProgDb.defaultProgramDb + (_compiler, _mplatform, progdb1) <- GHC.configure v Nothing Nothing progdb + let Just haddockKnownProgram = ProgDb.lookupKnownProgram "haddock" progdb1 + progdb2 <- ProgDb.configureProgram v haddockKnownProgram progdb1 + let getProg p = ProgDb.programPath <$> ProgDb.lookupProgram p progdb2 + return progs + { ghcProgram = + fromMaybe (ghcProgram progs) $ getProg ProgDb.ghcProgram + , ghcPkgProgram = + fromMaybe (ghcPkgProgram progs) $ getProg ProgDb.ghcPkgProgram + , haddockProgram = + fromMaybe (haddockProgram progs) $ getProg ProgDb.haddockProgram + } + +getMaybeProg :: Programs -> (Programs -> FilePath) -> Maybe FilePath +getMaybeProg progs fn + | fn progs == fn defaultPrograms = Nothing + | otherwise = Just (fn progs) + +patchBuildToolProgs :: SProjType pt -> Programs -> IO Programs +patchBuildToolProgs (SCabal _) progs = return progs + { cabalUnitArgs = concat + [ maybeToList (("--with-ghc="++) <$> getMaybeProg progs ghcProgram) + , maybeToList (("--with-ghc-pkg="++) <$> getMaybeProg progs ghcPkgProgram) + , maybeToList (("--with-haddock="++) <$> getMaybeProg progs haddockProgram) + ] ++ cabalUnitArgs progs + } +patchBuildToolProgs SStack progs + -- optimization; if none of the program paths are non-default we don't + -- even have to add anything to PATH. + | ghcProgram progs == "ghc" + , ghcPkgProgram progs == "ghc-pkg" + , haddockProgram progs == "haddock" + = return progs + + -- optimization; if all paths are unqualified and have the same version + -- postfix Stack's default behaviour works for us. + | [ghc] <- splitPath (ghcProgram progs) + , [ghcPkg] <- splitPath (ghcPkgProgram progs) + , [haddock] <- splitPath (haddockProgram progs) + , Just ver <- stripPrefix "ghc-" ghc + , Just ver == stripPrefix "ghc-pkg-" ghcPkg + , Just ver == stripPrefix "haddock-" haddock + = return progs +patchBuildToolProgs SStack progs = do + -- otherwise fall back to creating a symlink farm + -- + -- This is of course all quite horrible and we would much prefer just + -- being able to pass executable paths straight through to stack but + -- currently there is no option to let us do that. + withSystemTempDirectory "cabal-helper-symlinks" $ \bindir -> do + createProgSymlink bindir $ ghcProgram progs + createProgSymlink bindir $ ghcPkgProgram progs + createProgSymlink bindir $ haddockProgram progs + return $ progs + { stackEnv = + [("PATH", EnvPrepend $ bindir ++ [searchPathSeparator])] ++ + stackEnv progs + } + +createProgSymlink :: FilePath -> FilePath -> IO () +createProgSymlink bindir target + | [exe] <- splitPath target = do + Just exe_path <- findExecutable exe + createSymbolicLink exe_path (bindir takeFileName target) + | otherwise = do + cwd <- getCurrentDirectory + createSymbolicLink (cwd target) (bindir takeFileName target) diff --git a/src/CabalHelper/Compiletime/Compat/Environment.hs b/src/CabalHelper/Compiletime/Compat/Environment.hs --- a/src/CabalHelper/Compiletime/Compat/Environment.hs +++ b/src/CabalHelper/Compiletime/Compat/Environment.hs @@ -1,18 +1,13 @@ -- cabal-helper: Simple interface to Cabal's configuration state -- Copyright (C) 2017 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . +-- http://www.apache.org/licenses/LICENSE-2.0 {-# LANGUAGE CPP #-} module CabalHelper.Compiletime.Compat.Environment where diff --git a/src/CabalHelper/Compiletime/Compat/Parsec.hs b/src/CabalHelper/Compiletime/Compat/Parsec.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/Compat/Parsec.hs @@ -0,0 +1,36 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-# LANGUAGE CPP #-} +module CabalHelper.Compiletime.Compat.Parsec + ( absorbParsecFailure + , eitherParsec + ) where + +#if MIN_VERSION_Cabal(2,5,0) +import Distribution.Parsec +#else +import qualified Distribution.Compat.ReadP as Dist +import Distribution.Text +#endif + +absorbParsecFailure :: String -> Either String a -> a +absorbParsecFailure _ (Right x) = x +absorbParsecFailure ctx (Left err) = + error $ "Error parsing in '"++ctx++"': " ++ err + +#if !MIN_VERSION_Cabal(2,5,0) +eitherParsec :: Text t => String -> Either String t +eitherParsec i = + case filter ((=="") . snd) $ Dist.readP_to_S parse i of + (a,""):[] -> Right a + _ -> Left $ show i +#endif diff --git a/src/CabalHelper/Compiletime/Compat/ProgramDb.hs b/src/CabalHelper/Compiletime/Compat/ProgramDb.hs deleted file mode 100644 --- a/src/CabalHelper/Compiletime/Compat/ProgramDb.hs +++ /dev/null @@ -1,30 +0,0 @@ --- cabal-helper: Simple interface to Cabal's configuration state --- Copyright (C) 2018 Daniel Gröber --- --- 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 . - -{-# LANGUAGE CPP #-} -module CabalHelper.Compiletime.Compat.ProgramDb - ( defaultProgramDb - , programPath - , lookupProgram - , ghcProgram - , ghcPkgProgram - ) where - -import Distribution.Simple.Program - -#if !MIN_VERSION_Cabal(2,0,0) -defaultProgramDb = defaultProgramConfiguration -#endif diff --git a/src/CabalHelper/Compiletime/Compat/Version.hs b/src/CabalHelper/Compiletime/Compat/Version.hs --- a/src/CabalHelper/Compiletime/Compat/Version.hs +++ b/src/CabalHelper/Compiletime/Compat/Version.hs @@ -1,18 +1,13 @@ -- cabal-helper: Simple interface to Cabal's configuration state -- Copyright (C) 2017-2018 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . +-- http://www.apache.org/licenses/LICENSE-2.0 {-# LANGUAGE CPP #-} module CabalHelper.Compiletime.Compat.Version diff --git a/src/CabalHelper/Compiletime/Compile.hs b/src/CabalHelper/Compiletime/Compile.hs --- a/src/CabalHelper/Compiletime/Compile.hs +++ b/src/CabalHelper/Compiletime/Compile.hs @@ -1,30 +1,27 @@ -- cabal-helper: Simple interface to Cabal's configuration state -- Copyright (C) 2015-2018 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . -{-# LANGUAGE RecordWildCards, FlexibleContexts, NamedFieldPuns, DeriveFunctor, -GADTs #-} +-- http://www.apache.org/licenses/LICENSE-2.0 +{-# LANGUAGE DeriveFunctor, GADTs, ScopedTypeVariables #-} + {-| Module : CabalHelper.Compiletime.Compile Description : Runtime compilation machinery -License : GPL-3 +License : Apache-2.0 -} module CabalHelper.Compiletime.Compile where +import qualified Cabal.Plan as CP import Cabal.Plan + ( PlanJson(..), PkgId(..), PkgName(..), Ver(..), uPId) import Control.Applicative import Control.Arrow import Control.Exception as E @@ -36,49 +33,52 @@ import Data.Maybe import Data.String import Data.Version -import GHC.IO.Exception (IOErrorType(OtherError)) import Text.Printf -import Text.Read +import qualified System.Clock as Clock import System.Directory import System.FilePath -import System.Process import System.Exit -import System.Environment import System.IO -import System.IO.Error import System.IO.Temp import Prelude - import qualified Data.Text as Text import qualified Data.Map.Strict as Map -import Distribution.System (buildPlatform) -import Distribution.Text (display) +import Distribution.System + ( buildPlatform ) +import Distribution.Text + ( display ) -import Paths_cabal_helper (version) +import CabalHelper.Compiletime.Cabal import CabalHelper.Compiletime.Data import CabalHelper.Compiletime.Log +import CabalHelper.Compiletime.Program.GHC +import CabalHelper.Compiletime.Program.CabalInstall +import CabalHelper.Compiletime.Sandbox + ( getSandboxPkgDb ) import CabalHelper.Compiletime.Types + import CabalHelper.Shared.Common -import CabalHelper.Shared.Sandbox (getSandboxPkgDb) +import Paths_cabal_helper (version) + + data Compile = CompileWithCabalSource - { compCabalSourceDir :: CabalSourceDir - , compCabalSourceVersion :: Version + { compCabalSourceDir :: !CabalSourceDir + , compCabalSourceVersion :: !Version } | CompileWithCabalPackage - { compPackageDb :: Maybe PackageDbDir - , compCabalVersion :: CabalVersion - , compPackageDeps :: [String] - , compProductTarget :: CompilationProductScope + { compPackageSource :: !GhcPackageSource + , compCabalVersion :: !ResolvedCabalVersion + , compProductTarget :: !CompilationProductScope } data CompPaths = CompPaths - { compSrcDir :: FilePath - , compOutDir :: FilePath - , compExePath :: FilePath + { compBuildDir:: !FilePath + , compOutDir :: !FilePath + , compExePath :: !FilePath } -- | The Helper executable we produce as a compilation product can either be @@ -87,110 +87,207 @@ -- executable. data CompilationProductScope = CPSGlobal | CPSProject -compileHelper :: Options -> Version -> FilePath -> Maybe (PlanJson, FilePath) -> FilePath -> IO (Either ExitCode FilePath) -compileHelper opts hdrCabalVersion projdir mnewstyle distdir = do - ghcVer <- ghcVersion opts - Just (prepare, comp) <- runMaybeT $ msum $ - case oCabalPkgDb opts of - Nothing -> - [ compileCabalSource - , compileNewBuild ghcVer - , compileSandbox ghcVer - , compileGlobal - , MaybeT $ Just <$> compileWithCabalInPrivatePkgDb - ] - Just db -> - [ return $ (return (), compileWithPkg (Just db) hdrCabalVersion CPSProject) - ] +type CompHelperEnv = CompHelperEnv' CabalVersion +data CompHelperEnv' cv = CompHelperEnv + { cheCabalVer :: !cv + , chePkgDb :: !(Maybe PackageDbDir) + -- ^ A package-db where we are guaranteed to find Cabal-`cheCabalVer`. + , cheProjDir :: !FilePath + , chePlanJson :: !(Maybe PlanJson) + , cheDistV2 :: !(Maybe FilePath) + , cheProjLocalCacheDir :: FilePath + } - appdir <- appCacheDir +compileHelper + :: Env => CompHelperEnv -> IO (Either ExitCode FilePath) +compileHelper che@CompHelperEnv {cheCabalVer} = do + withSystemTempDirectory "cabal-helper.compile-tmp" $ \tmpdir -> do + ucv <- unpackCabal cheCabalVer tmpdir + compileHelper' che { cheCabalVer = ucv } - let cp@CompPaths {compExePath} = compPaths appdir distdir comp - exists <- doesFileExist compExePath - if exists +compileHelper' + :: Env + => CompHelperEnv' UnpackedCabalVersion + -> IO (Either ExitCode FilePath) +compileHelper' CompHelperEnv {..} = do + ghcVer <- ghcVersion + Just (prepare, comp) <- case cheCabalVer of + cabalVer@CabalHEAD {} -> runMaybeT $ msum $ map (\f -> f ghcVer cabalVer) + [ compileWithCabalV2GhcEnv' + , compileWithCabalInPrivatePkgDb' + ] + CabalVersion cabalVerPlain -> do + runMaybeT $ msum $ map (\f -> f ghcVer cabalVerPlain) $ + case chePkgDb of + Nothing -> + [ compileWithCabalV2Inplace + , compileWithCabalV2GhcEnv + , compileCabalSource + , compileSandbox + , compileGlobal + , compileWithCabalInPrivatePkgDb + ] + Just db -> + [ ((.).(.)) liftIO (compilePkgDb db) + ] + appdir <- appCacheDir + let cp@CompPaths {compExePath} = compPaths appdir cheProjLocalCacheDir comp + helper_exists <- doesFileExist compExePath + rv <- if helper_exists then do - vLog opts $ "helper already compiled, using exe: "++compExePath + vLog $ "helper already compiled, using exe: "++compExePath return (Right compExePath) else do - vLog opts $ "helper exe does not exist, compiling "++compExePath - prepare >> compile comp cp opts + vLog $ "helper exe does not exist, compiling "++compExePath + prepare >> compile cp comp + return rv - where + + where logMsg = "using helper compiled with Cabal from " --- for relaxed deps: find (sameMajorVersionAs hdrCabalVersion) . reverse . sort +-- for relaxed deps: find (sameMajorVersionAs cheCabalVer) . reverse . sort + compilePkgDb db _ghcVer cabalVer = return $ + (,) + (pure ()) + CompileWithCabalPackage + { compPackageSource = GPSPackageDBs [db] + , compCabalVersion = CabalVersion cabalVer + , compProductTarget = CPSProject + } + -- | Check if this version is globally available - compileGlobal :: MaybeT IO (IO (), Compile) - compileGlobal = do - cabal_versions <- listCabalVersions opts - ver <- MaybeT $ return $ find (== hdrCabalVersion) cabal_versions - vLog opts $ logMsg ++ "user/global package-db" - return $ (return (), compileWithPkg Nothing ver CPSGlobal) + compileGlobal :: Env => gv -> Version -> MaybeT IO (IO (), Compile) + compileGlobal _ghcVer cabalVer = do + cabal_versions <- listCabalVersions Nothing + _ <- MaybeT $ return $ find (== cabalVer) cabal_versions + vLog $ logMsg ++ "user/global package-db" + return $ (return (), compileWithPkg GPSAmbient cabalVer CPSGlobal) -- | Check if this version is available in the project sandbox - compileSandbox :: Version -> MaybeT IO (IO (), Compile) - compileSandbox ghcVer = do - let mdb_path = getSandboxPkgDb projdir (display buildPlatform) ghcVer + compileSandbox :: Env => GhcVersion -> Version -> MaybeT IO (IO (), Compile) + compileSandbox ghcVer cabalVer = do + let mdb_path = getSandboxPkgDb (display buildPlatform) ghcVer cheProjDir sandbox <- PackageDbDir <$> MaybeT mdb_path - cabal_versions <- listCabalVersions' opts (Just sandbox) - ver <- MaybeT $ return $ find (== hdrCabalVersion) cabal_versions - vLog opts $ logMsg ++ "sandbox package-db" - return $ (return (), compileWithPkg (Just sandbox) ver CPSProject) + cabal_versions <- listCabalVersions (Just sandbox) + _ <- MaybeT $ return $ find (== cabalVer) cabal_versions + vLog $ logMsg ++ "sandbox package-db" + return $ (return (), compileWithPkg (GPSPackageDBs [sandbox]) cabalVer CPSProject) - compileNewBuild :: Version -> MaybeT IO (IO (), Compile) - compileNewBuild ghcVer = do - (PlanJson {pjUnits}, distdir_newstyle) <- maybe mzero pure mnewstyle + -- | Check if the requested Cabal version is available in a v2-build + -- project's inplace package-db. + -- + -- This is likely only the case if Cabal was vendored by this project or if + -- we're operating on Cabal itself! + compileWithCabalV2Inplace :: Env => GhcVersion -> Version -> MaybeT IO (IO (), Compile) + compileWithCabalV2Inplace ghcVer cabalVer = do + -- TODO: Test coverage! Neither compile-test nor ghc-session test out + -- this code path + PlanJson {pjUnits} <- maybe mzero pure chePlanJson + distdir_newstyle <- maybe mzero pure cheDistV2 let cabal_pkgid = - PkgId (PkgName (Text.pack "Cabal")) - (Ver $ versionBranch hdrCabalVersion) + PkgId (PkgName (Text.pack "Cabal")) (Ver $ versionBranch cabalVer) mcabal_unit = listToMaybe $ - Map.elems $ Map.filter (\Unit {..} -> uPId == cabal_pkgid) pjUnits - Unit {} <- maybe mzero pure mcabal_unit + Map.elems $ Map.filter (\CP.Unit{..} -> uPId == cabal_pkgid) pjUnits + CP.Unit {} <- maybe mzero pure mcabal_unit let inplace_db_path = distdir_newstyle - "packagedb" ("ghc-" ++ showVersion ghcVer) + "packagedb" ("ghc-" ++ showGhcVersion ghcVer) inplace_db = PackageDbDir inplace_db_path - cabal_versions <- listCabalVersions' opts (Just inplace_db) - ver <- MaybeT $ return $ find (== hdrCabalVersion) cabal_versions - vLog opts $ logMsg ++ "v2-build package-db " ++ inplace_db_path - return $ (return (), compileWithPkg (Just inplace_db) ver CPSProject) + cabal_versions <- listCabalVersions (Just inplace_db) + _ <- MaybeT $ return $ find (== cabalVer) cabal_versions + vLog $ logMsg ++ "v2-build package-db " ++ inplace_db_path + return $ (return (), compileWithPkg (GPSPackageDBs [inplace_db]) cabalVer CPSProject) + compileWithCabalV2GhcEnv :: Env => GhcVersion -> Version -> MaybeT IO (IO (), Compile) + compileWithCabalV2GhcEnv ghcVer cabalVer = + compileWithCabalV2GhcEnv' ghcVer (CabalVersion cabalVer) + + -- TODO: Support using existing ghc-environments too! That's mostly + -- relevant for when you want to use a development version of + -- cabal-install since that will depend on an unreleased version of + -- Cabal we cannot new-install just like that. + + -- | If this is a v2-build project it makes sense to use @v2-install@ for + -- installing Cabal as this will use the @~/.cabal/store@. We use + -- @--package-env@ to instruct cabal to not meddle with the user's package + -- environment. + compileWithCabalV2GhcEnv' :: Env => GhcVersion -> UnpackedCabalVersion -> MaybeT IO (IO (), Compile) + compileWithCabalV2GhcEnv' ghcVer cabalVer = do + _ <- maybe mzero pure cheDistV2 -- bail if this isn't a v2-build project + CabalInstallVersion instVer <- liftIO cabalInstallVersion + guard $ instVer >= (Version [2,4,1,0] []) + -- ^ didn't test with older versions + guard $ ghcVer >= (GhcVersion (Version [8,0] [])) + env@(PackageEnvFile env_file) <- liftIO $ + getPrivateCabalPkgEnv ghcVer $ unpackedToResolvedCabalVersion cabalVer + vLog $ logMsg ++ "v2-build package-env " ++ env_file + return $ (,) + (prepare env) + CompileWithCabalPackage + { compPackageSource = GPSPackageEnv env + , compCabalVersion = unpackedToResolvedCabalVersion cabalVer + , compProductTarget = CPSGlobal + } + where + prepare env = do + -- exists_in_env <- liftIO $ cabalVersionExistsInPkgDb cheCabalVer db + void $ installCabalLibV2 ghcVer cheCabalVer env `E.catch` + \(ex :: IOError) -> print ex >> + case cheCabalVer of + CabalHEAD _ -> panicIO "Installing Cabal HEAD failed." + CabalVersion ver -> errorInstallCabal (CabalVersion ver) + + + + compileWithCabalInPrivatePkgDb + :: (Env, MonadIO m) => GhcVersion -> Version -> m (IO (), Compile) + compileWithCabalInPrivatePkgDb ghcVer cabalVer = + compileWithCabalInPrivatePkgDb' ghcVer (CabalVersion cabalVer) + -- | Compile the requested Cabal version into an isolated package-db if it's -- not there already - compileWithCabalInPrivatePkgDb :: IO (IO (), Compile) - compileWithCabalInPrivatePkgDb = do - db@(PackageDbDir db_path) - <- getPrivateCabalPkgDb opts (CabalVersion hdrCabalVersion) - vLog opts $ logMsg ++ "private package-db in " ++ db_path - return (prepare db, compileWithPkg (Just db) hdrCabalVersion CPSGlobal) + compileWithCabalInPrivatePkgDb' + :: (Env, MonadIO m) => GhcVersion -> UnpackedCabalVersion -> m (IO (), Compile) + compileWithCabalInPrivatePkgDb' ghcVer cabalVer = do + db@(PackageDbDir db_path) <- liftIO $ + getPrivateCabalPkgDb $ unpackedToResolvedCabalVersion cabalVer + vLog $ logMsg ++ "private package-db in " ++ db_path + return $ (,) + (prepare db) + CompileWithCabalPackage + { compPackageSource = GPSPackageDBs [db] + , compCabalVersion = unpackedToResolvedCabalVersion cabalVer + , compProductTarget = CPSGlobal + } where prepare db = do - db_exists <- liftIO $ cabalVersionExistsInPkgDb opts hdrCabalVersion db + db_exists <- liftIO $ cabalVersionExistsInPkgDb cabalVer db when (not db_exists) $ - void $ installCabal opts (Right hdrCabalVersion) `E.catch` - \(SomeException _) -> errorInstallCabal hdrCabalVersion distdir + void (installCabalLibV1 ghcVer cabalVer) `E.catch` + \(SomeException _) -> errorInstallCabal cabalVer -- | See if we're in a cabal source tree - compileCabalSource :: MaybeT IO (IO (), Compile) - compileCabalSource = do - let cabalFile = projdir "Cabal.cabal" + -- compileCabalSource :: Env => MaybeT IO (IO (), Compile) + compileCabalSource _ghcVer _cabalVer = do + let cabalFile = cheProjDir "Cabal.cabal" cabalSrc <- liftIO $ doesFileExist cabalFile - let projdir' = CabalSourceDir projdir + let projdir = CabalSourceDir cheProjDir case cabalSrc of False -> mzero True -> do - vLog opts $ "projdir looks like Cabal source tree (Cabal.cabal exists)" + vLog $ "projdir looks like Cabal source tree (Cabal.cabal exists)" cf <- liftIO $ readFile cabalFile let buildType = cabalFileBuildType cf ver = cabalFileVersion cf case buildType of "simple" -> do - vLog opts $ "Cabal source tree is build-type:simple, moving on" + vLog $ "Cabal source tree is build-type:simple, moving on" mzero "custom" -> do - vLog opts $ "compiling helper with local Cabal source tree" - return $ (return (), compileWithCabalSource projdir' ver) + vLog $ "compiling helper with local Cabal source tree" + return $ (return (), compileWithCabalSource projdir ver) _ -> error $ "compileCabalSource: unknown build-type: '"++buildType++"'" compileWithCabalSource srcDir ver = @@ -199,64 +296,64 @@ , compCabalSourceVersion = ver } - compileWithPkg mdb ver target = + compileWithPkg pkg_src ver target = CompileWithCabalPackage - { compPackageDb = mdb + { compPackageSource = pkg_src , compCabalVersion = CabalVersion ver - , compPackageDeps = [cabalPkgId ver] , compProductTarget = target } - cabalPkgId v = "Cabal-" ++ showVersion v - -compile :: Compile -> CompPaths -> Options -> IO (Either ExitCode FilePath) -compile comp paths@CompPaths {..} opts@Options {..} = do +compile :: Env => CompPaths -> Compile -> IO (Either ExitCode FilePath) +compile paths@CompPaths {..} comp = do createDirectoryIfMissing True compOutDir - createHelperSources compSrcDir + createHelperSources compBuildDir - vLog opts $ "compSrcDir: " ++ compSrcDir - vLog opts $ "compOutDir: " ++ compOutDir - vLog opts $ "compExePath: " ++ compExePath + vLog $ "compBuildDir: " ++ compBuildDir + vLog $ "compOutDir: " ++ compOutDir + vLog $ "compExePath: " ++ compExePath - invokeGhc opts $ compGhcInvocation comp paths + invokeGhc $ compGhcInvocation comp paths compPaths :: FilePath -> FilePath -> Compile -> CompPaths -compPaths appdir distdir c = - case c of - CompileWithCabalPackage {compProductTarget=CPSGlobal,..} -> CompPaths {..} +compPaths appdir proj_local_cachedir c = + case c of + CompileWithCabalPackage + { compProductTarget=CPSGlobal + , compCabalVersion + } -> CompPaths {..} where - compSrcDir = appdir exeName compCabalVersion <.> "build" - compOutDir = compSrcDir - compExePath = appdir exeName compCabalVersion - - CompileWithCabalPackage {compProductTarget=CPSProject,..} -> distdirPaths - CompileWithCabalSource {..} -> distdirPaths + compBuildDir = + appdir exeName compCabalVersion ++ "--" ++ sourceHash <.> "build" + compOutDir = compBuildDir + compExePath = compBuildDir "cabal-helper" + CompileWithCabalPackage {compProductTarget=CPSProject} -> + projLocalCachedirPaths + CompileWithCabalSource {} -> + projLocalCachedirPaths where - distdirPaths = CompPaths {..} + projLocalCachedirPaths = CompPaths {..} where - compSrcDir = distdir "cabal-helper" - compOutDir = compSrcDir + compBuildDir = proj_local_cachedir "cabal-helper" + compOutDir = compBuildDir compExePath = compOutDir "cabal-helper" -data GhcInvocation = GhcInvocation - { giOutDir :: FilePath - , giOutput :: FilePath - , giCPPOptions :: [String] - , giPackageDBs :: [PackageDbDir] - , giIncludeDirs :: [FilePath] - , giHideAllPackages :: Bool - , giPackages :: [String] - , giWarningFlags :: [String] - , giInputs :: [String] - } +exeName :: ResolvedCabalVersion -> String +exeName (CabalHEAD commitid) = intercalate "--" + [ "cabal-helper-" ++ showVersion version + , "Cabal-HEAD" ++ unCommitId commitid + ] +exeName CabalVersion {cvVersion} = intercalate "--" + [ "cabal-helper-" ++ showVersion version + , "Cabal-" ++ showVersion cvVersion + ] compGhcInvocation :: Compile -> CompPaths -> GhcInvocation compGhcInvocation comp CompPaths {..} = case comp of CompileWithCabalSource {..} -> GhcInvocation - { giIncludeDirs = [compSrcDir, unCabalSourceDir compCabalSourceDir] - , giPackageDBs = [] + { giIncludeDirs = [compBuildDir, unCabalSourceDir compCabalSourceDir] + , giPackageSource = GPSAmbient , giHideAllPackages = False , giPackages = [] , giCPPOptions = cppOptions compCabalSourceVersion @@ -265,8 +362,8 @@ } CompileWithCabalPackage {..} -> GhcInvocation - { giIncludeDirs = [compSrcDir] - , giPackageDBs = maybeToList compPackageDb + { giIncludeDirs = [compBuildDir] + , giPackageSource = compPackageSource , giHideAllPackages = True , giPackages = [ "base" @@ -276,7 +373,10 @@ , "process" , "bytestring" , "ghc-prim" - ] ++ compPackageDeps + , case compCabalVersion of + CabalHEAD {} -> "Cabal" + CabalVersion ver -> "Cabal-" ++ showVersion ver + ] , giCPPOptions = cppOptions (unCabalVersion compCabalVersion) , .. } @@ -293,7 +393,7 @@ giOutDir = compOutDir giOutput = compExePath giWarningFlags = [ "-w" ] -- no point in bothering end users with warnings - giInputs = [compSrcDir"CabalHelper""Runtime""Main.hs"] + giInputs = [compBuildDir"CabalHelper""Runtime""Main.hs"] cabalVersionMacro :: Version -> String cabalVersionMacro (Version vs _) = @@ -309,119 +409,6 @@ cabalMinVersionMacro _ = error "cabalMinVersionMacro: Version must have at least 3 components" -invokeGhc :: Options -> GhcInvocation -> IO (Either ExitCode FilePath) -invokeGhc opts@Options {..} GhcInvocation {..} = do - rv <- callProcessStderr' opts Nothing oGhcProgram $ concat - [ [ "-outputdir", giOutDir - , "-o", giOutput - ] - , map ("-optP"++) giCPPOptions - , map ("-package-conf="++) $ unPackageDbDir <$> giPackageDBs - , map ("-i"++) $ nub $ "" : giIncludeDirs - , if giHideAllPackages then ["-hide-all-packages"] else [] - , concatMap (\p -> ["-package", p]) giPackages - , giWarningFlags - , ["--make"] - , giInputs - ] - return $ - case rv of - ExitSuccess -> Right giOutput - e@(ExitFailure _) -> Left e - - --- | Cabal library version we're compiling the helper exe against. -data CabalVersion - = CabalHEAD { cvCommitId :: CommitId } - | CabalVersion { cabalVersion :: Version } - -newtype CommitId = CommitId { unCommitId :: String } - -exeName :: CabalVersion -> String -exeName (CabalHEAD commitid) = intercalate "-" - [ "cabal-helper" ++ showVersion version - , "CabalHEAD" ++ unCommitId commitid - ] -exeName CabalVersion {cabalVersion} = intercalate "-" - [ "cabal-helper" ++ showVersion version - , "Cabal" ++ showVersion cabalVersion - ] - -readProcess' :: Options -> FilePath -> [String] -> String -> IO String -readProcess' opts@Options{..} exe args inp = do - vLog opts $ intercalate " " $ map formatProcessArg (oGhcPkgProgram:args) - outp <- readProcess exe args inp - vLog opts $ unlines $ map ("=> "++) $ lines outp - return outp - -callProcessStderr' - :: Options -> Maybe FilePath -> FilePath -> [String] -> IO ExitCode -callProcessStderr' opts mwd exe args = do - let cd = case mwd of - Nothing -> []; Just wd -> [ "cd", formatProcessArg wd++";" ] - vLog opts $ intercalate " " $ cd ++ map formatProcessArg (exe:args) - (_, _, _, h) <- createProcess (proc exe args) { std_out = UseHandle stderr - , cwd = mwd } - waitForProcess h - -callProcessStderr :: Options -> Maybe FilePath -> FilePath -> [String] -> IO () -callProcessStderr opts mwd exe args = do - rv <- callProcessStderr' opts mwd exe args - case rv of - ExitSuccess -> return () - ExitFailure v -> processFailedException "callProcessStderr" exe args v - -processFailedException :: String -> String -> [String] -> Int -> IO a -processFailedException fn exe args rv = - ioError $ mkIOError OtherError msg Nothing Nothing - where - msg = concat [ fn, ": ", exe, " " - , intercalate " " (map formatProcessArg args) - , " (exit " ++ show rv ++ ")" - ] - -formatProcessArg :: String -> String -formatProcessArg xs - | any isSpace xs = "'"++ xs ++"'" - | otherwise = xs - -data HEAD = HEAD deriving (Eq, Show) - -installCabal :: Options -> Either HEAD Version -> IO (PackageDbDir, CabalVersion) -installCabal opts ever = do - appdir <- appCacheDir - let message ver = do - let sver = showVersion ver - hPutStr stderr $ printf "\ -\cabal-helper-wrapper: Installing a private copy of Cabal because we couldn't\n\ -\find the right version in your global/user package-db, this might take a\n\ -\while but will only happen once per Cabal version you're using.\n\ -\\n\ -\If anything goes horribly wrong just delete this directory and try again:\n\ -\ %s\n\ -\\n\ -\If you want to avoid this automatic installation altogether install\n\ -\version %s of Cabal manually (into your user or global package-db):\n\ -\ $ cabal install Cabal --constraint \"Cabal == %s\"\n\ -\\n\ -\Installing Cabal %s ...\n" appdir sver sver sver - - withSystemTempDirectory "cabal-helper-Cabal-source" $ \tmpdir -> do - (srcdir, cabalVer) <- case ever of - Left HEAD -> do - second CabalHEAD <$> unpackCabalHEAD opts tmpdir - Right ver -> do - message ver - let patch = fromMaybe nopCabalPatchDescription $ - find ((ver`elem`) . cpdVersions) patchyCabalVersions - (,) <$> unpackPatchedCabal opts ver tmpdir patch <*> pure (CabalVersion ver) - - db <- createPkgDb opts cabalVer - - runCabalInstall opts db srcdir ever - - return (db, cabalVer) - {- TODO: If the Cabal version we want to install is less than or equal to one we have available, either through act-as-setup or in a package-db we should be able @@ -435,200 +422,11 @@ -} -runCabalInstall - :: Options -> PackageDbDir -> CabalSourceDir -> Either HEAD Version-> IO () -runCabalInstall opts (PackageDbDir db) (CabalSourceDir srcdir) ever = do - civ@CabalInstallVersion {..} <- cabalInstallVersion opts - cabal_opts <- return $ concat - [ - [ "--package-db=clear" - , "--package-db=global" - , "--package-db=" ++ db - , "--prefix=" ++ db "prefix" - ] - , withGHCProgramOptions opts - , if cabalInstallVer >= Version [1,20,0,0] [] - then ["--no-require-sandbox"] - else [] - , [ "install", srcdir ] - , if oVerbose opts - then ["-v"] - else [] - , [ "--only-dependencies" ] - ] - - callProcessStderr opts (Just "/") (oCabalProgram opts) cabal_opts - - runSetupHs opts db srcdir ever civ - - hPutStrLn stderr "done" - -withGHCProgramOptions :: Options -> [String] -withGHCProgramOptions opts = - concat [ [ "--with-ghc=" ++ oGhcProgram opts ] - , if oGhcPkgProgram opts /= oGhcPkgProgram defaultOptions - then [ "--with-ghc-pkg=" ++ oGhcPkgProgram opts ] - else [] - ] - -runSetupHs - :: Options - -> FilePath - -> FilePath - -> Either HEAD Version - -> CabalInstallVersion - -> IO () -runSetupHs opts@Options {..} db srcdir ever CabalInstallVersion {..} - | cabalInstallVer >= parseVer "1.24" = do - go $ \args -> callProcessStderr opts (Just srcdir) oCabalProgram $ - [ "act-as-setup", "--" ] ++ args - | otherwise = do - SetupProgram {..} <- compileSetupHs opts db srcdir - go $ callProcessStderr opts (Just srcdir) setupProgram - where - parmake_opt :: Maybe Int -> [String] - parmake_opt nproc' - | Left _ <- ever = ["-j"++nproc] - | Right ver <- ever, ver >= Version [1,20] [] = ["-j"++nproc] - | otherwise = [] - where - nproc = fromMaybe "" $ show <$> nproc' - - go :: ([String] -> IO ()) -> IO () - go run = do - run $ [ "configure", "--package-db", db, "--prefix", db "prefix" ] - ++ withGHCProgramOptions opts - mnproc <- join . fmap readMaybe <$> lookupEnv "NPROC" - run $ [ "build" ] ++ parmake_opt mnproc - run [ "copy" ] - run [ "register" ] - - - - -newtype SetupProgram = SetupProgram { setupProgram :: FilePath } -compileSetupHs :: Options -> FilePath -> FilePath -> IO SetupProgram -compileSetupHs opts db srcdir = do - ver <- ghcVersion opts - let no_version_macros - | ver >= Version [8] [] = [ "-fno-version-macros" ] - | otherwise = [] - - file = srcdir "Setup" - - callProcessStderr opts (Just srcdir) (oGhcProgram opts) $ concat - [ [ "--make" - , "-package-conf", db - ] - , no_version_macros - , [ file <.> "hs" - , "-o", file - ] - ] - return $ SetupProgram file - -data CabalPatchDescription = CabalPatchDescription { - cpdVersions :: [Version], - cpdUnpackVariant :: UnpackCabalVariant, - cpdPatchFn :: FilePath -> IO () - } -nopCabalPatchDescription :: CabalPatchDescription -nopCabalPatchDescription = CabalPatchDescription [] LatestRevision (const (return ())) - -patchyCabalVersions :: [CabalPatchDescription] -patchyCabalVersions = [ - let versions = [ Version [1,18,1] [] ] - variant = Pristine - patch = fixArrayConstraint - in CabalPatchDescription versions variant patch, - - let versions = [ Version [1,18,0] [] ] - variant = Pristine - patch dir = do - fixArrayConstraint dir - fixOrphanInstance dir - in CabalPatchDescription versions variant patch, - - let versions = [ Version [1,24,1,0] [] ] - variant = Pristine - patch _ = return () - in CabalPatchDescription versions variant patch - ] - where - fixArrayConstraint dir = do - let cabalFile = dir "Cabal.cabal" - cabalFileTmp = cabalFile ++ ".tmp" - - cf <- readFile cabalFile - writeFile cabalFileTmp $ replace "&& < 0.5" "&& < 0.6" cf - renameFile cabalFileTmp cabalFile - - fixOrphanInstance dir = do - let versionFile = dir "Distribution/Version.hs" - versionFileTmp = versionFile ++ ".tmp" - - let languagePragma = - "{-# LANGUAGE DeriveDataTypeable, StandaloneDeriving #-}" - languagePragmaCPP = - "{-# LANGUAGE CPP, DeriveDataTypeable, StandaloneDeriving #-}" - - derivingDataVersion = - "deriving instance Data Version" - derivingDataVersionCPP = unlines [ - "#if __GLASGOW_HASKELL__ < 707", - derivingDataVersion, - "#endif" - ] - - vf <- readFile versionFile - writeFile versionFileTmp - $ replace derivingDataVersion derivingDataVersionCPP - $ replace languagePragma languagePragmaCPP vf - - renameFile versionFileTmp versionFile - -unpackPatchedCabal - :: Options - -> Version - -> FilePath - -> CabalPatchDescription - -> IO CabalSourceDir -unpackPatchedCabal opts cabalVer tmpdir (CabalPatchDescription _ variant patch) = do - res@(CabalSourceDir dir) <- unpackCabal opts cabalVer tmpdir variant - patch dir - return res - -data UnpackCabalVariant = Pristine | LatestRevision -newtype CabalSourceDir = CabalSourceDir { unCabalSourceDir :: FilePath } -unpackCabal - :: Options -> Version -> FilePath -> UnpackCabalVariant -> IO CabalSourceDir -unpackCabal opts cabalVer tmpdir variant = do - let cabal = "Cabal-" ++ showVersion cabalVer - dir = tmpdir cabal - variant_opts = case variant of Pristine -> [ "--pristine" ]; _ -> [] - args = [ "get", cabal ] ++ variant_opts - callProcessStderr opts (Just tmpdir) (oCabalProgram opts) args - return $ CabalSourceDir dir - -unpackCabalHEAD :: Options -> FilePath -> IO (CabalSourceDir, CommitId) -unpackCabalHEAD opts tmpdir = do - let dir = tmpdir "cabal-head.git" - url = "https://github.com/haskell/cabal.git" - ExitSuccess <- rawSystem "git" [ "clone", "--depth=1", url, dir] - commit <- - withDirectory_ dir $ trim <$> readProcess' opts "git" ["rev-parse", "HEAD"] "" - return (CabalSourceDir $ dir "Cabal", CommitId commit) - where - withDirectory_ :: FilePath -> IO a -> IO a - withDirectory_ dir action = - bracket - (liftIO getCurrentDirectory) - (liftIO . setCurrentDirectory) - (\_ -> liftIO (setCurrentDirectory dir) >> action) - -errorInstallCabal :: Version -> FilePath -> IO a -errorInstallCabal cabalVer _distdir = panicIO $ printf "\ -\Installing Cabal version %s failed.\n\ +errorInstallCabal :: CabalVersion' a -> IO b +errorInstallCabal (CabalHEAD _) = + error "cabal-helper: Installing Cabal HEAD failed." +errorInstallCabal (CabalVersion cabalVer) = panicIO $ printf "\ +\cabal-helper: Installing Cabal version %s failed.\n\ \\n\ \You have the following choices to fix this:\n\ \\n\ @@ -637,8 +435,8 @@ \ $ cabal clean && cabal configure\n\ \\n\ \- If that fails you can try to install the version of Cabal mentioned above\n\ -\ into your global/user package-db somehow, you'll probably have to fix\n\ -\ something otherwise it wouldn't have failed above:\n\ +\ into your global/user package-db somehow, though you'll probably have to\n\ +\ fix something otherwise it wouldn't have failed above:\n\ \ $ cabal install Cabal --constraint 'Cabal == %s'\n\ \\n\ \- If you're using `Build-Type: Simple`:\n\ @@ -660,65 +458,6 @@ \\n" sver sver where sver = showVersion cabalVer - -listCabalVersions :: Options -> MaybeT IO [Version] -listCabalVersions opts = listCabalVersions' opts Nothing - -listCabalVersions' :: Options -> Maybe PackageDbDir -> MaybeT IO [Version] -listCabalVersions' opts@Options {..} mdb = do - case mdb of - Nothing -> mzero - Just (PackageDbDir db_path) -> do - exists <- liftIO $ doesDirectoryExist db_path - case exists of - False -> mzero - True -> MaybeT $ logIOError opts "listCabalVersions'" $ Just <$> do - let mdbopt = ("--package-conf="++) <$> unPackageDbDir <$> mdb - args = ["list", "--simple-output", "Cabal"] ++ maybeToList mdbopt - - catMaybes . map (fmap snd . parsePkgId . fromString) . words - <$> readProcess' opts oGhcPkgProgram args "" - -cabalVersionExistsInPkgDb :: Options -> Version -> PackageDbDir -> IO Bool -cabalVersionExistsInPkgDb opts cabalVer db@(PackageDbDir db_path) = do - exists <- doesDirectoryExist db_path - case exists of - False -> return False - True -> fromMaybe False <$> runMaybeT (do - vers <- listCabalVersions' opts (Just db) - return $ cabalVer `elem` vers) - -ghcVersion :: Options -> IO Version -ghcVersion opts@Options {..} = do - parseVer . trim <$> readProcess' opts oGhcProgram ["--numeric-version"] "" - -ghcPkgVersion :: Options -> IO Version -ghcPkgVersion opts@Options {..} = do - parseVer . trim . dropWhile (not . isDigit) <$> readProcess' opts oGhcPkgProgram ["--version"] "" - -newtype CabalInstallVersion = CabalInstallVersion { cabalInstallVer :: Version } -cabalInstallVersion :: Options -> IO CabalInstallVersion -cabalInstallVersion opts@Options {..} = do - CabalInstallVersion . parseVer . trim - <$> readProcess' opts oCabalProgram ["--numeric-version"] "" - -createPkgDb :: Options -> CabalVersion -> IO PackageDbDir -createPkgDb opts@Options {..} cabalVer = do - db@(PackageDbDir db_path) <- getPrivateCabalPkgDb opts cabalVer - exists <- doesDirectoryExist db_path - when (not exists) $ callProcessStderr opts Nothing oGhcPkgProgram ["init", db_path] - return db - -getPrivateCabalPkgDb :: Options -> CabalVersion -> IO PackageDbDir -getPrivateCabalPkgDb opts cabalVer = do - appdir <- appCacheDir - ghcVer <- ghcVersion opts - let db_path = appdir exeName cabalVer - ++ "-ghc" ++ showVersion ghcVer - ++ ".package-db" - return $ PackageDbDir db_path - --- "Cabal" ++ ver ++ "-ghc" ++ showVersion ghcVer -- | Find @version: XXX@ delcaration in a cabal file cabalFileVersion :: String -> Version diff --git a/src/CabalHelper/Compiletime/Data.hs b/src/CabalHelper/Compiletime/Data.hs --- a/src/CabalHelper/Compiletime/Data.hs +++ b/src/CabalHelper/Compiletime/Data.hs @@ -1,18 +1,13 @@ -- cabal-helper: Simple interface to Cabal's configuration state -- Copyright (C) 2015-2017 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . +-- http://www.apache.org/licenses/LICENSE-2.0 {-# LANGUAGE TemplateHaskell, ScopedTypeVariables #-} {-# OPTIONS_GHC -fforce-recomp #-} @@ -20,16 +15,20 @@ {-| Module : CabalHelper.Compiletime.Data Description : Embeds source code for runtime component using TH -License : GPL-3 +License : Apache-2.0 -} module CabalHelper.Compiletime.Data where import Control.Monad import Control.Monad.IO.Class +import Data.Digest.Pure.SHA import Data.Functor +import Data.List import qualified Data.ByteString as BS import qualified Data.ByteString.UTF8 as UTF8 +import qualified Data.ByteString.Lazy as LBS +import qualified Data.ByteString.Lazy.UTF8 as LUTF8 import Language.Haskell.TH import System.Directory import System.FilePath @@ -71,11 +70,32 @@ BS.writeFile path $ UTF8.fromString src setFileTimes path modtime modtime +sourceHash :: String +sourceHash = fst runtimeSources sourceFiles :: [(FilePath, String)] -sourceFiles = - [ ("Runtime/Main.hs", $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "src/CabalHelper/Runtime/Main.hs"))) - , ("Shared/Common.hs", $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "src/CabalHelper/Shared/Common.hs"))) - , ("Shared/Sandbox.hs", $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "src/CabalHelper/Shared/Sandbox.hs"))) - , ("Shared/InterfaceTypes.hs", $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "src/CabalHelper/Shared/InterfaceTypes.hs"))) - ] +sourceFiles = snd runtimeSources + +runtimeSources :: (String, [(FilePath, FilePath)]) +runtimeSources = $( + let files = map (\f -> (f, ("src/CabalHelper" f))) $ sort $ + [ ("Runtime/Main.hs") + , ("Runtime/HelperMain.hs") + , ("Runtime/Compat.hs") + , ("Shared/Common.hs") + , ("Shared/InterfaceTypes.hs") + ] + in do + contents <- mapM (\lf -> runIO (LBS.readFile lf)) $ map snd files + let hashes = map (bytestringDigest . sha256) contents + let top_hash = showDigest $ sha256 $ LBS.concat hashes + + thfiles <- forM (map fst files `zip` contents) $ \(f, xs) -> do + return $ TupE [LitE (StringL f), LitE (StringL (LUTF8.toString xs))] + + + return $ TupE [LitE (StringL top_hash), ListE thfiles] + + ) + +-- - $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile diff --git a/src/CabalHelper/Compiletime/Log.hs b/src/CabalHelper/Compiletime/Log.hs --- a/src/CabalHelper/Compiletime/Log.hs +++ b/src/CabalHelper/Compiletime/Log.hs @@ -1,45 +1,35 @@ -- cabal-helper: Simple interface to Cabal's configuration state --- Copyright (C) 2017-2018 Daniel Gröber +-- Copyright (C) 2018 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . - -{-# LANGUAGE ScopedTypeVariables #-} +-- http://www.apache.org/licenses/LICENSE-2.0 {-| Module : CabalHelper.Compiletime.Log -Description : Basic logging facilities -License : GPL-3 +Description : Logging utilities +License : Apache-2.0 -} module CabalHelper.Compiletime.Log where -import Control.Monad import Control.Monad.IO.Class -import Control.Exception as E -import Data.String import System.IO -import Prelude +import System.IO.Error import CabalHelper.Compiletime.Types -vLog :: MonadIO m => Options -> String -> m () -vLog Options { oVerbose = True } msg = - liftIO $ hPutStrLn stderr msg -vLog _ _ = return () - -logIOError :: Options -> String -> IO (Maybe a) -> IO (Maybe a) -logIOError opts label a = do - a `E.catch` \(ex :: IOError) -> do - vLog opts $ label ++ ": " ++ show ex +logIOError :: Verbose => String -> IO (Maybe a) -> IO (Maybe a) +logIOError label a = do + a `catchIOError` \ex -> do + vLog $ label ++ ": " ++ show ex return Nothing + +vLog :: (MonadIO m, Verbose) => String -> m () +vLog msg + | ?verbose 0 = liftIO $ hPutStrLn stderr msg + | otherwise = return () diff --git a/src/CabalHelper/Compiletime/Process.hs b/src/CabalHelper/Compiletime/Process.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/Process.hs @@ -0,0 +1,115 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-| +Module : CabalHelper.Compiletime.Process +Description : System process utilities +License : Apache-2.0 +-} + +module CabalHelper.Compiletime.Process + ( module CabalHelper.Compiletime.Process + , module System.Process + ) where + +import Control.Arrow (second) +import Data.Char +import Data.List +import qualified Data.Map.Strict as Map +import GHC.IO.Exception (IOErrorType(OtherError)) +import System.IO +import System.IO.Error +import System.Environment +import System.Exit +import System.Process + +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.Log + +readProcess' :: Verbose => FilePath -> [String] -> String -> IO String +readProcess' exe args inp = + readProcessStderr Nothing [] exe args inp + +readProcessStderr :: Verbose => Maybe FilePath -> [(String, EnvOverride)] + -> FilePath -> [String] -> String -> IO String +readProcessStderr mcwd env exe args inp = do + logProcessCall mcwd env exe args + env' <- execEnvOverrides env + outp <- readCreateProcess (proc exe args) + { cwd = mcwd + , env = if env == [] then Nothing else Just env' + } inp + vLog $ unlines $ map ("=> "++) $ lines outp + return outp + +-- | Essentially 'System.Process.callProcess' but returns exit code, has +-- additional options and logging to stderr when verbosity is enabled. +callProcessStderr' + :: Verbose => Maybe FilePath -> [(String, EnvOverride)] + -> FilePath -> [String] -> IO ExitCode +callProcessStderr' mcwd env exe args = do + logProcessCall mcwd env exe args + env' <- execEnvOverrides env + (_, _, _, h) <- createProcess (proc exe args) + { std_out = UseHandle stderr + , env = if env == [] then Nothing else Just env' + , cwd = mcwd + } + waitForProcess h + +logProcessCall :: Verbose => Maybe FilePath -> [(String, EnvOverride)] + -> FilePath -> [String] -> IO () +logProcessCall mcwd env exe args = do + vLog $ intercalate " " $ cd ++ env_args ++ map formatProcessArg (exe:args) + where + env_args = map (\(k,v) -> k ++ "=" ++ show v) env + cd = case mcwd of + Nothing -> []; Just cwd -> [ "cd", formatProcessArg cwd++";" ] + +execEnvOverride :: EnvOverride -> String -> String +execEnvOverride (EnvPrepend x) y = x ++ y +execEnvOverride (EnvAppend y) x = x ++ y +execEnvOverride (EnvReplace x) _ = x + +execEnvOverrides :: [(String, EnvOverride)] -> IO [(String, String)] +execEnvOverrides overrides = do + envs <- getEnvironment + return $ do + (k,v) <- envs + case Map.lookup k overrides_map of + Just os -> return (k, foldr execEnvOverride v os) + Nothing -> return (k, v) + where + overrides_map = Map.fromListWith (++) $ map (second (:[])) overrides + +-- | Essentially 'System.Process.callProcess' but with additional options +-- and logging to stderr when verbosity is enabled. +callProcessStderr :: Verbose => Maybe FilePath -> [(String, EnvOverride)] + -> FilePath -> [String] -> IO () +callProcessStderr mwd env exe args = do + rv <- callProcessStderr' mwd env exe args + case rv of + ExitSuccess -> return () + ExitFailure v -> processFailedException "callProcessStderr" exe args v + +processFailedException :: String -> String -> [String] -> Int -> IO a +processFailedException fn exe args rv = + ioError $ mkIOError OtherError msg Nothing Nothing + where + msg = concat [ fn, ": ", exe, " " + , intercalate " " (map formatProcessArg args) + , " (exit " ++ show rv ++ ")" + ] + +formatProcessArg :: String -> String +formatProcessArg xs + | any isSpace xs = "'"++ xs ++"'" + | otherwise = xs diff --git a/src/CabalHelper/Compiletime/Program/CabalInstall.hs b/src/CabalHelper/Compiletime/Program/CabalInstall.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/Program/CabalInstall.hs @@ -0,0 +1,369 @@ +{-# LANGUAGE DataKinds, MultiWayIf, TupleSections, GADTs, OverloadedStrings #-} + +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-| +Module : CabalHelper.Compiletime.Program.Cabal +Description : cabal-install program interface +License : Apache-2.0 +-} + +module CabalHelper.Compiletime.Program.CabalInstall where + +import Control.Arrow ((&&&)) +import qualified Cabal.Plan as CP +import Control.Monad +import Data.Coerce +import Data.List.NonEmpty (NonEmpty((:|))) +import Data.Semigroup ((<>)) +import Data.Maybe +import Data.Version +import System.IO +import System.IO.Temp +import System.Directory +import System.Environment +import System.FilePath +import Text.Printf +import Text.Read + +import Data.Map.Strict (Map) +import qualified Data.Map.Strict as Map +import qualified Data.Set as Set +import qualified Data.Text as Text + +import qualified CabalHelper.Compiletime.Cabal as Cabal +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.Program.GHC + ( GhcVersion(..), createPkgDb ) +import CabalHelper.Compiletime.Cabal + ( CabalSourceDir(..), UnpackedCabalVersion, CabalVersion'(..), unpackCabalV1 ) +import CabalHelper.Compiletime.Process +import CabalHelper.Shared.InterfaceTypes + ( ChComponentName(..), ChLibraryName(..) ) +import CabalHelper.Shared.Common + ( parseVer, trim, appCacheDir, panicIO ) + +newtype CabalInstallVersion = CabalInstallVersion { cabalInstallVer :: Version } + +data HEAD = HEAD deriving (Eq, Show) + +cabalInstallVersion :: (Verbose, Progs) => IO CabalInstallVersion +cabalInstallVersion = do + CabalInstallVersion . parseVer . trim + <$> readProcess' (cabalProgram ?progs) ["--numeric-version"] "" + +installCabalLibV1 :: Env => GhcVersion -> UnpackedCabalVersion -> IO PackageDbDir +installCabalLibV1 ghcVer cabalVer = do + withSystemTempDirectory "cabal-helper.install-cabal-tmp" $ \tmpdir -> do + installingMessage cabalVer + srcdir <- unpackCabalV1 cabalVer tmpdir + + db <- createPkgDb cabalVer + + callCabalInstall db srcdir ghcVer cabalVer + + return db + +installingMessage :: CabalVersion' a -> IO () +installingMessage = message + where + message (CabalHEAD {}) = return () -- only used for tests + message (CabalVersion ver) = do + appdir <- appCacheDir + let sver = showVersion ver + -- TODO: dumping this to stderr is not really acceptable, we need to have + -- a way to let API clients override this! + hPutStr stderr $ printf "\ +\cabal-helper: Installing a private copy of Cabal because we couldn't\n\ +\find the right version anywhere on your system. You can set the environment\n\ +\variable CABAL_HELPER_DEBUG=1 to see where we searched.\n\ +\\n\ +\Note that this installation might take a little while but it will only\n\ +\happen once per Cabal library version used in your build-plans.\n\ +\\n\ +\If you want to avoid this automatic installation altogether install\n\ +\version %s of the Cabal library manually, either using cabal or your\n\ +\system package manager. With cabal you can use the following command:\n\ +\ $ cabal install Cabal --constraint \"Cabal == %s\"\n\ +\\n\ +\FYI the build products and cabal-helper executable cache are all in the\n\ +\following directory, you can simply delete it if you think something\n\ +\is broken :\n\ +\ %s\n\ +\Please do report any problems you encounter.\n\ +\\n\ +\Installing Cabal %s ...\n" sver sver appdir sver + +callCabalInstall + :: Env + => PackageDbDir + -> CabalSourceDir + -> GhcVersion + -> UnpackedCabalVersion + -> IO () +callCabalInstall + (PackageDbDir db) + (CabalSourceDir srcdir) + ghcVer + unpackedCabalVer + = do + civ@CabalInstallVersion {..} <- cabalInstallVersion + cabal_opts <- return $ concat + [ + [ "--package-db=clear" + , "--package-db=global" + , "--package-db=" ++ db + , "--prefix=" ++ db "prefix" + ] + , cabalWithGHCProgOpts + , if cabalInstallVer >= Version [1,20,0,0] [] + then ["--no-require-sandbox"] + else [] + , [ "install", srcdir ] + , if | ?verbose 3 -> ["-v2"] + | ?verbose 4 -> ["-v3"] + | otherwise -> [] + , [ "--only-dependencies" ] + ] + + callProcessStderr (Just "/") [] (cabalProgram ?progs) cabal_opts + + runSetupHs ghcVer db srcdir unpackedCabalVer civ + + hPutStrLn stderr "done" + +runSetupHs + :: Env + => GhcVersion + -> FilePath + -> FilePath + -> UnpackedCabalVersion + -> CabalInstallVersion + -> IO () +runSetupHs ghcVer db srcdir cabalVer CabalInstallVersion {..} + | cabalInstallVer >= parseVer "1.24" = do + go $ \args -> callProcessStderr (Just srcdir) [] (cabalProgram ?progs) $ + [ "act-as-setup", "--" ] ++ args + | otherwise = do + SetupProgram {..} <- compileSetupHs ghcVer db srcdir + go $ callProcessStderr (Just srcdir) [] setupProgram + where + parmake_opt :: Maybe Int -> [String] + parmake_opt nproc' + | CabalHEAD _ <- cabalVer = + ["-j"++nproc] + | CabalVersion ver <- cabalVer, ver >= Version [1,20] [] = + ["-j"++nproc] + | otherwise = + [] + where + nproc = fromMaybe "" $ show <$> nproc' + go :: ([String] -> IO ()) -> IO () + go run = do + run $ [ "configure", "--package-db", db, "--prefix", db "prefix" ] + ++ cabalWithGHCProgOpts + mnproc <- join . fmap readMaybe <$> lookupEnv "NPROC" + run $ [ "build" ] ++ parmake_opt mnproc + run [ "copy" ] + run [ "register" ] + +newtype SetupProgram = SetupProgram { setupProgram :: FilePath } +compileSetupHs :: Env => GhcVersion -> FilePath -> FilePath -> IO SetupProgram +compileSetupHs (GhcVersion ghcVer) db srcdir = do + let no_version_macros + | ghcVer >= Version [8] [] = [ "-fno-version-macros" ] + | otherwise = [] + + file = srcdir "Setup" + + callProcessStderr (Just srcdir) [] (ghcProgram ?progs) $ concat + [ [ "--make" + , "-package-conf", db + ] + , no_version_macros + , [ file <.> "hs" + , "-o", file + ] + ] + return $ SetupProgram file + +cabalWithGHCProgOpts :: Progs => [String] +cabalWithGHCProgOpts = concat + [ [ "--with-ghc=" ++ ghcProgram ?progs ] + -- Only pass ghc-pkg if it was actually set otherwise we + -- might break cabal's guessing logic + , if ghcPkgProgram ?progs /= ghcPkgProgram defaultPrograms + then [ "--with-ghc-pkg=" ++ ghcPkgProgram ?progs ] + else [] + ] + +installCabalLibV2 :: Env => GhcVersion -> UnpackedCabalVersion -> PackageEnvFile -> IO () +installCabalLibV2 _ghcVer cv (PackageEnvFile env_file) = do + exists <- doesFileExist env_file + if exists + then return () + else do + installingMessage cv + (target, cwd) <- case cv of + CabalVersion cabalVer -> do + tmp <- getTemporaryDirectory + return $ ("Cabal-"++showVersion cabalVer, tmp) + CabalHEAD (_commitid, CabalSourceDir srcdir) -> do + return (".", srcdir) + CabalInstallVersion {..} <- cabalInstallVersion + cabal_opts <- return $ concat + [ if cabalInstallVer >= Version [1,20] [] + then ["--no-require-sandbox"] + else [] + , [ if cabalInstallVer >= Version [2,4] [] + then "v2-install" + else "new-install" + ] + , cabalV2WithGHCProgOpts + , [ "--package-env=" ++ env_file + , "--lib" + , target + ] + , if | ?verbose 3 -> ["-v2"] + | ?verbose 4 -> ["-v3"] + | otherwise -> [] + ] + callProcessStderr (Just cwd) [] (cabalProgram ?progs) cabal_opts + hPutStrLn stderr "done" + + +cabalV2WithGHCProgOpts :: Progs => [String] +cabalV2WithGHCProgOpts = concat + [ [ "--with-compiler=" ++ ghcProgram ?progs ] + , if ghcPkgProgram ?progs /= ghcPkgProgram defaultPrograms + then [ "--with-hc-pkg=" ++ ghcPkgProgram ?progs ] + else [] + ] + +planPackages :: CP.PlanJson -> IO [Package ('Cabal 'CV2)] +planPackages plan = do + fmap Map.elems $ + mapM mkPackage $ + groupByMap $ Map.elems $ + Map.filter ((==CP.UnitTypeLocal) . CP.uType) $ + CP.pjUnits plan + where + groupByMap = Map.fromListWith (<>) . map (CP.uPId &&& (:|[])) + + mkPackage :: NonEmpty CP.Unit -> IO (Package ('Cabal 'CV2)) + mkPackage units@(unit :| _) = + case unit of + CP.Unit + { uPkgSrc=Just (CP.LocalUnpackedPackage pkgdir) + } -> do + cabal_file <- Cabal.complainIfNoCabalFile pkgdir =<< Cabal.findCabalFile pkgdir + let pkg = Package + { pPackageName = + let CP.PkgId (CP.PkgName pkg_name) _ = CP.uPId unit + in Text.unpack pkg_name + , pSourceDir = pkgdir + , pCabalFile = CabalFile cabal_file + , pFlags = [] + , pUnits = fmap (\u -> fixBackpackUnit u $ mkUnit pkg { pUnits = () } u) units + } + return pkg + _ -> panicIO "planPackages.mkPackage: Got non-unpacked package src!" + + takeBackpackIndefUnitId :: CP.Unit -> Maybe CP.UnitId + takeBackpackIndefUnitId CP.Unit {uId=CP.UnitId uid} + | Text.any (=='+') uid = Just $ CP.UnitId $ Text.takeWhile (/='+') uid + | otherwise = Nothing + + findUnitsDependingOn :: CP.UnitId -> [CP.Unit] + findUnitsDependingOn uid = Map.elems $ + Map.filter (any (Set.member uid . CP.ciLibDeps) . Map.elems . CP.uComps) $ + CP.pjUnits plan + + -- Horrible workaround for https://github.com/haskell/cabal/issues/6201 + fixBackpackUnit plan_unit ch_unit + | Just indef_uid <- takeBackpackIndefUnitId plan_unit = do + let deps = findUnitsDependingOn indef_uid + ch_unit { uImpl = (uImpl ch_unit) + { uiV2Components = concatMap unitTargets deps + , uiV2OnlyDependencies = True + } } + | otherwise = + ch_unit + + unitTargets :: CP.Unit -> [String] + unitTargets CP.Unit {uComps, uPId=CP.PkgId pkg_name _} = + map (Text.unpack . (((coerce pkg_name) <> ":") <>) . CP.dispCompNameTarget pkg_name) $ + Map.keys uComps + + mkUnit :: Package' () -> CP.Unit -> Unit ('Cabal 'CV2) + mkUnit pkg u@CP.Unit + { uDistDir=Just distdirv1 + , uComps=comps + , uPId=CP.PkgId pkg_name _ + , uId + } = + Unit + { uUnitId = UnitId $ Text.unpack (coerce uId) + , uPackage = pkg + , uDistDir = DistDirLib distdirv1 + , uImpl = + let + comp_names = Map.keys comps + uiV2ComponentNames = map cpCompNameToChComponentName comp_names + uiV2Components = unitTargets u + uiV2OnlyDependencies = False + in UnitImplV2 {..} + } + mkUnit _ _ = + error "planPackages.mkUnit: Got package without distdir!" + +cpCompNameToChComponentName :: CP.CompName -> ChComponentName +cpCompNameToChComponentName cn = + case cn of + CP.CompNameSetup -> ChSetupHsName + CP.CompNameLib -> ChLibName ChMainLibName + (CP.CompNameSubLib name) -> ChLibName $ ChSubLibName $ Text.unpack name + (CP.CompNameFLib name) -> ChFLibName $ Text.unpack name + (CP.CompNameExe name) -> ChExeName $ Text.unpack name + (CP.CompNameTest name) -> ChTestName $ Text.unpack name + (CP.CompNameBench name) -> ChBenchName $ Text.unpack name + +data CabalInstallCommand + = CIConfigure + | CIBuild + +doCabalInstallCmd + :: (QueryEnvI c ('Cabal cpt) -> CallProcessWithCwdAndEnv a) + -> QueryEnvI c ('Cabal cpt) + -> Maybe FilePath -> CabalInstallCommand -> [String] -> IO a +doCabalInstallCmd procfn qe mcwd cmd args = do + case (cmd, projTypeOfQueryEnv qe) of + (CIConfigure, SCabal SCV1) -> + run "v1-configure" cabalProjArgs cabalUnitArgs [] + (CIBuild, SCabal SCV1) -> + run "v1-build" cabalProjArgs [] [] + (_, SCabal SCV2) -> + run "v2-build" cabalProjArgs cabalUnitArgs [] + where + Programs{..} = qePrograms qe + run cmdarg before aftercmd after = procfn qe mcwd [] cabalProgram $ + before ++ [cmdarg] ++ aftercmd ++ args ++ after + +readCabalInstallCmd + :: QueryEnvI c ('Cabal cpt) + -> Maybe FilePath -> CabalInstallCommand -> [String] -> IO String +callCabalInstallCmd + :: QueryEnvI c ('Cabal cpt) + -> Maybe FilePath -> CabalInstallCommand -> [String] -> IO () + +readCabalInstallCmd = doCabalInstallCmd (\qe -> qeReadProcess qe "") +callCabalInstallCmd = doCabalInstallCmd qeCallProcess diff --git a/src/CabalHelper/Compiletime/Program/GHC.hs b/src/CabalHelper/Compiletime/Program/GHC.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/Program/GHC.hs @@ -0,0 +1,155 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-| +Module : CabalHelper.Compiletime.Program.GHC +Description : GHC program interface +License : Apache-2.0 +-} + +module CabalHelper.Compiletime.Program.GHC where + +import Control.Monad +import Control.Monad.Trans.Maybe +import Control.Monad.IO.Class +import Data.Char +import Data.List +import Data.Maybe +import Data.Version +import System.Exit +import System.FilePath +import System.Directory + +import CabalHelper.Shared.Common + (parseVer, trim, appCacheDir, parsePkgId) +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.Cabal + ( ResolvedCabalVersion, showResolvedCabalVersion, UnpackedCabalVersion + , unpackedToResolvedCabalVersion, CabalVersion'(..) ) +import CabalHelper.Compiletime.Process +import CabalHelper.Compiletime.Log + +data GhcPackageSource + = GPSAmbient + | GPSPackageDBs ![PackageDbDir] + | GPSPackageEnv !PackageEnvFile + +data GhcInvocation = GhcInvocation + { giOutDir :: !FilePath + , giOutput :: !FilePath + , giCPPOptions :: ![String] + , giPackageSource :: !GhcPackageSource + , giIncludeDirs :: ![FilePath] + , giHideAllPackages :: !Bool + , giPackages :: ![String] + , giWarningFlags :: ![String] + , giInputs :: ![String] + } + +newtype GhcVersion = GhcVersion { unGhcVersion :: Version } + deriving (Eq, Ord, Read, Show) + +showGhcVersion :: GhcVersion -> String +showGhcVersion (GhcVersion v) = showVersion v + +ghcVersion :: (Verbose, Progs) => IO GhcVersion +ghcVersion = GhcVersion . + parseVer . trim <$> readProcess' (ghcProgram ?progs) ["--numeric-version"] "" + +ghcPkgVersion :: (Verbose, Progs) => IO Version +ghcPkgVersion = + parseVer . trim . dropWhile (not . isDigit) + <$> readProcess' (ghcPkgProgram ?progs) ["--version"] "" + +createPkgDb :: (Verbose, Progs) => UnpackedCabalVersion -> IO PackageDbDir +createPkgDb cabalVer = do + db@(PackageDbDir db_path) + <- getPrivateCabalPkgDb $ unpackedToResolvedCabalVersion cabalVer + exists <- doesDirectoryExist db_path + when (not exists) $ + callProcessStderr Nothing [] (ghcPkgProgram ?progs) ["init", db_path] + return db + +getPrivateCabalPkgDb :: (Verbose, Progs) => ResolvedCabalVersion -> IO PackageDbDir +getPrivateCabalPkgDb cabalVer = do + appdir <- appCacheDir + ghcVer <- ghcVersion + let db_path = + appdir "ghc-" ++ showGhcVersion ghcVer ++ ".package-dbs" + "Cabal-" ++ showResolvedCabalVersion cabalVer + return $ PackageDbDir db_path + +getPrivateCabalPkgEnv + :: Verbose => GhcVersion -> ResolvedCabalVersion -> IO PackageEnvFile +getPrivateCabalPkgEnv ghcVer cabalVer = do + appdir <- appCacheDir + let env_path = + appdir "ghc-" ++ showGhcVersion ghcVer ++ ".package-envs" + "Cabal-" ++ showResolvedCabalVersion cabalVer ++ ".package-env" + return $ PackageEnvFile env_path + +listCabalVersions + :: (Verbose, Progs) => Maybe PackageDbDir -> MaybeT IO [Version] +listCabalVersions mdb = do + let mdb_path = unPackageDbDir <$> mdb + exists <- fromMaybe True <$> + traverse (liftIO . doesDirectoryExist) mdb_path + case exists of + True -> MaybeT $ logIOError "listCabalVersions" $ Just <$> do + let mdbopt = ("--package-conf="++) <$> mdb_path + args = ["list", "--simple-output", "Cabal"] ++ maybeToList mdbopt + catMaybes . map (fmap snd . parsePkgId) . words + <$> readProcess' (ghcPkgProgram ?progs) args "" + _ -> mzero + +cabalVersionExistsInPkgDb + :: (Verbose, Progs) => CabalVersion' a -> PackageDbDir -> IO Bool +cabalVersionExistsInPkgDb cabalVer db@(PackageDbDir db_path) = do + fromMaybe False <$> runMaybeT (do + vers <- listCabalVersions (Just db) + return $ + case (cabalVer, vers) of + (CabalVersion ver, _) -> ver `elem` vers + (CabalHEAD _, []) -> False + (CabalHEAD _, [_headver]) -> True + (CabalHEAD _, _) -> + error $ msg ++ db_path) + where + msg = "\ +\Multiple Cabal versions in a HEAD package-db!\n\ +\This shouldn't happen. However you can manually delete the following\n\ +\directory to resolve this:\n " + +invokeGhc :: Env => GhcInvocation -> IO (Either ExitCode FilePath) +invokeGhc GhcInvocation {..} = do + rv <- callProcessStderr' (Just "/") [] (ghcProgram ?progs) $ concat + [ [ "-outputdir", giOutDir + , "-o", giOutput + ] + , map ("-optP"++) giCPPOptions + , if giHideAllPackages then ["-hide-all-packages"] else [] + , let packageFlags = concatMap (\p -> ["-package", p]) giPackages in + case giPackageSource of + GPSAmbient -> packageFlags + GPSPackageDBs dbs -> concat + [ map ("-package-conf="++) $ unPackageDbDir <$> dbs + , packageFlags + ] + GPSPackageEnv env -> [ "-package-env=" ++ unPackageEnvFile env ] + , map ("-i"++) $ nub $ "" : giIncludeDirs + , giWarningFlags + , ["--make"] + , giInputs + ] + return $ + case rv of + ExitSuccess -> Right giOutput + e@(ExitFailure _) -> Left e diff --git a/src/CabalHelper/Compiletime/Program/Stack.hs b/src/CabalHelper/Compiletime/Program/Stack.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/Program/Stack.hs @@ -0,0 +1,141 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-| +Module : CabalHelper.Compiletime.Program.Stack +Description : Stack program interface +License : Apache-2.0 +-} + +{-# LANGUAGE GADTs, DataKinds #-} + +module CabalHelper.Compiletime.Program.Stack where + +import Control.Exception (handle, throwIO) +import Control.Monad +import Control.Monad.Trans.Maybe +import Control.Monad.IO.Class +import Data.Char +import Data.List hiding (filter) +import Data.List.NonEmpty (NonEmpty(..)) +import Data.String +import Data.Maybe +import Data.Function +import Data.Version +import System.Directory (findExecutable) +import System.FilePath hiding ((<.>)) +import System.IO (hPutStrLn, stderr) +import Text.Printf (printf) +import Prelude + +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.Types.RelativePath +import CabalHelper.Shared.Common + +getPackage :: QueryEnvI c 'Stack -> CabalFile -> IO (Package 'Stack) +getPackage qe cabal_file@(CabalFile cabal_file_path) = do + let pkgdir = takeDirectory cabal_file_path + -- this is kind of a hack but works even for unicode package names and + -- besides stack even enforces this naming convention unlike cabal. This + -- is the error you get if the names don't match: + -- + -- cabal file path foo-bla.cabal does not match the package name it defines. + -- Please rename the file to: foo.cabal + -- For more information, see: + -- https://github.com/commercialhaskell/stack/issues/317 + let pkg_name = dropExtension $ takeFileName cabal_file_path + look <- paths qe pkgdir + let distdirv1_rel = look "dist-dir:" + let pkg = Package + { pPackageName = pkg_name + , pSourceDir = pkgdir + , pCabalFile = cabal_file + , pFlags = [] + , pUnits = (:|[]) $ Unit + { uUnitId = UnitId pkg_name + , uDistDir = DistDirLib $ pkgdir distdirv1_rel + , uPackage = pkg { pUnits = () } + , uImpl = UnitImplStack + } + } + return pkg + +projPaths :: QueryEnvI c 'Stack -> IO StackProjPaths +projPaths qe@QueryEnv {qeProjLoc} = do + look <- paths qe $ plStackProjectDir qeProjLoc + return StackProjPaths + { sppGlobalPkgDb = PackageDbDir $ look "global-pkg-db:" + , sppSnapPkgDb = PackageDbDir $ look "snapshot-pkg-db:" + , sppLocalPkgDb = PackageDbDir $ look "local-pkg-db:" + , sppCompExe = look "compiler-exe:" + } + +paths :: QueryEnvI c 'Stack -> FilePath -> IO (String -> FilePath) +paths qe@QueryEnv{qeProjLoc=ProjLocStackYaml stack_yaml} cwd + = do + out <- readStackCmd qe (Just cwd) $ + workdirArg qe ++ [ "path", "--stack-yaml="++stack_yaml ] + return $ \k -> let Just x = lookup k $ map split $ lines out in x + where + split l = let (key, ' ' : val) = span (not . isSpace) l in (key, val) + +listPackageCabalFiles :: QueryEnvI c 'Stack -> IO [CabalFile] +listPackageCabalFiles qe@QueryEnv{qeProjLoc} + = handle ioerror $ do + let projdir = plStackProjectDir qeProjLoc + out <- readStackCmd qe (Just projdir) + [ "ide", "packages", "--cabal-files", "--stdout" ] + return $ map CabalFile $ lines out + where + ioerror :: IOError -> IO a + ioerror ioe = (fromMaybe (throwIO ioe) =<<) $ runMaybeT $ do + stack_exe <- MaybeT $ findExecutable $ stackProgram $ qePrograms qe + stack_ver_str + <- liftIO $ trim <$> readStackCmd qe Nothing ["--numeric-version"] + stack_ver <- MaybeT $ return $ parseVerMay stack_ver_str + guard $ stack_ver < makeVersion [1,9,4] + + let prog_cfg = show $ qePrograms qe + + liftIO $ hPutStrLn stderr $ printf + "\nerror: stack version too old!\ + \\n\n\ + \You have '%s' installed but cabal-helper needs at least\n\ + \stack version 1.9.4+.\n\ + \\n\ + \FYI cabal-helper is using the following `stack` executable:\n\ + \ %s\n\ + \\n\ + \Additional debugging info: QueryEnv qePrograms =\n\ + \ %s\n" stack_ver_str stack_exe prog_cfg + mzero + +workdirArg :: QueryEnvI c 'Stack -> [String] +workdirArg QueryEnv{qeDistDir=DistDirStack mworkdir} = + maybeToList $ ("--work-dir="++) . unRelativePath <$> mworkdir + +doStackCmd :: (QueryEnvI c 'Stack -> CallProcessWithCwdAndEnv a) + -> QueryEnvI c 'Stack + -> Maybe FilePath -> [String] -> IO a +doStackCmd procfn qe mcwd args = + let Programs{..} = qePrograms qe in + procfn qe mcwd stackEnv stackProgram $ + stackProjArgs ++ args ++ stackUnitArgs + +readStackCmd :: QueryEnvI c 'Stack -> Maybe FilePath -> [String] -> IO String +callStackCmd :: QueryEnvI c 'Stack -> Maybe FilePath -> [String] -> IO () + +readStackCmd = doStackCmd (\qe -> qeReadProcess qe "") +callStackCmd = doStackCmd qeCallProcess + +patchCompPrograms :: StackProjPaths -> Programs -> Programs +patchCompPrograms StackProjPaths{sppCompExe} progs = + progs { ghcProgram = sppCompExe } diff --git a/src/CabalHelper/Compiletime/Sandbox.hs b/src/CabalHelper/Compiletime/Sandbox.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/Sandbox.hs @@ -0,0 +1,70 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2015-2017 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-| +Module : CabalHelper.Shared.Sandbox +Description : Extracting information from @cabal.sandbox.config@ files +License : Apache-2.0 +-} + +module CabalHelper.Compiletime.Sandbox where + +import Control.Applicative +import Data.Char +import Data.Maybe +import Data.List +import System.FilePath +import Prelude + +import qualified Data.Traversable as T + +import CabalHelper.Shared.Common +import CabalHelper.Compiletime.Program.GHC + ( GhcVersion (..), showGhcVersion ) + +-- | Get the path to the sandbox package-db in a project +getSandboxPkgDb :: String + -- ^ Cabal build platform, i.e. @buildPlatform@ + -> GhcVersion + -- ^ GHC version (@cProjectVersion@ is your friend) + -> FilePath + -- ^ Path to the cabal package root directory (containing the + -- @cabal.sandbox.config@ file) + -> IO (Maybe FilePath) +getSandboxPkgDb platform ghcVer projdir = do + mConf <- + T.traverse readFile =<< mightExist (projdir "cabal.sandbox.config") + return $ fixPkgDbVer <$> (extractSandboxDbDir =<< mConf) + + where + fixPkgDbVer dir = + case takeFileName dir == ghcSandboxPkgDbDir platform ghcVer of + True -> dir + False -> takeDirectory dir ghcSandboxPkgDbDir platform ghcVer + +ghcSandboxPkgDbDir :: String -> GhcVersion -> String +ghcSandboxPkgDbDir platform ghcVer = + platform ++ "-ghc-" ++ showGhcVersion ghcVer ++ "-packages.conf.d" + +-- | Extract the sandbox package db directory from the cabal.sandbox.config +-- file. Exception is thrown if the sandbox config file is broken. +extractSandboxDbDir :: String -> Maybe FilePath +extractSandboxDbDir conf = extractValue <$> parse conf + where + key = "package-db:" + keyLen = length key + + parse = listToMaybe . filter (key `isPrefixOf`) . lines + extractValue = CabalHelper.Compiletime.Sandbox.dropWhileEnd isSpace . dropWhile isSpace . drop keyLen + +-- dropWhileEnd is not provided prior to base 4.5.0.0. +dropWhileEnd :: (a -> Bool) -> [a] -> [a] +dropWhileEnd p = foldr (\x xs -> if p x && null xs then [] else x : xs) [] diff --git a/src/CabalHelper/Compiletime/Types.hs b/src/CabalHelper/Compiletime/Types.hs --- a/src/CabalHelper/Compiletime/Types.hs +++ b/src/CabalHelper/Compiletime/Types.hs @@ -1,42 +1,595 @@ -- cabal-helper: Simple interface to Cabal's configuration state -- Copyright (C) 2015-2018 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . +-- http://www.apache.org/licenses/LICENSE-2.0 -{-# LANGUAGE DeriveGeneric, DeriveDataTypeable, DefaultSignatures #-} +{-# LANGUAGE DeriveGeneric, DeriveDataTypeable, DefaultSignatures, + StandaloneDeriving, GADTs, DataKinds, KindSignatures, RankNTypes, PolyKinds #-} {-| Module : CabalHelper.Compiletime.Types Description : Types used throughout -License : GPL-3 +License : Apache-2.0 -} module CabalHelper.Compiletime.Types where +import Cabal.Plan + ( PlanJson ) +import Data.ByteString (ByteString) +import Data.IORef import Data.Version +import Data.Typeable +import GHC.Generics +import System.FilePath (takeDirectory) +import System.Posix.Types +import CabalHelper.Compiletime.Types.RelativePath +import CabalHelper.Shared.InterfaceTypes -data Options = Options { - oHelp :: Bool - , oVerbose :: Bool - , oGhcProgram :: FilePath - , oGhcPkgProgram :: FilePath - , oCabalProgram :: FilePath - , oCabalVersion :: Maybe Version - , oCabalPkgDb :: Maybe PackageDbDir -} +import Data.List.NonEmpty (NonEmpty) +--import qualified Data.List.NonEmpty as NonEmpty +import Data.Map.Strict (Map) +--import qualified Data.Map.Strict as Strict -newtype PackageDbDir = PackageDbDir { unPackageDbDir :: FilePath } +-- | The kind of project being managed by a 'QueryEnv' (pun intended). Used +-- as a phantom-type variable throughout to make the project type being +-- passed into various functions correspond to the correct implementation. +data ProjType + = Cabal CabalProjType -- ^ @cabal@ project. + | Stack -- ^ @stack@ project. + deriving (Eq, Ord, Show, Read) -defaultOptions :: Options -defaultOptions = Options False False "ghc" "ghc-pkg" "cabal" Nothing Nothing +-- | The kind of a @cabal@ project. +data CabalProjType + = CV1 -- ^ @cabal v1-build@ project. + | CV2 -- ^ @cabal v2-build@ project. + deriving (Eq, Ord, Show, Read) + +-- | A "singleton" datatype for 'ProjType' which allows us to establish a +-- correspondence between a runtime representation of 'ProjType' to the +-- compile-time value at the type level. +-- +-- If you just want to know the runtime 'ProjType' use 'demoteSProjType' to +-- convert to that. +data SProjType pt where + SCabal :: !(SCabalProjType pt) -> SProjType ('Cabal pt) + SStack :: SProjType 'Stack + +deriving instance Show (SProjType pt) + +-- | This is a singleton, like 'SProjType', but restricted to just the +-- Cabal project types. We use this to restrict some functions which don't +-- make sense for Stack to just the Cabal project types. +data SCabalProjType pt where + SCV1 :: SCabalProjType 'CV1 + SCV2 :: SCabalProjType 'CV2 + +deriving instance Show (SCabalProjType pt) + +demoteSProjType :: SProjType pt -> ProjType +demoteSProjType (SCabal SCV1) = Cabal CV1 +demoteSProjType (SCabal SCV2) = Cabal CV2 +demoteSProjType SStack = Stack + +-- | Location of a project context. This is usually just the path project's +-- top-level source code directory together with an optional project-type +-- specific config file path. +-- +-- To find any recognized default project contexts in a given directory +-- use 'Distribution.Helper.Discover.findProjects'. +-- +-- Build tools usually allow the user to specify the location of their +-- project config files manually, so we also support passing this path here +-- with the @*File@ constructors. +-- +-- === Correspondence between Project and Package Source Directories +-- +-- Note that the project's source directory does not necessarily correspond +-- to the directory containing the project config file, though in some +-- cases it does. +-- +-- For example @cabal v2-build@ allows the @cabal.project@ file to be +-- positively anywhere in the filesystem when specified via the +-- @--cabal-project@ command-line flag, corresponding to the +-- 'ProjLocV2File' constructor here. This config file can then refer to +-- package directories with absolute paths in the @packages:@ declaration. +-- +-- Hence it isn't actually possible to find /one/ directory which contains +-- the whole project's source code but rather we have to consider each +-- package's source directory individually, see 'Package.pSourceDir' +data ProjLoc (pt :: ProjType) where + -- | A fully specified @cabal v1-build@ project context. Here you can + -- specify both the path to the @.cabal@ file and the source directory + -- of the package. The cabal file path corresponds to the + -- @--cabal-file=PATH@ flag on the @cabal@ command line. + -- + -- Note that more than one such files existing in a package directory + -- is a user error and while cabal will still complain about that we + -- won't. + -- + -- Also note that for this project type the concepts of project and + -- package coincide. + ProjLocV1CabalFile :: { plCabalFile :: !FilePath, plProjectDirV1 :: !FilePath } -> ProjLoc ('Cabal 'CV1) + + -- | A @cabal v1-build@ project context. Essentially the same as + -- 'ProjLocV1CabalFile' but this will dynamically search for the cabal + -- file for you as cabal-install does by default. + -- + -- If more than one @.cabal@ file is found in the given directory we + -- will shamelessly throw a obscure exception so prefer + -- 'ProjLocV1CabalFile' if you don't want that to happen. This mainly + -- exists for easy upgrading from the @cabal-helper-0.8@ series. + ProjLocV1Dir :: { plProjectDirV1 :: !FilePath } -> ProjLoc ('Cabal 'CV1) + + -- | A @cabal v2-build@ project context. The path to the + -- @cabal.project@ file, though you can call it whatever you like. This + -- configuration file then points to the packages that make up this + -- project. This corresponds to the @--cabal-project=PATH@ flag on the + -- @cabal@ command line. + ProjLocV2File :: { plCabalProjectFile :: !FilePath, plProjectDirV2 :: !FilePath } -> ProjLoc ('Cabal 'CV2) + + -- | This is equivalent to 'ProjLocV2File' but using the default + -- @cabal.project@ file name in the given directory. + ProjLocV2Dir :: { plProjectDirV2 :: !FilePath } -> ProjLoc ('Cabal 'CV2) + + -- | A @stack@ project context. Specify the path to the @stack.yaml@ + -- file here. This configuration file then points to the packages that + -- make up this project. Corresponds to @stack@'s @--stack-yaml=PATH@ + -- command line flag if different from the default name, @stack.yaml@. + -- + -- Note: with Stack the invariant @takeDirectory plStackYaml == projdir@ holds. + ProjLocStackYaml :: { plStackYaml :: !FilePath } -> ProjLoc 'Stack + +deriving instance Show (ProjLoc pt) + +plV1Dir :: ProjLoc ('Cabal 'CV1) -> FilePath +plV1Dir ProjLocV1CabalFile {plProjectDirV1} = plProjectDirV1 +plV1Dir ProjLocV1Dir {plProjectDirV1} = plProjectDirV1 + +plCabalProjectDir :: ProjLoc ('Cabal cpt) -> FilePath +plCabalProjectDir ProjLocV1CabalFile {plProjectDirV1} = plProjectDirV1 +plCabalProjectDir ProjLocV1Dir {plProjectDirV1} = plProjectDirV1 +plCabalProjectDir ProjLocV2File {plProjectDirV2} = plProjectDirV2 +plCabalProjectDir ProjLocV2Dir {plProjectDirV2} = plProjectDirV2 + +plStackProjectDir :: ProjLoc 'Stack -> FilePath +plStackProjectDir ProjLocStackYaml {plStackYaml} = takeDirectory plStackYaml + +projTypeOfProjLoc :: ProjLoc pt -> SProjType pt +projTypeOfProjLoc ProjLocV1CabalFile{} = SCabal SCV1 +projTypeOfProjLoc ProjLocV1Dir{} = SCabal SCV1 +projTypeOfProjLoc ProjLocV2File{} = SCabal SCV2 +projTypeOfProjLoc ProjLocV2Dir{} = SCabal SCV2 +projTypeOfProjLoc ProjLocStackYaml{} = SStack + +-- | A build directory for a certain project type. The @pt@ type variable +-- must be compatible with the 'ProjLoc' used. This is enforced by the type +-- system so you can't get this wrong. +data DistDir (pt :: ProjType) where + -- | A build-directory for cabal, aka. dist-dir in Cabal + -- terminology. 'SCabalProjType' specifies whether we should use + -- /v2-build/ or /v1-build/. This choice must correspond to + -- 'ProjLoc' \'s project type. + DistDirCabal :: !(SCabalProjType pt) -> !FilePath -> DistDir ('Cabal pt) + + -- | A build-directory for stack, aka. /work-dir/. Optionally override + -- Stack's /work-dir/. If you just want to use Stack's default set to + -- @Nothing@ + DistDirStack :: !(Maybe RelativePath) -> DistDir 'Stack + +deriving instance Show (DistDir pt) + +projTypeOfDistDir :: DistDir pt -> SProjType pt +projTypeOfDistDir (DistDirCabal pt _) = SCabal pt +projTypeOfDistDir DistDirStack{} = SStack + +-- | General purpose existential wrapper. Useful for hiding a phantom type +-- argument. +-- +-- Say you have: +-- +-- @ +-- {-\# LANGUAGE DataKinds, GADTS \#-} +-- data K = A | B | ... +-- data Q k where +-- QA :: ... -> Q 'A +-- QB :: ... -> Q 'B +-- @ +-- +-- and you want a list of @Q@. You can use @Ex@ to hide the phantom type +-- argument and recover it later by matching on the GADT constructors: +-- +-- @ +-- qa :: Q A +-- qa = QA +-- +-- qb :: Q B +-- qb = QB +-- +-- mylist :: [Ex Q] +-- mylist = [Ex qa, Ex qb] +-- @ +data Ex a = forall x. Ex (a x) + +-- | Environment for running a 'Query'. The constructor is not exposed in the +-- API to allow extending it with more fields without breaking user code. +-- +-- To create a 'QueryEnv' use the 'mkQueryEnv' smart constructor instead. Some +-- field accessors are exported and may be used to override the defaults filled +-- in by 'mkQueryEnv'. See below. +-- +-- Note that this environment contains an 'IORef' used as a cache. If you want +-- to take advantage of this you should not simply discard the value returned by +-- the smart constructor after one use. +type QueryEnv pt = QueryEnvI QueryCache pt + +data QueryEnvI c (pt :: ProjType) = QueryEnv + { qeReadProcess :: !ReadProcessWithCwdAndEnv + -- ^ Field accessor for 'QueryEnv'. Function used to to start processes + -- and capture output. Useful if you need to, for example, redirect + -- standard error output of programs started by cabal-helper. + + , qeCallProcess :: !(CallProcessWithCwdAndEnv ()) + -- ^ Field accessor for 'QueryEnv'. Function used to to start processes + -- without capturing output. See also 'qeReadProcess'. + + , qePrograms :: !Programs + -- ^ Field accessor for 'QueryEnv'. Paths to various programs we use. + + , qeProjLoc :: !(ProjLoc pt) + -- ^ Field accessor for 'QueryEnv'. Defines path to the project directory, + -- i.e. a directory containing a @cabal.project@ file + + , qeDistDir :: !(DistDir pt) + -- ^ Field accessor for 'QueryEnv'. Defines path to the @dist/@ or + -- @dist-newstyle/@ directory, aka. /builddir/ in Cabal terminology. + + , qeCacheRef :: !(IORef (c pt)) + -- ^ Cache for query results, only accessible when type parameter @c@ is + -- instantiated with 'QueryCache'. This is the case wherever the type alias + -- 'QueryEnv' is used. + + , qeCacheKeys :: IORef (CacheKeyCache pt) + } + +projTypeOfQueryEnv :: QueryEnvI c pt -> SProjType pt +projTypeOfQueryEnv = projTypeOfProjLoc . qeProjLoc + +type ReadProcessWithCwdAndEnv = + String -> CallProcessWithCwdAndEnv String + +type CallProcessWithCwdAndEnv a = + Maybe FilePath -> [(String, EnvOverride)] -> FilePath -> [String] -> IO a + +-- | Full instansiation of 'QueryCacheI', with all cache fields visible +type QueryCache + = QueryCacheI + PreInfo + Programs + ProjInfo + UnitInfo + +-- | 'QueryCacheI', only instantiated with 'PreInfo' cache. +type QCPreInfo progs proj_info unit_info + = QueryCacheI + PreInfo + progs + proj_info + unit_info + +-- | 'QueryCacheI', only instantiated with 'PreInfo' and configured +-- 'Programs' cache. +type QCProgs proj_info unit_info + = QueryCacheI + PreInfo + Programs + proj_info + unit_info + +data QueryCacheI pre_info progs proj_info unit_info pt = QueryCache + { qcPreInfo + :: !(Maybe ((ProjConf pt, ProjConfModTimes), pre_info pt)) + , qcConfProgs :: !(Maybe (Programs, progs)) + , qcProjInfo + :: !(Maybe ((ProjConf pt, ProjConfModTimes), proj_info pt)) + , qcUnitInfos :: !(Map DistDirLib unit_info) + } + +data CacheKeyCache pt = CacheKeyCache + { ckcProjConf :: !(Maybe (ProjConf pt, ProjConfModTimes)) + } + +newtype DistDirLib = DistDirLib FilePath + deriving (Eq, Ord, Read, Show) + +type Package pt = Package' (NonEmpty (Unit pt)) + +-- | A 'Package' is a named collection of many 'Unit's. +data Package' units = Package + { pPackageName :: !String + , pSourceDir :: !FilePath + , pCabalFile :: !CabalFile + , pFlags :: ![(String, Bool)] + -- | Cabal flags to set when configuring and building this package. + , pUnits :: !units + } deriving (Show) + +-- | A 'Unit' is essentially a "build target". It is used to refer to a set +-- of components (exes, libs, tests etc.) which are managed by a certain +-- instance of the Cabal build-system[1]. We may get information on the +-- components in a unit by retriving the corresponding 'UnitInfo'. +-- +-- \[1]: No I'm not talking about the cabal-install /build-tool/, I'm +-- talking about the Cabal /build-system/. Note the distinction. Both +-- cabal-install and Stack use the Cabal build-system (aka @lib:Cabal@) +-- underneath. +-- +-- Note that a 'Unit' value is only valid within the 'QueryEnv' context it +-- was created in, this is however this is not enforced by the +-- API. Furthermore if the user changes the underlying project +-- configuration while your application is running even a properly scoped +-- 'Unit' could become invalid because the component it belongs to was +-- removed from the cabal file. +data Unit pt = Unit + { uUnitId :: !UnitId + , uPackage :: !(Package' ()) + , uDistDir :: !DistDirLib + , uImpl :: !(UnitImpl pt) + } deriving (Show) + +data UnitImpl pt where + UnitImplV1 :: UnitImpl ('Cabal 'CV1) + + UnitImplV2 :: + { uiV2ComponentNames :: ![ChComponentName] + , uiV2Components :: ![String] + , uiV2OnlyDependencies :: !Bool + } -> UnitImpl ('Cabal 'CV2) + + UnitImplStack :: UnitImpl 'Stack + +deriving instance Show (UnitImpl pt) + +-- | This returns the component a 'Unit' corresponds to. This information is +-- only available if the correspondence happens to be unique and known before +-- querying setup-config for the respective project type. Currently this only +-- applies to @pt=@'V2'. +-- +-- This is intended to be used as an optimization, to allow reducing the number +-- of helper invocations for clients that don't need to know the entire project +-- structure. +uComponentName :: Unit pt -> Maybe ChComponentName +uComponentName Unit { uImpl=UnitImplV2 { uiV2ComponentNames=[comp] } } = + Just comp +uComponentName _ = + Nothing + +-- | The @setup-config@ header. Note that Cabal writes all the package names in +-- the header using 'Data.ByteString.Char8' and hence all characters are +-- truncated from Unicode codepoints to 8-bit Latin-1. +-- +-- We can be fairly confident that 'uhSetupId' and 'uhCompilerId' won\'t have +-- names that cause trouble here so it's ok to look at them but user packages +-- are free to have any unicode name. +data UnitHeader = UnitHeader + { uhPackageId :: !(ByteString, Version) + -- ^ Name and version of the source package. This is only going to be + -- usable for unicode package names starting with @Cabal-3.0.0.0@. See + -- 'uiPackageId' for an alternative that always works. + , uhSetupId :: !(ByteString, Version) + -- ^ Name and version of the @Setup.hs@ implementation. We expect + -- @"Cabal"@ here, naturally. + , uhCompilerId :: !(ByteString, Version) + -- ^ Name and version of the compiler that was used to build + -- Setup.hs. WARNING: This does not identify the GHC version the project + -- is configured to use! + } deriving (Eq, Ord, Read, Show) + +newtype UnitId = UnitId String + deriving (Eq, Ord, Read, Show) + +-- | The information extracted from a 'Unit'\'s on-disk configuration cache. +data UnitInfo = UnitInfo + { uiUnitId :: !UnitId + -- ^ A unique identifier of this unit within the originating project. + + , uiPackageId :: !(String, Version) + -- ^ The package-name and version this unit belongs to. + + , uiComponents :: !(Map ChComponentName ChComponentInfo) + -- ^ The components of the unit: libraries, executables, test-suites, + -- benchmarks and so on. + + , uiCompilerId :: !(String, Version) + -- ^ The version of GHC the unit is configured to use + + , uiPackageFlags :: !([(String, Bool)]) + -- ^ Flag definitions from cabal file + + , uiConfigFlags :: ![(String, Bool)] + -- ^ Flag assignments from active configuration + + , uiNonDefaultConfigFlags :: ![(String, Bool)] + -- ^ Flag assignments from setup-config which differ from the default + -- setting. This can also include flags which cabal decided to modify, + -- i.e. don't rely on these being the flags set by the user directly. + + , uiModTimes :: !UnitModTimes + -- ^ Key for cache invalidation. When this is not equal to the value + -- returned by 'getUnitModTimes' this 'UnitInfo' is considered invalid. + } deriving (Eq, Ord, Read, Show) + +-- | Files relevant to the project-scope configuration. We gather them here so +-- we can refer to their paths conveniently throughout the code. These files are +-- not necessarily guaranteed to even exist. +data ProjConf pt where + ProjConfV1 :: + { pcV1CabalFile :: !FilePath + } -> ProjConf ('Cabal 'CV1) + + ProjConfV2 :: + { pcV2CabalProjFile :: !FilePath + , pcV2CabalProjLocalFile :: !FilePath + , pcV2CabalProjFreezeFile :: !FilePath + } -> ProjConf ('Cabal 'CV2) + + ProjConfStack :: + { pcStackYaml :: !FilePath + } -> ProjConf 'Stack + +projTypeOfProjConf :: ProjConf pt -> SProjType pt +projTypeOfProjConf ProjConfV1{} = SCabal SCV1 +projTypeOfProjConf ProjConfV2{} = SCabal SCV2 +projTypeOfProjConf ProjConfStack{} = SStack + + +-- This is supposed to be opaque, as it's only meant to be used only for cache +-- invalidation. +newtype ProjConfModTimes = ProjConfModTimes [(FilePath, EpochTime)] + deriving (Eq, Show) + +-- | Project-scope information cache. +data ProjInfo pt = ProjInfo + { piCabalVersion :: !Version + , piPackages :: !(NonEmpty (Package pt)) + , piImpl :: !(ProjInfoImpl pt) + , piProjConfModTimes :: !ProjConfModTimes + -- ^ Key for cache invalidation. When this is not equal to the return + -- value of 'getProjConfModTime' this 'ProjInfo' is considered invalid. + } deriving (Show) + +data ProjInfoImpl pt where + ProjInfoV1 :: + { piV1SetupHeader :: !UnitHeader + } -> ProjInfoImpl ('Cabal 'CV1) + + ProjInfoV2 :: + { piV2Plan :: !PlanJson + , piV2PlanModTime :: !EpochTime + , piV2CompilerId :: !(String, Version) + } -> ProjInfoImpl ('Cabal 'CV2) + + ProjInfoStack :: ProjInfoImpl 'Stack + +instance Show (ProjInfoImpl pt) where + show ProjInfoV1 {..} = concat + [ "ProjInfoV1 {" + , "piV1SetupHeader = ", show piV1SetupHeader, ", " + , "}" + ] + show ProjInfoV2 {..} = concat + [ "ProjInfoV2 {" + , "piV2Plan = ", show piV2Plan, ", " + , "piV2PlanModTime = ", show piV2PlanModTime, ", " + , "piV2CompilerId = ", show piV2CompilerId + , "}" + ] + show ProjInfoStack{} = concat + [ "ProjInfoStack {" + , "}" + ] + +data UnitModTimes = UnitModTimes + { umtPkgYaml :: !(Maybe (FilePath, EpochTime)) + , umtCabalFile :: !(FilePath, EpochTime) + , umtSetupConfig :: !(Maybe (FilePath, EpochTime)) + } deriving (Eq, Ord, Read, Show) +data PreInfo pt where + PreInfoCabal :: PreInfo ('Cabal cpt) + PreInfoStack :: + { piStackProjPaths :: !StackProjPaths + } -> PreInfo 'Stack + +instance Show (PreInfo pt) where + show PreInfoCabal{} = concat + [ "PreInfoCabal {" + , "}" + ] + show PreInfoStack {..} = concat + [ "PreInfoStack {" + , "piStackProjPaths = ", show piStackProjPaths + , "}" + ] + +newtype CabalFile = CabalFile FilePath + deriving (Show) + +data StackProjPaths = StackProjPaths + { sppGlobalPkgDb :: !PackageDbDir + , sppSnapPkgDb :: !PackageDbDir + , sppLocalPkgDb :: !PackageDbDir + , sppCompExe :: !FilePath + } deriving (Show) + + +-- Beware: GHC 8.0.2 doesn't like these being recursively defined for some +-- reason so just keep them unrolled. +type Verbose = (?verbose :: Word -> Bool) +type Env = ( ?progs :: Programs + , ?verbose :: Word -> Bool) +type Progs = (?progs :: Programs) + +-- | Configurable paths to various programs we use. +data Programs = Programs + { cabalProgram :: !FilePath + -- ^ The path to the @cabal@ program. + , cabalProjArgs :: ![String] + , cabalUnitArgs :: ![String] + + , stackProgram :: !FilePath + -- ^ The path to the @stack@ program. + , stackProjArgs :: ![String] + , stackUnitArgs :: ![String] + , stackEnv :: ![(String, EnvOverride)] + -- ^ TODO: Stack doesn't support passing the compiler as a + -- commandline option so we meddle with PATH instead. We should + -- patch that upstream. + + , ghcProgram :: !FilePath + -- ^ The path to the @ghc@ program. + + , ghcPkgProgram :: !FilePath + -- ^ The path to the @ghc-pkg@ program. If not changed it will be derived + -- from the path to 'ghcProgram'. + + , haddockProgram :: !FilePath + -- ^ The path to the @haddock@ program. If not changed it will be + -- derived from the path to 'ghcProgram'. + } deriving (Eq, Ord, Show, Read, Generic, Typeable) + +-- | By default all programs use their unqualified names, i.e. they will be +-- searched for on @PATH@. +defaultPrograms :: Programs +defaultPrograms = + Programs "cabal" [] [] "stack" [] [] [] "ghc" "ghc-pkg" "haddock" + +data EnvOverride + = EnvPrepend String + | EnvAppend String + | EnvReplace String + deriving (Eq, Ord, Show, Read, Generic, Typeable) + +data CompileOptions = CompileOptions + { oVerbose :: Bool + , oCabalPkgDb :: Maybe PackageDbDir + , oCabalVersion :: Maybe Version + , oPrograms :: Programs + } + +oCabalProgram :: Env => FilePath +oCabalProgram = cabalProgram ?progs + +defaultCompileOptions :: CompileOptions +defaultCompileOptions = + CompileOptions False Nothing Nothing defaultPrograms + +newtype PackageDbDir = PackageDbDir { unPackageDbDir :: FilePath } + deriving (Show) +newtype PackageEnvFile = PackageEnvFile { unPackageEnvFile :: FilePath } + deriving (Show) diff --git a/src/CabalHelper/Compiletime/Types/RelativePath.hs b/src/CabalHelper/Compiletime/Types/RelativePath.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Compiletime/Types/RelativePath.hs @@ -0,0 +1,51 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-| +Module : CabalHelper.Compiletime.Types.RelativePath +License : Apache-2.0 +-} + +module CabalHelper.Compiletime.Types.RelativePath + ( RelativePath + , mkRelativePath + , unRelativePath + ) where + +import System.FilePath + +-- | A path guaranteed to be relative and not escape the base path. The +-- constructor is not exposed, use the 'mkRelativePath' smart constructor. +newtype RelativePath = RelativePath { unRelativePath :: FilePath } + deriving (Show) + +-- | Smart constructor for 'RelativePath'. Checks if the given path +-- satisfies the constraints and throws 'UserError' if not. +mkRelativePath :: FilePath -> RelativePath +mkRelativePath dir + | isAbsolute dir = + error $ "mkRelativePath: the path given was absolute! got: " ++ dir + | doesRelativePathEscapeCWD dir = + error $ "mkRelativePath: the path given escapes the base dir! got: " ++ dir + | otherwise = + RelativePath dir + +doesRelativePathEscapeCWD :: FilePath -> Bool +doesRelativePathEscapeCWD path = + go [] $ splitDirectories $ normalise path + -- normalise collapses '.' in path, this is very important or this + -- check would be traivial to defeat. For example './../' would be + -- able to escape. + where + go (_:xs) ("..":ys) = go xs ys + go [] ("..":__) = True + go xs (y :ys) = go (y:xs) ys + go _ [] = False diff --git a/src/CabalHelper/Compiletime/Wrapper.hs b/src/CabalHelper/Compiletime/Wrapper.hs deleted file mode 100644 --- a/src/CabalHelper/Compiletime/Wrapper.hs +++ /dev/null @@ -1,227 +0,0 @@ --- cabal-helper: Simple interface to Cabal's configuration state --- Copyright (C) 2015-2018 Daniel Gröber --- --- 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 . -{-# LANGUAGE RecordWildCards, NamedFieldPuns, FlexibleContexts, ViewPatterns #-} -module Main where - -import Cabal.Plan -import Control.Applicative -import Control.Monad -import Data.Char -import Data.List -import Data.Maybe -import Data.String -import Text.Printf -import Text.Show.Pretty -import System.Console.GetOpt -import System.Environment -import System.Directory -import System.FilePath -import System.Process -import System.Exit -import System.IO -import Prelude - -import qualified Data.Text as Text -import qualified Data.Map.Strict as Map - -import Distribution.System (buildPlatform) -import Distribution.Text (display) -import Distribution.Verbosity (silent, deafening) -import Distribution.Package (packageName, packageVersion) -import Distribution.Simple.GHC as GHC (configure) - -import Paths_cabal_helper (version) -import CabalHelper.Compiletime.Compat.ProgramDb - ( defaultProgramDb, programPath, lookupProgram, ghcProgram, ghcPkgProgram) -import CabalHelper.Compiletime.Compat.Version -import CabalHelper.Compiletime.Compile -import CabalHelper.Compiletime.Types -import CabalHelper.Shared.Common -import CabalHelper.Shared.InterfaceTypes - -usage :: IO () -usage = do - prog <- getProgName - hPutStr stderr $ "Usage: " ++ prog ++ " " ++ usageMsg - where - usageMsg = "\ -\( print-appcachedir\n\ -\| print-build-platform\n\ -\| [--verbose]\n\ -\ [--with-ghc=GHC_PATH]\n\ -\ [--with-ghc-pkg=GHC_PKG_PATH]\n\ -\ [--with-cabal=CABAL_PATH]\n\ -\ [--with-cabal-version=VERSION]\n\ -\ [--with-cabal-pkg-db=PKG_DB]\n\ -\ v1-style PROJ_DIR DIST_DIR \n\ -\ ( print-exe | package-id | [CABAL_HELPER_ARGS...] )\n\ -\ v2-style PROJ_DIR DIST_NEWSTYLE_DIR DIST_DIR\n\ -\ ( print-exe | package-id | [CABAL_HELPER_ARGS...] )\n\ -\)\n" - -globalArgSpec :: [OptDescr (Options -> Options)] -globalArgSpec = - [ option "h" ["help"] "Display help message" $ - NoArg $ \o -> o { oHelp = True } - , option "" ["verbose"] "Be more verbose" $ - NoArg $ \o -> o { oVerbose = True } - - , option "" ["with-ghc"] "GHC executable to use" $ - reqArg "PROG" $ \p o -> o { oGhcProgram = p } - - , option "" ["with-ghc-pkg"] "ghc-pkg executable to use (only needed when guessing from GHC path fails)" $ - reqArg "PROG" $ \p o -> o { oGhcPkgProgram = p } - - , option "" ["with-cabal"] "cabal-install executable to use" $ - reqArg "PROG" $ \p o -> o { oCabalProgram = p } - - , option "" ["with-cabal-version"] "Cabal library version to use" $ - reqArg "VERSION" $ \p o -> o { oCabalVersion = Just $ parseVer p } - - , option "" ["with-cabal-pkg-db"] "package database to look for Cabal library in" $ - reqArg "PKG_DB" $ \p o -> o { oCabalPkgDb = Just (PackageDbDir p) } - - ] - where - option :: [Char] -> [String] -> String -> ArgDescr a -> OptDescr a - option s l udsc dsc = Option s l dsc udsc - - reqArg :: String -> (String -> a) -> ArgDescr a - reqArg udsc dsc = ReqArg dsc udsc - -parseCommandArgs :: Options -> [String] -> (Options, [String]) -parseCommandArgs opts argv - = case getOpt RequireOrder globalArgSpec argv of - (o,r,[]) -> (foldr id opts o, r) - (_,_,errs) -> - panic $ "Parsing command options failed:\n" ++ concat errs - -guessProgramPaths :: Options -> IO Options -guessProgramPaths opts = do - let v | oVerbose opts = deafening - | otherwise = silent - - mGhcPath0 | same oGhcProgram opts dopts = Nothing - | otherwise = Just $ oGhcProgram opts - mGhcPkgPath0 | same oGhcPkgProgram opts dopts = Nothing - | otherwise = Just $ oGhcPkgProgram opts - - (_compiler, _mplatform, progdb) - <- GHC.configure - v - mGhcPath0 - mGhcPkgPath0 - defaultProgramDb - - let mghcPath1 = programPath <$> lookupProgram ghcProgram progdb - mghcPkgPath1 = programPath <$> lookupProgram ghcPkgProgram progdb - - return $ opts { oGhcProgram = fromMaybe (oGhcProgram opts) mghcPath1 - , oGhcPkgProgram = fromMaybe (oGhcProgram opts) mghcPkgPath1 - } - where - same f o o' = f o == f o' - dopts = defaultOptions - -overrideVerbosityEnvVar :: Options -> IO Options -overrideVerbosityEnvVar opts = do - x <- lookup "CABAL_HELPER_DEBUG" <$> getEnvironment - return $ case x of - Just _ -> opts { oVerbose = True } - Nothing -> opts - -main :: IO () -main = handlePanic $ do - (opts', args) <- parseCommandArgs defaultOptions <$> getArgs - opts <- overrideVerbosityEnvVar =<< guessProgramPaths opts' - case args of - _ | oHelp opts -> usage - [] -> usage - "help":[] -> usage - "version":[] -> putStrLn $ showVersion version - "print-appdatadir":[] -> putStrLn =<< appCacheDir - "print-appcachedir":[] -> putStrLn =<< appCacheDir - "print-build-platform":[] -> putStrLn $ display buildPlatform - - _:projdir:_distdir:"package-id":[] -> do - let v | oVerbose opts = deafening - | otherwise = silent - -- ghc-mod will catch multiple cabal files existing before we get here - [cfile] <- filter isCabalFile <$> getDirectoryContents projdir - gpd <- readPackageDescription v (projdir cfile) - putStrLn $ show $ - [Just $ ChResponseVersion (display (packageName gpd)) (toDataVersion $ packageVersion gpd)] - - "v2-style":projdir:distdir_newstyle:unitid':args' -> do - let unitid = UnitId $ Text.pack unitid' - let plan_path = distdir_newstyle "cache" "plan.json" - plan@PlanJson {pjCabalLibVersion=Ver (makeDataVersion -> pjCabalLibVersion) } - <- decodePlanJson plan_path - case oCabalVersion opts of - Just ver | pjCabalLibVersion /= ver -> let - sver = showVersion ver - spjVer = showVersion pjCabalLibVersion - in panic $ printf "\ -\Cabal version %s was requested but plan.json was written by version %s" sver spjVer - _ -> case Map.lookup unitid $ pjUnits plan of - Just u@Unit {uType} | uType /= UnitTypeLocal -> do - panic $ "\ -\UnitId '"++ unitid' ++"' points to non-local unit: " ++ ppShow u - Just Unit {uDistDir=Nothing} -> panic $ printf "\ -\plan.json doesn't contain 'dist-dir' for UnitId '"++ unitid' ++"'" - Just Unit {uType=UnitTypeLocal, uDistDir=Just distdir} -> - runHelper opts projdir (Just (plan, distdir_newstyle)) distdir pjCabalLibVersion args' - _ -> let - units = map (\(UnitId u) -> Text.unpack u) - $ Map.keys - $ Map.filter ((==UnitTypeLocal) . uType) - $ pjUnits plan - - units_list = unlines $ map (" "++) units - in - panic $ "\ -\UnitId '"++ unitid' ++"' not found in plan.json, available local units:\n" ++ units_list - - "v1-style":projdir:distdir:args' -> do - cfgf <- canonicalizePath (distdir "setup-config") - mhdr <- getCabalConfigHeader cfgf - case (mhdr, oCabalVersion opts) of - (Nothing, _) -> panic $ printf "\ -\Could not read Cabal's persistent setup configuration header\n\ -\- Check first line of: %s\n\ -\- Maybe try: $ cabal configure" cfgf - (Just (hdrCabalVersion, _), Just ver) - | hdrCabalVersion /= ver -> panic $ printf "\ -\Cabal version %s was requested but setup configuration was\n\ -\written by version %s" (showVersion ver) (showVersion hdrCabalVersion) - (Just (hdrCabalVersion, _), _) -> - runHelper opts projdir Nothing distdir hdrCabalVersion args' - _ -> do - hPutStrLn stderr "Invalid command line!" - usage - exitWith $ ExitFailure 1 - -runHelper :: Options -> FilePath -> Maybe (PlanJson, FilePath) -> FilePath -> DataVersion -> [String] -> IO () -runHelper opts projdir mnewstyle distdir cabal_ver args' = do - eexe <- compileHelper opts cabal_ver projdir mnewstyle distdir - case eexe of - Left e -> exitWith e - Right exe -> do - case args' of - "print-exe":_ -> putStrLn exe - _ -> do - (_,_,_,h) <- createProcess $ proc exe $ projdir : distdir : args' - exitWith =<< waitForProcess h diff --git a/src/CabalHelper/Runtime/Compat.hs b/src/CabalHelper/Runtime/Compat.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Runtime/Compat.hs @@ -0,0 +1,228 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2015-2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-# LANGUAGE CPP, BangPatterns, RecordWildCards, RankNTypes, ViewPatterns, + TupleSections #-} +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +#ifdef MIN_VERSION_Cabal +#undef CH_MIN_VERSION_Cabal +#define CH_MIN_VERSION_Cabal MIN_VERSION_Cabal +#endif + +module CabalHelper.Runtime.Compat + ( UnitId + , componentNameToCh + , unUnqualComponentName' + , componentNameFromComponent + , componentOutDir + , internalPackageDBPath + ) where + +import System.FilePath + +import Distribution.PackageDescription + ( PackageDescription + , GenericPackageDescription(..) + , Flag(..) + , FlagName + , FlagAssignment + , Executable(..) + , Library(..) + , TestSuite(..) + , Benchmark(..) + , BuildInfo(..) + , TestSuiteInterface(..) + , BenchmarkInterface(..) + , withLib + ) +import Distribution.Simple.LocalBuildInfo + ( ComponentName(..) + , Component(..) + , LocalBuildInfo(..) + ) + + +#if CH_MIN_VERSION_Cabal(1,24,0) +import Distribution.Package (UnitId) +#else +import Distribution.Package (InstalledPackageId) +#endif + +#if CH_MIN_VERSION_Cabal(1,25,0) +-- >=1.25 +import Distribution.PackageDescription + ( unFlagName + -- , mkFlagName + ) +import Distribution.Types.ForeignLib + ( ForeignLib(..) + ) +import Distribution.Types.UnqualComponentName + ( UnqualComponentName + , unUnqualComponentName + ) +#else +-- <1.25 +import Distribution.PackageDescription + ( FlagName(FlagName) + ) +#endif + +#if CH_MIN_VERSION_Cabal(2,0,0) +-- CPP >= 2.0 +import Distribution.Simple.LocalBuildInfo + ( allLibModules + , componentBuildDir + ) +import Distribution.Simple.Register + ( internalPackageDBPath + ) +import Distribution.Backpack + ( OpenUnitId(..), + OpenModule(..) + ) +import Distribution.ModuleName + ( ModuleName + ) +import Distribution.Types.ComponentId + ( unComponentId + ) +import Distribution.Types.ComponentLocalBuildInfo + ( maybeComponentInstantiatedWith + ) +import Distribution.Types.ModuleRenaming + ( ModuleRenaming(..), + isDefaultRenaming + ) +import Distribution.Types.MungedPackageId + ( MungedPackageId + ) +import Distribution.Types.UnitId + ( UnitId + , unDefUnitId + , unUnitId + ) +import Distribution.Types.UnitId + ( DefUnitId + ) +import Distribution.Utils.NubList + ( toNubListR + ) +import Distribution.Version + ( versionNumbers + , mkVersion + ) +import qualified Distribution.InstalledPackageInfo as Installed +#endif + +#if CH_MIN_VERSION_Cabal(2,2,0) +import Distribution.Types.GenericPackageDescription + ( unFlagAssignment + ) +#endif + +#if CH_MIN_VERSION_Cabal(2,5,0) +import Distribution.Types.LibraryName + ( LibraryName (..) + ) +#endif + + +import CabalHelper.Shared.Common +import CabalHelper.Shared.InterfaceTypes + + + + + + + +#if !CH_MIN_VERSION_Cabal(1,24,0) +type UnitId = InstalledPackageId +#endif + + + +componentNameToCh :: ComponentName -> ChComponentName +#if CH_MIN_VERSION_Cabal(2,5,0) +componentNameToCh (CLibName LMainLibName) = ChLibName ChMainLibName +componentNameToCh (CLibName (LSubLibName n)) = ChLibName $ ChSubLibName (unUnqualComponentName' n) +#elif CH_MIN_VERSION_Cabal(2,0,0) +componentNameToCh CLibName = ChLibName ChMainLibName +componentNameToCh (CSubLibName n) = ChLibName $ ChSubLibName (unUnqualComponentName' n) +#else +componentNameToCh CLibName = ChLibName ChMainLibName +#endif +#if CH_MIN_VERSION_Cabal(2,0,0) +componentNameToCh (CFLibName n) = ChFLibName (unUnqualComponentName' n) +#endif +componentNameToCh (CExeName n) = ChExeName (unUnqualComponentName' n) +componentNameToCh (CTestName n) = ChTestName (unUnqualComponentName' n) +componentNameToCh (CBenchName n) = ChBenchName (unUnqualComponentName' n) + + +#if CH_MIN_VERSION_Cabal(1,25,0) +-- CPP >= 1.25 +unUnqualComponentName' :: UnqualComponentName -> String +unUnqualComponentName' = unUnqualComponentName +#else +unUnqualComponentName' :: a -> a +unUnqualComponentName' = id +#endif + + +componentNameFromComponent :: Component -> ComponentName +#if CH_MIN_VERSION_Cabal(2,5,0) +componentNameFromComponent (CLib Library { libName = n }) = CLibName n +componentNameFromComponent (CFLib ForeignLib {..}) = CFLibName foreignLibName +#elif CH_MIN_VERSION_Cabal(1,25,0) +-- CPP >= 1.25 (redundant) +componentNameFromComponent (CLib Library { libName = Nothing }) = CLibName +componentNameFromComponent (CLib Library { libName = Just n }) = CSubLibName n +componentNameFromComponent (CFLib ForeignLib {..}) = CFLibName foreignLibName +#else +-- CPP < 1.25 +componentNameFromComponent (CLib Library {}) = CLibName +#endif +componentNameFromComponent (CExe Executable {..}) = CExeName exeName +componentNameFromComponent (CTest TestSuite {..}) = CTestName testName +componentNameFromComponent (CBench Benchmark {..}) = CBenchName benchmarkName + + +componentOutDir :: LocalBuildInfo -> Component -> FilePath +componentOutDir lbi (CLib Library {..})= + buildDir lbi +#if CH_MIN_VERSION_Cabal(2,0,0) +componentOutDir lbi (CFLib ForeignLib {..}) = + componentOutDir' lbi (unUnqualComponentName foreignLibName) +#endif +componentOutDir lbi (CExe Executable {..}) = + componentOutDir' lbi (unUnqualComponentName' exeName) +componentOutDir lbi (CTest TestSuite { testInterface = TestSuiteLibV09 _ _, ..}) = + componentOutDir' lbi (unUnqualComponentName' testName ++ "Stub") +componentOutDir lbi (CTest TestSuite { testInterface = _, ..}) = + componentOutDir' lbi (unUnqualComponentName' testName) +componentOutDir lbi (CBench Benchmark { benchmarkInterface = _, ..})= + componentOutDir' lbi (unUnqualComponentName' benchmarkName) + +componentOutDir' :: LocalBuildInfo -> String -> FilePath +componentOutDir' lbi compName' = + ----- Copied from Distribution/Simple/GHC.hs:buildOrReplExe + let targetDir = (buildDir lbi) compName' + compDir = targetDir (compName' ++ "-tmp") + in compDir + +#if !CH_MIN_VERSION_Cabal(2,0,0) +internalPackageDBPath :: LocalBuildInfo -> FilePath -> FilePath +internalPackageDBPath lbi distPref = + distPref "package.conf.inplace" +#endif diff --git a/src/CabalHelper/Runtime/HelperMain.hs b/src/CabalHelper/Runtime/HelperMain.hs new file mode 100644 --- /dev/null +++ b/src/CabalHelper/Runtime/HelperMain.hs @@ -0,0 +1,519 @@ +-- cabal-helper: Simple interface to Cabal's configuration state +-- Copyright (C) 2015-2018 Daniel Gröber +-- +-- SPDX-License-Identifier: Apache-2.0 +-- +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 + +{-# LANGUAGE CPP, BangPatterns, RecordWildCards, RankNTypes, ViewPatterns, + TupleSections #-} +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{- # OPTIONS_GHC -Wno-missing-signatures #-} +{- # OPTIONS_GHC -fno-warn-incomplete-patterns #-} + +#ifdef MIN_VERSION_Cabal +#undef CH_MIN_VERSION_Cabal +#define CH_MIN_VERSION_Cabal MIN_VERSION_Cabal +#endif + +module CabalHelper.Runtime.HelperMain (helper_main) where + +import Distribution.Simple.Utils (cabalVersion) +import Distribution.Simple.Configure +import Distribution.Package + ( PackageIdentifier + , PackageId + , packageName + , packageVersion + ) +import Distribution.PackageDescription + ( PackageDescription + , GenericPackageDescription(..) + , Flag(..) + , FlagName + , FlagAssignment + , Executable(..) + , Library(..) + , TestSuite(..) + , Benchmark(..) + , BuildInfo(..) + , TestSuiteInterface(..) + , BenchmarkInterface(..) + , withLib + ) +import Distribution.PackageDescription.Configuration + ( flattenPackageDescription + ) +import Distribution.Simple.Program + ( requireProgram + , ghcProgram + ) +import Distribution.Simple.Program.Types + ( ConfiguredProgram(..) + ) +import Distribution.Simple.Configure + ( getPersistBuildConfig + ) +import Distribution.Simple.LocalBuildInfo + ( LocalBuildInfo(..) + , Component(..) + , ComponentName(..) + , ComponentLocalBuildInfo(..) + , componentBuildInfo + , withAllComponentsInBuildOrder + , withLibLBI + , withExeLBI + ) +import Distribution.Simple.GHC + ( componentGhcOptions + ) +import Distribution.Simple.Program.GHC + ( GhcOptions(..) + , renderGhcOptions + ) +import Distribution.Simple.Setup + ( ConfigFlags(..) + , Flag(..) + , fromFlagOrDefault + ) +import Distribution.Simple.Build + ( initialBuildSteps + ) +import Distribution.Simple.BuildPaths + ( cppHeaderName + ) +import Distribution.Simple.Compiler + ( PackageDB(..) + , compilerId + ) +import Distribution.Compiler + ( CompilerId(..) + ) +import Distribution.ModuleName + ( components + ) +import qualified Distribution.ModuleName as C + ( ModuleName + ) +import Distribution.Text + ( display + ) +import Distribution.Verbosity + ( Verbosity + , silent + , deafening + , normal + ) +import Distribution.Version + ( Version + ) + +#if CH_MIN_VERSION_Cabal(1,22,0) +-- CPP >= 1.22 +import Distribution.Utils.NubList +#endif + +#if CH_MIN_VERSION_Cabal(1,23,0) +-- >= 1.23 +import Distribution.Simple.LocalBuildInfo + ( localUnitId + ) +#else +-- <= 1.22 +import Distribution.Simple.LocalBuildInfo + ( inplacePackageId + ) +#endif + +#if CH_MIN_VERSION_Cabal(1,25,0) +-- >=1.25 +import Distribution.PackageDescription + ( unFlagName + -- , mkFlagName + ) +import Distribution.Types.ForeignLib + ( ForeignLib(..) + ) +import Distribution.Types.UnqualComponentName + ( UnqualComponentName + , unUnqualComponentName + ) +#else +-- <1.25 +import Distribution.PackageDescription + ( FlagName(FlagName) + ) +#endif + +#if CH_MIN_VERSION_Cabal(2,0,0) +-- CPP >= 2.0 +import Distribution.Simple.LocalBuildInfo + ( allLibModules + , componentBuildDir + ) +import Distribution.Backpack + ( OpenUnitId(..), + OpenModule(..) + ) +import Distribution.ModuleName + ( ModuleName + ) +import Distribution.Types.ComponentId + ( unComponentId + ) +import Distribution.Types.ComponentLocalBuildInfo + ( maybeComponentInstantiatedWith + ) +import Distribution.Types.ModuleRenaming + ( ModuleRenaming(..), + isDefaultRenaming + ) +import Distribution.Types.MungedPackageId + ( MungedPackageId + ) +import Distribution.Types.UnitId + ( UnitId + , unDefUnitId + , unUnitId + ) +import Distribution.Types.UnitId + ( DefUnitId + ) +import Distribution.Utils.NubList + ( toNubListR + ) +import Distribution.Version + ( versionNumbers + , mkVersion + ) +import qualified Distribution.InstalledPackageInfo as Installed +#endif + +#if CH_MIN_VERSION_Cabal(2,2,0) +import Distribution.Types.GenericPackageDescription + ( unFlagAssignment + ) +#endif + +import Control.Applicative ((<$>), (<*>), ZipList(..)) +import Control.Arrow (first, second, (&&&)) +import Control.Monad +import Control.Exception (catch, PatternMatchFail(..)) +import Data.List +import qualified Data.Map.Strict as Map +import Data.Maybe +import Data.Monoid +import Data.IORef +import qualified Data.Version as DataVersion +import System.Environment +import System.Directory +import System.FilePath +import System.Exit +import System.IO +import System.IO.Unsafe (unsafeInterleaveIO, unsafePerformIO) +import Text.Printf + +import CabalHelper.Shared.Common +import CabalHelper.Shared.InterfaceTypes +import CabalHelper.Runtime.Compat + +usage :: IO () +usage = do + prog <- getProgName + hPutStr stderr $ "Usage: " ++ prog ++ " " ++ usageMsg + where + usageMsg = "" + ++"PROJ_DIR DIST_DIR (v1|v2)\n" + ++" ( version\n" + ++" | flags\n" + ++" | config-flags\n" + ++" | non-default-config-flags\n" + ++" | write-autogen-files\n" + ++" | compiler-id\n" + ++" | component-info\n" + ++" | print-lbi [--human]\n" + ++" ) ...\n" + +commands :: [String] +commands = [ "flags" + , "config-flags" + , "non-default-config-flags" + , "write-autogen-files" + , "compiler-id" + , "package-db-stack" + , "component-info" + , "print-lbi" + ] + +helper_main :: [String] -> IO [Maybe ChResponse] +helper_main args = do + cfile : distdir : pt : args' + <- case args of + [] -> usage >> exitFailure + _ -> return args + + ddexists <- doesDirectoryExist distdir + when (not ddexists) $ do + errMsg $ "distdir '"++distdir++"' does not exist" + exitFailure + + v <- maybe silent (const deafening) . lookup "CABAL_HELPER_DEBUG" <$> getEnvironment + lbi <- unsafeInterleaveIO $ getPersistBuildConfig distdir + gpd <- unsafeInterleaveIO $ readPackageDescription v cfile + let pd = localPkgDescr lbi + let lvd = (lbi, v, distdir) + + let + -- a =<< b $$ c == (a =<< b) $$ c + infixr 2 $$ + ($$) = ($) + + collectCmdOptions :: [String] -> [[String]] + collectCmdOptions = + reverse . map reverse . foldl f [] . dropWhile isOpt + where + isOpt = ("--" `isPrefixOf`) + f [] x = [[x]] + f (a:as) x + | isOpt x = (x:a):as + | otherwise = [x]:(a:as) + + let cmds = collectCmdOptions args' + + flip mapM cmds $$ \x -> do + case x of + "version":[] -> + return $ Just $ ChResponseVersion ("Cabal", toDataVersion cabalVersion) + + "package-id":[] -> + return $ Just $ ChResponseVersion $ (,) + (display (packageName gpd)) + (toDataVersion (packageVersion gpd)) + + "flags":[] -> do + return $ Just $ ChResponseFlags $ sort $ + map (flagName' &&& flagDefault) $ genPackageFlags gpd + + "config-flags":[] -> do + return $ Just $ ChResponseFlags $ sort $ + map (first unFlagName) +#if CH_MIN_VERSION_Cabal(2,2,0) + $ unFlagAssignment $ configConfigurationsFlags +#else + $ configConfigurationsFlags +#endif + $ configFlags lbi + + "non-default-config-flags":[] -> do + let flagDefinitons = genPackageFlags gpd + flagAssgnments = +#if CH_MIN_VERSION_Cabal(2,2,0) + unFlagAssignment $ configConfigurationsFlags +#else + configConfigurationsFlags +#endif + $ configFlags lbi + nonDefaultFlags = + [ (flag_name, val) + | MkFlag {flagName=(unFlagName -> flag_name'), flagDefault=def_val} <- flagDefinitons + , (unFlagName -> flag_name, val) <- flagAssgnments + , flag_name == flag_name' + , val /= def_val + ] + return $ Just $ ChResponseFlags $ sort nonDefaultFlags + + "write-autogen-files":[] -> do + initialBuildStepsForAllComponents distdir pd lbi v + return Nothing + + "compiler-id":[] -> do + let CompilerId comp ver = compilerId $ compiler lbi + return $ Just $ ChResponseVersion $ (,) (show comp) (toDataVersion ver) + + "component-info":[] -> do + res <- componentsInfo lvd pt + return $ Just $ ChResponseComponentsInfo res + + "print-lbi":flags -> + case flags of + ["--human"] -> print lbi >> return Nothing + _ -> return $ Just $ ChResponseLbi $ show lbi + + cmd:_ | not (cmd `elem` commands) -> + errMsg ("Unknown command: " ++ cmd) >> usage >> exitFailure + _ -> + errMsg "Invalid usage!" >> usage >> exitFailure + +type ProjectType = String -- either "v1" or "v2" + +componentsInfo + :: (LocalBuildInfo, Verbosity, FilePath) + -> ProjectType + -> IO (Map.Map ChComponentName ChComponentInfo) +componentsInfo lvd@(lbi, v, distdir) pt = do + let mod_ghc_opts opts + | pt == "v1" = opts { + ghcOptPackageDBs = + -- c.f. Simple/Build.hs createInternalPackageDB call + ghcOptPackageDBs opts ++ + [SpecificPackageDB $ internalPackageDBPath lbi distdir] + } + | pt == "v2" = opts + | otherwise = error $ "Unknown project-type '"++pt++"'!" + + ciGhcOptions <- componentOptions lvd mod_ghc_opts + + ciSourceDirs <- componentsMap lbi v distdir $ \_ _ bi -> return $ hsSourceDirs bi + + ciEntrypoints <- componentsMap lbi v distdir $ \c _clbi _bi -> + return $ componentEntrypoints c + + let comp_name = map fst ciGhcOptions + uiComponents = Map.fromList + $ map (ciComponentName &&& id) + $ getZipList + $ ChComponentInfo + <$> ZipList comp_name + <*> ZipList (map snd ciGhcOptions) + <*> ZipList (map snd ciSourceDirs) + <*> ZipList (map snd ciEntrypoints) + + return uiComponents + + +flagName' :: Distribution.PackageDescription.Flag -> String +flagName' = unFlagName . flagName + +componentsMap :: LocalBuildInfo + -> Verbosity + -> FilePath + -> ( Component + -> ComponentLocalBuildInfo + -> BuildInfo + -> IO a) + -> IO [(ChComponentName, a)] +componentsMap lbi _v _distdir f = do + let pd = localPkgDescr lbi + + lr <- newIORef [] + + -- withComponentsLBI is deprecated but also exists in very old versions + -- it's equivalent to withAllComponentsInBuildOrder in newer versions + withAllComponentsInBuildOrder pd lbi $ \c clbi -> do + let bi = componentBuildInfo c + name = componentNameToCh $ componentNameFromComponent c + + l' <- readIORef lr + r <- f c clbi bi + writeIORef lr $ (name, r) : l' + + reverse <$> readIORef lr + +componentOptions' + :: (LocalBuildInfo, Verbosity, FilePath) + -> (LocalBuildInfo -> Verbosity -> GhcOptions -> IO a) + -> (GhcOptions -> GhcOptions) + -> IO [(ChComponentName, a)] +componentOptions' (lbi, v, distdir) rf f = do + componentsMap lbi v distdir $ \c clbi bi -> + let + outdir = componentOutDir lbi c + opts = componentGhcOptions normal lbi bi clbi outdir + + in rf lbi v $ f opts + +componentOptions :: (LocalBuildInfo, Verbosity, FilePath) + -> (GhcOptions -> GhcOptions) + -> IO [(ChComponentName, [String])] +componentOptions (lbi, v, distdir) f = + componentOptions' (lbi, v, distdir) renderGhcOptions' f + +gmModuleName :: C.ModuleName -> ChModuleName +gmModuleName = ChModuleName . intercalate "." . components + + +initialBuildStepsForAllComponents + :: FilePath + -> PackageDescription + -> LocalBuildInfo + -> Verbosity + -> IO () +initialBuildStepsForAllComponents distdir pd lbi v = + initialBuildSteps distdir pd lbi v + + + +#if !CH_MIN_VERSION_Cabal(1,25,0) +-- CPP < 1.25 +unFlagName :: FlagName -> String +unFlagName (FlagName n) = n +-- mkFlagName n = FlagName n +#endif + +toDataVersion :: Version -> DataVersion.Version +--fromDataVersion :: DataVersion.Version -> Version +#if CH_MIN_VERSION_Cabal(2,0,0) +toDataVersion v = DataVersion.Version (versionNumbers v) [] +--fromDataVersion (DataVersion.Version vs _) = mkVersion vs +#else +toDataVersion = id +--fromDataVersion = id +#endif + + + +componentEntrypoints :: Component -> ChEntrypoint +componentEntrypoints (CLib Library {..}) + = ChLibEntrypoint + (map gmModuleName exposedModules) + (map gmModuleName $ otherModules libBuildInfo) +#if CH_MIN_VERSION_Cabal(2,0,0) + (map gmModuleName signatures) +#else + [] -- no signatures prior to Cabal 2.0 +#endif +#if CH_MIN_VERSION_Cabal(2,0,0) +componentEntrypoints (CFLib (ForeignLib{..})) + = ChLibEntrypoint + [] + (map gmModuleName $ otherModules foreignLibBuildInfo) + [] +#endif +componentEntrypoints (CExe Executable {..}) + = ChExeEntrypoint + modulePath + (map gmModuleName $ otherModules buildInfo) +componentEntrypoints (CTest TestSuite { testInterface = TestSuiteExeV10 _ fp, ..}) + = ChExeEntrypoint fp (map gmModuleName $ otherModules testBuildInfo) +componentEntrypoints (CTest TestSuite { testInterface = TestSuiteLibV09 _ mn, ..}) + = ChLibEntrypoint [gmModuleName mn] (map gmModuleName $ otherModules testBuildInfo) [] +componentEntrypoints (CTest TestSuite {}) + = ChLibEntrypoint [] [] [] +componentEntrypoints (CBench Benchmark { benchmarkInterface = BenchmarkExeV10 _ fp, ..}) + = ChExeEntrypoint fp (map gmModuleName $ otherModules benchmarkBuildInfo) +componentEntrypoints (CBench Benchmark {}) + = ChLibEntrypoint [] [] [] + +renderGhcOptions' :: LocalBuildInfo + -> Verbosity + -> GhcOptions + -> IO [String] +#if !CH_MIN_VERSION_Cabal(1,20,0) +renderGhcOptions' lbi v opts = do +-- CPP < 1.20 + (ghcProg, _) <- requireProgram v ghcProgram (withPrograms lbi) + let Just ghcVer = programVersion ghcProg + return $ renderGhcOptions ghcVer opts +#elif CH_MIN_VERSION_Cabal(1,20,0) && !CH_MIN_VERSION_Cabal(1,24,0) +renderGhcOptions' lbi _v opts = do +-- CPP >= 1.20 && < 1.24 + return $ renderGhcOptions (compiler lbi) opts +#else +renderGhcOptions' lbi _v opts = do +-- CPP >= 1.24 + return $ renderGhcOptions (compiler lbi) (hostPlatform lbi) opts +#endif diff --git a/src/CabalHelper/Runtime/Main.hs b/src/CabalHelper/Runtime/Main.hs --- a/src/CabalHelper/Runtime/Main.hs +++ b/src/CabalHelper/Runtime/Main.hs @@ -1,841 +1,16 @@ -- cabal-helper: Simple interface to Cabal's configuration state --- Copyright (C) 2015-2018 Daniel Gröber +-- Copyright (C) 2018 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . - -{-# LANGUAGE CPP, BangPatterns, RecordWildCards, RankNTypes, ViewPatterns #-} - -#ifdef MIN_VERSION_Cabal -#undef CH_MIN_VERSION_Cabal -#define CH_MIN_VERSION_Cabal MIN_VERSION_Cabal -#endif - -import Distribution.Simple.Utils (cabalVersion) -import Distribution.Simple.Configure -import Distribution.Package - ( PackageIdentifier - , InstalledPackageId - , PackageId - , packageName - , packageVersion - ) -import Distribution.PackageDescription - ( PackageDescription - , GenericPackageDescription(..) - , Flag(..) - , FlagName(..) - , FlagAssignment - , Executable(..) - , Library(..) - , TestSuite(..) - , Benchmark(..) - , BuildInfo(..) - , TestSuiteInterface(..) - , BenchmarkInterface(..) - , withLib - ) -import Distribution.PackageDescription.Configuration - ( flattenPackageDescription - ) -import Distribution.Simple.Program - ( requireProgram - , ghcProgram - ) -import Distribution.Simple.Program.Types - ( ConfiguredProgram(..) - ) -import Distribution.Simple.Configure - ( getPersistBuildConfig - ) -import Distribution.Simple.LocalBuildInfo - ( LocalBuildInfo(..) - , Component(..) - , ComponentName(..) - , ComponentLocalBuildInfo(..) - , componentBuildInfo - , externalPackageDeps - , withComponentsLBI - , withLibLBI - , withExeLBI - ) -import Distribution.Simple.GHC - ( componentGhcOptions - ) -import Distribution.Simple.Program.GHC - ( GhcOptions(..) - , renderGhcOptions - ) -import Distribution.Simple.Setup - ( ConfigFlags(..) - , Flag(..) - , fromFlagOrDefault - ) -import Distribution.Simple.Build - ( initialBuildSteps - ) -import Distribution.Simple.BuildPaths - ( autogenModuleName - , cppHeaderName - ) -import Distribution.Simple.Compiler - ( PackageDB(..) - , compilerId - ) -import Distribution.Compiler - ( CompilerId(..) - ) -import Distribution.ModuleName - ( components - ) -import qualified Distribution.ModuleName as C - ( ModuleName - ) -import Distribution.Text - ( display - ) -import Distribution.Verbosity - ( Verbosity - , silent - , deafening - , normal - ) -import Distribution.Version - ( Version - ) - -#if CH_MIN_VERSION_Cabal(1,22,0) --- CPP >= 1.22 -import Distribution.Utils.NubList -#endif - -#if CH_MIN_VERSION_Cabal(1,23,0) --- >= 1.23 -import Distribution.Simple.LocalBuildInfo - ( localUnitId - ) -#else --- <= 1.22 -import Distribution.Simple.LocalBuildInfo - ( inplacePackageId - ) -#endif - -#if CH_MIN_VERSION_Cabal(1,25,0) --- >=1.25 -import Distribution.PackageDescription - ( unFlagName - -- , mkFlagName - ) -import Distribution.Types.ForeignLib - ( ForeignLib(..) - ) -import Distribution.Types.UnqualComponentName - ( unUnqualComponentName - ) -#endif - -#if CH_MIN_VERSION_Cabal(2,0,0) --- CPP >= 2.0 -import Distribution.Simple.LocalBuildInfo - ( allLibModules - , componentBuildDir - ) -import Distribution.Simple.Register - ( internalPackageDBPath - ) -import Distribution.Backpack - ( OpenUnitId(..), - OpenModule(..) - ) -import Distribution.ModuleName - ( ModuleName - ) -import Distribution.Types.ComponentId - ( unComponentId - ) -import Distribution.Types.ComponentLocalBuildInfo - ( maybeComponentInstantiatedWith - ) -import Distribution.Types.ModuleRenaming - ( ModuleRenaming(..), - isDefaultRenaming - ) -import Distribution.Types.MungedPackageId - ( MungedPackageId - ) -import Distribution.Types.UnitId - ( UnitId - , unDefUnitId - , unUnitId - ) -import Distribution.Types.UnitId - ( DefUnitId - ) -import Distribution.Utils.NubList - ( toNubListR - ) -import Distribution.Version - ( versionNumbers - , mkVersion - ) -import qualified Distribution.InstalledPackageInfo as Installed -#endif - -#if CH_MIN_VERSION_Cabal(2,2,0) -import Distribution.Types.GenericPackageDescription - ( unFlagAssignment - ) -#endif +-- http://www.apache.org/licenses/LICENSE-2.0 -import Control.Applicative ((<$>)) -import Control.Arrow (first, second, (&&&)) -import Control.Monad -import Control.Exception (catch, PatternMatchFail(..)) -import Data.List -import qualified Data.Map as Map -import Data.Maybe -import Data.Monoid -import Data.IORef -import qualified Data.Version as DataVersion +import CabalHelper.Runtime.HelperMain (helper_main) import System.Environment -import System.Directory -import System.FilePath -import System.Exit -import System.IO -import System.IO.Unsafe (unsafeInterleaveIO, unsafePerformIO) -import Text.Printf -import CabalHelper.Shared.Sandbox -import CabalHelper.Shared.Common -import CabalHelper.Shared.InterfaceTypes - -usage :: IO () -usage = do - prog <- getProgName - hPutStr stderr $ "Usage: " ++ prog ++ " " ++ usageMsg - where - usageMsg = "" - ++"PROJ_DIR DIST_DIR [--with-* ...] (\n" - ++" version\n" - ++" | print-lbi [--human]\n" - ++" | package-id\n" - ++" | flags\n" - ++" | config-flags\n" - ++" | non-default-config-flags\n" - ++" | write-autogen-files\n" - ++" | compiler-version\n" - ++" | ghc-options [--with-inplace]\n" - ++" | ghc-src-options [--with-inplace]\n" - ++" | ghc-pkg-options [--with-inplace]\n" - ++" | ghc-merged-pkg-options [--with-inplace]\n" - ++" | ghc-lang-options [--with-inplace]\n" - ++" | package-db-stack\n" - ++" | entrypoints\n" - ++" | needs-build-output\n" - ++" | source-dirs\n" - ++" ) ...\n" - -commands :: [String] -commands = [ "print-lbi" - , "package-id" - , "flags" - , "config-flags" - , "non-default-config-flags" - , "write-autogen-files" - , "compiler-version" - , "ghc-options" - , "ghc-src-options" - , "ghc-pkg-options" - , "ghc-lang-options" - , "package-db-stack" - , "entrypoints" - , "needs-build-output" - , "source-dirs" - ] - main :: IO () -main = do - args <- getArgs - - projdir:distdir:args' <- case args of - [] -> usage >> exitFailure - _ -> return args - - ddexists <- doesDirectoryExist distdir - when (not ddexists) $ do - errMsg $ "distdir '"++distdir++"' does not exist" - exitFailure - - [cfile] <- filter isCabalFile <$> getDirectoryContents projdir - - v <- maybe silent (const deafening) . lookup "CABAL_HELPER_DEBUG" <$> getEnvironment - lbi <- unsafeInterleaveIO $ getPersistBuildConfig distdir - gpd <- unsafeInterleaveIO $ readPackageDescription v (projdir cfile) - let pd = localPkgDescr lbi - let lvd = (lbi, v, distdir) - - let - -- a =<< b $$ c == (a =<< b) $$ c - infixr 2 $$ - ($$) = ($) - - collectCmdOptions :: [String] -> [[String]] - collectCmdOptions = - reverse . map reverse . foldl f [] . dropWhile isOpt - where - isOpt = ("--" `isPrefixOf`) - f [] x = [[x]] - f (a:as) x - | isOpt x = (x:a):as - | otherwise = [x]:(a:as) - - let cmds = collectCmdOptions args' - - if any (["version"] `isPrefixOf`) cmds - then do - putStrLn $ - printf "using version %s of the Cabal library" (display cabalVersion) - exitSuccess - else return () - - print =<< flip mapM cmds $$ \x -> do - case x of - "flags":[] -> do - return $ Just $ ChResponseFlags $ sort $ - map (flagName' &&& flagDefault) $ genPackageFlags gpd - - "config-flags":[] -> do - return $ Just $ ChResponseFlags $ sort $ - map (first unFlagName) -#if CH_MIN_VERSION_Cabal(2,2,0) - $ unFlagAssignment $ configConfigurationsFlags -#else - $ configConfigurationsFlags -#endif - $ configFlags lbi - - "non-default-config-flags":[] -> do - let flagDefinitons = genPackageFlags gpd - flagAssgnments = -#if CH_MIN_VERSION_Cabal(2,2,0) - unFlagAssignment $ configConfigurationsFlags -#else - configConfigurationsFlags -#endif - $ configFlags lbi - nonDefaultFlags = - [ (flag_name, val) - | MkFlag {flagName=(unFlagName -> flag_name'), flagDefault=def_val} <- flagDefinitons - , (unFlagName -> flag_name, val) <- flagAssgnments - , flag_name == flag_name' - , val /= def_val - ] - return $ Just $ ChResponseFlags $ sort nonDefaultFlags - - "write-autogen-files":[] -> do - initialBuildStepsForAllComponents distdir pd lbi v - return Nothing - - "compiler-version":[] -> do - let CompilerId comp ver = compilerId $ compiler lbi - return $ Just $ ChResponseVersion (show comp) (toDataVersion ver) - - "ghc-options":flags -> do - res <- componentOptions lvd True flags id - return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])]) - - "ghc-src-options":flags -> do - res <- componentOptions lvd False flags $ \opts -> mempty { - -- Not really needed but "unexpected package db stack: []" - ghcOptPackageDBs = [GlobalPackageDB, UserPackageDB], - - ghcOptCppOptions = ghcOptCppOptions opts, - ghcOptCppIncludePath = ghcOptCppIncludePath opts, - ghcOptCppIncludes = ghcOptCppIncludes opts, - ghcOptFfiIncludes = ghcOptFfiIncludes opts, - ghcOptSourcePathClear = ghcOptSourcePathClear opts, - ghcOptSourcePath = ghcOptSourcePath opts - } - return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])]) - - "ghc-pkg-options":flags -> do - res <- componentOptions lvd True flags $ \opts -> mempty { - ghcOptPackageDBs = ghcOptPackageDBs opts, - ghcOptPackages = ghcOptPackages opts, - ghcOptHideAllPackages = ghcOptHideAllPackages opts - } - return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])]) - - "ghc-merged-pkg-options":flags -> do - res <- mconcat . map snd <$> (componentOptions' lvd True flags (\_ _ o -> return o) $ \opts -> mempty { - ghcOptPackageDBs = [], - ghcOptHideAllPackages = NoFlag, - ghcOptPackages = ghcOptPackages opts - }) - - let res' = nubPackageFlags $ res { ghcOptPackageDBs = withPackageDB lbi - , ghcOptHideAllPackages = Flag True - } - - Just . ChResponseList <$> renderGhcOptions' lbi v res' - - "ghc-lang-options":flags -> do - res <- componentOptions lvd False flags $ \opts -> mempty { - ghcOptPackageDBs = [GlobalPackageDB, UserPackageDB], - - ghcOptLanguage = ghcOptLanguage opts, - ghcOptExtensions = ghcOptExtensions opts, - ghcOptExtensionMap = ghcOptExtensionMap opts - } - return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])]) - - "package-db-stack":[] -> do - let - pkgDb GlobalPackageDB = ChPkgGlobal - pkgDb UserPackageDB = ChPkgUser - pkgDb (SpecificPackageDB s) = ChPkgSpecific s - - -- TODO: Setup.hs has access to the sandbox as well: ghc-mod#478 - return $ Just $ ChResponsePkgDbs $ map pkgDb $ withPackageDB lbi - - "entrypoints":[] -> do -#if CH_MIN_VERSION_Cabal(2,0,0) - includeDirMap <- recursiveDepInfo lbi v distdir - eps <- componentsMap lbi v distdir $ \c clbi _bi -> do - case needsBuildOutput includeDirMap (componentUnitId clbi) of - ProduceBuildOutput -> return $ componentEntrypoints c - NoBuildOutput -> return seps - where (_,_,seps) = recursiveIncludeDirs includeDirMap (componentUnitId clbi) -#else - eps <- componentsMap lbi v distdir $ \c _clbi _bi -> - return $ componentEntrypoints c -#endif - -- MUST append Setup component at the end otherwise CabalHelper gets - -- confused - let eps' = eps ++ [(ChSetupHsName, ChSetupEntrypoint)] - return $ Just $ ChResponseEntrypoints eps' - - "needs-build-output":[] -> do -#if CH_MIN_VERSION_Cabal(2,0,0) - includeDirMap <- recursiveDepInfo lbi v distdir - nbs <- componentsMap lbi v distdir $ \c clbi _bi -> - return $ needsBuildOutput includeDirMap (componentUnitId clbi) -#else - nbs <- componentsMap lbi v distdir $ \c _clbi _bi -> - return $ NoBuildOutput -#endif - return $ Just $ ChResponseNeedsBuild nbs - - "source-dirs":[] -> do - res <- componentsMap lbi v distdir $$ \_ _ bi -> return $ hsSourceDirs bi - return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])]) - - "print-lbi":flags -> - case flags of - ["--human"] -> print lbi >> return Nothing - [] -> return $ Just $ ChResponseLbi $ show lbi - - cmd:_ | not (cmd `elem` commands) -> - errMsg ("Unknown command: " ++ cmd) >> usage >> exitFailure - _ -> - errMsg "Invalid usage!" >> usage >> exitFailure - -flagName' = unFlagName . flagName - --- getLibrary :: PackageDescription -> Library --- getLibrary pd = unsafePerformIO $ do --- lr <- newIORef (error "libraryMap: empty IORef") --- withLib pd (writeIORef lr) --- readIORef lr - -getLibraryClbi pd lbi = unsafePerformIO $ do - lr <- newIORef Nothing - - withLibLBI pd lbi $ \ lib clbi -> - writeIORef lr $ Just (lib,clbi) - - readIORef lr - - -getExeClbi pd lbi = unsafePerformIO $ do - lr <- newIORef Nothing - - withExeLBI pd lbi $ \ exe clbi -> - writeIORef lr $ Just (exe,clbi) - - readIORef lr - - -componentsMap :: LocalBuildInfo - -> Verbosity - -> FilePath - -> ( Component - -> ComponentLocalBuildInfo - -> BuildInfo - -> IO a) - -> IO [(ChComponentName, a)] -componentsMap lbi _v _distdir f = do - let pd = localPkgDescr lbi - - lr <- newIORef [] - - -- withComponentsLBI is deprecated but also exists in very old versions - -- it's equivalent to withAllComponentsInBuildOrder in newer versions - withComponentsLBI pd lbi $ \c clbi -> do - let bi = componentBuildInfo c - name = componentNameFromComponent c - - l' <- readIORef lr - r <- f c clbi bi -#if CH_MIN_VERSION_Cabal(2,0,0) - writeIORef lr $ (componentNameToCh (unUnitId $ componentUnitId clbi) name, r):l' -#else - writeIORef lr $ (componentNameToCh "" name, r):l' -#endif - - reverse <$> readIORef lr - -componentOptions' (lbi, v, distdir) inplaceFlag flags rf f = do - let pd = localPkgDescr lbi -#if CH_MIN_VERSION_Cabal(2,0,0) - includeDirMap <- recursiveDepInfo lbi v distdir -#endif - - componentsMap lbi v distdir $ \c clbi bi -> - let - outdir = componentOutDir lbi c - (clbi', adopts) = case flags of - _ | not inplaceFlag -> (clbi, mempty) - ["--with-inplace"] -> (clbi, mempty) -#if CH_MIN_VERSION_Cabal(2,0,0) - [] -> removeInplaceDeps v lbi pd clbi includeDirMap -#else - [] -> removeInplaceDeps v lbi pd clbi -#endif - opts = componentGhcOptions normal lbi bi clbi' outdir - opts' = f opts - - in rf lbi v $ nubPackageFlags $ opts' `mappend` adopts - -componentOptions (lbi, v, distdir) inplaceFlag flags f = - componentOptions' (lbi, v, distdir) inplaceFlag flags renderGhcOptions' f - -gmModuleName :: C.ModuleName -> ChModuleName -gmModuleName = ChModuleName . intercalate "." . components - -#if CH_MIN_VERSION_Cabal(2,0,0) -removeInplaceDeps :: Verbosity - -> LocalBuildInfo - -> PackageDescription - -> ComponentLocalBuildInfo - -> Map.Map UnitId SubDeps - -> (ComponentLocalBuildInfo, GhcOptions) -removeInplaceDeps _v lbi pd clbi includeDirs = let - removeInplace c = - let - (ideps, incs) = partition (isInplaceCompInc c) (componentIncludes c) - hasIdeps' = not $ null ideps - c' = c { componentPackageDeps = error "using deprecated field:componentPackageDeps" - , componentInternalDeps = [] - , componentIncludes = incs } - in (hasIdeps',c') - - needsBuild = needsBuildOutput includeDirs (componentUnitId clbi) - - cleanRecursiveOpts :: Component - -> BuildInfo -> ComponentLocalBuildInfo -> GhcOptions - cleanRecursiveOpts comp libbi libclbi = - let - liboutdir = componentOutDir lbi comp - (_,libclbi') = removeInplace libclbi - (extraIncludes,extraDeps',_ems) = recursiveIncludeDirs includeDirs (componentUnitId libclbi) - (_,extraDeps) = partition (isInplaceCompInc libclbi) extraDeps' - opts = (componentGhcOptions normal lbi libbi libclbi' liboutdir) { - ghcOptPackageDBs = [] - } - - in - opts { ghcOptSourcePath = ghcOptSourcePath opts <> toNubListR extraIncludes - , ghcOptPackages = ghcOptPackages opts <> toNubListR extraDeps } - - libopts = - case (getLibraryClbi pd lbi,getExeClbi pd lbi) of - (Just (lib, libclbi),_) | hasIdeps -> - let - libbi = libBuildInfo lib - opts = cleanRecursiveOpts (CLib lib) libbi libclbi - in - opts { ghcOptInputModules = ghcOptInputModules opts <> (toNubListR $ allLibModules lib libclbi) } - (_,Just (exe,execlbi)) | hasIdeps -> - let - exebi = buildInfo exe - in - cleanRecursiveOpts (CExe exe) exebi execlbi - _ -> mempty - - distDir = fromFlagOrDefault ("." "dist") (configDistPref $ configFlags lbi) - packageDbDir = internalPackageDBPath lbi distDir - (hasIdeps,clbi') = case needsBuild of - NoBuildOutput -> removeInplace clbi - ProduceBuildOutput -> (False, clbi) - libopts' = case needsBuild of - NoBuildOutput -> libopts - ProduceBuildOutput -> mempty { ghcOptPackageDBs = [SpecificPackageDB packageDbDir] } - in (clbi', libopts') -#else -removeInplaceDeps :: Verbosity - -> LocalBuildInfo - -> PackageDescription - -> ComponentLocalBuildInfo - -> (ComponentLocalBuildInfo, GhcOptions) -removeInplaceDeps _v lbi pd clbi = let - (ideps, deps) = partition (isInplaceDep lbi) (componentPackageDeps clbi) - hasIdeps = not $ null ideps - libopts = - case getLibraryClbi pd lbi of - Just (lib, libclbi) | hasIdeps -> - let - libbi = libBuildInfo lib - liboutdir = componentOutDir lbi (CLib lib) - in - (componentGhcOptions normal lbi libbi libclbi liboutdir) { - ghcOptPackageDBs = [] - } - _ -> mempty - clbi' = clbi { componentPackageDeps = deps } - in (clbi', libopts) -#endif - - -#if CH_MIN_VERSION_Cabal(2,0,0) -recursiveDepInfo lbi v distdir = do - includeDirs <- componentsMap lbi v distdir $ \c clbi bi -> do - return (componentUnitId clbi - , ( SubDeps - { sdComponentInternalDeps = componentInternalDeps clbi - , sdHsSourceDirs = hsSourceDirs bi - , sdComponentIncludes = componentIncludes clbi - , sdComponentEntryPoints = componentEntrypoints c}) ) - return $ Map.fromList $ map snd includeDirs - -data SubDeps = SubDeps - { sdComponentInternalDeps :: [UnitId] - , sdHsSourceDirs :: [FilePath] - , sdComponentIncludes :: [(OpenUnitId, ModuleRenaming)] - , sdComponentEntryPoints :: ChEntrypoint - } - -recursiveIncludeDirs :: Map.Map UnitId SubDeps - -> UnitId -> ([FilePath], [(OpenUnitId, ModuleRenaming)] - , ChEntrypoint) -recursiveIncludeDirs includeDirs unit = go ([],[],Nothing) [unit] - where - go (afp,aci,Nothing ) [] = (afp,aci,error "recursiveIncludeDirs:no ChEntrypoint") - go (afp,aci,Just amep) [] = (afp,aci,amep) - go acc@(afp,aci,amep) (u:us) = case Map.lookup u includeDirs of - Nothing -> go acc us - Just (SubDeps us' sfp sci sep) -> go (afp++sfp,aci++sci,Just (combineEp amep sep)) (us++us') - -needsBuildOutput :: Map.Map UnitId SubDeps -> UnitId -> NeedsBuildOutput -needsBuildOutput includeDirs unit = go [unit] - where - isIndef (IndefFullUnitId _ _) = True - isIndef _ = False - go [] = NoBuildOutput - go (u:us) = case Map.lookup u includeDirs of - Nothing -> go us - Just (SubDeps us' sfp sci sep) -> - if any (isIndef . fst) sci - then ProduceBuildOutput - else go (us++us') - --- | combineEP is used to combine the entrypoints when recursively chasing --- through the dependencies of a given entry point. The first parameter is the --- current accumulated value, and the second one is the current sub-dependency --- being considered. So the bias should be to preserve the type of entrypoint --- from the first parameter. -combineEp Nothing e = e -combineEp (Just ChSetupEntrypoint) e = e -combineEp (Just (ChLibEntrypoint es1 os1 ss1)) (ChLibEntrypoint es2 os2 ss2) = (ChLibEntrypoint (nub $ es2++es1) (nub $ os2++os1) (nub $ ss2++ss1)) -combineEp _ e@(ChExeEntrypoint mi os2) = error $ "combineEP: cannot have a sub exe:" ++ show e -combineEp (Just (ChExeEntrypoint mi os1)) (ChLibEntrypoint es2 os2 ss2) = (ChExeEntrypoint mi (nub $ os1++es2++os2++ss2)) - --- no, you unconditionally always wrap the result in Just, so instead of `f x = Just y; f x = Just z` do `f x = y; f x = z` and use f as `Just . f` - - - -instantiatedGhcPackage :: (ModuleName,OpenModule) -> [(OpenUnitId, ModuleRenaming)] -instantiatedGhcPackage (_,OpenModule oui@(DefiniteUnitId _) _) = [(oui,DefaultRenaming)] -instantiatedGhcPackage (_, _) = [] -#endif - -initialBuildStepsForAllComponents distdir pd lbi v = - initialBuildSteps distdir pd lbi v - - - - - - -#if !CH_MIN_VERSION_Cabal(1,25,0) --- CPP < 1.25 -unFlagName (FlagName n) = n --- mkFlagName n = FlagName n -#endif - -toDataVersion :: Version -> DataVersion.Version ---fromDataVersion :: DataVersion.Version -> Version -#if CH_MIN_VERSION_Cabal(2,0,0) -toDataVersion v = DataVersion.Version (versionNumbers v) [] ---fromDataVersion (DataVersion.Version vs _) = mkVersion vs -#else -toDataVersion = id ---fromDataVersion = id -#endif - -componentNameToCh _uid CLibName = ChLibName -#if CH_MIN_VERSION_Cabal(1,25,0) --- CPP >= 1.25 -#if CH_MIN_VERSION_Cabal(2,0,0) -componentNameToCh uid (CSubLibName n) = ChSubLibName uid -#else -componentNameToCh _uid (CSubLibName n) = ChSubLibName (unUnqualComponentName' n) -#endif -componentNameToCh uid (CFLibName n) = ChFLibName (unUnqualComponentName' n) -#endif -componentNameToCh _uid (CExeName n) = ChExeName (unUnqualComponentName' n) -componentNameToCh _uid (CTestName n) = ChTestName (unUnqualComponentName' n) -componentNameToCh _uid (CBenchName n) = ChBenchName (unUnqualComponentName' n) - -#if CH_MIN_VERSION_Cabal(1,25,0) --- CPP >= 1.25 -unUnqualComponentName' = unUnqualComponentName -#else -unUnqualComponentName' = id -#endif - -#if !CH_MIN_VERSION_Cabal(1,25,0) --- CPP < 1.25 -componentNameFromComponent (CLib Library {}) = CLibName -#elif CH_MIN_VERSION_Cabal(1,25,0) --- CPP >= 1.25 (redundant) -componentNameFromComponent (CLib Library { libName = Nothing }) = CLibName -componentNameFromComponent (CLib Library { libName = Just n }) = CSubLibName n -componentNameFromComponent (CFLib ForeignLib {..}) = CFLibName foreignLibName -#endif -componentNameFromComponent (CExe Executable {..}) = CExeName exeName -componentNameFromComponent (CTest TestSuite {..}) = CTestName testName -componentNameFromComponent (CBench Benchmark {..}) = CBenchName benchmarkName - -componentOutDir lbi (CLib Library {..})= - buildDir lbi -#if CH_MIN_VERSION_Cabal(2,0,0) -componentOutDir lbi (CFLib ForeignLib {..}) = - componentOutDir' lbi (unUnqualComponentName foreignLibName) -#endif -componentOutDir lbi (CExe Executable {..}) = - componentOutDir' lbi (unUnqualComponentName' exeName) -componentOutDir lbi (CTest TestSuite { testInterface = TestSuiteExeV10 _ _, ..}) = - componentOutDir' lbi (unUnqualComponentName' testName) -componentOutDir lbi (CTest TestSuite { testInterface = TestSuiteLibV09 _ _, ..}) = - componentOutDir' lbi (unUnqualComponentName' testName ++ "Stub") -componentOutDir lbi (CBench Benchmark { benchmarkInterface = BenchmarkExeV10 _ _, ..})= - componentOutDir' lbi (unUnqualComponentName' benchmarkName) - -componentOutDir' :: LocalBuildInfo -> String -> FilePath -componentOutDir' lbi compName' = - ----- Copied from Distribution/Simple/GHC.hs:buildOrReplExe - let targetDir = (buildDir lbi) compName' - compDir = targetDir (compName' ++ "-tmp") - in compDir - -componentEntrypoints :: Component -> ChEntrypoint -componentEntrypoints (CLib Library {..}) - = ChLibEntrypoint - (map gmModuleName exposedModules) - (map gmModuleName $ otherModules libBuildInfo) -#if CH_MIN_VERSION_Cabal(2,0,0) - (map gmModuleName signatures) -#else - [] -- no signatures prior to Cabal 2.0 -#endif -#if CH_MIN_VERSION_Cabal(2,0,0) -componentEntrypoints (CFLib (ForeignLib{..})) - = ChLibEntrypoint - [] - (map gmModuleName $ otherModules foreignLibBuildInfo) - [] -#endif -componentEntrypoints (CExe Executable {..}) - = ChExeEntrypoint - modulePath - (map gmModuleName $ otherModules buildInfo) -componentEntrypoints (CTest TestSuite { testInterface = TestSuiteExeV10 _ fp, ..}) - = ChExeEntrypoint fp (map gmModuleName $ otherModules testBuildInfo) -componentEntrypoints (CTest TestSuite { testInterface = TestSuiteLibV09 _ mn, ..}) - = ChLibEntrypoint [gmModuleName mn] (map gmModuleName $ otherModules testBuildInfo) [] -componentEntrypoints (CTest TestSuite {}) - = ChLibEntrypoint [] [] [] -componentEntrypoints (CBench Benchmark { benchmarkInterface = BenchmarkExeV10 _ fp, ..}) - = ChExeEntrypoint fp (map gmModuleName $ otherModules benchmarkBuildInfo) -componentEntrypoints (CBench Benchmark {}) - = ChLibEntrypoint [] [] [] - -#if CH_MIN_VERSION_Cabal(2,0,0) -isInplaceCompInc :: ComponentLocalBuildInfo -> (OpenUnitId, ModuleRenaming) -> Bool -isInplaceCompInc clbi (DefiniteUnitId uid, _mr) = unDefUnitId uid `elem` componentInternalDeps clbi -isInplaceCompInc clbi (IndefFullUnitId uid _, _mmr) = False -#endif - -#if CH_MIN_VERSION_Cabal(2,0,0) -isInplaceDep :: LocalBuildInfo -> ComponentLocalBuildInfo -> (UnitId, MungedPackageId) -> Bool -isInplaceDep lbi clbi (uid, _mpid) = uid `elem` componentInternalDeps clbi -#else -isInplaceDep :: LocalBuildInfo -> (InstalledPackageId, PackageId) -> Bool -# if CH_MIN_VERSION_Cabal(1,23,0) --- CPP >= 1.23 -isInplaceDep lbi (ipid, _pid) = localUnitId lbi == ipid -# else --- CPP <= 1.22 -isInplaceDep _lbi (ipid, pid) = inplacePackageId pid == ipid -# endif -#endif - -#if CH_MIN_VERSION_Cabal(1,22,0) --- CPP >= 1.22 --- >= 1.22 uses NubListR -nubPackageFlags opts = opts -#else -nubPackageFlags opts = opts { ghcOptPackages = nub $ ghcOptPackages opts } -#endif - -renderGhcOptions' :: LocalBuildInfo - -> Verbosity - -> GhcOptions - -> IO [String] -#if !CH_MIN_VERSION_Cabal(1,20,0) -renderGhcOptions' lbi v opts = do --- CPP < 1.20 - (ghcProg, _) <- requireProgram v ghcProgram (withPrograms lbi) - let Just ghcVer = programVersion ghcProg - return $ renderGhcOptions ghcVer opts -#elif CH_MIN_VERSION_Cabal(1,20,0) && !CH_MIN_VERSION_Cabal(1,24,0) -renderGhcOptions' lbi _v opts = do --- CPP >= 1.20 && < 1.24 - return $ renderGhcOptions (compiler lbi) opts -#else -renderGhcOptions' lbi _v opts = do --- CPP >= 1.24 - return $ renderGhcOptions (compiler lbi) (hostPlatform lbi) opts -#endif +main = getArgs >>= helper_main >>= print diff --git a/src/CabalHelper/Shared/Common.hs b/src/CabalHelper/Shared/Common.hs --- a/src/CabalHelper/Shared/Common.hs +++ b/src/CabalHelper/Shared/Common.hs @@ -1,23 +1,18 @@ -- cabal-helper: Simple interface to Cabal's configuration state -- Copyright (C) 2015-2018 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . +-- http://www.apache.org/licenses/LICENSE-2.0 {-| Module : CabalHelper.Shared.Common Description : Shared utility functions -License : GPL-3 +License : Apache-2.0 -} {-# LANGUAGE CPP, DeriveDataTypeable, OverloadedStrings #-} @@ -28,6 +23,19 @@ #define CH_MIN_VERSION_Cabal MIN_VERSION_Cabal #endif +import Distribution.PackageDescription + ( GenericPackageDescription + ) +import Distribution.Verbosity + ( Verbosity + ) + +#if CH_MIN_VERSION_Cabal(2,2,0) +import qualified Distribution.PackageDescription.Parsec as P +#else +import qualified Distribution.PackageDescription.Parse as P +#endif + import Control.Applicative import Control.Exception as E import Control.Monad @@ -39,11 +47,6 @@ import Data.ByteString (ByteString) import qualified Data.ByteString as BS import qualified Data.ByteString.Char8 as BS8 -#if CH_MIN_VERSION_Cabal(2,2,0) -import qualified Distribution.PackageDescription.Parsec as P -#else -import qualified Distribution.PackageDescription.Parse as P -#endif import System.Environment import System.IO import qualified System.Info @@ -53,8 +56,10 @@ import Text.ParserCombinators.ReadP import Prelude -data Panic = Panic String deriving (Typeable, Show) +data Panic = Panic String deriving (Typeable) instance Exception Panic +instance Show Panic where + show (Panic msg) = "panic! " ++ msg panic :: String -> a panic msg = throw $ Panic msg @@ -71,29 +76,25 @@ prog <- getProgName hPutStrLn stderr $ prog ++ ": " ++ str --- | @getCabalConfigHeader "dist/setup-config"@ returns the cabal version and --- compiler version -getCabalConfigHeader :: FilePath -> IO (Maybe (Version, (ByteString, Version))) -getCabalConfigHeader file = bracket (openFile file ReadMode) hClose $ \h -> do - parseHeader <$> BS.hGetLine h - -parseHeader :: ByteString -> Maybe (Version, (ByteString, Version)) -parseHeader header = case BS8.words header of - ["Saved", "package", "config", "for", _pkgId , - "written", "by", cabalId, - "using", compId] - -> liftM2 (,) (snd <$> parsePkgId cabalId) (parsePkgId compId) - _ -> Nothing - -parsePkgId :: ByteString -> Maybe (ByteString, Version) -parsePkgId bs = - case BS8.split '-' bs of - [pkg, vers] -> Just (pkg, parseVer $ BS8.unpack vers) +parsePkgId :: String -> Maybe (String, Version) +parsePkgId s = + case span (/='-') (reverse s) of + (vers, '-':pkg) -> Just (reverse pkg, parseVer (reverse vers)) _ -> Nothing +parsePkgIdBS :: ByteString -> Maybe (ByteString, Version) +parsePkgIdBS bs = + case BS8.span (/='-') (BS.reverse bs) of + (vers, pkg') -> + Just ( BS.reverse $ BS.tail pkg' + , parseVer (BS8.unpack (BS.reverse vers))) + parseVer :: String -> Version parseVer vers = runReadP parseVersion vers +parseVerMay :: String -> Maybe Version +parseVerMay vers = runReadPMay parseVersion vers + trim :: String -> String trim = dropWhileEnd isSpace @@ -104,10 +105,17 @@ sameMajorVersionAs a b = majorVer a == majorVer b runReadP :: ReadP t -> String -> t -runReadP p i = case filter ((=="") . snd) $ readP_to_S p i of - (a,""):[] -> a - _ -> error $ "Error parsing: " ++ show i +runReadP p i = + case runReadPMay p i of + Just x -> x + Nothing -> error $ "Error parsing version: " ++ show i +runReadPMay :: ReadP t -> String -> Maybe t +runReadPMay p i = case filter ((=="") . snd) $ readP_to_S p i of + (a,""):[] -> Just a + _ -> Nothing + + appCacheDir :: IO FilePath appCacheDir = ( "cabal-helper") <$> getEnvDefault "XDG_CACHE_HOME" (homeRel cache) @@ -124,15 +132,6 @@ windowsCache = "Local Settings" "Cache" unixCache = ".cache" -isCabalFile :: FilePath -> Bool -isCabalFile f = takeExtension' f == ".cabal" - -takeExtension' :: FilePath -> String -takeExtension' p = - if takeFileName p == takeExtension p - then "" -- just ".cabal" is not a valid cabal file - else takeExtension p - replace :: String -> String -> String -> String replace n r hs' = go "" hs' where @@ -143,8 +142,17 @@ go acc [] = reverse acc -#if CH_MIN_VERSION_Cabal(2,2,0) +readPackageDescription + :: Verbosity + -> FilePath + -> IO GenericPackageDescription +#if CH_MIN_VERSION_Cabal(2,0,0) readPackageDescription = P.readGenericPackageDescription #else readPackageDescription = P.readPackageDescription #endif + +mightExist :: FilePath -> IO (Maybe FilePath) +mightExist f = do + exists <- doesFileExist f + return $ if exists then (Just f) else (Nothing) diff --git a/src/CabalHelper/Shared/InterfaceTypes.hs b/src/CabalHelper/Shared/InterfaceTypes.hs --- a/src/CabalHelper/Shared/InterfaceTypes.hs +++ b/src/CabalHelper/Shared/InterfaceTypes.hs @@ -1,27 +1,22 @@ -- cabal-helper: Simple interface to Cabal's configuration state -- Copyright (C) 2015-2018 Daniel Gröber -- --- 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. +-- SPDX-License-Identifier: Apache-2.0 -- --- 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. +-- Licensed under the Apache License, Version 2.0 (the "License"); +-- you may not use this file except in compliance with the License. +-- You may obtain a copy of the License at -- --- You should have received a copy of the GNU General Public License --- along with this program. If not, see . +-- http://www.apache.org/licenses/LICENSE-2.0 {-# LANGUAGE DeriveGeneric, DeriveDataTypeable, DefaultSignatures #-} {-| Module : CabalHelper.Shared.InterfaceTypes Description : Types which are used by c-h library and executable to communicate -License : GPL-3 +License : Apache-2.0 -These types are used to communicate between the cabal-helper library and main +These types are used to communicate between the cabal-helper library and helper executable, using Show/Read. If any types in this module change the major version must be bumped since this will be exposed in the @Distribution.Helper@ module. @@ -34,48 +29,64 @@ import GHC.Generics import Data.Version +import Data.Map.Strict (Map) data ChResponse - = ChResponseCompList [(ChComponentName, [String])] - | ChResponseEntrypoints [(ChComponentName, ChEntrypoint)] - | ChResponseNeedsBuild [(ChComponentName, NeedsBuildOutput)] - | ChResponseList [String] - | ChResponsePkgDbs [ChPkgDb] - | ChResponseLbi String - | ChResponseVersion String Version - | ChResponseLicenses [(String, [(String, Version)])] - | ChResponseFlags [(String, Bool)] + = ChResponseComponentsInfo (Map ChComponentName ChComponentInfo) + | ChResponseList [String] + | ChResponseLbi String + | ChResponseVersion (String, Version) + | ChResponseFlags [(String, Bool)] deriving (Eq, Ord, Read, Show, Generic) data ChComponentName = ChSetupHsName - | ChLibName - | ChSubLibName String + | ChLibName ChLibraryName | ChFLibName String | ChExeName String | ChTestName String | ChBenchName String deriving (Eq, Ord, Read, Show, Generic) -newtype ChModuleName = ChModuleName String +data ChLibraryName = ChMainLibName + | ChSubLibName String + deriving (Eq, Ord, Read, Show, Generic) + +newtype ChModuleName = ChModuleName { unChModuleName :: String } deriving (Eq, Ord, Read, Show, Generic) -data ChEntrypoint = ChSetupEntrypoint -- ^ Almost like 'ChExeEntrypoint' but - -- @main-is@ could either be @"Setup.hs"@ - -- or @"Setup.lhs"@. Since we don't know - -- where the source directory is you have - -- to find these files. - | ChLibEntrypoint { chExposedModules :: [ChModuleName] - , chOtherModules :: [ChModuleName] - , chSignatures :: [ChModuleName] -- backpack only - } - | ChExeEntrypoint { chMainIs :: FilePath - , chOtherModules :: [ChModuleName] - } deriving (Eq, Ord, Read, Show, Generic) +data ChComponentInfo = ChComponentInfo + { ciComponentName :: ChComponentName + -- ^ The component\'s type and name + , ciGhcOptions :: [String] + -- ^ Full set of GHC options, ready for loading this component into GHCi. + + , ciSourceDirs :: [String] + -- ^ A component's @hs-source-dirs@ field, note that this only contains the + -- directories specified by the cabal file, however cabal also adds the + -- output directory of preprocessors to GHC's search path when + -- building. TODO: make this easier to use. + + , ciEntrypoints :: ChEntrypoint + -- ^ Modules or files Cabal would have the compiler build directly. Can be + -- used to compute the home module closure for a component. + } deriving (Eq, Ord, Read, Show) + +data ChEntrypoint + = ChSetupEntrypoint + { chMainIs :: FilePath + } + | ChLibEntrypoint + { chExposedModules :: [ChModuleName] + , chOtherModules :: [ChModuleName] + , chSignatures :: [ChModuleName] -- backpack only + } + | ChExeEntrypoint + { chMainIs :: FilePath + , chOtherModules :: [ChModuleName] + } deriving (Eq, Ord, Read, Show, Generic) + data ChPkgDb = ChPkgGlobal | ChPkgUser | ChPkgSpecific FilePath - deriving (Eq, Ord, Read, Show, Generic) - -data NeedsBuildOutput = ProduceBuildOutput | NoBuildOutput deriving (Eq, Ord, Read, Show, Generic) diff --git a/src/CabalHelper/Shared/Sandbox.hs b/src/CabalHelper/Shared/Sandbox.hs deleted file mode 100644 --- a/src/CabalHelper/Shared/Sandbox.hs +++ /dev/null @@ -1,78 +0,0 @@ --- cabal-helper: Simple interface to Cabal's configuration state --- Copyright (C) 2015-2017 Daniel Gröber --- --- 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 . - -{-| -Module : CabalHelper.Shared.Sandbox -Description : Extracting information from @cabal.sandbox.config@ files -License : GPL-3 --} - -module CabalHelper.Shared.Sandbox where - -import Control.Applicative -import Data.Char -import Data.Maybe -import Data.List -import Data.Version -import System.FilePath -import System.Directory -import Prelude - -import qualified Data.Traversable as T - --- | Get the path to the sandbox package-db in a project -getSandboxPkgDb :: FilePath - -- ^ Path to the cabal package root directory (containing the - -- @cabal.sandbox.config@ file) - -> String - -- ^ Cabal build platform, i.e. @buildPlatform@ - -> Version - -- ^ GHC version (@cProjectVersion@ is your friend) - -> IO (Maybe FilePath) -getSandboxPkgDb d platform ghcVer = do - mConf <- T.traverse readFile =<< mightExist (d "cabal.sandbox.config") - return $ fixPkgDbVer <$> (extractSandboxDbDir =<< mConf) - - where - fixPkgDbVer dir = - case takeFileName dir == ghcSandboxPkgDbDir platform ghcVer of - True -> dir - False -> takeDirectory dir ghcSandboxPkgDbDir platform ghcVer - -ghcSandboxPkgDbDir :: String -> Version -> String -ghcSandboxPkgDbDir platform ghcVer = - platform ++ "-ghc-" ++ showVersion ghcVer ++ "-packages.conf.d" - --- | Extract the sandbox package db directory from the cabal.sandbox.config --- file. Exception is thrown if the sandbox config file is broken. -extractSandboxDbDir :: String -> Maybe FilePath -extractSandboxDbDir conf = extractValue <$> parse conf - where - key = "package-db:" - keyLen = length key - - parse = listToMaybe . filter (key `isPrefixOf`) . lines - extractValue = CabalHelper.Shared.Sandbox.dropWhileEnd isSpace . dropWhile isSpace . drop keyLen - - -mightExist :: FilePath -> IO (Maybe FilePath) -mightExist f = do - exists <- doesFileExist f - return $ if exists then (Just f) else (Nothing) - --- dropWhileEnd is not provided prior to base 4.5.0.0. -dropWhileEnd :: (a -> Bool) -> [a] -> [a] -dropWhileEnd p = foldr (\x xs -> if p x && null xs then [] else x : xs) [] diff --git a/tests/CompileTest.hs b/tests/CompileTest.hs --- a/tests/CompileTest.hs +++ b/tests/CompileTest.hs @@ -1,159 +1,163 @@ -{-# LANGUAGE ScopedTypeVariables, GADTs #-} +{-# LANGUAGE ScopedTypeVariables, GADTs, ImplicitParams, OverloadedStrings #-} +{-| This test tries to compile the Helper against every supported version of the + Cabal library. Since we compile the Helper at runtime, on the user's machine, + it is very important to make sure this will not fail to compile. + + This test only covers using v2-build to install the requested Cabal library + version because it has the best build product caching (keeps CI times + down). We could also use stack since it has a global package cache but we + don't support that because stack always comes with the right Cabal library + version available for a given resolver anyways. +-} + import System.Environment (getArgs) import System.Directory import System.FilePath import System.Process import System.Exit import System.IO -import Control.Exception as E +import System.IO.Temp import Data.List import Data.Maybe import Data.Version import Data.Functor import Data.Function -import qualified Distribution.Compat.ReadP as Dist import Distribution.Version (VersionRange, withinRange) -import Distribution.Text import Control.Arrow import Control.Monad +import Control.Monad.Trans.Maybe import Prelude import CabalHelper.Compiletime.Compat.Environment import CabalHelper.Compiletime.Compat.Version +import CabalHelper.Compiletime.Compat.Parsec +import CabalHelper.Compiletime.Cabal import CabalHelper.Compiletime.Compile +import CabalHelper.Compiletime.Program.GHC import CabalHelper.Compiletime.Types import CabalHelper.Shared.Common -runReadP'Dist :: Dist.ReadP t t -> String -> t -runReadP'Dist p i = case filter ((=="") . snd) $ Dist.readP_to_S p i of - (a,""):[] -> a - _ -> error $ "Error parsing: " ++ show i - withinRange'CH :: Version -> VersionRange -> Bool withinRange'CH v r = withinRange (fromDataVersion v) r setupHOME :: IO () setupHOME = do + mhome <- lookupEnv "HOME" + case mhome of + Just home -> do + exists <- doesDirectoryExist home + when (not exists) createHOME + Nothing -> createHOME + +createHOME :: IO () +createHOME = do tmp <- fromMaybe "/tmp" <$> lookupEnv "TMPDIR" let home = tmp "compile-test-home" _ <- rawSystem "rm" ["-r", home] - createDirectory home + createDirectory home setEnv "HOME" home main :: IO () main = do + let ?progs = defaultPrograms + let ?opts = defaultCompileOptions { oVerbose = True } + let ?verbose = \level -> case level of 1 -> True; _ -> False + args <- getArgs case args of "list-versions":[] -> do - mapM_ print =<< (allCabalVersions <$> ghcVersion defaultOptions) + mapM_ print =<< relevantCabalVersions =<< ghcVersion "list-versions":ghc_ver_str:[] -> - mapM_ print $ allCabalVersions (parseVer ghc_ver_str) + mapM_ print =<< relevantCabalVersions (GhcVersion (parseVer ghc_ver_str)) _ -> test args +test :: Env => [String] -> IO () test args = do let action - | null args = testAllCabalVersions + | null args = testRelevantCabalVersions | otherwise = testCabalVersions $ map parseVer' args setupHOME - _ <- rawSystem "cabal" ["update"] - action -parseVer' :: String -> Either HEAD Version -parseVer' "HEAD" = Left HEAD -parseVer' v = Right $ parseVer v +parseVer' :: String -> CabalVersion +parseVer' "HEAD" = CabalHEAD () +parseVer' v = CabalVersion $ parseVer v -allCabalVersions :: Version -> [Version] -allCabalVersions ghc_ver = let - cabal_versions :: [Version] - cabal_versions = map parseVer - -- "1.14.0" -- not supported at runtime - [ "1.16.0" - , "1.16.0.1" - , "1.16.0.2" - , "1.16.0.3" - , "1.18.0" - , "1.18.1" - , "1.18.1.1" - , "1.18.1.2" - , "1.18.1.3" - , "1.18.1.4" - , "1.18.1.5" - , "1.18.1.6" - , "1.18.1.7" - , "1.20.0.0" - , "1.20.0.1" - , "1.20.0.2" - , "1.20.0.3" - , "1.20.0.4" - , "1.22.0.0" - , "1.22.1.0" - , "1.22.1.1" - , "1.22.2.0" - , "1.22.3.0" - , "1.22.4.0" - , "1.22.5.0" - , "1.22.6.0" - , "1.22.7.0" - , "1.22.8.0" - , "1.24.0.0" - , "1.24.1.0" - , "1.24.2.0" - , "2.0.0.2" - , "2.0.1.0" - , "2.0.1.1" - , "2.2.0.0" - , "2.2.0.1" - , "2.4.0.0" - , "2.4.0.1" - , "2.4.1.0" - ] +relevantCabalVersions :: GhcVersion -> IO [Version] +relevantCabalVersions g = map snd . filter fst <$> allCabalVersions g +allCabalVersions :: GhcVersion -> IO [(Bool,Version)] +allCabalVersions (GhcVersion ghc_ver) = do + cabal_versions + <- map parseVer . lines <$> readFile "tests/cabal-versions" + let constraint :: VersionRange - constraint = - fromMaybe (snd $ last constraint_table) $ + Just constraint = fmap snd $ find (and . (zipWith (==) `on` versionBranch) ghc_ver . fst) $ constraint_table + constraint_table :: [(Version, VersionRange)] constraint_table = - map (parseVer *** runReadP'Dist parse) $ - [ ("7.4" , ">= 1.14 && < 2") - , ("7.6" , ">= 1.16 && < 2") - , ("7.8" , ">= 1.18 && < 2") - , ("7.10" , ">= 1.22.2 && < 2") + map (parseVer *** (absorbParsecFailure "constraint_table" . eitherParsec)) $ + -- , ("7.8" , ">= 1.18 && < 2") + [ ("7.10" , ">= 1.22.2 && < 2") , ("8.0.1", ">= 1.24 ") , ("8.0.2", ">= 1.24.2 ") - , ("8.2.1", ">= 2.0.0.2 ") - , ("8.2.2", ">= 2.0.0.2 ") - , ("8.4.1", ">= 2.0.0.2 ") - , ("8.4.2", ">= 2.2.0.1 ") - , ("8.6", ">= 2.4.0.0 ") + , ("8.2", ">= 1.24.2.0 ") + , ("8.4", ">= 2.0.0.2 ") + , ("8.6", ">= 2.0.0.2 ") ] - in - reverse $ filter (flip withinRange'CH constraint) cabal_versions + return $ reverse $ map (flip withinRange'CH constraint &&& id) cabal_versions -testAllCabalVersions :: IO () -testAllCabalVersions = do - ghc_ver <- ghcVersion defaultOptions - let relevant_cabal_versions = allCabalVersions ghc_ver - testCabalVersions $ map Right relevant_cabal_versions ++ [Left HEAD] +testRelevantCabalVersions :: Env => IO () +testRelevantCabalVersions = do + ghc_ver <- ghcVersion + relevant_cabal_versions <- relevantCabalVersions ghc_ver + testCabalVersions $ map CabalVersion relevant_cabal_versions ++ [CabalHEAD ()] -testCabalVersions :: [Either HEAD Version] -> IO () +testCabalVersions :: Env => [CabalVersion] -> IO () testCabalVersions versions = do - rvs <- forM versions $ \ver -> do - let sver = either show showVersion ver - hPutStrLn stderr $ "\n\n\n\n\n\n====== Compiling with Cabal-" ++ sver - compilePrivatePkgDb ver +-- ghcVer <- ghcVersion + rvs <- forM versions $ \cv -> do + withSystemTempDirectory "cabal-helper.proj-local-tmp" $ \tmpdir -> do + let sver = showCabalVersion cv + hPutStrLn stderr $ "\n\n\n\n\n\n====== Compiling with Cabal-" ++ sver + + let che0 = \icv db -> CompHelperEnv + { cheCabalVer = icv + , chePkgDb = db + , cheProjDir = tmpdir + , chePlanJson = Nothing + , cheDistV2 = Just $ tmpdir "dist-newstyle" + , cheProjLocalCacheDir = + tmpdir "dist-newstyle" "cache" + } + + che <- case cv of + CabalHEAD () -> do + rcv <- resolveCabalVersion cv + db <- getPrivateCabalPkgDb rcv + mcabalVersions <- runMaybeT $ listCabalVersions (Just db) + case mcabalVersions of + Just [hdver] -> + return $ che0 (CabalVersion hdver) (Just db) + _ -> + return $ che0 (CabalHEAD ()) Nothing + (CabalVersion ver) -> + return $ che0 (CabalVersion ver) Nothing + + compileHelper che + let printStatus (cv, rv) = putStrLn $ "- Cabal "++ver++" "++status - where ver = case cv of Left _ -> "HEAD"; Right v -> showVersion v + where ver = showCabalVersion cv status = case rv of Right _ -> "succeeded" @@ -163,37 +167,10 @@ let drvs = versions `zip` rvs mapM_ printStatus drvs - if any isLeft' $ map snd $ filter ((/=Left HEAD) . fst) drvs + if any isLeft' $ map snd $ filter ((/=(CabalHEAD ())) . fst) drvs then exitFailure else exitSuccess where isLeft' (Left _) = True isLeft' (Right _) = False - -compilePrivatePkgDb :: Either HEAD Version -> IO (Either ExitCode FilePath) -compilePrivatePkgDb eCabalVer = do - res <- E.try $ installCabal defaultOptions { oVerbose = True } eCabalVer - case res of - Right (db, cabalVer) -> - compileWithPkg db cabalVer - Left (ioe :: IOException) -> do - print ioe - return $ Left (ExitFailure 1) - -compileWithPkg :: PackageDbDir - -> CabalVersion - -> IO (Either ExitCode FilePath) -compileWithPkg db cabalVer = do - appdir <- appCacheDir - let comp = - CompileWithCabalPackage (Just db) cabalVer [cabalPkgId cabalVer] CPSGlobal - compile - comp - (compPaths appdir (error "compile-test: distdir not available") comp) - defaultOptions { oVerbose = True } - - -cabalPkgId :: CabalVersion -> String -cabalPkgId (CabalHEAD _commitid) = "Cabal" -cabalPkgId (CabalVersion v) = "Cabal-" ++ showVersion v diff --git a/tests/Examples.hs b/tests/Examples.hs new file mode 100644 --- /dev/null +++ b/tests/Examples.hs @@ -0,0 +1,65 @@ +{-# LANGUAGE ScopedTypeVariables #-} + +module Main where + +import Distribution.Helper +import Data.Foldable + ( toList ) +import System.Process + ( system ) +import System.Environment + ( getArgs ) +import System.Exit + ( ExitCode(ExitSuccess) ) +import System.IO + ( hPutStrLn, stderr ) +import System.Console.GetOpt + ( OptDescr(Option), ArgDescr(NoArg), ArgOrder(RequireOrder), getOpt + , usageInfo ) + +main :: IO () +main = do + args <- getArgs + actions <- parseOpts args + sequence_ actions + +-- | Run shell command and +systemV :: String -> IO () +systemV shell_cmd = do + hPutStrLn stderr $ "$ " ++ shell_cmd + ExitSuccess <- system shell_cmd + return () + +options :: [OptDescr (IO ())] +options = + [ Option [] ["cabal"] (NoArg doCabalV2) "" + , Option [] ["cabal-old-v1"] (NoArg doCabalV1) "" + , Option [] ["stack"] (NoArg doCabalV2) "" + ] + +parseOpts :: [String] -> IO [IO ()] +parseOpts argv = + case getOpt RequireOrder options argv of + (o, [], [] ) -> + return o + (_, _, errs) -> + ioError (userError (concat errs ++ usageInfo header options)) + where header = "Usage: examples (--cabal|--cabal-old-v1|--stack)..." + +doCabalV2 :: IO () +doCabalV2 = do + _ <- systemV "cabal new-build --builddir=dist-newstyle" + qe <- mkQueryEnv (ProjLocV2Dir ".") (DistDirCabal SCV2 "dist-newstyle/") + printUnitInfos qe + +doCabalV1 :: IO () +doCabalV1 = return () + +doStack :: IO () +doStack = return () + +printUnitInfos :: QueryEnv pt -> IO () +printUnitInfos qe = do + components :: [ChComponentInfo] + <- concat <$> runQuery (allUnits (toList . uiComponents)) qe + print components diff --git a/tests/GhcSession.hs b/tests/GhcSession.hs --- a/tests/GhcSession.hs +++ b/tests/GhcSession.hs @@ -1,135 +1,376 @@ -{-# LANGUAGE TupleSections, ScopedTypeVariables #-} +{-# LANGUAGE TupleSections, ScopedTypeVariables, RecordWildCards, RankNTypes, + DataKinds, ExistentialQuantification, PolyKinds, ViewPatterns, + DeriveFunctor, MonoLocalBinds, GADTs, MultiWayIf #-} + +{-| This test ensures we can get a GHC API session up and running in a variety of + project environments. +-} + module Main where import GHC +import Config import GHC.Paths (libdir) +import Outputable import DynFlags import qualified Control.Exception as E import Control.Monad import Control.Monad.IO.Class import Data.List +import Data.Maybe import Data.Version +import Data.Bifunctor +import qualified Data.Map as Map +import System.Console.GetOpt as GetOpt import System.Environment (getArgs) import System.Exit -import System.FilePath (()) +import System.FilePath ((), (<.>), makeRelative, takeDirectory) import System.Directory import System.IO +import System.IO.Unsafe (unsafePerformIO) import System.IO.Temp -import System.Process (rawSystem, readProcess) +import Text.Printf (printf) +import Text.Show.Pretty (pPrint) import Distribution.Helper import CabalHelper.Shared.Common +import CabalHelper.Compiletime.Types (Env) +import CabalHelper.Compiletime.Process (readProcess, callProcessStderr) +import CabalHelper.Compiletime.Program.GHC + (GhcVersion(..), ghcVersion) +import CabalHelper.Compiletime.Program.CabalInstall + (CabalInstallVersion(..), cabalInstallVersion) +data TestConfig = TC + { location :: TestLocation + , cabalLowerBound :: Version + , ghcLowerBound :: Version + , projTypes :: [ProjType] + } deriving (Show) +data TestLocation + = TN String + | TF FilePath FilePath FilePath + deriving (Show) + +testConfigToTestSpec :: TestConfig -> ProjType -> String +testConfigToTestSpec (TC loc _ _ _) pt = + let (topdir, projdir, cabal_file) = testLocPath loc in + "- " ++ intercalate ":" [topdir, projdir, cabal_file, show pt] + +type ModProgs = (Programs -> Programs) + +options :: [OptDescr ModProgs] +options = + [ GetOpt.Option [] ["with-cabal"] + (ReqArg (\arg -> \p -> p { cabalProgram = arg }) "PROG") + "name or path of 'cabal' executable" + , GetOpt.Option [] ["with-stack"] + (ReqArg (\arg -> \p -> p { stackProgram = arg }) "PROG") + "name or path of 'stack' executable" + , GetOpt.Option [] ["with-ghc"] + (ReqArg (\arg -> \cp -> cp { ghcProgram = arg }) "PROG") + "name or path of 'ghc' executable" + , GetOpt.Option [] ["with-ghc-pkg"] + (ReqArg (\arg -> \cp -> cp { ghcPkgProgram = arg }) "PROG") + "name or path of 'ghc-pkg' executable" + ] + +testOpts :: [String] -> IO (ModProgs, [String]) +testOpts args = + case getOpt Permute options args of + (o,n,[] ) -> return (foldl (flip (.)) id o, n) + (_,_,errs) -> ioError (userError (concat errs ++ usageInfo header options)) + where header = "Usage: ghc-session [OPTION..] [TEST_SPEC..]" + main :: IO () main = do - args <- getArgs - topdir <- getCurrentDirectory - res <- mapM (setup topdir test) $ case args of - [] -> [ ("tests/exelib" , parseVer "1.10", parseVer "0") - , ("tests/exeintlib", parseVer "2.0", parseVer "0") - , ("tests/fliblib" , parseVer "2.0", parseVer "0") - , ("tests/bkpregex" , parseVer "2.0", parseVer "8.1") - -- min Cabal lib ver -^ min GHC ver -^ - ] - xs -> map (, parseVer "0", parseVer "0") xs + (modProgs, args) <- testOpts =<< getArgs +-- topdir <- getCurrentDirectory - if any (==False) $ concat res + let withEnv :: (Env => a) -> a + withEnv action = + let ?verbose = const False + ?progs = modProgs defaultPrograms + in action + + GhcVersion g_ver <- withEnv ghcVersion + CabalInstallVersion ci_ver <- withEnv cabalInstallVersion + s_ver <- withEnv stackVersion + `E.catch` \(_ :: IOError) -> return (makeVersion [0]) + + -- Cabal lib version + f_c_ver :: ProjType -> Either SkipReason Version <- do + ci_c_ver <- Right <$> withEnv cabalInstallBuiltinCabalVersion + s_c_ver :: Either SkipReason Version + <- sequence $ withEnv stackBuiltinCabalVersion s_ver g_ver + return $ \pt -> case pt of + Cabal CV1 -> ci_c_ver + Cabal CV2 -> ci_c_ver + Stack -> s_c_ver + + let showEsrVer = either (\(SkipReason msg) -> "dunno, "++msg) showVersion + + putStrLn "Environment Info" + putStrLn "================" + putStrLn "" + putStrLn $ "cabal-install version: " ++ showVersion ci_ver + putStrLn $ "cabal-install builtin Cabal version: " + ++ showEsrVer (f_c_ver (Cabal CV1)) + putStrLn $ "GHC executable version: " ++ showVersion g_ver + putStrLn $ "GHC library version: " ++ cProjectVersion + putStrLn $ "Stack version: " ++ showVersion s_ver + putStrLn $ "Stack Cabal version: " ++ showEsrVer (f_c_ver Stack) + putStrLn "" + + when (cProjectVersion /= showVersion g_ver) $ + error "GHC version mismatch! See above." + + let proj_impls :: [(ProjType, ProjSetup0)] + proj_impls = + -- V2 is sorted before the others here so helper compilation always + -- uses v2-build caching! + [ (Cabal CV2, newBuildProjSetup) + , (Cabal CV1, oldBuildProjSetup) + , (Stack, stackProjSetup g_ver) + ] + all_proj_types = map fst proj_impls + + tests <- return $ case args of + xs@(_:_) -> flip map xs $ \loc -> + let (topdir, ':':x0) = span (/=':') loc + (projdir0, ':':x1) = span (/=':') x0 + (cabal_file0, ':':pt) = span (/=':') x1 + projdir = makeRelative topdir projdir0 + cabal_file = makeRelative topdir cabal_file0 in + TC (TF topdir projdir cabal_file) (parseVer "0") (parseVer "0") [read pt] + [] -> + -- below V2 is sorted before Stack and V1 since we rely on v2-build's + -- fucking awesome store cache to keep CI times down. + -- + -- TODO: Better test coverage for helper compilation with the other two! + [ TC (TN "exelib") (parseVer "1.10") (parseVer "0") [] + , TC (TN "exeintlib") (parseVer "2.0") (parseVer "0") [] + , TC (TN "fliblib") (parseVer "2.0") (parseVer "0") [] + , TC (TN "bkpregex") (parseVer "2.0") (parseVer "8.1") [Cabal CV2, Cabal CV1] + , let multipkg_loc = TF "tests/multipkg/" "proj/" "proj/proj.cabal" in + TC multipkg_loc (parseVer "1.10") (parseVer "0") [Cabal CV2, Stack] + -- min Cabal lib ver -^ min GHC ver -^ + ] + + putStrLn "Going to Run These Tests" + putStrLn "========================" + forM_ tests $ \tc@(TC _ _ _ pts) -> do + forM_ (if pts == [] then all_proj_types else pts) $ \pt -> + putStrLn $ testConfigToTestSpec tc pt + + pPrint tests + putStrLn "" + + res :: [[TestResult]] <- sequence $ do + tc@TC {..} <- tests + (pt, ps0 :: ProjSetup0) <- proj_impls + guard (null projTypes || pt `elem` projTypes) + + let skip (SkipReason reason) = do + putStrLn $ intercalate " " + [ "\n\n\nSkipping test" + , psdHeading ps0 + , "'" ++ topdir projdir_rel ++ "'" + , "because" + , reason + ] + where + (topdir, projdir_rel, _) = testLocPath location + + case psdImpl ps0 of + Left reason -> return $ skip reason >> return [] + Right eximpl -> do + let ps1 = ps0 { psdImpl = eximpl } + case checkAndRunTestConfig modProgs VerEnv{..} ps1 tc of + Left reason -> return $ skip reason >> return [] + Right (Message msg, act) -> return $ putStrLn msg >> act + + putStr "\n\n\n\n" + putStrLn "Test Results" + putStrLn "============" + pPrint res + + if any (==False) $ map trSuccess $ concat res then exitFailure else exitSuccess -cabalInstallVersion :: IO Version -cabalInstallVersion = - parseVer . trim <$> readProcess "cabal" ["--numeric-version"] "" +data VerEnv = VerEnv + { ci_ver :: !Version + -- ^ cabal-install exe version + , f_c_ver :: !(ProjType -> Either SkipReason Version) + -- ^ cabal-install/Stack builtin Cabal library version + , g_ver :: !Version + -- ^ GHC exe version + , s_ver :: !Version + -- ^ Stack exe version + } -ghcVersion :: IO Version -ghcVersion = - parseVer . trim <$> readProcess "ghc" ["--numeric-version"] "" +data Message = Message String +data SkipReason = SkipReason String +data TestResult + = TestResult + { trSuccess :: Bool + , trComp :: ChComponentName + , trHeading :: String -- ^ project type + , trDir :: FilePath + , trSpec :: String + } + deriving (Show) -cabalInstallBuiltinCabalVersion :: IO Version -cabalInstallBuiltinCabalVersion = - parseVer . trim <$> readProcess "cabal" - ["act-as-setup", "--", "--numeric-version"] "" +testLocPath :: TestLocation -> (FilePath, FilePath, FilePath) +testLocPath (TN test_name) = (projdir, ".", cabal_file) + where + projdir :: FilePath + projdir = "tests" test_name + cabal_file :: FilePath + cabal_file = test_name <.> "cabal" +testLocPath (TF topdir projdir cabal_file) = + (topdir, projdir, cabal_file) -setup :: FilePath -> (FilePath -> IO [Bool]) -> (FilePath, Version, Version) -> IO [Bool] -setup topdir act (srcdir, min_cabal_ver, min_ghc_ver) = do - ci_ver <- cabalInstallVersion - c_ver <- cabalInstallBuiltinCabalVersion - g_ver <- ghcVersion - let mreason - | (ci_ver < parseVer "1.24") = - Just $ "cabal-install-" ++ showVersion ci_ver ++ " is too old" - | c_ver < min_cabal_ver = - Just $ "Cabal-" ++ showVersion c_ver - ++ " < " ++ showVersion min_cabal_ver - | g_ver < min_ghc_ver = - Just $ "ghc-" ++ showVersion g_ver - ++ " < " ++ showVersion min_ghc_ver - | otherwise = - Nothing +-- | Check version bounds of tests against available versions, if successful run +-- the test. +checkAndRunTestConfig + :: ModProgs + -> VerEnv + -> ProjSetup1 + -> TestConfig + -> Either SkipReason (Message, IO [TestResult]) +checkAndRunTestConfig + modProgs + VerEnv { ci_ver, f_c_ver, g_ver, s_ver } + ps1@(psdImpl -> Ex psdImpl2) + tc@(TC test_loc min_cabal_ver min_ghc_ver _proj_types) + = let + pt = demoteSProjType $ psiProjType psdImpl2 + (topdir, projdir_rel, cabal_file) = testLocPath test_loc in do + c_ver <- f_c_ver pt + first SkipReason $ do + if| Stack <- pt, Left (SkipReason msg) <- stackCheckCompat s_ver g_ver -> + Left $ msg + | ci_ver < parseVer "1.24" -> + Left $ "cabal-install-" ++ showVersion ci_ver ++ " is too old" + | c_ver < min_cabal_ver -> + Left $ pt_disp pt ++ "'s builtin Cabal version is too old:\n" + ++ "Cabal-" ++ showVersion c_ver + ++ " < " ++ showVersion min_cabal_ver + | g_ver < min_ghc_ver -> + Left $ "ghc-" ++ showVersion g_ver + ++ " < " ++ showVersion min_ghc_ver + | otherwise -> + Right () + return $ (,) + (Message $ intercalate " " + [ "\n\n\nRunning test" + , psdHeading ps1 + , "'" ++ topdir ++ "'" + ]) + $ do + trs <- runTest + modProgs ps1{ psdImpl = psdImpl2 } topdir projdir_rel cabal_file + return $ map ($ testConfigToTestSpec tc pt) trs - case mreason of - Just reason -> do - putStrLn $ "Skipping test '" ++ srcdir ++ "' because " ++ reason ++ "." - return [] - Nothing -> do - putStrLn $ "Running test '" ++ srcdir ++ "' ------------------------------" - withSystemTempDirectory "cabal-helper.ghc-session.test" $ \dir -> do - setCurrentDirectory $ topdir srcdir - run "cabal" [ "sdist", "--output-dir", dir ] + where + pt_disp (Cabal CV1) = "cabal-install" + pt_disp (Cabal CV2) = "cabal-install" + pt_disp Stack = "Stack" - setCurrentDirectory dir - run "cabal" [ "configure" ] - act dir +runTest + :: ModProgs -> ProjSetup2 pt + -> FilePath -> FilePath -> FilePath + -> IO [String -> TestResult] +runTest modProgs ps2@(psdImpl -> ProjSetupImpl{..}) topdir projdir cabal_file + = do + withSystemTempDirectory' "cabal-helper.ghc-session.test" $ \tmpdir -> do + trs <- test modProgs ps2 topdir tmpdir (tmpdir projdir) (tmpdir cabal_file) + return $ + map ($ (topdir projdir)) $ + map ($ (psdHeading ps2)) $ + trs +runWithCwd :: FilePath -> String -> [String] -> IO () +runWithCwd cwd x xs = do + let ?verbose = (<=1) + callProcessStderr (Just cwd) [] x xs + run :: String -> [String] -> IO () run x xs = do - print $ x:xs - ExitSuccess <- rawSystem x xs - return () + let ?verbose = (<=1) + callProcessStderr Nothing [] x xs -test :: FilePath -> IO [Bool] -test dir = do - let qe = mkQueryEnv dir (dir "dist") - cs <- runQuery qe $ components $ (,,,) <$> entrypoints <.> ghcOptions <.> needsBuildOutput - forM cs $ \(ep, opts, nb, cn) -> do +test + :: ModProgs -> ProjSetup2 pt + -> FilePath -> FilePath -> FilePath -> FilePath + -> IO [(String -> String -> FilePath -> TestResult)] +test modProgs (psdImpl -> ProjSetupImpl{..}) topdir tmpdir projdir cabal_file + = do + qe' <- psiQEmod <$> mkQueryEnv + (psiProjLoc (CabalFile cabal_file) projdir) + (psiDistDir projdir) - putStrLn $ "\n" ++ show cn ++ ":::: " ++ show nb + let progs = modProgs (qePrograms qe') + qe = qe' { qePrograms = progs } - when (nb == ProduceBuildOutput) $ do - run "cabal" [ "build" ] + psiSdist progs topdir tmpdir - let opts' = "-Werror" : opts + cs <- concat <$> runQuery (allUnits (Map.elems . uiComponents)) qe - let sopts = intercalate " " $ map formatArg $ "\nghc" : opts' - putStrLn $ "\n" ++ show cn ++ ": " ++ sopts + -- TODO: Cludge until we can just build the unit dependencies + runQuery buildProject qe + + let pkgdir = takeDirectory cabal_file + homedir <- getHomeDirectory + let var_table = + [ (pkgdir, "${pkgdir}") + , (homedir, "${HOME}") + ] + + forM cs $ \ChComponentInfo{..} -> do + let opts' = "-Werror" : ciGhcOptions + let sopts = intercalate " " $ map formatArg $ "ghc" : map (normalizeOutputWithVars var_table) opts' + + putStrLn $ "\n" ++ show ciComponentName ++ ":\n" + hPutStrLn stderr $ "cd " ++ pkgdir -- messes up normalized output + putStrLn sopts + hFlush stdout - compileModule nb ep opts' + tr <- compileModule pkgdir ciEntrypoints ciSourceDirs opts' + return $ tr ciComponentName where formatArg x - | "-" `isPrefixOf` x = "\n "++x + | "-" `isPrefixOf` x = "\\\n "++x | otherwise = x +addCabalProject :: FilePath -> IO () +addCabalProject dir = do + writeFile (dir "cabal.project") "packages: .\n" -compileModule :: NeedsBuildOutput -> ChEntrypoint -> [String] -> IO Bool -compileModule nb ep opts = do +compileModule + :: FilePath -> ChEntrypoint -> [FilePath] -> [String] + -> IO (ChComponentName -> FilePath -> String -> String -> TestResult) +compileModule pkgdir ep srcdirs opts = do + cwd_before <- getCurrentDirectory + setCurrentDirectory pkgdir + flip E.finally (setCurrentDirectory cwd_before) $ do - putStrLn $ "compiling:" ++ show ep ++ " (" ++ show nb ++ ")" + putStrLn $ "compiling: " ++ show ep - E.handle (\(ec :: ExitCode) -> print ec >> return False) $ do + E.handle (\(ec :: ExitCode) -> print ec >> return (TestResult False)) $ do defaultErrorHandler defaultFatalMessager defaultFlushOut $ do - runGhc (Just libdir) $ do - - handleSourceError (\e -> GHC.printException e >> return False) $ do + let printGhcEx e = GHC.printException e >> return (TestResult False) + handleSourceError printGhcEx $ do - let target = case nb of - ProduceBuildOutput -> HscNothing -- AZ: what should this be? - NoBuildOutput -> HscInterpreted + let target = HscInterpreted -- TODO dflags0 <- getSessionDynFlags let dflags1 = dflags0 { @@ -142,41 +383,201 @@ (dflags2, _, _) <- parseDynamicFlags dflags1 (map noLoc opts) _ <- setSessionDynFlags dflags2 - ts <- mapM (\t -> guessTarget t Nothing) $ + ts <- mapM (\t -> guessTarget t Nothing) =<< case ep of - ChLibEntrypoint ms ms' ss -> map unChModuleName $ ms ++ ms' ++ ss - ChExeEntrypoint m' ms -> - let + ChLibEntrypoint ms ms' ss -> return $ + map unChModuleName $ ms ++ ms' ++ ss + ChExeEntrypoint m ms -> do + -- TODO: this doesn't take preprocessor outputs in + -- dist/build/$pkg/$pkg-tmp/ into account. + m1 <- liftIO $ findFile srcdirs m + case m1 of + Just m2 -> return $ [m2] ++ map unChModuleName ms + Nothing -> error $ printf + "Couldn't find source file for Main module (%s), search path:\n\ + \%s\n" m (show srcdirs) + ChSetupEntrypoint m -> return [m] - -- The options first clear out includes, then put in the build dir. We want the - -- first one after that, so "regex-example" in the following case - -- - -- ,"-i" - -- ,"-idist/build/regex-example" - -- ,"-iregex-example" - firstInclude = drop 2 $ head $ drop 2 $ filter (isPrefixOf "-i") opts - m = firstInclude m' - in [m] ++ map unChModuleName ms - ChSetupEntrypoint -> ["Setup.hs"] + -- Always compile targets as GHCi bytecode so the setContext call below + -- can always succeed + let ts' = map (\t -> t { targetAllowObjCode = False }) ts - let ts' = case nb of - NoBuildOutput -> map (\t -> t { targetAllowObjCode = False }) ts - ProduceBuildOutput -> ts + liftIO $ putStrLn $ "targets: " ++ showPpr dflags2 ts' setTargets ts' _ <- load LoadAllTargets - when (nb == NoBuildOutput) $ do +-- when (nb == NoBuildOutput) $ do + do setContext $ case ep of ChLibEntrypoint ms ms' ss -> map (IIModule . mkModuleName . unChModuleName) $ ms ++ ms' ++ ss ChExeEntrypoint _ ms -> map (IIModule . mkModuleName . unChModuleName) $ ChModuleName "Main" : ms - ChSetupEntrypoint -> + ChSetupEntrypoint _ -> map (IIModule . mkModuleName) ["Main"] - liftIO $ print ExitSuccess - return True + return $ TestResult True -unChModuleName :: ChModuleName -> String -unChModuleName (ChModuleName mn) = mn + +data CabalFile = CabalFile FilePath + +type ProjSetup0 = ProjSetupDescr (Either SkipReason (Ex ProjSetupImpl)) +type ProjSetup1 = ProjSetupDescr (Ex ProjSetupImpl) +type ProjSetup2 pt = ProjSetupDescr (ProjSetupImpl pt) + +data ProjSetupDescr a = + ProjSetupDescr + { psdHeading :: !String + , psdImpl :: !a + } deriving (Functor) + +data ProjSetupImpl pt = + ProjSetupImpl + { psiProjType :: !(SProjType pt) + , psiDistDir :: !(FilePath -> DistDir pt) + , psiProjLoc :: !(CabalFile -> FilePath -> ProjLoc pt) + , psiSdist :: !(Programs -> FilePath -> FilePath -> IO ()) + , psiQEmod :: !(QueryEnv pt -> QueryEnv pt) + } + +oldBuildProjSetup :: ProjSetup0 +oldBuildProjSetup = ProjSetupDescr "cabal-v1" $ Right $ Ex $ ProjSetupImpl + { psiProjType = SCabal SCV1 + , psiDistDir = \dir -> DistDirCabal SCV1 (dir "dist") + , psiProjLoc = \(CabalFile cf) projdir -> ProjLocV1CabalFile cf projdir + , psiSdist = \progs srcdir destdir -> + copyMuliPackageProject progs srcdir destdir (\_ _ -> return ()) + , psiQEmod = id + } + +newBuildProjSetup :: ProjSetup0 +newBuildProjSetup = ProjSetupDescr "cabal-v2" $ Right $ Ex $ ProjSetupImpl + { psiProjType = SCabal SCV2 + , psiDistDir = \dir -> DistDirCabal SCV2 (dir "dist-newstyle") + , psiProjLoc = \_cabal_file projdir -> ProjLocV2File (projdir "cabal.project") projdir + -- TODO: check if cabal.project is there and only use + -- V2File then, also remove addCabalProject below so we + -- cover both cases. + , psiSdist = \progs srcdir destdir -> do + copyMuliPackageProject progs srcdir destdir $ \pkgsrc pkgdest -> do + exists <- doesFileExist (pkgsrc "cabal.project") + if exists then + copyFile (pkgsrc "cabal.project") (pkgdest "cabal.project") + else + addCabalProject pkgdest + , psiQEmod = id + } + +stackProjSetup :: Version -> ProjSetup0 +stackProjSetup ghcVer = + ProjSetupDescr "stack" $ do + res <- lookupStackResolver ghcVer + let argsBefore = [ "--resolver="++res, "--system-ghc" ] + return $ Ex $ ProjSetupImpl + { psiProjType = SStack + , psiDistDir = \_dir -> DistDirStack Nothing + , psiProjLoc = \_cabal_file projdir -> + ProjLocStackYaml $ projdir "stack.yaml" + , psiSdist = \progs srcdir destdir -> do + copyMuliPackageProject progs srcdir destdir copyStackYamls + , psiQEmod = \qe -> + qe { qePrograms = (qePrograms qe) + { stackProjArgs = argsBefore + } + } + } + +lookupStackResolver :: Version -> Either SkipReason String +lookupStackResolver ghcVer = maybe (Left msg) Right $ + lookup ghcVer stack_resolver_table + where + msg = SkipReason $ "missing stack_resolver_table entry for "++ + showVersion ghcVer + +stack_resolver_table :: [(Version, String)] -- ^ (ghc version, stack resolver) +stack_resolver_table = unsafePerformIO $ + map (\(words -> [g, l]) -> (parseVer g, l)) . lines + <$> readFile "tests/stack-resolvers" + +copyStackYamls :: FilePath -> FilePath -> IO () +copyStackYamls srcdir destdir = do + files <- (\\ [".", ".."]) <$> getDirectoryContents srcdir + let ymls = filter (".yaml" `isSuffixOf`) $ + filter ("stack-" `isPrefixOf`) $ files + forM_ ymls $ \filename -> copyFile (srcdir filename) (destdir filename) + +-- | For each Cabal package listed in a @packages.list@ file, copy the package +-- to another directory while only including source files referenced in the +-- cabal file. +copyMuliPackageProject + :: Programs -> FilePath -> FilePath -> (FilePath -> FilePath -> IO ()) -> IO () +copyMuliPackageProject progs srcdir destdir copyPkgExtra = do + let packages_file = srcdir "packages.list" + pkgdirs <- lines <$> readFile packages_file + forM_ pkgdirs $ \pkgdir -> do + runWithCwd (srcdir pkgdir) (cabalProgram progs) + [ "act-as-setup", "--", "sdist" + , "--output-directory="++destdir pkgdir ] + copyPkgExtra (srcdir pkgdir) (destdir pkgdir) + +stackVersion :: (?progs :: Programs) => IO Version +stackVersion = + parseVer . trim <$> readProcess (stackProgram ?progs) [ "--numeric-version" ] "" + +stackBuiltinCabalVersion + :: (?progs :: Programs) + => Version -> Version -> Either SkipReason (IO Version) +stackBuiltinCabalVersion s_ver g_ver = do + _ <- stackCheckCompat s_ver g_ver + res <- lookupStackResolver g_ver + return $ parseVer . trim <$> readProcess (stackProgram ?progs) + [ "--resolver="++res, "--system-ghc", "exec", "--" + , "ghc-pkg", "--simple-output", "field", "Cabal", "version" + ] "" + +stackCheckCompat :: Version -> Version -> Either SkipReason () +stackCheckCompat s_ver g_ver = + if| s_ver < parseVer "1.9.4" -> + Left $ SkipReason $ "stack-" ++ showVersion s_ver ++ " is too old" + | otherwise -> + Right () + +cabalInstallBuiltinCabalVersion :: (?progs :: Programs) => IO Version +cabalInstallBuiltinCabalVersion = + parseVer . trim <$> readProcess (cabalProgram ?progs) + ["act-as-setup", "--", "--numeric-version"] "" + +normalizeOutputWithVars :: [(String, String)] -> String -> String +normalizeOutputWithVars ts str = + case filter (isJust . fst) $ map (first (flip stripPrefix str)) ts of + (Just rest, replacemnet) : _ -> + replacemnet ++ normalizeOutputWithVars ts rest + _ -> cont + where + cont = + case str of + s:ss -> s : normalizeOutputWithVars ts ss + [] -> [] +-- --------------------------------------------------------------------- +-- | Create and use a temporary directory in the system standard temporary directory. +-- +-- Behaves exactly the same as 'withTempDirectory', except that the parent temporary directory +-- will be that returned by 'getCanonicalTemporaryDirectory'. +withSystemTempDirectory' :: String -- ^ Directory name template + -> (FilePath -> IO a) -- ^ Callback that can use the directory + -> IO a +withSystemTempDirectory' template action + = liftIO getCanonicalTemporaryDirectory >>= \tmpDir' -> withTempDirectory' tmpDir' template action + +-- | Create and use a temporary directory inside the given directory. +-- +-- The directory is deleted after use. +withTempDirectory' :: FilePath -- ^ Parent directory to create the directory in + -> String -- ^ Directory name template + -> (FilePath -> IO a) -- ^ Callback that can use the directory + -> IO a +withTempDirectory' targetDir template = + gbracket + (liftIO (createTempDirectory targetDir template)) + (\x -> return x) -- Leave the dir for inspection later diff --git a/tests/ProgramsTest.hs b/tests/ProgramsTest.hs new file mode 100644 --- /dev/null +++ b/tests/ProgramsTest.hs @@ -0,0 +1,76 @@ +{-| This test checks if 'guessCompProgramPaths'\'s behaviour makes sense +-} + +{-# OPTIONS_GHC -fno-warn-incomplete-patterns #-} + +import Control.Monad +import Data.List +import System.Directory +import System.Environment +import System.Exit +import System.FilePath +import System.IO.Temp +import Text.Show.Pretty + +import CabalHelper.Compiletime.Types +import CabalHelper.Compiletime.CompPrograms +import Symlink (createSymbolicLink) + +main :: IO () +main = do + prog_name <- getProgName + args <- getArgs + case prog_name of + "programs-test" + | "ghc":ver:rest <- args -> ghc ver rest + | "ghc-pkg":ver:rest <- args -> ghc_pkg ver rest + | "haddock":ver:rest <- args -> haddock ver rest + | otherwise -> do_test + _ + | Just ver <- stripPrefix "ghc-pkg-" prog_name -> ghc_pkg ver args + | Just ver <- stripPrefix "ghc-" prog_name -> ghc ver args + | Just ver <- stripPrefix "haddock-" prog_name -> haddock ver args + where + ghc _ver ["--info"] = putStrLn "[]" -- seems we can get away with that :) + ghc ver ["--numeric-version"] = putStrLn ver + ghc _ver ["--supported-languages"] = return () + + ghc_pkg ver ["--version"] = + putStrLn $ "GHC package manager version " ++ ver + + haddock _ver ["--version"] = + putStrLn $ -- cabal isn't very picky about haddock versions so we just + -- hardocde it here + "Haddock version 2.20.0, (c) Simon Marlow 2006" ++ + "Ported to use the GHC API by David Waern 2006-2008" + +do_test :: IO () +do_test = do + prog <- canonicalizePath =<< getExecutablePath + + withSystemTempDirectory "c-h-programs-test" $ \tmpdir -> do + + forM_ ["8.6.5", "8.4.4"] $ \ver -> do + + let ghc = tmpdir "ghc-" ++ ver + let ghc_pkg = tmpdir "ghc-pkg-" ++ ver + let haddock = tmpdir "haddock-" ++ ver + let progs = defaultPrograms { ghcProgram = ghc } + + createSymbolicLink prog ghc + createSymbolicLink prog ghc_pkg + createSymbolicLink prog haddock + + let ?verbose = (==4) + + progs' <- guessCompProgramPaths progs + + pPrint (ghc, ghc_pkg, haddock) -- expected + pPrint progs' -- actual + + when (not $ and [ ghcPkgProgram progs' == ghc_pkg + , haddockProgram progs' == haddock + ]) + exitFailure + + putStr "\n\n" diff --git a/tests/ProjectTest.hs b/tests/ProjectTest.hs new file mode 100644 --- /dev/null +++ b/tests/ProjectTest.hs @@ -0,0 +1,7 @@ +{-| This test codifies the assumptions we make about build tool behaviour. +-} + +import System.Process + +main = do + withSystemTempDirectory "c-h-project-test" $ \tmpdir -> do diff --git a/tests/bkpregex/packages.list b/tests/bkpregex/packages.list new file mode 100644 --- /dev/null +++ b/tests/bkpregex/packages.list @@ -0,0 +1,1 @@ +./ diff --git a/tests/bkpregex/stack.yaml b/tests/bkpregex/stack.yaml new file mode 100644 --- /dev/null +++ b/tests/bkpregex/stack.yaml @@ -0,0 +1,3 @@ +resolver: lts-0.0 # will be overridden on the commandline +packages: +- ./ diff --git a/tests/cabal-versions b/tests/cabal-versions new file mode 100644 --- /dev/null +++ b/tests/cabal-versions @@ -0,0 +1,58 @@ +1.1.6 +1.2.1 +1.2.2.0 +1.2.3.0 +1.2.4.0 +1.4.0.0 +1.4.0.1 +1.4.0.2 +1.6.0.1 +1.6.0.2 +1.6.0.3 +1.8.0.2 +1.8.0.4 +1.8.0.6 +1.10.0.0 +1.10.1.0 +1.10.2.0 +1.12.0 +1.14.0 +1.16.0 +1.16.0.1 +1.16.0.2 +1.16.0.3 +1.18.0 +1.18.1 +1.18.1.1 +1.18.1.2 +1.18.1.3 +1.18.1.4 +1.18.1.5 +1.18.1.6 +1.18.1.7 +1.20.0.0 +1.20.0.1 +1.20.0.2 +1.20.0.3 +1.20.0.4 +1.22.0.0 +1.22.1.0 +1.22.1.1 +1.22.2.0 +1.22.3.0 +1.22.4.0 +1.22.5.0 +1.22.6.0 +1.22.7.0 +1.22.8.0 +1.24.0.0 +1.24.2.0 +2.0.0.2 +2.0.1.0 +2.0.1.1 +2.2.0.0 +2.2.0.1 +2.4.0.0 +2.4.0.1 +2.4.1.0 +3.0.0.0 diff --git a/tests/exeintlib/exeintlib.cabal b/tests/exeintlib/exeintlib.cabal --- a/tests/exeintlib/exeintlib.cabal +++ b/tests/exeintlib/exeintlib.cabal @@ -2,6 +2,7 @@ version: 0 build-type: Simple cabal-version: >=2.0 +extra-source-files: stack.yaml library exposed-modules: Lib diff --git a/tests/exeintlib/packages.list b/tests/exeintlib/packages.list new file mode 100644 --- /dev/null +++ b/tests/exeintlib/packages.list @@ -0,0 +1,1 @@ +./ diff --git a/tests/exeintlib/stack.yaml b/tests/exeintlib/stack.yaml new file mode 100644 --- /dev/null +++ b/tests/exeintlib/stack.yaml @@ -0,0 +1,3 @@ +resolver: lts-0.0 # will be overridden on the commandline +packages: +- ./ diff --git a/tests/exelib/exelib.cabal b/tests/exelib/exelib.cabal --- a/tests/exelib/exelib.cabal +++ b/tests/exelib/exelib.cabal @@ -2,6 +2,7 @@ version: 0 build-type: Simple cabal-version: >=1.10 +extra-source-files: stack.yaml library exposed-modules: Lib diff --git a/tests/exelib/packages.list b/tests/exelib/packages.list new file mode 100644 --- /dev/null +++ b/tests/exelib/packages.list @@ -0,0 +1,1 @@ +./ diff --git a/tests/exelib/stack.yaml b/tests/exelib/stack.yaml new file mode 100644 --- /dev/null +++ b/tests/exelib/stack.yaml @@ -0,0 +1,3 @@ +resolver: lts-0.0 # will be overridden on the commandline +packages: +- ./ diff --git a/tests/fliblib/fliblib.cabal b/tests/fliblib/fliblib.cabal --- a/tests/fliblib/fliblib.cabal +++ b/tests/fliblib/fliblib.cabal @@ -2,6 +2,7 @@ version: 0 build-type: Simple cabal-version: >=1.10 +extra-source-files: stack.yaml library exposed-modules: Lib diff --git a/tests/fliblib/packages.list b/tests/fliblib/packages.list new file mode 100644 --- /dev/null +++ b/tests/fliblib/packages.list @@ -0,0 +1,1 @@ +./ diff --git a/tests/fliblib/stack.yaml b/tests/fliblib/stack.yaml new file mode 100644 --- /dev/null +++ b/tests/fliblib/stack.yaml @@ -0,0 +1,3 @@ +resolver: lts-0.0 # will be overridden on the commandline +packages: +- ./ diff --git a/tests/multipkg/packages.list b/tests/multipkg/packages.list new file mode 100644 --- /dev/null +++ b/tests/multipkg/packages.list @@ -0,0 +1,4 @@ +proj/ +proj/pkg-a +proj/pkg-b +pkg-oot/ diff --git a/tests/multipkg/pkg-oot/Exe.hs b/tests/multipkg/pkg-oot/Exe.hs new file mode 100644 --- /dev/null +++ b/tests/multipkg/pkg-oot/Exe.hs @@ -0,0 +1,1 @@ +main = putStrLn "Hello World!" diff --git a/tests/multipkg/pkg-oot/Lib.hs b/tests/multipkg/pkg-oot/Lib.hs new file mode 100644 --- /dev/null +++ b/tests/multipkg/pkg-oot/Lib.hs @@ -0,0 +1,2 @@ +module Lib where +lib = () diff --git a/tests/multipkg/pkg-oot/pkg-oot.cabal b/tests/multipkg/pkg-oot/pkg-oot.cabal new file mode 100644 --- /dev/null +++ b/tests/multipkg/pkg-oot/pkg-oot.cabal @@ -0,0 +1,24 @@ +name: pkg-oot +version: 0 +build-type: Simple +cabal-version: >=1.10 + +library + exposed-modules: Lib + build-depends: base, filepath, directory + default-language: Haskell2010 + +executable pkg-oot-exe + main-is: Exe.hs + build-depends: base, pkg-oot + default-language: Haskell2010 + +test-suite pkg-oot-test + type: exitcode-stdio-1.0 + main-is: Exe.hs + build-depends: base, pkg-oot + +benchmark pkg-oot-bench + type: exitcode-stdio-1.0 + main-is: Exe.hs + build-depends: base, pkg-oot diff --git a/tests/multipkg/proj/Exe.hs b/tests/multipkg/proj/Exe.hs new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/Exe.hs @@ -0,0 +1,1 @@ +main = putStrLn "Hello World!" diff --git a/tests/multipkg/proj/Lib.hs b/tests/multipkg/proj/Lib.hs new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/Lib.hs @@ -0,0 +1,2 @@ +module Lib where +lib = () diff --git a/tests/multipkg/proj/cabal.project b/tests/multipkg/proj/cabal.project new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/cabal.project @@ -0,0 +1,1 @@ +packages: ./ ./pkg-a ./pkg-b ../pkg-oot diff --git a/tests/multipkg/proj/pkg-a/Exe.hs b/tests/multipkg/proj/pkg-a/Exe.hs new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/pkg-a/Exe.hs @@ -0,0 +1,1 @@ +main = putStrLn "Hello World!" diff --git a/tests/multipkg/proj/pkg-a/Lib.hs b/tests/multipkg/proj/pkg-a/Lib.hs new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/pkg-a/Lib.hs @@ -0,0 +1,2 @@ +module Lib where +lib = () diff --git a/tests/multipkg/proj/pkg-a/pkg-a.cabal b/tests/multipkg/proj/pkg-a/pkg-a.cabal new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/pkg-a/pkg-a.cabal @@ -0,0 +1,24 @@ +name: pkg-a +version: 0 +build-type: Simple +cabal-version: >=1.10 + +library + exposed-modules: Lib + build-depends: base, filepath, directory + default-language: Haskell2010 + +executable pkg-a-exe + main-is: Exe.hs + build-depends: base, pkg-a + default-language: Haskell2010 + +test-suite pkg-a-test + type: exitcode-stdio-1.0 + main-is: Exe.hs + build-depends: base, pkg-a + +benchmark pkg-a-bench + type: exitcode-stdio-1.0 + main-is: Exe.hs + build-depends: base, pkg-a diff --git a/tests/multipkg/proj/pkg-b/Exe.hs b/tests/multipkg/proj/pkg-b/Exe.hs new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/pkg-b/Exe.hs @@ -0,0 +1,1 @@ +main = putStrLn "Hello World!" diff --git a/tests/multipkg/proj/pkg-b/Lib.hs b/tests/multipkg/proj/pkg-b/Lib.hs new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/pkg-b/Lib.hs @@ -0,0 +1,2 @@ +module Lib where +lib = () diff --git a/tests/multipkg/proj/pkg-b/pkg-b.cabal b/tests/multipkg/proj/pkg-b/pkg-b.cabal new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/pkg-b/pkg-b.cabal @@ -0,0 +1,24 @@ +name: pkg-b +version: 0 +build-type: Simple +cabal-version: >=1.10 + +library + exposed-modules: Lib + build-depends: base, filepath, directory + default-language: Haskell2010 + +executable pkg-b-exe + main-is: Exe.hs + build-depends: base, pkg-b + default-language: Haskell2010 + +test-suite pkg-b-test + type: exitcode-stdio-1.0 + main-is: Exe.hs + build-depends: base, pkg-b + +benchmark pkg-b-bench + type: exitcode-stdio-1.0 + main-is: Exe.hs + build-depends: base, pkg-b diff --git a/tests/multipkg/proj/proj.cabal b/tests/multipkg/proj/proj.cabal new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/proj.cabal @@ -0,0 +1,25 @@ +name: proj +version: 0 +build-type: Simple +cabal-version: >=1.10 +extra-source-files: stack.yaml + +library + exposed-modules: Lib + build-depends: base, filepath, directory ,pkg-a,pkg-b,pkg-oot + default-language: Haskell2010 + +executable proj-exe + main-is: Exe.hs + build-depends: base, proj ,pkg-a,pkg-b,pkg-oot + default-language: Haskell2010 + +test-suite proj-test + type: exitcode-stdio-1.0 + main-is: Exe.hs + build-depends: base, proj ,pkg-a,pkg-b,pkg-oot + +benchmark proj-bench + type: exitcode-stdio-1.0 + main-is: Exe.hs + build-depends: base, proj ,pkg-a,pkg-b,pkg-oot diff --git a/tests/multipkg/proj/stack.yaml b/tests/multipkg/proj/stack.yaml new file mode 100644 --- /dev/null +++ b/tests/multipkg/proj/stack.yaml @@ -0,0 +1,6 @@ +resolver: lts-0.0 # will be overridden on the commandline +packages: +- ./ +- ./pkg-a +- ./pkg-b +- ../pkg-oot diff --git a/tests/stack-resolvers b/tests/stack-resolvers new file mode 100644 --- /dev/null +++ b/tests/stack-resolvers @@ -0,0 +1,15 @@ +8.6.5 lts-14.18 +8.6.5 lts-13.30 +8.4.4 lts-12.26 +8.2.2 lts-11.22 +8.2.2 lts-10.10 +8.0.2 lts-9.21 +8.0.2 lts-8.24 +8.0.1 lts-7.24 +7.10.3 lts-6.35 +7.10.3 lts-5.18 +7.10.3 lts-4.2 +7.10.2 lts-3.22 +7.8.4 lts-2.22 +7.8.4 lts-1.15 +7.8.3 lts-0.7