From f98ed238af2281a854dfed20cc0a686c7d217ed4 Mon Sep 17 00:00:00 2001 From: Julien Moutinho Date: Fri, 14 Jun 2019 14:31:04 +0000 Subject: [PATCH 1/1] init --- .gitignore | 11 + COPYING | 674 ++++++++++++++++++++++++++++++++++ GNUmakefile | 81 ++++ HLint.hs | 19 + Symantic/Document.hs | 8 + Symantic/Document/API.hs | 484 ++++++++++++++++++++++++ Symantic/Document/AnsiText.hs | 211 +++++++++++ Symantic/Document/HLint.hs | 1 + Symantic/Document/Plain.hs | 447 ++++++++++++++++++++++ Symantic/HLint.hs | 1 + stack.yaml | 3 + symantic-document.cabal | 104 ++++++ test/HLint.hs | 1 + test/HUnit.hs | 211 +++++++++++ test/Main.hs | 14 + 15 files changed, 2270 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 GNUmakefile create mode 100644 HLint.hs create mode 100644 Symantic/Document.hs create mode 100644 Symantic/Document/API.hs create mode 100644 Symantic/Document/AnsiText.hs create mode 120000 Symantic/Document/HLint.hs create mode 100644 Symantic/Document/Plain.hs create mode 120000 Symantic/HLint.hs create mode 100644 stack.yaml create mode 100644 symantic-document.cabal create mode 120000 test/HLint.hs create mode 100644 test/HUnit.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/GNUmakefile b/GNUmakefile new file mode 100644 index 0000000..c45d668 --- /dev/null +++ b/GNUmakefile @@ -0,0 +1,81 @@ +cabal := $(shell find . -name '*.cabal' -print -quit) +package := $(notdir ./$(cabal:.cabal=)) +#package := $(shell 2>&1 stack ide packages) +#STACK_FLAGS ?= --nix + +all: build + +build: + stack $(STACK_FLAGS) build $(STACK_BUILD_FLAGS) + +.PHONY: test +test: + ! grep -q '^Test-Suite\>' $(cabal) || \ + { stack $(STACK_FLAGS) test $(STACK_TEST_FLAGS) --test-arguments "$(STACK_TEST_ARGS)"; } + +GHCID_TEST_ARGS ?= +GHCID_TEST ?= ":main --color always $(GHCID_TEST_ARGS)" +ghcid: + ghcid --color=always \ + --warnings \ + --command "stack $(STACK_FLAGS) $(GHCID_STACK_FLAGS) ghci $(GHCID_GHCI_FLAGS) --test \ + $(shell 2>&1 stack ide targets) \ + --ghci-options=-fobject-code" \ + --test $(GHCID_TEST) \ + $(GHCID_FLAGS) + +clean: + stack $(STACK_FLAGS) clean $(STACK_CLEAN_FLAGS) +cleaner: + stack $(STACK_FLAGS) clean --full $(STACK_CLEAN_FLAGS) + +%/fast: override STACK_BUILD_FLAGS+=--fast +%/fast: override STACK_HADDOCK_FLAGS+=--fast +%/fast: override STACK_TEST_FLAGS+=--fast +%/fast: % + + +%/debug: override STACK_BUILD_FLAGS+=--flag $(cabal:.cabal=):debug +%/debug: override STACK_TEST_FLAGS+=--flag $(cabal:.cabal=):debug +%/debug: % + + +%/accept: override STACK_TEST_ARGS+=--accept +%/accept: % + + +doc: + stack $(STACK_FLAGS) haddock $(STACK_HADDOCK_FLAGS) +%.html: %.md + markdown $*.md >$*.html +%.html/view: %.html + sensible-browser $*.html + +HLint.hs: $(shell find . -name '*.hs' -not -name 'HLint.hs') + sed -i -e '/^-- BEGIN: generated hints/,/^-- END: Generated by hlint/d' HLint.hs + echo '-- BEGIN: generated hints' >> HLint.hs + hlint -XTypeApplications --find . | sed -ne 's/^- infix: "\([^"]*\)"/\1/p' | sort -u >>HLint.hs + echo '-- END: generated hints' >> HLint.hs + +lint: HLint.hs + if hlint --quiet --report=hlint.html -XNoCPP \ + $(shell cabal-cargs --format=ghc --only=default_extensions --sourcefile=$(cabal)) $(HLINT_FLAGS) .; \ + then rm -f hlint.html; \ + else sensible-browser ./hlint.html & fi + +tag: + name=$$(sed -ne 's/^name: *\(.*\)/\1/p' "$(cabal)"); \ + version=$$(sed -ne 's/^version: *\(.*\)/\1/p' "$(cabal)"); \ + git tag --merged | grep -Fqx "$$name-$$version" || \ + git tag -f -s -m "$$name v$$version" $$name-$$version + +tar: + stack $(STACK_FLAGS) sdist $(STACK_SDIST_FLAGS) +upload: + LANG=C stack $(STACK_FLAGS) upload $(STACK_UPLOAD_FLAGS) . + +.PHONY: stats +stats: + gitstats . $@ +stats/view: stats + sensible-browser stats/index.html diff --git a/HLint.hs b/HLint.hs new file mode 100644 index 0000000..a86561a --- /dev/null +++ b/HLint.hs @@ -0,0 +1,19 @@ +import "hint" HLint.HLint +ignore "Move brackets to avoid $" +ignore "Reduce duplication" +ignore "Redundant $" +ignore "Redundant bracket" +ignore "Redundant do" +ignore "Use camelCase" +ignore "Use const" +ignore "Use fmap" +ignore "Use if" +ignore "Use import/export shortcut" +ignore "Use list literal pattern" +ignore "Use list literal" + +-- BEGIN: generated hints +infix 1 `maxWidth` +infixr 6 +infixr 6 <+> +-- END: generated hints diff --git a/Symantic/Document.hs b/Symantic/Document.hs new file mode 100644 index 0000000..40d5cf6 --- /dev/null +++ b/Symantic/Document.hs @@ -0,0 +1,8 @@ +module Symantic.Document + ( module Symantic.Document.API + , module Symantic.Document.Plain + , module Symantic.Document.AnsiText + ) where +import Symantic.Document.API +import Symantic.Document.Plain +import Symantic.Document.AnsiText diff --git a/Symantic/Document/API.hs b/Symantic/Document/API.hs new file mode 100644 index 0000000..62903f2 --- /dev/null +++ b/Symantic/Document/API.hs @@ -0,0 +1,484 @@ +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE UndecidableInstances #-} +module Symantic.Document.API where + +import Control.Applicative (Applicative(..)) +import Data.Bool +import Data.Char (Char) +import Data.Eq (Eq(..)) +import Data.Foldable (Foldable, foldr, foldr1, null) +import Data.Function ((.), ($), id, const) +import Data.Functor (Functor(..), (<$>)) +import Data.Int (Int) +import Data.Maybe (Maybe(..)) +import Data.Monoid (Monoid(..)) +import Data.Ord (Ord(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String, IsString(..)) +import Data.Text (Text) +import Numeric.Natural (Natural) +import Prelude (Integer, fromIntegral, pred) +import System.Console.ANSI (SGR, setSGRCode) +import Text.Show (Show(..)) +import qualified Data.List as List +import qualified Data.Text as Text +import qualified Data.Text.Lazy as TL +import qualified Data.Text.Lazy.Builder as TLB + +-- * Helper types +type Column = Natural +type Indent = Column +type Width = Natural + +-- ** Type 'Line' +newtype Line d = Line d + deriving (Eq,Show) +unLine :: Line d -> d +unLine (Line d) = d + +-- ** Type 'Word' +newtype Word d = Word d + deriving (Eq,Show,Semigroup) +unWord :: Word d -> d +unWord (Word d) = d +instance DocFrom [SGR] d => DocFrom [SGR] (Word d) where + docFrom = Word . docFrom + +-- * Class 'DocFrom' +class DocFrom a d where + docFrom :: a -> d + default docFrom :: DocFrom String d => Show a => a -> d + docFrom = docFrom . show +instance DocFrom (Line String) d => DocFrom Int d where + docFrom = docFrom . Line . show +instance DocFrom (Line String) d => DocFrom Integer d where + docFrom = docFrom . Line . show +instance DocFrom (Line String) d => DocFrom Natural d where + docFrom = docFrom . Line . show + +-- String +instance DocFrom Char String where + docFrom = pure +instance DocFrom String String where + docFrom = id +instance DocFrom Text String where + docFrom = Text.unpack +instance DocFrom TL.Text String where + docFrom = TL.unpack +instance DocFrom d String => DocFrom (Line d) String where + docFrom = docFrom . unLine +instance DocFrom d String => DocFrom (Word d) String where + docFrom = docFrom . unWord +instance DocFrom [SGR] String where + docFrom = setSGRCode + +-- Text +instance DocFrom Char Text where + docFrom = Text.singleton +instance DocFrom String Text where + docFrom = Text.pack +instance DocFrom Text Text where + docFrom = id +instance DocFrom TL.Text Text where + docFrom = TL.toStrict +instance DocFrom d Text => DocFrom (Line d) Text where + docFrom = docFrom . unLine +instance DocFrom d Text => DocFrom (Word d) Text where + docFrom = docFrom . unWord +instance DocFrom [SGR] Text where + docFrom = docFrom . setSGRCode + +-- TLB.Builder +instance DocFrom Char TLB.Builder where + docFrom = TLB.singleton +instance DocFrom String TLB.Builder where + docFrom = fromString +instance DocFrom Text TLB.Builder where + docFrom = TLB.fromText +instance DocFrom TL.Text TLB.Builder where + docFrom = TLB.fromLazyText +instance DocFrom TLB.Builder TLB.Builder where + docFrom = id +instance DocFrom d TLB.Builder => DocFrom (Line d) TLB.Builder where + docFrom = docFrom . unLine +instance DocFrom d TLB.Builder => DocFrom (Word d) TLB.Builder where + docFrom = docFrom . unWord +instance DocFrom [SGR] TLB.Builder where + docFrom = docFrom . setSGRCode + +runTextBuilder :: TLB.Builder -> TL.Text +runTextBuilder = TLB.toLazyText + +-- * Class 'Lengthable' +class Lengthable d where + length :: d -> Column + nullLength :: d -> Bool + nullLength d = length d == 0 +instance Lengthable Char where + length _ = 1 + nullLength = const False +instance Lengthable String where + length = fromIntegral . List.length + nullLength = null +instance Lengthable Text.Text where + length = fromIntegral . Text.length + nullLength = Text.null +instance Lengthable TL.Text where + length = fromIntegral . TL.length + nullLength = TL.null +instance Lengthable d => Lengthable (Line d) where + length = fromIntegral . length . unLine + nullLength = nullLength . unLine +instance Lengthable d => Lengthable (Word d) where + length = fromIntegral . length . unWord + nullLength = nullLength . unWord + +-- * Class 'Spaceable' +class Monoid d => Spaceable d where + newline :: d + space :: d + default newline :: Spaceable (UnTrans d) => Trans d => d + default space :: Spaceable (UnTrans d) => Trans d => d + newline = noTrans newline + space = noTrans space + + -- | @'spaces' ind = 'replicate' ind 'space'@ + spaces :: Column -> d + default spaces :: Monoid d => Column -> d + spaces i = replicate (fromIntegral i) space + unlines :: Foldable f => f (Line d) -> d + unlines = foldr (\(Line x) acc -> x<>newline<>acc) mempty + unwords :: Foldable f => Functor f => f (Word d) -> d + unwords = intercalate space . (unWord <$>) + -- | Like 'unlines' but without the trailing 'newline'. + catLines :: Foldable f => Functor f => f (Line d) -> d + catLines = intercalate newline . (unLine <$>) + -- | @x '<+>' y = x '<>' 'space' '<>' y@ + (<+>) :: d -> d -> d + -- | @x '' y = x '<>' 'newline' '<>' y@ + () :: d -> d -> d + x <+> y = x <> space <> y + x y = x <> newline <> y + catH :: Foldable f => f d -> d + catV :: Foldable f => f d -> d + catH = foldr (<>) mempty + catV = intercalate newline +infixr 6 <+> +infixr 6 +instance Spaceable String where + newline = "\n" + space = " " + spaces n = List.replicate (fromIntegral n) ' ' +instance Spaceable Text where + newline = "\n" + space = " " + spaces n = Text.replicate (fromIntegral n) " " +instance Spaceable TLB.Builder where + newline = TLB.singleton '\n' + space = TLB.singleton ' ' + spaces = TLB.fromText . spaces + +intercalate :: (Foldable f, Monoid d) => d -> f d -> d +intercalate sep ds = if null ds then mempty else foldr1 (\x y -> x<>sep<>y) ds + +replicate :: Monoid d => Int -> d -> d +replicate cnt t | cnt <= 0 = mempty + | otherwise = t `mappend` replicate (pred cnt) t + +between :: Semigroup d => d -> d -> d -> d +between o c d = o<>d<>c +parens :: Semigroup d => DocFrom (Word Char) d => d -> d +parens = between (docFrom (Word '(')) (docFrom (Word ')')) +braces :: Semigroup d => DocFrom (Word Char) d => d -> d +braces = between (docFrom (Word '{')) (docFrom (Word '}')) +brackets :: Semigroup d => DocFrom (Word Char) d => d -> d +brackets = between (docFrom (Word '[')) (docFrom (Word ']')) +angles :: Semigroup d => DocFrom (Word Char) d => d -> d +angles = between (docFrom (Word '<')) (docFrom (Word '>')) + +-- * Class 'Splitable' +class (Lengthable d, Monoid d) => Splitable d where + tail :: d -> Maybe d + break :: (Char -> Bool) -> d -> (d, d) + span :: (Char -> Bool) -> d -> (d, d) + span f = break (not . f) + lines :: d -> [Line d] + words :: d -> [Word d] + linesNoEmpty :: d -> [Line d] + wordsNoEmpty :: d -> [Word d] + lines = (Line <$>) . splitOnChar (== '\n') + words = (Word <$>) . splitOnChar (== ' ') + linesNoEmpty = (Line <$>) . splitOnCharNoEmpty (== '\n') + wordsNoEmpty = (Word <$>) . splitOnCharNoEmpty (== ' ') + + splitOnChar :: (Char -> Bool) -> d -> [d] + splitOnChar f d0 = + if nullLength d0 then [] else go d0 + where + go d = + let (l,r) = f`break`d in + l : case tail r of + Nothing -> [] + Just rt | nullLength rt -> [mempty] + | otherwise -> go rt + splitOnCharNoEmpty :: (Char -> Bool) -> d -> [d] + splitOnCharNoEmpty f d = + let (l,r) = f`break`d in + (if nullLength l then [] else [l]) <> + case tail r of + Nothing -> [] + Just rt -> splitOnCharNoEmpty f rt +instance Splitable String where + tail [] = Nothing + tail s = Just $ List.tail s + break = List.break +instance Splitable Text.Text where + tail "" = Nothing + tail s = Just $ Text.tail s + break = Text.break +instance Splitable TL.Text where + tail "" = Nothing + tail s = Just $ TL.tail s + break = TL.break + +-- * Class 'Decorable' +class Decorable d where + bold :: d -> d + underline :: d -> d + italic :: d -> d + default bold :: Decorable (UnTrans d) => Trans d => d -> d + default underline :: Decorable (UnTrans d) => Trans d => d -> d + default italic :: Decorable (UnTrans d) => Trans d => d -> d + bold = noTrans1 bold + underline = noTrans1 underline + italic = noTrans1 italic + +-- * Class 'Colorable16' +class Colorable16 d where + reverse :: d -> d + + -- Foreground colors + -- Dull + black :: d -> d + red :: d -> d + green :: d -> d + yellow :: d -> d + blue :: d -> d + magenta :: d -> d + cyan :: d -> d + white :: d -> d + + -- Vivid + blacker :: d -> d + redder :: d -> d + greener :: d -> d + yellower :: d -> d + bluer :: d -> d + magentaer :: d -> d + cyaner :: d -> d + whiter :: d -> d + + -- Background colors + -- Dull + onBlack :: d -> d + onRed :: d -> d + onGreen :: d -> d + onYellow :: d -> d + onBlue :: d -> d + onMagenta :: d -> d + onCyan :: d -> d + onWhite :: d -> d + + -- Vivid + onBlacker :: d -> d + onRedder :: d -> d + onGreener :: d -> d + onYellower :: d -> d + onBluer :: d -> d + onMagentaer :: d -> d + onCyaner :: d -> d + onWhiter :: d -> d + + default reverse :: Colorable16 (UnTrans d) => Trans d => d -> d + default black :: Colorable16 (UnTrans d) => Trans d => d -> d + default red :: Colorable16 (UnTrans d) => Trans d => d -> d + default green :: Colorable16 (UnTrans d) => Trans d => d -> d + default yellow :: Colorable16 (UnTrans d) => Trans d => d -> d + default blue :: Colorable16 (UnTrans d) => Trans d => d -> d + default magenta :: Colorable16 (UnTrans d) => Trans d => d -> d + default cyan :: Colorable16 (UnTrans d) => Trans d => d -> d + default white :: Colorable16 (UnTrans d) => Trans d => d -> d + default blacker :: Colorable16 (UnTrans d) => Trans d => d -> d + default redder :: Colorable16 (UnTrans d) => Trans d => d -> d + default greener :: Colorable16 (UnTrans d) => Trans d => d -> d + default yellower :: Colorable16 (UnTrans d) => Trans d => d -> d + default bluer :: Colorable16 (UnTrans d) => Trans d => d -> d + default magentaer :: Colorable16 (UnTrans d) => Trans d => d -> d + default cyaner :: Colorable16 (UnTrans d) => Trans d => d -> d + default whiter :: Colorable16 (UnTrans d) => Trans d => d -> d + default onBlack :: Colorable16 (UnTrans d) => Trans d => d -> d + default onRed :: Colorable16 (UnTrans d) => Trans d => d -> d + default onGreen :: Colorable16 (UnTrans d) => Trans d => d -> d + default onYellow :: Colorable16 (UnTrans d) => Trans d => d -> d + default onBlue :: Colorable16 (UnTrans d) => Trans d => d -> d + default onMagenta :: Colorable16 (UnTrans d) => Trans d => d -> d + default onCyan :: Colorable16 (UnTrans d) => Trans d => d -> d + default onWhite :: Colorable16 (UnTrans d) => Trans d => d -> d + default onBlacker :: Colorable16 (UnTrans d) => Trans d => d -> d + default onRedder :: Colorable16 (UnTrans d) => Trans d => d -> d + default onGreener :: Colorable16 (UnTrans d) => Trans d => d -> d + default onYellower :: Colorable16 (UnTrans d) => Trans d => d -> d + default onBluer :: Colorable16 (UnTrans d) => Trans d => d -> d + default onMagentaer :: Colorable16 (UnTrans d) => Trans d => d -> d + default onCyaner :: Colorable16 (UnTrans d) => Trans d => d -> d + default onWhiter :: Colorable16 (UnTrans d) => Trans d => d -> d + + reverse = noTrans1 reverse + black = noTrans1 black + red = noTrans1 red + green = noTrans1 green + yellow = noTrans1 yellow + blue = noTrans1 blue + magenta = noTrans1 magenta + cyan = noTrans1 cyan + white = noTrans1 white + blacker = noTrans1 blacker + redder = noTrans1 redder + greener = noTrans1 greener + yellower = noTrans1 yellower + bluer = noTrans1 bluer + magentaer = noTrans1 magentaer + cyaner = noTrans1 cyaner + whiter = noTrans1 whiter + onBlack = noTrans1 onBlack + onRed = noTrans1 onRed + onGreen = noTrans1 onGreen + onYellow = noTrans1 onYellow + onBlue = noTrans1 onBlue + onMagenta = noTrans1 onMagenta + onCyan = noTrans1 onCyan + onWhite = noTrans1 onWhite + onBlacker = noTrans1 onBlacker + onRedder = noTrans1 onRedder + onGreener = noTrans1 onGreener + onYellower = noTrans1 onYellower + onBluer = noTrans1 onBluer + onMagentaer = noTrans1 onMagentaer + onCyaner = noTrans1 onCyaner + onWhiter = noTrans1 onWhiter + +-- | For debugging purposes. +instance Colorable16 String where + reverse = xmlSGR "reverse" + black = xmlSGR "black" + red = xmlSGR "red" + green = xmlSGR "green" + yellow = xmlSGR "yellow" + blue = xmlSGR "blue" + magenta = xmlSGR "magenta" + cyan = xmlSGR "cyan" + white = xmlSGR "white" + blacker = xmlSGR "blacker" + redder = xmlSGR "redder" + greener = xmlSGR "greener" + yellower = xmlSGR "yellower" + bluer = xmlSGR "bluer" + magentaer = xmlSGR "magentaer" + cyaner = xmlSGR "cyaner" + whiter = xmlSGR "whiter" + onBlack = xmlSGR "onBlack" + onRed = xmlSGR "onRed" + onGreen = xmlSGR "onGreen" + onYellow = xmlSGR "onYellow" + onBlue = xmlSGR "onBlue" + onMagenta = xmlSGR "onMagenta" + onCyan = xmlSGR "onCyan" + onWhite = xmlSGR "onWhite" + onBlacker = xmlSGR "onBlacker" + onRedder = xmlSGR "onRedder" + onGreener = xmlSGR "onGreener" + onYellower = xmlSGR "onYellower" + onBluer = xmlSGR "onBluer" + onMagentaer = xmlSGR "onMagentaer" + onCyaner = xmlSGR "onCyaner" + onWhiter = xmlSGR "onWhiter" + +-- | For debugging purposes. +xmlSGR :: Semigroup d => DocFrom String d => String -> d -> d +xmlSGR newSGR s = docFrom ("<"<>newSGR<>">")<>s<>docFrom ("newSGR<>">") + +-- * Class 'Indentable' +class Spaceable d => Indentable d where + -- | @('align' d)@ make @d@ uses current 'Column' as 'Indent' level. + align :: d -> d + -- | @('incrIndent' ind d)@ make @d@ uses current 'Indent' plus @ind@ as 'Indent' level. + incrIndent :: Indent -> d -> d + -- | @('setIndent' ind d)@ make @d@ uses @ind@ as 'Indent' level. + setIndent :: Indent -> d -> d + -- | @('hang' ind d)@ make @d@ uses current 'Column' plus @ind@ as 'Indent' level. + hang :: Indent -> d -> d + hang ind = align . incrIndent ind + -- | @('fill' w d)@ write @d@, + -- then if @d@ is not wider than @w@, + -- write the difference with 'spaces'. + fill :: Width -> d -> d + -- | @('breakfill' w d)@ write @d@, + -- then if @d@ is not wider than @w@, write the difference with 'spaces' + -- otherwise write a 'newline' indented to to the start 'Column' of @d@ plus @w@. + breakfill :: Width -> d -> d + + default align :: Indentable (UnTrans d) => Trans d => d -> d + default incrIndent :: Indentable (UnTrans d) => Trans d => Indent -> d -> d + default setIndent :: Indentable (UnTrans d) => Trans d => Indent -> d -> d + default fill :: Indentable (UnTrans d) => Trans d => Width -> d -> d + default breakfill :: Indentable (UnTrans d) => Trans d => Width -> d -> d + + align = noTrans1 align + incrIndent = noTrans1 . incrIndent + setIndent = noTrans1 . setIndent + fill = noTrans1 . fill + breakfill = noTrans1 . breakfill + +-- * Class 'Wrappable' +class Wrappable d where + setWidth :: Maybe Width -> d -> d + -- getWidth :: (Maybe Width -> d) -> d + breakpoint :: d + breakspace :: d + breakalt :: d -> d -> d + default breakpoint :: Wrappable (UnTrans d) => Trans d => d + default breakspace :: Wrappable (UnTrans d) => Trans d => d + default breakalt :: Wrappable (UnTrans d) => Trans d => d -> d -> d + breakpoint = noTrans breakpoint + breakspace = noTrans breakspace + breakalt = noTrans2 breakalt + +-- * Class 'Justifiable' +class Justifiable d where + justify :: d -> d + +-- * Class 'Trans' +class Trans repr where + -- | Return the underlying @repr@ of the transformer. + type UnTrans repr :: * + + -- | Lift a repr to the transformer's. + noTrans :: UnTrans repr -> repr + -- | Unlift a repr from the transformer's. + unTrans :: repr -> UnTrans repr + + -- | Identity transformation for a unary symantic method. + noTrans1 :: (UnTrans repr -> UnTrans repr) -> (repr -> repr) + noTrans1 f = noTrans . f . unTrans + + -- | Identity transformation for a binary symantic method. + noTrans2 + :: (UnTrans repr -> UnTrans repr -> UnTrans repr) + -> (repr -> repr -> repr) + noTrans2 f a b = noTrans (f (unTrans a) (unTrans b)) + + -- | Identity transformation for a ternary symantic method. + noTrans3 + :: (UnTrans repr -> UnTrans repr -> UnTrans repr -> UnTrans repr) + -> (repr -> repr -> repr -> repr) + noTrans3 f a b c = noTrans (f (unTrans a) (unTrans b) (unTrans c)) diff --git a/Symantic/Document/AnsiText.hs b/Symantic/Document/AnsiText.hs new file mode 100644 index 0000000..485e7b6 --- /dev/null +++ b/Symantic/Document/AnsiText.hs @@ -0,0 +1,211 @@ +{-# LANGUAGE UndecidableInstances #-} +module Symantic.Document.AnsiText where + +import Control.Applicative (Applicative(..), liftA2) +import Control.Monad (Monad(..)) +import Control.Monad.Trans.Reader +import Data.Bool +import Data.Char (Char) +import Data.Function (($), (.), id) +import Data.Functor ((<$>)) +import Data.Monoid (Monoid(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String, IsString(..)) +import Data.Text (Text) +import System.Console.ANSI +import qualified Data.List as List +import qualified Data.Text.Lazy as TL + +import Symantic.Document.API + +-- * Type 'AnsiText' +newtype AnsiText d = AnsiText { unAnsiText :: Reader [SGR] d } + +ansiText :: AnsiText d -> AnsiText d +ansiText = id + +runAnsiText :: AnsiText d -> d +runAnsiText (AnsiText d) = (`runReader` []) d + +instance DocFrom Char d => DocFrom Char (AnsiText d) where + docFrom = AnsiText . return . docFrom +instance DocFrom String d => DocFrom String (AnsiText d) where + docFrom = AnsiText . return . docFrom +instance DocFrom Text d => DocFrom Text (AnsiText d) where + docFrom = AnsiText . return . docFrom +instance DocFrom TL.Text d => DocFrom TL.Text (AnsiText d) where + docFrom = AnsiText . return . docFrom +instance DocFrom s (AnsiText d) => DocFrom (Line s) (AnsiText d) where + docFrom = docFrom . unLine +instance DocFrom s (AnsiText d) => DocFrom (Word s) (AnsiText d) where + docFrom = docFrom . unWord +instance DocFrom String d => IsString (AnsiText d) where + fromString = docFrom +instance Semigroup d => Semigroup (AnsiText d) where + AnsiText x <> AnsiText y = AnsiText $ liftA2 (<>) x y +instance Monoid d => Monoid (AnsiText d) where + mempty = AnsiText (return mempty) + mappend = (<>) +instance Lengthable d => Lengthable (AnsiText d) where + -- NOTE: AnsiText's Reader can be run with an empty value + -- because all 'SGR' are ignored anyway. + length (AnsiText ds) = length $ runReader ds mempty + nullLength (AnsiText ds) = nullLength $ runReader ds mempty +instance Spaceable d => Spaceable (AnsiText d) where + newline = AnsiText $ return newline + space = AnsiText $ return space + spaces = AnsiText . return . spaces +instance (Semigroup d, DocFrom [SGR] d) => Colorable16 (AnsiText d) where + reverse = ansiTextSGR $ SetSwapForegroundBackground True + black = ansiTextSGR $ SetColor Foreground Dull Black + red = ansiTextSGR $ SetColor Foreground Dull Red + green = ansiTextSGR $ SetColor Foreground Dull Green + yellow = ansiTextSGR $ SetColor Foreground Dull Yellow + blue = ansiTextSGR $ SetColor Foreground Dull Blue + magenta = ansiTextSGR $ SetColor Foreground Dull Magenta + cyan = ansiTextSGR $ SetColor Foreground Dull Cyan + white = ansiTextSGR $ SetColor Foreground Dull White + blacker = ansiTextSGR $ SetColor Foreground Vivid Black + redder = ansiTextSGR $ SetColor Foreground Vivid Red + greener = ansiTextSGR $ SetColor Foreground Vivid Green + yellower = ansiTextSGR $ SetColor Foreground Vivid Yellow + bluer = ansiTextSGR $ SetColor Foreground Vivid Blue + magentaer = ansiTextSGR $ SetColor Foreground Vivid Magenta + cyaner = ansiTextSGR $ SetColor Foreground Vivid Cyan + whiter = ansiTextSGR $ SetColor Foreground Vivid White + onBlack = ansiTextSGR $ SetColor Background Dull Black + onRed = ansiTextSGR $ SetColor Background Dull Red + onGreen = ansiTextSGR $ SetColor Background Dull Green + onYellow = ansiTextSGR $ SetColor Background Dull Yellow + onBlue = ansiTextSGR $ SetColor Background Dull Blue + onMagenta = ansiTextSGR $ SetColor Background Dull Magenta + onCyan = ansiTextSGR $ SetColor Background Dull Cyan + onWhite = ansiTextSGR $ SetColor Background Dull White + onBlacker = ansiTextSGR $ SetColor Background Vivid Black + onRedder = ansiTextSGR $ SetColor Background Vivid Red + onGreener = ansiTextSGR $ SetColor Background Vivid Green + onYellower = ansiTextSGR $ SetColor Background Vivid Yellow + onBluer = ansiTextSGR $ SetColor Background Vivid Blue + onMagentaer = ansiTextSGR $ SetColor Background Vivid Magenta + onCyaner = ansiTextSGR $ SetColor Background Vivid Cyan + onWhiter = ansiTextSGR $ SetColor Background Vivid White +instance (Semigroup d, DocFrom [SGR] d) => Decorable (AnsiText d) where + bold = ansiTextSGR $ SetConsoleIntensity BoldIntensity + underline = ansiTextSGR $ SetUnderlining SingleUnderline + italic = ansiTextSGR $ SetItalicized True +instance Justifiable d => Justifiable (AnsiText d) where + justify (AnsiText d) = AnsiText $ justify <$> d +instance Indentable d => Indentable (AnsiText d) where + setIndent i (AnsiText d) = AnsiText $ setIndent i <$> d + incrIndent i (AnsiText d) = AnsiText $ incrIndent i <$> d + fill w (AnsiText d) = AnsiText $ fill w <$> d + breakfill w (AnsiText d) = AnsiText $ breakfill w <$> d + align (AnsiText d) = AnsiText $ align <$> d +instance Wrappable d => Wrappable (AnsiText d) where + setWidth w (AnsiText d) = AnsiText $ setWidth w <$> d + breakpoint = AnsiText $ return breakpoint + breakspace = AnsiText $ return breakspace + breakalt (AnsiText x) (AnsiText y) = AnsiText $ liftA2 breakalt x y + +ansiTextSGR :: + Semigroup d => DocFrom [SGR] d => + SGR -> AnsiText d -> AnsiText d +ansiTextSGR newSGR (AnsiText d) = AnsiText $ do + oldSGR <- ask + (\m -> docFrom [newSGR] <> m <> docFrom (Reset:List.reverse oldSGR)) + <$> local (newSGR :) d + +-- * Type 'PlainText' +-- | Drop 'Colorable16' and 'Decorable'. +newtype PlainText d = PlainText { unPlainText :: d } + +plainText :: PlainText d -> PlainText d +plainText = id + +runPlainText :: PlainText d -> d +runPlainText (PlainText d) = d + +instance DocFrom Char d => DocFrom Char (PlainText d) where + docFrom = PlainText . docFrom +instance DocFrom String d => DocFrom String (PlainText d) where + docFrom = PlainText . docFrom +instance DocFrom Text d => DocFrom Text (PlainText d) where + docFrom = PlainText . docFrom +instance DocFrom TL.Text d => DocFrom TL.Text (PlainText d) where + docFrom = PlainText . docFrom +instance DocFrom s (PlainText d) => DocFrom (Line s) (PlainText d) where + docFrom = docFrom . unLine +instance DocFrom s (PlainText d) => DocFrom (Word s) (PlainText d) where + docFrom = docFrom . unWord +instance DocFrom String d => IsString (PlainText d) where + fromString = docFrom +instance Semigroup d => Semigroup (PlainText d) where + PlainText x <> PlainText y = PlainText $ (<>) x y +instance Monoid d => Monoid (PlainText d) where + mempty = PlainText mempty + mappend = (<>) +instance Lengthable d => Lengthable (PlainText d) where + -- NOTE: PlainText's Reader can be run with an empty value + -- because all 'SGR' are ignored anyway. + length (PlainText ds) = length ds + nullLength (PlainText ds) = nullLength ds +instance Spaceable d => Spaceable (PlainText d) where + newline = PlainText $ newline + space = PlainText $ space + spaces = PlainText . spaces +instance Semigroup d => Colorable16 (PlainText d) where + reverse = plainTextSGR + black = plainTextSGR + red = plainTextSGR + green = plainTextSGR + yellow = plainTextSGR + blue = plainTextSGR + magenta = plainTextSGR + cyan = plainTextSGR + white = plainTextSGR + blacker = plainTextSGR + redder = plainTextSGR + greener = plainTextSGR + yellower = plainTextSGR + bluer = plainTextSGR + magentaer = plainTextSGR + cyaner = plainTextSGR + whiter = plainTextSGR + onBlack = plainTextSGR + onRed = plainTextSGR + onGreen = plainTextSGR + onYellow = plainTextSGR + onBlue = plainTextSGR + onMagenta = plainTextSGR + onCyan = plainTextSGR + onWhite = plainTextSGR + onBlacker = plainTextSGR + onRedder = plainTextSGR + onGreener = plainTextSGR + onYellower = plainTextSGR + onBluer = plainTextSGR + onMagentaer = plainTextSGR + onCyaner = plainTextSGR + onWhiter = plainTextSGR +instance (Semigroup d, DocFrom [SGR] d) => Decorable (PlainText d) where + bold = plainTextSGR + underline = plainTextSGR + italic = plainTextSGR +instance Justifiable d => Justifiable (PlainText d) where + justify (PlainText d) = PlainText $ justify d +instance Indentable d => Indentable (PlainText d) where + setIndent i (PlainText d) = PlainText $ setIndent i d + incrIndent i (PlainText d) = PlainText $ incrIndent i d + fill w (PlainText d) = PlainText $ fill w d + breakfill w (PlainText d) = PlainText $ breakfill w d + align (PlainText d) = PlainText $ align d +instance Wrappable d => Wrappable (PlainText d) where + setWidth w (PlainText d) = PlainText $ setWidth w d + breakpoint = PlainText breakpoint + breakspace = PlainText breakspace + breakalt (PlainText x) (PlainText y) = PlainText $ breakalt x y + +plainTextSGR :: + Semigroup d => + PlainText d -> PlainText d +plainTextSGR (PlainText d) = PlainText d diff --git a/Symantic/Document/HLint.hs b/Symantic/Document/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/Symantic/Document/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/Symantic/Document/Plain.hs b/Symantic/Document/Plain.hs new file mode 100644 index 0000000..343cb42 --- /dev/null +++ b/Symantic/Document/Plain.hs @@ -0,0 +1,447 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE UndecidableInstances #-} +module Symantic.Document.Plain where + +import Data.Bool +import Data.Char (Char) +import Data.Eq (Eq(..)) +import Data.Foldable (foldr) +import Data.Function (($), (.), id) +import Data.Functor ((<$>)) +import Data.Maybe (Maybe(..)) +import Data.Monoid (Monoid(..)) +import Data.Ord (Ord(..), Ordering(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String, IsString(..)) +import Data.Text (Text) +import GHC.Natural (minusNatural,quotRemNatural) +import Numeric.Natural (Natural) +import Prelude (fromIntegral, Num(..)) +import System.Console.ANSI +import Text.Show (Show(..), showString, showParen) +import qualified Data.List as List +import qualified Data.Text.Lazy as TL + +import Symantic.Document.API + +-- * Type 'Plain' +-- | Church encoded for performance concerns. +-- Kind like 'ParsecT' in @megaparsec@ but a little bit different +-- due to the use of 'PlainFit' for implementing 'breakingSpace' correctly +-- when in the left hand side of ('<>'). +-- Prepending is done using continuation, like in a difference list. +newtype Plain d = Plain + { unPlain :: + {-curr-}PlainInh -> + {-curr-}PlainState d -> + {-ok-}( ({-prepend-}(d->d), {-new-}PlainState d) -> PlainFit d) -> + PlainFit d + -- NOTE: equivalent to: + -- ReaderT PlainInh (StateT (PlainState d) (Cont (PlainFit d))) (d->d) + } + +runPlain :: Monoid d => Plain d -> d +runPlain x = + unPlain x + defPlainInh + defPlainState + {-k-}(\(px,_sx) fits _overflow -> + -- NOTE: if px fits, then appending mempty fits + fits (px mempty) ) + {-fits-}id + {-overflow-}id + +-- ** Type 'PlainState' +data PlainState d = PlainState + { plainState_buffer :: ![PlainChunk d] + , plainState_bufferStart :: !Column + , plainState_bufferWidth :: !Width + , plainState_removableIndent :: !Indent + -- ^ The amount of 'Indent' added by 'breakspace' + -- that can be removed by breaking the 'space' into a 'newline'. + } deriving (Show) + +defPlainState :: PlainState d +defPlainState = PlainState + { plainState_buffer = mempty + , plainState_bufferStart = 0 + , plainState_bufferWidth = 0 + , plainState_removableIndent = 0 + } + +-- ** Type 'PlainInh' +data PlainInh = PlainInh + { plainInh_width :: !(Maybe Column) + , plainInh_justify :: !Bool + , plainInh_indent :: !Width + } deriving (Show) + +defPlainInh :: PlainInh +defPlainInh = PlainInh + { plainInh_width = Nothing + , plainInh_justify = False + , plainInh_indent = 0 + } + +-- ** Type 'PlainFit' +-- | Double continuation to qualify the returned document +-- as fitting or overflowing the given 'plainInh_width'. +-- It's like @('Bool',d)@ in a normal style +-- (a non continuation-passing-style). +type PlainFit d = {-fits-}(d -> d) -> + {-overflow-}(d -> d) -> + d + +-- ** Type 'PlainChunk' +data PlainChunk d + = PlainChunk_Ignored d + -- ^ Ignored by the justification but kept in place. + -- Used for instance to put ANSI sequences. + | PlainChunk_Word (Word d) + | PlainChunk_Spaces Width + -- ^ 'spaces' preserved to be interleaved + -- correctly with 'PlainChunk_Ignored'. +instance Show d => Show (PlainChunk d) where + showsPrec p x = + showParen (p>10) $ + case x of + PlainChunk_Ignored d -> + showString "Z " . + showsPrec 11 d + PlainChunk_Word (Word d) -> + showString "W " . + showsPrec 11 d + PlainChunk_Spaces s -> + showString "S " . + showsPrec 11 s +instance Lengthable d => Lengthable (PlainChunk d) where + length = \case + PlainChunk_Ignored{} -> 0 + PlainChunk_Word d -> length d + PlainChunk_Spaces s -> s + nullLength = \case + PlainChunk_Ignored{} -> True + PlainChunk_Word d -> nullLength d + PlainChunk_Spaces s -> s == 0 +instance DocFrom [SGR] d => DocFrom [SGR] (PlainChunk d) where + docFrom sgr = PlainChunk_Ignored (docFrom sgr) + +runPlainChunk :: Spaceable d => PlainChunk d -> d +runPlainChunk = \case + PlainChunk_Ignored d -> d + PlainChunk_Word (Word d) -> d + PlainChunk_Spaces s -> spaces s + +instance Semigroup d => Semigroup (Plain d) where + Plain x <> Plain y = Plain $ \inh st k -> + x inh st $ \(px,sx) -> + y inh sx $ \(py,sy) -> + k (px.py,sy) +instance Monoid d => Monoid (Plain d) where + mempty = Plain $ \_inh st k -> k (id,st) + mappend = (<>) +instance (Spaceable d) => Spaceable (Plain d) where + newline = Plain $ \inh st k -> + k(\next -> + (if plainInh_justify inh then joinLine inh st else mempty) <> + newline<>spaces (plainInh_indent inh)<>next + , st + { plainState_bufferStart = plainInh_indent inh + , plainState_bufferWidth = 0 + , plainState_buffer = mempty + } + ) + space = spaces 1 + spaces n = Plain $ \inh st@PlainState{..} k fits overflow -> + let newWidth = plainState_bufferStart + plainState_bufferWidth + n in + if plainInh_justify inh + then + let newState = + case plainState_buffer of + PlainChunk_Spaces s:bs -> st + { plainState_buffer = PlainChunk_Spaces (s+n):bs + } + _ -> st + { plainState_buffer = PlainChunk_Spaces n:plainState_buffer + , plainState_bufferWidth = plainState_bufferWidth + 1 + } + in + case plainInh_width inh of + Just width | width < newWidth -> + overflow $ k (id{-(d<>)-}, newState) fits overflow + _ -> k (id{-(d<>)-}, newState) fits overflow + else + let newState = st + { plainState_bufferWidth = plainState_bufferWidth + n + } in + case plainInh_width inh of + Just width | width < newWidth -> + overflow $ k ((spaces n <>), newState) fits fits + _ -> k ((spaces n <>), newState) fits overflow +instance (DocFrom (Word s) d, Semigroup d, Lengthable s) => DocFrom (Word s) (Plain d) where + docFrom s = Plain $ \inh st@PlainState{..} k fits overflow -> + let wordLen = length s in + if wordLen <= 0 + then k (id,st) fits overflow + else + let newBufferWidth = plainState_bufferWidth + wordLen in + let newWidth = plainState_bufferStart + newBufferWidth in + if plainInh_justify inh + then + let newState = st + { plainState_buffer = + PlainChunk_Word (Word (docFrom s)) : + plainState_buffer + , plainState_bufferWidth = newBufferWidth + } in + case plainInh_width inh of + Just width | width < newWidth -> + overflow $ k (id, newState) fits overflow + _ -> k (id, newState) fits overflow + else + let newState = st + { plainState_bufferWidth = newBufferWidth + } in + case plainInh_width inh of + Just width | width < newWidth -> + overflow $ k ((docFrom s <>), newState) fits fits + _ -> k ((docFrom s <>), newState) fits overflow +instance (DocFrom (Word s) d, Lengthable s, Spaceable d, Splitable s) => + DocFrom (Line s) (Plain d) where + docFrom = + mconcat . + List.intersperse breakspace . + (docFrom <$>) . + words . + unLine +instance Spaceable d => Indentable (Plain d) where + align p = Plain $ \inh st -> + let currInd = plainState_bufferStart st + plainState_bufferWidth st in + unPlain p inh{plainInh_indent=currInd} st + incrIndent i p = Plain $ \inh -> + unPlain p inh{plainInh_indent = plainInh_indent inh + i} + setIndent i p = Plain $ \inh -> + unPlain p inh{plainInh_indent=i} + fill m p = Plain $ \inh0 st0 -> + let col0 = plainState_bufferStart st0 + plainState_bufferWidth st0 in + let p1 = Plain $ \inh1 st1 -> + let col1 = plainState_bufferStart st1 + plainState_bufferWidth st1 in + let w | col0 <= col1 = col1`minusNatural`col0 + | otherwise = col0`minusNatural`col1 in + unPlain + (if w<=m + then spaces (m`minusNatural`w) + else mempty) + inh1 st1 + in + unPlain (p <> p1) inh0 st0 + breakfill m p = Plain $ \inh0 st0 -> + let col0 = plainState_bufferStart st0 + plainState_bufferWidth st0 in + let p1 = Plain $ \inh1 st1 -> + let col1 = plainState_bufferStart st1 + plainState_bufferWidth st1 in + let w | col0 <= col1 = col1`minusNatural`col0 + | otherwise = col0`minusNatural`col1 in + unPlain + (case w`compare`m of + LT -> spaces (m`minusNatural`w) + EQ -> mempty + GT -> setIndent (col0 + m) newline) + inh1 st1 + in + unPlain (p <> p1) inh0 st0 +instance Spaceable d => Justifiable (Plain d) where + justify p = (<> flushLastLine) $ Plain $ \inh -> + unPlain p inh{plainInh_justify=True} + where + flushLastLine :: Plain d + flushLastLine = Plain $ \_inh st@PlainState{..} ok -> + ok + ( (joinPlainLine (collapseSpaces <$> List.reverse plainState_buffer) <>) + , st + { plainState_bufferStart = plainState_bufferStart + plainState_bufferWidth + , plainState_bufferWidth = 0 + , plainState_buffer = mempty + } + ) + collapseSpaces = \case + PlainChunk_Spaces s -> PlainChunk_Spaces (if s > 0 then 1 else 0) + x -> x +instance (Spaceable d) => Wrappable (Plain d) where + setWidth w p = Plain $ \inh -> + unPlain p inh{plainInh_width=w} + breakpoint = Plain $ \inh st k fits overflow -> + let newlineInd = plainInh_indent inh in + k + ( id + , st + { plainState_removableIndent = newlineInd + } + ) + fits + {-overflow-}(\_r -> + unPlain newline inh st k + fits + {-overflow-}( + if plainState_removableIndent st < newlineInd + then overflow + else fits + ) + ) + breakspace = Plain $ \inh st k fits overflow -> + let newlineInd = plainInh_indent inh in + k + ( if plainInh_justify inh then id else (space <>) + , st + { plainState_buffer = + case plainState_buffer st of + PlainChunk_Spaces s:bs -> PlainChunk_Spaces (s+1):bs + bs -> PlainChunk_Spaces 1:bs + , plainState_bufferWidth = plainState_bufferWidth st + 1 + , plainState_removableIndent = newlineInd + } + ) + fits + {-overflow-}(\_r -> + unPlain newline inh st k + fits + {-overflow-}( + if plainState_removableIndent st < newlineInd + then overflow + else fits + ) + ) + breakalt x y = Plain $ \inh st k fits overflow -> + unPlain x inh st k fits + {-overflow-}(\_r -> + unPlain y inh st k fits overflow + ) +-- String +instance (DocFrom (Word String) d, Spaceable d) => + DocFrom String (Plain d) where + docFrom = + mconcat . + List.intersperse newline . + (docFrom <$>) . + lines +instance (DocFrom (Word String) d, Spaceable d) => + IsString (Plain d) where + fromString = docFrom +-- Text +instance (DocFrom (Word Text) d, Spaceable d) => + DocFrom Text (Plain d) where + docFrom = + mconcat . + List.intersperse newline . + (docFrom <$>) . + lines +instance (DocFrom (Word TL.Text) d, Spaceable d) => + DocFrom TL.Text (Plain d) where + docFrom = + mconcat . + List.intersperse newline . + (docFrom <$>) . + lines +-- Char +instance (DocFrom (Word Char) d, Spaceable d) => + DocFrom Char (Plain d) where + docFrom ' ' = breakspace + docFrom '\n' = newline + docFrom c = docFrom (Word c) + + +instance (DocFrom [SGR] d, Semigroup d) => DocFrom [SGR] (Plain d) where + docFrom sgr = Plain $ \inh st k -> + if plainInh_justify inh + then k (id, st {plainState_buffer = PlainChunk_Ignored (docFrom sgr) : plainState_buffer st}) + else k ((docFrom sgr <>), st) + +joinLine :: + Spaceable d => + PlainInh -> PlainState d -> d +joinLine PlainInh{..} PlainState{..} = + case plainInh_width of + Nothing -> joinPlainLine $ List.reverse plainState_buffer + Just width -> + if width < plainState_bufferStart + || width < plainInh_indent + then joinPlainLine $ List.reverse plainState_buffer + else + let wordCount = + foldr (\c acc -> acc + case c of + PlainChunk_Word{} -> 1 + _ -> 0) 0 plainState_buffer in + let bufferWidth = + -- NOTE: compress all separated spaces into a single one. + if wordCount == 0 + then 0 + else + let spaceCount = foldr + (\c acc -> + acc + case c of + PlainChunk_Ignored{} -> 0 + PlainChunk_Word{} -> 0 + PlainChunk_Spaces s -> s) + 0 plainState_buffer in + (plainState_bufferWidth`minusNatural`spaceCount) + + (wordCount`minusNatural`1) in + let adjustedWidth = + max bufferWidth $ + min + (width`minusNatural`plainState_bufferStart) + (width`minusNatural`plainInh_indent) in + unLine $ padPlainLineInits adjustedWidth + (bufferWidth,wordCount,List.reverse plainState_buffer) + +-- | @('justifyPadding' a b)@ returns the padding lengths +-- to reach @(a)@ in @(b)@ pads, +-- using the formula: @(a '==' m'*'(q '+' q'+'1) '+' ('r'-'m)'*'(q'+'1) '+' (b'-'r'-'m)'*'q)@ +-- where @(q+1)@ and @(q)@ are the two padding lengths used and @(m = min (b-r) r)@. +-- +-- A simple implementation of 'justifyPadding' could be: +-- @ +-- 'justifyPadding' a b = +-- 'join' ('List.replicate' m [q,q'+'1]) +-- <> ('List.replicate' (r'-'m) (q'+'1) +-- <> ('List.replicate' ((b'-'r)'-'m) q +-- where +-- (q,r) = a`divMod`b +-- m = 'min' (b-r) r +-- @ +justifyPadding :: Natural -> Natural -> [Natural] +justifyPadding a b = go r (b-r) -- NOTE: r >= 0 && b-r >= 0 due to 'divMod' + where + (q,r) = a`quotRemNatural`b + + go 0 bmr = List.replicate (fromIntegral bmr) q -- when min (b-r) r == b-r + go rr 0 = List.replicate (fromIntegral rr) (q+1) -- when min (b-r) r == r + go rr bmr = q:(q+1) : go (rr`minusNatural`1) (bmr`minusNatural`1) + +padPlainLineInits :: + Spaceable d => + Width -> (Natural, Natural, [PlainChunk d]) -> Line d +padPlainLineInits width (lineLen,wordCount,line) = Line $ + if width <= lineLen + -- The gathered line reached or overreached the width, + -- hence no padding id needed. + || wordCount <= 1 + -- The case width <= lineLen && wordCount == 1 + -- can happen if first word's length is < width + -- but second word's len is >= width. + then joinPlainLine line + else + -- Share the missing spaces as evenly as possible + -- between the words of the line. + padPlainLine line $ justifyPadding (width-lineLen) (wordCount-1) + +joinPlainLine :: Monoid d => Spaceable d => [PlainChunk d] -> d +joinPlainLine = mconcat . (runPlainChunk <$>) + +padPlainLine :: Spaceable d => [PlainChunk d] -> [Width] -> d +padPlainLine = go + where + go (w:ws) lls@(l:ls) = + case w of + PlainChunk_Spaces _s -> spaces (fromIntegral (l+1)) <> go ws ls + _ -> runPlainChunk w <> go ws lls + go (w:ws) [] = runPlainChunk w <> go ws [] + go [] _ls = mempty diff --git a/Symantic/HLint.hs b/Symantic/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/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..39ba440 --- /dev/null +++ b/stack.yaml @@ -0,0 +1,3 @@ +resolver: lts-13.19 +packages: +- '.' diff --git a/symantic-document.cabal b/symantic-document.cabal new file mode 100644 index 0000000..c24870d --- /dev/null +++ b/symantic-document.cabal @@ -0,0 +1,104 @@ +name: symantic-document +-- PVP: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 1.0.0.20190614 +category: Text +synopsis: Document symantics. +description: Symantics for generating documents. +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.4 +extra-source-files: + stack.yaml +extra-tmp-files: + +Source-Repository head + location: git://git.autogeree.net/symantic + type: git + +Library + exposed-modules: + Symantic.Document + Symantic.Document.API + Symantic.Document.AnsiText + Symantic.Document.Plain + default-language: Haskell2010 + default-extensions: + DataKinds + DefaultSignatures + FlexibleContexts + FlexibleInstances + LambdaCase + MultiParamTypeClasses + NamedFieldPuns + NoImplicitPrelude + OverloadedStrings + RecordWildCards + ScopedTypeVariables + StandaloneDeriving + TupleSections + TypeApplications + TypeFamilies + TypeOperators + ghc-options: + -Wall + -Wincomplete-uni-patterns + -Wincomplete-record-updates + -fno-warn-tabs + -fhide-source-paths + build-depends: + ansi-terminal >= 0.7 + , base >= 4.6 && < 5 + , text >= 1.2 + , transformers >= 0.5 + +Test-Suite symantic-document-test + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: Main.hs + other-modules: + HUnit + default-language: Haskell2010 + default-extensions: + DataKinds + FlexibleContexts + FlexibleInstances + LambdaCase + MultiParamTypeClasses + NoImplicitPrelude + NoMonomorphismRestriction + OverloadedStrings + RecordWildCards + ScopedTypeVariables + TupleSections + TypeApplications + TypeFamilies + TypeOperators + ghc-options: + -Wall + -Wincomplete-uni-patterns + -Wincomplete-record-updates + -fno-warn-tabs + -fhide-source-paths + -fprint-explicit-kinds + -- -O0 + -- -fmax-simplifier-iterations=0 + -- -dshow-passes + build-depends: + symantic-document + , base >= 4.6 && < 5 + , containers >= 0.5 + , tasty >= 0.11 + , tasty-hunit >= 0.9 + , text >= 1.2 + , transformers >= 0.5 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/HUnit.hs b/test/HUnit.hs new file mode 100644 index 0000000..1098b9c --- /dev/null +++ b/test/HUnit.hs @@ -0,0 +1,211 @@ +{-# LANGUAGE OverloadedStrings #-} +module HUnit where + +import Test.Tasty +import Test.Tasty.HUnit + +import Data.Foldable (Foldable(..)) +import Data.Function (($), (.)) +import Data.Functor ((<$>)) +import Data.Int (Int) +import Data.Maybe (Maybe(..)) +import Data.Monoid (Monoid(..)) +import Data.Ord (Ord(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String, IsString(..)) +import Prelude ((+)) +import Text.Show (Show(..)) +import qualified Data.List as List + +import Symantic.Document.API +import Symantic.Document.Plain +import Symantic.Document.AnsiText + +-- * Tests +hunits :: TestTree +hunits = testGroup "HUnit" $ + [ hunitPlain + ] + +hunitPlain :: TestTree +hunitPlain = testList "Plain" + [ newline ==> "\n" + , "hello\nworld" ==> "hello\nworld" + , 10`maxWidth` breakpoints ["hello", "world"] ==> "helloworld" + , 9`maxWidth` breakpoints ["hello", "world"] ==> "hello\nworld" + , 6`maxWidth` breakpoints ["he", "ll", "o!"] ==> "hello!" + , 6`maxWidth` breakpoints ["he", "ll", "o!", "wo", "rl", "d!"] ==> "hello!\nworld!" + , 5`maxWidth` breakpoints ["hello", "world"] ==> "hello\nworld" + , 5`maxWidth` breakpoints ["he", "llo", "world"] ==> "hello\nworld" + , 5`maxWidth` breakpoints ["he", "ll", "o!"] ==> "hell\no!" + , 4`maxWidth` breakpoints ["hello", "world"] ==> "hello\nworld" + , 4`maxWidth` breakpoints ["he", "ll", "o!"] ==> "hell\no!" + , 4`maxWidth` breakpoints ["he", "llo", "world"] ==> "he\nllo\nworld" + , 4`maxWidth` breakpoints ["he", "llo", "w", "orld"] ==> "he\nllow\norld" + , 4`maxWidth` breakpoints ["he", "ll", "o!", "wo", "rl", "d!"] ==> "hell\no!wo\nrld!" + , 3`maxWidth` breakpoints ["hello", "world"] ==> "hello\nworld" + , 3`maxWidth` breakpoints ["he", "ll"] ==> "he\nll" + , 3`maxWidth` breakpoints ["he", "ll", "o!"] ==> "he\nll\no!" + , 1`maxWidth` breakpoints ["he", "ll", "o!"] ==> "he\nll\no!" + , 4`maxWidth` mconcat ["__", align $ breakpoints ["he", "ll", "o!", "wo", "rl", "d!"]] + ==> "__he\n ll\n o!\n wo\n rl\n d!" + , 6`maxWidth` mconcat ["__", align $ breakpoints ["he", "ll", "o!", "wo", "rl", "d!"]] + ==> "__hell\n o!wo\n rld!" + , 16`maxWidth` mconcat ["__", listHorV ["hello", "world"]] ==> "__[hello, world]" + , 4`maxWidth` mconcat ["__", listHorV ["hello", "world"]] ==> "__[ hello\n , world\n ]" + , 11`maxWidth` breakspaces ["hello", "world"] ==> "hello world" + , 10`maxWidth` breakspaces ["hello", "world"] ==> "hello\nworld" + , 6`maxWidth` breakspaces ["hel", "lo", "wo", "rld"] ==> "hel lo\nwo rld" + , 6`maxWidth` breakspaces ["hel", "lo", "wo", "rld", "HEL", "LO", "WO", "RLD"] ==> "hel lo\nwo rld\nHEL LO\nWO RLD" + , 5`maxWidth` breakspaces ["hello", "world"] ==> "hello\nworld" + , 19`maxWidth` fun (fun $ fun $ fun $ fun $ listHorV ["abcdefg", "abcdefg"]) + ==> "function(function(\n function(\n function(\n function(\n [ abcdefg\n , abcdefg\n ]\n )\n )\n )\n ))" + , 19`maxWidth` fun (fun $ fun $ fun $ fun $ listHorV ["abcdefgh", "abcdefgh"]) + ==> "function(\n function(\n function(\n function(\n function(\n [ abcdefgh\n , abcdefgh\n ]\n )\n )\n )\n )\n )" + , 7`maxWidth` ("hello"<>breakspace<>"world") ==> "hello\nworld" + , 7`maxWidth` ("hello "<>"world") ==> "hello\nworld" + , " "<> "hello\nworld\n!" ==> " hello\nworld\n!" + , "__"<>align "hello\nworld\n!" ==> "__hello\n world\n !" + , hang 2 "hello\nworld\n!" ==> "hello\n world\n !" + , hang 2 "hello\nworld\n!"<>"\nhello\n!" ==> "hello\n world\n !\nhello\n!" + , "let " <> align (catV $ + (\(name, typ) -> fill 6 name <+> "::" <+> typ) + <$> [ ("abcdef","Doc") + , ("abcde","Int -> Doc -> Doc") + , ("abcdefghi","Doc") ]) + ==> "let abcdef :: Doc\n abcde :: Int -> Doc -> Doc\n abcdefghi :: Doc" + , "let " <> align (catV $ + (\(name, typ) -> breakfill 6 name <> " ::" <+> typ) + <$> [ ("abcdef","Doc") + , ("abcde","Int -> Doc -> Doc") + , ("abcdefghi","Doc") ]) + ==> "let abcdef :: Doc\n abcde :: Int -> Doc -> Doc\n abcdefghi\n :: Doc" + , "let " <> align (catV $ + (\(name, typ) -> breakfill 6 name <> " ::" <+> typ) + <$> [("abcdefghi","Doc ->\nDoc")]) + ==> "let abcdefghi\n :: Doc ->\n Doc" + , "let " <> align (catV $ + (\(name, typ) -> breakfill 6 name <> align (" ::" <+> typ)) + <$> [("abcdefghi","Doc ->\nDoc")]) + ==> "let abcdefghi\n :: Doc ->\n Doc" + , 10 `maxWidth` "1 2 3 4 5 6 7 8 9 10 11 12 13 14 15" ==> "1 2 3 4 5\n6 7 8 9 10\n11 12 13\n14 15" + , 10 `maxWidth` "a b "<>"12"<>align (" 34 5") ==> "a b 12 34\n 5" + , 10 `maxWidth` "a b "<>"12"<>align (" 34" <> align "") ==> "a b 12 34" + , 10 `maxWidth` "a b "<>"12"<>align (" 34" <> align " ") ==> "a b 12 34 " + , 10 `maxWidth` "a b "<>"12"<>align (" 34" <> align " 5") ==> "a b 12 34\n 5" + , 10 `maxWidth` "a b "<>"12"<>align (" 34" <> align " 56") ==> "a b 12\n 34\n 56" + , 10 `maxWidth` "a b "<>"12"<>align (" 34" <> align " 567") ==> "a b\n12 34 567" + , 10 `maxWidth` "a b "<>"12"<>align (" 34" <> align " 5678") ==> "a b\n12 34 5678" + , 10 `maxWidth` "a b "<>"12"<>align (" 34" <> align " 56789") ==> "a b\n12 34\n 56789" + , 10 `maxWidth` ("1234567890" <> " ") <> "1" ==> "1234567890\n1" + , 10 `maxWidth` nestedAlign 6 ==> "1 2 3 4 5\n 6" + , 10 `maxWidth` nestedAlign 7 ==> "1 2 3 4\n 5\n 6\n 7" + , 10 `maxWidth` nestedAlign 8 ==> "1 2 3\n 4\n 5\n 6\n 7\n 8" + , 10 `maxWidth` nestedAlign 9 ==> "1 2\n 3\n 4\n 5\n 6\n 7\n 8\n 9" + , 10 `maxWidth` nestedAlign 10 ==> "1\n 2\n 3\n 4\n 5\n 6\n 7\n 8\n 9\n 10" + -- justify justifies + , 10 `maxWidth` justify "1 2 3 4 5 6" ==> "1 2 3 4 5\n6" + -- justify compress spaces + , 10 `maxWidth` justify "1 2 3 4 5 6" ==> "1 2 3 4 5\n6" + -- justify does not overflow the alignment + , 10 `maxWidth` justify (nestedAlign 6) ==> "1 2 3 4 5\n 6" + , 10 `maxWidth` justify ("a b\n" <> nestedAlign 2) ==> "a b\n1 2" + , 10 `maxWidth` justify (bold ("12 34 56 78 "<> underline "90" <> " 123 456 789")) + ==> "\ESC[1m12 34 56\n78 \ESC[4m90\ESC[0;1m 123\n456 789\ESC[0m" + -- breakspace backtracking is bounded by the removable indentation + -- (hence it can actually justify a few words in reasonable time). + , 80 `maxWidth` + "Lorem ipsum dolor sit amet, Nulla nec tortor. Donec id elit quis purus\ + \ consectetur consequat. Nam congue semper tellus. Sed erat dolor,\ + \ dapibus sit amet, venenatis ornare, ultrices ut, nisi. Aliquam ante.\ + \ Suspendisse scelerisque dui nec velit. Duis augue augue, gravida euismod,\ + \ vulputate ac, facilisis id, sem. Morbi in orci. Nulla purus lacus,\ + \ pulvinar vel, malesuada ac, mattis nec, quam. Nam molestie scelerisque\ + \ quam. Nullam feugiat cursus lacus.orem ipsum dolor sit amet, consectetur\ + \ adipiscing elit. Donec libero risus, commodo vitae, pharetra mollis,\ + \ posuere eu, pede. Nulla nec tortor. Donec id elit quis purus consectetur\ + \ consequat. Nam congue semper tellus. Sed erat dolor, dapibus sit\ + \ amet, venenatis ornare, ultrices ut, nisi. Aliquam ante. Suspendisse\ + \ scelerisque dui nec velit. Duis augue augue, gravida euismod, vulputate ac,\ + \ facilisis id, sem. Morbi in orci. Nulla purus lacus, pulvinar vel,\ + \ malesuada ac, mattis nec, quam. Nam molestie scelerisque quam.\ + \ Nullam feugiat cursus lacus.orem ipsum dolor sit amet, consectetur\ + \ adipiscing elit. Donec libero risus, commodo vitae, pharetra mollis,\ + \ posuere eu, pede. Nulla nec tortor. Donec id elit quis purus consectetur\ + \ consequat. Nam congue semper tellus. Sed erat dolor, dapibus sit amet,\ + \ venenatis ornare, ultrices ut, nisi. Aliquam ante. Suspendisse\ + \ scelerisque dui nec velit. Duis augue augue, gravida euismod, vulputate ac,\ + \ facilisis id, sem. Morbi in orci. Nulla purus lacus, pulvinar vel,\ + \ malesuada ac, mattis nec, quam. Nam molestie scelerisque quam. Nullam\ + \ feugiat cursus lacus.orem ipsum dolor sit amet, consectetur adipiscing\ + \ elit. Donec libero risus, commodo vitae, pharetra mollis, posuere eu, pede.\ + \ Nulla nec tortor. Donec id elit quis purus consectetur consequat. Nam\ + \ congue semper tellus. Sed erat dolor, dapibus sit amet, venenatis ornare,\ + \ ultrices ut, nisi." + ==> "Lorem ipsum dolor sit amet, Nulla nec tortor. Donec id elit quis\ + \ purus\nconsectetur consequat. Nam congue semper tellus. Sed erat dolor, dapibus\ + \ sit\namet, venenatis ornare, ultrices ut, nisi. Aliquam ante. Suspendisse\ + \ scelerisque\ndui nec velit. Duis augue augue, gravida euismod, vulputate ac,\ + \ facilisis id,\nsem. Morbi in orci. Nulla purus lacus, pulvinar vel, malesuada\ + \ ac, mattis nec,\nquam. Nam molestie scelerisque quam. Nullam feugiat cursus\ + \ lacus.orem ipsum\ndolor sit amet, consectetur adipiscing elit. Donec libero\ + \ risus, commodo vitae,\npharetra mollis, posuere eu, pede. Nulla nec tortor.\ + \ Donec id elit quis purus\nconsectetur consequat. Nam congue semper tellus. Sed\ + \ erat dolor, dapibus sit\namet, venenatis ornare, ultrices ut, nisi. Aliquam\ + \ ante. Suspendisse scelerisque\ndui nec velit. Duis augue augue, gravida\ + \ euismod, vulputate ac, facilisis id,\nsem. Morbi in orci. Nulla purus lacus,\ + \ pulvinar vel, malesuada ac, mattis nec,\nquam. Nam molestie scelerisque quam.\ + \ Nullam feugiat cursus lacus.orem ipsum\ndolor sit amet, consectetur adipiscing\ + \ elit. Donec libero risus, commodo vitae,\npharetra mollis, posuere eu, pede.\ + \ Nulla nec tortor. Donec id elit quis purus\nconsectetur consequat. Nam congue\ + \ semper tellus. Sed erat dolor, dapibus sit\namet, venenatis ornare, ultrices\ + \ ut, nisi. Aliquam ante. Suspendisse scelerisque\ndui nec velit. Duis augue\ + \ augue, gravida euismod, vulputate ac, facilisis id,\nsem. Morbi in orci. Nulla\ + \ purus lacus, pulvinar vel, malesuada ac, mattis nec,\nquam. Nam molestie\ + \ scelerisque quam. Nullam feugiat cursus lacus.orem ipsum\ndolor sit amet,\ + \ consectetur adipiscing elit. Donec libero risus, commodo vitae,\npharetra\ + \ mollis, posuere eu, pede. Nulla nec tortor. Donec id elit quis\ + \ purus\nconsectetur consequat. Nam congue semper tellus. Sed erat dolor, dapibus\ + \ sit\namet, venenatis ornare, ultrices ut, nisi." + ] + where + (==>) :: IsString d => d ~ String => AnsiText (Plain d) -> d -> Assertion; infix 0 ==> + p ==> exp = got @?= exp + where got = runPlain $ runAnsiText p + +testList :: String -> [Assertion] -> TestTree +testList n as = testGroup n $ List.zipWith testCase (show <$> [1::Int ..]) as + +breakpoints :: Wrappable d => Monoid d => [d] -> d +breakpoints = intercalate breakpoint + +breakspaces :: Wrappable d => Monoid d => [d] -> d +breakspaces = intercalate breakspace + +infix 1 `maxWidth` +maxWidth :: Wrappable d => Width -> d -> d +maxWidth = setWidth . Just + +nestedAlign :: + DocFrom (Line String) d => + Spaceable d => Indentable d => Wrappable d => + Int -> d +nestedAlign n = go 1 + where + go i = + docFrom (Line (show i)) <> + (if n <= i then mempty + else align (breakspace <> go (i+1))) + +listHorV :: IsString d => Indentable d => Wrappable d => [d] -> d +listHorV [] = "[]" +listHorV [d] = "["<>d<>"]" +listHorV ds = + breakalt + ("[" <> intercalate ("," <> space) ds <> "]") + (align $ "[" <> space + <> foldr1 (\a acc -> a <> newline <> "," <> space <> acc) ds + <> newline <> "]") + +fun :: IsString d => Indentable d => Wrappable d => d -> d +fun d = "function(" <> incrIndent 2 (breakalt d (newline<>d<>newline)) <> ")" diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 index 0000000..ee82889 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,14 @@ +module Main where + +import Data.Function (($)) +import System.IO (IO) +import Test.Tasty + +import HUnit + +main :: IO () +main = do + defaultMain $ + testGroup "Document" + [ hunits + ] -- 2.47.0