diff --git a/ChangeLog.md b/ChangeLog.md --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,5 +1,10 @@ # Revision history for stylist +## 2.6.0 -- 2023-05-04 +* Improved text generation +* Added infrastructure forwarding pseudoelements to PropertyParsers +* @counter-style support, with large builtin suite. + ## 2.4.0 -- 2020-12-31 * Add `@document regexp()` support via TDFA. * Allow callers to define psuedoclasses via callbacks on attribute value. diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,20 +1,674 @@ -Copyright (c) 2019 Adrian Cochrane + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: + 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. -The above copyright notice and this permission notice shall be included -in all copies or substantial portions of the Software. + Preamble -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + 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/src/Data/CSS/Preprocessor/Text.hs b/src/Data/CSS/Preprocessor/Text.hs --- a/src/Data/CSS/Preprocessor/Text.hs +++ b/src/Data/CSS/Preprocessor/Text.hs @@ -1,20 +1,25 @@ {-# LANGUAGE OverloadedStrings #-} -- | Lowers certain CSS properties to plain text. -module Data.CSS.Preprocessor.Text(TextStyle, resolve) where +module Data.CSS.Preprocessor.Text( + TextStyle, resolve, resolveWithCounterStyles, CounterStore'(..)) where import Data.CSS.Syntax.Tokens (Token(..), NumericValue(..)) -import Data.CSS.Style (PropertyParser(..)) +import Stylist (parseUnorderedShorthand, PropertyParser(..)) +import Stylist.Parse (scanBlock) import Data.CSS.StyleTree import qualified Data.Text as Txt import Data.Text (Text) +import Data.CSS.Preprocessor.Text.CounterStyle + (parseCounter, counterRender, CounterStore'(..), decimalCounter, + defaultCounterStore, CounterStore, CounterStyle(..), speakAs') -import Data.Maybe (fromMaybe) +import Data.Maybe (fromMaybe, isJust) import qualified Data.HashMap.Lazy as M import Data.Function ((&)) import Data.Char (isSpace) -type Counters = [(Text, Integer)] +type Counters = [(Text, Int)] -- | `PropertyParser` decorator that parses & lowers certain CSS properties to plain text. data TextStyle p = TextStyle { inner :: p, @@ -25,7 +30,18 @@ counterSet :: Counters, whiteSpaceCollapse :: Bool, - newlineCollapse :: Bool + newlineCollapse :: Bool, + + isListItem :: Bool, + listStyleImage :: [Token], + listStyleType :: [Token], + listPosInside :: Bool, + markerIsRight :: Maybe Bool, + isRTL :: Bool, + + beforePseudo :: Maybe (TextStyle p), + afterPseudo :: Maybe (TextStyle p), + markerPseudo :: Maybe (TextStyle p) } instance PropertyParser p => PropertyParser (TextStyle p) where @@ -36,7 +52,16 @@ counterIncrement = [], counterSet = [], whiteSpaceCollapse = True, - newlineCollapse = True + newlineCollapse = True, + isListItem = False, + listStyleImage = [], + listStyleType = [Ident "disc"], + listPosInside = False, + markerIsRight = Nothing, + isRTL = False, + beforePseudo = Nothing, + afterPseudo = Nothing, + markerPseudo = Nothing } inherit parent = TextStyle { inner = inherit $ inner parent, @@ -45,7 +70,17 @@ counterIncrement = [], counterSet = [], whiteSpaceCollapse = whiteSpaceCollapse parent, - newlineCollapse = newlineCollapse parent + newlineCollapse = newlineCollapse parent, + isListItem = False, + listStyleImage = listStyleImage parent, + listStyleType = listStyleType parent, + listPosInside = listPosInside parent, + markerIsRight = if isJust $ markerIsRight parent + then Just $ isRTL parent else Nothing, + isRTL = isRTL parent, + beforePseudo = Nothing, + afterPseudo = Nothing, + markerPseudo = Nothing } shorthand _ key value @@ -54,6 +89,8 @@ shorthand self "white-space" [Ident val] | val `elem` ["normal", "pre", "pre-wrap", "pre-line"] = [("white-space", [Ident val])] | otherwise = shorthand (inner self) "white-space" [Ident val] + shorthand self "list-style" toks = parseUnorderedShorthand self subprops toks + where subprops = ["list-style-image", "list-style-type", "list-style-position"] shorthand TextStyle { inner = s } k v | Just _ <- longhand s s k $ removeCounters v = [(k, v)] | otherwise = shorthand s k v @@ -69,57 +106,221 @@ longhand p self "white-space" [Ident "pre-wrap"] = setWhiteSpace p self False False "normal" longhand p self "white-space" [Ident "pre-line"] = setWhiteSpace p self True False "normal" + longhand p self@TextStyle {inner=self'} "display" [Ident "list-item"] = + Just self { + isListItem = True, + inner = fromMaybe self' $ + longhand (inner p) self' "display" [Ident "block"] + } + longhand TextStyle {inner=p'} self@TextStyle {inner = self'} "display" value + | Just ret <- longhand p' self' "display" value = Just self { + isListItem = False, + inner = ret + } + | otherwise = Nothing + + longhand _ self "list-style-image" [Ident kw] | kw `elem` ["initial", "none"] + = Just self { listStyleImage = [] } + longhand TextStyle { inner = p' } self@TextStyle { inner = self' } + "list-style-image" value + | Just _ <- longhand p' self' "background-image" value = Just self { + listStyleImage = value -- This is a valid image according to caller. + } + | otherwise = Nothing + longhand _ self "list-style-type" [Ident "initial"] = + Just self { listStyleType = [Ident "disc"] } + longhand _ self "list-style-type" toks | Just _ <- parseCounter M.empty toks = + Just self { listStyleType = toks } + longhand _ self "list-style-position" [Ident "inside"] = + Just self { listPosInside = True } + longhand _ self "list-style-position" [Ident "outside"] = + Just self { listPosInside = False } + longhand _ self "list-style-position" [Ident "initial"] = + Just self { listPosInside = False } + + longhand _ self "marker-side" [Ident "match-self"] = + Just self { markerIsRight = Nothing } + longhand parent self "marker-side" [Ident "match-parent"] = + Just self { markerIsRight = Just $ isRTL parent } + longhand _ self "marker-side" [Ident "initial"] = + Just self { markerIsRight = Nothing } + longhand _ self k@"direction" v@[Ident "ltr"] = Just self { + isRTL = False, counterProps = insertList k v $ counterProps self } + longhand _ self k@"direction" v@[Ident "rtl"] = Just self { + isRTL = True, counterProps = insertList k v $ counterProps self } + longhand _ self k@"direction" v@[Ident "initial"] = Just self { + isRTL = False, counterProps = insertList k v $ counterProps self } + -- Capture `content` properties & anything else using counter(s) functions. -- This is important in Rhapsode for the sake of navigational markers. + -- Ignoring invalid properties. + longhand TextStyle { inner = p' } TextStyle { inner = self' } key value + | Nothing <- longhand p' self' key $ removeCounters value = Nothing + longhand _ self "content" [Ident "normal"] = + Just self { + counterProps = + [(k, val) | (k, val) <- counterProps self, k /= "content"] + } longhand parent self key value | key == "content" || Function "counter" `elem` value || Function "counters" `elem` value = Just $ self { counterProps = insertList key value $ counterProps self } - | otherwise = (\v -> self {inner = v}) <$> longhand (inner parent ) (inner self) key value + | otherwise = (\v -> self {inner = v}) <$> + longhand (inner parent ) (inner self) key value + pseudoEl self "before" calc = self { beforePseudo = Just $ calc self Nothing } + pseudoEl self "after" calc = self { afterPseudo = Just $ calc self Nothing } + pseudoEl self "marker" calc = self { markerPseudo = Just $ calc self Nothing } + pseudoEl self sel calc = self { + inner = pseudoEl (inner self) sel calc' + } where + calc' parent (Just base) = + inner $ calc temp { inner = parent } $ Just temp { inner = base } + calc' parent Nothing = inner $ calc temp { inner = parent } Nothing + insertList :: Eq a => a -> b -> [(a, b)] -> [(a, b)] insertList key value list | Nothing <- lookup key list = (key, value) : list | otherwise = [(k, if k == key then value else v) | (k, v) <- list] removeCounters :: [Token] -> [Token] removeCounters (Function "counter":Ident _:RightParen:toks) = String "" : removeCounters toks -removeCounters (Function "counters":Ident _:Comma:String _:toks) = String "" : removeCounters toks +removeCounters (Function "counter":Ident _:Comma:toks) + | Just (_, RightParen:toks') <- parseCounter0 toks = String "" : removeCounters toks' +removeCounters (Function "counters":Ident _:Comma:String _:RightParen:toks) = + String "" : removeCounters toks +removeCounters (Function "counters":Ident _:Comma:String _:Comma:toks) + | Just (_, RightParen:toks') <- parseCounter0 toks = String "" : removeCounters toks' removeCounters (tok:toks) = tok : removeCounters toks removeCounters [] = [] +parseCounter0 :: [Token] -> Maybe (CounterStyle, [Token]) +parseCounter0 = parseCounter M.empty + setWhiteSpace :: PropertyParser p => TextStyle p -> TextStyle p -> Bool -> Bool -> Text -> Maybe (TextStyle p) setWhiteSpace parent self collapse noNewlines lowered = Just $ self { inner = inner self `fromMaybe` longhand (inner parent) (inner self) "white-space" [Ident lowered], whiteSpaceCollapse = collapse, newlineCollapse = noNewlines } -parseCounters :: Integer -> [Token] -> Maybe [(Text, Integer)] +parseCounters :: Int -> [Token] -> Maybe [(Text, Int)] parseCounters _ [Ident "none"] = Just [] parseCounters _ [Ident "initial"] = Just [] parseCounters _ [] = Just [] parseCounters x (Ident counter : Number _ (NVInteger count') : toks) = - (:) (counter, count') <$> parseCounters x toks + (:) (counter, fromIntegral count') <$> parseCounters x toks parseCounters x (Ident counter : toks) = (:) (counter, x) <$> parseCounters x toks parseCounters _ _ = Nothing -- | Returns inner `PropertyParser` with text properties applied. resolve :: PropertyParser p => StyleTree (TextStyle p) -> StyleTree p -resolve = resolve' . collapseWS . applyCounters +resolve = resolveWithCounterStyles defaultCounterStore +resolveWithCounterStyles :: PropertyParser p => + CounterStore' -> StyleTree (TextStyle p) -> StyleTree p +resolveWithCounterStyles (CounterStore counters) = + resolve' . collapseWS . applyCounters counters . insertPseudos counters resolve' :: PropertyParser p => StyleTree (TextStyle p) -> StyleTree p resolve' = treeMap $ \TextStyle {inner = inner', counterProps = props} -> foldl resolveProp inner' props resolveProp :: PropertyParser p => p -> (Text, [Token]) -> p resolveProp sty (key, value) = sty `fromMaybe` longhand temp sty key value -------- +---- Lists & pseudo-elements +-------- + +insertPseudos :: PropertyParser p => + CounterStore -> StyleTree (TextStyle p) -> StyleTree (TextStyle p) +insertPseudos s (StyleTree self@TextStyle { afterPseudo = Just child } childs) = + insertPseudos s $ + StyleTree self { afterPseudo = Nothing } (childs ++ [t Nothing child]) +insertPseudos s (StyleTree self@TextStyle { beforePseudo = Just child } childs) = + insertPseudos s $ StyleTree self { beforePseudo = Nothing } + (t Nothing child:childs) + +insertPseudos s (StyleTree self@TextStyle { markerPseudo = Nothing } childs) = + insertPseudos s $ StyleTree self { markerPseudo = Just temp } childs +insertPseudos s self@(StyleTree TextStyle { markerPseudo = Just child} _) + | Just text <- lookup "content" $ counterProps child = + addBullet self s Nothing text +insertPseudos s self@(StyleTree TextStyle { listStyleImage = bullet@(_:_) } _) = + addBullet self s Nothing (bullet ++ [String " "]) +insertPseudos s self@(StyleTree TextStyle { listStyleType = bullet@(_:_) } _) + | Just (cstyle, _) <- parseCounter s bullet = + addBullet self s (Just cstyle) $ text cstyle + where + text counter = String (prefix counter): + Function "counter":Ident "list-item":Comma:bullet ++ + [String $ suffix counter] + +insertPseudos store (StyleTree self childs) = + StyleTree self $ map (insertPseudos store) childs + +addBullet :: PropertyParser p => StyleTree (TextStyle p) -> + CounterStore -> Maybe CounterStyle -> [Token] -> StyleTree (TextStyle p) +addBullet (StyleTree self@TextStyle { + counterIncrement = counters, isListItem = True + } childs) store cstyle txt | Nothing <- lookup "list-item" counters = + addBullet (StyleTree self { + counterIncrement = ("list-item", 1):counterIncrement self + } childs) store cstyle txt +addBullet (StyleTree self@TextStyle { + isListItem = True, listPosInside = True, markerPseudo = Just child + } childs) store cstyle txt = insertPseudos store $ + StyleTree self { isListItem = False } (t cstyle child { + counterProps = insertList "content" txt $ counterProps child + } : childs) +addBullet (StyleTree s@TextStyle {markerIsRight=Nothing} childs) store cstyle txt + = addBullet (StyleTree s { markerIsRight = Just $ isRTL s } childs) + store cstyle txt +addBullet (StyleTree self@TextStyle { markerIsRight = Just False, + isListItem = True, listPosInside = False, markerPseudo = Just child + } childs) store cstyle txt = insertPseudos store $ + StyleTree self { + isListItem = False, + -- Flex lays out children horizontally at min size. + counterProps=insertList "display" [Ident "flex"] $ counterProps child + } [ + t cstyle child { + counterProps = insertList "content" txt $ counterProps child + }, + -- Generate a new layout box for the bullet to sit outside of. + StyleTree temp childs + ] +addBullet (StyleTree self@TextStyle { markerIsRight = Just True, + isListItem = True, listPosInside = False, markerPseudo = Just child + } childs) store cstyle txt = insertPseudos store $ + StyleTree self { + isListItem = False, + counterProps=insertList "display" [Ident "flex"] $ counterProps child + } [ + StyleTree temp childs, + t cstyle child { + counterProps = insertList "content" txt $ counterProps child + } + ] +addBullet (StyleTree self childs) store _ _ = + insertPseudos store $ StyleTree self { + isListItem = False, + listStyleImage = [], listStyleType = [] + } childs + +t :: Maybe CounterStyle -> TextStyle p -> StyleTree (TextStyle p) +t (Just cstyle) self = StyleTree self { + counterProps = insertList "speak-as" [Ident $ speakAs' cstyle] $ + counterProps self } [] +t Nothing self = StyleTree self [] + +-------- ---- Counters -------- -type Context = M.HashMap Text [([Integer], Integer)] +type Context = M.HashMap Text [([Integer], Int)] inheritCounters :: Context -> Context -> Context -inheritCounters counterSource valueSource = M.intersectionWith cb valueSource counterSource -- indexed by name & el-path - where cb val source = [counter | counter@(path, _) <- val, path `elem` [p | (p, _) <- source]] +inheritCounters counterSource valueSource = M.unionWith cb valueSource counterSource -- indexed by name & el-path + where cb val source = [counter | counter@(path, _) <- val, + path `elem` [p | (p, _) <- source]] -instantiateCounter :: Context -> Path -> Text -> Integer -> Context -instantiateCounter counters path name val = M.insertWith appendCounter name [(path, val)] counters +instantiateCounter :: Context -> Path -> Text -> Int -> Context +instantiateCounter counters path name val = + M.insertWith appendCounter name [(path, val)] counters where appendCounter new (old@((_:oldPath), _):olds) | oldPath == tail path = new ++ olds @@ -130,8 +331,9 @@ instantiateCounters path instruct counters = foldl cb counters instruct where cb counters' (name, value) = instantiateCounter counters' path name value -incrementCounter :: Context -> Path -> Text -> Integer -> Context -incrementCounter counters path name val = M.insertWith addCounter name [(path, val)] counters +incrementCounter :: Context -> Path -> Text -> Int -> Context +incrementCounter counters path name val = + M.insertWith addCounter name [(path, val)] counters where addCounter ((_, new):_) ((path', old):rest) = (path', new + old):rest addCounter [] old = old @@ -140,7 +342,7 @@ incrementCounters path instruct counters = foldl cb counters instruct where cb counters' (name, value) = incrementCounter counters' path name value -setCounter :: Context -> Path -> Text -> Integer -> Context +setCounter :: Context -> Path -> Text -> Int -> Context setCounter counters path name val = M.insertWith setCounter' name [(path, val)] counters where setCounter' ((_, val'):_) ((path', _):rest) = (path', val'):rest @@ -151,29 +353,45 @@ where cb counters' (name, value) = setCounter counters' path name value -renderCounters :: Context -> [Token] -> [Token] -renderCounters counters (Function "counter":Ident name:RightParen:toks) +renderCounters :: CounterStore -> Context -> [Token] -> [Token] +renderCounters store counters (Function "counter":Ident name:RightParen:toks) | Just ((_, count):_) <- name `M.lookup` counters = - String (Txt.pack $ show count) : renderCounters counters toks - | otherwise = renderCounters counters toks -renderCounters counters (Function "counters":Ident name:Comma:String sep:RightParen:toks) + String (counterRender decimalCounter count) : renderCounters store counters toks + | otherwise = renderCounters store counters toks +renderCounters store counters (Function "counter":Ident name:Comma:toks) + | Just ((_, count):_) <- name `M.lookup` counters, + Just (cstyle, RightParen:toks') <- parseCounter store toks = + String (counterRender cstyle count) : renderCounters store counters toks' + | otherwise = renderCounters store counters $ skipBlock toks +renderCounters store counters (Function "counters":Ident name:Comma:String sep:RightParen:toks) | Just counter <- name `M.lookup` counters = String (Txt.intercalate sep [ - Txt.pack $ show count | (_, count) <- reverse counter - ]) : renderCounters counters toks - | otherwise = renderCounters counters toks -renderCounters counters (tok:toks) = tok : renderCounters counters toks -renderCounters _ [] = [] + counterRender decimalCounter count | (_, count) <- reverse counter + ]) : renderCounters store counters toks + | otherwise = renderCounters store counters toks +renderCounters store counters (Function "counters":Ident name:Comma:String sep:Comma:toks) + | Just counter <- name `M.lookup` counters, + Just (cstyle, RightParen:toks') <- parseCounter store toks = + String (Txt.intercalate sep [ + counterRender cstyle count | (_, count) <- reverse counter + ]) : renderCounters store counters toks' + | otherwise = renderCounters store counters toks +renderCounters store counters (tok:toks) = tok : renderCounters store counters toks +renderCounters _ _ [] = [] -applyCounters :: StyleTree (TextStyle p) -> StyleTree (TextStyle p) -applyCounters = treeOrder applyCounters0 M.empty -applyCounters0 :: Context -> Context -> Path -> TextStyle p -> (Context, TextStyle p) -applyCounters0 counterSource valueSource path node = +skipBlock :: [Token] -> [Token] +skipBlock = snd . scanBlock + +applyCounters :: CounterStore -> StyleTree (TextStyle p) -> StyleTree (TextStyle p) +applyCounters counters = treeOrder (applyCounters0 counters) M.empty +applyCounters0 :: CounterStore -> Context -> Context -> Path -> TextStyle p -> + (Context, TextStyle p) +applyCounters0 store counterSource valueSource path node = let counters = inheritCounters counterSource valueSource & instantiateCounters path (counterReset node) & incrementCounters path (counterIncrement node) & setCounters path (counterSet node) in (counters, node { - counterProps = [(k, renderCounters counters v) | (k, v) <- counterProps node] + counterProps = [(k, renderCounters store counters v) | (k, v) <- counterProps node] }) -------- @@ -189,17 +407,21 @@ collapseWS :: StyleTree (TextStyle p) -> StyleTree (TextStyle p) collapseWS = treeOrder collapseWS0 True collapseWS0 :: Bool -> Bool -> Path -> TextStyle p -> (Bool, TextStyle p) -collapseWS0 _ _ _ node@(TextStyle {whiteSpaceCollapse = False, newlineCollapse = False}) = (False, node) +collapseWS0 _ _ _ node@(TextStyle { + whiteSpaceCollapse = False, newlineCollapse = False }) = (False, node) collapseWS0 _ inSpace _ node@(TextStyle { whiteSpaceCollapse = wsCollapse, newlineCollapse = nlCollapse }) = (trailingSpace, setContent content' node) - where (trailingSpace, content') = collapseWSToks inSpace wsCollapse nlCollapse $ content node + where (trailingSpace, content') = + collapseWSToks inSpace wsCollapse nlCollapse $ content node collapseWSToks :: Bool -> Bool -> Bool -> [Token] -> (Bool, [Token]) collapseWSToks stripStart wsCollapse nlCollapse (String txt:toks) = - let (trailingSpace, str') = collapseWSStr stripStart wsCollapse nlCollapse $ Txt.unpack txt - (trailingSpace', toks') = collapseWSToks trailingSpace wsCollapse nlCollapse toks + let (trailingSpace, str') = + collapseWSStr stripStart wsCollapse nlCollapse $ Txt.unpack txt + (trailingSpace', toks') = + collapseWSToks trailingSpace wsCollapse nlCollapse toks in (trailingSpace', String (Txt.pack str'):toks') collapseWSToks _ wsCollapse nlCollapse (tok:toks) = let (trailingSpace, toks') = collapseWSToks False wsCollapse nlCollapse toks @@ -207,9 +429,14 @@ collapseWSToks trailingWS _ _ [] = (trailingWS, []) collapseWSStr, collapseWSStr' :: Bool -> Bool -> Bool -> String -> (Bool, String) -collapseWSStr _ wsCollapse False str@('\n':_) = collapseWSStr' True wsCollapse True str -collapseWSStr True True nlCollapse (ch:str) | isSpace ch = collapseWSStr True True nlCollapse str -collapseWSStr False True nlCollapse str@(ch:_) | isSpace ch = collapseWSStr' True True nlCollapse str -collapseWSStr _ wsCollapse nlCollapse str = collapseWSStr' False wsCollapse nlCollapse str -collapseWSStr' a b c (d:ds) = let (trailing, ds') = collapseWSStr a b c ds in (trailing, d:ds') +collapseWSStr _ wsCollapse False str@('\n':_) = + collapseWSStr' True wsCollapse False str +collapseWSStr True True nlCollapse (ch:str) | isSpace ch = + collapseWSStr True True nlCollapse str +collapseWSStr False True nlCollapse str@(ch:_) | isSpace ch = + collapseWSStr' True True nlCollapse str +collapseWSStr _ wsCollapse nlCollapse str = + collapseWSStr' False wsCollapse nlCollapse str +collapseWSStr' a b c (d:ds) = + let (trailing, ds') = collapseWSStr a b c ds in (trailing, d:ds') collapseWSStr' a _ _ [] = (a, []) diff --git a/src/Data/CSS/Preprocessor/Text/CounterStyle.hs b/src/Data/CSS/Preprocessor/Text/CounterStyle.hs new file mode 100644 --- /dev/null +++ b/src/Data/CSS/Preprocessor/Text/CounterStyle.hs @@ -0,0 +1,367 @@ +{-# LANGUAGE OverloadedStrings, TemplateHaskell #-} +module Data.CSS.Preprocessor.Text.CounterStyle(CounterStyle(..), CounterSystem(..), + defaultCounter, decimalCounter, simpChineseInformal, cjkDecimal, ethiopic, + isValid, parseCounterStyle, CounterStore'(..), parseCounter, defaultCounterStore, + counterRender, counterRenderMarker, ranges', speakAs', CounterStore) where +import Data.CSS.Syntax.Tokens +import Data.CSS.Syntax.StyleSheet + +import Data.FileEmbed (embedStringFile, makeRelativeToProject) + +import qualified Data.Text as Txt +import Data.Text (Text, unpack) +import qualified Data.HashMap.Lazy as HM +import Data.HashMap.Lazy (HashMap) +import Data.Maybe (isJust, fromJust) + +-- NOTE: No support for image "symbols" yet. +data CounterStyle = CounterStyle { + system :: CounterSystem, + negativePrefix :: Text, + negativeSuffix :: Text, + prefix :: Text, + suffix :: Text, + ranges :: Maybe [(Int, Int)], + padLength :: Int, + padChar :: Text, + fallback :: Maybe CounterStyle, + symbols :: [Text], + additiveSymbols :: [(Int, Text)], + speakAs :: Maybe Text +} +data CounterSystem = Cyclic | Fixed Int | Symbolic | Alphabetic | Numeric + | Additive | Chinese { isSimplified :: Bool } | Ethiopic + +defaultCounter, decimalCounter :: CounterStyle +ethiopic, simpChineseInformal, cjkDecimal :: CounterStyle +defaultCounter = CounterStyle { + system = Symbolic, + negativePrefix = "-", + negativeSuffix = "", + prefix = "", + suffix = ". ", + ranges = Nothing, + padLength = 0, + padChar = "", + fallback = Just decimalCounter, + symbols = [], -- Must be overriden! + additiveSymbols = [], -- Alternative requirement! + speakAs = Nothing +} +decimalCounter = defaultCounter { + system = Numeric, + symbols = ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"], + fallback = Nothing +} +-- These are here mostly for testing... +cjkDecimal = defaultCounter { + system = Numeric, + ranges = Just [(0, maxBound)], + symbols = ["〇", "一", "二", "三", "四", "五", "六", "七", "八", "九"], + suffix = "、" +} +simpChineseInformal = defaultCounter { + system = Chinese True, + negativePrefix = "负", + symbols = ["零", "一", "二", "三", "四", "五", "六", "七", "八", "九"], + additiveSymbols = [(0, ""), (10, "十"), (100, "百"), (1000, "千")], + suffix = "、", + fallback = Just cjkDecimal +} +ethiopic = defaultCounter { + system = Ethiopic, + symbols = ["", "፩", "፪", "፫", "፬", "፭", "፮", "፯", "፰", "፱"], + additiveSymbols = [(0, ""), (10, "፲"), (20, "፳"), (30, "፴"), (40, "፵"), + (50, "፶"), (60, "፷"), (70, "፸"), (80, "፹"), (90, "፺")], + suffix = "/ " +} + +isValid :: CounterStyle -> Bool +isValid CounterStyle { system = Additive, additiveSymbols = [] } = False +isValid self@CounterStyle { + system = Chinese _, symbols = syms, additiveSymbols = markers + } = length syms == 10 && length markers >= 4 && ranges self == Nothing +isValid CounterStyle { + system = Ethiopic, symbols = units, additiveSymbols = tens + } = length units == 10 && length tens == 10 +isValid CounterStyle { symbols = [] } = False +isValid _ = True + +type CounterStore = HashMap Text CounterStyle +parseCounterProperty :: CounterStore -> (Text, [Token]) -> + CounterStyle -> CounterStyle +parseCounterProperty _ ("system", [Ident "cyclic"]) self = self {system = Cyclic} +parseCounterProperty _ ("system", [Ident "fixed"]) self = self {system = Fixed 1} +parseCounterProperty _ ("system", [Ident "fixed", Number _ (NVInteger x)]) self + = self { system = Fixed $ fromInteger x } +parseCounterProperty _ ("system", [Ident "symbolic"]) self = + self {system = Symbolic } +parseCounterProperty _ ("system", [Ident "alphabetic"]) self = + self { system = Alphabetic } +parseCounterProperty _ ("system", [Ident "numeric"]) self = + self { system = Numeric } +parseCounterProperty _ ("system", [Ident "-argo-chinese", Ident x]) self = + self { system = Chinese (x == "simplified") } +parseCounterProperty _ ("system", [Ident "-argo-ethiopic"]) self = + self { system = Ethiopic } +-- Handled by caller so property overrides work correctly. +parseCounterProperty _ ("system", [Ident "extends", Ident _]) self = self + +parseCounterProperty _ ("negative", [x]) self | Just pre <- parseSymbol x = + self { negativePrefix = pre, negativeSuffix = "" } +parseCounterProperty _ ("negative", [x, y]) self + | Just pre <- parseSymbol x, Just suf <- parseSymbol y = + self { negativePrefix = pre, negativeSuffix = suf } + +parseCounterProperty _ ("prefix", [x]) self | Just pre <- parseSymbol x = + self { prefix = pre } +parseCounterProperty _ ("suffix", [x]) self | Just suf <- parseSymbol x = + self { suffix = suf } + +parseCounterProperty _ ("range", [Ident "auto"]) self = self {ranges = Nothing} +parseCounterProperty _ ("range", toks) self | Just rs <- parseRanges (Comma:toks) = + self { ranges = Just rs } + +parseCounterProperty _ ("pad", [Number _ (NVInteger x), y]) self + | Just char <- parseSymbol y = self { + padLength = fromInteger x, padChar = char + } +parseCounterProperty styles ("fallback", [Ident name]) self = self { + fallback = Just $ HM.lookupDefault decimalCounter name styles + } +parseCounterProperty _ ("symbols", toks) self | all (isJust . parseSymbol) toks + = self { symbols = map (fromJust . parseSymbol) toks } +parseCounterProperty _ ("additive-symbols", toks) self + | Just syms <- parseAdditiveSymbols (Comma:toks) = + self { additiveSymbols = syms } + +parseCounterProperty _ ("speak-as", [Ident "auto"]) self = + self { speakAs = Nothing } +parseCounterProperty styles ("speak-as", [Ident x]) self + | x `elem` ["bullets", "numbers", "words", "spell-out"] = + self { speakAs = Just x } + | Just super <- HM.lookup x styles = self { speakAs = speakAs super } + | otherwise = self +parseCounterProperty _ _ self = self + +parseRanges :: [Token] -> Maybe [(Int, Int)] +parseRanges (Comma:a:b:toks) | Just self <- parseRanges toks = case (a, b) of + (Ident "infinite", Ident "infinite") -> Just ((minBound, maxBound):self) + (Ident "infinite", Number _ (NVInteger x)) -> + Just ((minBound, fromInteger x):self) + (Number _ (NVInteger x), Ident "infinite") -> + Just ((fromInteger x, maxBound):self) + (Number _ (NVInteger x), Number _ (NVInteger y)) -> + Just ((fromInteger x, fromInteger y):self) + _ -> Nothing +parseRanges [] = Just [] +parseRanges _ = Nothing + +parseAdditiveSymbols :: [Token] -> Maybe [(Int, Text)] +parseAdditiveSymbols (Comma:Number _ (NVInteger x):y:toks) + | Just self <- parseAdditiveSymbols toks, Just sym <- parseSymbol y = + Just ((fromInteger x, sym):self) +parseAdditiveSymbols [] = Just [] +parseAdditiveSymbols _ = Nothing + +parseCounterStyle :: CounterStore -> [Token] -> (CounterStore, [Token]) +parseCounterStyle store (Whitespace:toks) = parseCounterStyle store toks +parseCounterStyle store (Ident name:toks) + | ((props, ""), toks') <- parseProperties toks = + let super = case Prelude.lookup "system" props of + Just [Ident "extends", Ident name'] -> + HM.lookupDefault decimalCounter name' store + _ -> defaultCounter + style = foldr (parseCounterProperty store) super props + in (HM.insert name style store, toks') +parseCounterStyle store toks = (store, skipAtRule toks) + +parseSymbol :: Token -> Maybe Text +parseSymbol (Ident x) = Just x +parseSymbol (String x) = Just x +parseSymbol _ = Nothing + +data CounterStore' = CounterStore { unwrap :: CounterStore } +instance StyleSheet CounterStore' where + addRule self _ = self + addAtRule (CounterStore self) "counter-style" toks = + let (self', toks') = parseCounterStyle self toks + in (CounterStore self', toks') + addAtRule self _ toks = (self, skipAtRule toks) + +defaultCounterStore :: CounterStore' +defaultCounterStore = + parse (CounterStore HM.empty) $ Txt.pack + $(makeRelativeToProject "src/Data/CSS/Preprocessor/Text/counter-styles.css" >>= + embedStringFile) + +--- + +fallbackSym :: Text +fallbackSym = "\0" + +counterRenderCore :: CounterStyle -> Int -> Text +counterRenderCore CounterStyle { system = Cyclic, symbols = syms } x = + syms !! (pred x `rem` length syms) +counterRenderCore CounterStyle { system = Fixed n, symbols = syms } x + | x - n < length syms = syms !! (x - n) + | otherwise = fallbackSym +counterRenderCore CounterStyle { system = Symbolic, symbols = syms } x = + succ (quot x' n) `Txt.replicate` (syms !! rem x' n) + where (n, x') = (length syms, pred x) +counterRenderCore CounterStyle { system = Alphabetic, symbols = syms } x = inner x + where + n = length syms + inner 0 = "" + inner y = let x' = pred y in inner (quot x' n) `Txt.append` (syms !! rem x' n) +counterRenderCore CounterStyle { system = Numeric, symbols = syms } 0 = syms !! 0 +counterRenderCore CounterStyle { system = Numeric, symbols = syms } x = inner x + where + n = length syms + inner 0 = "" + inner y = inner (quot y n) `Txt.append` (syms !! rem y n) +counterRenderCore CounterStyle { system = Additive, additiveSymbols = syms } 0 + | Just sym <- Prelude.lookup 0 syms = sym + | otherwise = fallbackSym +counterRenderCore CounterStyle { system = Additive, additiveSymbols = syms } w + | '\0' `elem'` inner syms w = fallbackSym + | otherwise = inner syms w + where + elem' ch txt = elem ch $ unpack txt + inner _ 0 = "" + inner ((0, _):syms') x = inner syms' x + inner ((weight, _):syms') x | weight > x = inner syms' x + inner ((weight, sym):syms') x = + Txt.replicate reps sym `Txt.append` inner syms' x' + where + reps = quot x weight + x' = x - weight * reps + inner [] _ = "\0" -- Run fallback counter! +-- Following https://w3c.github.io/csswg-drafts/css-counter-styles-3/#limited-chinese +-- 1. If the counter value is 0, the representation is the character for 0 +-- specified for the given counter style. Skip the rest of this algorithm. +counterRenderCore CounterStyle { system = Chinese _, symbols = (sym:_) } 0 = sym +counterRenderCore CounterStyle { + system = Chinese simplified, symbols = syms, additiveSymbols = markers + } x = Txt.concat $ map renderDigit $ collapse0s $ + reverse $ enumerate $ decimalDigits x + where + -- Implements step 4. + collapse0s ((i, 0):digits) = inner digits + where + inner ((_, 0):digits') = inner digits' + -- Drop trailing 0s + inner [] = [] + -- Collapse any remaining (consecutive?) zeroes into a single 0 digit. + inner digits' = (i, 0):collapse0s digits' + collapse0s (digit:digits) = digit:collapse0s digits + collapse0s [] = [] + renderDigit (_, 0) = syms !! 0 -- Don't append digit marker for zero, step 2. + -- 3. For the informal styles, if the counter value is between 10 and 19, + -- remove the 10s digit (leave the digit marker). + renderDigit (1,1) | simplified, [_, _] <- decimalDigits x = markers' !! 1 + -- Select characters per steps 2 & 5 + renderDigit (place, digit) = Txt.concat [syms !! digit, markers' !! place] + markers' = map snd markers +-- Following https://w3c.github.io/csswg-drafts/css-counter-styles-3/#ethiopic-numeric-counter-style +-- 1. If the number is 1, return "፩" (U+1369). +counterRenderCore CounterStyle { system = Ethiopic, symbols = (_:sym:_) } 1 = sym +counterRenderCore CounterStyle { + system = Ethiopic, symbols = unitSyms, additiveSymbols = tenSyms + } x = Txt.concat $ renderPairs True $ + reverse $ enumerate $ pairDigits $ decimalDigits x + where + -- 2. Split the number into groups of two digits, + -- starting with the least significant decimal digit. + pairDigits (units:tens:digits) = (tens,units):pairDigits digits + pairDigits [units] = (0, units):[] + pairDigits [] = [] + + renderPairs isBigEnd (group:groups) = + renderPair isBigEnd group:renderPairs False groups + renderPairs _ [] = [] + -- Handle step 4's exceptions. + renderPair' :: Bool -> (Int, (Int, Int)) -> Text + renderPair' _ (_,(0, 0)) = "" + renderPair' True (_, (0,1)) = "" + renderPair' _ (i, (0,1)) | odd i = "" + -- Step 5 + renderPair' _ (_, (tens, units)) = + (map snd tenSyms !! tens) `Txt.append` (unitSyms !! units) + -- Step 6 & 7 + renderPair _ (i, (0,0)) | odd i = "" + renderPair isBigEnd (0, group) = renderPair' isBigEnd (0, group) + renderPair isBigEnd (i, group) + | odd i = renderPair' isBigEnd (i, group) `Txt.append` "፻" + | even i = renderPair' isBigEnd (i, group) `Txt.append` "፼" + renderPair _ _ = "" -- Silence warnings, above case should not fallthrough. +decimalDigits :: Int -> [Int] +decimalDigits 0 = [] +decimalDigits x = rem x 10:decimalDigits (quot x 10) +enumerate :: [a] -> [(Int, a)] +enumerate = zip $ enumFrom 0 + +counterRenderMarker :: CounterStyle -> Int -> Text +counterRenderMarker self x = + Txt.concat [prefix self, counterRender self x, suffix self] +counterRender :: CounterStyle -> Int -> Text +counterRender self@CounterStyle { fallback = Just self' } x + | not $ inRange x $ ranges' self = counterRender self' x + | counterRenderCore self x == fallbackSym = counterRender self' x + where + inRange y ((start, end):rest) + | y >= start && y <= end = True + | otherwise = inRange y rest + inRange _ [] = False +counterRender self@CounterStyle { padLength = m, padChar = pad } x + | x < 0 = Txt.concat [ + negativePrefix self, + counterRender self { ranges = Just [(0, maxBound)] } $ -x, -- No fallback! + negativeSuffix self + ] + | text == fallbackSym = Txt.pack $ show x -- NOTE: Shouldn't happen + | n < m = Txt.replicate (m - n) pad `Txt.append` text + | otherwise = text + where + text = counterRenderCore self x + n = Txt.length text + +infiniteRange :: [(Int, Int)] +infiniteRange = [(minBound, maxBound)] +ranges' :: CounterStyle -> [(Int, Int)] +ranges' CounterStyle { ranges = Just ret } = ret +ranges' CounterStyle { system = Cyclic } = infiniteRange +ranges' CounterStyle { system = Numeric } = infiniteRange +ranges' CounterStyle { system = Fixed _ } = infiniteRange +ranges' CounterStyle { system = Alphabetic } = [(1, maxBound)] +ranges' CounterStyle { system = Symbolic } = [(1, maxBound)] +ranges' CounterStyle { system = Additive } = [(0, maxBound)] +ranges' CounterStyle { system = Chinese _ } = [(-9999, 9999)] +ranges' CounterStyle { system = Ethiopic } = [(1, maxBound)] + +speakAs' :: CounterStyle -> Text +speakAs' CounterStyle { speakAs = Just ret } = ret +speakAs' CounterStyle { system = Alphabetic } = "spell-out" +speakAs' CounterStyle { system = Cyclic } = "bullets" +speakAs' _ = "numbers" + +--- + +parseCounter :: CounterStore -> [Token] -> Maybe (CounterStyle, [Token]) +parseCounter _ (Function "symbols":Ident name:toks) + | Just system' <- Prelude.lookup name [ + ("cyclic", Cyclic), ("numeric", Numeric), ("alphabetic", Alphabetic), + ("symbolic", Symbolic), ("fixed", Fixed 1) + ], Just (syms, toks') <- parseArgs toks = + Just (defaultCounter { system = system', symbols = syms }, toks') + where + parseArgs (String sym:toks') | Just (syms,tail') <- parseArgs toks' = + Just (sym:syms, tail') + parseArgs (RightParen:toks') = Just ([],toks') + parseArgs _ = Nothing +parseCounter store (Ident name:toks) + | Just ret <- HM.lookup name store, isValid ret = Just (ret, toks) + | otherwise = Just (decimalCounter, toks) +parseCounter _ (String sym:toks) = + Just (defaultCounter {system = Cyclic, symbols = [sym], suffix = " "}, toks) +parseCounter _ _ = Nothing diff --git a/src/Data/CSS/Style.hs b/src/Data/CSS/Style.hs --- a/src/Data/CSS/Style.hs +++ b/src/Data/CSS/Style.hs @@ -23,8 +23,10 @@ import Data.CSS.Syntax.AtLayer as AtLayer import Data.HashMap.Strict (HashMap, lookupDefault, fromList) +import qualified Data.HashMap.Strict as HM import Data.Text (isPrefixOf) import Data.List (elemIndex) +import Data.Maybe (fromMaybe) -- | A parsed CSS stylesheet from which you can query styles to match an element. type QueryableStyleSheet parser = QueryableStyleSheet' (ImportanceSplitter ( @@ -79,9 +81,19 @@ cascade' :: PropertyParser p => [StyleRule'] -> Props -> p -> p cascade' = Cascade.cascade --- | Facade over `queryRules` & `cascade'` for simple cases you don't care about psuedoelements. +-- | Facade over `queryRules` & `cascade'`. +-- Instead of exposing pseudoelements to callers it exposes pseudoelements to +-- the `PropertyParser` implementation. cascade :: PropertyParser p => QueryableStyleSheet p -> Element -> Props -> p -> p -cascade self el = cascade' $ lookupDefault [] "" $ queryRules self el +cascade self el props style = HM.foldlWithKey' applyPseudoEl (cascade' ( + lookupDefault [] "" rules) props style) rules + where + rules = queryRules self el + applyPseudoEl :: PropertyParser p => p -> Text -> [StyleRule'] -> p + applyPseudoEl self' "" _ = self' + applyPseudoEl self' pseudo props' = pseudoEl self' pseudo cb + where cb parent' base' = Cascade.cascadeWithParent props' [] parent' $ + fromMaybe (inherit parent') base' --- Verify syntax during parsing, so invalid properties don't interfere with cascade. data PropertyExpander parser inner = PropertyExpander parser inner diff --git a/src/Data/CSS/Style/Cascade.hs b/src/Data/CSS/Style/Cascade.hs --- a/src/Data/CSS/Style/Cascade.hs +++ b/src/Data/CSS/Style/Cascade.hs @@ -2,7 +2,7 @@ -- | Applies CSS selection, cascade, & inheritance. -- INTERNAL MODULE. module Data.CSS.Style.Cascade( - query, cascade, + query, cascade, cascadeWithParent, TrivialPropertyParser(..), PropertyParser(..), Props ) where @@ -41,15 +41,21 @@ cascade :: PropertyParser p => [StyleRule'] -> Props -> p -> p cascade styles overrides base = construct base $ HML.toList $ cascadeRules (getVars base ++ overrides) styles +-- | Variant of `cascade` which allows configuring base styles seperate from parent. +cascadeWithParent :: PropertyParser p => [StyleRule'] -> Props -> p -> p -> p +cascadeWithParent styles overrides parent' base = constructWithParent parent' base $ + HML.toList $ cascadeRules (getVars base ++ overrides) styles cascadeRules :: Props -> [StyleRule'] -> HashMap Text [Token] cascadeRules overrides rules = cascadeProperties overrides $ concat $ Prelude.map properties rules cascadeProperties :: Props -> Props -> HashMap Text [Token] cascadeProperties overrides props = HML.fromList (props ++ overrides) +constructWithParent :: PropertyParser p => p -> p -> Props -> p +constructWithParent parent' base props = dispatch parent' child props + where child = setVars [item | item@(n, _) <- props, isPrefixOf "--" n] base construct :: PropertyParser p => p -> Props -> p -construct base props = dispatch base child props - where child = setVars [item | item@(n, _) <- props, isPrefixOf "--" n] $ inherit base +construct base props = constructWithParent base (inherit base) props dispatch :: PropertyParser p => p -> p -> Props -> p dispatch base child ((key, value):props) | Just child' <- longhand base child key value = dispatch base child' props diff --git a/stylist.cabal b/stylist.cabal --- a/stylist.cabal +++ b/stylist.cabal @@ -10,7 +10,7 @@ -- PVP summary: +-+------- breaking API changes -- | | +----- non-breaking API additions -- | | | +--- code changes with no API change -version: 2.5.0.1 +version: 2.6.0.0 -- A short (one-line) description of the package. synopsis: Apply CSS styles to a document tree. @@ -21,7 +21,7 @@ The hope is that this would be useful for implementing new browser engines, web development tools, and UI frameworks. -- The license under which the package is released. -license: MIT +license: GPL-3 -- The file containing the license text. license-file: LICENSE @@ -56,7 +56,8 @@ exposed-modules: Data.CSS.Syntax.StyleSheet, Data.CSS.Syntax.Selector, Data.CSS.Style, Data.CSS.StyleTree, Data.CSS.Preprocessor.Conditions, Data.CSS.Preprocessor.Conditions.Expr, - Data.CSS.Preprocessor.Assets, Data.CSS.Preprocessor.Text, Data.CSS.Preprocessor.PsuedoClasses + Data.CSS.Preprocessor.Assets, Data.CSS.Preprocessor.PsuedoClasses, + Data.CSS.Preprocessor.Text, Data.CSS.Preprocessor.Text.CounterStyle -- Modules included in this library but not exported. other-modules: Data.CSS.Style.Importance, Data.CSS.Style.Common, Data.CSS.Style.Cascade, @@ -71,7 +72,8 @@ build-depends: base >=4.9 && <5, css-syntax >=0.1 && <0.2, text, unordered-containers >= 0.2 && <0.3, hashable, network-uri >= 2.6 && <2.7, async >= 2.1 && <2.3, - regex-tdfa >= 1.3, stylist-traits >= 0.1 && < 0.2 + regex-tdfa >= 1.3, stylist-traits >= 0.1.2 && < 0.2, + file-embed >= 0.0.10 && < 0.1 -- Directories containing source files. hs-source-dirs: src @@ -83,7 +85,8 @@ test-suite test-stylist other-modules: - Data.CSS.Preprocessor.Conditions, Data.CSS.Preprocessor.Conditions.Expr, Data.CSS.Preprocessor.Text, + Data.CSS.Preprocessor.Conditions, Data.CSS.Preprocessor.Conditions.Expr, + Data.CSS.Preprocessor.Text, Data.CSS.Preprocessor.Text.CounterStyle, Data.CSS.Style.Cascade, Data.CSS.Style.Common, Data.CSS.Style.Importance, Data.CSS.Style.Selector.Index, Data.CSS.Style.Selector.Interpret, Data.CSS.Style.Selector.LowerWhere, Data.CSS.Style.Selector.Specificity, @@ -97,5 +100,5 @@ build-depends: base >=4.9 && <5, css-syntax >=0.1 && <0.2, text, unordered-containers >= 0.2 && <0.3, hashable, network-uri >= 2.6 && <2.7, async >= 2.1 && <2.3, - regex-tdfa >= 1.3, hspec, QuickCheck, + regex-tdfa >= 1.3, hspec, QuickCheck, file-embed, scientific >= 0.3 && <1.0, regex-tdfa >= 1.3, stylist-traits >= 0.1 && < 0.2 diff --git a/test/Test.hs b/test/Test.hs --- a/test/Test.hs +++ b/test/Test.hs @@ -24,6 +24,8 @@ import Data.CSS.Preprocessor.Conditions.Expr (Datum(..), Op(..), parse', eval) import qualified Data.CSS.Preprocessor.Text as Txt +import qualified Data.CSS.Preprocessor.Text.CounterStyle as Ctr + main :: IO () main = hspec spec @@ -519,6 +521,199 @@ layerPath ["HomeTeam"] tree5 `shouldBe` [3] layerPath ["LeagueOfGentlemenAdventurers"] tree5 `shouldBe` [1] uniqueName ["HomeTeam"] tree5 `shouldBe` ["HomeTeam", "1"] + + describe "@counter-style" $ do + -- NOTE: Thes are mostly based on examples given in the spec + -- https://w3c.github.io/csswg-drafts/css-counter-styles-3/#counter-style-system + it "Handles system: cyclic" $ do + let counter = Ctr.defaultCounter { + Ctr.system = Ctr.Cyclic, Ctr.symbols = ["!", "@", "#"] + } + Ctr.counterRenderMarker counter 2 `shouldBe` "@. " + Ctr.counterRenderMarker counter 4 `shouldBe` "!. " + it "Handles system: fixed" $ do + let counter = Ctr.defaultCounter { + Ctr.system = Ctr.Fixed 1, Ctr.symbols = ["◰", "◳", "◲", "◱"], + Ctr.suffix = ": " + } + Ctr.counterRenderMarker counter 1 `shouldBe` "◰: " + Ctr.counterRenderMarker counter 2 `shouldBe` "◳: " + Ctr.counterRenderMarker counter 3 `shouldBe` "◲: " + Ctr.counterRenderMarker counter 4 `shouldBe` "◱: " + Ctr.counterRenderMarker counter 5 `shouldBe` "5: " + Ctr.counterRenderMarker counter 6 `shouldBe` "6: " + it "Handles system: symbolic" $ do + let counter = Ctr.defaultCounter { + Ctr.system = Ctr.Symbolic, Ctr.symbols = ["*", "⁑", "†", "‡"], + Ctr.suffix = " " + } + Ctr.counterRenderMarker counter 1 `shouldBe` "* " + Ctr.counterRenderMarker counter 2 `shouldBe` "⁑ " + Ctr.counterRenderMarker counter 3 `shouldBe` "† " + Ctr.counterRenderMarker counter 4 `shouldBe` "‡ " + Ctr.counterRenderMarker counter 5 `shouldBe` "** " + Ctr.counterRenderMarker counter 6 `shouldBe` "⁑⁑ " + it "Handles system: alphabetic" $ do + let counter = Ctr.defaultCounter { + Ctr.system = Ctr.Alphabetic, Ctr.symbols = ["◦", "•"], + Ctr.suffix = " " + } + Ctr.counterRenderMarker counter 1 `shouldBe` "◦ " + Ctr.counterRenderMarker counter 2 `shouldBe` "• " + Ctr.counterRenderMarker counter 3 `shouldBe` "◦◦ " + Ctr.counterRenderMarker counter 4 `shouldBe` "◦• " + Ctr.counterRenderMarker counter 5 `shouldBe` "•◦ " + Ctr.counterRenderMarker counter 6 `shouldBe` "•• " + Ctr.counterRenderMarker counter 7 `shouldBe` "◦◦◦ " + it "Handles system: numeric" $ do + let counter = Ctr.defaultCounter { + Ctr.system = Ctr.Numeric, Ctr.symbols = ["0", "1", "2"] + } + Ctr.counterRenderMarker counter 1 `shouldBe` "1. " + Ctr.counterRenderMarker counter 2 `shouldBe` "2. " + Ctr.counterRenderMarker counter 3 `shouldBe` "10. " + Ctr.counterRenderMarker counter 4 `shouldBe` "11. " + Ctr.counterRenderMarker counter 5 `shouldBe` "12. " + Ctr.counterRenderMarker counter 6 `shouldBe` "20. " + it "Handles system: additive" $ do + let counter = Ctr.defaultCounter { + Ctr.system = Ctr.Additive, Ctr.suffix = " ", + Ctr.additiveSymbols = [(6, "⚅"), (5, "⚄"), (4, "⚃"), + (3, "⚂"), (2, "⚁"), (1, "⚀")] + } + Ctr.counterRenderMarker counter 1 `shouldBe` "⚀ " + Ctr.counterRenderMarker counter 2 `shouldBe` "⚁ " + Ctr.counterRenderMarker counter 3 `shouldBe` "⚂ " + Ctr.counterRenderMarker counter 11 `shouldBe` "⚅⚄ " + Ctr.counterRenderMarker counter 12 `shouldBe` "⚅⚅ " + Ctr.counterRenderMarker counter 13 `shouldBe` "⚅⚅⚀ " + it "Handles Chinese-specific numbering systems" $ do + let counterRender = Ctr.counterRender Ctr.simpChineseInformal + counterRender 1 `shouldBe` "一" + counterRender 2 `shouldBe` "二" + counterRender 3 `shouldBe` "三" + counterRender 4 `shouldBe` "四" + counterRender 5 `shouldBe` "五" + counterRender 6 `shouldBe` "六" + counterRender 7 `shouldBe` "七" + counterRender 8 `shouldBe` "八" + counterRender 9 `shouldBe` "九" + counterRender 10 `shouldBe` "十" + counterRender 11 `shouldBe` "十一" + counterRender 12 `shouldBe` "十二" + counterRender 13 `shouldBe` "十三" + counterRender 14 `shouldBe` "十四" + counterRender 15 `shouldBe` "十五" + counterRender 16 `shouldBe` "十六" + counterRender 17 `shouldBe` "十七" + counterRender 18 `shouldBe` "十八" + counterRender 19 `shouldBe` "十九" + counterRender 20 `shouldBe` "二十" + counterRender 21 `shouldBe` "二十一" + counterRender 22 `shouldBe` "二十二" + counterRender 23 `shouldBe` "二十三" + counterRender 24 `shouldBe` "二十四" + counterRender 25 `shouldBe` "二十五" + counterRender 26 `shouldBe` "二十六" + counterRender 27 `shouldBe` "二十七" + counterRender 28 `shouldBe` "二十八" + counterRender 29 `shouldBe` "二十九" + counterRender 30 `shouldBe` "三十" + counterRender 31 `shouldBe` "三十一" + counterRender 32 `shouldBe` "三十二" + counterRender 33 `shouldBe` "三十三" + counterRender 34 `shouldBe` "三十四" + counterRender 35 `shouldBe` "三十五" + counterRender 36 `shouldBe` "三十六" + counterRender 37 `shouldBe` "三十七" + counterRender 38 `shouldBe` "三十八" + counterRender 39 `shouldBe` "三十九" + counterRender 40 `shouldBe` "四十" + counterRender 41 `shouldBe` "四十一" + counterRender 42 `shouldBe` "四十二" + counterRender 43 `shouldBe` "四十三" + counterRender 44 `shouldBe` "四十四" + counterRender 45 `shouldBe` "四十五" + counterRender 46 `shouldBe` "四十六" + counterRender 47 `shouldBe` "四十七" + counterRender 48 `shouldBe` "四十八" + counterRender 49 `shouldBe` "四十九" + counterRender 50 `shouldBe` "五十" + counterRender 51 `shouldBe` "五十一" + counterRender 52 `shouldBe` "五十二" + counterRender 53 `shouldBe` "五十三" + counterRender 54 `shouldBe` "五十四" + counterRender 55 `shouldBe` "五十五" + counterRender 56 `shouldBe` "五十六" + counterRender 57 `shouldBe` "五十七" + counterRender 58 `shouldBe` "五十八" + counterRender 59 `shouldBe` "五十九" + counterRender 60 `shouldBe` "六十" + counterRender 61 `shouldBe` "六十一" + counterRender 62 `shouldBe` "六十二" + counterRender 63 `shouldBe` "六十三" + counterRender 64 `shouldBe` "六十四" + counterRender 65 `shouldBe` "六十五" + counterRender 66 `shouldBe` "六十六" + counterRender 67 `shouldBe` "六十七" + counterRender 68 `shouldBe` "六十八" + counterRender 69 `shouldBe` "六十九" + counterRender 70 `shouldBe` "七十" + counterRender 71 `shouldBe` "七十一" + counterRender 72 `shouldBe` "七十二" + counterRender 73 `shouldBe` "七十三" + counterRender 74 `shouldBe` "七十四" + counterRender 75 `shouldBe` "七十五" + counterRender 76 `shouldBe` "七十六" + counterRender 77 `shouldBe` "七十七" + counterRender 78 `shouldBe` "七十八" + counterRender 79 `shouldBe` "七十九" + counterRender 80 `shouldBe` "八十" + counterRender 81 `shouldBe` "八十一" + counterRender 82 `shouldBe` "八十二" + counterRender 83 `shouldBe` "八十三" + counterRender 84 `shouldBe` "八十四" + counterRender 85 `shouldBe` "八十五" + counterRender 86 `shouldBe` "八十六" + counterRender 87 `shouldBe` "八十七" + counterRender 88 `shouldBe` "八十八" + counterRender 89 `shouldBe` "八十九" + counterRender 90 `shouldBe` "九十" + counterRender 91 `shouldBe` "九十一" + counterRender 92 `shouldBe` "九十二" + counterRender 93 `shouldBe` "九十三" + counterRender 94 `shouldBe` "九十四" + counterRender 95 `shouldBe` "九十五" + counterRender 96 `shouldBe` "九十六" + counterRender 97 `shouldBe` "九十七" + counterRender 98 `shouldBe` "九十八" + counterRender 99 `shouldBe` "九十九" + counterRender 100 `shouldBe` "一百" + counterRender 101 `shouldBe` "一百零一" + counterRender 102 `shouldBe` "一百零二" + counterRender 103 `shouldBe` "一百零三" + counterRender 104 `shouldBe` "一百零四" + counterRender 105 `shouldBe` "一百零五" + counterRender 106 `shouldBe` "一百零六" + counterRender 107 `shouldBe` "一百零七" + counterRender 108 `shouldBe` "一百零八" + counterRender 109 `shouldBe` "一百零九" + counterRender 110 `shouldBe` "一百一十" + counterRender 111 `shouldBe` "一百一十一" + counterRender 112 `shouldBe` "一百一十二" + counterRender 113 `shouldBe` "一百一十三" + counterRender 114 `shouldBe` "一百一十四" + counterRender 115 `shouldBe` "一百一十五" + counterRender 116 `shouldBe` "一百一十六" + counterRender 117 `shouldBe` "一百一十七" + counterRender 118 `shouldBe` "一百一十八" + counterRender 119 `shouldBe` "一百一十九" + counterRender 120 `shouldBe` "一百二十" + it "Handles ethiopian numbering system" $ do + Ctr.counterRender Ctr.ethiopic 1 `shouldBe` "፩" + Ctr.counterRender Ctr.ethiopic 100 `shouldBe` "፻" + Ctr.counterRender Ctr.ethiopic 78010092 `shouldBe` "፸፰፻፩፼፺፪" + Ctr.counterRender Ctr.ethiopic 780100000092 `shouldBe` "፸፰፻፩፼፼፺፪" styleIndex :: StyleIndex styleIndex = new