diff --git a/.gitignore b/.gitignore --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,2 @@ -.cabal-sandbox/ -cabal.sandbox.config -dist -README.xhtml +/haskell-formatter.cabal +/.stack-work/ diff --git a/.hlint.yaml b/.hlint.yaml new file mode 100644 --- /dev/null +++ b/.hlint.yaml @@ -0,0 +1,2 @@ +- group: { name: dollar, enabled: true } +- group: { name: generalise, enabled: true } diff --git a/HLint.hs b/HLint.hs deleted file mode 100644 --- a/HLint.hs +++ /dev/null @@ -1,3 +0,0 @@ -import "hint" HLint.Default -import "hint" HLint.Dollar -import "hint" HLint.Generalise diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - 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: +MIT License - 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 (c) 2019 Benjamin Fischer -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". +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: - 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 above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. - 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 -. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile deleted file mode 100644 --- a/Makefile +++ /dev/null @@ -1,37 +0,0 @@ -FORMATTED_FILES = Setup.hs src testsuite/src -FORMATTER_UTILITY = cabal run -- -FORMATTER_ARGUMENTS = --force --input {} --output {} - -.PHONY : all build test document format sandbox clean - -all : build test document format - -build : - cabal install --only-dependencies --enable-tests -j - cabal configure --enable-tests - cabal build -j - -test : build - cabal test -j - cabal check - -document : build README.xhtml - cabal haddock --internal - -%.xhtml : %.rst - rst2html --strict $< $@ - -format : build -# Use "xargs" instead of "-exec", since -# 1. the call should fail if any "-exec" fails and -# 2. the behavior of multiple "{}" is undefined for a standard "find". - find $(FORMATTED_FILES) -type f -name '*.hs' -print0 | \ - xargs -n 1 -0 -I {} $(FORMATTER_UTILITY) $(FORMATTER_ARGUMENTS) - -sandbox : - cabal sandbox init - $(MAKE) build - -clean : - cabal clean - cabal sandbox delete diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,133 @@ +# Haskell Formatter + +[![Build](https://img.shields.io/travis/evolutics/haskell-formatter.svg)](https://travis-ci.org/evolutics/haskell-formatter) +[![License](https://img.shields.io/github/license/evolutics/haskell-formatter.svg)](LICENSE) +[![Package](https://img.shields.io/hackage/v/haskell-formatter.svg)](https://hackage.haskell.org/package/haskell-formatter) + +The Haskell Formatter formats Haskell source code. It is strict in that it fundamentally rearranges code. + +## Installation + +Install it by running + +``` +stack install haskell-formatter +``` + +or + +``` +cabal new-install haskell-formatter +``` + +You are ready when + +``` +haskell-formatter --help +``` + +works. + +## Usage + +### Basics + +Read source code from `Input.hs`, format it, and write it to `Output.hs` by + +``` +haskell-formatter --input Input.hs --output Output.hs +``` + +If the input or output file is not given, it defaults to the corresponding standard stream. This allows commands like + +``` +haskell-formatter < Input.hs +``` + +To format a file in-place, use the `--force` option as in + +``` +# Warning: this overwrites the file `Code.hs`. +haskell-formatter --force --input Code.hs --output Code.hs +``` + +For more help about the usage, call + +``` +haskell-formatter --help +``` + +### Formatting Many Files + +For a diff of how code in the current folder would be formatted, without actually changing anything, run + +``` +find . -name '*.hs' -type f -print0 \ + | xargs -0 -n 1 bash -c 'haskell-formatter < "$@" | diff -u "$@" -' -- +``` + +The returned exit status is nonzero if there are unformatted files. This may be useful for continuous integration. + +To format any `*.hs` files in a folder `code/` or (recursively) in its subfolders, run + +``` +# Warning: this overwrites files, so better back them up first. +find code/ -name '*.hs' -type f -print0 \ + | xargs -0 -I {} -n 1 haskell-formatter --force --input {} --output {} +``` + +### Style Configuration + +The formatting style can be configured with a file referred by the `--style` option. For instance, the call + +``` +haskell-formatter --style my_style.yaml --input Input.hs --output Output.hs +``` + +uses `my_style.yaml` as a style file. Such files are in the [YAML format](http://en.wikipedia.org/wiki/YAML). The following is an [example style file](testsuite/resources/examples/default_style.yaml), which at the same time shows the available keys with their default values. + + + +```yaml +# Lines should be no longer than this length in characters. +line_length_limit: 80 + +# How much to spread code over multiple lines instead of trying to fill a single +# line. More precisely, this guides the ratio of "line_length_limit" to the +# ribbon length (the number of characters on a line without leading and trailing +# whitespace). Only the lowest value of 1 forces "line_length_limit" to be +# applied strictly. +# Reference: http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.38.8777 +ribbons_per_line: 1 + +# More than this number of empty lines in succession are merged. +successive_empty_lines_limit: 1 + +# Indentation lengths in characters. +indentations: + class: 8 # "class" and "instance" declarations. + do: 3 # "do" notation. + case: 4 # Body of "case" expressions. + let: 4 # Declarations in "let" expressions. + where: 6 # Declarations in "where" clauses. + onside: 2 # Continuation lines which would otherwise be offside. + +# Decides which parts of the code to sort. +order: + # Sequence of import declarations. + import_declarations: true + + # Entities of import lists. + import_entities: true +``` + +## Related Projects + +You may like to have a look at the following projects, which aim at formatting Haskell code, too. + +- [brittany](https://github.com/lspitzner/brittany) +- [hfmt](https://github.com/danstiner/hfmt) +- [hindent](https://github.com/chrisdone/hindent) +- [stylish-haskell](https://github.com/jaspervdj/stylish-haskell) diff --git a/README.rst b/README.rst deleted file mode 100644 --- a/README.rst +++ /dev/null @@ -1,111 +0,0 @@ -================= -Haskell Formatter -================= - -The Haskell Formatter formats Haskell source code. It is strict in that it fundamentally rearranges code. - -Installation -============ - -Run - -:: - - $ cabal install haskell-formatter - -to create an executable, which is referred to as ``haskell-formatter`` in the following. On Linux, for example, you should now be able to call it as - -:: - - $ ~/.cabal/bin/haskell-formatter --help - -In case of issues with dependencies, try to use a Cabal sandbox. For convenience, this can be done by - -:: - - $ make sandbox - -Usage -===== - -Basics ------- - -Read source code from ``Input.hs``, format it, and write it to ``Output.hs`` by - -:: - - $ haskell-formatter --input Input.hs --output Output.hs - -If the input or output file is not given, it defaults to the corresponding standard stream. This allows commands like - -:: - - $ haskell-formatter < Input.hs - -For more help about the usage, call - -:: - - $ haskell-formatter --help - -Style Configuration -------------------- - -The formatting style can be configured with a file referred by the ``--style`` option. For instance, the call - -:: - - $ haskell-formatter --style my_style.yaml --input Input.hs --output Output.hs - -uses ``my_style.yaml`` as a style file. Such files are in the `YAML format `_. The following is an `example style file `_, which at the same time shows the available keys with their default values. - -.. GitHub does currently not allow to include files with the reStructuredText directive ``include`` (https://github.com/github/markup/issues/172). - - Thus, the file content is replicated here. There is a test which checks that the strings of both sources are equal. - -.. code:: yaml - - # Lines should be no longer than this length in characters. - line_length_limit: 80 - - # How much to spread code over multiple lines instead of trying to fill a single - # line. More precisely, this guides the ratio of "line_length_limit" to the - # ribbon length (the number of characters on a line without leading and trailing - # whitespace). Only the lowest value of 1 forces "line_length_limit" to be - # applied strictly. - # Reference: http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.38.8777 - ribbons_per_line: 1 - - # More than this number of empty lines in succession are merged. - successive_empty_lines_limit: 1 - - # Indentation lengths in characters. - indentations: - class: 8 # "class" and "instance" declarations. - do: 3 # "do" notation. - case: 4 # Body of "case" expressions. - let: 4 # Declarations in "let" expressions. - where: 6 # Declarations in "where" clauses. - onside: 2 # Continuation lines which would otherwise be offside. - - # Decides which parts of the code to sort. - order: - # Sequence of import declarations. - import_declarations: true - - # Entities of import lists. - import_entities: true - -Related Projects -================ - -You may like to have a look at the following projects, which aim at formatting Haskell code, too. - -* `hindent `_ -* `stylish-haskell `_ - -License -======= - -See the `LICENSE file `_. diff --git a/format.sh b/format.sh new file mode 100644 --- /dev/null +++ b/format.sh @@ -0,0 +1,8 @@ + #!/bin/bash + +set -o errexit +set -o nounset +set -o pipefail + +find Setup.hs src testsuite/src -name '*.hs' -type f -print0 \ + | xargs -0 -I {} -n 1 stack run -- --force --input {} --output {} diff --git a/haskell-formatter.cabal b/haskell-formatter.cabal --- a/haskell-formatter.cabal +++ b/haskell-formatter.cabal @@ -1,121 +1,118 @@ -name: haskell-formatter -version: 1.0.0 -synopsis: Haskell source code formatter -homepage: https://github.com/evolutics/haskell-formatter -bug-reports: https://github.com/evolutics/haskell-formatter/issues -license: GPL-3 -license-file: LICENSE -author: Benjamin Fischer -maintainer: Benjamin Fischer -copyright: (C) 2014–2015 Benjamin Fischer -category: Development -build-type: Simple -cabal-version: >= 1.8 +cabal-version: 1.12 -description: - The Haskell Formatter formats Haskell source code. It is strict in that it - fundamentally rearranges code. +-- This file has been generated from package.yaml by hpack version 0.31.1. +-- +-- see: https://github.com/sol/hpack +-- +-- hash: f2c2c0ac0a4d24bd2fe6b570ce4d489d4ff3ad57dc8aeb9b49c18a756f3edcac +name: haskell-formatter +version: 2.0.0 +synopsis: Haskell source code formatter +description: The Haskell Formatter formats Haskell source code. It is strict in that it fundamentally rearranges code. +category: Development +homepage: https://github.com/evolutics/haskell-formatter.git#readme +bug-reports: https://github.com/evolutics/haskell-formatter.git/issues +author: Benjamin Fischer +maintainer: Benjamin Fischer +copyright: (C) 2014–2019 Benjamin Fischer +license: MIT +license-file: LICENSE +build-type: Simple extra-source-files: - .gitignore - HLint.hs - Makefile - README.rst - testsuite/resources/examples/default_style.yaml + format.sh + .gitignore + .hlint.yaml + README.md + testsuite/resources/examples/default_style.yaml -extra-tmp-files: - README.xhtml +source-repository head + type: git + location: https://github.com/evolutics/haskell-formatter.git library exposed-modules: - Language.Haskell.Formatter, - Language.Haskell.Formatter.Internal.MapTree, - Language.Haskell.Formatter.Internal.Newline, - Language.Haskell.Formatter.Internal.StyleFileFormat, - Language.Haskell.Formatter.Internal.TreeFormat - + Language.Haskell.Formatter + Language.Haskell.Formatter.Internal.MapTree + Language.Haskell.Formatter.Internal.Newline + Language.Haskell.Formatter.Internal.StyleFileFormat + Language.Haskell.Formatter.Internal.TreeFormat other-modules: - Language.Haskell.Formatter.CommentCore, - Language.Haskell.Formatter.Configuration, - Language.Haskell.Formatter.Error, - Language.Haskell.Formatter.ExactCode, - Language.Haskell.Formatter.Location, - Language.Haskell.Formatter.Main, - Language.Haskell.Formatter.Process.AttachComments, - Language.Haskell.Formatter.Process.Code, - Language.Haskell.Formatter.Process.CodeOrdering, - Language.Haskell.Formatter.Process.Control, - Language.Haskell.Formatter.Process.DetachComments, - Language.Haskell.Formatter.Process.FormatActualCode, - Language.Haskell.Formatter.Process.FormatComments, - Language.Haskell.Formatter.Process.Formatter, - Language.Haskell.Formatter.Process.LineTool, - Language.Haskell.Formatter.Process.Note, - Language.Haskell.Formatter.Result, - Language.Haskell.Formatter.Source, - Language.Haskell.Formatter.Style, - Language.Haskell.Formatter.Toolkit.ListTool, - Language.Haskell.Formatter.Toolkit.Splitter, - Language.Haskell.Formatter.Toolkit.StreamName, - Language.Haskell.Formatter.Toolkit.Visit - - build-depends: - base >= 4.6 && < 4.8, - containers >= 0.5, - haskell-src-exts == 1.16.*, - scientific >= 0.3, - text >= 1.0, - unordered-containers >= 0.2, - yaml >= 0.8 - + Language.Haskell.Formatter.CommentCore + Language.Haskell.Formatter.Configuration + Language.Haskell.Formatter.Error + Language.Haskell.Formatter.ExactCode + Language.Haskell.Formatter.Location + Language.Haskell.Formatter.Main + Language.Haskell.Formatter.Process.AttachComments + Language.Haskell.Formatter.Process.Code + Language.Haskell.Formatter.Process.CodeOrdering + Language.Haskell.Formatter.Process.Control + Language.Haskell.Formatter.Process.DetachComments + Language.Haskell.Formatter.Process.FormatActualCode + Language.Haskell.Formatter.Process.FormatComments + Language.Haskell.Formatter.Process.Formatter + Language.Haskell.Formatter.Process.LineTool + Language.Haskell.Formatter.Process.Note + Language.Haskell.Formatter.Result + Language.Haskell.Formatter.Source + Language.Haskell.Formatter.Style + Language.Haskell.Formatter.Toolkit.ListTool + Language.Haskell.Formatter.Toolkit.Splitter + Language.Haskell.Formatter.Toolkit.StreamName + Language.Haskell.Formatter.Toolkit.Visit + Paths_haskell_formatter hs-source-dirs: - src/library - - ghc-options: -Wall - -executable haskell-formatter - main-is: Main.hs - + src/library + ghc-options: -Wall build-depends: - base >= 4.6 && < 4.8, - directory >= 1.2, - filepath >= 1.3, - haskell-formatter, - optparse-applicative >= 0.10 + base >=4.6 && <5 + , containers + , haskell-src-exts + , scientific + , text + , unordered-containers + , yaml + default-language: Haskell2010 +executable haskell-formatter + main-is: Main.hs + other-modules: + Paths_haskell_formatter hs-source-dirs: - src/executable - - ghc-options: -Wall + src/executable + ghc-options: -Wall + build-depends: + base >=4.6 && <5 + , directory + , filepath + , haskell-formatter + , optparse-applicative + default-language: Haskell2010 test-suite test - type: exitcode-stdio-1.0 - main-is: Main.hs - + type: exitcode-stdio-1.0 + main-is: Main.hs other-modules: - Language.Haskell.Formatter.Internal.Tests, - Language.Haskell.Formatter.Tests, - Language.Haskell.Formatter.Toolkit.FileTesting, - Language.Haskell.Formatter.Toolkit.FileTree, - Language.Haskell.Formatter.Toolkit.TestTool - - build-depends: - base >= 4.6 && < 4.8, - containers >= 0.5, - directory-tree >= 0.11, - doctest >= 0.9, - filemanip >= 0.3, - filepath >= 1.3, - haskell-formatter, - hlint >= 1.9, - tasty >= 0.9, - tasty-hunit >= 0.8 - + Language.Haskell.Formatter.Internal.Tests + Language.Haskell.Formatter.Tests + Language.Haskell.Formatter.Toolkit.FileTesting + Language.Haskell.Formatter.Toolkit.FileTree + Language.Haskell.Formatter.Toolkit.TestTool + Paths_haskell_formatter hs-source-dirs: - testsuite/src - - ghc-options: -Wall - -source-repository head - type: git - location: https://github.com/evolutics/haskell-formatter.git + testsuite/src + ghc-options: -Wall + build-depends: + QuickCheck + , base >=4.6 && <5 + , containers + , directory-tree + , doctest + , filemanip + , filepath + , haskell-formatter + , hlint + , tasty + , tasty-hunit + default-language: Haskell2010 diff --git a/src/executable/Main.hs b/src/executable/Main.hs --- a/src/executable/Main.hs +++ b/src/executable/Main.hs @@ -19,7 +19,7 @@ data Arguments = Arguments{input :: Maybe FilePath, output :: Maybe FilePath, force :: Bool, styleFile :: Maybe FilePath} - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) main :: IO () main diff --git a/src/library/Language/Haskell/Formatter/CommentCore.hs b/src/library/Language/Haskell/Formatter/CommentCore.hs --- a/src/library/Language/Haskell/Formatter/CommentCore.hs +++ b/src/library/Language/Haskell/Formatter/CommentCore.hs @@ -11,16 +11,16 @@ import qualified Language.Haskell.Formatter.Toolkit.ListTool as ListTool data CommentCore = CommentCore{kind :: Kind, content :: String} - deriving (Eq, Ord) + deriving (Eq, Ord) data Kind = Ordinary | Nested - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) data DocumentationDisplacement = BeforeActualCode | AfterActualCode | None - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) instance Show CommentCore where show comment diff --git a/src/library/Language/Haskell/Formatter/Configuration.hs b/src/library/Language/Haskell/Formatter/Configuration.hs --- a/src/library/Language/Haskell/Formatter/Configuration.hs +++ b/src/library/Language/Haskell/Formatter/Configuration.hs @@ -13,7 +13,7 @@ data Configuration = Configuration{configurationStyle :: Style.Style, configurationStreamName :: StreamName.StreamName} - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) defaultConfiguration :: Configuration defaultConfiguration diff --git a/src/library/Language/Haskell/Formatter/Error.hs b/src/library/Language/Haskell/Formatter/Error.hs --- a/src/library/Language/Haskell/Formatter/Error.hs +++ b/src/library/Language/Haskell/Formatter/Error.hs @@ -11,7 +11,7 @@ data Error = StyleFormatError String | ParseError Location.SrcLoc String | AssertionError String - deriving (Eq, Ord) + deriving (Eq, Ord) instance Show Error where show (StyleFormatError message) = message diff --git a/src/library/Language/Haskell/Formatter/Internal/MapTree.hs b/src/library/Language/Haskell/Formatter/Internal/MapTree.hs --- a/src/library/Language/Haskell/Formatter/Internal/MapTree.hs +++ b/src/library/Language/Haskell/Formatter/Internal/MapTree.hs @@ -10,7 +10,7 @@ data MapTree k a = Leaf a | Node (MapForest k a) - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) type MapForest k a = Map.Map k (MapTree k a) diff --git a/src/library/Language/Haskell/Formatter/Location.hs b/src/library/Language/Haskell/Formatter/Location.hs --- a/src/library/Language/Haskell/Formatter/Location.hs +++ b/src/library/Language/Haskell/Formatter/Location.hs @@ -11,9 +11,9 @@ getEndLine, getEndColumn) where import qualified Data.Function as Function -import qualified Language.Haskell.Exts.Annotated.Syntax as Syntax import qualified Language.Haskell.Exts.Comments as Comments import qualified Language.Haskell.Exts.SrcLoc as SrcLoc +import qualified Language.Haskell.Exts.Syntax as Syntax import qualified Language.Haskell.Formatter.Internal.Newline as Newline import qualified Language.Haskell.Formatter.Toolkit.ListTool as ListTool import qualified Language.Haskell.Formatter.Toolkit.StreamName as StreamName @@ -34,11 +34,11 @@ getPortion :: a -> SrcLoc.SrcSpan -data Line = Line Int - deriving (Eq, Ord, Show) +newtype Line = Line Int + deriving (Eq, Ord, Show) -data Column = Column Int - deriving (Eq, Ord, Show) +newtype Column = Column Int + deriving (Eq, Ord, Show) instance Enum Line where toEnum = Line diff --git a/src/library/Language/Haskell/Formatter/Process/AttachComments.hs b/src/library/Language/Haskell/Formatter/Process/AttachComments.hs --- a/src/library/Language/Haskell/Formatter/Process/AttachComments.hs +++ b/src/library/Language/Haskell/Formatter/Process/AttachComments.hs @@ -9,6 +9,7 @@ import qualified Data.List as List import qualified Data.Map.Strict as Map import qualified Data.Monoid as Monoid +import qualified Data.Semigroup as Semigroup import qualified Data.Traversable as Traversable import qualified Language.Haskell.Formatter.CommentCore as CommentCore import qualified Language.Haskell.Formatter.ExactCode as ExactCode @@ -20,18 +21,20 @@ import qualified Language.Haskell.Formatter.Source as Source import qualified Language.Haskell.Formatter.Style as Style -data Assignment = Assignment (Map.Map Location.SrcSpan Note.CommentNote) - deriving (Eq, Ord, Show) +newtype Assignment = Assignment (Map.Map Location.SrcSpan Note.CommentNote) + deriving (Eq, Ord, Show) data CodeGap = InfiniteLower Location.SrcSpan | FiniteGap Location.SrcSpan Location.SrcSpan | InfiniteUpper Location.SrcSpan - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) +instance Semigroup.Semigroup Assignment where + (Assignment left) <> (Assignment right) = Assignment merged + where merged = Map.unionWith Monoid.mappend left right + instance Monoid.Monoid Assignment where mempty = Assignment Map.empty - mappend (Assignment left) (Assignment right) = Assignment merged - where merged = Map.unionWith Monoid.mappend left right attachComments :: Style.Style -> diff --git a/src/library/Language/Haskell/Formatter/Process/CodeOrdering.hs b/src/library/Language/Haskell/Formatter/Process/CodeOrdering.hs --- a/src/library/Language/Haskell/Formatter/Process/CodeOrdering.hs +++ b/src/library/Language/Haskell/Formatter/Process/CodeOrdering.hs @@ -5,7 +5,7 @@ (orderImportDeclarations, orderRootImportEntities, orderNestedImportEntities) where -import qualified Language.Haskell.Exts.Annotated.Syntax as Syntax +import qualified Language.Haskell.Exts.Syntax as Syntax import qualified Language.Haskell.Formatter.Process.Code as Code import qualified Language.Haskell.Formatter.Source as Source import qualified Language.Haskell.Formatter.Toolkit.Visit as Visit @@ -30,15 +30,15 @@ replaceImportDeclarations function (Syntax.Module a h p importDeclarations d) = Syntax.Module a h p importDeclarations' d where importDeclarations' = function importDeclarations -replaceImportDeclarations _ xmlPage@(Syntax.XmlPage _ _ _ _ _ _ _) = xmlPage +replaceImportDeclarations _ xmlPage@Syntax.XmlPage{} = xmlPage replaceImportDeclarations function (Syntax.XmlHybrid a h p importDeclarations d xn xa me e) = Syntax.XmlHybrid a h p importDeclarations' d xn xa me e where importDeclarations' = function importDeclarations importEntityKey :: Syntax.ImportSpec a -> [String] -importEntityKey (Syntax.IVar _ _ name) = rootNameKey name -importEntityKey (Syntax.IAbs _ name) = rootNameKey name +importEntityKey (Syntax.IVar _ name) = rootNameKey name +importEntityKey (Syntax.IAbs _ _ name) = rootNameKey name importEntityKey (Syntax.IThingAll _ name) = rootNameKey name importEntityKey (Syntax.IThingWith _ name entities) = nameKey name : fmap nestedImportEntityKey entities diff --git a/src/library/Language/Haskell/Formatter/Process/DetachComments.hs b/src/library/Language/Haskell/Formatter/Process/DetachComments.hs --- a/src/library/Language/Haskell/Formatter/Process/DetachComments.hs +++ b/src/library/Language/Haskell/Formatter/Process/DetachComments.hs @@ -9,6 +9,7 @@ import qualified Data.Map.Strict as Map import qualified Data.Maybe as Maybe import qualified Data.Monoid as Monoid +import qualified Data.Semigroup as Semigroup import qualified Language.Haskell.Formatter.CommentCore as CommentCore import qualified Language.Haskell.Formatter.ExactCode as ExactCode import qualified Language.Haskell.Formatter.Location as Location @@ -21,12 +22,11 @@ import qualified Language.Haskell.Formatter.Toolkit.ListTool as ListTool import qualified Language.Haskell.Formatter.Toolkit.StreamName as StreamName -data Reservation = Reservation (Map.Map Location.Line [Note.CommentBox]) - deriving (Eq, Ord, Show) +newtype Reservation = Reservation (Map.Map Location.Line [Note.CommentBox]) + deriving (Eq, Ord, Show) -instance Monoid.Monoid Reservation where - mempty = Reservation Map.empty - mappend (Reservation left) (Reservation right) = Reservation merged +instance Semigroup.Semigroup Reservation where + (Reservation left) <> (Reservation right) = Reservation merged where merged = Map.unionWith merge left right merge before after = concat [before, between, after] where between @@ -38,6 +38,9 @@ Nothing -> False Just (Note.ActualComment _) -> True Just Note.EmptyLine -> False + +instance Monoid.Monoid Reservation where + mempty = Reservation Map.empty detachComments :: Style.Style -> diff --git a/src/library/Language/Haskell/Formatter/Process/Formatter.hs b/src/library/Language/Haskell/Formatter/Process/Formatter.hs --- a/src/library/Language/Haskell/Formatter/Process/Formatter.hs +++ b/src/library/Language/Haskell/Formatter/Process/Formatter.hs @@ -42,8 +42,7 @@ locatableCommentable' <- formatActualCode formatter locatableCommentable locatableCommentable'' <- checkedFormatComments formatter locatableCommentable' - exact' <- checkedDetachComments formatter locatableCommentable'' - return exact' + checkedDetachComments formatter locatableCommentable'' where locatable = ExactCode.actualCode exact checkedAttachComments :: diff --git a/src/library/Language/Haskell/Formatter/Process/LineTool.hs b/src/library/Language/Haskell/Formatter/Process/LineTool.hs --- a/src/library/Language/Haskell/Formatter/Process/LineTool.hs +++ b/src/library/Language/Haskell/Formatter/Process/LineTool.hs @@ -7,8 +7,8 @@ import qualified Language.Haskell.Formatter.Location as Location import qualified Language.Haskell.Formatter.Process.Code as Code -data Shifter = Shifter (Map.Map Location.Line Shift) - deriving (Eq, Ord, Show) +newtype Shifter = Shifter (Map.Map Location.Line Shift) + deriving (Eq, Ord, Show) type Shift = Int diff --git a/src/library/Language/Haskell/Formatter/Process/Note.hs b/src/library/Language/Haskell/Formatter/Process/Note.hs --- a/src/library/Language/Haskell/Formatter/Process/Note.hs +++ b/src/library/Language/Haskell/Formatter/Process/Note.hs @@ -10,32 +10,35 @@ where import qualified Data.Function as Function import qualified Data.Monoid as Monoid +import qualified Data.Semigroup as Semigroup import qualified Language.Haskell.Formatter.CommentCore as CommentCore import qualified Language.Haskell.Formatter.Location as Location data CommentNote = CommentNote{commentsBefore :: [CommentBox], commentsAfter :: [CommentBox]} - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) data CommentBox = ActualComment IndentedComment | EmptyLine - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) data IndentedComment = IndentedComment{commentCore :: CommentCore.CommentCore, commentStartColumn :: Location.Column} - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) data LocationCommentNote = LocationCommentNote{locationNote :: Location.SrcSpanInfo, commentNote :: CommentNote} - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) -instance Monoid.Monoid CommentNote where - mempty = createCommentNote [] [] - mappend left right = createCommentNote before after +instance Semigroup.Semigroup CommentNote where + left <> right = createCommentNote before after where before = merge commentsBefore merge getComments = Function.on (++) getComments left right after = merge commentsAfter + +instance Monoid.Monoid CommentNote where + mempty = createCommentNote [] [] instance Location.Portioned LocationCommentNote where getPortion = Location.getPortion . locationNote diff --git a/src/library/Language/Haskell/Formatter/Result.hs b/src/library/Language/Haskell/Formatter/Result.hs --- a/src/library/Language/Haskell/Formatter/Result.hs +++ b/src/library/Language/Haskell/Formatter/Result.hs @@ -7,8 +7,8 @@ import qualified Control.Monad as Monad import qualified Language.Haskell.Formatter.Error as Error -data Result a = Result (Either Error.Error a) - deriving (Eq, Ord, Show) +newtype Result a = Result (Either Error.Error a) + deriving (Eq, Ord, Show) instance Functor Result where fmap = Monad.liftM diff --git a/src/library/Language/Haskell/Formatter/Source.hs b/src/library/Language/Haskell/Formatter/Source.hs --- a/src/library/Language/Haskell/Formatter/Source.hs +++ b/src/library/Language/Haskell/Formatter/Source.hs @@ -4,18 +4,18 @@ See also "Language.Haskell.Formatter.Location". -} module Language.Haskell.Formatter.Source - (Annotated.parseFileContents, Annotated.parseFileContentsWithComments, - Comments.Comment, ExactPrint.exactPrint, Parser.defaultParseMode, + (Comments.Comment, ExactPrint.exactPrint, Exts.parseFileContents, + Exts.parseFileContentsWithComments, Parser.defaultParseMode, Parser.parseFilename, Parser.ParseResult(..), module Language.Haskell.Exts.Pretty, (Syntax.=~=), Syntax.Module, createComment, commentCore) where -import qualified Language.Haskell.Exts.Annotated as Annotated -import qualified Language.Haskell.Exts.Annotated.ExactPrint as ExactPrint -import qualified Language.Haskell.Exts.Annotated.Syntax as Syntax +import qualified Language.Haskell.Exts as Exts import qualified Language.Haskell.Exts.Comments as Comments +import qualified Language.Haskell.Exts.ExactPrint as ExactPrint import qualified Language.Haskell.Exts.Parser as Parser import Language.Haskell.Exts.Pretty +import qualified Language.Haskell.Exts.Syntax as Syntax import qualified Language.Haskell.Formatter.CommentCore as CommentCore import qualified Language.Haskell.Formatter.Location as Location diff --git a/src/library/Language/Haskell/Formatter/Style.hs b/src/library/Language/Haskell/Formatter/Style.hs --- a/src/library/Language/Haskell/Formatter/Style.hs +++ b/src/library/Language/Haskell/Formatter/Style.hs @@ -21,10 +21,10 @@ whereIndentation :: Indentation, onsideIndentation :: Indentation, orderImportDeclarations :: Bool, orderImportEntities :: Bool} - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) -data Check = Check (Maybe String) - deriving (Eq, Ord, Show) +newtype Check = Check (Maybe String) + deriving (Eq, Ord, Show) {-| Number of characters used to indent. -} type Indentation = Int diff --git a/src/library/Language/Haskell/Formatter/Toolkit/Splitter.hs b/src/library/Language/Haskell/Formatter/Toolkit/Splitter.hs --- a/src/library/Language/Haskell/Formatter/Toolkit/Splitter.hs +++ b/src/library/Language/Haskell/Formatter/Toolkit/Splitter.hs @@ -11,14 +11,14 @@ {-| Strategy to split a list on sublists. -} data Splitter a = Splitter{delimiterPolicy :: DelimiterPolicy, delimiterQueue :: [[a]]} - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) {-| What to do with the delimiters? -} data DelimiterPolicy = Drop | Separate | MergeLeft | MergeRight - deriving (Eq, Ord, Show) + deriving (Eq, Ord, Show) {-| @separate d l@ splits @l@ on the delimiters @d@, which are matched in the given order. The delimiters are not kept. diff --git a/src/library/Language/Haskell/Formatter/Toolkit/StreamName.hs b/src/library/Language/Haskell/Formatter/Toolkit/StreamName.hs --- a/src/library/Language/Haskell/Formatter/Toolkit/StreamName.hs +++ b/src/library/Language/Haskell/Formatter/Toolkit/StreamName.hs @@ -6,8 +6,8 @@ {-| An informal reference to a data stream. For example, this could be the name of a file stream to be used in error messages. -} -data StreamName = StreamName String - deriving (Eq, Ord) +newtype StreamName = StreamName String + deriving (Eq, Ord) instance Show StreamName where show (StreamName string) = string diff --git a/testsuite/src/Language/Haskell/Formatter/Internal/Tests.hs b/testsuite/src/Language/Haskell/Formatter/Internal/Tests.hs --- a/testsuite/src/Language/Haskell/Formatter/Internal/Tests.hs +++ b/testsuite/src/Language/Haskell/Formatter/Internal/Tests.hs @@ -46,16 +46,10 @@ assertion = do styleString <- readFile defaultStyleFile readme <- readFile readmeFile - let isContained = isContainedInReadme styleString readme + let isContained = styleString `List.isInfixOf` readme HUnit.assertBool message isContained - readmeFile = "README.rst" + readmeFile = "README.md" message = concat [show readmeFile, " must contain ", show defaultStyleFile, ", but it does not."] - -isContainedInReadme :: String -> String -> Bool -isContainedInReadme file = List.isInfixOf preparedFile - where preparedFile = indent file - indent = unlines . fmap (indentation ++) . lines - indentation = " "