diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 --- /dev/null +++ b/LICENSE.txt @@ -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/ParseShortXML.hs b/ParseShortXML.hs new file mode 100644 --- /dev/null +++ b/ParseShortXML.hs @@ -0,0 +1,135 @@ +{- + Copyright (C) Stilo International plc, 2012 + + This file contains the main file of concrete-relaxng-parser, a parser driven by a standard RELAX NG schema with + concrete syntax extensions. + + The concrete-relaxng-parser project 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. + + The concrete-relaxng-parser project 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 concrete-relaxng-parser. If not, see + . +-} + +{-# LANGUAGE DeriveDataTypeable #-} + +module Main where + +import Data.List (stripPrefix) +import Data.Maybe (fromMaybe) +import System.Console.CmdArgs.Implicit + +import Text.XML.HXT.Core hiding (trace) +import Text.XML.HXT.DOM.Interface +import Text.XML.HXT.DOM.ShowXml (xshow) +import qualified Text.XML.HXT.DOM.TypeDefs (XNode) +import qualified Text.XML.HXT.DOM.XmlNode as XN +import Text.XML.HXT.Curl (withCurl) +import Text.XML.HXT.TagSoup (withTagSoup) +import Text.XML.HXT.RelaxNG (Uri, LocalName, ParamList, Prefix, Context, Datatype, NameClass(..)) +import Text.XML.HXT.RelaxNG.CreatePattern (createPatternFromXmlTree) +import Text.XML.HXT.RelaxNG.Validator (createSimpleForm) +import qualified Text.XML.HXT.RelaxNG.Validation as Validator +import qualified Text.XML.HXT.RelaxNG.DataTypes as Validator +import Text.XML.HXT.RelaxNG.Parser + +data Args = Args {raw :: Bool, + passthrough :: Bool, + schema :: String, + input :: String} + deriving (Show, Data, Typeable) + +main :: IO () +main = do arg <- cmdArgs Args{raw = def &= help "Output the raw syntax tree with the terminal nodes.", + passthrough = def &= help "Reproduce the unparsed input.", + schema = def &= typFile &= argPos 0, + input = def &= typFile &= argPos 1} + pattern <- loadPattern (schema arg) + runX (pipeline (passthrough arg) (raw arg) pattern (input arg)) + return () + +recoveryLimit = 20 + +pipeline :: Bool -> Bool -> Validator.Pattern -> String -> IOSArrow XmlTree XmlTree +pipeline passthrough rawOutput pattern input = + readDocument [withValidate no] input + >>> + changeChildren (\l-> if null l then [XN.mkText ""] else l) + >>> + canonicalizeAllNodes + >>> + propagateAndValidateNamespaces + >>> + Validator.normalizeForRelaxValidation + >>> + (if passthrough then this else processChildren ( + arrL (parse pattern) + >>> + (if rawOutput + then this + else processTopDown (none `when` (isElem >>> hasNamespaceUri terminalNamespace) + >>> + changeElemName stripOmissiblePrefix) + ) + >>> + fromLA (cleanupNamespaces collectPrefixUriPairs) + ) + ) + >>> + writeDocument [withIndent no, withOutputEncoding utf8] "" + +loadPattern :: String -> IO Validator.Pattern +loadPattern schema = + fmap head $ runX ( + Validator.readForRelax schema + >>> + createSimpleForm True False True + >>> + fromLA createPatternFromXmlTree + ) + +parse :: Validator.Pattern -> XmlTree -> XmlTrees +parse pattern input = case bestNullableResult recoveryLimit derivative + of Just r -> fst $ reNest False r + Nothing -> [XN.mkError' 1 ("The input cannot be parsed.\n" + ++ "pattern: " ++ pretty "" 0 noRecovery (translate pattern) ++ "\n" + ++ "input: " ++ show input ++ "\n" + ++ "derivative: " ++ show derivative ++ "\n")] + where derivative = childDeriv recoveryLimit startContext (translate pattern) input + +stripOmissiblePrefix :: QName -> QName +stripOmissiblePrefix qn = + maybe qn (\s-> setNamespaceUri' (newXName s) qn) (stripPrefix omissibleNamespacePrefix $ namespaceUri qn) + +translate :: Validator.Pattern -> Pattern +translate Validator.Empty = Empty +translate (Validator.NotAllowed _) = NotAllowed [] +translate Validator.Text = Text +translate (Validator.Choice p1 p2) = Choice (translate p1) (translate p2) +translate (Validator.Interleave p1 p2) = Interleave 0 (translate p1) (translate p2) +translate (Validator.Group p1 p2) = Group (translate p1) (translate p2) +translate (Validator.OneOrMore p) = OneOrMore (translate p) +translate (Validator.List p) = List (translate p) +translate (Validator.Data d l) = Data d l +translate (Validator.DataExcept d l p) = DataExcept d l (translate p) +translate (Validator.Value d s c) = Value d s c +translate (Validator.Attribute c p) = Attribute c (translate p) +translate (Validator.Element c p) = Element c (translate p) + +reNest :: Bool -> [ResultDelta] -> (XmlTrees, [ResultDelta]) +reNest _ [] = ([], []) +reNest original (Add c : rest) = (c : nested, rest') + where (nested, rest') = reNest original rest +reNest original (StartTag t : rest) = (XN.mkElement name atts content : nested, rest'') + where (content, rest') = reNest original rest + (nested, rest'') = reNest original rest' + name = fromMaybe (error ("No name in start tag " ++ show t) :: QName) (XN.getElemName t) + atts = fromMaybe (error ("No attribute list in start tag " ++ show t) :: XmlTrees) (XN.getAttrl t) +reNest _ (EndTag : rest) = ([], rest) +reNest original (Penalty : rest) = reNest original rest +reNest original (Inferred d : rest) = reNest original (if original then rest else d:rest) diff --git a/Setup.lhs b/Setup.lhs new file mode 100644 --- /dev/null +++ b/Setup.lhs @@ -0,0 +1,4 @@ +#! /usr/bin/env runhaskell + +> import Distribution.Simple +> main = defaultMain diff --git a/Text/XML/HXT/RelaxNG/Parser.hs b/Text/XML/HXT/RelaxNG/Parser.hs new file mode 100644 --- /dev/null +++ b/Text/XML/HXT/RelaxNG/Parser.hs @@ -0,0 +1,528 @@ +{- + Copyright (C) Stilo International plc, 2012 + + This file contains the implementation of concrete-relaxng-parser, a parser driven by a standard RELAX NG schema with + concrete syntax extensions. + + The concrete-relaxng-parser project 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. + + The concrete-relaxng-parser project 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 concrete-relaxng-parser. If not, see + . +-} + +module Text.XML.HXT.RelaxNG.Parser where + +import Prelude hiding (any, null) + +import Control.Monad (liftM2) +import Control.Exception (assert) +import Data.Char (isSpace) +import Data.Foldable (any) +import Data.List (find, groupBy, inits, isInfixOf, isPrefixOf, minimumBy, sortBy, stripPrefix) +import Data.Maybe (fromJust, isNothing, mapMaybe, maybe) +import Data.Ord (comparing) +import Data.Set (Set, empty, null, singleton, union) + +import Debug.Trace (trace) + +import Data.Char.Properties.XMLCharProps ( isXmlSpaceChar ) + +import Text.XML.HXT.DOM.Interface +import Text.XML.HXT.DOM.ShowXml (xshow) +import qualified Text.XML.HXT.DOM.XmlNode as XN +import Text.XML.HXT.RelaxNG (contains, Uri, LocalName, ParamList, Prefix, Context, Datatype, NameClass(..)) +import Text.XML.HXT.RelaxNG.DataTypeLibraries (datatypeAllows, datatypeEqual) + +data Pattern = Empty + | NotAllowed XmlTrees + | Text + | Choice !Pattern !Pattern + | Interleave Int !Pattern !Pattern + | Group !Pattern !Pattern + | OneOrMore !Pattern + | List !Pattern + | Data Datatype ParamList + | DataExcept Datatype ParamList !Pattern + | Value Datatype String Context + | Attribute NameClass !Pattern + | Element NameClass Pattern + | Region Bool QName !Pattern + | Result [ResultDelta] !Pattern + deriving Show + +data ResultDelta = StartTag XNode | Add XmlTree | EndTag | Penalty | Inferred ResultDelta + deriving (Eq, Show) + +type RecoveryLimits = Int + +pretty :: String -> Int -> RecoveryLimits -> Pattern -> String +pretty _ _ _ Empty = "empty" +pretty _ _ _ (NotAllowed ts) = "notAllowed " ++ show ts +pretty _ _ _ Text = "text" +pretty indent 0 rl (Choice p1 p2) = pretty indent 0 rl p1 ++ "\n" ++ indent ++ "| " ++ pretty indent 0 rl p2 +pretty indent prec rl p@Choice{} = "(" ++ pretty (' ':indent) 0 rl p ++ ")" +pretty indent prec rl (Interleave balance p1 p2) + | prec < 3 = "(" ++ pretty indent 2 rl p1 ++ " " ++ replicate (-balance) '<' ++ "&" ++ replicate balance '>' + ++ " " ++ pretty indent 2 rl p2 ++ ")" +pretty indent prec rl p@Interleave{} = "(" ++ pretty (' ':indent) 0 rl p ++ ")" +pretty indent prec rl (Group p1 p2) + | prec < 2 = pretty (' ':indent) 1 rl p1 ++ "\n" ++ indent ++ ", " ++ pretty (' ':indent) 1 rl p2 +pretty indent prec rl p@Group{} = "(" ++ pretty (' ':indent) 0 rl p ++ ")" +pretty indent prec rl (OneOrMore p) = "(" ++ pretty (' ':indent) 0 rl p ++ ")+" +pretty indent prec rl (Element nc@(Name uri local) p) = + "element " ++ show nc + ++ maybe "" + (\rl'-> " {\n " ++ indent ++ pretty (' ':indent) 0 rl' p ++ "}") + (recoveryAllowed (mkNsName local uri) rl) +pretty _ _ rl (Element nc p) = "element " ++ show nc +pretty indent prec rl (Region inf qn p) = "region " ++ show qn ++ " {\n " ++ indent ++ pretty (' ':indent) 0 rl p ++ "}" +pretty indent prec rl (Result r p) = "(result " ++ shows r ("\n " ++ indent ++ pretty (' ':indent) 0 rl p ++ ")") +pretty _ _ rl p = show p + +noRecovery :: RecoveryLimits +noRecovery = 0 + +omissibleNamespacePrefix :: String +omissibleNamespacePrefix = "omissible+" + +terminalNamespace :: String +terminalNamespace ="http://en.wikipedia.org/wiki/Terminal_and_nonterminal_symbols#Terminal_symbols" + +noContext :: Context +noContext = ("", []) + +recoveryAllowed :: QName -> RecoveryLimits -> Maybe RecoveryLimits +recoveryAllowed _ 0 = Nothing +recoveryAllowed qn rl | omissibleNamespacePrefix `isPrefixOf` namespaceUri qn = Just (pred rl) + | terminalNamespace == namespaceUri qn = Just (pred rl) + | otherwise = Nothing + +startSet :: RecoveryLimits -> Pattern -> Set String +startSet rl (Group p1 p2) = (if nullable rl p1 then startSet rl p2 else empty) `union` startSet rl p1 +startSet rl (Interleave balance p1 p2) = startSet rl p1 `union` startSet rl p2 +startSet rl (Choice p1 p2) = startSet rl p1 `union` startSet rl p2 +startSet rl (OneOrMore p) = startSet rl p +startSet rl (Element (Name uri local) p) = maybe empty (flip startSet p) (recoveryAllowed (mkNsName local uri) rl) +startSet rl (Element (NameClassChoice nc1 nc2) p) = startSet rl (Element nc1 p) `union` startSet rl (Element nc2 p) +startSet rl Element{} = empty +startSet _ (Attribute _ _) = empty +startSet _ (List _) = empty +startSet _ (Value _ s _) = singleton s +startSet _ (Data _ _) = empty +startSet _ (DataExcept _ _ _) = empty +startSet _ NotAllowed{} = empty +startSet _ Empty = empty +startSet _ Text = empty +startSet rl (Region _ _ p) = startSet rl p +startSet rl (Result _ p) = startSet rl p + +nullable :: RecoveryLimits -> Pattern -> Bool +nullable rl (Group p1 p2) = nullable rl p1 && nullable rl p2 +nullable rl (Interleave balance p1 p2) = balance == 0 && nullable rl p1 && nullable rl p2 +nullable rl (Choice p1 p2) = nullable rl p1 || nullable rl p2 +nullable rl (OneOrMore p) = nullable rl p +nullable rl (Element (Name uri local) p) = maybe False (\rl'-> nullable rl' p) (recoveryAllowed qn rl) + where qn = mkNsName local uri +nullable rl (Element (NameClassChoice n1 n2) p) = nullable rl (Element n1 p) || nullable rl (Element n2 p) +nullable _ (Element _ _) = False +nullable _ (Attribute _ _) = False +nullable _ (List _) = False +nullable _ (Value _ _ _) = False +nullable _ (Data _ _) = False +nullable _ (DataExcept _ _ _) = False +nullable _ NotAllowed{} = False +nullable _ Empty = True +nullable _ Text = True +nullable _ (Region False _ _) = False +nullable rl (Region True _ p) = nullable rl p +nullable rl (Result _ p) = nullable rl p + +inferred :: ResultDelta -> Bool +inferred (Inferred _) = True +inferred _ = False + +nullableResults:: RecoveryLimits -> Pattern -> [[ResultDelta]] +nullableResults rl (Group p1 p2) = case nullableResults rl p2 + of [] -> [] + l -> assert (all (==[]) l) (nullableResults rl p1) +nullableResults rl (Interleave 0 p1 p2) = liftM2 (++) (nullableResults rl p1) (nullableResults rl p2) +nullableResults rl Interleave{} = [] +nullableResults rl (Choice p1 p2) = nullableResults rl p1 ++ nullableResults rl p2 +nullableResults rl (OneOrMore p) = nullableResults rl p +nullableResults rl (Element (Name uri local) p) = + maybe [] (\rl'-> map enclose $ nullableResults rl' p) (recoveryAllowed qn rl) + where enclose r = Inferred (StartTag (XN.mkElementNode qn [])) : (r ++ [Inferred EndTag]) + qn = mkNsName local uri +nullableResults rl (Element (NameClassChoice n1 n2) p) = + nullableResults rl (Element n1 p) ++ nullableResults rl (Element n2 p) +nullableResults _ (Element _ _) = [] +nullableResults _ (Attribute _ _) = [] +nullableResults _ (List _) = [] +nullableResults _ (Value _ _ _) = [] +nullableResults _ (Data _ _) = [] +nullableResults _ (DataExcept _ _ _) = [] +nullableResults _ NotAllowed{} = [] +nullableResults _ (Region False _ _) = [] +nullableResults rl (Region True q p) = map (++ [Inferred EndTag]) (nullableResults rl p) +nullableResults _ Empty = [[]] +nullableResults _ Text = [[]] +nullableResults rl (Result r p) = map (r ++) (nullableResults rl p) + +prepend :: [ResultDelta] -> ([ResultDelta], String) -> ([ResultDelta], String) +prepend r1 (r2, l) = (r1 ++ r2, l) + +findSplit :: (String -> Bool) -> String -> (String, String) +findSplit p s = splitAt (findTailIndex p 0 s) s + +findTailIndex :: (String -> Bool) -> Int -> String -> Int +findTailIndex _ n [] = n +findTailIndex pred n l@(h:t) = if pred l then n else findTailIndex pred (succ n) t + +findSuffix :: (String -> Bool) -> (String -> String) -> String -> (String, String) +findSuffix pred f [] = (f [], []) +findSuffix pred f l@(h:t) = if pred l then (f [], l) else findSuffix pred (f . (h:)) t + +upto :: Set String -> String -> (String, String) +upto limits s = findSplit startsWithAnyLimit s + where startsWithAnyLimit tail = any (\limit-> limit `isPrefixOf` tail || tail `isPrefixOf` limit) limits + +splits :: String -> [(String, String)] +splits [] = [([], [])] +splits l@(head : tail) = ([], l) : map (\(init, tail)-> (head:init, tail)) (splits tail) + +bestNullableResult :: RecoveryLimits -> Pattern -> Maybe [ResultDelta] +bestNullableResult rl p = case nullableResults rl p + of [] -> Nothing + r -> Just (minimumBy (comparing (semanticLength 0)) r) + +semanticLength :: Int -> [ResultDelta] -> Int +semanticLength s (StartTag node : tail) | XN.getNamespaceUri node == Just terminalNamespace = + semanticLength s (dropContent 0 tail) + where dropContent 0 (EndTag : rest) = rest + dropContent n (EndTag : rest) = dropContent (pred n) rest + dropContent n (StartTag{} : rest) = dropContent (succ n) rest + dropContent n (Inferred d : rest) = dropContent n (d:rest) + dropContent n (_ : rest) = dropContent n rest +semanticLength s (Inferred d : tail) = semanticLength s (d : tail) +semanticLength s (Add t : tail) = semanticLength (s + maybe 1 length (XN.getText t)) tail +semanticLength s (_ : tail) = semanticLength (succ s) tail +semanticLength s [] = s + +hasResults :: Pattern -> Bool +hasResults Result{} = True +hasResults (Choice p1 p2) = hasResults p1 || hasResults p2 +hasResults (Interleave _ p1 p2) = hasResults p1 || hasResults p2 +hasResults (Region _ _ p) = hasResults p +hasResults _ = False + +childDeriv :: RecoveryLimits -> Context -> Pattern -> XmlTree -> Pattern +childDeriv rl cx p t + | XN.isText t = let Just s = XN.getText t + cont r s = if whitespace s + then result (r ++ [Add $ XN.mkText s]) Empty + else NotAllowed [XN.mkText s, t] + in textDeriv rl cx False empty empty p s cont id + | XN.isElem t = let p1 = startTagOpenDeriv rl p (XN.mkElementNode qn atts) + p2 = attsDeriv cx p1 atts + p3 = startTagCloseDeriv p2 + p4 = childrenDeriv rl startContext p3 children + qn = fromJust (XN.getElemName t) + atts = fromJust (XN.getAttrl t) + children = XN.getChildren t + in endTagDeriv rl qn p4 + +textDeriv :: RecoveryLimits -> Context -> Bool -> Set String -> Set String -> Pattern -> String -> + ([ResultDelta] -> String -> Pattern) -> (Pattern -> Pattern) -> Pattern +textDeriv rl cx inf follow alt (Choice p1 p2) s c1 c2 = + let newAlt p = alt `union` startSet rl p `union` if nullable rl p then follow else empty + in choice + (textDeriv rl cx inf follow (newAlt p2) p1 s c1 c2) + (textDeriv rl cx inf follow (newAlt p1) p2 s c1 c2) +textDeriv rl cx inf follow alt (Interleave 0 p1 p2) s c1 c2 = + choice + (textDeriv rl cx inf (follow `union` start2) (alt `union` start2) p1 s (cont p2) (c2 . flip (interleave 0) p2)) + (textDeriv rl cx inf (follow `union` start1) (alt `union` start1) p2 s (cont p1) (c2 . interleave 0 p1)) + where start1 = startSet rl p1 + start2 = startSet rl p2 + cont p r s' = textDeriv rl cx inf follow alt p s' (c1 . (r ++)) (c2 . result r) +textDeriv rl cx inf follow alt (Interleave balance p1 p2) s c1 c2 + | balance < 0 = textDeriv rl cx inf follow alt p1 s fail (c2 . flip (interleave balance) p2) + | balance > 0 = textDeriv rl cx inf follow alt p2 s fail (c2 . interleave balance p1) + where fail _ s = NotAllowed [XN.mkText s] +textDeriv rl cx inf follow alt (Group p1 p2) s c1 c2 = + textDeriv rl cx inf follow' alt p1 s + (\r s'-> textDeriv rl cx inf follow (altAfter r) p2 s' (c1 . (r ++)) (c2 . result r)) + (c2 . flip group p2) + where follow1 = startSet rl p2 + follow' = if nullable rl p2 then follow1 `union` follow else follow1 + altAfter r = if blankResult r then alt else empty +textDeriv rl cx inf follow alt (OneOrMore p) s c1 c2 = + textDeriv rl cx inf follow' alt p s + (\r s'-> case r of [] -> c1 r s' + _ -> textDeriv rl cx inf follow' (altAfter r) zeroOrMore s' (c1 . (r ++)) (c2 . result r)) + (c2 . flip group zeroOrMore) + where follow' = follow `union` startSet rl p + zeroOrMore = choice (OneOrMore p) Empty + altAfter r = if blankResult r then alt else empty +textDeriv rl cx inf follow alt Text s c1 c2 = + case upto (alt `union` follow) s + of ("", c:s') -> NotAllowed [XN.mkText s] + (_, "") -> c2 $ result [(if inf then Inferred else id) (Add $ XN.mkText s)] Text + (init, tail) -> c1 [(if inf then Inferred else id) (Add $ XN.mkText init)] tail +textDeriv rl cx inf follow alt Empty "" c1 c2 = c2 Empty +textDeriv rl cx inf follow alt Empty s c1 c2 = c1 [] s +textDeriv rl cx1 inf follow alt (Value (uri, name) value cx2) s c1 c2 + | isNothing (datatypeEqual uri name value cx2 s cx1) = + c2 $ result [(if inf then Inferred else id) (Add (XN.mkText s))] Empty + | otherwise = case datatypePrefix uri name value cx2 s cx1 + of Just (p, s) -> c1 [(if inf then Inferred else id) (Add $ XN.mkText p)] s + Nothing -> NotAllowed [XN.mkText s] +textDeriv rl cx inf follow alt (Data (uri, name) params) s c1 c2 = + case longestAllowedPrefix cx uri name params init + of Just (allowed, rest) -> case rest ++ tail + of "" -> c2 $ result [(if inf then Inferred else id) (Add (XN.mkText allowed))] Empty + s' -> c1 [(if inf then Inferred else id) (Add (XN.mkText allowed))] s' + Nothing -> NotAllowed [XN.mkText s] + where (init, tail) = upto (alt `union` follow) s +textDeriv rl cx inf follow alt (DataExcept (uri, name) params p) s c1 c2 + | isNothing (datatypeAllows uri name params s cx) + && not (nullable rl (textDeriv rl cx inf follow alt p s (\_ _-> NotAllowed [XN.mkText s]) id)) = + c2 $ result [(if inf then Inferred else id) (Add (XN.mkText s))] Empty +textDeriv rl cx inf follow alt (List p) s c1 c2 + | nullable rl (listDeriv cx follow alt p (words s)) = + c2 $ result [(if inf then Inferred else id) (Add (XN.mkText s))] Empty +textDeriv rl cx inf follow alt (Element (Name uri local) p) s c1 c2 = + let qn = mkNsName local uri + in case recoveryAllowed qn rl + of Just rl' -> textDeriv rl' cx inf follow alt (startTagCloseDeriv p) s + (\r-> c1 ([Inferred $ StartTag $ XN.mkElementNode qn []] ++ r ++ [Inferred EndTag])) + (c2 . result [Inferred $ StartTag $ XN.mkElementNode qn []] . region True qn) + Nothing -> if whitespace s then c2 $ result [Add $ XN.mkText s] p else NotAllowed [XN.mkText s] +textDeriv rl cx inf follow alt (Element (NameClassChoice n1 n2) p) s c1 c2 = + choice + (textDeriv rl cx inf follow alt (Element n1 p) s c1 c2) + (textDeriv rl cx inf follow alt (Element n2 p) s c1 c2) +textDeriv rl cx inf follow alt p@(Element _ _) s c1 c2 = + if whitespace s then c2 $ result [Add $ XN.mkText s] p else NotAllowed [XN.mkText s] +textDeriv rl cx inf follow alt (Region False qn p) s c1 c2 = + textDeriv rl cx inf empty empty p s (\r-> region False qn . c1 r) (c2 . region False qn) +textDeriv rl cx inf follow alt (Region True qn p) s c1 c2 = + maybe (NotAllowed [XN.mkText s]) + (\rl'-> textDeriv rl' cx inf follow alt p s + (\r-> c1 (r ++ [Inferred EndTag])) + (c2 . region True qn)) + (recoveryAllowed qn rl) +textDeriv rl cx inf follow alt (Result r p) s c1 c2 = + textDeriv rl cx inf follow alt p s (\r'-> c1 (r ++ r')) (c2 . result r) +textDeriv _ _ _ _ _ p@NotAllowed{} _ _ _ = p +textDeriv _ _ _ _ _ _ s _ _ = NotAllowed [XN.mkText s] + +listDeriv :: Context -> Set String -> Set String -> Pattern -> [String] -> Pattern +listDeriv _ _ _ p [] = p +listDeriv cx follow alt p (h:t) = + textDeriv noRecovery cx False follow alt p h + (\_ _-> NotAllowed [XN.mkText h]) + (flip group $ listDeriv cx follow alt p t) + +startRecovery :: RecoveryLimits -> QName -> Context -> Pattern -> Pattern +startRecovery rl qn cx p = result [Inferred (StartTag (XN.mkElementNode qn []))] (startTagCloseDeriv p) + +region :: Bool -> QName -> Pattern -> Pattern +region inferred qname p@NotAllowed{} = p +region inferred qname (Result r p) = result r (region inferred qname p) +region inferred qname p = Region inferred qname p + +result :: [ResultDelta] -> Pattern -> Pattern +result _ p@NotAllowed{} = p +result r1 (Result r2 p) = Result (r1 ++ r2) p +result [] p = p +result r p = Result r p + +addResult :: Pattern -> [ResultDelta] -> Pattern +addResult p@NotAllowed{} _ = p +addResult (Choice p1 p2) r = Choice (addResult p1 r) (addResult p2 r) +addResult (Group p1 p2) r = group (addResult p1 r) p2 +addResult p@(Interleave balance p1 p2) r = interleave balance (addResult p1 r) p2 +addResult (Result r1 p) r2 = result r1 (addResult p r2) +addResult (Region inferred qn p) r = Region inferred qn (addResult p r) +addResult p r = Result r p + +choice :: Pattern -> Pattern -> Pattern +choice p NotAllowed{} = p +choice NotAllowed{} p = p +choice Empty t@Text{} = t +choice t@Text{} Empty = t +choice p1 p2 = Choice p1 p2 + +group :: Pattern -> Pattern -> Pattern +group _ p@NotAllowed{} = p +group p@NotAllowed{} _ = p +group p Empty = p +group Empty p = p +group _ (Result _ _) = error "Can't have Result on the RHS of Group." +group (Result r p1) p2 = result r (group p1 p2) +group Text Text = Text +group p1 p2 = Group p1 p2 + +interleave :: Int -> Pattern -> Pattern -> Pattern +interleave _ _ p@NotAllowed{} = p +interleave _ p@NotAllowed{} _ = p +interleave _ p Empty = p +interleave _ Empty p = p +interleave _ Text Text = Text +interleave balance p1 p2 = Interleave balance p1 p2 + +startContext = ("", []) + +startTagOpenDeriv :: RecoveryLimits -> Pattern -> XNode -> Pattern +startTagOpenDeriv rl (Choice p1 p2) node = choice (startTagOpenDeriv rl p1 node) (startTagOpenDeriv rl p2 node) +startTagOpenDeriv rl (Element (NameClassChoice n1 n2) p) node = + choice (startTagOpenDeriv rl (Element n1 p) node) (startTagOpenDeriv rl (Element n2 p) node) +startTagOpenDeriv rl (Element nc@(Name uri local) p) node@(XTag qn _) = + if contains nc qn + then Region False qn (result [StartTag node] p) + else let qn = mkNsName local uri + in case recoveryAllowed qn rl + of Just rl' -> region True qn (startTagOpenDeriv rl' (startRecovery rl' qn startContext p) node) + Nothing -> NotAllowed [XN.mkLeaf node] +startTagOpenDeriv rl (Element nc p) node@(XTag qn _) = + if contains nc qn then Region False qn (result [StartTag node] p) else NotAllowed [XN.mkLeaf node] +startTagOpenDeriv rl (Interleave 0 p1 p2) node = + choice + (let p = interleave (-1) (startTagOpenDeriv rl p1 node) p2 + in if hasResults p2 then result [Penalty] p else p) + (interleave 1 p1 (startTagOpenDeriv rl p2 node)) +startTagOpenDeriv rl (Interleave balance p1 p2) node = + if balance < 0 + then interleave (balance-1) (startTagOpenDeriv rl p1 node) p2 + else interleave (balance+1) p1 (startTagOpenDeriv rl p2 node) +startTagOpenDeriv rl (OneOrMore p) node = group (startTagOpenDeriv rl p node) (choice (OneOrMore p) Empty) +startTagOpenDeriv rl (Group p1 p2) node = + let p = group (startTagOpenDeriv rl p1 node) p2 + in maybe p (\r-> choice p (result r $ startTagOpenDeriv rl p2 node)) (bestNullableResult rl p1) +startTagOpenDeriv rl (Region False qn p) node = region False qn $ startTagOpenDeriv rl p node +startTagOpenDeriv rl (Region True qn p) node = + maybe (NotAllowed [XN.mkLeaf node]) (\rl'-> region True qn $ startTagOpenDeriv rl' p node) (recoveryAllowed qn rl) +startTagOpenDeriv rl (Result r p) node = result r (startTagOpenDeriv rl p node) +startTagOpenDeriv _ p@NotAllowed{} _ = p +startTagOpenDeriv _ _ node = NotAllowed [XN.mkLeaf node] + +attsDeriv :: Context -> Pattern -> XmlTrees -> Pattern +attsDeriv _ p [] = p +attsDeriv cx p (t : ts) + | XN.isAttr t = attsDeriv cx (attDeriv cx p t) ts + | otherwise = NotAllowed [t] + +attDeriv :: Context -> Pattern -> XmlTree -> Pattern +attDeriv cx (Choice p1 p2) att = choice (attDeriv cx p1 att) (attDeriv cx p2 att) +attDeriv cx (Group p1 p2) att = choice (group (attDeriv cx p1 att) p2) (group p1 (attDeriv cx p2 att)) +attDeriv cx (Interleave balance p1 p2) att = + choice (interleave balance (attDeriv cx p1 att) p2) (interleave balance p1 (attDeriv cx p2 att)) +attDeriv cx (OneOrMore p) att = group (attDeriv cx p att) (choice (OneOrMore p) Empty) +attDeriv cx (Attribute nc p) att + | XN.isAttr att = if contains nc (fromJust $ XN.getAttrName att) + && valueMatch cx p (xshow $ XN.getChildren att) + then Empty else NotAllowed [att] +attDeriv cx (Region inferred qn p) att = Region inferred qn (attDeriv cx p att) +attDeriv cx (Result r p) att = result r (attDeriv cx p att) +attDeriv _ _ t = NotAllowed [t] + +valueMatch :: Context -> Pattern -> String -> Bool +valueMatch cx p s = (nullable noRecovery p && whitespace s) + || nullable noRecovery (textDeriv noRecovery cx False empty empty p s + (\_ _-> NotAllowed [XN.mkText s]) id) + +startTagCloseDeriv :: Pattern -> Pattern +startTagCloseDeriv (Choice p1 p2) = choice (startTagCloseDeriv p1) (startTagCloseDeriv p2) +startTagCloseDeriv (Group p1 p2) = group (startTagCloseDeriv p1) (startTagCloseDeriv p2) +startTagCloseDeriv (Interleave balance p1 p2) = interleave balance (startTagCloseDeriv p1) (startTagCloseDeriv p2) +startTagCloseDeriv (OneOrMore p) = oneOrMore (startTagCloseDeriv p) +startTagCloseDeriv (Attribute nc _) = NotAllowed [XN.mkError' c_err ("Missing required attribute " ++ show nc)] +startTagCloseDeriv (Region inferred qn p) = Region inferred qn (startTagCloseDeriv p) +startTagCloseDeriv (Result r p) = result r (startTagCloseDeriv p) +startTagCloseDeriv p = p + +oneOrMore :: Pattern -> Pattern +oneOrMore p@NotAllowed{} = p +oneOrMore Empty = Empty +oneOrMore p@Text{} = p +oneOrMore p@OneOrMore{} = p +oneOrMore (Choice p Empty) = Choice (oneOrMore p) Empty +oneOrMore (Choice Empty p) = Choice Empty (oneOrMore p) +oneOrMore (Result r p) = result r (oneOrMore p) +oneOrMore p = OneOrMore p + +childrenDeriv :: RecoveryLimits -> Context -> Pattern -> XmlTrees -> Pattern +childrenDeriv _ _ p@NotAllowed{} _ = p +childrenDeriv rl cx p [] = p +childrenDeriv rl cx p [t] | XN.isText t = childDeriv rl cx p t +childrenDeriv rl cx p children = stripChildrenDeriv rl cx p children + +stripChildrenDeriv :: RecoveryLimits -> Context -> Pattern -> XmlTrees -> Pattern +stripChildrenDeriv _ _ p@NotAllowed{} _ = p +stripChildrenDeriv _ _ p [] = p +stripChildrenDeriv rl cx p (h:t) = + stripChildrenDeriv rl cx (if strip h then (addResult p [Add h]) else childDeriv rl cx p h) t + +endTagDeriv :: RecoveryLimits -> QName -> Pattern -> Pattern +endTagDeriv rl qn (Choice p1 p2) = choice (endTagDeriv rl qn p1) (endTagDeriv rl qn p2) +endTagDeriv rl qn1 (Region False qn2 p) | qn1 == qn2 = + maybe (NotAllowed [XN.mkError' c_err ("Cannot close element " ++ show qn1)]) + (\r-> result (r ++ [EndTag]) Empty) + (bestNullableResult rl p) +endTagDeriv rl qn1 (Region inf qn2 p) = region inf qn2 (endTagDeriv rl qn1 p) +endTagDeriv rl qn (Result r p) = result r (endTagDeriv rl qn p) +endTagDeriv rl qn (Group p1 p2) = group (endTagDeriv rl qn p1) p2 +endTagDeriv rl qn (Interleave balance p1 p2) + | balance < 0 = interleave (balance+1) (endTagDeriv rl qn p1) p2 + | balance == 0 = NotAllowed [XN.mkError' c_err ("Cannot close interleaved element " ++ show qn)] + | balance > 0 = interleave (balance-1) p1 (endTagDeriv rl qn p2) +endTagDeriv _ _ p@NotAllowed{} = p +endTagDeriv _ qn _ = NotAllowed [XN.mkError' c_err ("Cannot find and close element " ++ show qn)] + +longestAllowedPrefix :: Context -> String -> String -> ParamList -> String -> Maybe (String, String) +longestAllowedPrefix _ "" "string" [] s = Just (s, "") +longestAllowedPrefix _ "http://www.w3.org/XML/2001/XMLSchema-datatypes" "string" [] s = Just (s, "") +longestAllowedPrefix cx uri name params s = + find (\(init, tail)-> isNothing (datatypeAllows uri name params init cx)) (reverse $ splits s) + +commonPrefixes :: Eq x => ([x] -> [x]) -> [x] -> [x] -> ([x], [x], [x]) +commonPrefixes c [] l = (c [], [], l) +commonPrefixes c l [] = (c [], l, []) +commonPrefixes c l1@(h1:t1) l2@(h2:t2) | h1 == h2 = commonPrefixes (c . (h1:)) t1 t2 + | otherwise = (c [], l1, l2) + +datatypePrefix :: String -> String -> String -> Context -> String -> Context -> Maybe (String, String) +datatypePrefix "" "string" s1 _ s2 _ = fmap ((,) s1) (stripPrefix s1 s2) +datatypePrefix "http://www.w3.org/XML/2001/XMLSchema-datatypes" "string" s1 _ s2 _ = fmap ((,) s1) (stripPrefix s1 s2) +datatypePrefix "http://www.w3.org/2001/XMLSchema-datatypes" "string" s1 _ s2 _ = fmap ((,) s1) (stripPrefix s1 s2) +datatypePrefix "" "token" s1 _ s2 _ = case span isSpace s2 + of (spaces, s2') -> let s1' = dropWhile isSpace s1 + in fmap ((,) (spaces ++ s1')) (stripPrefix s1' s2') +datatypePrefix "http://www.w3.org/XML/2001/XMLSchema-datatypes" "token" s1 cx1 s2 cx2 = + datatypePrefix "" "token" s1 cx1 s2 cx2 +datatypePrefix "http://www.w3.org/2001/XMLSchema-datatypes" "token" s1 cx1 s2 cx2 = + datatypePrefix "" "token" s1 cx1 s2 cx2 +datatypePrefix uri name s1 cx1 s2 cx2 + | s1 == s2 = Just (s1, "") + | otherwise = {-# SCC "datatypePrefix.generic" #-} + fmap (\prefix-> (prefix, fromJust $ stripPrefix prefix s2)) + $ find (\prefix-> isNothing $ datatypeEqual uri name s1 cx1 prefix cx2) (inits s2) + +blankResult :: [ResultDelta] -> Bool +blankResult = all blank + where blank (Add t) = maybe False whitespace (XN.getText t) + blank (Inferred n) = blank n + blank _ = False + +strip :: XmlTree -> Bool +strip = maybe False whitespace . XN.getText + +whitespace :: String -> Bool +whitespace = all isXmlSpaceChar diff --git a/concrete-relaxng-parser.cabal b/concrete-relaxng-parser.cabal new file mode 100644 --- /dev/null +++ b/concrete-relaxng-parser.cabal @@ -0,0 +1,65 @@ +Name: concrete-relaxng-parser +Version: 0.1 +Cabal-Version: >= 1.10 +Build-Type: Simple +Synopsis: A parser driven by a standard RELAX NG schema with concrete syntax extensions. +Category: Parsing, XML +Tested-with: GHC +Description: + This package exports a parser executable named @parse-concrete@. The executable takes two arguments, the target RELAX + NG schema filename and the input filename. The input must be well-formed XML. The output of the parser is either an + error or XML conforming to the schema. + . + If the input XML already conforms to the target schema, the parser acts as an ordinary RELAX NG validator. If not, it + attempts to insert the missing element tags and to parse the text nodes within the input XML into XML elements. The + target schema can be enriched by concrete syntax extensions, syntactically compatible with standard RELAX NG, to drive + the parsing process. + . + The included sample RELAX NG schema @xhtml-concrete.rng@ is an extension of the regular must be used together with + James Clark's modularized RELAX NG schema for XHTML, which can be downloaded from + . Here is an example session: + . + > $ cat <test.xhtml.short + > + > Title + > + > A paragraph may contain more than one line. + > Use *four* (that was emphasized) hyphens to draw a horizontal line: + > + > ---- + > + > Unnumbered lists are like + > * item a + > * item b + > + > Numbered lists are like + > * item a + > * item b + > + > END + > $ parse-concrete xhtml-concrete.rng test.xhtml.short | tee test.xhtml + > + > + > Title

A paragraph may contain more than one line. + > Use four (that was emphasized) hyphens to draw a horizontal line:

+ >

Unnumbered lists are like

  • item a
  • item b

>Numbered lists are like

  • item a
  • item b + >
+ > $ parse-concrete xhtml-concrete.rng test.xhtml | diff test.xhtml - + > $ + +License: GPL +License-file: LICENSE.txt +Copyright: Copyright (C) Stilo International plc, 2012 +Author: Mario Blazevic +Maintainer: mblazevic@stilo.com + +Data-files: xhtml-concrete.rng + +Executable parse-concrete + Main-is: ParseShortXML.hs + Other-Modules: Text.XML.HXT.RelaxNG.Parser + Build-Depends: base < 5, containers >= 0.4 && < 0.6, hxt >= 9.2 && < 10, hxt-relaxng == 9.1.*, + hxt-charproperties == 9.*, hxt-tagsoup == 9.1.*, hxt-curl == 9.1.*, cmdargs == 0.9.* + GHC-options: -threaded + default-language: Haskell2010 diff --git a/xhtml-concrete.rng b/xhtml-concrete.rng new file mode 100644 --- /dev/null +++ b/xhtml-concrete.rng @@ -0,0 +1,183 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + * + + + + + + + + + + + + + + + + + + # + + + + + + * + + + + + + ---- + + +