packages feed

comonad-coactions (empty) → 0.1.0.0

raw patch · 11 files changed

+1598/−0 lines, 11 filesdep +QuickCheckdep +adjunctionsdep +base

Dependencies added: QuickCheck, adjunctions, base, checkers, clock, comonad, comonad-coactions, constraints, containers, distributive, finite-typelits, free, ghc-typelits-knownnat, kan-extensions, ki, random, tasty, tasty-quickcheck, template-haskell, termbox-tea, terminal-size, vector-sized

Files

+ CHANGELOG.md view
@@ -0,0 +1,5 @@+# Revision history for comonad-coactions++## 0.1.0.0 -- 2026-02-08++* First version. Released on an unsuspecting world.
+ LICENSE view
@@ -0,0 +1,661 @@+                    GNU AFFERO GENERAL PUBLIC LICENSE+                       Version 3, 19 November 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 Affero General Public License is a free, copyleft license for+software and other kinds of works, specifically designed to ensure+cooperation with the community in the case of network server software.++  The licenses for most software and other practical works are designed+to take away your freedom to share and change the works.  By contrast,+our General Public Licenses are 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.++  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.++  Developers that use our General Public Licenses protect your rights+with two steps: (1) assert copyright on the software, and (2) offer+you this License which gives you legal permission to copy, distribute+and/or modify the software.++  A secondary benefit of defending all users' freedom is that+improvements made in alternate versions of the program, if they+receive widespread use, become available for other developers to+incorporate.  Many developers of free software are heartened and+encouraged by the resulting cooperation.  However, in the case of+software used on network servers, this result may fail to come about.+The GNU General Public License permits making a modified version and+letting the public access it on a server without ever releasing its+source code to the public.++  The GNU Affero General Public License is designed specifically to+ensure that, in such cases, the modified source code becomes available+to the community.  It requires the operator of a network server to+provide the source code of the modified version running there to the+users of that server.  Therefore, public use of a modified version, on+a publicly accessible server, gives the public access to the source+code of the modified version.++  An older license, called the Affero General Public License and+published by Affero, was designed to accomplish similar goals.  This is+a different license, not a version of the Affero GPL, but Affero has+released a new version of the Affero GPL which permits relicensing under+this license.++  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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.++  Notwithstanding any other provision of this License, if you modify the+Program, your modified version must prominently offer all users+interacting with it remotely through a computer network (if your version+supports such interaction) an opportunity to receive the Corresponding+Source of your version by providing access to the Corresponding Source+from a network server at no charge, through some standard or customary+means of facilitating copying of software.  This Corresponding Source+shall include the Corresponding Source for any work covered by version 3+of the GNU General Public License that is incorporated pursuant to the+following paragraph.++  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 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 work with which it is combined will remain governed by version+3 of the GNU General Public License.++  14. Revised Versions of this License.++  The Free Software Foundation may publish revised and/or new versions of+the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.++    You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer+network, you should also make sure that it provides a way for users to+get its source.  For example, if your program is a web application, its+interface could display a "Source" link that leads users to an archive+of the code.  There are many ways you could offer source, and different+solutions will be better for different programs; see section 13 for the+specific requirements.++  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 AGPL, see+<http://www.gnu.org/licenses/>.
+ comonad-coactions.cabal view
@@ -0,0 +1,114 @@+cabal-version:      3.4+name:               comonad-coactions++-- 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.1.0.0++synopsis: Coactions of comonads on functors++description:+  This package defines classes for left and right coactions of+  comonads on functors.++license:            AGPL-3.0-or-later+license-file:       LICENSE+author:             noiioiu+maintainer:         noiioiu@cocaine.ninja++homepage: https://codeberg.org/noiioiu/comonad-coactions++category:           Control,+                    Comonads+build-type:         Simple++extra-doc-files:    CHANGELOG.md++common warnings+    ghc-options: -Wall++source-repository head+  type: git+  location: ssh://git@codeberg.org/noiioiu/comonad-coactions.git++library+    import:           warnings+    exposed-modules:  Control.Comonad.Coaction,+                      Control.Comonad.TransformerStack,+                      Control.Comonad.Coaction.Left,+                      Control.Comonad.Coaction.Right,+    other-modules: Control.Comonad.Coaction.TH+    build-depends: base >= 4.20.2 && < 4.21,+                   comonad >= 5.0.10 && < 5.1,+                   kan-extensions >= 5.2.8 && < 5.3,+                   free >= 5.2 && < 5.3,+                   template-haskell >= 2.22.0 && < 2.23,+                   adjunctions >= 4.4.4 && < 4.5,+                    +    hs-source-dirs:   src+    default-language: GHC2021++flag examples+  description: Build examples+  default:     False+  manual:      True++executable ca+  import: warnings+  if !flag(examples)+    buildable: False+  default-language: GHC2021+  hs-source-dirs: examples+  main-is: ElementaryCA.hs+  build-depends:+        comonad-coactions,+        base >= 4.20.2 && < 4.21,+        comonad >= 5.0.10 && < 5.1,+        finite-typelits >= 0.2.1 && < 0.3,+        random >= 1.3.1 && < 1.4,+        terminal-size >= 0.3.4 && < 0.4,+        vector-sized >= 1.6.1 && < 1.7,++executable life+  import: warnings+  if !flag(examples)+    buildable: False+  default-language: GHC2021+  hs-source-dirs: examples+  main-is: Life.hs+  ghc-options: -threaded -rtsopts -fplugin GHC.TypeLits.KnownNat.Solver+  build-depends:+        comonad-coactions,+        adjunctions >= 4.4.4 && < 4.5,+        base >= 4.20.2 && < 4.21,+        clock >= 0.8.4 && < 0.9,+        comonad >= 5.0.10 && < 5.1,+        constraints >= 0.14.4 && < 0.15,+        distributive >= 0.6.3 && < 0.7,+        finite-typelits >= 0.2.1 && < 0.3,+        ghc-typelits-knownnat >= 0.8.2 && < 0.9,+        ki >= 1.0.1 && < 1.1,+        random >= 1.3.1 && < 1.4,+        termbox-tea >= 1.0.0 && < 1.1,+        vector-sized >= 1.6.1 && < 1.7,++test-suite comonad-coactions-test+    import:           warnings+    default-language: GHC2021+    type:             exitcode-stdio-1.0+    hs-source-dirs:   test+    main-is:          Main.hs+    build-depends:+        base,+        comonad,+        comonad-coactions,+        containers,+        QuickCheck,+        checkers,+        tasty,+        tasty-quickcheck
+ examples/ElementaryCA.hs view
@@ -0,0 +1,70 @@+{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE PatternSynonyms #-}++module Main where++import Control.Comonad.Coaction+import Control.Comonad.Identity+import Control.Comonad.Store+import Control.Concurrent+import Control.Monad+import Data.Bits+import Data.Finite+import Data.Vector.Sized qualified as V+import GHC.TypeLits+import System.Console.Terminal.Size+import System.IO+import System.Random++type Cell = Bool++pattern Off :: Cell+pattern Off = False++pattern On :: Cell+pattern On = True++{-# COMPLETE On, Off #-}++cellToChar :: Cell -> Char+cellToChar = \case+  Off -> ' '+  On -> '█'++cellsToString :: (Foldable f) => f Cell -> String+cellsToString = foldr ((:) . cellToChar) ""++pattern Store :: (s -> a) -> s -> Store s a+pattern Store a b = StoreT (Identity a) b++{-# COMPLETE Store #-}++rule :: (KnownNat n) => Int -> V.Vector n Cell -> V.Vector n Cell+rule rn =+  rextend $ \(Store f i) ->+    let i' = getFinite i+        nbhd = foldl ((+) . (* 2)) 0 $ fromEnum . f . modulo . (+ i') <$> [-1, 0, 1]+     in testBit rn nbhd++mainLoop :: forall n. Maybe (SNat n) -> Int -> IO ()+mainLoop (Just sn) rn = withKnownNat sn $+  do+    x <- sequence . V.replicate @n $ randomIO+    forever $ go x+  where+    go x = do+      putStrLn $ cellsToString x+      threadDelay 25000+      go $ rule rn x+mainLoop Nothing _ = pure ()++main :: IO ()+main = do+  putStr "Enter rule number: "+  hFlush stdout+  ruleNumber <- readLn+  Just Window {width} <- size+  let loop = withSomeSNat width mainLoop+  loop ruleNumber
+ examples/Life.hs view
@@ -0,0 +1,186 @@+{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE PatternSynonyms #-}+{-# LANGUAGE QualifiedDo #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE UndecidableInstances #-}+{-# LANGUAGE ViewPatterns #-}+{-# LANGUAGE NoStarIsType #-}+{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver -threaded -rtsopts #-}++module Main (main) where++import Control.Comonad.Coaction+import Control.Comonad.Coaction.Right qualified as R+import Control.Comonad.Identity hiding ((<@>))+import Control.Comonad.Store hiding (pos, (<@>))+import Control.Concurrent+import Control.Monad+import Data.Bifunctor+import Data.Constraint+import Data.Distributive+import Data.Finite+import Data.Foldable+import Data.Functor.Rep+import Data.Vector.Sized qualified as V+import GHC.TypeLits+import Ki qualified+import System.Clock+import System.IO+import System.Random hiding (Finite)+import Termbox.Tea qualified as TB+import Prelude hiding (replicate)++newtype Array2D (m :: Nat) (n :: Nat) a = Array2D {getArray2D :: V.Vector (m * n) a}+  deriving+    ( Eq,+      Ord,+      Show,+      Functor,+      Foldable,+      Traversable+    )++instance (KnownNat (m * n)) => Distributive (Array2D m n) where+  distribute = Array2D . distribute . fmap getArray2D++instance (KnownNat m, KnownNat n) => Representable (Array2D m n) where+  type Rep (Array2D m n) = (Finite m, Finite n)+  index Array2D {getArray2D} = index getArray2D . combineProduct+  tabulate f = Array2D . tabulate $ f . separateProduct++replicate :: (KnownNat (m * n)) => a -> Array2D m n a+replicate = Array2D . V.replicate++imap :: (KnownNat m) => ((Finite m, Finite n) -> a -> b) -> Array2D m n a -> Array2D m n b+imap f = Array2D . V.imap (f . separateProduct) . getArray2D++type Cell = Bool++pattern Off :: Cell+pattern Off = False++pattern On :: Cell+pattern On = True++{-# COMPLETE On, Off #-}++cellArray :: (KnownNat m) => Array2D m n Cell -> TB.Image+cellArray =+  fold+    . imap+      ( \(i, j) c ->+          if c+            then+              TB.atRow (fromInteger $ getFinite i)+                . TB.atCol (fromInteger $ 2 * getFinite j)+                . ap mappend (TB.atCol 1)+                $ TB.char '█'+            else mempty+      )++pattern Store :: (s -> a) -> s -> Store s a+pattern Store a b = StoreT (Identity a) b++{-# COMPLETE Store #-}++life :: (KnownNat m, KnownNat n, KnownNat (m * n)) => Array2D m n Cell -> Array2D m n Cell+life = rextend $ \(Store grid (i, j)) ->+  let s =+        sum . fmap (fromEnum . grid . bimap modulo modulo) $+          (,)+            <$> fmap (getFinite i +) [-1, 0, 1]+            <*> fmap (getFinite j +) [-1, 0, 1]+   in s == 3 || (s == 4 && grid (i, j))++data SomeBoard where SomeBoard :: (KnownNat m, KnownNat n) => SNat m -> SNat n -> Array2D m n Cell -> SomeBoard++data LifeState = LifeState+  { board :: !SomeBoard,+    running :: !Bool,+    time :: !TimeSpec,+    done :: !Bool,+    delay :: !TimeSpec,+    drawing :: !(Maybe Cell),+    steps :: !Int+  }++snatDict :: SNat n -> Dict (KnownNat n)+snatDict sn = withKnownNat sn Dict++initialize :: TimeSpec -> TB.Size -> LifeState+initialize time = \TB.Size {width, height} ->+  withSomeSNat (fromIntegral $ width `div` 2) $+    withSomeSNat (fromIntegral height) $+      \case+        Nothing -> error "Unknown nat"+        Just sm -> \case+          Nothing -> error "Unknown nat"+          Just sn -> case (snatDict sm, snatDict sn) of+            (Dict, Dict) ->+              LifeState+                { board = SomeBoard sm sn $ replicate Off,+                  running = True,+                  time,+                  done = False,+                  delay = TimeSpec {sec = 0, nsec = 100_000_000},+                  drawing = Nothing,+                  steps = 0+                }++pollEvent :: MVar TimeSpec -> Maybe (IO TimeSpec)+pollEvent m = Just $ takeMVar m++handleEvent :: LifeState -> TB.Event TimeSpec -> IO LifeState+handleEvent s@(LifeState {board = SomeBoard (sm :: SNat m) (sn :: SNat n) b, ..}) =+  \case+    TB.EventKey (TB.KeyChar 'r') ->+      do+        randomBoard <- sequence $ replicate randomIO+        pure $ s {board = SomeBoard sm sn randomBoard, steps = 0}+    TB.EventKey (TB.KeyChar 'c') -> pure $ s {board = SomeBoard sm sn $ replicate Off, steps = 0}+    TB.EventKey (TB.KeyChar 'q') -> pure $ s {done = True}+    TB.EventKey (TB.KeyChar '+') -> pure $ s {delay = max 0 $ delay - TimeSpec {sec = 0, nsec = 20_000_000}}+    TB.EventKey (TB.KeyChar '-') -> pure $ s {delay = delay + TimeSpec {sec = 0, nsec = 20_000_000}}+    TB.EventKey TB.KeySpace -> pure $ s {running = not running}+    TB.EventMouse TB.Mouse {button = TB.LeftClick, pos = TB.Pos {..}} ->+      let r = modulo $ fromIntegral row+          c = modulo $ fromIntegral $ col `div` 2+       in case drawing of+            Nothing ->+              let b' = b R.=>> \(Store grid (i, j)) -> if (i, j) == (r, c) then not $ grid (i, j) else grid (i, j)+               in pure s {board = SomeBoard sm sn b', drawing = Just $ index b' (r, c)}+            Just cell ->+              let b' = b R.=>> \(Store grid (i, j)) -> if (i, j) == (r, c) then cell else grid (i, j)+               in pure s {board = SomeBoard sm sn b'}+    TB.EventMouse TB.Mouse {button = TB.ReleaseClick} -> pure s {drawing = Nothing}+    TB.EventUser t -> if t - time >= delay && running then pure s {board = SomeBoard sm sn $ life b, time = t, steps = steps + 1} else pure s+    _ -> pure s++render :: LifeState -> TB.Scene+render = TB.image . (\(SomeBoard _ _ b) -> cellArray b) . board++main :: IO ()+main = do+  t0 <- getTime Monotonic+  result <-+    Ki.scoped $ \scope -> do+      timeVar <- newEmptyMVar+      Ki.fork_ scope+        . forever+        $ threadDelay 1000+          >> getTime Monotonic+          >>= putMVar timeVar+      TB.run+        TB.Program+          { initialize = initialize t0,+            pollEvent = pollEvent timeVar,+            handleEvent,+            render,+            finished = done+          }+  case result of+    Left err -> hPutStrLn stderr $ "Failed to initialize: " ++ show err+    Right LifeState {steps} -> putStrLn $ "Ran for " ++ show steps ++ " steps"
+ src/Control/Comonad/Coaction.hs view
@@ -0,0 +1,176 @@+{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE UndecidableInstances #-}++-- | Given a comonad \(W\) on a category \(\mathcal{D}\) with counit \(\varepsilon\) and+--     comultiplication \(\Delta\) and a functor \(F\) from \(\mathcal{C}\) to \(\mathcal{D}\),+--     a left (or outer) comonad coaction of \(W\) on \(F\) is a natural transformation+--     \(\Sigma: F \to W \circ F\) such that the following two laws hold:+--+--     * \((\varepsilon \circ F) \cdot \Sigma  = \mathrm{id}_F\)+--     * \((\Delta \circ F) \cdot \Sigma   = (W \circ \Sigma) \cdot \Sigma\)+--+--     We also say that \(F\) is a left comodule over \(W\).  In the case+--     \(\mathcal{C} = \mathcal{D}\), a left comonad comodule is a left comonoid comodule+--     object in the category of endofunctors on \(\mathcal{C}\).+--+--     Right (or inner) comonad coactions are defined similarly.+module Control.Comonad.Coaction+  ( LeftComodule (..),+    RightComodule (..),+    BiComodule (..),+    ComonadTransStack (..),+  )+where++import Control.Comonad (Comonad (..))+import Control.Comonad.Density (Density (..))+import Control.Comonad.Env.Class (ComonadEnv (..))+import Control.Comonad.Identity (Identity (..))+import Control.Comonad.Store.Class (ComonadStore (..))+import Control.Comonad.Traced.Class (ComonadTraced (..))+import Control.Comonad.Trans.Store (Store, store)+import Control.Comonad.Trans.Traced (Traced, traced)+import Control.Comonad.TransformerStack (ComonadTransStack (..))+import Control.Monad (liftM2)+import Data.Functor.Compose (Compose (..))+import Data.Functor.Rep (Representable (..))+import Data.Functor.Sum (Sum (..))++-- | Instances must satisfy the following laws:+--+-- * @'duplicate' '.' 'lduplicate' = 'fmap' 'lduplicate' '.' 'lduplicate'@+--+-- * @'extract' '.' 'lduplicate' = 'id'@+class (Comonad w, Functor f) => LeftComodule w f where+  lduplicate ::+    f a ->+    -- | left comonad coaction+    w (f a)+  lduplicate = lextend id+  lextend :: (f a -> b) -> f a -> w b+  lextend f = fmap f . lduplicate+  {-# MINIMAL lduplicate | lextend #-}++-- | Instances must satisfy the following laws:+--+-- * @'fmap' 'duplicate' '.' 'rduplicate' = 'rduplicate' '.' 'rduplicate'@+--+-- * @'fmap' 'extract' '.' 'lduplicate' = 'id'@+class (Comonad w, Functor f) => RightComodule w f where+  rduplicate ::+    f a ->+    -- | right comonad coaction+    f (w a)+  rduplicate = rextend id+  rextend :: (w a -> b) -> f a -> f b+  rextend f = fmap f . rduplicate+  {-# MINIMAL rduplicate | rextend #-}++-- | Given two comonads r and s, an (r, s) bicomodule is a functor that is a left comodule over r and a right comodule over s, where the two coactions are compatible.+--   Instances must satisfy the following law in addition to the laws for @'LeftComodule'@ and @'RightComodule'@:+--+-- * @'lduplicate' '.' 'rduplicate' = 'fmap' 'rduplicate' '.' 'lduplicate' = 'biduplicate'@+class (LeftComodule r f, RightComodule s f) => BiComodule r s f where+  biduplicate ::+    f a ->+    -- | two-sided comonad coaction+    r (f (s a))+  biduplicate = lduplicate . rduplicate++instance {-# INCOHERENT #-} (Comonad w) => LeftComodule Identity w where+  lduplicate = Identity++instance {-# INCOHERENT #-} (Comonad w) => RightComodule Identity w where+  rduplicate = fmap Identity++instance {-# INCOHERENT #-} (Comonad w) => BiComodule Identity Identity w where+  biduplicate = Identity . fmap Identity++instance {-# INCOHERENT #-} (Comonad w, Functor f, LeftComodule w v) => LeftComodule w (Compose v f) where+  lduplicate = fmap Compose . lduplicate . getCompose+  lextend f = lextend (f . Compose) . getCompose++instance {-# INCOHERENT #-} (Comonad w, Functor f, RightComodule w v) => RightComodule w (Compose f v) where+  rduplicate = Compose . fmap rduplicate . getCompose+  rextend f = Compose . fmap (rextend f) . getCompose++instance {-# INCOHERENT #-} (Comonad s, Comonad t, Functor f, LeftComodule s u, RightComodule t v) => BiComodule s t (Compose u (Compose f v))++-- | Proof that @f@ is always a left comodule over @t'Density' f@:+--+--   * @   'duplicate' ('lduplicate' w)+--       = 'duplicate' ('Density' 'id' w)+--       = 'Density' ('Density' 'id') w+--       = 'Density' 'lduplicate' w+--       = 'fmap' 'lduplicate' ('Density' 'id' w)+--       = 'fmap' 'lduplicate' ('lduplicate' w)@+--+--   * @'extract' ('lduplicate' w) = 'extract' ('Density' 'id' w) = w@+instance (Functor f) => LeftComodule (Density f) f where+  lduplicate = Density id++instance {-# OVERLAPS #-} (Comonad q, Comonad w, ComonadTransStack w q) => LeftComodule w q where+  lduplicate = lowerStack . duplicate+  lextend f = lowerStack . extend f++instance {-# OVERLAPS #-} (Comonad q, Comonad w, ComonadTransStack w q) => RightComodule w q where+  rduplicate = lextend lowerStack+  rextend f = extend $ f . lowerStack++instance {-# OVERLAPS #-} (Comonad q, Comonad w, ComonadTransStack w q) => BiComodule w w q++instance {-# INCOHERENT #-} (ComonadStore s w) => LeftComodule (Store s) w where+  lduplicate = liftM2 store (flip peek) pos . duplicate+  lextend f = liftM2 store (flip peek) pos . extend f++-- instance {-# INCOHERENT #-} (ComonadStore s w) => RightComodule (Store s) w where+--   rduplicate = extend $ liftM2 store (flip peek) pos+--   rextend f = extend $ f . liftM2 store (flip peek) pos++-- instance {-# INCOHERENT #-} (ComonadStore s w) => BiComodule (Store s) (Store s) w++instance {-# INCOHERENT #-} (ComonadEnv e w) => LeftComodule ((,) e) w where+  lduplicate = liftM2 (,) ask extract . duplicate+  lextend f = liftM2 (,) ask extract . extend f++instance {-# INCOHERENT #-} (ComonadEnv e w) => RightComodule ((,) e) w where+  rduplicate = extend $ liftM2 (,) ask extract+  rextend f = extend $ f . liftM2 (,) ask extract++instance {-# INCOHERENT #-} (ComonadEnv e w) => BiComodule ((,) e) ((,) e) w++instance {-# INCOHERENT #-} (ComonadTraced m w, Monoid m) => LeftComodule (Traced m) w where+  lduplicate = traced . flip trace . duplicate+  lextend f = traced . flip trace . extend f++instance {-# INCOHERENT #-} (ComonadTraced m w, Monoid m) => RightComodule (Traced m) w where+  rduplicate = extend $ traced . flip trace+  rextend f = extend $ f . traced . flip trace++instance {-# INCOHERENT #-} (ComonadTraced m w, Monoid m) => BiComodule (Traced m) (Traced m) w++instance {-# INCOHERENT #-} (LeftComodule w f, LeftComodule w g) => LeftComodule w (Sum f g) where+  lduplicate = \case+    InL x -> InL <$> lduplicate x+    InR x -> InR <$> lduplicate x+  lextend f = \case+    InL x -> lextend @w (f . InL) x+    InR x -> lextend @w (f . InR) x++instance {-# INCOHERENT #-} (RightComodule w f, RightComodule w g) => RightComodule w (Sum f g) where+  rduplicate = \case+    InL x -> InL $ rduplicate x+    InR x -> InR $ rduplicate x+  rextend f = \case+    InL x -> InL $ rextend @w f x+    InR x -> InR $ rextend @w f x++instance {-# INCOHERENT #-} (BiComodule w q f, BiComodule w q g) => BiComodule w q (Sum f g) where+  biduplicate = \case+    InL x -> InL <$> biduplicate x+    InR x -> InR <$> biduplicate x++instance (Representable f, Rep f ~ s) => RightComodule (Store s) f where+  rduplicate = tabulate . store . index
+ src/Control/Comonad/Coaction/Left.hs view
@@ -0,0 +1,35 @@+-- | Operators for left comonad coactions.+--   This module should be imported qualified.+module Control.Comonad.Coaction.Left+  ( (<<=),+    (=>>),+    (=>=),+    (=<=),+  )+where++import Control.Comonad.Coaction++infixl 1 =>>++infixr 1 <<=, =<=, =>=++-- | @'lextend'@ in operator form.+(<<=) :: (LeftComodule w f) => (f a -> b) -> f a -> w b+(<<=) = lextend+{-# INLINE (<<=) #-}++-- | @'lextend'@ with arguments swapped.+(=>>) :: (LeftComodule w f) => f a -> (f a -> b) -> w b+(=>>) = flip lextend+{-# INLINE (=>>) #-}++-- | Left to right Cokleisli arrow scalar multiplication induced by a left comonad coaction.+(=>=) :: (LeftComodule w f) => (f a -> b) -> (w b -> c) -> f a -> c+f =>= g = g . lextend f+{-# INLINE (=>=) #-}++-- | Right to left Cokleisli arrow scalar multiplication induced by a left comonad coaction.+(=<=) :: (LeftComodule w f) => (w b -> c) -> (f a -> b) -> f a -> c+f =<= g = f . lextend g+{-# INLINE (=<=) #-}
+ src/Control/Comonad/Coaction/Right.hs view
@@ -0,0 +1,37 @@+{-# LANGUAGE MonoLocalBinds #-}++-- | Operators for left comonad coactions.+--   This module should be imported qualified.+module Control.Comonad.Coaction.Right+  ( (<<=),+    (=>>),+    (=>=),+    (=<=),+  )+where++import Control.Comonad.Coaction++infixl 1 =>>++infixr 1 <<=, =<=, =>=++-- | @'rextend'@ in operator form.+(<<=) :: (RightComodule w f) => (w a -> b) -> f a -> f b+(<<=) = rextend+{-# INLINE (<<=) #-}++-- | @'rextend'@ with arguments swapped.+(=>>) :: (RightComodule w f) => f a -> (w a -> b) -> f b+(=>>) = flip rextend+{-# INLINE (=>>) #-}++-- | Left to right Cokleisli arrow scalar multiplication induced by a right comonad coaction.+(=>=) :: (RightComodule w f) => (w a -> b) -> (f b -> c) -> f a -> c+f =>= g = g . rextend f+{-# INLINE (=>=) #-}++-- | Right to left Cokleisli arrow scalar multiplication induced by a right comonad coaction.+(=<=) :: (RightComodule w f) => (f b -> c) -> (w a -> b) -> f a -> c+f =<= g = f . rextend g+{-# INLINE (=<=) #-}
+ src/Control/Comonad/Coaction/TH.hs view
@@ -0,0 +1,75 @@+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE TemplateHaskellQuotes #-}+{-# LANGUAGE TypeData #-}++module Control.Comonad.Coaction.TH (mkLowerBy) where++import Control.Comonad+import Control.Comonad.Trans.Class (ComonadTrans (..))+import Data.Kind qualified as K+import Language.Haskell.TH++infixl 5 #++(#) :: Type -> Type -> Type+(#) = AppT++(|->|) :: Type -> Type -> Type+a |->| b = ArrowT # a # b++mkLowerBy :: Q [Dec]+mkLowerBy =+  reify ''ComonadTrans+    >>= \case+      ClassI _ instances ->+        do+          decs <-+            [d|+              type data Nat = Z | S Nat++              class (Comonad w, Comonad q) => LowerBy (k :: Nat) (w :: K.Type -> K.Type) (q :: K.Type -> K.Type) | k q -> w where+                lowerBy :: q a -> w a++              instance (Comonad w) => LowerBy Z w w where+                lowerBy = id+              |]+          let famName = mkName "Steps"+          w <- newName "w"+          q <- newName "q"+          k <- newName "k"+          let famDec =+                ClosedTypeFamilyD+                  ( TypeFamilyHead+                      famName+                      [ KindedTV w BndrReq (StarT |->| StarT),+                        KindedTV q BndrReq (StarT |->| StarT)+                      ]+                      (KindSig . ConT $ mkName "Nat")+                      Nothing+                  )+                  $ TySynEqn Nothing (ConT famName # VarT w # VarT w) (ConT $ mkName "Z")+                    : ( instances >>= \case+                          InstanceD _ _ (AppT (ConT _) t) _ ->+                            [ TySynEqn+                                Nothing+                                (ConT famName # VarT w # (t # VarT q))+                                (ConT (mkName "S") # (ConT famName # VarT w # VarT q))+                            ]+                          _ -> []+                      )+          let inductiveInstances =+                instances >>= \case+                  InstanceD ov ct (AppT (ConT _) t) _ ->+                    pure $+                      InstanceD+                        ov+                        (ct ++ [ConT (mkName "LowerBy") # VarT k # VarT w # VarT q, ConT ''Comonad # (t # VarT q)])+                        (ConT (mkName "LowerBy") # (ConT (mkName "S") # VarT k) # VarT w # (t # VarT q))+                        [ ValD+                            (VarP $ mkName "lowerBy")+                            (NormalB $ UInfixE (AppTypeE (VarE $ mkName "lowerBy") (VarT k)) (VarE '(.)) (VarE 'lower))+                            []+                        ]+                  _ -> []+          pure $ decs ++ famDec : inductiveInstances+      _ -> pure []
+ src/Control/Comonad/TransformerStack.hs view
@@ -0,0 +1,36 @@+{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE FunctionalDependencies #-}+{-# LANGUAGE TemplateHaskell #-}+{-# LANGUAGE TypeData #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE UndecidableInstances #-}++module Control.Comonad.TransformerStack (ComonadTransStack (..)) where++import Control.Comonad.Coaction.TH+import Control.Comonad.Trans.Cofree ()+import Control.Comonad.Trans.Env ()+import Control.Comonad.Trans.Identity ()+import Control.Comonad.Trans.Store ()+import Control.Comonad.Trans.Traced ()++$mkLowerBy++-- | All @'ComonadTransStack'@ instances are defined inductively using @'Control.Comonad.Trans.Class.ComonadTrans'@ instances.+--+--   No laws are given in the documentation for @'Control.Comonad.Trans.Class.ComonadTrans'@,+--   but all instances should satisfy the following laws, dual to the laws for+--   @'Control.Monad.Trans.Class.MonadTrans'@, which state that @'Control.Comonad.Trans.Class.lower'@ is a comonad homomorphism:+--+--   * @'Control.Comonad.extract' '.' 'Control.Comonad.Trans.Class.lower' = 'Control.Comonad.extract'@+--+--   * @'Control.Comonad.duplicate' '.' 'Control.Comonad.Trans.Class.lower' = 'Control.Comonad.Trans.Class.lower' '.' 'fmap' 'Control.Comonad.Trans.Class.lower' . 'Control.Comonad.duplicate'@+--+--   It follows by induction that @'lowerStack'@ is a comonad homomorphism.+--   The proofs of the comodule laws may be obtained by looking at the corresponding+--   proofs of the module laws in a mirror.+class (LowerBy (Steps w q) w q) => ComonadTransStack w q where+  lowerStack :: forall a. q a -> w a++instance (LowerBy (Steps w q) w q) => ComonadTransStack w q where+  lowerStack = lowerBy @(Steps w q)
+ test/Main.hs view
@@ -0,0 +1,203 @@+{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE MonoLocalBinds #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# OPTIONS_GHC -Wno-orphans #-}+{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}+{-# OPTIONS_GHC -Wno-unused-top-binds #-}++module Main (main) where++import Control.Comonad+import Control.Comonad.Coaction+import Control.Comonad.Store+import Control.Comonad.Traced (TracedT (..))+import Data.Functor.Compose+import Data.List.NonEmpty qualified as NE+import Data.Monoid (Sum)+import Data.Tree+import Test.QuickCheck+import Test.QuickCheck.Checkers+import Test.Tasty+import Test.Tasty.QuickCheck++leftcomodule ::+  forall w f a.+  ( LeftComodule w f,+    Arbitrary (f a),+    Show (f a),+    EqProp (f a),+    EqProp (w (w (f a)))+  ) =>+  TestBatch+leftcomodule =+  ( "left comodule laws",+    [ ("left coidentity", property leftP),+      ("coassociativity", property coassocP)+    ]+  )+  where+    leftP :: f a -> Property+    coassocP :: f a -> Property++    leftP a = extract (lduplicate @w a) =-= a+    coassocP a = duplicate @w (lduplicate a) =-= fmap lduplicate (lduplicate a)++leftcomodulestore ::+  forall w s a.+  ( Comonad w,+    Arbitrary s,+    Arbitrary (w (Fun s a)),+    Show s,+    EqProp s,+    EqProp (w a),+    Show (w (Fun s a)),+    EqProp (w (w (w a, s))),+    ComonadTransStack w (StoreT s w)+  ) =>+  TestBatch+leftcomodulestore =+  ( "left comodule laws for StoreT",+    [ ("right coidentity", property leftP),+      ("associativity", property coassocP)+    ]+  )+  where+    leftP :: w (Fun s a) -> s -> s -> Property+    coassocP :: w (Fun s a) -> s -> s -> Property++    leftP a s t =+      let x@(StoreT f1 s1) = StoreT (applyFun <$> a) s+          StoreT f2 s2 = extract (lduplicate @w x)+       in (($ t) <$> f1, s1) =-= (($ t) <$> f2, s2)+    coassocP a s t =+      let x = StoreT (applyFun <$> a) s+          w1 = fmap (\(StoreT f u) -> (($ t) <$> f, u)) <$> duplicate @w (lduplicate x)+          w2 = fmap (\(StoreT f u) -> (($ t) <$> f, u)) <$> fmap lduplicate (lduplicate x)+       in w1 =-= w2++leftcomoduletraced ::+  forall w m a.+  ( Comonad w,+    Arbitrary m,+    Arbitrary a,+    Monoid m,+    EqProp (w a),+    Arbitrary (w (Fun m a)),+    Show m,+    Show (w (Fun m a)),+    EqProp (w (w (w a))),+    ComonadTransStack w (TracedT m w)+  ) =>+  TestBatch+leftcomoduletraced =+  ( "left comodule laws for TracedT",+    [ ("right coidentity", property leftP),+      ("associativity", property coassocP)+    ]+  )+  where+    leftP :: w (Fun m a) -> m -> Property+    coassocP :: w (Fun m a) -> m -> Property++    leftP a t =+      let x@(TracedT f1) = TracedT (applyFun <$> a)+          TracedT f2 = extract (lduplicate @w x)+       in (($ t) <$> f1) =-= (($ t) <$> f2)+    coassocP a t =+      let x = TracedT (applyFun <$> a)+          w1 = fmap (\(TracedT f) -> ($ t) <$> f) <$> duplicate @w (lduplicate x)+          w2 = fmap (\(TracedT f) -> ($ t) <$> f) <$> fmap lduplicate (lduplicate x)+       in w1 =-= w2++rightcomodule ::+  forall w f a.+  ( RightComodule w f,+    EqProp (f a),+    EqProp (f (w (w a))),+    Arbitrary (f a),+    Show (f a)+  ) =>+  TestBatch+rightcomodule =+  ( "right comodule laws",+    [ ("right coidentity", property rightP),+      ("coassociativity", property coassocP)+    ]+  )+  where+    rightP :: f a -> Property+    coassocP :: f a -> Property++    rightP a = fmap extract (rduplicate @w a) =-= a+    coassocP a = fmap duplicate (rduplicate @w a) =-= fmap rduplicate (rduplicate a)++rightcomodulestore ::+  forall w s a.+  ( Comonad w,+    Arbitrary s,+    Arbitrary (w (Fun s a)),+    Show s,+    Show (w (Fun s a)),+    EqProp s,+    EqProp (w a),+    EqProp (w (w (w a))),+    ComonadTransStack w (StoreT s w)+  ) =>+  TestBatch+rightcomodulestore =+  ( "right comodule laws for StoreT",+    [ ("right coidentity", property rightP),+      ("associativity", property coassocP)+    ]+  )+  where+    rightP :: w (Fun s a) -> s -> s -> Property+    coassocP :: w (Fun s a) -> s -> s -> Property++    rightP a s t =+      let x@(StoreT f1 s1) = StoreT (applyFun <$> a) s+          StoreT f2 s2 = fmap extract (rduplicate @w x)+       in (($ t) <$> f1, s1) =-= (($ t) <$> f2, s2)+    coassocP a s t =+      let x = StoreT (applyFun <$> a) s+          StoreT f1 s1 = fmap duplicate (rduplicate @w x)+          StoreT f2 s2 = fmap rduplicate (rduplicate x)+       in (($ t) <$> f1, s1) =-= (($ t) <$> f2, s2)++bicomodule ::+  forall s t f a.+  ( BiComodule s t f,+    Arbitrary a,+    EqProp (s (f (t a))),+    Arbitrary (f a),+    Show (f a)+  ) =>+  TestBatch+bicomodule =+  ( "bicomodule laws",+    [ ("coassociativity 1", property assoc1P),+      ("coassociativity 2", property assoc2P)+    ]+  )+  where+    assoc1P :: f a -> Property+    assoc2P :: f a -> Property++    assoc1P a = biduplicate @s @t a =-= lduplicate (rduplicate a)+    assoc2P a = biduplicate @s @t a =-= fmap rduplicate (lduplicate a)++instance (EqProp a) => EqProp (Tree a)++main :: IO ()+main =+  defaultMain+    ( testGroup "monad action laws" $+        uncurry testProperties+          <$> [ leftcomodule @NE.NonEmpty @(Compose NE.NonEmpty Maybe) @Int,+                rightcomodule @NE.NonEmpty @(Compose Maybe NE.NonEmpty) @Int,+                rightcomodulestore @NE.NonEmpty @Bool @Int,+                rightcomodulestore @Tree @Char @Int,+                leftcomodulestore @Tree @Char @Char,+                leftcomoduletraced @Tree @(Sum Int) @Char+              ]+    )