diff --git a/COPYING b/COPYING new file mode 100644 --- /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/Language/Symantic/Document.hs b/Language/Symantic/Document.hs new file mode 100644 --- /dev/null +++ b/Language/Symantic/Document.hs @@ -0,0 +1,13 @@ +module Language.Symantic.Document + ( module Language.Symantic.Document.Sym + , module Language.Symantic.Document.ANSI + , module Language.Symantic.Document.Dim + , module Language.Symantic.Document.Plain + , module Language.Symantic.Document.Valid + ) where + +import Language.Symantic.Document.Sym +import Language.Symantic.Document.ANSI +import Language.Symantic.Document.Dim +import Language.Symantic.Document.Plain +import Language.Symantic.Document.Valid diff --git a/Language/Symantic/Document/ANSI.hs b/Language/Symantic/Document/ANSI.hs new file mode 100644 --- /dev/null +++ b/Language/Symantic/Document/ANSI.hs @@ -0,0 +1,162 @@ +module Language.Symantic.Document.ANSI where + +import Control.Monad (Monad(..), replicateM_) +import Data.Bool (Bool(..)) +import Data.Function (($), (.), const) +import Data.Monoid (Monoid(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (IsString(..)) +import System.Console.ANSI +import System.IO (IO) +import Text.Show (Show(..)) +import qualified Data.List as L +import qualified Data.Text.IO as T +import qualified Data.Text.Lazy as TL +import qualified Data.Text.Lazy.Builder as TLB +import qualified Data.Text.Lazy.IO as TL +import qualified System.IO as IO + +import Language.Symantic.Document.Sym + +-- * Type 'ANSI' +newtype ANSI = ANSI { unANSI :: [SGR] -> TLB.Builder } +instance IsString ANSI where + fromString s = ANSI $ const t + where t = fromString s + +ansi :: ANSI -> TLB.Builder +ansi (ANSI d) = d [] + +pushSGR :: SGR -> ANSI -> ANSI +pushSGR c (ANSI d) = ANSI $ \cs -> + fromString (setSGRCode [c]) <> + d (c:cs) <> + fromString (setSGRCode $ Reset:L.reverse cs) + +instance Semigroup ANSI where + ANSI x <> ANSI y = ANSI $ \c -> x c <> y c +instance Monoid ANSI where + mempty = empty + mappend = (<>) +instance Doc_Text ANSI where + replicate i d = ANSI $ TLB.fromLazyText . TL.replicate (int64OfInt i) . TLB.toLazyText . unANSI d + int = ANSI . const . fromString . show + integer = ANSI . const . fromString . show + char = ANSI . const . TLB.singleton + string = ANSI . const . fromString + text = ANSI . const . TLB.fromText + ltext = ANSI . const . TLB.fromLazyText + charH = char + stringH = string + textH = text + ltextH = ltext +instance Doc_Color ANSI where + reverse = pushSGR $ SetSwapForegroundBackground True + black = pushSGR $ SetColor Foreground Dull Black + red = pushSGR $ SetColor Foreground Dull Red + green = pushSGR $ SetColor Foreground Dull Green + yellow = pushSGR $ SetColor Foreground Dull Yellow + blue = pushSGR $ SetColor Foreground Dull Blue + magenta = pushSGR $ SetColor Foreground Dull Magenta + cyan = pushSGR $ SetColor Foreground Dull Cyan + white = pushSGR $ SetColor Foreground Dull White + blacker = pushSGR $ SetColor Foreground Vivid Black + redder = pushSGR $ SetColor Foreground Vivid Red + greener = pushSGR $ SetColor Foreground Vivid Green + yellower = pushSGR $ SetColor Foreground Vivid Yellow + bluer = pushSGR $ SetColor Foreground Vivid Blue + magentaer = pushSGR $ SetColor Foreground Vivid Magenta + cyaner = pushSGR $ SetColor Foreground Vivid Cyan + whiter = pushSGR $ SetColor Foreground Vivid White + onBlack = pushSGR $ SetColor Background Dull Black + onRed = pushSGR $ SetColor Background Dull Red + onGreen = pushSGR $ SetColor Background Dull Green + onYellow = pushSGR $ SetColor Background Dull Yellow + onBlue = pushSGR $ SetColor Background Dull Blue + onMagenta = pushSGR $ SetColor Background Dull Magenta + onCyan = pushSGR $ SetColor Background Dull Cyan + onWhite = pushSGR $ SetColor Background Dull White + onBlacker = pushSGR $ SetColor Background Vivid Black + onRedder = pushSGR $ SetColor Background Vivid Red + onGreener = pushSGR $ SetColor Background Vivid Green + onYellower = pushSGR $ SetColor Background Vivid Yellow + onBluer = pushSGR $ SetColor Background Vivid Blue + onMagentaer = pushSGR $ SetColor Background Vivid Magenta + onCyaner = pushSGR $ SetColor Background Vivid Cyan + onWhiter = pushSGR $ SetColor Background Vivid White +instance Doc_Decoration ANSI where + bold = pushSGR $ SetConsoleIntensity BoldIntensity + underline = pushSGR $ SetUnderlining SingleUnderline + italic = pushSGR $ SetItalicized True + +-- * Type 'ANSI_IO' +newtype ANSI_IO = ANSI_IO { unANSI_IO :: [SGR] -> IO.Handle -> IO () } +instance IsString ANSI_IO where + fromString s = ANSI_IO $ \_c h -> IO.hPutStr h t + where t = fromString s + +ansiIO :: ANSI_IO -> IO.Handle -> IO () +ansiIO (ANSI_IO d) = d [] + +pushSGR_IO :: SGR -> ANSI_IO -> ANSI_IO +pushSGR_IO c (ANSI_IO d) = ANSI_IO $ \cs h -> do + hSetSGR h [c] + d (c:cs) h + hSetSGR h $ Reset:L.reverse cs + +instance Semigroup ANSI_IO where + ANSI_IO x <> ANSI_IO y = ANSI_IO $ \c h -> do {x c h; y c h} +instance Monoid ANSI_IO where + mempty = empty + mappend = (<>) +instance Doc_Text ANSI_IO where + empty = ANSI_IO $ \_ _ -> return () + replicate i d = ANSI_IO $ \c -> replicateM_ i . unANSI_IO d c + int i = ANSI_IO $ \_ h -> IO.hPutStr h (show i) + integer i = ANSI_IO $ \_ h -> IO.hPutStr h (show i) + char x = ANSI_IO $ \_ h -> IO.hPutChar h x + string x = ANSI_IO $ \_ h -> IO.hPutStr h x + text x = ANSI_IO $ \_ h -> T.hPutStr h x + ltext x = ANSI_IO $ \_ h -> TL.hPutStr h x + charH = char + stringH = string + textH = text + ltextH = ltext +instance Doc_Color ANSI_IO where + reverse = pushSGR_IO $ SetSwapForegroundBackground True + black = pushSGR_IO $ SetColor Foreground Dull Black + red = pushSGR_IO $ SetColor Foreground Dull Red + green = pushSGR_IO $ SetColor Foreground Dull Green + yellow = pushSGR_IO $ SetColor Foreground Dull Yellow + blue = pushSGR_IO $ SetColor Foreground Dull Blue + magenta = pushSGR_IO $ SetColor Foreground Dull Magenta + cyan = pushSGR_IO $ SetColor Foreground Dull Cyan + white = pushSGR_IO $ SetColor Foreground Dull White + blacker = pushSGR_IO $ SetColor Foreground Vivid Black + redder = pushSGR_IO $ SetColor Foreground Vivid Red + greener = pushSGR_IO $ SetColor Foreground Vivid Green + yellower = pushSGR_IO $ SetColor Foreground Vivid Yellow + bluer = pushSGR_IO $ SetColor Foreground Vivid Blue + magentaer = pushSGR_IO $ SetColor Foreground Vivid Magenta + cyaner = pushSGR_IO $ SetColor Foreground Vivid Cyan + whiter = pushSGR_IO $ SetColor Foreground Vivid White + onBlack = pushSGR_IO $ SetColor Background Dull Black + onRed = pushSGR_IO $ SetColor Background Dull Red + onGreen = pushSGR_IO $ SetColor Background Dull Green + onYellow = pushSGR_IO $ SetColor Background Dull Yellow + onBlue = pushSGR_IO $ SetColor Background Dull Blue + onMagenta = pushSGR_IO $ SetColor Background Dull Magenta + onCyan = pushSGR_IO $ SetColor Background Dull Cyan + onWhite = pushSGR_IO $ SetColor Background Dull White + onBlacker = pushSGR_IO $ SetColor Background Vivid Black + onRedder = pushSGR_IO $ SetColor Background Vivid Red + onGreener = pushSGR_IO $ SetColor Background Vivid Green + onYellower = pushSGR_IO $ SetColor Background Vivid Yellow + onBluer = pushSGR_IO $ SetColor Background Vivid Blue + onMagentaer = pushSGR_IO $ SetColor Background Vivid Magenta + onCyaner = pushSGR_IO $ SetColor Background Vivid Cyan + onWhiter = pushSGR_IO $ SetColor Background Vivid White +instance Doc_Decoration ANSI_IO where + bold = pushSGR_IO $ SetConsoleIntensity BoldIntensity + underline = pushSGR_IO $ SetUnderlining SingleUnderline + italic = pushSGR_IO $ SetItalicized True diff --git a/Language/Symantic/Document/Dim.hs b/Language/Symantic/Document/Dim.hs new file mode 100644 --- /dev/null +++ b/Language/Symantic/Document/Dim.hs @@ -0,0 +1,102 @@ +module Language.Symantic.Document.Dim where + +import Data.Eq (Eq) +import Data.Foldable (Foldable(..)) +import Data.Function (($), id) +import Data.Functor ((<$>)) +import Data.Int (Int) +import Data.Monoid (Monoid(..)) +import Data.Ord (Ord(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (IsString(..)) +import Prelude (max, Num(..), toInteger) +import Text.Show (Show(..)) +import qualified Data.List as L +import qualified Data.Text as T +import qualified Data.Text.Lazy as TL + +import Language.Symantic.Document.Sym + +-- * Type 'Dim' +data Dim + = Dim + { width :: Int -- ^ Maximun line length. + , height :: Int -- ^ Number of newlines. + , width_first :: Int -- ^ Length of the first line. + , width_last :: Int -- ^ Length of the last line. + } deriving (Eq, Show) +instance IsString Dim where + fromString [] = Dim 0 0 0 0 + fromString s = + Dim + { width = maximum ws + , height = length ls + , width_first = if null ws then 0 else L.head ws + , width_last = if null ws then 0 else L.last ws + } + where + ls = L.lines s + ws = length <$> ls + +dim :: Dim -> Dim +dim = id + +instance Semigroup Dim where + Dim wx hx wfx wlx <> Dim wy hy wfy wly = + let h = hx + hy in + case (hx, hy) of + (0, 0) -> let w = wx + wy in Dim w h w w + (0, _) -> let v = wfx + wfy in Dim (max v (wx + wy)) h v wly + (_, 0) -> let v = wlx + wfy in Dim (max v (wx + wy)) h wfx v + _ -> Dim (max wx wy) h wfx wly +instance Monoid Dim where + mempty = empty + mappend = (<>) +instance Doc_Text Dim where + spaces i = Dim i 0 i i + replicate i d = if i <= 0 then empty else d <> replicate (i - 1) d + int i = fromString $ show i + integer i = fromString $ show i + charH _c = Dim 1 0 1 1 + stringH t = Dim l 0 l l where l = length t + textH t = Dim l 0 l l where l = T.length t + ltextH t = Dim l 0 l l where l = fromInteger $ toInteger $ TL.length t + -- XXX: conversion may overflow +instance Doc_Color Dim where + reverse = id + black = id + red = id + green = id + yellow = id + blue = id + magenta = id + cyan = id + white = id + blacker = id + redder = id + greener = id + yellower = id + bluer = id + magentaer = id + cyaner = id + whiter = id + onBlack = id + onRed = id + onGreen = id + onYellow = id + onBlue = id + onMagenta = id + onCyan = id + onWhite = id + onBlacker = id + onRedder = id + onGreener = id + onYellower = id + onBluer = id + onMagentaer = id + onCyaner = id + onWhiter = id +instance Doc_Decoration Dim where + bold = id + underline = id + italic = id diff --git a/Language/Symantic/Document/Plain.hs b/Language/Symantic/Document/Plain.hs new file mode 100644 --- /dev/null +++ b/Language/Symantic/Document/Plain.hs @@ -0,0 +1,150 @@ +module Language.Symantic.Document.Plain where + +import Control.Monad (Monad(..), replicateM_) +import Data.Function (($), (.), id) +import Data.Monoid (Monoid(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (IsString(..)) +import System.IO (IO) +import Text.Show (Show(..)) +import qualified Data.Text.IO as T +import qualified Data.Text.Lazy as TL +import qualified Data.Text.Lazy.IO as TL +import qualified Data.Text.Lazy.Builder as TLB +import qualified System.IO as IO + +import Language.Symantic.Document.Sym + +-- * Type 'Plain' +newtype Plain + = Plain TLB.Builder + deriving (Show) +instance IsString Plain where + fromString = Plain . fromString + +plain :: Plain -> TLB.Builder +plain (Plain d) = d + + +instance Semigroup Plain where + Plain x <> Plain y = Plain (x <> y) +instance Monoid Plain where + mempty = empty + mappend = (<>) +instance Doc_Text Plain where + int = Plain . fromString . show + integer = Plain . fromString . show + replicate i = Plain . TLB.fromLazyText . TL.replicate (int64OfInt i) . TLB.toLazyText . plain + char = Plain . TLB.singleton + string = Plain . fromString + text = Plain . TLB.fromText + ltext = Plain . TLB.fromLazyText + charH = char + stringH = string + textH = text + ltextH = ltext +instance Doc_Color Plain where + reverse = id + black = id + red = id + green = id + yellow = id + blue = id + magenta = id + cyan = id + white = id + blacker = id + redder = id + greener = id + yellower = id + bluer = id + magentaer = id + cyaner = id + whiter = id + onBlack = id + onRed = id + onGreen = id + onYellow = id + onBlue = id + onMagenta = id + onCyan = id + onWhite = id + onBlacker = id + onRedder = id + onGreener = id + onYellower = id + onBluer = id + onMagentaer = id + onCyaner = id + onWhiter = id +instance Doc_Decoration Plain where + bold = id + underline = id + italic = id + +-- * Type 'PlainIO' +newtype PlainIO + = PlainIO { unPlainH :: IO.Handle -> IO () } +instance IsString PlainIO where + fromString s = PlainIO $ \h -> IO.hPutStr h t + where t = fromString s + +plainIO :: PlainIO -> IO.Handle -> IO () +plainIO (PlainIO d) = d + +instance Semigroup PlainIO where + PlainIO x <> PlainIO y = PlainIO $ \h -> do {x h; y h} +instance Monoid PlainIO where + mempty = empty + mappend = (<>) +instance Doc_Text PlainIO where + empty = PlainIO $ \_ -> return () + int i = PlainIO $ \h -> IO.hPutStr h (show i) + integer i = PlainIO $ \h -> IO.hPutStr h (show i) + replicate i d = PlainIO $ replicateM_ i . plainIO d + char x = PlainIO $ \h -> IO.hPutChar h x + string x = PlainIO $ \h -> IO.hPutStr h x + text x = PlainIO $ \h -> T.hPutStr h x + ltext x = PlainIO $ \h -> TL.hPutStr h x + charH = char + stringH = string + textH = text + ltextH = ltext +instance Doc_Color PlainIO where + reverse = id + black = id + red = id + green = id + yellow = id + blue = id + magenta = id + cyan = id + white = id + blacker = id + redder = id + greener = id + yellower = id + bluer = id + magentaer = id + cyaner = id + whiter = id + onBlack = id + onRed = id + onGreen = id + onYellow = id + onBlue = id + onMagenta = id + onCyan = id + onWhite = id + onBlacker = id + onRedder = id + onGreener = id + onYellower = id + onBluer = id + onMagentaer = id + onCyaner = id + onWhiter = id +instance Doc_Decoration PlainIO where + bold = id + underline = id + italic = id diff --git a/Language/Symantic/Document/Sym.hs b/Language/Symantic/Document/Sym.hs new file mode 100644 --- /dev/null +++ b/Language/Symantic/Document/Sym.hs @@ -0,0 +1,287 @@ +{-# LANGUAGE PolyKinds #-} +{-# LANGUAGE ViewPatterns #-} +module Language.Symantic.Document.Sym where + +import Data.Char (Char) +import Data.Eq (Eq(..)) +import Data.Foldable (Foldable(..)) +import Data.Function ((.)) +import Data.Functor (Functor(..)) +import Data.Int (Int, Int64) +import Data.Maybe (Maybe(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String, IsString) +import Data.Text (Text) +import Prelude (Integer, fromInteger, toInteger) +import qualified Data.List as L +import qualified Data.Text as T +import qualified Data.Text.Lazy as TL + +-- * Class 'Doc_Text' +class (IsString d, Semigroup d) => Doc_Text d where + charH :: Char -> d -- ^ XXX: MUST NOT be '\n' + stringH :: String -> d -- ^ XXX: MUST NOT contain '\n' + textH :: Text -> d -- ^ XXX: MUST NOT contain '\n' + ltextH :: TL.Text -> d -- ^ XXX: MUST NOT contain '\n' + replicate :: Int -> d -> d + integer :: Integer -> d + default charH :: Doc_Text (ReprOf d) => Trans d => Char -> d + default stringH :: Doc_Text (ReprOf d) => Trans d => String -> d + default textH :: Doc_Text (ReprOf d) => Trans d => Text -> d + default ltextH :: Doc_Text (ReprOf d) => Trans d => TL.Text -> d + default replicate :: Doc_Text (ReprOf d) => Trans d => Int -> d -> d + default integer :: Doc_Text (ReprOf d) => Trans d => Integer -> d + charH = trans . charH + stringH = trans . stringH + textH = trans . textH + ltextH = trans . ltextH + replicate = trans1 . replicate + integer = trans . integer + + empty :: d + eol :: d + space :: d + spaces :: Int -> d + int :: Int -> d + char :: Char -> d + string :: String -> d + text :: Text -> d + ltext :: TL.Text -> d + catH :: Foldable f => f d -> d + catV :: Foldable f => f d -> d + paren :: d -> d + brace :: d -> d + bracket :: d -> d + bquote :: d -> d + dquote :: d -> d + fquote :: d -> d + squote :: d -> d + + empty = "" + eol = "\n" + space = char ' ' + spaces i = replicate i space + int = integer . toInteger + char = \case '\n' -> eol; c -> charH c + string = catV . fmap stringH . lines + text = catV . fmap textH . lines + ltext = catV . fmap ltextH . lines + catH = foldr (<>) empty + catV l = if null l then empty else foldr1 (\a acc -> a <> eol <> acc) l + paren d = charH '(' <> d <> charH ')' + brace d = charH '{' <> d <> charH '}' + bracket d = charH '[' <> d <> charH ']' + bquote d = charH '`' <> d <> charH '`' + dquote d = charH '\"' <> d <> charH '\"' + fquote d = "« " <> d <> " »" + squote d = charH '\'' <> d <> charH '\'' + -- default catH :: Doc_Text (ReprOf d) => Trans d => Foldable f => Functor f => f d -> d + -- default catV :: Doc_Text (ReprOf d) => Trans d => Foldable f => Functor f => f d -> d + -- catH l = trans (catH (fmap unTrans l)) + -- catV l = trans (catV (fmap unTrans l)) + +-- * Class 'Doc_Color' +class Doc_Color 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 :: Doc_Color (ReprOf d) => Trans d => d -> d + default black :: Doc_Color (ReprOf d) => Trans d => d -> d + default red :: Doc_Color (ReprOf d) => Trans d => d -> d + default green :: Doc_Color (ReprOf d) => Trans d => d -> d + default yellow :: Doc_Color (ReprOf d) => Trans d => d -> d + default blue :: Doc_Color (ReprOf d) => Trans d => d -> d + default magenta :: Doc_Color (ReprOf d) => Trans d => d -> d + default cyan :: Doc_Color (ReprOf d) => Trans d => d -> d + default white :: Doc_Color (ReprOf d) => Trans d => d -> d + default blacker :: Doc_Color (ReprOf d) => Trans d => d -> d + default redder :: Doc_Color (ReprOf d) => Trans d => d -> d + default greener :: Doc_Color (ReprOf d) => Trans d => d -> d + default yellower :: Doc_Color (ReprOf d) => Trans d => d -> d + default bluer :: Doc_Color (ReprOf d) => Trans d => d -> d + default magentaer :: Doc_Color (ReprOf d) => Trans d => d -> d + default cyaner :: Doc_Color (ReprOf d) => Trans d => d -> d + default whiter :: Doc_Color (ReprOf d) => Trans d => d -> d + default onBlack :: Doc_Color (ReprOf d) => Trans d => d -> d + default onRed :: Doc_Color (ReprOf d) => Trans d => d -> d + default onGreen :: Doc_Color (ReprOf d) => Trans d => d -> d + default onYellow :: Doc_Color (ReprOf d) => Trans d => d -> d + default onBlue :: Doc_Color (ReprOf d) => Trans d => d -> d + default onMagenta :: Doc_Color (ReprOf d) => Trans d => d -> d + default onCyan :: Doc_Color (ReprOf d) => Trans d => d -> d + default onWhite :: Doc_Color (ReprOf d) => Trans d => d -> d + default onBlacker :: Doc_Color (ReprOf d) => Trans d => d -> d + default onRedder :: Doc_Color (ReprOf d) => Trans d => d -> d + default onGreener :: Doc_Color (ReprOf d) => Trans d => d -> d + default onYellower :: Doc_Color (ReprOf d) => Trans d => d -> d + default onBluer :: Doc_Color (ReprOf d) => Trans d => d -> d + default onMagentaer :: Doc_Color (ReprOf d) => Trans d => d -> d + default onCyaner :: Doc_Color (ReprOf d) => Trans d => d -> d + default onWhiter :: Doc_Color (ReprOf d) => Trans d => d -> d + + reverse = trans1 reverse + black = trans1 black + red = trans1 red + green = trans1 green + yellow = trans1 yellow + blue = trans1 blue + magenta = trans1 magenta + cyan = trans1 cyan + white = trans1 white + blacker = trans1 blacker + redder = trans1 redder + greener = trans1 greener + yellower = trans1 yellower + bluer = trans1 bluer + magentaer = trans1 magentaer + cyaner = trans1 cyaner + whiter = trans1 whiter + onBlack = trans1 onBlack + onRed = trans1 onRed + onGreen = trans1 onGreen + onYellow = trans1 onYellow + onBlue = trans1 onBlue + onMagenta = trans1 onMagenta + onCyan = trans1 onCyan + onWhite = trans1 onWhite + onBlacker = trans1 onBlacker + onRedder = trans1 onRedder + onGreener = trans1 onGreener + onYellower = trans1 onYellower + onBluer = trans1 onBluer + onMagentaer = trans1 onMagentaer + onCyaner = trans1 onCyaner + onWhiter = trans1 onWhiter + +-- * Class 'Doc_Decoration' +class Doc_Decoration d where + bold :: d -> d + underline :: d -> d + italic :: d -> d + default bold :: Doc_Decoration (ReprOf d) => Trans d => d -> d + default underline :: Doc_Decoration (ReprOf d) => Trans d => d -> d + default italic :: Doc_Decoration (ReprOf d) => Trans d => d -> d + bold = trans1 bold + underline = trans1 underline + italic = trans1 italic + +-- * Class 'Trans' +class Trans tr where + -- | Return the underlying @tr@ of the transformer. + type ReprOf tr :: * + + -- | Lift a tr to the transformer's. + trans :: ReprOf tr -> tr + -- | Unlift a tr from the transformer's. + unTrans :: tr -> ReprOf tr + + -- | Identity transformation for a unary symantic method. + trans1 :: (ReprOf tr -> ReprOf tr) -> (tr -> tr) + trans1 f = trans . f . unTrans + + -- | Identity transformation for a binary symantic method. + trans2 + :: (ReprOf tr -> ReprOf tr -> ReprOf tr) + -> (tr -> tr -> tr) + trans2 f t1 t2 = trans (f (unTrans t1) (unTrans t2)) + + -- | Identity transformation for a ternary symantic method. + trans3 + :: (ReprOf tr -> ReprOf tr -> ReprOf tr -> ReprOf tr) + -> (tr -> tr -> tr -> tr) + trans3 f t1 t2 t3 = trans (f (unTrans t1) (unTrans t2) (unTrans t3)) + + +-- * Class 'SplitOnCharWithEmpty' +class SplitOnCharWithEmpty t where + splitOnCharWithEmpty :: Char -> t -> [t] +instance SplitOnCharWithEmpty Text where + splitOnCharWithEmpty sep t = + case T.break (== sep) t of + (chunk, T.uncons -> Just (_, rest)) -> chunk : splitOnCharWithEmpty sep rest + (chunk, _) -> [chunk] +instance SplitOnCharWithEmpty TL.Text where + splitOnCharWithEmpty sep t = + case TL.break (== sep) t of + (chunk, TL.uncons -> Just (_, rest)) -> chunk : splitOnCharWithEmpty sep rest + (chunk, _) -> [chunk] +instance SplitOnCharWithEmpty String where + splitOnCharWithEmpty sep t = + case L.break (== sep) t of + (chunk, _:rest) -> chunk : splitOnCharWithEmpty sep rest + (chunk, []) -> [chunk] + +lines :: SplitOnCharWithEmpty t => t -> [t] +lines = splitOnCharWithEmpty '\n' + +int64OfInt :: Int -> Int64 +int64OfInt = fromInteger . toInteger + + +{- +-- * Class 'SplitOnChar' + +class SplitOnChar t where + splitOnChar :: Char -> t -> [t] +instance SplitOnChar Text where + splitOnChar sep t = + case Text.uncons t of + Nothing -> [] + Just (x, xs) -> + if x == sep + then splitOnChar sep xs + else + let (chunk, rest) = Text.break (== sep) t in + chunk:splitOnChar sep rest +instance SplitOnChar String where + splitOnChar sep t = + case t of + [] -> [] + x:xs -> + if x == sep + then splitOnChar sep xs + else + let (chunk, rest) = List.break (== sep) t in + chunk:splitOnChar sep rest +-} diff --git a/Language/Symantic/Document/Valid.hs b/Language/Symantic/Document/Valid.hs new file mode 100644 --- /dev/null +++ b/Language/Symantic/Document/Valid.hs @@ -0,0 +1,112 @@ +module Language.Symantic.Document.Valid where + +import Control.Applicative (Applicative(..)) +import Control.Monad (Monad(..)) +import Data.Eq (Eq(..)) +import Data.Foldable (elem) +import Data.Function (($), (.), id) +import Data.Functor (Functor(..)) +import Data.Int (Int) +import Data.Monoid (Monoid(..)) +import Data.Ord (Ord(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (IsString(..)) +import Text.Show (Show) +import qualified Data.Text as T +import qualified Data.Text.Lazy as TL + +import Language.Symantic.Document.Sym + +-- * Type 'Valid' +data Valid repr + = KO [Error_Valid] + | Ok repr + deriving (Eq, Show) +instance IsString repr => IsString (Valid repr) where + fromString = Ok . fromString + +valid :: Valid repr -> Valid repr +valid = id + +-- ** Type 'Error_Valid' +data Error_Valid + = Error_Valid_not_horizontal TL.Text + | Error_Valid_negative_replicate Int + deriving (Eq, Show) + +instance Semigroup repr => Semigroup (Valid repr) where + Ok x <> Ok y = Ok $ x <> y + KO x <> Ok _ = KO x + Ok _ <> KO y = KO y + KO x <> KO y = KO $ x <> y +instance (Doc_Text repr, Semigroup repr) => Monoid (Valid repr) where + mempty = empty + mappend = (<>) +instance Functor Valid where + fmap _ (KO e) = KO e + fmap f (Ok a) = Ok $ f a +instance Applicative Valid where + pure = Ok + Ok f <*> Ok a = Ok $ f a + KO e <*> KO e' = KO $ e <> e' + Ok _f <*> KO e = KO e + KO e <*> Ok _a = KO e +instance Monad Valid where + return = Ok + Ok a >>= f = f a + KO e >>= _ = KO e +instance (Doc_Text repr, Semigroup repr) => Doc_Text (Valid repr) where + replicate i _ | i < 0 = KO [Error_Valid_negative_replicate i] + replicate i d = d >>= Ok . replicate i + int = pure . int + integer = pure . integer + char = pure . char + string = pure . string + text = pure . text + ltext = pure . ltext + charH '\n'= KO [Error_Valid_not_horizontal $ TL.singleton '\n'] + charH c = Ok $ charH c + stringH t | '\n' `elem` t = KO [Error_Valid_not_horizontal $ fromString t] + stringH t = Ok $ stringH t + textH t | T.any (== '\n') t = KO [Error_Valid_not_horizontal $ TL.fromStrict t] + textH t = Ok $ textH t + ltextH t | TL.any (== '\n') t = KO [Error_Valid_not_horizontal t] + ltextH t = Ok $ ltextH t +instance Doc_Color repr => Doc_Color (Valid repr) where + reverse = fmap reverse + black = fmap black + red = fmap red + green = fmap green + yellow = fmap yellow + blue = fmap blue + magenta = fmap magenta + cyan = fmap cyan + white = fmap white + blacker = fmap blacker + redder = fmap redder + greener = fmap greener + yellower = fmap yellower + bluer = fmap bluer + magentaer = fmap magentaer + cyaner = fmap cyaner + whiter = fmap whiter + onBlack = fmap onBlack + onRed = fmap onRed + onGreen = fmap onGreen + onYellow = fmap onYellow + onBlue = fmap onBlue + onMagenta = fmap onMagenta + onCyan = fmap onCyan + onWhite = fmap onWhite + onBlacker = fmap onBlacker + onRedder = fmap onRedder + onGreener = fmap onGreener + onYellower = fmap onYellower + onBluer = fmap onBluer + onMagentaer = fmap onMagentaer + onCyaner = fmap onCyaner + onWhiter = fmap onWhiter +instance Doc_Decoration repr => Doc_Decoration (Valid repr) where + bold = fmap bold + italic = fmap italic + underline = fmap underline diff --git a/stack.yaml b/stack.yaml new file mode 100644 --- /dev/null +++ b/stack.yaml @@ -0,0 +1,3 @@ +resolver: nightly-2017-02-03 +packages: +- '.' diff --git a/symantic-document.cabal b/symantic-document.cabal new file mode 100644 --- /dev/null +++ b/symantic-document.cabal @@ -0,0 +1,57 @@ +author: Julien Moutinho +-- bug-reports: http://bug.autogeree.net/symantic +build-type: Simple +cabal-version: >= 1.8 +category: Text +-- data-dir: data +-- data-files: +description: Symantics for generating documents. +extra-source-files: + stack.yaml +extra-tmp-files: +-- homepage: http://pad.autogeree.net/informatique/symantic +license: GPL-3 +license-file: COPYING +maintainer: Julien Moutinho +name: symantic-document +stability: experimental +synopsis: Document symantics. +tested-with: GHC==8.0.2 +-- PVP: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.0.0.20170623 + +source-repository head + location: git://git.autogeree.net/symantic + type: git + +Library + extensions: + NoImplicitPrelude + DataKinds + DefaultSignatures + FlexibleContexts + FlexibleInstances + LambdaCase + MultiParamTypeClasses + NamedFieldPuns + OverloadedStrings + ScopedTypeVariables + StandaloneDeriving + TupleSections + TypeFamilies + TypeOperators + ghc-options: -Wall -fno-warn-tabs + exposed-modules: + Language.Symantic.Document + Language.Symantic.Document.ANSI + Language.Symantic.Document.Dim + Language.Symantic.Document.Plain + Language.Symantic.Document.Sym + Language.Symantic.Document.Valid + build-depends: + ansi-terminal + , base >= 4.6 && < 5 + , text + -- , transformers >= 0.4 && < 0.5