diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for BBCode + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -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/bbcode.cabal b/bbcode.cabal new file mode 100644 --- /dev/null +++ b/bbcode.cabal @@ -0,0 +1,67 @@ +cabal-version: 3.0 +name: bbcode +version: 0.1.0.0 +synopsis: Library for parsing, constructing, and printing BBCode +description: + This is a set of utilities for: Parsing BBCode into AST(providing + related types), Building BBCode AST with simple DSL based on + Semigroup and functions. + Currently this library can only be used with a very specific BBCode dialect + used on a resource I won't name. + +homepage: https://gitlab.com/repetitivesin/BBCode +license: GPL-3.0-or-later +license-file: LICENSE +author: Repetitive +maintainer: serendipitousdog@protonmail.com +category: text +build-type: Simple +extra-doc-files: CHANGELOG.md + +source-repository head + type: git + location: https://gitlab.com/repetitivesin/BBCode.git + +common c + build-depends: base ^>=4.16.4.0 + ghc-options: -Wall + default-extensions: + ApplicativeDo + LambdaCase + OverloadedStrings + RecordWildCards + ViewPatterns + + build-depends: + , base ^>=4.16.4.0 + , containers >=0.6.5 && <0.7 + , lens >=5.2.2 && <5.3 + , megaparsec >=9.4.1 && <9.5 + , mtl >=2.2.2 && <2.3 + , text >=1.2.5 && <1.3 + , transformers >=0.5.6 && <0.6 + +library + import: c + exposed-modules: + Text.BBCode + Text.BBCode.Lens + Text.BBCode.Parser + + other-modules: + Text.BBCode.Internal.Builder + Text.BBCode.Internal.Helper + Text.BBCode.Internal.Parser + Text.BBCode.Internal.Pretty + Text.BBCode.Internal.Types + + hs-source-dirs: lib + default-language: GHC2021 + +test-suite BBCode-test + import: c + default-language: GHC2021 + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: Main.hs + build-depends: bbcode diff --git a/lib/Text/BBCode.hs b/lib/Text/BBCode.hs new file mode 100644 --- /dev/null +++ b/lib/Text/BBCode.hs @@ -0,0 +1,63 @@ +{-| +Module : Text.BBCode +Description : Main module exporting builder interface and types +License : GPL-3 +Stability : experimental +Portability : GHC + +Here is a longer description of this module, containing some +commentary with @some markup@. +-} +module Text.BBCode + ( -- Builder + nl + , text + , doc + , hr + , br + , clear + , listEl + , bold + , italic + , underline + , strikethrough + , indent + , nfo + , oneline + , code + , pre + , box + , image + , quote + , spoiler + , list + , boxAlign + , imageAlign + , quoteNamed + , spoilerNamed + , listFlavor + , color + , url + , size + , align + , font + -- Types + , BBCode (..) + , El (..) + , IsArgument (..) + , AlignPosition (..) + , ListFlavor (..) + , ImagePosition (..) + , BoxPosition (..) + -- Pretty + , pretty + -- Parser + , bbcode + , runParserMaybeEnv + ) +where + +import Text.BBCode.Internal.Builder +import Text.BBCode.Internal.Parser (bbcode, runParserMaybeEnv) +import Text.BBCode.Internal.Pretty +import Text.BBCode.Internal.Types diff --git a/lib/Text/BBCode/Internal/Builder.hs b/lib/Text/BBCode/Internal/Builder.hs new file mode 100644 --- /dev/null +++ b/lib/Text/BBCode/Internal/Builder.hs @@ -0,0 +1,230 @@ +module Text.BBCode.Internal.Builder where + +import Numeric.Natural +import Text.BBCode.Internal.Helper + +{-| Newline + +> nl == 'text' "\n" +-} +nl :: BBCode +nl = text "\n" +{-# INLINE nl #-} + +-- | > text == 'ElText' +text :: Text -> BBCode +text = ElText +{-# INLINE text #-} + +-- | Wrap @['BBCode']@ in 'ElDocument' +doc :: [BBCode] -> BBCode +doc = ElDocument +{-# INLINE doc #-} + +{-| Horizontal line + +> hr == 'ElVoid' 'HR' +-} +hr :: BBCode +hr = ElVoid HR +{-# INLINE hr #-} + +{-| +Line break + +> br == 'ElVoid' 'BR' +-} +br :: BBCode +br = ElVoid BR +{-# INLINE br #-} + +-- | > clear == 'ElVoid' 'Clear' +clear :: BBCode +clear = ElVoid Clear +{-# INLINE clear #-} + +{-| +Notice it is not a function, but a value. + +@listEl@ represents "[*]" + +> listEl == 'ElVoid' 'ListElement' +-} +listEl :: BBCode +listEl = ElVoid ListElement +{-# INLINE listEl #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +bold :: BBCode -> BBCode +bold = ElSimple Bold +{-# INLINE bold #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +italic :: BBCode -> BBCode +italic = ElSimple Italic +{-# INLINE italic #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +underline :: BBCode -> BBCode +underline = ElSimple Underline +{-# INLINE underline #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +strikethrough :: BBCode -> BBCode +strikethrough = ElSimple Strikethrough +{-# INLINE strikethrough #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +indent :: BBCode -> BBCode +indent = ElSimple Indent +{-# INLINE indent #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +nfo :: BBCode -> BBCode +nfo = ElSimple NFO +{-# INLINE nfo #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +oneline :: BBCode -> BBCode +oneline = ElSimple Oneline +{-# INLINE oneline #-} + +-- | 'Code' element contains plain text +code :: Text -> BBCode +code = ElSimple Code . ElText +{-# INLINE code #-} + +-- | 'Preformatted' element contains plain text +pre :: Text -> BBCode +pre = ElSimple Preformatted . ElText +{-# INLINE pre #-} + +{-| +'bold', 'italic', 'underline', and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +box :: BBCode -> BBCode +box = ElSimple Box +{-# INLINE box #-} + +-- | Takes image URL +image :: Text -> BBCode +image = ElSimple Image . ElText +{-# INLINE image #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +quote :: BBCode -> BBCode +quote = ElSimple Quote +{-# INLINE quote #-} + +{-| +bold, italic, underline, and all the rest functions @'BBCode' -> 'BBCode'@ work +the same way by wrapping argument in another element. +-} +spoiler :: BBCode -> BBCode +spoiler = ElSimple Spoiler +{-# INLINE spoiler #-} + +{-| Each element of list is prepended with 'listElement', meaning you can't +create list with contents but without elements + +>>> list [bold "10", italic "15"] +ElSimple List (ElDocument [ElVoid ListElement,ElSimple Bold (ElText "10"),ElVoid ListElement,ElSimple Italic (ElText "15")]) +-} +list :: [BBCode] -> BBCode +list = + ElSimple List + . ElDocument + . foldl (\b a -> b <> [listEl, a]) [] +{-# INLINEABLE list #-} + +-- | Like 'box' but with alignment argument +boxAlign :: BoxPosition -> BBCode -> BBCode +boxAlign arg = ElArg Box (toArgument arg) +{-# INLINE boxAlign #-} + +-- | Like 'image' but with alignment argument +imageAlign :: ImagePosition -> Text -> BBCode +imageAlign arg = ElArg Image (toArgument arg) . ElText +{-# INLINE imageAlign #-} + +-- | Named quote +quoteNamed :: Text -> BBCode -> BBCode +quoteNamed = ElArg Quote +{-# INLINE quoteNamed #-} + +-- | Named spoiler +spoilerNamed :: Text -> BBCode -> BBCode +spoilerNamed = ElArg Spoiler +{-# INLINE spoilerNamed #-} + +{-| Ordered list + +>>> listFlavor LatinUpper [bold "I am bald", boxAlign BoxRight "get boxxxed"] +ElArg List "A" (ElDocument [ElVoid ListElement,ElSimple Bold (ElText "I am bald"),ElVoid ListElement,ElArg Box "right" (ElText "get boxxxed")]) +-} +listFlavor :: Foldable t => ListFlavor -> t BBCode -> BBCode +listFlavor flavor = + ElArg List (toArgument flavor) + . ElDocument + . foldl (\b a -> b <> [listEl, a]) [] +{-# INLINEABLE listFlavor #-} + +{-| Change color of inner BBCode +First argument is either color name (e.g. blue) or hex color(e.g. #333 or #151515) +-} +color :: Text -> BBCode -> BBCode +color = ElArg Color +{-# INLINE color #-} + +{-| Create a hyperlink + +first argument is expected to be valid URL +-} +url :: Text -> BBCode -> BBCode +url = ElArg URL +{-# INLINE url #-} + +{-| Change font size of inner bbcode + +@arg@ ∈ [10, 29] and @arg@ is natural +-} +size :: Natural -> BBCode -> BBCode +size arg = ElArg Size (show' arg) +{-# INLINE size #-} + +align :: AlignPosition -> BBCode -> BBCode +align arg = ElArg Align (toArgument arg) +{-# INLINE align #-} + +{-| Change font of inner BBCode + +argument should be a valid font name +-} +font :: Text -> BBCode -> BBCode +font = ElArg Font +{-# INLINE font #-} diff --git a/lib/Text/BBCode/Internal/Helper.hs b/lib/Text/BBCode/Internal/Helper.hs new file mode 100644 --- /dev/null +++ b/lib/Text/BBCode/Internal/Helper.hs @@ -0,0 +1,97 @@ +module Text.BBCode.Internal.Helper + ( module Text.BBCode.Internal.Helper + , module Control.Lens + , module Data.Text + , module Data.String + , module Text.BBCode.Internal.Types + ) +where + +import Control.Lens hiding (List) +import Data.String (IsString, fromString) +import Data.Text (Text) +import Text.BBCode.Internal.Types + +{- | Get representation of element in form of @IsString a => a@ +@elName HR == "hr"@ +@elName Align == "align"@ +@elName ListElement == "*"@ +-} +elName :: IsString a => El -> a +-- Void elements +elName HR = "hr" +elName BR = "br" +elName Clear = "clear" +elName ListElement = "*" +-- No argumets +elName Bold = "b" +elName Italic = "i" +elName Underline = "u" +elName Strikethrough = "s" +elName Indent = "indent" +elName NFO = "nfo" +elName Oneline = "oneline" +elName Code = "code" +elName Preformatted = "pre" +-- Optional argument +elName Box = "box" +elName Image = "img" +elName Quote = "quote" +elName Spoiler = "spoiler" +elName List = "list" +-- One argument +elName Color = "color" +elName Size = "size" +elName URL = "url" +elName Align = "align" +elName Font = "font" + +{- | Elements that can be opening +e.g. @HR@: @"[hr]"@ or @Bold@: @"[bold]"@ +-} +elementOpenings :: [El] +elementOpenings = [HR .. Font] + +{- | Elements that can be opening and can take argument +e.g. @Box@: @"[box=right]"@ +-} +elementArgOpenings :: [El] +elementArgOpenings = [Box .. Font] + +{- | Elements that can be closing +e.g. @Bold@: @"[/bold]"@ +-} +elementClosings :: [El] +elementClosings = [Bold .. Font] + +show' :: (Show a, IsString b) => a -> b +show' = fromString . show +{-# INLINE show' #-} + +surround :: Text -> Text -> Text +surround s x = mconcat [s, x, s] +{-# INLINE surround #-} + +opening :: El -> Text +opening = (\x -> mconcat ["[", x, "]"]) . elName +{-# INLINE opening #-} + +openingArg :: El -> Text -> Text +openingArg el arg = mconcat ["[", elName el, "=", arg, "]"] +{-# INLINE openingArg #-} + +closing :: El -> Text +closing x = mconcat ["[/", elName x, "]"] +{-# INLINE closing #-} + +wrap :: El -> Text -> Text +wrap el x = mconcat ["[", elName el, "]", x, "[/", elName el, "]"] +{-# INLINE wrap #-} + +wrapArg :: El -> Text -> Text -> Text +wrapArg el arg x = mconcat ["[", elName el, "=", arg, "]", x, "[/", elName el, "]"] + +-- | Combine two predicates with OR +(|||) :: (a -> Bool) -> (a -> Bool) -> (a -> Bool) +(|||) pL pR c = pL c || pR c +{-# INLINE (|||) #-} diff --git a/lib/Text/BBCode/Internal/Parser.hs b/lib/Text/BBCode/Internal/Parser.hs new file mode 100644 --- /dev/null +++ b/lib/Text/BBCode/Internal/Parser.hs @@ -0,0 +1,417 @@ +module Text.BBCode.Internal.Parser + ( Parser + , runParserEnv + , runParserMaybeEnv + , parseTestEnv + , parsers + , bbcode + , bbcode1 + , hr + , br + , clear + , bold + , italic + , underline + , strikethrough + , indent + , nfo + , oneline + , everythingInElement + , code + , preformatted + , box + , boxAlign + , image + , imageAlign + , quote + , quoteNamed + , spoiler + , spoilerNamed + , listElement + , list + , listFlavor + , colorName + , colorHex + , url + , size + , align + , font + , plaintext + ) +where + +import Control.Applicative (Applicative (liftA2)) +import Control.Monad.Reader +import Data.Char (isAsciiLower, isAsciiUpper, isDigit, isSpace) +import Data.Functor (($>)) +import Data.Map (Map) +import Data.Map qualified as M +import Data.Maybe (isNothing) +import Data.Text qualified as T +import Data.Text.IO qualified as T +import Data.Void (Void) +import Text.BBCode.Internal.Helper hiding (closing, opening, openingArg, surround, wrap, wrapArg) +import Text.Megaparsec +import Text.Megaparsec.Char +import Text.Megaparsec.Char.Lexer (charLiteral) + +{-| Parser with reader transformer inside. + +Reader environment contains current context for element. + +It is used for 'oneline' because @"[oneline][oneline][\/oneline][\/oneline]"@ should +produce error. Same with 'nfo' + +Also used by 'plaintext' to end parsing on closing element of current environment. + +>>> parseTestEnv bbcode "[i]Bread[/b][/i]" +ElSimple Italic (ElText "Bread[/b]") + +Notice it parsed @"[\/b]"@. 'plaintext' finishes parsing only on closing element that matches last parsed opening +-} +type Parser a = ParsecT Void Text (Reader [El]) a + +-- | 'runParser' specialized for 'Parser' +runParserEnv :: ParsecT e s (Reader r) a -> r -> s -> Either (ParseErrorBundle s e) a +runParserEnv p env input = runReader (runParserT p "" input) env +{-# INLINEABLE runParserEnv #-} + +-- | 'parseMaybe' specialized for 'Parser' +runParserMaybeEnv :: ParsecT e s (Reader r) a -> r -> s -> Maybe a +runParserMaybeEnv p env input = + runParserEnv p env input & \case + (Right x) -> Just x + _ -> Nothing +{-# INLINEABLE runParserMaybeEnv #-} + +-- | 'parseTest' specialized for 'Parser'. Passes empty list to inner reader monad +parseTestEnv :: Show a => Parser a -> Text -> IO () +parseTestEnv p input = + T.putStrLn + . fromString + . either errorBundlePretty show + $ runParserEnv p [] input +{-# INLINEABLE parseTestEnv #-} + +-- | Same as 'parseTestEnv' but works with HLS's codelenses +mp :: Show a => Parser a -> Text -> IO String +mp parser text = error . either errorBundlePretty show $ runParserEnv parser [] text + +opening :: El -> Parser () +opening el = void . string' $ mconcat ["[", elName el, "]"] +{-# INLINEABLE opening #-} + +openingArg :: El -> Parser a -> Parser a +openingArg el p = do + void . try . string' $ mconcat ["[", elName el, "="] + res <- p + void . char $ ']' + pure res +{-# INLINEABLE openingArg #-} + +closing :: El -> Parser () +closing el = void . string' $ mconcat ["[/", elName el, "]"] +{-# INLINEABLE closing #-} + +localAddEl :: MonadReader [r] m => r -> m a -> m a +localAddEl el = local (<> [el]) +{-# INLINEABLE localAddEl #-} + +elVoid :: El -> Parser BBCode +elVoid el = opening el $> ElVoid el +{-# INLINEABLE elVoid #-} + +elSimple :: El -> Parser BBCode -> Parser BBCode +elSimple el body = do + opening el + res <- localAddEl el body + closing el + pure $ ElSimple el res +{-# INLINEABLE elSimple #-} + +elArg :: El -> Parser Text -> Parser BBCode -> Parser BBCode +elArg el arg body = do + a <- openingArg el arg + b <- localAddEl el body + closing el + pure $ ElArg el a b +{-# INLINEABLE elArg #-} + +{-|All parsers used by 'bbcode' and 'bbcode1' + +Keys are element names and values are associated element parsers. + +Values are lists because some elements have optional element. +That means they are two separate parsers, e.g. +'Box' element parsers are 'box' (simple element) and 'boxAlign' (element with +parameter) +-} +parsers :: Map El [Parser BBCode] +parsers = + M.fromList + [ (HR, [hr]) + , (BR, [br]) + , (Clear, [clear]) + , (ListElement, [listElement]) + , (Bold, [bold]) + , (Italic, [italic]) + , (Underline, [underline]) + , (Strikethrough, [strikethrough]) + , (Indent, [indent]) + , (NFO, [nfo]) + , (Oneline, [oneline]) + , (Code, [code]) + , (Preformatted, [preformatted]) + , (Box, [box, boxAlign]) + , (Image, [image, imageAlign]) + , (Quote, [quote, quoteNamed]) + , (Spoiler, [spoiler, spoilerNamed]) + , (List, [list, listFlavor]) + , (Color, [colorName, colorHex]) + , (Size, [size]) + , (URL, [url]) + , (Align, [align]) + , (Font, [font]) + ] +{-# NOINLINE parsers #-} + +{-| Parse zero or more BBCode elements +Doesn't necessarily return value wrapped in 'ElDocument', it returns +@('mempty' :: BBCode)@ if it parses no elements, or just element if parses +just one element. Otherwise it is 'ElDocument' +-} +bbcode :: Parser BBCode +bbcode = do + many (choice $ concat parsers <> [plaintext]) + <&> \case + [] -> mempty + [x] -> x + xs -> ElDocument xs +{-# NOINLINE bbcode #-} + +-- | Similar to 'bbcode' but parses one or more elements +bbcode1 :: Parser BBCode +bbcode1 = + some (choice $ concat parsers) + <&> \case + [x] -> x + xs -> ElDocument xs +{-# NOINLINE bbcode1 #-} + +hr :: Parser BBCode +hr = elVoid HR +{-# INLINEABLE hr #-} + +br :: Parser BBCode +br = elVoid BR +{-# INLINEABLE br #-} + +clear :: Parser BBCode +clear = elVoid Clear +{-# INLINEABLE clear #-} + +bold :: Parser BBCode +bold = elSimple Bold bbcode + +italic :: Parser BBCode +italic = elSimple Italic bbcode + +underline :: Parser BBCode +underline = elSimple Underline bbcode + +strikethrough :: Parser BBCode +strikethrough = elSimple Strikethrough bbcode + +indent :: Parser BBCode +indent = elSimple Indent bbcode + +nfo :: Parser BBCode +nfo = do + insideNFO <- preview (folded . filtered (== NFO)) + if isNothing insideNFO + then elSimple NFO bbcode + else fail "Can't parse [nfo] inside [nfo]" + +oneline :: Parser BBCode +oneline = do + insideOneline <- preview (folded . filtered (== Oneline)) + if isNothing insideOneline + then elSimple Oneline bbcode + else fail "Can't parse [oneline] inside [oneline]" + +-- BUG: in a string "[code][code][/code][/code]" parser only does +-- +-- >>> mp (everythingInElement Code) "[code][code][/code][/code]" +-- ElSimple Code (ElText "[code]") +-- >>> mp (everythingInElement Code <* eof) "[code][code][/code][/code]" +-- 1:20: +-- | +-- 1 | [code][code][/code][/code] +-- | ^ +-- unexpected '[' +-- expecting end of input +everythingInElement :: El -> Parser BBCode +everythingInElement el = elSimple el $ do + let bc = do + r <- takeWhileP Nothing (/= '[') + end <- lookAhead . optional $ closing el + if isNothing end + then (r <>) <$> liftA2 (<>) (takeP Nothing 1) bc + else pure r + ElText <$> bc +{-# INLINEABLE everythingInElement #-} + +-- >>> mp (code <* eof) "[code][code][/code][/code]" +code :: Parser BBCode +code = everythingInElement Code +{-# INLINEABLE code #-} + +preformatted :: Parser BBCode +preformatted = everythingInElement Preformatted +{-# INLINEABLE preformatted #-} + +box :: Parser BBCode +box = elSimple Box bbcode + +image :: Parser BBCode +image = elSimple Image $ ElText <$> takeWhile1P (Just "URL") (/= '[') +{-# INLINEABLE image #-} + +quote :: Parser BBCode +quote = elSimple Quote bbcode + +spoiler :: Parser BBCode +spoiler = elSimple Spoiler bbcode + +listElement :: Parser BBCode +listElement = do + isInsideList <- has (_Just . _List) <$> preview _last + unless isInsideList $ fail "Not inside list" + res <- elVoid ListElement + void $ takeWhileP Nothing isSpace + pure res + +list :: Parser BBCode +list = elSimple List bbcode + +boxAlign :: Parser BBCode +boxAlign = elArg Box (string "left" <|> string "center" <|> string "right") bbcode + +imageAlign :: Parser BBCode +imageAlign = + elArg Image (string "left" <|> string "right") $ + ElText <$> takeWhile1P (Just "URL") (/= '[') +{-# INLINEABLE imageAlign #-} + +quoteNamed :: Parser BBCode +quoteNamed = elArg Quote arg bbcode + where + arg = + fmap T.pack . label "quote author in quotes(e.g. [quote=\"Dan\"])" $ + char '"' *> manyTill charLiteral (char '"') + +spoilerNamed :: Parser BBCode +spoilerNamed = elArg Spoiler arg bbcode + where + arg = + fmap T.pack . label "spoiler name in quotes (e.g. [spoiler=\"The ending is\"])" $ + char '"' *> manyTill charLiteral (char '"') + +listFlavor :: Parser BBCode +listFlavor = + elArg + List + (choice $ string <$> ["a", "A", "i", "I", "1"]) + bbcode + +-- >>> mp colorName "[color=gray][/color]" +-- ElArg Color "GreEn" (ElText "") +colorName :: Parser BBCode +colorName = + elArg + Color + ( takeWhile1P + (Just "Color name") + (\c -> isAsciiLower c || isAsciiUpper c || isDigit c) + ) + bbcode + +-- >>> mp colorHex "[color=#333][/color]" +-- ElArg Color "#333" (ElText "") +-- >>> mp colorHex "[color=#333Faa][/color]" +-- ElArg Color "#333Faa" (ElText "") +colorHex :: Parser BBCode +colorHex = + elArg + Color + ( label "hex color(e.g. #333 or #123456)" $ do + hash :: Char <- char '#' + name :: String <- + try (count 6 hexDigitChar) + <|> count 3 hexDigitChar + pure . T.pack $ hash : name + ) + bbcode + +url :: Parser BBCode +url = elArg URL (takeWhileP (Just "URL") (/= ']')) bbcode + +size :: Parser BBCode +size = + elArg + Size + (choice $ string . fromString . show <$> ([10 .. 29] :: [Int])) + bbcode + +align :: Parser BBCode +align = + elArg + Align + (choice $ string <$> ["left", "right", "center", "justify"]) + bbcode + +font :: Parser BBCode +font = + elArg + Font + ( takeWhile1P + (Just "font name(digits and latin letters)") + (isAsciiLower ||| isAsciiUpper ||| isDigit) + ) + bbcode + +plaintext :: Parser BBCode +plaintext = do + currentElement <- preview _last + let bc = do + res <- takeWhile1P Nothing (/= '[') + end <- -- Attempts to find element that will end parsing + lookAhead . optional . choice . concat $ + [ -- Opening element ends parsing text(only simple elements) + elementOpenings + ^.. folded + . to elName + . to (\el -> mconcat ["[", el, "]"]) + . to string' + , -- Opening element ends parsing text. + -- Note that it produces opening element without closing bracket, + -- because we can't predict what an argument will be + elementArgOpenings + ^.. folded + . to elName + . to ("[" <>) + . to string' + , -- Current closing element (last element in reader environment) + currentElement + ^.. _Just + . to closing + . to ($> "") + , [eof $> ""] + ] + if isNothing end + then -- continue parsing text + (res <>) <$> liftA2 (<>) (takeP Nothing 1) bc + else -- end parsing + pure res + ElText <$> bc +{-# INLINEABLE plaintext #-} diff --git a/lib/Text/BBCode/Internal/Pretty.hs b/lib/Text/BBCode/Internal/Pretty.hs new file mode 100644 --- /dev/null +++ b/lib/Text/BBCode/Internal/Pretty.hs @@ -0,0 +1,69 @@ +{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-} + +{-# HLINT ignore "Use record patterns" #-} +module Text.BBCode.Internal.Pretty + ( pretty + ) +where + +import Text.BBCode.Internal.Helper + +{- ORMOLU_DISABLE -} + +{- | Serialize BBCode AST + +Should be reversible by parsing, but it is not guaranteed + +Can cause error at runtime if unrepresentable element is passed, e.g. +>>> pretty $ ElSimple HR "abc" +Prelude.undefined +-} +pretty :: BBCode -> Text +pretty (ElText x) = x +pretty (ElDocument xs) = mconcat $ fmap pretty xs + +pretty (ElVoid HR) = opening HR <> "\n" +pretty (ElVoid BR) = opening BR <> "\n" +pretty (ElVoid Clear) = opening Clear <> "\n" +pretty (ElVoid ListElement) = "\n" <> opening ListElement +pretty (ElVoid _) = undefined + +pretty (ElSimple Bold bb) = wrap Bold $ pretty bb +pretty (ElSimple Italic bb) = wrap Italic $ pretty bb +pretty (ElSimple Underline bb) = wrap Underline $ pretty bb +pretty (ElSimple Strikethrough bb) = wrap Strikethrough $ pretty bb +pretty (ElSimple Indent bb) = wrap Indent $ pretty bb +pretty (ElSimple NFO bb) = wrap NFO $ pretty bb +pretty (ElSimple Oneline bb) = wrap Oneline $ pretty bb +pretty (ElSimple Code bb) = wrap Code $ pretty bb +pretty (ElSimple Preformatted bb) = wrap Preformatted $ pretty bb + +pretty (ElSimple Box bb) = wrap Box $ pretty bb +pretty (ElSimple Image bb) = wrap Image $ pretty bb +pretty (ElSimple Quote bb) = wrap Quote . surround "\n" $ pretty bb +pretty (ElSimple Spoiler bb) = wrap Spoiler . surround "\n" $ pretty bb +pretty (ElSimple List (ElDocument bb)) = + wrap List + . (<> "\n") + . foldl (<>) "" + $ fmap pretty bb +pretty (ElSimple _ _) = undefined + +pretty (ElArg Box arg bb) = wrapArg Box arg $ pretty bb +pretty (ElArg Image arg bb) = wrapArg Image arg $ pretty bb +pretty (ElArg Quote arg bb) = wrapArg Quote (show' arg) $ pretty bb +pretty (ElArg Spoiler arg bb) = wrapArg Spoiler (show' arg) $ pretty bb +pretty (ElArg List arg (ElDocument bb)) = + wrapArg List arg + . (<> "\n") + . foldl (<>) "" + $ fmap pretty bb + +pretty (ElArg Color arg bb) = wrapArg Color arg $ pretty bb +pretty (ElArg URL arg bb) = wrapArg URL arg $ pretty bb +pretty (ElArg Size arg bb) = wrapArg Size arg $ pretty bb +pretty (ElArg Align arg bb) = wrapArg Align arg $ pretty bb +pretty (ElArg Font arg bb) = wrapArg Font arg $ pretty bb +pretty (ElArg _ _ _) = undefined +{-# INLINEANBLE pretty #-} +{- ORMOLU_ENABLE -} diff --git a/lib/Text/BBCode/Internal/Types.hs b/lib/Text/BBCode/Internal/Types.hs new file mode 100644 --- /dev/null +++ b/lib/Text/BBCode/Internal/Types.hs @@ -0,0 +1,197 @@ +{-# LANGUAGE StrictData #-} +{-# LANGUAGE TemplateHaskell #-} + +module Text.BBCode.Internal.Types where + +import Control.Lens hiding (List) +import Data.String (IsString (..)) +import Data.Text (Text) + +-- |BBCode AST +data BBCode where + -- |Element that has neither closing part nor arguments + -- + -- @'ElVoid' 'HR'@ represents "[hr]" + ElVoid :: El -> BBCode + -- |Element that has closing part but no arguments + -- + -- @'ElSimple' 'Bold' ('ElText' "abc")@ represents @"[b]abc[/b]"@ + ElSimple :: El -> BBCode -> BBCode + -- |Element that has closing part and exactly one argument + -- + -- @'ElArg' 'Color' "red" ('ElText' "I am red")@ represents @"[color=red]I am red[/color]"@ + ElArg :: El -> Text -> BBCode -> BBCode + -- |Plain text + -- + -- @'ElText' "I am text" represents @"I am text"@ + ElText :: Text -> BBCode + -- |Just a list of BBCode elements, just as type signature says. + -- + -- @'ElDocument' ['ElSimple' 'Bold' ('ElText' "Bold not bald"), 'ElText' "legit text"]@ + -- represents @"[b]Bold not bald[/b]legit text"@ + ElDocument :: [BBCode] -> BBCode + deriving + ( Eq + , -- |Don't use it to render BBCode! + Show + ) + +instance Semigroup BBCode where + (<>) :: BBCode -> BBCode -> BBCode + (<>) (ElText x) (ElText y) = ElText $ x <> y + (<>) (ElText "") y = y + (<>) x (ElText "") = x + (<>) (ElDocument xs) (ElDocument ys) = ElDocument $ xs <> ys + (<>) (ElDocument xs) y = ElDocument $ xs <> [y] + (<>) x (ElDocument ys) = ElDocument $ [x] <> ys + (<>) x y = ElDocument [x, y] + {-# INLINEABLE (<>) #-} + +{- | +Identity is defined as zero-width Text + +>>> mempty :: BBCode +ElText "" +-} +instance Monoid BBCode where + mempty :: BBCode + mempty = ElText "" + {-# INLINE mempty #-} + +{- | +Allows easier BBCode construction + +>>> ElSimple Bold "I am bold" +ElSimple Bold (ElText "I am bold") + +Recall that 'ElSimple' takes 'El' and 'BBCode', but not 'Text' +-} +instance IsString BBCode where + fromString :: String -> BBCode + fromString = ElText . fromString + {-# INLINE fromString #-} + +{- ORMOLU_DISABLE -} +{- | +Type of an element. 'BBCode' declares three constructors for elements: 'ElVoid', 'ElSimple', 'ElArg'. But 'El' can be split into four cateogories: +1) void elements, +2) simple elements, +3) elements with optional argument, +4) element with one argument + +There is no enforcement of combining 'BBCode' constuctors and 'El' values, that means you can create @ElSimple HR (ElText "smth")@ but that would make no sense. 'Text.BBCode.pretty' would emit a runtime error if you try to pass such value. +-} +data El + = HR -- ^ void element + | BR -- ^ void element + | Clear -- ^ void element + | ListElement -- ^ void element + + | Bold -- ^ simple element + | Italic -- ^ simple element + | Underline -- ^ simple element + | Strikethrough -- ^ simple element + | Indent -- ^ simple element + | NFO -- ^ simple element + | Oneline -- ^ simple element + | Code -- ^ simple element + | Preformatted -- ^ simple element + + | Box -- ^ element with optional argument + | Image -- ^ element with optional argument + | Quote -- ^ element with optional argument + | Spoiler -- ^ element with optional argument + | List -- ^ element with optional argument + + | Color -- ^ element with one argument + | URL -- ^ element with one argument + | Size -- ^ element with one argument + | Align -- ^ element with one argument + | Font -- ^ element with one argument + deriving + ( Eq + , Ord -- ^ Allows having 'Data.Map.Map' with key type 'El' (used in Parser) + , Show + , Enum -- ^ Allows internal module to quickly list elements of different categories (Void, Simple, Optional, One) + , Bounded -- ^ Addition to Enum instance + ) +{- ORMOLU_ENABLE -} + +{- | +Used for building BBCode safely. Instead of passing 'Text' to builder functions, +you pass values of types that implement 'IsArgument'. Then 'toArgument' is used +to convert that value to Text. +-} +class IsArgument a where + toArgument :: a -> Text + +-- | Argument to 'Text.BBCode.align' +data AlignPosition where + AlignLeft :: AlignPosition + AlignRight :: AlignPosition + AlignCenter :: AlignPosition + AlignJustify :: AlignPosition + deriving (Eq, Show) + +instance IsArgument AlignPosition where + toArgument :: AlignPosition -> Text + toArgument AlignLeft = "left" + toArgument AlignRight = "right" + toArgument AlignCenter = "center" + toArgument AlignJustify = "justify" + {-# INLINEABLE toArgument #-} + +-- | Argument to 'Text.BBCode.listFlavor' +data ListFlavor where + -- | Numeric 1, 2, 3,.. + Roman :: ListFlavor + -- | Arabic I, II, III,.. + ArabicUpper :: ListFlavor + -- | Arabic i, ii, iii,.. + ArabicLower :: ListFlavor + -- | Alphabetical A, B, C,.. + LatinUpper :: ListFlavor + -- | Alphabetical a, b, c,.. + LatinLower :: ListFlavor + deriving (Eq, Show) + +instance IsArgument ListFlavor where + toArgument :: ListFlavor -> Text + toArgument Roman = "1" + toArgument ArabicUpper = "I" + toArgument ArabicLower = "i" + toArgument LatinUpper = "A" + toArgument LatinLower = "a" + {-# INLINEABLE toArgument #-} + +-- | Argument to 'Text.BBCode.imageAlign' +data ImagePosition where + ImageLeft :: ImagePosition + ImageRight :: ImagePosition + deriving (Eq, Show) + +instance IsArgument ImagePosition where + toArgument :: ImagePosition -> Text + toArgument ImageLeft = "left" + toArgument ImageRight = "right" + {-# INLINEABLE toArgument #-} + +-- | Argument to 'Text.BBCode.boxAlign' +data BoxPosition where + BoxLeft :: BoxPosition + BoxCenter :: BoxPosition + BoxRight :: BoxPosition + deriving (Eq, Show) + +instance IsArgument BoxPosition where + toArgument :: BoxPosition -> Text + toArgument BoxLeft = "left" + toArgument BoxCenter = "center" + toArgument BoxRight = "right" + {-# INLINEABLE toArgument #-} + +makePrisms ''BBCode +makePrisms ''AlignPosition +makePrisms ''ListFlavor +makePrisms ''ImagePosition +makePrisms ''El diff --git a/lib/Text/BBCode/Lens.hs b/lib/Text/BBCode/Lens.hs new file mode 100644 --- /dev/null +++ b/lib/Text/BBCode/Lens.hs @@ -0,0 +1,43 @@ +module Text.BBCode.Lens + ( _ElArg + , _ElDocument + , _ElSimple + , _ElText + , _ElVoid + , _AlignCenter + , _AlignJustify + , _AlignLeft + , _AlignRight + , _ArabicLower + , _ArabicUpper + , _LatinLower + , _LatinUpper + , _Roman + , _ImageLeft + , _ImageRight + , _Align + , _BR + , _Bold + , _Box + , _Clear + , _Code + , _Color + , _Font + , _HR + , _Image + , _Indent + , _Italic + , _List + , _ListElement + , _NFO + , _Oneline + , _Preformatted + , _Quote + , _Size + , _Spoiler + , _Strikethrough + , _URL + , _Underline + ) where + +import Text.BBCode.Internal.Types diff --git a/lib/Text/BBCode/Parser.hs b/lib/Text/BBCode/Parser.hs new file mode 100644 --- /dev/null +++ b/lib/Text/BBCode/Parser.hs @@ -0,0 +1,42 @@ +module Text.BBCode.Parser + ( Parser + , runParserEnv + , runParserMaybeEnv + , parseTestEnv + , parsers + , bbcode + , bbcode1 + , hr + , br + , clear + , bold + , italic + , underline + , strikethrough + , indent + , nfo + , oneline + , everythingInElement + , code + , preformatted + , box + , boxAlign + , image + , imageAlign + , quote + , quoteNamed + , spoiler + , spoilerNamed + , listElement + , list + , listFlavor + , colorName + , colorHex + , url + , size + , align + , font + , plaintext + ) where + +import Text.BBCode.Internal.Parser diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,4 @@ +module Main (main) where + +main :: IO () +main = putStrLn "Test suite not yet implemented."