From b096386ac90186d7557ff9fae01f54d5381cef49 Mon Sep 17 00:00:00 2001 From: Julien Moutinho Date: Tue, 13 Nov 2018 01:53:34 +0000 Subject: [PATCH 1/1] init --- .gitignore | 11 + COPYING | 674 ++++++++++++++++++++++++++++++++ HLint.hs | 1 + Language/HLint.hs | 1 + Language/Symantic/CLI.hs | 4 + Language/Symantic/CLI/Fixity.hs | 91 +++++ Language/Symantic/CLI/HLint.hs | 1 + Language/Symantic/CLI/Help.hs | 223 +++++++++++ Language/Symantic/CLI/Plain.hs | 214 ++++++++++ Language/Symantic/CLI/Read.hs | 163 ++++++++ Language/Symantic/CLI/Sym.hs | 135 +++++++ Language/Symantic/CLI/Test.hs | 217 ++++++++++ Language/Symantic/HLint.hs | 1 + stack.yaml | 6 + symantic-cli.cabal | 61 +++ test/Golden.hs | 72 ++++ test/Golden/.gitattributes | 1 + test/HLint.hs | 1 + test/Main.hs | 15 + 19 files changed, 1892 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 120000 HLint.hs create mode 120000 Language/HLint.hs create mode 100644 Language/Symantic/CLI.hs create mode 100644 Language/Symantic/CLI/Fixity.hs create mode 120000 Language/Symantic/CLI/HLint.hs create mode 100644 Language/Symantic/CLI/Help.hs create mode 100644 Language/Symantic/CLI/Plain.hs create mode 100644 Language/Symantic/CLI/Read.hs create mode 100644 Language/Symantic/CLI/Sym.hs create mode 100644 Language/Symantic/CLI/Test.hs create mode 120000 Language/Symantic/HLint.hs create mode 100644 stack.yaml create mode 100644 symantic-cli.cabal create mode 100644 test/Golden.hs create mode 100644 test/Golden/.gitattributes create mode 120000 test/HLint.hs create mode 100644 test/Main.hs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bf52384 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +*.hi +*.html +*.o +.cabal-sandbox/ +.stack-work/ +bug/ +cabal.sandbox.config +dist/ +hlint.html +old/ +stats/ diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/HLint.hs b/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/Language/HLint.hs b/Language/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/Language/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/Language/Symantic/CLI.hs b/Language/Symantic/CLI.hs new file mode 100644 index 0000000..23bac21 --- /dev/null +++ b/Language/Symantic/CLI.hs @@ -0,0 +1,4 @@ +module Language.Symantic.CLI + ( module Language.Symantic.CLI.Sym + ) where +import Language.Symantic.CLI.Sym diff --git a/Language/Symantic/CLI/Fixity.hs b/Language/Symantic/CLI/Fixity.hs new file mode 100644 index 0000000..2569da4 --- /dev/null +++ b/Language/Symantic/CLI/Fixity.hs @@ -0,0 +1,91 @@ +module Language.Symantic.CLI.Fixity where + +import Data.Bool +import Data.Eq (Eq(..)) +import Data.Function ((.)) +import Data.Int (Int) +import Data.Maybe (Maybe(..)) +import Data.Ord (Ord(..)) +import Text.Show (Show(..)) +import qualified Data.Bool as Bool + +-- * Type 'Fixity' +data Fixity + = Fixity1 Unifix + | Fixity2 Infix + deriving (Eq, Show) + +-- ** Type 'Unifix' +data Unifix + = Prefix { unifix_prece :: Precedence } + | Postfix { unifix_prece :: Precedence } + deriving (Eq, Show) + +-- ** Type 'Infix' +data Infix + = Infix + { infix_assoc :: Maybe Associativity + , infix_prece :: Precedence + } deriving (Eq, Show) + +infixL :: Precedence -> Infix +infixL = Infix (Just AssocL) + +infixR :: Precedence -> Infix +infixR = Infix (Just AssocR) + +infixB :: Side -> Precedence -> Infix +infixB = Infix . Just . AssocB + +infixN :: Precedence -> Infix +infixN = Infix Nothing + +infixN0 :: Infix +infixN0 = infixN 0 + +infixN5 :: Infix +infixN5 = infixN 5 + +-- | Given 'Precedence' and 'Associativity' of its parent operator, +-- and the operand 'Side' it is in, +-- return whether an 'Infix' operator +-- needs to be enclosed by parenthesis. +needsParenInfix :: (Infix, Side) -> Infix -> Bool +needsParenInfix (po, lr) op = + infix_prece op < infix_prece po + || infix_prece op == infix_prece po + && Bool.not associate + where + associate = + case (lr, infix_assoc po) of + (_, Just AssocB{}) -> True + (SideL, Just AssocL) -> True + (SideR, Just AssocR) -> True + _ -> False + +-- * Type 'Precedence' +type Precedence = Int + +-- ** Class 'PrecedenceOf' +class PrecedenceOf a where + precedence :: a -> Precedence +instance PrecedenceOf Fixity where + precedence (Fixity1 uni) = precedence uni + precedence (Fixity2 inf) = precedence inf +instance PrecedenceOf Unifix where + precedence = unifix_prece +instance PrecedenceOf Infix where + precedence = infix_prece + +-- * Type 'Associativity' +data Associativity + = AssocL -- ^ Associate to the left: @a ¹ b ² c == (a ¹ b) ² c@ + | AssocR -- ^ Associate to the right: @a ¹ b ² c == a ¹ (b ² c)@ + | AssocB Side -- ^ Associate to both sides, but to 'Side' when reading. + deriving (Eq, Show) + +-- ** Type 'Side' +data Side + = SideL -- ^ Left + | SideR -- ^ Right + deriving (Eq, Show) diff --git a/Language/Symantic/CLI/HLint.hs b/Language/Symantic/CLI/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/Language/Symantic/CLI/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/Language/Symantic/CLI/Help.hs b/Language/Symantic/CLI/Help.hs new file mode 100644 index 0000000..778b8a9 --- /dev/null +++ b/Language/Symantic/CLI/Help.hs @@ -0,0 +1,223 @@ +{-# LANGUAGE OverloadedStrings #-} +module Language.Symantic.CLI.Help where + +import Control.Applicative (Applicative(..)) +import Data.Bool +import Data.Function (($), (.)) +import Data.Functor ((<$>)) +import Data.Functor.Compose (Compose(..)) +import Data.Maybe (Maybe(..), maybeToList, maybe) +import Data.Monoid (Monoid(..)) +import Data.Semigroup (Semigroup(..)) +import qualified Language.Symantic.Document.Term as Doc +import Data.Tree as Tree + +import Language.Symantic.CLI.Sym +import qualified Language.Symantic.CLI.Plain as Plain + +-- * Type 'Reader' +data Reader d + = Reader + { reader_help :: Maybe d + , reader_command_indent :: Doc.Indent + , reader_option_indent :: Doc.Indent + , reader_plain :: Plain.Reader d + , reader_option_empty :: Bool + } + +defReader :: Doc.Textable d => Reader d +defReader = Reader + { reader_help = Nothing + , reader_command_indent = 2 + , reader_option_indent = 15 + , reader_plain = Plain.defReader + , reader_option_empty = False + } + +-- * Type 'Result' +type Result d = Tree.Forest (DocNode d) + +defResult :: Monoid d => Result d +defResult = mempty + +-- ** Type 'DocNode' +data DocNode d + = Leaf + { docNodeSep :: d + , docNode :: d + } + | Indented + { docNodeIndent :: Doc.Indent + , docNodeSep :: d + , docNode :: d + } + | BreakableFill + { docNodeIndent :: Doc.Indent + , docNodeSep :: d + , docNode :: d + } + +docTree :: + Monoid d => + Doc.Textable d => + Doc.Indentable d => + Tree (DocNode d) -> d +docTree (Tree.Node n []) = docNode n +docTree (Tree.Node n ts) = + case n of + Leaf{} -> docNode n + Indented ind _sep d -> d <> Doc.incrIndent ind (Doc.newline <> docTrees ts) + BreakableFill ind _sep d -> Doc.breakableFill ind d <> (Doc.align $ docTrees ts) + +docTrees :: + Monoid d => + Doc.Textable d => + Doc.Indentable d => + Tree.Forest (DocNode d) -> d +docTrees [] = Doc.empty +docTrees [t] = docTree t +docTrees (t0:ts) = + docTree t0 <> mconcat ((\t@(Tree.Node n _ns) -> docNodeSep n <> docTree t) <$> ts) + +-- * Type 'Help' +data Help d e t a + = Help + { help_result :: Reader d -> Result d + , help_plain :: Plain.Plain d e t a + } + +runHelp :: Monoid d => Doc.Indentable d => Doc.Textable d => Help d e t a -> d +runHelp h = docTrees $ help_result h defReader + +textHelp :: Plain.Doc d => Reader d -> Help d e t a -> d +textHelp def (Help h _p) = docTrees $ h def + +coerceHelp :: Help d e s a -> Help d e t b +coerceHelp Help{help_plain, ..} = Help + { help_plain = Plain.coercePlain help_plain + , .. + } + +instance Doc.Textable d => Semigroup (Help d e s a) where + Help hx px <> Help hy py = Help (hx<>hy) (px<>py) +instance (Doc.Textable d, Monoid d) => Monoid (Help d e s a) where + mempty = Help mempty mempty + mappend = (<>) +{- +instance (Semigroup d, IsString d) => IsString (Help d e s a) where + fromString "" = Help $ \_ro -> Nothing + fromString s = Help $ \_ro -> Just $ fromString s +instance Show (Help Doc.Term e s a) where + show = TL.unpack . Doc.textTerm . textHelp +-} +instance Plain.Doc d => Sym_Fun (Help d) where + f <$$> Help h p = Help h (f<$$>p) +instance Plain.Doc d => Sym_App (Help d) where + value a = Help mempty (value a) + end = Help mempty end + Help hf pf <**> Help hx px = Help (hf<>hx) (pf<**>px) +instance Plain.Doc d => Sym_Alt (Help d) where + Help hl pl <||> Help hr pr = Help (hl<>hr) (pl<||>pr) + try (Help h p) = Help h (try p) + choice hs = Help (mconcat $ help_result <$> hs) (choice (help_plain <$> hs)) + option a (Help h p) = Help h (option a p) +instance Plain.Doc d => Sym_AltApp (Help d) where + many (Help h p) = Help h (many p) + some (Help h p) = Help h (many p) +-- * Type 'PermHelp' +data PermHelp d e t a + = PermHelp (Reader d -> Result d) + [Plain.Plain d e t a] +type instance Perm (Help d e t) = PermHelp d e t +instance Plain.Doc d => Sym_Interleaved (Help d) where + interleaved (PermHelp h ps) = Help h $ interleaved $ Compose ps + f <<$>> Help h p = PermHelp h $ getCompose $ f<<$>>p + f <<$?>> (a, Help h p) = PermHelp h $ getCompose $ f<<$?>>(a,p) + f <<$*>> Help h p = PermHelp h $ getCompose $ f<<$*>>p + PermHelp hl pl <<|>> Help hr pr = PermHelp (hl<>hr) $ getCompose $ Compose pl<<|>>pr + PermHelp hl pl <<|?>> (a, Help hr pr) = PermHelp (hl<>hr) $ getCompose $ Compose pl<<|?>>(a,pr) + PermHelp hl pl <<|*>> Help hr pr = PermHelp (hl<>hr) $ getCompose $ Compose pl<<|*>>pr +instance Plain.Doc d => Sym_Rule (Help d) where + rule n (Help h p) = + Help (\ro -> + pure $ + Tree.Node (Indented + (reader_command_indent ro) + (Doc.newline <> Doc.newline) $ + ref<>" ::= "<>Plain.runPlain p' (reader_plain ro)) $ + maybeToList (pure . Leaf Doc.empty <$> reader_help ro) <> + h ro{reader_help=Nothing} + ) p' + where + p' = rule n p + ref = + Doc.bold $ + Doc.between (Doc.charH '<') (Doc.charH '>') $ + Doc.magentaer $ + Doc.stringH n +instance Plain.Doc d => Sym_Option (Help d) where + var n f = Help mempty (var n f) + tag n = Help mempty (tag n) + opt n (Help _h p) = + Help (\ro -> + case reader_help ro of + Nothing -> + if reader_option_empty ro + then + pure $ pure $ Leaf Doc.newline $ Doc.bold $ + Plain.runPlain p' (reader_plain ro) + else [] + Just msg -> + pure $ + Tree.Node + (BreakableFill + (reader_option_indent ro) + Doc.newline + (Doc.bold $ Plain.runPlain p' (reader_plain ro) <> Doc.space)) $ + pure $ pure $ Leaf Doc.empty msg + ) p' + where p' = opt n p +instance Plain.Doc d => Sym_Help d (Help d) where + help msg (Help h p) = Help + (\ro -> h ro{reader_help=Just msg}) + (Language.Symantic.CLI.Sym.help msg p) +instance Plain.Doc d => Sym_Command (Help d) where + main n (Help h p) = + Help (\ro -> + pure $ + Tree.Node (Indented 0 + (Doc.newline <> Doc.newline) $ + Plain.runPlain p' (reader_plain ro) <> + maybe Doc.empty + (\d -> Doc.newline <> Doc.newline <> d <> Doc.newline) + (reader_help ro) + ) $ + h ro{reader_help=Nothing} + ) p' + where p' = main n p + command n (Help h p) = + Help (\ro -> + pure $ + Tree.Node + (Indented + (reader_command_indent ro) + (Doc.newline <> Doc.newline) $ + ref<>" ::= " <> + Plain.runPlain p' (reader_plain ro) <> + maybe Doc.empty + ( (<> Doc.newline) + . Doc.incrIndent (reader_command_indent ro) + . (Doc.newline <>) ) + (reader_help ro) + ) $ + h ro{reader_help=Nothing} + ) p' + where + p' = command n p + ref = + Doc.bold $ + Doc.between (Doc.charH '<') (Doc.charH '>') $ + Doc.magentaer $ + Doc.stringH n +instance Plain.Doc d => Sym_Exit (Help d) where + exit e = Help mempty $ exit e diff --git a/Language/Symantic/CLI/Plain.hs b/Language/Symantic/CLI/Plain.hs new file mode 100644 index 0000000..981c251 --- /dev/null +++ b/Language/Symantic/CLI/Plain.hs @@ -0,0 +1,214 @@ +{-# LANGUAGE OverloadedStrings #-} +module Language.Symantic.CLI.Plain where + +import Data.Bool +import Data.Function (($), (.)) +import Data.Functor ((<$>)) +import Data.Functor.Compose (Compose(..)) +import Data.Maybe (Maybe(..), fromMaybe, catMaybes) +import Data.Monoid (Monoid(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String, IsString(..)) +import Text.Show (Show(..)) +import qualified Data.Text.Lazy as TL +import qualified Language.Symantic.Document.Term as Doc +import qualified Language.Symantic.Document.Term.IO as DocIO + +import Language.Symantic.CLI.Sym +import Language.Symantic.CLI.Fixity + +-- * Class 'Doc' +class + ( IsString d + , Semigroup d + , Monoid d + , Doc.Textable d + , Doc.Indentable d + , Doc.Breakable d + , Doc.Colorable d + , Doc.Decorable d + ) => + Doc d +instance Doc Doc.Term +instance Doc DocIO.TermIO + +words :: Doc.Textable d => Doc.Breakable d => String -> d +words m = Doc.breakableSpaces $ Doc.string <$> Doc.words m + +-- * Type 'Reader' +-- | Constructed top-down +data Reader d + = Reader + { reader_op :: (Infix, Side) -- ^ Parent operator. + , reader_define :: Bool -- ^ Whether to print a definition, or not. + , reader_or :: d + } + +defReader :: Doc.Textable d => Reader d +defReader = Reader + { reader_op = (infixN0, SideL) + , reader_define = True + , reader_or = Doc.stringH " | " + } + +pairIfNeeded :: Doc d => Reader d -> Infix -> d -> d +pairIfNeeded Reader{..} op d = + if needsParenInfix reader_op op + then Doc.align $ Doc.between (Doc.charH '(') (Doc.charH ')') d + else d + +-- * Type 'Plain' +newtype Plain d e t a + = Plain { unPlain :: Reader d -> Maybe d } + +runPlain :: Monoid d => Plain d e t a -> Reader d -> d +runPlain (Plain p) = fromMaybe mempty . p + +coercePlain :: Plain d e t a -> Plain d e u b +coercePlain Plain{..} = Plain{..} + +textPlain :: Monoid d => Doc.Textable d => Plain d e t a -> d +textPlain p = runPlain p defReader + +instance Semigroup d => Semigroup (Plain d e t a) where + Plain x <> Plain y = Plain $ x <> y +instance (Semigroup d, Monoid d) => Monoid (Plain d e t a) where + mempty = Plain mempty + mappend = (<>) +instance (Semigroup d, IsString d) => IsString (Plain d e t a) where + fromString "" = Plain $ \_ro -> Nothing + fromString s = Plain $ \_ro -> Just $ fromString s +instance Show (Plain Doc.Term e t a) where + show = TL.unpack . Doc.textTerm . textPlain +instance Doc d => Sym_Fun (Plain d) where + _f <$$> Plain x = Plain $ \ro -> + pairIfNeeded ro op <$> + x ro{reader_op=(op, SideR)} + where + op = infixB SideL 10 +instance Doc d => Sym_App (Plain d) where + value _ = Plain $ \_ro -> Nothing + end = Plain $ \_ro -> Nothing + Plain f <**> Plain x = Plain $ \ro -> + case (f ro{reader_op=(op, SideL)}, x ro{reader_op=(op, SideR)}) of + (Nothing, Nothing) -> Nothing + (Just f', Nothing) -> Just f' + (Nothing, Just x') -> Just x' + (Just f', Just x') -> Just $ pairIfNeeded ro op $ f' <> Doc.space <> x' + where + op = infixB SideL 10 +instance Doc d => Sym_Alt (Plain d) where + lp <||> rp = Plain $ \ro -> + Just $ + if needsParenInfix (reader_op ro) op + then + Doc.ifBreak + (Doc.align $ + Doc.between (Doc.charH '(') (Doc.charH ')') $ + Doc.space <> + runPlain lp ro{reader_op=(op, SideL), reader_or=Doc.newline<>Doc.charH '|'<>Doc.space} <> + Doc.newline <> + Doc.stringH "| " <> + runPlain rp ro{reader_op=(op, SideR), reader_or=Doc.newline<>Doc.charH '|'<>Doc.space} <> + Doc.newline) + (Doc.between (Doc.charH '(') (Doc.charH ')') $ + Doc.withBreakable Nothing $ + runPlain lp ro{reader_op=(op, SideL), reader_or=Doc.stringH " | "} <> + Doc.stringH " | " <> + runPlain rp ro{reader_op=(op, SideR), reader_or=Doc.stringH " | "}) + else + runPlain lp ro{reader_op=(op, SideL)} <> + reader_or ro <> + runPlain rp ro{reader_op=(op, SideR)} + where op = infixB SideL 2 + try p = p + choice [] = "" + choice [p] = p + choice l@(_:_) = Plain $ \ro -> Just $ + pairIfNeeded ro op $ + Doc.foldWith ("\n| " <>) $ + (($ ro{reader_op=(op, SideL)}) . runPlain) <$> l + where op = infixB SideL 2 + option _a p = Plain $ \ro -> Just $ + if needsParenInfix (reader_op ro) op + then + Doc.ifBreak + (Doc.align $ + Doc.between (Doc.charH '[') (Doc.charH ']') $ + Doc.space <> + runPlain p ro{reader_op=(op, SideL)} <> + Doc.newline) + (Doc.between (Doc.charH '[') (Doc.charH ']') $ + Doc.withBreakable Nothing $ + runPlain p ro{reader_op=(op, SideL), reader_or=Doc.stringH " | "}) + else + runPlain p ro{reader_op=(op, SideL)} + where op = infixN0 +instance Doc d => Sym_AltApp (Plain d) where + many p = Plain $ \ro -> Just $ + runPlain p ro{reader_op=(op, SideL)}<>"*" + where op = infixN 10 + some p = Plain $ \ro -> Just $ + runPlain p ro{reader_op=(op, SideL)}<>"+" + where op = infixN 10 +type instance Perm (Plain d e t) = Compose [] (Plain d e t) +instance Doc d => Sym_Interleaved (Plain d) where + interleaved (Compose []) = "" + interleaved (Compose [Plain p]) = Plain p + interleaved (Compose l@(_:_)) = Plain $ \ro -> Just $ + -- pairIfNeeded ro op $ + Doc.align $ + Doc.foldWith Doc.breakableSpace $ + catMaybes $ + (\(Plain p) -> + p ro + { reader_op=(op, SideL) + , reader_or=Doc.stringH " | " } + ) <$> l + where op = infixN 10 + _f <<$>> Plain p = Compose [Plain p] + _f <<$?>> (_, Plain p) = Compose [coercePlain $ optional $ Plain p] + _f <<$*>> Plain p = Compose [coercePlain $ many $ Plain p] + Compose ws <<|>> Plain p = Compose $ coercePlain <$> ws <> [Plain p] + Compose ws <<|?>> (_, Plain p) = Compose $ coercePlain <$> ws <> [coercePlain $ optional $ Plain p] + Compose ws <<|*>> Plain p = Compose $ coercePlain <$> ws <> [coercePlain $ many $ Plain p] +instance Doc d => Sym_Rule (Plain d) where + rule n p = Plain $ \ro -> Just $ + if reader_define ro + then runPlain p ro{reader_define=False} + else ref + where + ref = + Doc.bold $ + Doc.between (Doc.charH '<') (Doc.charH '>') $ + Doc.magentaer $ + Doc.stringH n +instance Doc d => Sym_Option (Plain d) where + var n _f = Plain $ \_ro -> Just $ Doc.between (Doc.charH '<') (Doc.charH '>') (Doc.string n) + tag = fromString + opt n r = Plain $ \ro -> + unPlain (prefix n <**> coercePlain r) ro + where + prefix = \case + OptionName s l -> prefix (OptionNameShort s)<>"|"<>prefix (OptionNameLong l) + OptionNameShort s -> fromString ['-', s] + OptionNameLong l -> fromString ("--"<>l) +instance Doc d => Sym_Command (Plain d) where + main n r = Plain $ \ro -> Just $ + if reader_define ro + then + runPlain + (fromString n <**> coercePlain r) + ro{reader_define = False} + else ref + where + ref = + Doc.bold $ + Doc.between (Doc.charH '<') (Doc.charH '>') $ + Doc.magentaer $ + Doc.stringH n + command = main +instance Doc d => Sym_Help d (Plain d) where + help _msg p = p +instance Doc d => Sym_Exit (Plain d) where + exit _ = Plain $ \_ro -> Nothing diff --git a/Language/Symantic/CLI/Read.hs b/Language/Symantic/CLI/Read.hs new file mode 100644 index 0000000..e3c15d9 --- /dev/null +++ b/Language/Symantic/CLI/Read.hs @@ -0,0 +1,163 @@ +{-# LANGUAGE DeriveFunctor #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +module Language.Symantic.CLI.Read where + +import Control.Applicative (Applicative(..), Alternative(..)) +import Control.Arrow ((***)) +import Control.Monad (Monad(..), MonadPlus(..)) +import Data.Bool +import Data.Either (Either(..)) +import Data.Eq (Eq(..)) +import Data.Foldable (Foldable(..)) +import Data.Function (($), (.)) +import Data.Functor (Functor(..), (<$>)) +import Data.Maybe (Maybe(..)) +import Data.Monoid (Monoid(..)) +import Data.Ord (Ord(..), Ordering(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String) +import Text.Show (Show(..)) +import qualified Data.List as List +import qualified Data.Set as Set +import qualified Text.Megaparsec as P +import qualified Text.Megaparsec.Perm as P + +import Language.Symantic.CLI.Sym as Sym + +-- * Type 'Arg' +newtype Arg = Arg { unArg :: String } + deriving (Eq, Ord, Show) + +-- * Type 'Args' +newtype Args = Args { unArgs :: [Arg] } + deriving (Eq, Ord, Show, Semigroup, Monoid) +instance P.Stream Args where + type Token Args = Arg + type Tokens Args = Args + tokenToChunk _s = Args . pure + tokensToChunk _s = Args + chunkToTokens _s = unArgs + chunkLength _s = List.length . unArgs + chunkEmpty _s = List.null . unArgs + advance1 _s _ind (P.SourcePos n l c) _ = P.SourcePos n l (c <> P.pos1) + advanceN s ind pos = foldl' (P.advance1 s ind) pos . unArgs + take1_ as = + case unArgs as of + [] -> Nothing + t:ts -> Just (t, Args ts) + takeN_ n as | n <= 0 = Just (Args [], as) + | null (unArgs as) = Nothing + | otherwise = Just $ (Args *** Args) $ List.splitAt n $ unArgs as + takeWhile_ f = (Args *** Args) . List.span f . unArgs +instance P.ShowToken Arg where + showTokens toks = + List.intercalate ", " $ toList $ showArg <$> toks + where + showArg :: Arg -> String + showArg (Arg a@('-':_)) = a + showArg (Arg a) = "\""<>a<>"\"" + +-- * Type 'Parser' +newtype Parser e s a + = Parser { unParser :: P.Parsec (ErrorRead e) Args a } + deriving (Functor, Applicative, Alternative, Monad, MonadPlus, P.MonadParsec (ErrorRead e) Args) + +coerceParser :: Parser e s a -> Parser e t a +coerceParser = Parser . unParser + +instance Sym_Fun Parser where + f <$$> Parser a = Parser $ f <$> a +instance Sym_App Parser where + value = Parser . pure + end = Parser P.eof + Parser f <**> Parser a = Parser $ f <*> a +instance Sym_Alt Parser where + (<||>) = (P.<|>) + optional = P.optional + option = P.option + choice = P.choice + try = P.try +instance Sym_AltApp Parser where + many = P.many + some = P.some +type instance Perm (Parser e s) = P.PermParser Args (Parser e s) +instance Sym_Interleaved Parser where + interleaved = P.makePermParser + (<<$>>) = (P.<$$>) + (<<|>>) = (P.<||>) + (<<$?>>) = (P.<$?>) + (<<|?>>) = (P.<|?>) + f <<$*>> a = f P.<$?> ([],P.some a) + f <<|*>> a = f P.<|?> ([],P.some a) +instance Sym_Command Parser where + main = command + command n p = P.token check (Just expected) *> coerceParser p + where + expected = Arg n + check a | a == expected = Right () + check t = Left + ( Just $ P.Tokens $ pure t + , Set.singleton $ P.Tokens $ pure expected ) +instance Sym_Option Parser where + var n f = do + let check = Right + let expected | List.null n = Arg "" + | otherwise = Arg $ "<"<>n<>">" + Arg arg <- P.token check (Just expected) + case f arg of + Right a -> return a + Left err -> P.customFailure $ ErrorRead err + tag n = do + let expected = Arg n + let check t | t == expected = Right () + | otherwise = Left ( Just $ P.Tokens $ pure t + , Set.singleton $ P.Tokens $ pure expected ) + P.token check (Just expected) + opt n p = + (*> coerceParser p) $ + case n of + OptionNameLong l -> + P.token (checkLong l) (Just $ expectedLong l) + OptionNameShort s -> + P.token (checkShort s) (Just $ expectedShort s) + OptionName s l -> + P.token (checkShort s) (Just $ expectedShort s) <|> + P.token (checkLong l) (Just $ expectedLong l) + where + expectedShort s = Arg ['-', s] + checkShort s a | a == expectedShort s = Right () + checkShort s t = Left + ( Just $ P.Tokens $ pure t + , Set.singleton $ P.Tokens $ pure $ expectedShort s) + expectedLong l = Arg $ "--"<>l + checkLong l a | a == expectedLong l = Right () + checkLong l t = Left + ( Just $ P.Tokens $ pure t + , Set.singleton $ P.Tokens $ pure $ expectedLong l) +instance Sym_Help d Parser where + help _msg p = p +instance Sym_Rule Parser where + rule _n = coerceParser +instance Sym_Exit Parser where + exit e = + Parser $ + P.fancyFailure $ Set.singleton $ + P.ErrorCustom $ ErrorRead e + +-- * Type 'ErrorRead' +newtype ErrorRead e + = ErrorRead e + deriving (Functor) +instance Show e => Show (ErrorRead e) where + showsPrec p (ErrorRead e) = showsPrec p e +instance Eq (ErrorRead a) where + _==_ = True +instance Ord (ErrorRead a) where + _`compare`_ = EQ +instance Show e => P.ShowErrorComponent (ErrorRead e) where + showErrorComponent = show + +readArgs :: Parser e s a -> Args -> Either (P.ParseError (P.Token Args) (ErrorRead e)) a +readArgs p = P.runParser (unParser $ p <* end) "" diff --git a/Language/Symantic/CLI/Sym.hs b/Language/Symantic/CLI/Sym.hs new file mode 100644 index 0000000..dab3b58 --- /dev/null +++ b/Language/Symantic/CLI/Sym.hs @@ -0,0 +1,135 @@ +{-# LANGUAGE TypeFamilyDependencies #-} +module Language.Symantic.CLI.Sym where + +import Data.Bool +import Data.Char (Char) +import Data.Either (Either(..)) +import Data.Eq (Eq) +import Data.Function (($), (.), const, id) +import Data.Functor ((<$>)) +import Data.Maybe (Maybe(..), catMaybes) +import Data.Ord (Ord(..)) +import Data.String (String) +import Text.Show (Show) + +-- * @Arg@ types +-- | Types to type the symantics: +-- eg. to segregate options from commands. +data ArgCommand +data ArgOption +data ArgValue +data ArgRule t + +-- * Type 'Name' +type Name = String + +-- * Class 'Sym_Fun' +class Sym_Fun repr where + (<$$>) :: (a -> b) -> repr e t a -> repr e t b + (<$$) :: a -> repr e t b -> repr e t a + (<$$) = (<$$>) . const + ($$>) :: repr e t b -> a -> repr e t a + r $$> a = const a <$$> r +-- * Class 'Sym_App' +class Sym_Fun repr => Sym_App repr where + value :: a -> repr e ArgValue a + (<**>) :: repr e t (a -> b) -> repr e u a -> repr e u b + (**>) :: repr e t a -> repr e u b -> repr e u b + a **> b = id <$$ a <**> b + (<**) :: repr e t a -> repr e u b -> repr e u a + a <** b = const <$$> a <**> b + end :: repr e t () +-- * Class 'Sym_Alt' +class Sym_Fun repr => Sym_Alt repr where + (<||>) :: repr e t a -> repr e t a -> repr e t a + choice :: [repr e t a] -> repr e t a + optional :: repr e t a -> repr e t (Maybe a) + optional a = option Nothing (Just <$$> a) + option :: a -> repr e t a -> repr e t a + try :: repr e t a -> repr e t a +-- * Class 'Sym_AltApp' +class (Sym_Alt repr, Sym_App repr) => Sym_AltApp repr where + many :: repr e t a -> repr e t [a] + some :: repr e t a -> repr e t [a] + -- default intermany :: (Sym_Alt repr, Sym_App repr) => [repr e t a] -> repr e t [a] + intermany :: [repr e t a] -> repr e t [a] + intermany = many . choice . (try <$>) +-- * Class 'Sym_Interleaved' +class Sym_Interleaved repr where + interleaved :: Perm (repr e t) a -> repr e t a + (<<$>>) :: (a -> b) -> repr e t a -> Perm (repr e t) b + (<<$?>>) :: (a -> b) -> (a, repr e t a) -> Perm (repr e t) b + (<<$*>>) :: ([a] -> b) -> repr e t a -> Perm (repr e t) b + (<<|>>) :: Perm (repr e t) (a -> b) -> repr e t a -> Perm (repr e t) b + (<<|?>>) :: Perm (repr e t) (a -> b) -> (a, repr e t a) -> Perm (repr e t) b + (<<|*>>) :: Perm (repr e t) ([a] -> b) -> repr e t a -> Perm (repr e t) b + + (<<$) :: a -> repr e t b -> Perm (repr e t) a + (<<$) = (<<$>>) . const + (<<$?) :: a -> (b, repr e t b) -> Perm (repr e t) a + a <<$? b = const a <<$?>> b + {- NOTE: cannot be done without and instance: + - Functor (P.PermParser s m) + (<<|) :: Functor (Perm (repr e t)) => Perm (repr e t) a -> repr e t b -> Perm (repr e t) a + (<<|?) :: Functor (Perm (repr e t)) => Perm (repr e t) a -> (b, repr e t b) -> Perm (repr e t) a + a <<| b = (const <$> a) <<|>> b + a <<|? b = (const <$> a) <<|?>> b + -} +infixl 4 <$$> +infixl 4 <**> +infixl 3 <||> +infixl 2 <<$>>, <<$?>>, <<$*>> +infixl 1 <<|>>, <<|?>>, <<|*>> +-- ** Type family 'Perm' +type family Perm (repr:: * -> *) = (r :: * -> *) | r -> repr +-- * Class 'Sym_Rule' +class Sym_Rule repr where + rule :: String -> repr e t a -> repr e t a + -- rule _n = id +-- * Class 'Sym_Command' +class Sym_Command repr where + main :: Name -> repr e t a -> repr e ArgCommand a + command :: Name -> repr e t a -> repr e ArgCommand a +-- * Class 'Sym_Option' +class Sym_AltApp repr => Sym_Option repr where + opt :: OptionName -> repr e s a -> repr e ArgOption a + var :: Name -> (String -> Either e a) -> repr e ArgValue a + tag :: String -> repr e ArgValue () + -- int :: repr e ArgValue Int + + long :: Name -> repr e ArgValue a -> repr e ArgOption a + short :: Char -> repr e ArgValue a -> repr e ArgOption a + flag :: OptionName -> (Bool, repr e ArgOption Bool) + endOpt :: repr e ArgOption () + string :: Name -> repr e ArgValue String + long = opt . OptionNameLong + short = opt . OptionNameShort + flag n = (False,) $ opt n $ value True + endOpt = option () $ opt (OptionNameLong "") $ value () + string n = var n Right +-- ** Type 'OptionName' +data OptionName + = OptionName Char Name + | OptionNameLong Name + | OptionNameShort Char + deriving (Eq, Show) +instance Ord OptionName where + x`compare`y = + catMaybes [longOf x, shortOf x] + `compare` + catMaybes [longOf y, shortOf y] + where + longOf = \case + OptionName _s l -> Just l + OptionNameLong l -> Just l + OptionNameShort _s -> Nothing + shortOf = \case + OptionName s _l -> Just [s] + OptionNameLong _l -> Nothing + OptionNameShort s -> Just [s] +-- * Class 'Sym_Help' +class Sym_Help d repr where + help :: d -> repr e t a -> repr e t a +-- * Class 'Sym_Exit' +class Sym_Exit repr where + exit :: e -> repr e t () diff --git a/Language/Symantic/CLI/Test.hs b/Language/Symantic/CLI/Test.hs new file mode 100644 index 0000000..921a267 --- /dev/null +++ b/Language/Symantic/CLI/Test.hs @@ -0,0 +1,217 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TypeApplications #-} +module Language.Symantic.CLI.Test where + +-- import Data.Monoid (Monoid(..)) +-- import Data.Ord (Ord(..)) +-- import Text.Show (Show(..)) +import Control.Monad (Monad(..)) +import Data.Bool +import Data.Either (Either(..)) +import Data.Function (($)) +import Data.Functor ((<$>)) +import Data.Maybe (Maybe(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String) +import Data.Void (Void) +import Text.Show (Show(..)) +import qualified Data.Set as Set +import qualified Data.Text.Lazy.IO as TL +import qualified Language.Symantic.Document.Term as Doc +import qualified Language.Symantic.Document.Term.IO as DocIO +import qualified System.IO as IO +import qualified Text.Megaparsec as P + +import Language.Symantic.CLI.Sym +import qualified Language.Symantic.CLI.Plain as Plain +import qualified Language.Symantic.CLI.Help as Help +import qualified Language.Symantic.CLI.Read as Read + +data Command + = Command_Source + { command_source_output :: [String] + , command_source_format :: String + , command_source_dump_tct :: Bool + } + | Command_Compile + { command_compile_output :: [String] + , command_compile_lang :: String + , command_compile_dump_tct :: Bool + , command_compile_dump_dtc :: Bool + } + | Command_Schema + { command_schema_output :: [String] + } + deriving (Show) + +-- * Type 'Exit' +data Exit d + = Exit_Help d + | Exit_Version + deriving Show + +doc :: + Plain.Doc d => + Plain.Plain d (Exit d) t a -> d +doc = Plain.textPlain + +{- +help_usage :: Plain.Doc d => Help.Help d (Exit d) t a -> d +help_usage = Help.help "USAGE" "COMMAND" "OPTION" Help.defReader + { Help.reader_command_indent = 4 } +-} + +help_usage :: Plain.Doc d => Help.Help d (Exit d) t a -> d +help_usage = Help.textHelp Help.defReader + +-- * Class 'Hdoc' +class + ( Sym_Fun repr + , Sym_App repr + , Sym_Alt repr + , Sym_Help d repr + , Sym_Rule repr + , Sym_Interleaved repr + , Sym_Command repr + , Sym_Option repr + , Sym_Exit repr + , Sym_AltApp repr + , Plain.Doc d + ) => Hdoc d repr where + hdoc :: repr (Exit d) ArgCommand Command + hdoc = + help_words "technical document compiler\n(disclaimer: expect hdoc's documentation to be quite… technical :)" $ + main "hdoc" $ opts **> cmds + where + opts = + interleaved $ + (\_ -> ()) + <<$? option_help (help_usage hdoc) + <<|?>> ((), long "version" $ exit Exit_Version) + cmds = + command_source <||> + command_compile <||> + command_schema + + help_words :: String -> repr (Exit d) t a -> repr (Exit d) t a + help_words d = help @d (Plain.words d) + + option_help :: d -> ((), repr (Exit d) ArgOption ()) + option_help d = ((), opt (OptionName 'h' "help") $ exit $ Exit_Help d) + + command_source :: repr (Exit d) ArgCommand Command + command_source = + help_words "Format a TCT source file." $ + command "source" $ + interleaved $ + Command_Source + <<$? option_help (help_usage command_source) + <<|*>> rule_output + <<|>> option_format + <<|?>> option_dump_tct + command_compile :: repr (Exit d) ArgCommand Command + command_compile = + help_words "Compile a TCT source file." $ + command "compile" $ + (\cmd os -> case cmd of + Command_Compile{..} -> Command_Compile{command_compile_output=command_compile_output<>os, ..} + _ -> cmd) + <$$> opts + <** end_options + <**> inps + where + opts = + interleaved $ + Command_Compile + <<$? option_help (help_usage command_compile) + <<|*>> rule_output + <<|?>> option_lang + <<|?>> option_dump_tct + <<|?>> option_dump_dtc + inps = many $ var "file" string + command_schema :: repr (Exit d) ArgCommand Command + command_schema = + help_words "Show the schema for DTC documents." $ + command "schema" $ + interleaved $ + Command_Schema + <<$? option_help (help_usage command_schema) + <<|*>> option_output + + end_options :: repr (Exit d) ArgOption () + end_options = + help_words "Force the end of options.\nUseful if has the same name as an option." $ + endOpt + + option_lang :: (String, repr (Exit d) ArgOption String) + option_lang = + let def = "en_US" in + (def,) $ + help_words ("Use language .\nDefault is: "<>def) $ + long "lang" $ + var "lang" string + rule_output :: repr (Exit d) ArgOption String + rule_output = + rule "output" $ + option_output + option_output :: repr (Exit d) ArgOption String + option_output = + help_words "Output into .\nDefault is: input whose extension is replaced by here and then." $ + opt (OptionName 'o' "output") $ + var "file" string + option_dump_tct :: (Bool, repr (Exit d) ArgOption Bool) + option_dump_tct = + (False,) $ + help_words "Dump TCT." $ + long "dump-tct" $ + value True + option_dump_dtc :: (Bool, repr (Exit d) ArgOption Bool) + option_dump_dtc = + (False,) $ + help_words "Dump DTC." $ + long "dump-dtc" $ + value True + option_format :: repr (Exit d) ArgOption String + option_format = + help_words "Output format." $ + opt (OptionName 'f' "format") $ + "plain" <$$ tag "plain" <||> + "html5" <$$ tag "html5" +instance Plain.Doc d => Hdoc d (Plain.Plain d) +instance Plain.Doc d => Hdoc d Read.Parser +-- instance Plain.Doc d => Hdoc d (Help.Help d) +instance Plain.Doc d => Hdoc d (Help.Help d) + +parse :: + Plain.Doc d => + [String] -> IO.IO (Maybe (Either (Exit d) Command)) +parse as = + case Read.readArgs hdoc $ Read.Args $ Read.Arg <$> as of + Right a -> return $ Just $ Right a + Left err -> + case err of + P.FancyError _pos es -> + case Set.toList es of + [P.ErrorCustom (Read.ErrorRead e)] -> + return $ Just $ Left e + _ -> return Nothing + P.TrivialError pos e es -> do + IO.putStr $ P.parseErrorPretty @_ @Void $ + P.TrivialError pos e es + return Nothing + +parseIO :: [String] -> IO.IO () +parseIO as = do + ret <- parse as + case ret of + Nothing -> return () + Just (Right cmd) -> + IO.print $ show cmd + Just (Left err) -> do + case err of + Exit_Help d -> + DocIO.runTermIO IO.stdout $ + Doc.withBreakable (Just 80) d <> + Doc.newline + Exit_Version -> + TL.putStrLn "version" diff --git a/Language/Symantic/HLint.hs b/Language/Symantic/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/Language/Symantic/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/stack.yaml b/stack.yaml new file mode 100644 index 0000000..1679f67 --- /dev/null +++ b/stack.yaml @@ -0,0 +1,6 @@ +resolver: lts-12.8 +packages: +- '.' +- location: '../symantic-document' + extra-dep: true + diff --git a/symantic-cli.cabal b/symantic-cli.cabal new file mode 100644 index 0000000..5d09b86 --- /dev/null +++ b/symantic-cli.cabal @@ -0,0 +1,61 @@ +name: symantic-cli +-- PVP: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.0.0.20180410 +category: Data Structures +synopsis: Library for Command Line Interface (CLI) +description: Symantics for CLI. +extra-doc-files: +license: GPL-3 +license-file: COPYING +stability: experimental +author: Julien Moutinho +maintainer: Julien Moutinho +bug-reports: Julien Moutinho +-- homepage: + +build-type: Simple +cabal-version: 1.24 +tested-with: GHC==8.4.3 +extra-source-files: + stack.yaml +extra-tmp-files: + +Source-Repository head + location: git://git.autogeree.net/symantic + type: git + +Library + exposed-modules: + Language.Symantic.CLI + Language.Symantic.CLI.Fixity + Language.Symantic.CLI.Help + Language.Symantic.CLI.Plain + Language.Symantic.CLI.Read + Language.Symantic.CLI.Sym + default-language: Haskell2010 + default-extensions: + FlexibleContexts + FlexibleInstances + LambdaCase + MultiParamTypeClasses + NamedFieldPuns + NoImplicitPrelude + RecordWildCards + ScopedTypeVariables + TupleSections + TypeFamilies + ghc-options: + -Wall + -Wincomplete-uni-patterns + -Wincomplete-record-updates + -fno-warn-tabs + -- -fhide-source-paths + build-depends: + base >= 4.10 && < 5 + , containers >= 0.5 + , text >= 1.2 + , transformers >= 0.5 + , megaparsec >= 6.3 + , symantic-document diff --git a/test/Golden.hs b/test/Golden.hs new file mode 100644 index 0000000..1162f05 --- /dev/null +++ b/test/Golden.hs @@ -0,0 +1,72 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE TypeApplications #-} +module Golden where + +import Control.Arrow (left) +import Control.Monad (Monad(..)) +import Data.Either (Either(..)) +import Data.Function (($), (.)) +import Data.Functor ((<$>)) +import Data.Locale +import Data.Semigroup (Semigroup(..)) +import Data.String (String) +import System.FilePath (FilePath) +import System.IO (IO) +import Text.Show (Show(..)) +import qualified Data.ByteString.Lazy as BSL +import qualified Data.List as List +import qualified Data.Map.Strict as Map +import qualified Data.Text as Text +import qualified Data.Text.Lazy as TL +import qualified Data.Text.Lazy.Encoding as TL +import qualified Data.TreeSeq.Strict as TreeSeq +import qualified Text.Blaze.Html.Renderer.Utf8 as Blaze +import qualified Text.Megaparsec as P + +import Test.Tasty +import Test.Tasty.Golden + +-- * Golden testing utilities +testGolden :: TestName -> TestName -> IO (Either String BSL.ByteString) -> TestTree +testGolden inputFile expectedExt = + goldenVsStringDiff inputFile diffGolden (inputFile <> expectedExt) + . (>>= unLeft) + +diffGolden :: FilePath -> FilePath -> [String] +diffGolden ref new = ["diff", "-u", ref, new] + +unLeft :: Either String BSL.ByteString -> IO BSL.ByteString +unLeft = \case + Left err -> return $ TL.encodeUtf8 $ TL.pack err + Right a -> return a + +-- * All golden tests +goldensIO :: IO TestTree +goldensIO = do + inputFiles <- List.sort <$> findByExtension [".args"] "test/Golden" + return $ + testGroup "Args" + [ goldensRead inputFiles + ] + +-- * Tests +readArgs :: FilePath -> IO (Either String [String]) +readArgs inputFile = + Right . + List.lines . + TL.unpack . + TL.decodeUtf8 <$> + BSL.readFile inputFile + +goldensRead :: [FilePath] -> TestTree +goldensRead inputFiles = + testGroup "Read" + [ testGolden inputFile ".args.read" $ + readArgs inputFile >>= \args -> + return $ + TL.encodeUtf8 + . TL.pack + . TCT.runPretty 0 + <$> args + | inputFile <- inputFiles + ] diff --git a/test/Golden/.gitattributes b/test/Golden/.gitattributes new file mode 100644 index 0000000..fa1385d --- /dev/null +++ b/test/Golden/.gitattributes @@ -0,0 +1 @@ +* -text diff --git a/test/HLint.hs b/test/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/test/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 index 0000000..07ff490 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,15 @@ +module Main where + +import System.IO (IO) +import Data.Function (($)) + +import Test.Tasty +import Golden + +main :: IO () +main = do + goldens <- goldensIO + defaultMain $ + testGroup "CLI" + [ goldens + ] -- 2.44.1