multiwalk (empty) → 0.3.0.1
raw patch · 9 files changed
+1707/−0 lines, 9 filesdep +basedep +bytestringdep +commonmark
Dependencies added: base, bytestring, commonmark, commonmark-pandoc, deepseq, multiwalk, pandoc-types, tasty, tasty-bench, tasty-hunit, text, transformers
Files
- CHANGELOG.md +14/−0
- LICENSE +674/−0
- README.md +50/−0
- multiwalk.cabal +159/−0
- src/Control/MultiWalk.hs +239/−0
- src/Control/MultiWalk/Contains.hs +149/−0
- src/Control/MultiWalk/HasSub.hs +197/−0
- test/Benchmark.hs +151/−0
- test/Main.hs +74/−0
+ CHANGELOG.md view
@@ -0,0 +1,14 @@+# Revision history for multiwalk++## 0.3.0.1 -- 2023-07-17+* Improve haddocks.++## 0.3.0.0 -- 2023-07-08+* Add `Spec` kind, in particular `SpecSelf` for matching the type itself.++## 0.2.0.0 -- 2023-07-07+* Change order of type arguments for `walkM`++## 0.1.0.0 -- 2023-04-05++* First version. Released on an unsuspecting world.
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ 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.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ 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 <http://www.gnu.org/licenses/>.++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:++ <program> Copyright (C) <year> <name of author>+ 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+<http://www.gnu.org/licenses/>.++ 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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ README.md view
@@ -0,0 +1,50 @@+# MultiWalk++This library provides functionality for traversing data types recursively,+acting on multiple types during the same traversal. In spirit, it is similar to+the `Walk` type class from `Pandoc.Walk`, but generalizes it by allowing+multiple types to be targeted by the traversal. Also, by default it only+requires an `Applicative` constraint on the action, making it suitable for+situations where you don't have a `Monad` (for instance, traversing within a+composition of monads).++Say, for instance, you want to query all code snippets from a Pandoc document,+including both `Inline` and `Block` ones, such that the list of results is *in+the same order* as they appear in the document. There is no way to do this with+Pandoc's `Walk` type class, because it only supports querying or walking with+one type at once. With MultiWalk you are able to do this with a single query+function that targets both types, and it'll look something like this:++```haskell+multi :: Block -> [Text]+multi = buildMultiQ @PTag $ \sub list ->+ list ?> blks sub+ ?> inls sub+ where+ blks _ (CodeBlock _ c) = [c]+ blks f x = f x+ inls _ (Code _ c) = [c]+ inls f x = f x+```++(note, however, that this library does not ship with default instances for+Pandoc, so you will have to define them yourself. You can find a basic Pandoc+instance for reference, and the function above, in `Benchmark.hs` inside the+test directory.)++Another use case is when you want to modify a data type, perhaps targeting+multiple subtypes, and you want to do that inside a functor that is+`Applicative` but not a `Monad`. Such functors may sound unusual, but one of the+interesting places where they appear are in composition of monads, which need+not be a monad itself. ++You can find a use of such monad compositions in my other library+[here](https://github.com/lucasvreis/org-mode-hs/blob/main/org-exporters/src/Org/Exporters/Processing/InternalLinks.hs).+It's used for resolving cross-references inside documents inside the functor+`Compose M F`, where `M` is a state monad which holds the links it has found so+far, and `F` is a reader which receives the _final, future state_ (that will+only be ready _at the end of the computation_). In this way I can walk across+the document only once, registering and applying cross references at the same+time. Note that this is composition is semantically different from using monad+transformers, because they would require the reader state to be supplied before+the final state is available.
+ multiwalk.cabal view
@@ -0,0 +1,159 @@+cabal-version: 3.0++-- The cabal-version field refers to the version of the .cabal specification,+-- and can be different from the cabal-install (the tool) version and the+-- Cabal (the library) version you are using. As such, the Cabal (the library)+-- version used must be equal or greater than the version stated in this field.+-- Starting from the specification version 2.2, the cabal-version field must be+-- the first thing in the cabal file.++-- Initial package description 'multiwalk' generated by+-- 'cabal init'. For further documentation, see:+-- http://haskell.org/cabal/users-guide/+--+-- The name of the package.+name: multiwalk++-- The package version.+-- See the Haskell package versioning policy (PVP) for standards+-- guiding when and how versions should be incremented.+-- https://pvp.haskell.org+-- PVP summary: +-+------- breaking API changes+-- | | +----- non-breaking API additions+-- | | | +--- code changes with no API change+version: 0.3.0.1++-- A short (one-line) description of the package.+synopsis:+ Traverse data types via generics, acting on multiple types simultaneously.++-- A longer description of the package.+description:+ This library provides functionality for traversing data types recursively,+ acting on multiple types during the same traversal. In spirit, it is similar to+ the Walk type class from Pandoc.Walk, but generalizes it by allowing+ multiple types to be targeted by the traversal. In general, it only+ requires an Applicative constraint on the action, making it suitable for+ situations where you don't have a Monad.++-- The license under which the package is released.+license: GPL-3.0-or-later++-- The file containing the license text.+license-file: LICENSE++-- The package author(s).+author: Lucas V. R.++-- An email address to which users can send suggestions, bug reports, and patches.+maintainer: @lucasvr:matrix.org++-- A copyright notice.+-- copyright:+category: Control+build-type: Simple++-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README.+extra-doc-files:+ CHANGELOG.md+ README.md++-- Extra source files to be distributed with the package, such as examples, or a tutorial module.+-- extra-source-files:++source-repository head+ type: git+ location: https://github.com/lucasvreis/multiwalk++common common-options+ ghc-options: -Wall -fprint-potential-instances+ default-extensions:+ AllowAmbiguousTypes+ ConstraintKinds+ DataKinds+ DefaultSignatures+ DeriveGeneric+ FlexibleContexts+ FlexibleInstances+ KindSignatures+ LambdaCase+ MultiParamTypeClasses+ ScopedTypeVariables+ TypeApplications+ TypeFamilies+ TypeOperators+ UndecidableInstances++library+ import: common-options++ -- Modules exported by the library.+ exposed-modules:+ Control.MultiWalk+ Control.MultiWalk.Contains+ Control.MultiWalk.HasSub++ -- Modules included in this library but not exported.+ -- other-modules:++ -- LANGUAGE extensions used by modules in this package.+ -- other-extensions:++ -- Other library packages from which modules are imported.+ build-depends: base >=4.16 && <4.19++ -- Directories containing source files.+ hs-source-dirs: src++ -- Base language which the package is written in.+ default-language: Haskell2010++test-suite multiwalk-test+ import: common-options++ -- Base language which the package is written in.+ default-language: Haskell2010++ -- Modules included in this executable, other than Main.+ -- other-modules:++ -- LANGUAGE extensions used by modules in this package.+ -- other-extensions:++ -- The interface type and version of the test suite.+ type: exitcode-stdio-1.0++ -- Directories containing source files.+ hs-source-dirs: test++ -- The entrypoint to the test suite.+ main-is: Main.hs++ -- Test dependencies.+ build-depends:+ , base+ , multiwalk+ , tasty >=1.4.3 && <1.5+ , tasty-hunit >=0.10.0 && <0.11++benchmark bench+ import: common-options+ hs-source-dirs: test+ main-is: Benchmark.hs+ type: exitcode-stdio-1.0+ build-depends:+ , base+ , bytestring >=0.11.4 && <0.12+ , commonmark >=0.2.2 && <0.3+ , commonmark-pandoc >=0.2.1 && <0.3+ , deepseq >=1.4.6 && <1.5+ , multiwalk+ , pandoc-types >=1.23 && <1.24+ , tasty+ , tasty-bench >=0.3.3 && <0.4+ , tasty-hunit+ , text >=1.2.5 && <2.1+ , transformers >=0.5.6 && <0.7++ ghc-options: "-with-rtsopts=-A32m --nonmoving-gc"+ default-language: Haskell2010
+ src/Control/MultiWalk.hs view
@@ -0,0 +1,239 @@+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE UndecidableSuperClasses #-}++{- | This module provides functionality for recursively traversing and querying+ along multiple types.+-}+module Control.MultiWalk (+ MultiTag (..),+ MultiSub (..),+ query,+ walk,+ walkM,+ Walk,+ Query,+ walkSub,+ querySub,+ buildMultiW,+ buildMultiQ,+ (.>),+ (?>),+ ToSpec,+ ToSpecSel,+ Spec (..),+ SelSpec (..),+ Trav,+ MatchWith,+ Under,+ MultiWalk,+ FList (..),+ QList (..),+ BuildF (..),+ BuildQ (..),+)+where++import Control.Monad ((>=>))+import Control.MultiWalk.Contains+import Data.Functor.Identity (Identity (Identity, runIdentity))+import Data.Kind (Type)++{- | You should instantiate 'MultiTag' to a tag associated to the structure you+ are working with. The tag is mostly there to prevent orphan instances, since+ people are often working with structures from other packages (Pandoc AST,+ HTML, etc.)+-}+class+ ( BuildF (MultiWalk' tag) (MultiTypes tag)+ , BuildQ (MultiWalk' tag) (MultiTypes tag)+ ) =>+ MultiTag tag+ where+ -- | The types that will be used in the walks and queries; every type listed here+ -- should have a 'MultiSub' instance. (The compiler will complain about this.)+ type MultiTypes tag :: [Type]++class MultiSub tag t where+ -- | A list of substructure specifications for types that are substructures to+ -- this type; all types listed here should also be listed in the corresponding+ -- 'MultiTypes', but you can omit types from there that should not be regarded+ -- as subtypes.+ --+ -- Substructure specifications are special datakinds that you can generate+ -- using 'ToSpec' and 'ToSpecSel', and the combinators (eg. 'Under',+ -- 'MatchWith' and 'Trav').+ type SubTypes tag t :: Spec++ -- | If you want to write HasSub instances by hand (not that easy), you can+ -- put the associated HasSub tag here. Defaults to 'GSubTag' (which derives+ -- 'Generic' instances).+ type HasSubTag tag t :: Type++ type HasSubTag tag t = GSubTag++type MultiWalk tag t =+ ( AllMods (TContains (MultiTypes tag)) (SubTypes tag t)+ , QContains (MultiTypes tag) t+ , FContains (MultiTypes tag) t+ , HasSub (HasSubTag tag t) (SubTypes tag t) t+ )++class (MultiWalk tag t) => MultiWalk' tag t++instance (MultiWalk tag t) => MultiWalk' tag t++-- | Query (only) substructures by applying functions from 'QList'.+querySub :: forall tag t m. (Monoid m, MultiWalk tag t) => QList m (MultiTypes tag) -> t -> m+querySub = getSubWithQList @(HasSubTag tag t) @(SubTypes tag t)++-- | Modify (only) substructures by applying functions from 'FList'.+walkSub :: forall tag t m. (Applicative m, MultiWalk tag t) => FList m (MultiTypes tag) -> t -> m t+walkSub = modSubWithFList @(HasSubTag tag t) @(SubTypes tag t)++-- | Query a structure with a single query function (just like Pandoc.Walk).+query ::+ forall tag m t a.+ ( MultiTag tag+ , MultiWalk tag a+ , MultiWalk tag t+ , Monoid m+ ) =>+ (t -> m) ->+ a ->+ m+query f =+ buildMultiQ @tag $ \go l ->+ l ?> \x -> f x <> go x++-- | Modify a structure by walking with a single function (just like Pandoc.Walk).+walk ::+ forall tag t c.+ (MultiTag tag, MultiWalk tag c, MultiWalk tag t) =>+ (t -> t) ->+ c ->+ c+walk f = runIdentity . walkM @tag (Identity . f)++-- | Modify a structure by walking with a single function (just like Pandoc.Walk).+walkM ::+ forall tag t a m.+ ( Monad m+ , MultiTag tag+ , MultiWalk tag a+ , MultiWalk tag t+ ) =>+ (t -> m t) ->+ a ->+ m a+walkM f =+ buildMultiW @tag $ \go l ->+ l .> (f >=> go)++type Query tag m = forall t. MultiWalk tag t => t -> m++{- | Most general way to create a query. Create a query with multiple functions,+ targeting multiple types.++ First argument is a function that takes a query, an empty list of queries and+ should return a list of queries populated with the multiple query functions.++ By "tying a knot", the first argument you are supplied with is almost the+ result of 'buildMultiQ' itself, the only difference being that it only+ queries /substructures/ of the type. It's a responsability of each function+ in the 'QList' to apply this function to its argument in any desired way, as+ to continue recursing down the "type tree".++ You can add functions to the empty 'QList' via '?>'.++ > multi :: Block -> [Text]+ > multi = buildMultiQ @PTag $ \sub list ->+ > list ?> blks sub+ > ?> inls sub+ > where+ > blks _ (CodeBlock _ c) = [c]+ > blks f x = f x+ > inls _ (Code _ c) = [c]+ > inls f x = f x+-}+buildMultiQ ::+ forall tag m.+ (MultiTag tag, Monoid m) =>+ ( Query tag m ->+ QList m (MultiTypes tag) ->+ -- \^ Empty query that you should modify.+ QList m (MultiTypes tag)+ ) ->+ Query tag m+buildMultiQ f = qGet qlist+ where+ qlist :: QList m (MultiTypes tag)+ qlist = f go $ buildQ @(MultiWalk' tag) go+ go :: forall s. MultiWalk tag s => s -> m+ go = querySub @tag qlist++type Walk tag m = forall t. MultiWalk tag t => t -> m t++{- | Most general way to create a walk. Create a walk with multiple functions,+ targeting multiple types.++ First argument is a function that takes a walk, an empty list of functions and+ should return a list of functions populated with the multiple walk functions.++ By "tying a knot", the first argument you are supplied with is almost the+ result of 'buildMultiW' itself, the only difference being that it only walks+ /substructures/ of the type. It's a responsability of each function in the+ 'FList' to apply this function to its argument in any desired way, as to+ continue recursing down the "type tree".++ You can add functions to the empty 'FList' via '.>'.++ > multi :: Applicative m => Block -> m Block+ > multi = buildMultiW @PTag $ \sub list ->+ > list .> blks sub+ > .> inls sub+ > where+ > blks _ (CodeBlock _ c) = Para [Str c]+ > blks f x = f x+ > inls _ (Code _ c) = Str c+ > inls f x = f x+-}+buildMultiW ::+ forall tag m.+ (MultiTag tag, Applicative m) =>+ ( Walk tag m ->+ FList m (MultiTypes tag) ->+ FList m (MultiTypes tag)+ ) ->+ Walk tag m+buildMultiW f = fGet flist+ where+ flist :: FList m (MultiTypes tag)+ flist = f go $ buildF @(MultiWalk' tag) go+ go :: forall s. MultiWalk tag s => s -> m s+ go = walkSub @tag flist++class All c ls => BuildQ c ls where+ buildQ :: (forall t. c t => t -> m) -> QList m ls++instance BuildQ c '[] where+ buildQ _ = QNil++instance (BuildQ c ls, c l) => BuildQ c (l : ls) where+ buildQ f = f :?: buildQ @c @ls f++class All c ls => BuildF c ls where+ buildF :: (forall t. c t => t -> m t) -> FList m ls++instance BuildF c '[] where+ buildF _ = FNil++instance (BuildF c ls, c l) => BuildF c (l : ls) where+ buildF f = f :.: buildF @c @ls f++-- | Add a function to a 'QList'.+(?>) :: QContains ls t => QList m ls -> (t -> m) -> QList m ls+(?>) = qSet++-- | Add a function to a 'FList'.+(.>) :: FContains ls t => FList m ls -> (t -> m t) -> FList m ls+(.>) = fSet
+ src/Control/MultiWalk/Contains.hs view
@@ -0,0 +1,149 @@+{-# LANGUAGE GADTs #-}++{- | This module contains the instances and definitions+ supporting 'Control.Multiwalk' module, along with+ the combinators for writing 'MultiSub' instances.+-}+module Control.MultiWalk.Contains (+ module Control.MultiWalk.HasSub,+ module Control.MultiWalk.Contains,+) where++import Control.MultiWalk.HasSub hiding (Carrier, HasSub (..), ToSpec, ToSpecSel)+import qualified Control.MultiWalk.HasSub as HS+import Data.Coerce (Coercible, coerce)+import Data.Kind (Type)+import Data.Proxy (Proxy (..))++data MWCTag++type family ContainsCarrier (a :: Type) :: Type where+ ContainsCarrier (Under b s a) = b+ ContainsCarrier (MatchWith s a) = s+ ContainsCarrier (Trav f a) = f (Carrier a)+ ContainsCarrier a = a++type instance HS.Carrier MWCTag a = ContainsCarrier a+type instance HS.Carrier MWCTag a = ContainsCarrier a++type HasSub tag ls t = HS.HasSub MWCTag tag ls t+type Carrier a = HS.Carrier MWCTag a+type ToSpec a = HS.ToSpec MWCTag a+type ToSpecSel s a = HS.ToSpecSel MWCTag s a++-- | Modify (only) substructures by applying functions from 'FList'.+modSubWithFList ::+ forall tag ls t fs m.+ (HasSub tag ls t, Applicative m, AllMods (TContains fs) ls) =>+ FList m fs ->+ t ->+ m t+modSubWithFList fs =+ HS.modSub @MWCTag @tag @ls @t (Proxy @(TContains fs)) (\(_ :: Proxy s) -> tGetW @fs @s fs)++-- | Query (only) substructures by applying functions from 'QList'.+getSubWithQList ::+ forall tag ls t fs m.+ (HasSub tag ls t, Monoid m, AllMods (TContains fs) ls) =>+ QList m fs ->+ t ->+ m+getSubWithQList fs =+ HS.getSub @MWCTag @tag @ls @t (Proxy @(TContains fs)) (\(_ :: Proxy s) -> tGetQ @fs @s fs)++infixr 8 :?:++-- | Heterogeneous list of queries+data QList :: Type -> [Type] -> Type where+ QNil :: QList m '[]+ (:?:) :: (x -> m) -> QList m xs -> QList m (x : xs)++class QContains (l :: [Type]) (t :: Type) where+ qGet :: QList m l -> t -> m+ qSet :: QList m l -> (t -> m) -> QList m l++instance {-# OVERLAPS #-} QContains (t : xs) t where+ qGet (f :?: _) = f+ qSet (_ :?: y) z = z :?: y++instance QContains xs t => QContains (x : xs) t where+ qGet (_ :?: y) = qGet y+ qSet (x :?: y) z = x :?: qSet y z++infixr 8 :.:++-- | Heterogeneous list of monadic-valued functions+data FList :: (Type -> Type) -> [Type] -> Type where+ FNil :: FList m '[]+ (:.:) :: (x -> m x) -> FList m xs -> FList m (x : xs)++class FContains (l :: [Type]) (t :: Type) where+ fGet :: FList m l -> t -> m t+ fSet :: FList m l -> (t -> m t) -> FList m l++instance {-# OVERLAPS #-} FContains (t : xs) t where+ fGet (f :.: _) = f+ fSet (_ :.: y) z = z :.: y++instance FContains xs t => FContains (x : xs) t where+ fGet (_ :.: y) = fGet y+ fSet (x :.: y) z = x :.: fSet y z++{- | Auxiliary class that keeps track of how retrieve queries and walks from their+ lists and apply them according to the combinators.+-}+class TContains (fs :: [Type]) (t :: Type) where+ tGetW :: Applicative m => FList m fs -> ContainsCarrier t -> m (ContainsCarrier t)+ tGetQ :: Monoid m => QList m fs -> ContainsCarrier t -> m++instance+ {-# OVERLAPPABLE #-}+ ( FContains fs (Carrier a)+ , QContains fs (Carrier a)+ ) =>+ TContains fs a+ where+ tGetW = fGet+ tGetQ = qGet++-- Useful combinators++-- | Use this for matching with a type inside a traversable functor.+data Trav (k :: Type -> Type) (a :: Type)++instance+ ( Traversable f+ , TContains fs a+ ) =>+ TContains fs (Trav f a)+ where+ tGetW = traverse . tGetW @fs @a+ tGetQ = foldMap . tGetQ @fs @a++{- | Use this for matching with another type that is coercible to the type you+ want.+-}+data MatchWith (s :: Type) (a :: Type)++instance+ ( TContains fs a+ , Coercible (Carrier a) s+ ) =>+ TContains fs (MatchWith s a)+ where+ tGetW fs = fmap coerce . tGetW @fs @a fs . coerce+ tGetQ fs = tGetQ @fs @a fs . coerce++{- | Use this for matching a subcomponent nested inside another type. Useful if+ you don't want to add the middle type to the list of walkable types.+-}+data Under (b :: Type) (s :: SelSpec) (a :: Type)++instance+ ( TContains fs a+ , HasSub GSubTag ('SpecList '[ 'SubSpec s a (Carrier a)]) b+ ) =>+ TContains fs (Under b s a)+ where+ tGetW = modSubWithFList @GSubTag @('SpecList '[ 'SubSpec s a (Carrier a)]) @b @fs+ tGetQ = getSubWithQList @GSubTag @('SpecList '[ 'SubSpec s a (Carrier a)]) @b @fs
+ src/Control/MultiWalk/HasSub.hs view
@@ -0,0 +1,197 @@+{-# LANGUAGE PolyKinds #-}+{-# LANGUAGE RankNTypes #-}++{- | This module is the heart of multiwalk, providing generic instances for+ modifying and querying data types.+-}+module Control.MultiWalk.HasSub (+ HasSub (..),+ Spec (..),+ SubSpec (..),+ SelSpec (..),+ Carrier,+ ToSpec,+ ToSpecSel,+ All,+ AllMods,+ GSubTag,+) where++import Control.Applicative (liftA2)+import Data.Kind (Constraint, Type)+import Data.Proxy (Proxy (..))+import GHC.Generics+import GHC.TypeLits++data Spec+ = SpecList [SubSpec]+ | SpecLeaf+ | -- | Modifiers (used for customizing constraints)+ SpecSelf+ Type++data SubSpec+ = SubSpec+ SelSpec+ -- ^ Constructor and field selectors+ Type+ -- ^ Modifiers (used for customizing constraints)+ Type+ -- ^ Carrier type, should be equal to Carrier of type above (to be aligned+ -- with the target's generic subtypes)++type family Carrier ctag a :: Type++data SelSpec+ = NoSel+ | ConsSel Symbol+ | FieldSel Symbol+ | ConsFieldSel Symbol Symbol++type ToSpec tag (a :: Type) = 'SubSpec 'NoSel a (Carrier tag a)+type ToSpecSel tag (s :: SelSpec) (a :: Type) = 'SubSpec s a (Carrier tag a)++class HasSub ctag tag (ls :: Spec) t where+ modSub ::+ forall c m.+ (Applicative m, AllMods c ls) =>+ Proxy c ->+ (forall s. c s => Proxy s -> Carrier ctag s -> m (Carrier ctag s)) ->+ t ->+ m t+ getSub ::+ forall c m.+ (Monoid m, AllMods c ls) =>+ Proxy c ->+ (forall s. c s => Proxy s -> Carrier ctag s -> m) ->+ t ->+ m++instance (Carrier tag s ~ t) => HasSub tag ctag ('SpecSelf s) t where+ modSub _ f = f (Proxy @s)+ getSub _ f = f (Proxy @s)++instance HasSub tag ctag 'SpecLeaf t where+ modSub _ _ = pure+ getSub _ _ = mempty++data GSubTag++instance (Generic t, HasSub' ctag (l : ls) 'Nothing 'Nothing (Rep t)) => HasSub ctag GSubTag ('SpecList (l : ls)) t where+ modSub p f = fmap to . modSub' @ctag @(l : ls) @'Nothing @'Nothing p f . from+ getSub p f = getSub' @ctag @(l : ls) @'Nothing @'Nothing p f . from++-- Generic code++type family All (p :: k -> Constraint) (as :: [k]) :: Constraint where+ All p '[] = ()+ All p (a ': as) = (p a, All p as)++type family SpecMods (s :: SubSpec) :: Type where+ SpecMods ('SubSpec _ t _) = t++type family AllMods (p :: Type -> Constraint) (as :: Spec) :: Constraint where+ AllMods p ('SpecList ls) = AllMods' p ls+ AllMods p ('SpecSelf t) = p t+ AllMods p 'SpecLeaf = ()++type family AllMods' (p :: Type -> Constraint) (as :: [SubSpec]) :: Constraint where+ AllMods' p '[] = ()+ AllMods' p (a ': as) = (p (SpecMods a), AllMods' p as)++class HasSub' ctag (ls :: [SubSpec]) (cname :: Maybe Symbol) (sname :: Maybe Symbol) (t :: Type -> Type) where+ modSub' ::+ forall c m p.+ (Applicative m, AllMods' c ls) =>+ Proxy c ->+ (forall s. c s => Proxy s -> Carrier ctag s -> m (Carrier ctag s)) ->+ t p ->+ m (t p)+ getSub' ::+ forall c m p.+ (Monoid m, AllMods' c ls) =>+ Proxy c ->+ (forall s. c s => Proxy s -> Carrier ctag s -> m) ->+ t p ->+ m++instance+ Carrier ctag t1 ~ t2 =>+ HasSub' ctag ('SubSpec 'NoSel t1 t2 : ls) _a _b (K1 _c t2)+ where+ modSub' _ f (K1 x) = K1 <$> f (Proxy @t1) x+ getSub' _ f (K1 x) = f (Proxy @t1) x++instance+ Carrier ctag t1 ~ t2 =>+ HasSub' ctag ('SubSpec ('FieldSel s) t1 t2 : ls) _a ('Just s) (K1 _c t2)+ where+ modSub' _ f (K1 x) = K1 <$> f (Proxy @t1) x+ getSub' _ f (K1 x) = f (Proxy @t1) x++instance+ Carrier ctag t1 ~ t2 =>+ HasSub' ctag ('SubSpec ('ConsSel s) t1 t2 : ls) ('Just s) _b (K1 _c t2)+ where+ modSub' _ f (K1 x) = K1 <$> f (Proxy @t1) x+ getSub' _ f (K1 x) = f (Proxy @t1) x++instance+ Carrier ctag t1 ~ t2 =>+ HasSub' ctag ('SubSpec ('ConsFieldSel s1 s2) t1 t2 : ls) ('Just s1) ('Just s2) (K1 _c t2)+ where+ modSub' _ f (K1 x) = K1 <$> f (Proxy @t1) x+ getSub' _ f (K1 x) = f (Proxy @t1) x++instance {-# OVERLAPPABLE #-} HasSub' ctag ls a b (K1 j s) => HasSub' ctag (l : ls) a b (K1 j s) where+ modSub' = modSub' @ctag @ls @a @b+ getSub' = getSub' @ctag @ls @a @b++instance HasSub' ctag '[] _a _b (K1 _c _d) where+ modSub' _ _ = pure+ getSub' _ _ = mempty++instance+ ( HasSub' ctag s a 'Nothing x+ , HasSub' ctag s a 'Nothing y+ ) =>+ HasSub' ctag s a 'Nothing (x :*: y)+ where+ modSub' p f (x :*: y) = liftA2 (:*:) (modSub' @ctag @s @a @'Nothing p f x) (modSub' @ctag @s @a @'Nothing p f y)+ getSub' p f (x :*: y) = getSub' @ctag @s @a @'Nothing p f x <> getSub' @ctag @s @a @'Nothing p f y++instance HasSub' ctag _a _b _c U1 where+ modSub' _ _ = pure+ getSub' _ _ = mempty++instance+ ( HasSub' ctag s 'Nothing 'Nothing x+ , HasSub' ctag s 'Nothing 'Nothing y+ ) =>+ HasSub' ctag s 'Nothing 'Nothing (x :+: y)+ where+ modSub' p f (L1 x) = L1 <$> modSub' @ctag @s @'Nothing @'Nothing p f x+ modSub' p f (R1 x) = R1 <$> modSub' @ctag @s @'Nothing @'Nothing p f x+ getSub' p f (L1 x) = getSub' @ctag @s @'Nothing @'Nothing p f x+ getSub' p f (R1 x) = getSub' @ctag @s @'Nothing @'Nothing p f x++instance+ HasSub' ctag ls a s x =>+ HasSub' ctag ls a 'Nothing (S1 ('MetaSel s _a _b _c) x)+ where+ modSub' p f (M1 x) = M1 <$> modSub' @ctag @ls @a @s p f x+ getSub' p f (M1 x) = getSub' @ctag @ls @a @s p f x++instance+ HasSub' ctag ls ('Just s) 'Nothing x =>+ HasSub' ctag ls 'Nothing 'Nothing (C1 ('MetaCons s _a _b) x)+ where+ modSub' p f (M1 x) = M1 <$> modSub' @ctag @ls @('Just s) @'Nothing p f x+ getSub' p f (M1 x) = getSub' @ctag @ls @('Just s) @'Nothing p f x++instance+ HasSub' ctag ls 'Nothing 'Nothing x =>+ HasSub' ctag ls 'Nothing 'Nothing (D1 _a x)+ where+ modSub' p f (M1 x) = M1 <$> modSub' @ctag @ls @'Nothing @'Nothing p f x+ getSub' p f (M1 x) = getSub' @ctag @ls @'Nothing @'Nothing p f x
+ test/Benchmark.hs view
@@ -0,0 +1,151 @@+{-# LANGUAGE RankNTypes #-}++module Main where++import Commonmark.Pandoc+import Commonmark.Parser+import Control.DeepSeq+import Control.Exception (evaluate)+import qualified Control.Monad.Trans.Writer.Lazy as LW+import qualified Control.Monad.Trans.Writer.Strict as CPSW+import qualified Control.Monad.Trans.Writer.Strict as SW+import Control.MultiWalk+import qualified Data.ByteString as B+import Data.Functor (($>))+import Data.Functor.Compose (Compose (..))+import Data.List (sort)+import Data.Text (Text)+import Data.Text.Encoding (decodeUtf8)+import Test.Tasty.Bench+import Test.Tasty.HUnit+import Text.Pandoc.Builder (Blocks, toList)+import Text.Pandoc.Definition+import Text.Pandoc.Generic (queryWith)+import qualified Text.Pandoc.Walk as PW++data PTag++instance MultiTag PTag where+ type+ MultiTypes PTag =+ '[ Block+ , Inline+ ]++type DoubleList a = MatchWith [[a]] (Trav (Compose [] []) a)++instance MultiSub PTag Block where+ type+ SubTypes PTag Block =+ 'SpecList+ '[ ToSpec (Trav [] Inline)+ , ToSpec (DoubleList Inline)+ , ToSpec (Trav [] Block)+ , ToSpec (DoubleList Block)+ , ToSpec+ ( Under+ [([Inline], [[Block]])]+ 'NoSel+ (Under ([Inline], [[Block]]) 'NoSel (Trav [] Inline))+ )+ , ToSpec+ ( Under+ [([Inline], [[Block]])]+ 'NoSel+ (Under ([Inline], [[Block]]) 'NoSel (DoubleList Block))+ )+ ]++instance MultiSub PTag Inline where+ type+ SubTypes PTag Inline =+ 'SpecList '[ToSpec (Trav [] Inline), ToSpec (Trav [] Block)]++prepEnv :: IO [Block]+prepEnv = do+ text <- decodeUtf8 <$> B.readFile "test/text.md"+ Right (Cm b :: Cm () Blocks) <- pure $ commonmark "test/text.md" text+ evaluate $ force $ toList b++multiLW :: [Block] -> [Text]+multiLW = foldMap (LW.execWriter . w)+ where+ w = buildMultiW @PTag $ \f list ->+ let blks x@(CodeBlock _ c) = LW.tell [c] $> x+ blks x = f x+ inls x@(Code _ c) = LW.tell [c] $> x+ inls x = f x+ in list .> blks .> inls++multiSW :: [Block] -> [Text]+multiSW = foldMap (SW.execWriter . w)+ where+ w = buildMultiW @PTag $ \f list ->+ let blks x@(CodeBlock _ c) = SW.tell [c] $> x+ blks x = f x+ inls x@(Code _ c) = SW.tell [c] $> x+ inls x = f x+ in list .> blks .> inls++multiCPSW :: [Block] -> [Text]+multiCPSW = foldMap (CPSW.execWriter . w)+ where+ w = buildMultiW @PTag $ \f list ->+ let blks x@(CodeBlock _ c) = CPSW.tell [c] $> x+ blks x = f x+ inls x@(Code _ c) = CPSW.tell [c] $> x+ inls x = f x+ in list .> blks .> inls++multi :: [Block] -> [Text]+multi = foldMap $+ buildMultiQ @PTag $ \sub list ->+ list ?> blks sub ?> inls sub+ where+ blks :: Query PTag [Text] -> Block -> [Text]+ blks _ (CodeBlock _ c) = [c]+ blks f x = f x+ inls :: Query PTag [Text] -> Inline -> [Text]+ inls _ (Code _ c) = [c]+ inls f x = f x++gene :: [Block] -> [Text]+gene x = queryWith blks x <> queryWith inls x+ where+ blks :: Block -> [Text]+ blks (CodeBlock _ c) = [c]+ blks _ = []+ inls :: Inline -> [Text]+ inls (Code _ c) = [c]+ inls _ = []++wal :: [Block] -> [Text]+wal x = PW.query blks x <> PW.query inls x+ where+ blks :: Block -> [Text]+ blks (CodeBlock _ c) = [c]+ blks _ = []+ inls :: Inline -> [Text]+ inls (Code _ c) = [c]+ inls _ = []++main :: IO ()+main =+ defaultMain+ [ bgroup+ "query"+ [ env prepEnv $ bench "multiwalk" . nf multi+ , env prepEnv $ bench "mw lw" . nf multiLW+ , env prepEnv $ bench "mw sw" . nf multiSW+ , env prepEnv $ bench "mw cpsw" . nf multiCPSW+ , env prepEnv $ bench "syb" . nf gene+ , env prepEnv $ bench "pandoc.walk" . nf wal+ , env prepEnv $ \blocks ->+ -- The other implementations return out of order (!!!) fragments, but sorted they should be the same.+ bgroup+ "equality"+ [ testCase "multiwalk eq syb" (sort (multi blocks) @?= sort (gene blocks))+ , testCase "multiwalk eq pandoc.walk" (sort (multi blocks) @?= sort (wal blocks))+ ]+ ]+ ]
+ test/Main.hs view
@@ -0,0 +1,74 @@+module Main (main) where++import Control.MultiWalk+import Data.Functor.Compose (Compose (..))+import Data.Functor.Identity (Identity (..))+import GHC.Generics (Generic)+import Test.Tasty+import Test.Tasty.HUnit++data Foo+ = Foo1 String+ | Foo2 String Foo+ | Foo3 [Int] String [[Int]] Int [Int]+ deriving (Eq, Show, Generic)++data FooTag++instance MultiTag FooTag where+ type+ MultiTypes FooTag =+ '[ String+ , Foo+ , Int+ , [Int]+ ]++instance MultiSub FooTag Foo where+ type+ SubTypes FooTag Foo =+ 'SpecList+ '[ ToSpec Foo+ , ToSpec String+ , ToSpec (MatchWith [[Int]] (Trav (Compose [] []) Int))+ , ToSpec [Int]+ ]++instance MultiSub FooTag String where+ type SubTypes FooTag String = 'SpecLeaf++instance MultiSub FooTag Int where+ type SubTypes FooTag Int = 'SpecLeaf++instance MultiSub FooTag [Int] where+ type SubTypes FooTag [Int] = 'SpecList '[ToSpec (Trav [] Int)]++sampleFoo :: Foo+sampleFoo = Foo2 "bla" (Foo2 "blblo" (Foo1 "ok"))++list' :: FList Identity '[String, Foo, Int, [Int]]+list' = (Identity . ('2' :)) :.: pure :.: (Identity . (2 *)) :.: (\x -> Identity (x ++ x)) :.: FNil++sampleFoo2 :: Foo+sampleFoo2 = Foo3 [0, 1] "abc" [[4, 8, 9], [5, 6, 7]] 32 [2, 3]++tests :: TestTree+tests =+ testGroup+ "Tests"+ [ testGroup+ "Query"+ [ testCase "Foo" $+ query @FooTag (\(x :: Foo) -> [x]) sampleFoo+ @?= [Foo2 "bla" (Foo2 "blblo" (Foo1 "ok")), Foo2 "blblo" (Foo1 "ok"), Foo1 "ok"]+ , testCase "String" $+ query @FooTag (\(x :: String) -> [x]) sampleFoo+ @?= ["bla", "blblo", "ok"]+ ]+ , testCase "ModSub" $+ walkSub @FooTag list' sampleFoo2+ @?= Identity (Foo3 [0, 1, 0, 1] "2abc" [[8, 16, 18], [10, 12, 14]] 32 [2, 3, 2, 3])+ ]++main :: IO ()+main = defaultMain tests