diff --git a/LICENSE b/LICENSE
new file mode 100644
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/Setup.lhs b/Setup.lhs
new file mode 100644
--- /dev/null
+++ b/Setup.lhs
@@ -0,0 +1,3 @@
+#! /usr/bin/env runhaskell
+> import Distribution.Simple
+> main = defaultMain
diff --git a/example/Test.hs b/example/Test.hs
new file mode 100644
--- /dev/null
+++ b/example/Test.hs
@@ -0,0 +1,7 @@
+module Main where
+
+import Text.HTML.TagSoup.HT.Test as Test
+
+main :: IO ()
+main =
+ putStrLn Test.laziness
diff --git a/example/Validate.hs b/example/Validate.hs
new file mode 100644
--- /dev/null
+++ b/example/Validate.hs
@@ -0,0 +1,32 @@
+{-
+Example program for TagSoup.
+Detects basic syntax errors like isolated ampersands and unquoted attribute values.
+-}
+module Main where
+
+import Text.HTML.TagSoup.HT.Parser
+import qualified Text.HTML.TagSoup.HT.Position as Position
+import qualified Text.HTML.TagSoup.HT.PositionTag as PosTag
+import qualified Text.HTML.TagSoup.HT.Tag as Tag
+
+import System.Environment (getArgs)
+
+import Data.Maybe (mapMaybe)
+
+
+validate :: FilePath -> String -> String
+validate fileName input =
+ let tags :: [PosTag.T Char]
+ tags = runSoupWithPositionsName fileName input
+ warnings =
+ mapMaybe (\(pos,tag) -> fmap ((,) pos) $ Tag.maybeWarning tag) tags
+ in unlines $ map (\(pos,msg) -> Position.toReportText pos ++ " " ++ msg) warnings
+
+validateIO :: FilePath -> IO ()
+validateIO fileName =
+ do text <- readFile fileName
+ putStrLn (validate fileName text)
+
+
+main :: IO ()
+main = mapM_ validateIO =<< getArgs
diff --git a/src/Text/HTML/TagSoup/HT/HTMLChar.hs b/src/Text/HTML/TagSoup/HT/HTMLChar.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/HTMLChar.hs
@@ -0,0 +1,7 @@
+module Text.HTML.TagSoup.HT.HTMLChar where
+
+data T =
+ Char Char
+ | NumericRef Int
+ | NamedRef String
+ deriving (Show, Eq)
diff --git a/src/Text/HTML/TagSoup/HT/Match.hs b/src/Text/HTML/TagSoup/HT/Match.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Match.hs
@@ -0,0 +1,96 @@
+module Text.HTML.TagSoup.HT.Match where
+
+import qualified Text.HTML.TagSoup.HT.Tag as Tag
+
+
+ignore :: a -> Bool
+ignore _ = True
+
+
+-- | match an opening tag
+open :: (String -> Bool) -> ([Tag.Attribute char] -> Bool) -> Tag.T char -> Bool
+open pName pAttrs (Tag.Open name attrs) =
+ pName name && pAttrs attrs
+open _ _ _ = False
+
+-- | match an closing tag
+close :: (String -> Bool) -> Tag.T char -> Bool
+close pName (Tag.Close name) = pName name
+close _ _ = False
+
+-- | match a text
+text :: ([char] -> Bool) -> Tag.T char -> Bool
+text p (Tag.Text str) = p str
+text _ _ = False
+
+comment :: (String -> Bool) -> Tag.T char -> Bool
+comment p (Tag.Comment str) = p str
+comment _ _ = False
+
+special :: (String -> Bool) -> (String -> Bool) -> Tag.T char -> Bool
+special pType pInfo (Tag.Special typ info) = pType typ && pInfo info
+special _ _ _ = False
+
+
+-- | match a opening tag's name literally
+openLit :: String -> ([Tag.Attribute char] -> Bool) -> Tag.T char -> Bool
+openLit name = open (name==)
+
+-- | match a closing tag's name literally
+closeLit :: String -> Tag.T char -> Bool
+closeLit name = close (name==)
+
+openAttrLit :: (Eq char) =>
+ String -> Tag.Attribute char -> Tag.T char -> Bool
+openAttrLit name attr =
+ openLit name (anyAttrLit attr)
+
+{- |
+Match a tag with given name, that contains an attribute
+with given name, that satisfies a predicate.
+If an attribute occurs multiple times,
+all occurrences are checked.
+-}
+openAttrNameLit :: String -> String -> ([char] -> Bool) -> Tag.T char -> Bool
+openAttrNameLit tagName attrName pAttrValue =
+ openLit tagName
+ (anyAttr (\(name,value) -> name==attrName && pAttrValue value))
+
+
+-- | Check if the 'Tag.T' is 'Tag.Open' and matches the given name
+openNameLit :: String -> Tag.T char -> Bool
+openNameLit name = openLit name ignore
+
+-- | Check if the 'Tag.T' is 'Tag.Close' and matches the given name
+closeNameLit :: String -> Tag.T char -> Bool
+closeNameLit name = closeLit name
+
+
+
+
+anyAttr :: ((String,[char]) -> Bool) -> [Tag.Attribute char] -> Bool
+anyAttr = any
+
+anyAttrName :: (String -> Bool) -> [Tag.Attribute char] -> Bool
+anyAttrName p = any (p . fst)
+
+anyAttrValue :: ([char] -> Bool) -> [Tag.Attribute char] -> Bool
+anyAttrValue p = any (p . snd)
+
+
+anyAttrLit :: (Eq char) => (String,[char]) -> [Tag.Attribute char] -> Bool
+anyAttrLit attr = anyAttr (attr==)
+
+anyAttrNameLit :: String -> [Tag.Attribute char] -> Bool
+anyAttrNameLit name = anyAttrName (name==)
+
+anyAttrValueLit :: (Eq char) => [char] -> [Tag.Attribute char] -> Bool
+anyAttrValueLit value = anyAttrValue (value==)
+
+
+{-
+getTagContent :: String -> ([Tag.Attribute char] -> Bool) -> [Tag.T char] -> [Tag.T char]
+getTagContent name pAttrs =
+ takeWhile (not . tagCloseLit name) . drop 1 .
+ head . sections (tagOpenLit name pAttrs)
+-}
diff --git a/src/Text/HTML/TagSoup/HT/Parser.hs b/src/Text/HTML/TagSoup/HT/Parser.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Parser.hs
@@ -0,0 +1,347 @@
+{-|
+This is a tag soup parser with a custom tag data structure.
+
+The parser works only on proper Unicode texts,
+that is, you must have decoded it before,
+e.g. using decoding functions from hxt or encoding package.
+-}
+module Text.HTML.TagSoup.HT.Parser (
+ CharType,
+ runSoup, runSoupWithPositions, runSoupWithPositionsName,
+ runTag, runInnerOfTag,
+ ) where
+
+import Text.HTML.TagSoup.HT.Parser.Combinator
+ (allowFail, withDefault,
+ char, dropSpaces, getPos,
+ many, many1, many1Satisfy, readUntil,
+ satisfy, string,
+ emit, mfix, )
+
+import qualified Text.HTML.TagSoup.HT.Parser.Combinator as Parser
+
+import qualified Text.HTML.TagSoup.HT.Tag as Tag
+import qualified Text.HTML.TagSoup.HT.PositionTag as PosTag
+import qualified Text.HTML.TagSoup.HT.Position as Position
+import qualified Text.HTML.TagSoup.HT.HTMLChar as HTMLChar
+
+import qualified Text.HTML.TagSoup.Entity as HTMLEntity
+
+import Control.Monad (mplus, msum, when, liftM, )
+
+-- import Control.Monad.Identity (Identity(..), )
+
+import Data.Char (isAlphaNum, isAscii, isDigit, chr, )
+import Data.Maybe (fromMaybe, )
+
+
+
+-- * run parser in several ways
+
+{- |
+Parse a single tag, throws an error if there is a syntax error.
+This is useful for parsing a match pattern.
+-}
+runTag :: (CharType char, Show char) =>
+ String -> Tag.T char
+runTag str =
+ let tags =
+ fromMaybe (error "runTag: no parse at all") $
+ Parser.write "string" parsePosTag str
+ makeError = error $
+ "runTag: parsing results in\n" ++
+ unlines (map show tags)
+ in case tags of
+ [(_,tag)] ->
+ if Tag.isWarning tag
+ then makeError
+ else tag
+ _ -> makeError
+
+{- |
+Parse the inner of a single tag.
+That is, @runTag \"\\"@ is the same as @runInnerOfTag \"\\"@.
+-}
+runInnerOfTag :: (CharType char, Show char) =>
+ String -> Tag.T char
+runInnerOfTag str = runTag $ "<"++str++">"
+
+
+
+runSoupWithPositionsName :: CharType char =>
+ FilePath -> String -> [PosTag.T char]
+runSoupWithPositionsName fileName =
+ Parser.runIdentity .
+ Parser.write fileName (many parsePosTag >> return ())
+
+
+-- | Parse an HTML document to a list of 'Tag.T'.
+-- Automatically expands out escape characters.
+runSoupWithPositions :: CharType char =>
+ String -> [PosTag.T char]
+runSoupWithPositions =
+ Parser.runIdentity .
+ Parser.write "input" (many parsePosTag >> return ())
+
+-- | Like 'runSoupWithPositions' but hides source file positions.
+runSoup :: CharType char => String -> [Tag.T char]
+runSoup = map snd . runSoupWithPositions
+
+
+
+-- * parser parts
+
+type Parser char a = Parser.Full (PosTag.T char) a
+type ParserEmit char a = Parser.Emitting (PosTag.T char) a
+
+
+parsePosTag :: CharType char => Parser char ()
+parsePosTag = do
+ pos <- getPos
+ mplus
+ (do char '<'
+ allowFail $ withDefault
+ (msum $
+ parseSpecialTag pos :
+ parseProcessingTag pos :
+ parseCloseTag pos :
+ parseOpenTag pos :
+ [])
+ (do emitTag pos (Tag.Text [fromChar '<'])
+ emitWarning pos "A '<', that is not part of a tag. Encode it as < please."))
+ (parseText pos)
+
+
+parseOpenTag :: CharType char => Position.T -> Parser char ()
+parseOpenTag pos =
+ do name <- parseName
+ allowFail $
+ do dropSpaces
+ mfix
+ (\attrs ->
+ emit (pos, Tag.Open name attrs) >>
+ many parseAttribute)
+ withDefault
+ (do closePos <- getPos
+ string "/>"
+ allowFail $ emitTag closePos (Tag.Close name))
+ (do junkPos <- getPos
+ readUntilTerm
+ (\ junk ->
+ emitWarningWhen
+ (not $ null junk)
+ junkPos ("Junk in opening tag: \"" ++ junk ++ "\""))
+ ("Unterminated open tag \"" ++ name ++ "\"") ">")
+
+parseCloseTag :: Position.T -> Parser char ()
+parseCloseTag pos =
+ do char '/'
+ name <- parseName
+ allowFail $
+ do emitTag pos (Tag.Close name)
+ dropSpaces
+ junkPos <- getPos
+ readUntilTerm
+ (\ junk ->
+ emitWarningWhen
+ (not $ null junk)
+ junkPos ("Junk in closing tag: \"" ++ junk ++"\""))
+ ("Unterminated closing tag \"" ++ name ++"\"") ">"
+
+parseSpecialTag :: Position.T -> Parser char ()
+parseSpecialTag pos =
+ do char '!'
+ msum $
+ (do string "--"
+ allowFail $ readUntilTerm
+ (\ cmt -> emitTag pos (Tag.Comment cmt))
+ "Unterminated comment" "-->") :
+ (do string "[CDATA["
+ allowFail $ readUntilTerm
+ (\ cdata -> emitTag pos (Tag.Special "[CDATA[" cdata))
+ "Unterminated cdata" "]]>") :
+ (do name <- many1Satisfy isAlphaNum
+ allowFail $
+ do dropSpaces
+ readUntilTerm
+ (\ info -> emitTag pos (Tag.Special name info))
+ ("Unterminated special tag \"" ++ name ++ "\"") ">") :
+ []
+
+parseProcessingTag :: CharType char => Position.T -> Parser char ()
+parseProcessingTag pos =
+ do char '?'
+ name <- parseName
+ allowFail $
+ do dropSpaces
+ mfix
+ (\proc ->
+ emit (pos, Tag.Processing name proc) >>
+ if elem name ["xml", "xml-stylesheet"]
+ then
+ do attrs <- many parseAttribute
+ junkPos <- getPos
+ readUntilTerm
+ (\ junk ->
+ emitWarningWhen (not $ null junk) junkPos
+ ("Junk in processing info tag: \"" ++ junk ++ "\""))
+ ("Unterminated processing info tag \"" ++ name ++ "\"") "?>"
+ return $ Tag.KnownProcessing attrs
+ else readUntilTerm (return . Tag.UnknownProcessing)
+ "Unterminated processing instruction" "?>")
+ return ()
+
+parseText :: CharType char => Position.T -> Parser char ()
+parseText pos =
+ mfix
+ (\ text ->
+ allowFail (emitTag pos (Tag.Text text)) >>
+ parseString1 ('<'/=))
+ >> return ()
+
+
+parseAttribute :: CharType char => Parser char (Tag.Attribute char)
+parseAttribute =
+ parseName >>= \name -> allowFail $
+ do dropSpaces
+ value <-
+ withDefault
+ (string "=" >> allowFail (dropSpaces >> parseValue))
+ (return [])
+ dropSpaces
+ return (name, value)
+
+parseName :: Parser char String
+parseName =
+ -- we must restrict to ASCII alphanum characters in order to exclude umlauts
+ many1Satisfy (\c -> isAlphaNum c && isAscii c || c `elem` "_-:")
+
+parseValue :: CharType char => ParserEmit char [char]
+parseValue =
+ (msum $
+ parseQuoted "Unterminated doubly quoted value string" '"' :
+ parseQuoted "Unterminated singly quoted value string" '\'' :
+ [])
+ `withDefault`
+ parseUnquotedValue
+
+parseUnquotedValueChar :: ParserEmit Char String
+parseUnquotedValueChar =
+ let parseValueChar =
+ do pos <- getPos
+ str <- parseChar (not . flip elem " >\"\'")
+ let wrong = filter (not . isValidValueChar) str
+ allowFail $
+ emitWarningWhen (not (null wrong)) pos $
+ "Illegal characters in unquoted value: " ++ wrong
+ return str
+ in liftM concat $ many parseValueChar
+
+parseUnquotedValueHTMLChar :: ParserEmit HTMLChar.T [HTMLChar.T]
+parseUnquotedValueHTMLChar =
+ let parseValueChar =
+ do pos <- getPos
+ hc <- parseHTMLChar (not . flip elem " >\"\'")
+ case hc of
+ HTMLChar.Char c ->
+ allowFail $
+ emitWarningWhen (not (isValidValueChar c)) pos $
+ "Illegal characters in unquoted value: '" ++ c : "'"
+ _ -> return ()
+ return hc
+ in many parseValueChar
+
+isValidValueChar :: Char -> Bool
+isValidValueChar c = isAlphaNum c || c `elem` "_-:."
+
+parseQuoted :: CharType char => String -> Char -> Parser char [char]
+parseQuoted termMsg quote =
+ char quote >>
+ (allowFail $
+ do str <- parseString (quote/=)
+ withDefault
+ (char quote >> return ())
+ (do termPos <- getPos
+ emitWarning termPos termMsg)
+ return str)
+
+{-
+Instead of using 'generateTag' we could also wrap the call to 'readUntilTerm'
+in 'mfix' in order to emit a tag, where some information is read later.
+-}
+readUntilTerm ::
+ (String -> ParserEmit char a) -> String -> String -> ParserEmit char a
+readUntilTerm generateTag termWarning termPat =
+ do ~(termFound,str) <- readUntil termPat
+ result <- generateTag str
+ termPos <- getPos
+ emitWarningWhen (not termFound) termPos termWarning
+ return result
+
+
+class CharType char where
+ fromChar :: Char -> char
+ parseString :: (Char -> Bool) -> ParserEmit char [char]
+ parseString1 :: (Char -> Bool) -> Parser char [char]
+ parseUnquotedValue :: ParserEmit char [char]
+
+instance CharType Char where
+ fromChar = id
+ parseString p = liftM concat $ many (parseChar p)
+ parseString1 p = liftM concat $ many1 (parseChar p)
+ parseUnquotedValue = parseUnquotedValueChar
+
+instance CharType HTMLChar.T where
+ fromChar = HTMLChar.Char
+ parseString p = many (parseHTMLChar p)
+ parseString1 p = many1 (parseHTMLChar p)
+ parseUnquotedValue = parseUnquotedValueHTMLChar
+
+
+parseChar :: (Char -> Bool) -> Parser char String
+parseChar p =
+ do pos <- getPos
+ x <- parseHTMLChar p
+ let returnChar c = return $ c:[]
+ allowFail $
+ case x of
+ HTMLChar.Char c -> returnChar c
+ HTMLChar.NumericRef num -> returnChar (chr num)
+ HTMLChar.NamedRef name ->
+ maybe
+ (let refName = '&':name++";"
+ in emitWarning pos ("Unknown HTML entity " ++ refName) >>
+ return refName)
+ (returnChar . chr)
+ (lookup name HTMLEntity.htmlEntities)
+
+
+parseHTMLChar :: (Char -> Bool) -> Parser char HTMLChar.T
+parseHTMLChar p =
+ do pos <- getPos
+ c <- satisfy p
+ allowFail $
+ if c=='&'
+ then
+ withDefault
+ (do ent <-
+ mplus
+ (char '#' >>
+ liftM (HTMLChar.NumericRef . read) (many1Satisfy isDigit))
+ (liftM HTMLChar.NamedRef $ many1Satisfy isAlphaNum)
+ char ';'
+ return ent)
+ (emitWarning pos "Ill formed entity" >>
+ return (HTMLChar.Char '&'))
+ else return (HTMLChar.Char c)
+
+
+emitWarningWhen :: Bool -> Position.T -> String -> ParserEmit char ()
+emitWarningWhen cond pos msg =
+ when cond $ emitWarning pos msg
+
+emitWarning :: Position.T -> String -> ParserEmit char ()
+emitWarning pos msg = emitTag pos (Tag.Warning msg)
+
+emitTag :: Position.T -> Tag.T char -> ParserEmit char ()
+emitTag = curry emit
diff --git a/src/Text/HTML/TagSoup/HT/Parser/Combinator.hs b/src/Text/HTML/TagSoup/HT/Parser/Combinator.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Parser/Combinator.hs
@@ -0,0 +1,116 @@
+module Text.HTML.TagSoup.HT.Parser.Combinator (
+ Parser.T, Full, Emitting, Fallible, Plain,
+ char, dropSpaces, eof, getPos,
+ many, many1, many1Satisfy, manySatisfy, readUntil,
+ satisfy, string,
+ emit,
+ eval, write, gets, mfix,
+ withDefault, allowFail, allowEmit,
+ Identity, runIdentity, )
+ where
+
+
+import qualified Text.HTML.TagSoup.HT.Position as Position
+import qualified Text.HTML.TagSoup.HT.Parser.Status as Status
+
+import Text.HTML.TagSoup.HT.Parser.Custom as Parser
+-- import Text.HTML.TagSoup.HT.Parser.MTL as Parser
+
+import Control.Monad (liftM, liftM2, )
+import Control.Monad.Fix (mfix, )
+-- import Control.Monad.Trans (lift, )
+
+import Data.Monoid (Monoid)
+
+import Data.Char (isSpace)
+
+
+
+type Full w = Parser.T [w] Maybe
+type Fallible = Parser.T () Maybe
+type Emitting w = Parser.T [w] Identity
+type Plain = Parser.T () Identity
+
+
+write :: Monad fail =>
+ FilePath -> Parser.T [w] fail () -> String -> fail [w]
+write fileName p =
+ liftM (\ ~(_,_,ws) -> ws) .
+ run p .
+ Status.Cons (Position.initialize fileName)
+
+eval :: Monad fail =>
+ FilePath -> Parser.T [w] fail a -> String -> fail a
+eval fileName p =
+ liftM (\ ~(x,_,_) -> x) .
+ run p .
+ Status.Cons (Position.initialize fileName)
+
+
+
+eof ::
+ (Monoid output, Monad fail) =>
+ Parser.T output fail Bool
+eof = gets (null . Status.source)
+
+getPos ::
+ (Monoid output, Monad fail) =>
+ Parser.T output fail Position.T
+getPos = gets Status.sourcePos
+
+satisfy :: Monoid output => (Char -> Bool) -> Parser.T output Maybe Char
+satisfy p =
+ do c <- nextChar
+ if p c
+ then return c
+ else fail "character not matched"
+
+-- | does never fail
+many :: Monoid output => Parser.T output Maybe a -> Parser.T output Identity [a]
+many x =
+ {- It is better to have 'force' at the place it is,
+ instead of writing it to the recursive call,
+ because 'x' can cause an infinite loop. -}
+ withDefault (many1 x) (return [])
+
+many1 :: Monoid output => Parser.T output Maybe a -> Parser.T output Maybe [a]
+many1 x = liftM2 (:) x (allowFail $ many x)
+
+manySatisfy :: (Char -> Bool) -> Parser.T [w] Identity String
+manySatisfy =
+ allowEmit . many . satisfy
+
+many1Satisfy :: (Char -> Bool) -> Parser.T [w] Maybe String
+many1Satisfy =
+ allowEmit . many1 . satisfy
+
+dropSpaces :: Parser.T [w] Identity ()
+dropSpaces =
+ manySatisfy isSpace >> return ()
+
+
+char :: Monoid output => Char -> Parser.T output Maybe Char
+char c = satisfy (c==)
+
+string :: String -> Parser.T [w] Maybe String
+string = allowEmit . mapM char
+
+
+readUntil :: String -> Parser.T [w] Identity (Bool,String)
+readUntil pattern =
+ let recurse =
+ foldr withDefault (return (False,[])) $
+ liftM (const (True,[])) (mapM char pattern) :
+ (do c <- nextChar
+ ~(found,str) <- allowFail recurse
+ return (found,c:str)) :
+ []
+ in allowEmit recurse
+{-
+runStateT (readUntil "-->") (Position.initialize "input", " other stuff")
+-}
+
+
+
+emit :: Monad fail => w -> Parser.T [w] fail ()
+emit w = tell [w]
diff --git a/src/Text/HTML/TagSoup/HT/Parser/Custom.hs b/src/Text/HTML/TagSoup/HT/Parser/Custom.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Parser/Custom.hs
@@ -0,0 +1,94 @@
+module Text.HTML.TagSoup.HT.Parser.Custom (
+ T,
+ nextChar, withDefault,
+ run, gets, tell, mfix,
+ allowFail, allowEmit,
+ Identity(..),
+ ) where
+
+
+import qualified Text.HTML.TagSoup.HT.Position as Position
+import qualified Text.HTML.TagSoup.HT.Parser.Status as Status
+
+import Control.Monad (MonadPlus, mzero, mplus, liftM, )
+import Control.Monad.Fix (MonadFix, mfix, fix, )
+
+import Data.Monoid (Monoid, mempty, mappend, )
+
+
+newtype Identity a = Identity {runIdentity :: a}
+
+instance Monad Identity where
+ return = Identity
+ m >>= k = k $ runIdentity m
+
+instance MonadFix Identity where
+ mfix f = Identity $ fix (runIdentity . f)
+
+{- |
+This type is essentially equivalent to @RWST () output Status.T fail a@,
+but its monadic combinator @>>=@ is defined more lazily.
+See Parser.MTL.
+-}
+newtype T output fail a =
+ Cons { run :: Status.T -> fail (a, Status.T, output) }
+
+
+instance (Monoid output, Monad fail) => Monad (T output fail) where
+ return a = Cons $ \s -> return (a, s, mempty)
+ m >>= k = Cons $ \s -> do
+ ~(a, s', w) <- run m s
+ ~(b, s'',w') <- run (k a) s'
+ return (b, s'', mappend w w')
+ fail msg = Cons $ \_ -> fail msg
+
+instance (Monoid output, MonadPlus fail) => MonadPlus (T output fail) where
+ mzero = Cons $ \_ -> mzero
+ m `mplus` n = Cons $ \s -> run m s `mplus` run n s
+
+
+{- |
+Cf. 'Control.Monad.State.gets'
+-}
+gets :: (Monoid output, Monad fail) => (Status.T -> a) -> T output fail a
+gets f =
+ Cons $ \ st -> return (f st, st, mempty)
+
+{- |
+Cf. 'Control.Monad.Writer.tell'
+-}
+tell :: (Monad fail) => output -> T output fail ()
+tell ws = Cons $ \ st -> return ((),st,ws)
+
+
+instance (Monoid output, MonadFix fail) => MonadFix (T output fail) where
+ mfix f = Cons $ \ st -> mfix $ \ ~(a, _, _) -> run (f a) st
+
+
+
+nextChar :: (Monoid output, MonadPlus fail) => T output fail Char
+nextChar =
+ Cons $ \ (Status.Cons pos str) ->
+ case str of
+ [] -> mzero
+ (c:cs) -> return (c, Status.Cons (Position.updateOnChar c pos) cs, mempty)
+
+
+-- this replaces 'ignoreEmit'
+allowEmit ::
+ Monad fail =>
+ T () fail a -> T [w] fail a
+allowEmit p =
+ Cons $ liftM (\ ~(a,s,_) -> (a,s,mempty)) . run p
+
+-- this replaces 'force'
+allowFail :: T output Identity a -> T output Maybe a
+allowFail p =
+ Cons $ return . runIdentity . run p
+
+withDefault ::
+ T output Maybe a ->
+ T output Identity a ->
+ T output Identity a
+withDefault p q =
+ Cons $ \s -> maybe (run q s) Identity (run p s)
diff --git a/src/Text/HTML/TagSoup/HT/Parser/MTL.hs b/src/Text/HTML/TagSoup/HT/Parser/MTL.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Parser/MTL.hs
@@ -0,0 +1,80 @@
+module Text.HTML.TagSoup.HT.Parser.MTL (
+ T,
+ nextChar, withDefault,
+ run, gets, tell, mfix,
+ allowFail, allowEmit,
+ module Control.Monad.Identity,
+ ) where
+
+
+import qualified Text.HTML.TagSoup.HT.Position as Position
+import qualified Text.HTML.TagSoup.HT.Parser.Status as Status
+import Text.HTML.TagSoup.HT.Utility (mapSnd, )
+
+import Control.Monad.Writer (WriterT(..), mapWriterT, tell, lift, liftM, )
+import Control.Monad.State (StateT(..), mapStateT, gets, )
+import Control.Monad.Fix (mfix)
+import Control.Monad.Identity (Identity(..), )
+
+import Data.Monoid (Monoid)
+
+
+{-
+We need to declare whether parts of the parser
+can or cannot fail and can or cannot emit something through the writer.
+This way we can get rid of the former functions 'force' and 'ignoreEmit'
+which generate errors at run-time
+if the assumptions of non-failing or non-emission were wrong.
+Now, since we declare this properties in types,
+runtime errors cannot happen.
+-}
+type T output fail = WriterT output (StateT Status.T fail)
+
+
+run :: Monad fail =>
+ T output fail a -> Status.T -> fail (a, Status.T, output)
+run p =
+ liftM (\((a,w),st) -> (a,st,w)) . runStateT (runWriterT p)
+
+
+nextChar :: Monoid output => T output Maybe Char
+nextChar =
+ lift $
+ StateT $ \ (Status.Cons pos str) ->
+ case str of
+ [] -> Nothing
+ (c:cs) -> Just (c, Status.Cons (Position.updateOnChar c pos) cs)
+
+
+
+-- this replaces 'ignoreEmit'
+allowEmit ::
+ Monad fail =>
+ T () fail a -> T [w] fail a
+allowEmit =
+ mapWriterT (fmap (mapSnd (const [])))
+
+allowFail' ::
+ StateT s Identity a -> StateT s Maybe a
+allowFail' =
+ mapStateT (Just . runIdentity)
+
+-- this replaces 'force'
+allowFail :: T output Identity a -> T output Maybe a
+allowFail =
+ mapWriterT allowFail'
+
+withDefault' ::
+ StateT s Maybe a ->
+ StateT s Identity a ->
+ StateT s Identity a
+withDefault' p q =
+ StateT $ \st ->
+ maybe (runStateT q st) Identity (runStateT p st)
+
+withDefault ::
+ T output Maybe a ->
+ T output Identity a ->
+ T output Identity a
+withDefault p q =
+ WriterT $ withDefault' (runWriterT p) (runWriterT q)
diff --git a/src/Text/HTML/TagSoup/HT/Parser/Status.hs b/src/Text/HTML/TagSoup/HT/Parser/Status.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Parser/Status.hs
@@ -0,0 +1,10 @@
+module Text.HTML.TagSoup.HT.Parser.Status where
+
+import qualified Text.HTML.TagSoup.HT.Position as Position
+
+data T =
+ Cons {
+ sourcePos :: Position.T,
+ source :: String
+ }
+ deriving Show
diff --git a/src/Text/HTML/TagSoup/HT/ParserNM.hs b/src/Text/HTML/TagSoup/HT/ParserNM.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/ParserNM.hs
@@ -0,0 +1,37 @@
+{-|
+This parser emits the data structure of the original tagsoup package by Neil Mitchell.
+-}
+module Text.HTML.TagSoup.HT.ParserNM (
+ runSoup,
+ ) where
+
+import qualified Text.HTML.TagSoup as TagSoup
+import qualified Text.HTML.TagSoup.HT.Tag as Custom
+import qualified Text.HTML.TagSoup.HT.PositionTag as PosTag
+import qualified Text.HTML.TagSoup.HT.Parser as Parser
+import qualified Text.HTML.TagSoup.HT.Position as Position
+
+import Data.Accessor.Basic ((^.), )
+
+
+runSoup :: String -> [TagSoup.Tag]
+runSoup =
+ concatMap convertTag . Parser.runSoupWithPositions
+
+convertTag :: PosTag.T Char -> [TagSoup.Tag]
+convertTag (pos,tag) =
+ TagSoup.TagPosition (pos ^. Position.row) (pos ^. Position.column) :
+ (case tag of
+ Custom.Open name attrs -> TagSoup.TagOpen name attrs
+ Custom.Close name -> TagSoup.TagClose name
+ Custom.Text text -> TagSoup.TagText text
+ Custom.Comment text -> TagSoup.TagComment text
+ Custom.Special name content
+ -> TagSoup.TagOpen ('!':name) [("",content)]
+ Custom.Processing name p
+ -> TagSoup.TagOpen ('?':name) $
+ case p of
+ Custom.KnownProcessing attrs -> attrs
+ Custom.UnknownProcessing content -> [("",content)]
+ Custom.Warning text -> TagSoup.TagWarning text) :
+ []
diff --git a/src/Text/HTML/TagSoup/HT/Position.hs b/src/Text/HTML/TagSoup/HT/Position.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Position.hs
@@ -0,0 +1,93 @@
+{- |
+Module : Text.HTML.TagSoup.HT.Position
+
+Maintainer : tagsoup@henning-thielemann.de
+Stability : provisional
+Portability : portable
+
+Position in a file.
+
+Cf. to Text.ParserCombinators.Parsec.Pos
+-}
+
+module Text.HTML.TagSoup.HT.Position (
+ T, FileName, Row, Column,
+ new, initialize,
+ row, column, fileName,
+ updateOnChar, updateOnString,
+ toReportText,
+ ) where
+
+import qualified Data.Accessor.Basic as Accessor
+-- import Data.Accessor.Basic ((^=), )
+
+import Data.List (foldl')
+
+
+type FileName = String
+type Row = Int
+type Column = Int
+
+{- |
+Position in a file consisting of file name, row and column coordinates.
+Upper left is (0,0), but show routines can display this with different offsets.
+-}
+data T =
+ Cons {
+ fileName_ :: FileName,
+ row_ :: !Row,
+ column_ :: !Column
+ } deriving (Eq,Ord)
+
+
+new :: FileName -> Row -> Column -> T
+new = Cons
+
+initialize :: FileName -> T
+initialize fn = new fn 0 0
+
+
+-- * access functions
+
+fileName :: Accessor.T T FileName
+fileName = Accessor.fromSetGet (\fn p -> p{fileName_ = fn}) fileName_
+
+row :: Accessor.T T Row
+row = Accessor.fromSetGet (\n p -> p{row_ = n}) row_
+
+column :: Accessor.T T Column
+column = Accessor.fromSetGet (\n p -> p{column_ = n}) column_
+
+
+-- * update position according to read characters
+
+updateOnString :: T -> String -> T
+updateOnString pos string =
+ foldl' (flip updateOnChar) pos string
+
+updateOnChar :: Char -> T -> T
+updateOnChar char (Cons name r c) =
+ let (newRow, newColumn) =
+ case char of
+ '\n' -> (succ r, 0)
+ '\t' -> (r, c + 8 - mod c 8)
+ _ -> (r, succ c)
+ in Cons name newRow newColumn
+-- in (row ^= newRow) $ (column ^= newColumn) $ pos
+
+
+-- * update position according to read characters
+
+{- |
+Convert the file position to a format
+that development environments can understand.
+-}
+toReportText :: T -> String
+toReportText (Cons name r c) =
+ concatMap (++":") [name, show (r+1), show (c+1)]
+
+instance Show T where
+ showsPrec p (Cons name r c) =
+ showParen (p >= 10)
+ (showString $ unwords $
+ "Position.new" : show name : show r : show c : [])
diff --git a/src/Text/HTML/TagSoup/HT/PositionTag.hs b/src/Text/HTML/TagSoup/HT/PositionTag.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/PositionTag.hs
@@ -0,0 +1,25 @@
+module Text.HTML.TagSoup.HT.PositionTag where
+
+import qualified Text.HTML.TagSoup.HT.Tag as Tag
+import qualified Text.HTML.TagSoup.HT.Position as Position
+
+import Text.HTML.TagSoup.HT.Utility (mapSnd, )
+
+
+type T char = (Position.T, Tag.T char)
+
+lift :: (Tag.T char0 -> Tag.T char1) -> (T char0 -> T char1)
+lift = mapSnd
+
+canonicalizeSoup :: [T char] -> [T char]
+canonicalizeSoup =
+ map canonicalize
+
+{- |
+See 'Tag.canonicalize'.
+-}
+canonicalize :: T char -> T char
+canonicalize = lift Tag.canonicalize
+
+textFromCData :: T Char -> T Char
+textFromCData = lift Tag.textFromCData
diff --git a/src/Text/HTML/TagSoup/HT/Tag.hs b/src/Text/HTML/TagSoup/HT/Tag.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Tag.hs
@@ -0,0 +1,134 @@
+module Text.HTML.TagSoup.HT.Tag where
+
+import Data.Char (toLower, toUpper, )
+import Data.Maybe (mapMaybe, )
+
+
+-- * type definitions
+
+{- | An HTML attribute @id=\"name\"@ generates @(\"id\",\"name\")@ -}
+type Attribute char = (String,[char])
+
+{- |
+An HTML element, a document is @[T]@.
+There is no requirement for 'Open' and 'Close' to match.
+
+The type parameter @char@ lets you choose between
+@Char@ for interpreted HTML entity references and
+@HTMLChar.T@ for uninterpreted HTML entity.
+You will most oftenly want plain @Char@,
+since @HTMLChar.T@ is only necessary if you want to know,
+whether a non-ASCII character was encoded as HTML entity
+or as non-ASCII Unicode character.
+-}
+data T char =
+ Open String [Attribute char]
+ -- ^ An open tag with 'Attribute's in their original order.
+ | Close String
+ -- ^ A closing tag
+ | Text [char]
+ -- ^ A text node, guaranteed not to be the empty string
+ | Comment String
+ -- ^ A comment
+ | Special String String
+ -- ^ A tag like @\@
+ | Processing String (Processing char)
+ -- ^ A tag like @\@
+ | Warning String
+ -- ^ Mark a syntax error in the input file
+ deriving (Show, Eq, Ord)
+
+data Processing char =
+ KnownProcessing [Attribute char]
+ | UnknownProcessing String
+ deriving (Show, Eq, Ord)
+
+
+-- * check for certain tag types
+
+-- | Test if a 'T' is a 'Open'
+isOpen :: T char -> Bool
+isOpen tag = case tag of (Open {}) -> True; _ -> False
+
+maybeOpen :: T char -> Maybe (String, [Attribute char])
+maybeOpen tag = case tag of Open name attrs -> Just (name, attrs); _ -> Nothing
+
+
+-- | Test if a 'T' is a 'Close'
+isClose :: T char -> Bool
+isClose tag = case tag of (Close {}) -> True; _ -> False
+
+maybeClose :: T char -> Maybe String
+maybeClose tag = case tag of Close x -> Just x; _ -> Nothing
+
+
+-- | Test if a 'T' is a 'Text'
+isText :: T char -> Bool
+isText tag = case tag of (Text {}) -> True; _ -> False
+
+-- | Extract the string from within 'Text', otherwise 'Nothing'
+maybeText :: T char -> Maybe [char]
+maybeText tag = case tag of Text x -> Just x; _ -> Nothing
+-- maybeText tag = do Text x <- Just tag; return x
+
+-- | Extract all text content from tags (similar to Verbatim found in HaXml)
+innerText :: [T char] -> [char]
+innerText = concat . mapMaybe maybeText
+
+
+isComment :: T char -> Bool
+isComment tag = case tag of (Comment {}) -> True; _ -> False
+
+maybeComment :: T char -> Maybe String
+maybeComment tag = case tag of Comment x -> Just x; _ -> Nothing
+
+
+isSpecial :: T char -> Bool
+isSpecial tag = case tag of (Special {}) -> True; _ -> False
+
+maybeSpecial :: T char -> Maybe (String, String)
+maybeSpecial tag = case tag of Special name content -> Just (name, content); _ -> Nothing
+
+
+isProcessing :: T char -> Bool
+isProcessing tag = case tag of (Processing {}) -> True; _ -> False
+
+maybeProcessing :: T char -> Maybe (String, Processing char)
+maybeProcessing tag = case tag of Processing target instr -> Just (target, instr); _ -> Nothing
+
+
+isWarning :: T char -> Bool
+isWarning tag = case tag of (Warning {}) -> True; _ -> False
+
+maybeWarning :: T char -> Maybe String
+maybeWarning tag = case tag of Warning x -> Just x; _ -> Nothing
+-- maybeWarning tag = do Warning x <- Just tag; return x
+
+
+
+-- * tag processing
+
+canonicalizeSoup :: [T char] -> [T char]
+canonicalizeSoup =
+ map canonicalize
+
+{- |
+Turns all tag names to lower case and
+converts DOCTYPE to upper case.
+-}
+canonicalize :: T char -> T char
+canonicalize t =
+ case t of
+ Open name attrs -> Open (map toLower name) attrs
+ Close name -> Close (map toLower name)
+ Special name info -> Special (map toUpper name) info
+ _ -> t
+
+{- |
+Replace CDATA sections by plain text.
+-}
+textFromCData :: T Char -> T Char
+textFromCData t =
+ case t of
+ Special "[CDATA[" text -> Text text
+ _ -> t
diff --git a/src/Text/HTML/TagSoup/HT/Test.hs b/src/Text/HTML/TagSoup/HT/Test.hs
new file mode 100644
--- /dev/null
+++ b/src/Text/HTML/TagSoup/HT/Test.hs
@@ -0,0 +1,103 @@
+module Text.HTML.TagSoup.HT.Test (
+ -- * Tests on laziness
+ laziness, lazyTags, lazyWarnings,
+
+ -- * QuickCheck properties
+ propSections, propPartitions,
+ ) where
+
+import qualified Text.HTML.TagSoup.HT.Tag as Tag
+import qualified Text.HTML.TagSoup.HT.Parser as Parser
+import qualified Text.HTML.TagSoup as TagSoupNM
+
+{-
+*Text.HTML.TagSoup.HT> mapM print $ runSoup $ "