diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU 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. + + + Copyright (C) + + 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 . + +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 +. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/antisplice.cabal b/antisplice.cabal new file mode 100644 --- /dev/null +++ b/antisplice.cabal @@ -0,0 +1,68 @@ +-- Initial antisplice.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +-- The name of the package. +name: antisplice + +-- The package version. See the Haskell package versioning policy (PVP) +-- for standards guiding when and how versions should be incremented. +-- http://www.haskell.org/haskellwiki/Package_versioning_policy +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.7.0.0 + +-- A short (one-line) description of the package. +synopsis: An engine for text-based dungeons. + +-- A longer description of the package. +-- description: + +-- The license under which the package is released. +license: AGPL-3 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: Marvin Cohrs + +-- An email address to which users can send suggestions, bug reports, and +-- patches. +maintainer: marvin.cohrs@gmx.net + +-- A copyright notice. +-- copyright: + +category: Game + +build-type: Simple + +-- Extra files to be distributed with the package, such as examples or a +-- README. +-- extra-source-files: + +-- Constraint on the version of Cabal needed to build this package. +cabal-version: >=1.10 + + +library + -- Modules exported by the library. + exposed-modules: Game.Antisplice.Prototypes, Game.Antisplice.Templates, Game.Antisplice.Lang, Game.Antisplice.Monad, Game.Antisplice.Rooms, Game.Antisplice.Errors, Game.Antisplice.Utils.TST, Game.Antisplice.Utils.AVL, Game.Antisplice.Utils.Run, Game.Antisplice.Utils.BST, Game.Antisplice.Utils.Graph, Game.Antisplice.Utils.Counter, Game.Antisplice.Utils.Fail, Game.Antisplice.Monad.Dungeon, Game.Antisplice.Terminal.Repl, Game.Antisplice.Events, Game.Antisplice.Monad.Vocab, Game.Antisplice.Utils.Atoms + + -- Modules included in this library but not exported. + -- other-modules: + + -- LANGUAGE extensions used by modules in this package. + other-extensions: TemplateHaskell, QuasiQuotes, FlexibleInstances, MultiParamTypeClasses, TypeSynonymInstances, FlexibleContexts, UndecidableInstances, RankNTypes, TypeFamilies, FunctionalDependencies + + -- Other library packages from which modules are imported. + build-depends: base >=4.6 && <4.7, chatty >=0.2 && <0.3, text >=0.11 && <0.12, template-haskell >=2.8 && <2.9, mtl >=2.1 && <2.2, transformers >=0.3 && <0.4, haskeline >= 0.7 && < 0.8, time >= 1.4 && < 1.5 + + -- Directories containing source files. + hs-source-dirs: src + + -- Base language which the package is written in. + default-language: Haskell2010 + + ghc-options: -threaded diff --git a/src/Game/Antisplice/Errors.hs b/src/Game/Antisplice/Errors.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Errors.hs @@ -0,0 +1,38 @@ +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides the error datatype for Antisplice +module Game.Antisplice.Errors where + +import Game.Antisplice.Utils.Fail + +-- | Antisplice errors +data SplErr = UnknownError + | QuitError + | DoneError + | UnintellegibleError + | VerbMustFirstError + | CantSeeOneError + | WhichOneError + | CantWalkThereError deriving Show + +-- | Alias for 'FailT' 'SplErr' +type SplErrT m = FailT SplErr m diff --git a/src/Game/Antisplice/Events.hs b/src/Game/Antisplice/Events.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Events.hs @@ -0,0 +1,142 @@ +{-# LANGUAGE RankNTypes, FlexibleContexts #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides setters for the various events +module Game.Antisplice.Events ( + OnEnter(..), OnFirstEnter(..), OnLook(..), OnAnnounce(..), OnSight(..), OnFirstSight(..), OnAcquire(..), OnFirstAcquire(..), + OnInspection(..), OnFirstInspection(..), OnLookInto(..), OnRead(..), OnRoomEnter(..), OnRoomLeave(..) + ) where + +import Game.Antisplice.Monad +import Game.Antisplice.Rooms +import Game.Antisplice.Monad.Dungeon + +roomOnFirstEnter :: MonadRoom m => Trigger -> m () +roomOnFirstEnter t = modifyRoomState $ \s -> s{roomTriggerOnFirstEnterOf=t} + +roomOnEachEnter :: MonadRoom m => Trigger -> m () +roomOnEachEnter t = modifyRoomState $ \s -> s{roomTriggerOnEachEnterOf=t} + +roomOnLook :: MonadRoom m => Trigger -> m () +roomOnLook t = modifyRoomState $ \s -> s{roomTriggerOnLookOf=t} + +roomOnAnnounce :: MonadRoom m => Trigger -> m () +roomOnAnnounce t = modifyRoomState $ \s -> s{roomTriggerOnAnnounceOf=t} + +objectOnFirstSight :: MonadObject m => Trigger -> m () +objectOnFirstSight t = modifyObjectState $ \s -> s{objectTriggerOnFirstSightOf=t} + +objectOnEachSight :: MonadObject m => Trigger -> m () +objectOnEachSight t = modifyObjectState $ \s -> s{objectTriggerOnEachSightOf=t} + +objectOnFirstAcquire :: MonadObject m => Trigger -> m () +objectOnFirstAcquire t = modifyObjectState $ \s -> s{objectTriggerOnFirstAcquireOf=t} + +objectOnEachAcquire :: MonadObject m => Trigger -> m () +objectOnEachAcquire t = modifyObjectState $ \s -> s{objectTriggerOnEachAcquireOf=t} + +objectOnFirstInspection :: MonadObject m => Trigger -> m () +objectOnFirstInspection t = modifyObjectState $ \s -> s{objectTriggerOnFirstInspectionOf=t} + +objectOnEachInspection :: MonadObject m => Trigger -> m () +objectOnEachInspection t = modifyObjectState $ \s -> s{objectTriggerOnEachInspectionOf=t} + +objectOnLookAt :: MonadObject m => Trigger -> m () +objectOnLookAt t = modifyObjectState $ \s -> s{objectTriggerOnLookAtOf=t} + +objectOnLookInto :: MonadObject m => Trigger -> m () +objectOnLookInto t = modifyObjectState $ \s -> s{objectTriggerOnLookIntoOf=t} + +objectOnRead :: MonadObject m => Trigger -> m () +objectOnRead t = modifyObjectState $ \s -> s{objectTriggerOnReadOf=t} + +objectOnEnter :: MonadObject m => Trigger -> m () +objectOnEnter t = modifyObjectState $ \s -> s{objectTriggerOnEnterOf=t} + +objectOnRoomEnter :: MonadObject m => Trigger -> m () +objectOnRoomEnter t = modifyObjectState $ \s -> s{objectTriggerOnRoomEnterOf=t} + +objectOnRoomLeave :: MonadObject m => Trigger -> m () +objectOnRoomLeave t = modifyObjectState $ \s -> s{objectTriggerOnRoomLeaveOf=t} + +objectOnAnnounce :: MonadObject m => Trigger -> m () +objectOnAnnounce t = modifyObjectState $ \s -> s{objectTriggerOnAnnounceOf=t} + +-- | Triggered when the user enters a room or object. +class OnEnter e where onEnter :: Trigger -> e () +instance Monad m => OnEnter (RoomT m) where onEnter = roomOnEachEnter +instance Monad m => OnEnter (ObjectT m) where onEnter = objectOnEnter + +-- | Triggered when the user enters a room the first time. +class OnFirstEnter e where onFirstEnter :: Trigger -> e () +instance Monad m => OnFirstEnter (RoomT m) where onFirstEnter = roomOnFirstEnter + +-- | Triggered when the user looks around or looks at a specific object. +class OnLook e where onLook :: Trigger -> e () +instance Monad m => OnLook (RoomT m) where onLook = roomOnLook +instance Monad m => OnLook (ObjectT m) where onLook = objectOnLookAt + +-- | Triggered when the user looks into a specific object. +class OnLookInto e where onLookInto :: Trigger -> e () +instance Monad m => OnLookInto (ObjectT m) where onLookInto = objectOnLookInto + +-- | Triggered when (a) the room is announced (e.g. when entered), (b) the user looks around in the room containing the object. +class OnAnnounce e where onAnnounce :: Trigger -> e () +instance Monad m => OnAnnounce (RoomT m) where onAnnounce = roomOnAnnounce +instance Monad m => OnAnnounce (ObjectT m) where onAnnounce = objectOnAnnounce + +-- | Triggered when the user sees the object (e.g. he enters its room). +class OnSight e where onSight :: Trigger -> e () +instance Monad m => OnSight (ObjectT m) where onSight = objectOnEachSight + +-- | Triggered when the user sees the object the first time. +class OnFirstSight e where onFirstSight :: Trigger -> e () +instance Monad m => OnFirstSight (ObjectT m) where onFirstSight = objectOnFirstSight + +-- | Triggered when the user acquires the object. +class OnAcquire e where onAcquire :: Trigger -> e () +instance Monad m => OnAcquire (ObjectT m) where onAcquire = objectOnEachAcquire + +-- | Triggered when the user acquires the object the first time. +class OnFirstAcquire e where onFirstAcquire :: Trigger -> e () +instance Monad m => OnFirstAcquire (ObjectT m) where onFirstAcquire = objectOnFirstAcquire + +-- | Triggered when the user inspects the object (looks at/into it, listens to it, ...) +class OnInspection e where onInspection :: Trigger -> e () +instance Monad m => OnInspection (ObjectT m) where onInspection = objectOnEachInspection + +-- | Triggered when the user inspects the object the first time. +class OnFirstInspection e where onFirstInspection :: Trigger -> e () +instance Monad m => OnFirstInspection (ObjectT m) where onFirstInspection = objectOnFirstInspection + +-- | Triggered when the user reads the object. +class OnRead e where onRead :: Trigger -> e () +instance Monad m => OnRead (ObjectT m) where onRead = objectOnRead + +-- | Triggered when the object (e.g. a mob with a route) enters the room of the user. +class OnRoomEnter e where onRoomEnter :: Trigger -> e () +instance Monad m => OnRoomEnter (ObjectT m) where onRoomEnter = objectOnRoomEnter + +-- | Triggered when the object (e.g. a mob with a route) leaves the room of the user. +class OnRoomLeave e where onRoomLeave :: Trigger -> e () +instance Monad m => OnRoomLeave (ObjectT m) where onRoomLeave = objectOnRoomLeave diff --git a/src/Game/Antisplice/Lang.hs b/src/Game/Antisplice/Lang.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Lang.hs @@ -0,0 +1,191 @@ +{-# LANGUAGE FlexibleContexts, RankNTypes #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides all methods for language intellection. +module Game.Antisplice.Lang (act) where + +import Text.Chatty.Printer +import Text.Chatty.Scanner +import Text.Chatty.Expansion +import Game.Antisplice.Errors +import Game.Antisplice.Monad +import Game.Antisplice.Monad.Dungeon +import Game.Antisplice.Monad.Vocab +import Game.Antisplice.Utils.Graph +import Game.Antisplice.Utils.AVL +import Game.Antisplice.Utils.TST +import Game.Antisplice.Rooms +import Control.Monad.Error +import Text.Printf +import Data.Text (unpack) + +aliases :: [(String,String)] +aliases = + ("l","look"): + ("n","go north"): + ("ne","go northeast"): + ("e","go east"): + ("se","go southeast"): + ("s","go south"): + ("sw","go southwest"): + ("w","go west"): + ("nw","go northwest"): + ("u","ascend"): + ("d","descend"): + ("q","quit"): + ("i","list inventory"): + ("ex","list exits"): + ("get","acquire"): + ("take","acquire"): + ("show","list"): + [] + +defVocab :: TST Token +defVocab = foldr (\(k,v) -> tstInsert k (v k)) EmptyTST ( + ("look",Verb): + ("quit",Verb): + ("read",Verb): + ("acquire",Verb): + ("drop",Verb): + ("idiot",Noun): + ("first",Ordn 1): + ("next",Ordn 1): + ("primary",Ordn 1): + ("second",Ordn 2): + ("commit",Verb): + ("suicide",Noun): + ("go",Verb): + ("ascend",Verb): + ("descend",Verb): + ("north",Fixe): + ("south",Fixe): + ("east",Fixe): + ("west",Fixe): + ("northeast",Fixe): + ("northwest",Fixe): + ("southeast",Fixe): + ("southwest",Fixe): + ("at",Prep): + ("enter",Verb): + ("list",Verb): + ("exits",Fixe): + ("inventory",Fixe): + []) + +replaceAliases :: [String] -> [String] +replaceAliases [] = [] +replaceAliases (s:ss) = words (aliasOf s) ++ replaceAliases ss + where aliasOf x = case filter ((==x).fst) aliases of + [] -> x + (a:_) -> snd a + +isIntellegible :: Token -> Bool +isIntellegible (Unintellegible _) = False +isIntellegible _ = True + +isNoun :: Token -> Bool +isNoun (Noun _) = True +isNoun _ = False + +isAdj :: Token -> Bool +isAdj (Adj _) = True +isAdj _ = False + +mergeNouns :: [Token] -> [Token] +mergeNouns [] = [] +mergeNouns (Noun s:ts) = Nounc [] Nothing s : mergeNouns ts +mergeNouns ts@(Adj _:_) = + let as = takeWhile isAdj ts + ns = dropWhile isAdj ts + in case ns of + (n:nx) -> Nounc (map (\(Adj a) -> a) as) Nothing ((\(Noun n) -> n) n) : mergeNouns nx + _ -> as +mergeNouns (o@(Ordn i _):ts) = + let as = takeWhile isAdj ts + ns = dropWhile isAdj ts + in case ns of + (n:nx) -> Nounc (map (\(Adj a) -> a) as) (Just i) ((\(Noun n) -> n) n) : mergeNouns nx + _ -> o:as +mergeNouns (t:ts) = t : mergeNouns ts + +-- | Run a given input line. +act :: String -> ChattyDungeonM () +act s = do + ts <- mapM lookupVocab $ replaceAliases $ words s + let ss = mergeNouns ts + unless (all isIntellegible ss) $ throwError UnintellegibleError + case ss of + [] -> return () + (Verb v:_) -> act' ss + _ -> throwError VerbMustFirstError + return () + +act' (Verb "quit":[]) = throwError QuitError +act' (Verb "look":[]) = roomTriggerOnLookOf =<< getRoomState +act' (Verb "look":Prep "at":n@Nounc{}:[]) = getObject n >>= objectTriggerOnLookAtOf +act' (Verb "read":n@Nounc{}:[]) = getObject n >>= objectTriggerOnReadOf +act' (Verb "enter":n@Nounc{}:[]) = getObject n >>= objectTriggerOnEnterOf +act' (Verb "ascend":[]) = changeRoom Up +act' (Verb "descend":[]) = changeRoom Down +act' (Verb "go":Fixe d:[]) = + changeRoom $ case d of + "north" -> North + "south" -> South + "east" -> East + "west" -> West + "northeast" -> NorthEast + "northwest" -> NorthWest + "southeast" -> SouthEast + "southwest" -> SouthWest + "up" -> Up + "down" -> Down +act' (Verb "list":Fixe "exits":[]) = do + s <- getDungeonState + let (Just r) = currentRoomOf s + forM_ (listEdges r $ roomsOf s) $ \(l,n) -> do + mprint " " >> mprint (show l) >> mprint " -> " + mprintLn =<< withRoom n getRoomTitle +act' (Verb "list":Fixe "inventory":[]) = do + ps <- getPlayerState + mprintLn "Your inventory:" + forM_ (avlInorder $ playerInventoryOf ps) $ \os -> mprintLn $ printf " %s" $ unpack $ objectTitleOf os +act' (Verb "acquire":n@Nounc{}:[]) = getObject n >>= (acquireObject . objectIdOf) +act' (Verb "drop":n@Nounc{}:[]) = getObject n >>= (dropObject . objectIdOf) +act' _ = throwError UnintellegibleError + +getObject :: (MonadRoom m,MonadError SplErr m,MonadPlayer m) => Token -> m ObjectState +getObject (Nounc as i n) = do + rs <- getRoomState + ps <- getPlayerState + let os = avlInorder (roomObjectsOf rs) ++ avlInorder (playerInventoryOf ps) + ns1 = filter (elem n . objectNamesOf) os + ns2 = foldr (\a ns -> filter (elem a . objectAttributesOf) ns) ns1 as + case ns2 of + [] -> throwError CantSeeOneError + xs -> case i of + Nothing -> case xs of + [x] -> return x + _ -> throwError WhichOneError + Just idx -> if idx > length xs then throwError CantSeeOneError + else return (xs !! (idx-1)) + diff --git a/src/Game/Antisplice/Monad.hs b/src/Game/Antisplice/Monad.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Monad.hs @@ -0,0 +1,46 @@ +{-# LANGUAGE TemplateHaskell, TypeSynonymInstances, FlexibleInstances, MultiParamTypeClasses, FlexibleContexts #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides some class instances. Nothing really interesting here. +module Game.Antisplice.Monad where + +import Game.Antisplice.Templates +import Game.Antisplice.Utils.Fail +import Game.Antisplice.Utils.Counter +import Game.Antisplice.Monad.Dungeon +import Game.Antisplice.Monad.Vocab +import Game.Antisplice.Utils.Atoms +import Game.Antisplice.Errors +import Control.Monad.Trans.Class +import Text.Chatty.Templates +import Text.Chatty.Interactor.Templates +--import Language.Haskell.TH + +mkInteractor ''SplErrT mkChatty mkRoom mkDungeon mkObject mkCounter mkPlayer mkIO mkVocab mkAtoms +mkInteractor ''DungeonT mkChatty (mkFail ''SplErr) mkCounter mkIO mkVocab mkAtoms +mkInteractor ''RoomT mkChatty (mkFail ''SplErr) mkCounter mkIO mkVocab mkAtoms +mkInteractor ''ObjectT mkChatty (mkFail ''SplErr) mkCounter mkIO mkVocab mkAtoms +mkInteractor ''CounterT mkChatty (mkFail ''SplErr) mkRoom mkObject mkDungeon mkPlayer mkIO mkVocab mkAtoms +mkInteractor ''PlayerT mkChatty (mkFail ''SplErr) mkCounter mkIO mkVocab mkAtoms +mkInteractor ''VocabT mkChatty (mkFail ''SplErr) mkCounter mkDungeon mkRoom mkAtoms mkPlayer +mkInteractor ''AtomStoreT mkChatty (mkFail ''SplErr) mkDungeon mkRoom mkVocab mkPlayer diff --git a/src/Game/Antisplice/Monad/Dungeon.hs b/src/Game/Antisplice/Monad/Dungeon.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Monad/Dungeon.hs @@ -0,0 +1,275 @@ +{-# LANGUAGE FlexibleInstances, MultiParamTypeClasses, RankNTypes, FlexibleContexts, TypeFamilies #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides the basic data types and monads for Antisplice. +module Game.Antisplice.Monad.Dungeon where + +import Text.Chatty.Printer +import Text.Chatty.Scanner +import Text.Chatty.Expansion +import System.Chatty.Misc +import Text.Chatty.Extended.Printer +import Game.Antisplice.Utils.Graph +import Game.Antisplice.Utils.BST +import Game.Antisplice.Utils.AVL +import Game.Antisplice.Utils.Atoms +import Game.Antisplice.Errors +import Game.Antisplice.Utils.Fail +import Game.Antisplice.Utils.Counter +import Game.Antisplice.Monad.Vocab +import Control.Arrow +import Control.Monad.Error +import Control.Monad.Trans.Class +import Data.Text +import Control.Monad +import Data.Time.Clock + +-- | Matches any 'MonadDungeon' context +type DungeonM a = forall m.(MonadDungeon m) => m a +-- | Matches any 'MonadDungeon' context that also implements most of the Chatty classes and some of our utility classes. +type ChattyDungeonM a = forall m.(Functor m,ExtendedPrinter m,MonadScanner m,MonadExpand m,ExpanderEnv m,MonadDungeon m,MonadError SplErr m,MonadAtoms m,MonadClock m,MonadVocab m) => m a +-- | The common type of all event handlers. +type Trigger = ChattyDungeonM () +-- | A boxed 'Trigger' to avoid ImpredicativeTypes +newtype TriggerBox = TriggerBox { runTrigger :: Trigger } + +-- | Key for item or player statistics +data StatKey = STR -- ^ Strength + | AGI -- ^ Agility + | STA -- ^ Stamina + | INT -- ^ Intelligence + | SPI -- ^ Spirit + | ARM -- ^ Armor + deriving (Ord,Eq) +-- | Key for equipment slot +data EquipKey = MainHand | OffHand | Chest | Feet | Wrists | Waist | Head | Legs | Back | Hands | Neck | Finger1 | Finger2 deriving (Ord,Eq) + +-- | State type for RoomT +data RoomState = RoomState { + roomDescOf :: !Text, + roomTitleOf :: !Text, + roomObjectsOf :: AVL ObjectState, + roomTriggerOnFirstEnterOf :: Trigger, + roomTriggerOnEachEnterOf :: Trigger, + roomTriggerOnLeaveOf :: Trigger, + roomTriggerOnLookOf :: Trigger, + roomTriggerOnAnnounceOf :: Trigger + } + +-- | The room monad. Used to create or modify room data. +newtype RoomT m a = Room { runRoomT :: RoomState -> m (a,RoomState) } + +instance Functor m => Functor (RoomT m) where + fmap f a = Room $ \s -> fmap (first f) $ runRoomT a s + +instance Monad m => Monad (RoomT m) where + return a = Room $ \s -> return (a,s) + m >>= f = Room $ \s -> do (a,s') <- runRoomT m s; runRoomT (f a) s' + +instance MonadTrans RoomT where + lift m = Room $ \s -> do a <- m; return (a,s) + +-- | Typeclass for all room monads. +class Monad m => MonadRoom m where + -- | Get the room state + getRoomState :: m RoomState + -- | Put the room state + putRoomState :: RoomState -> m () + +instance Monad m => MonadRoom (RoomT m) where + getRoomState = Room $ \s -> return (s,s) + putRoomState s = Room $ \_ -> return ((),s) + +-- | Typeclass for all types that are convertible to or from 'Text' +class IsText t where + toText :: t -> Text + fromText :: Text -> t + +instance IsText Text where + toText = id + fromText = id + +instance IsText String where + toText = pack + fromText = unpack + +-- | Implications a object infers for its containing room +data Implication = DescSeg (Atom String) -- ^ An additional particle for the room description (e.g. saying that XYZ is there). + +-- | Object features. +data Feature = Damagable -- ^ May take damage. + | Acquirable -- ^ May be acquired. + | Equipable EquipKey -- ^ May be equipped at the given slot. + | Mobile -- ^ May move around. + deriving (Ord,Eq) + +-- | Phantom ID type for objects. +newtype ObjectId = ObjectId Int deriving (Eq,Ord) + +-- | State type for ObjectT +data ObjectState = ObjectState { + objectIdOf :: !ObjectId, + objectTitleOf :: !Text, + objectDescOf :: !Text, + objectNamesOf :: ![String], + objectAttributesOf :: ![String], + objectOnceSeenOf :: !Bool, + objectOnceAcquiredOf :: !Bool, + objectOnceInspectedOf :: !Bool, + objectOnceEquippedOf :: !Bool, + objectMaxHealthOf :: !Int, + objectCurHealthOf :: !Int, + objectStatsOf :: AVL (StatKey,Int), + objectRouteOf :: ![NodeId], + objectFeaturesOf :: AVL (Feature,()), + objectImplicationsOf :: [Implication], + objectTriggerOnFirstSightOf :: Trigger, + objectTriggerOnEachSightOf :: Trigger, + objectTriggerOnFirstAcquireOf :: Trigger, + objectTriggerOnEachAcquireOf :: Trigger, + objectTriggerOnFirstInspectionOf :: Trigger, + objectTriggerOnEachInspectionOf :: Trigger, + objectTriggerOnLookAtOf :: Trigger, + objectTriggerOnLookIntoOf :: Trigger, + objectTriggerOnReadOf :: Trigger, + objectTriggerOnEnterOf :: Trigger, + objectTriggerOnRoomEnterOf :: Trigger, + objectTriggerOnRoomLeaveOf :: Trigger, + objectTriggerOnAnnounceOf :: Trigger, + objectTriggerOnDropOf :: Trigger, + objectTriggerOnFirstEquipOf :: Trigger, + objectTriggerOnEachEquipOf :: Trigger, + objectTriggerOnUnequipOf :: Trigger + } + +instance Indexable ObjectState ObjectId ObjectState where + type IndexOf ObjectState = ObjectId + type ValueOf ObjectState = ObjectState + indexOf = objectIdOf + valueOf = id + +-- | The object monad. Used to create or modify objects. +newtype ObjectT m a = Object { runObjectT :: ObjectState -> m (a,ObjectState) } + +instance Functor m => Functor (ObjectT m) where + fmap f a = Object $ \s -> fmap (first f) $ runObjectT a s + +instance Monad m => Monad (ObjectT m) where + return a = Object $ \s -> return (a,s) + m >>= f = Object $ \s -> do (a,s') <- runObjectT m s; runObjectT (f a) s' + +instance MonadTrans ObjectT where + lift m = Object $ \s -> do a <- m; return (a,s) + +-- | Typeclass for all object monads +class Monad m => MonadObject m where + -- | Get the object state + getObjectState :: m ObjectState + -- | Put the object state + putObjectState :: ObjectState -> m () + +instance Monad m => MonadObject (ObjectT m) where + getObjectState = Object $ \s -> return (s,s) + putObjectState s = Object $ \_ -> return ((),s) + +-- | State type for PlayerT +data PlayerState = PlayerState { + playerRoomOf :: !NodeId, + playerMaxHealthOf :: !Int, + playerCurHealthOf :: !Int, + playerInventoryOf :: AVL ObjectState, + playerEquipOf :: AVL (EquipKey,ObjectState), + playerBaseStatsOf :: AVL (StatKey,Int) + } + +-- | The player monad. Used to create or modify players. +newtype PlayerT m a = Player { runPlayerT :: PlayerState -> m (a,PlayerState) } + +instance Functor m => Functor (PlayerT m) where + fmap f a = Player $ \s -> fmap (first f) $ runPlayerT a s + +instance Monad m => Monad (PlayerT m) where + return a = Player $ \s -> return (a,s) + m >>= f = Player $ \s -> do (a,s') <- runPlayerT m s; runPlayerT (f a) s' + +instance MonadTrans PlayerT where + lift m = Player $ \s -> do a <- m; return (a,s) + +-- | Typeclass for all player monads. +class Monad m => MonadPlayer m where + -- | Get the player state. + getPlayerState :: m PlayerState + -- | Put the player state. + putPlayerState :: PlayerState -> m () + +instance Monad m => MonadPlayer (PlayerT m) where + getPlayerState = Player $ \s -> return (s,s) + putPlayerState s = Player $ \_ -> return ((),s) + +-- | 10 directions to go +data Direction = North | NorthEast | East | SouthEast | South | SouthWest | West | NorthWest | Up | Down deriving (Eq,Show) + +-- | State type for DungeonT +data DungeonState = DungeonState { + roomsOf :: Graph RoomState Direction, + playerOf :: Maybe PlayerState, + timeTriggersOf :: AVL (NominalDiffTime,TriggerBox) + } + +-- | For compatibility. Earlier versions of DungeonT had a field for that. +currentRoomOf = fmap playerRoomOf . playerOf + +-- | The dungeon monad. Everything runs inside this. +newtype DungeonT m a = Dungeon { runDungeonT :: DungeonState -> m (a,DungeonState) } + +instance Functor m => Functor (DungeonT m) where + fmap f a = Dungeon $ \s -> fmap (first f) $ runDungeonT a s + +instance Monad m => Monad (DungeonT m) where + return a = Dungeon $ \s -> return (a,s) + m >>= f = Dungeon $ \s -> do (a,s') <- runDungeonT m s; runDungeonT (f a) s' + +instance MonadTrans DungeonT where + lift m = Dungeon $ \s -> do a <- m; return (a,s) + +instance Monad m => MonadRoom (DungeonT m) where + getRoomState = Dungeon $ \s -> case currentRoomOf s of + Just r -> return (getNode r $ roomsOf s,s) + putRoomState s' = Dungeon $ \s -> case currentRoomOf s of + Just r -> return ((),s{roomsOf=setNode r s' $ roomsOf s}) + +instance Monad m => MonadPlayer (DungeonT m) where + getPlayerState = Dungeon $ \s -> case playerOf s of + Just p -> return (p,s) + putPlayerState s' = Dungeon $ \s -> return ((),s{playerOf=Just s'}) + +-- | Typeclass for all dungeon monads. +class (MonadRoom m,MonadPlayer m) => MonadDungeon m where + -- | Get the dungeon state. + getDungeonState :: m DungeonState + -- | Put the dungeon state. + putDungeonState :: DungeonState -> m () + +instance Monad m => MonadDungeon (DungeonT m) where + getDungeonState = Dungeon $ \s -> return (s,s) + putDungeonState s = Dungeon $ \_ -> return ((),s) diff --git a/src/Game/Antisplice/Monad/Vocab.hs b/src/Game/Antisplice/Monad/Vocab.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Monad/Vocab.hs @@ -0,0 +1,74 @@ +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a monad that collects vocab during dungeon construction and +-- reproduces it later. +module Game.Antisplice.Monad.Vocab where + +import Control.Arrow +import Control.Monad +import Control.Monad.IO.Class +import Control.Monad.Trans.Class +import Game.Antisplice.Utils.TST + +-- | Algebraic type for primitive and complex tokens. +data Token = Unintellegible String + | Verb String + | Prep String + | Noun String + | Adj String + | Ordn Int String + | Fixe String + | Nounc [String] (Maybe Int) String + -- ^ Complex noun, with attributes and maybe ordinal index. + deriving Show + +-- | The vocab monad. Carries the currently noun vocab as its state. +newtype VocabT m a = Vocab { runVocabT :: TST Token -> m (a,TST Token) } + +instance Functor m => Functor (VocabT m) where + fmap f a = Vocab $ \s -> fmap (first f) $ runVocabT a s + +instance Monad m => Monad (VocabT m) where + return a = Vocab $ \s -> return (a,s) + m >>= f = Vocab $ \s -> do (a,s') <- runVocabT m s; runVocabT (f a) s' + +instance MonadTrans VocabT where + lift m = Vocab $ \s -> do a <- m; return (a,s) + +instance MonadIO m => MonadIO (VocabT m) where + liftIO = lift . liftIO + +-- | Tyepclass for all vocab-memorizing monads. +class Monad m => MonadVocab m where + -- | Lookup a word and return its token. + lookupVocab :: String -> m Token + -- | Learn a new word. + insertVocab :: String -> (String -> Token) -> m () + -- | Check if a word is already known. + vocabKnown :: String -> m Bool + +instance Monad m => MonadVocab (VocabT m) where + lookupVocab k = Vocab $ \s -> case tstLookup k s of + Just t -> return (t,s) + Nothing -> return (Unintellegible k,s) + insertVocab k tc = Vocab $ \s -> return ((),tstInsert k (tc k) s) + vocabKnown k = Vocab $ \s -> return (tstContains k s,s) diff --git a/src/Game/Antisplice/Prototypes.hs b/src/Game/Antisplice/Prototypes.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Prototypes.hs @@ -0,0 +1,124 @@ +{-# LANGUAGE TupleSections, FlexibleContexts #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides prototypes for common entities (rooms, objects, mobs). +module Game.Antisplice.Prototypes where + +import Text.Chatty.Printer +import Text.Chatty.Expansion +import Text.Chatty.Extended.Printer +import Control.Monad +import Control.Monad.Error.Class +import Game.Antisplice.Monad +import Game.Antisplice.Monad.Dungeon +import Game.Antisplice.Monad.Vocab +import Game.Antisplice.Utils.Atoms +import Game.Antisplice.Utils.Fail +import Game.Antisplice.Utils.AVL +import Game.Antisplice.Utils.Graph +import Game.Antisplice.Rooms +import Game.Antisplice.Events +import Game.Antisplice.Errors +import Text.Printf +import Data.Text (pack,unpack) + +-- | Construct a simple room from a title and a description. +ctorRoom :: Monad m => String -> String -> RoomT m () +ctorRoom t d = do + setRoomTitle t + setRoomDesc d + onAnnounce $ getRoomTitle >>= eprintLn (Dull Magenta) + onLook $ do + getRoomDesc >>= expand >>= eprintLn (Dull Green) + rs <- getRoomState + sequence_ $ avlInorder $ flip fmap (roomObjectsOf rs) $ \os -> objectTriggerOnAnnounceOf os + +-- | Construct a sign from a text and some attributes. +ctorSign :: (MonadAtoms m,MonadVocab m,MonadError SplErr m) => String -> [String] -> ObjectT m () +ctorSign t as = do + onRead $ eprintLn (Vivid White) =<< expand t + lookCountA <- newAtom + putAtom lookCountA 0 + onLook $ do + c <- getAtom lookCountA + case c :: Int of + 0 -> mprintLn "This is just a regular sign. There is nothing special about this one in particular." + 1 -> mprintLn "This REALLY is just a regular sign." + 2 -> mprintLn "Stop looking at me!" + 3 -> mprintLn "I'll call the police if you don't stop!" + 4 -> mprintLn "You hear the sounds of an arriving police car. This is your end :P" >> throwError QuitError + putAtom lookCountA (c+1) + setObjectTitle "a sign" + setObjectDesc "This is a sign with a text written on it." + addObjectName "sign" + addObjectName "caption" + mapM_ (uncurry insertVocab) [("sign",Noun),("caption",Noun)] + forM_ as addObjectAttr + forM_ as $ uncurry insertVocab . (,Adj) + +-- | Construct a mob from a title, some names, a description and some attributes. +ctorMob :: MonadVocab m => String -> [String] -> String -> [String] -> ObjectT m () +ctorMob t ns d as = do + onLook $ mprintLn d + onRoomEnter $ mprintLn $ printf "%s has entered the room." t + onRoomLeave $ mprintLn $ printf "%s has left the room." t + onAnnounce $ eprintLn (Dull Cyan) $ printf " %s is here." t + setObjectIsMob True + setObjectTitle t + setObjectDesc d + forM_ ns addObjectName + forM_ ns $ uncurry insertVocab . (,Noun) + forM_ as addObjectAttr + forM_ as $ uncurry insertVocab . (,Adj) + +-- | Construct a mob route from some room IDs and a time delay in milliseconds. +ctorRoute :: (Monad m,Functor m) => [NodeId] -> Integer -> ObjectT m () +ctorRoute rs d = do + i <- fmap objectIdOf getObjectState + setMobRoute rs + let cmr :: Trigger + cmr = continueMobRoute i >> schedule d cmr + onFirstSight $ schedule d cmr + +-- | Construct a room nesting object from a title, a description, some names, some attributes and the target room ID. +ctorRoomNesting :: MonadVocab m => String -> String -> [String] -> [String] -> NodeId -> ObjectT m () +ctorRoomNesting t d ns as r = do + setObjectTitle t + setObjectDesc d + forM_ ns addObjectName + forM_ ns $ uncurry insertVocab . (,Noun) + forM_ as addObjectAttr + forM_ as $ uncurry insertVocab . (,Adj) + onEnter $ enterAndAnnounce r + +-- | Construct an acquirable object from a title, a description, some names and some attributes. +ctorAcq :: MonadVocab m => String -> String -> [String] -> [String] -> ObjectT m () +ctorAcq t d ns as = do + setObjectTitle t + setObjectDesc d + forM_ ns addObjectName + forM_ as addObjectAttr + forM_ ns $ uncurry insertVocab . (,Noun) + forM_ as $ uncurry insertVocab . (,Adj) + onLook $ mprintLn d + setObjectIsAcquirable True diff --git a/src/Game/Antisplice/Rooms.hs b/src/Game/Antisplice/Rooms.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Rooms.hs @@ -0,0 +1,329 @@ +{-# LANGUAGE RankNTypes, FlexibleContexts #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | A huge pile of utility functions for building our dungeon. +module Game.Antisplice.Rooms where + +import Text.Chatty.Printer +import Text.Chatty.Scanner +import Text.Chatty.Expansion +import System.Chatty.Misc +import Game.Antisplice.Monad.Dungeon +import Game.Antisplice.Monad +import Game.Antisplice.Utils.Graph +import Game.Antisplice.Utils.Counter +import Game.Antisplice.Utils.AVL +import Game.Antisplice.Errors +import Control.Monad +import Control.Monad.Error +import Control.Monad.Trans.Class +import Data.Text (pack) +import Data.Maybe +import Data.Time.Clock +import Text.Printf + +-- | Modify the room state. +modifyRoomState :: MonadRoom m => (RoomState -> RoomState) -> m () +modifyRoomState f = do + s <- getRoomState + putRoomState (f s) + +-- | Get the current room's description +getRoomDesc :: (MonadRoom m,IsText t) => m t +getRoomDesc = do + s <- getRoomState + return (fromText $ roomDescOf s) + +-- | Get the current room's title +getRoomTitle :: (MonadRoom m,IsText t) => m t +getRoomTitle = do + s <- getRoomState + return (fromText $ roomTitleOf s) + +-- | Set the current room's description +setRoomDesc :: (MonadRoom m,IsText t) => t -> m () +setRoomDesc t = modifyRoomState $ \s -> s{roomDescOf=toText t} + +-- | Set the current room's title +setRoomTitle :: (MonadRoom m,IsText t) => t -> m () +setRoomTitle t = modifyRoomState $ \s -> s{roomTitleOf=toText t} + +-- | Mark the current room as visited +markRoom :: MonadDungeon m => m () +markRoom = do + s <- getDungeonState + case currentRoomOf s of + Just r -> putDungeonState s{roomsOf=markNode r $ roomsOf s} + +-- | Enter the given room and trigger most events, but don't announce it. Result tells whether this room is visited the first time. +enterRoom :: NodeId -> ChattyDungeonM Bool +enterRoom n = do + rs0 <- getRoomState + roomTriggerOnLeaveOf rs0 + s <- getDungeonState + putDungeonState s{playerOf=fmap (\p -> p{playerRoomOf=n}) $ playerOf s} + let marked = nodeMarked $ getNode' n $ roomsOf s + rs <- getRoomState + unless marked $ do + markRoom + roomTriggerOnFirstEnterOf rs + roomTriggerOnEachEnterOf rs + sequence_ $ avlInorder $ flip fmap (roomObjectsOf rs) $ \os -> do + unless (objectOnceSeenOf os) $ objectTriggerOnFirstSightOf os + objectTriggerOnEachSightOf os + putRoomState rs{roomObjectsOf=fmap (\os -> os{objectOnceSeenOf=True}) $ roomObjectsOf rs} + return $ not marked + +-- | Reenter the current room and trigger all events (but don't announce it). +reenterCurrentRoom :: ChattyDungeonM () +reenterCurrentRoom = do + s <- getDungeonState + case currentRoomOf s of + Just r -> void $ enterRoom r + +-- | Enter the given room, trigger all events and announce it. On the first visit, look around. +enterAndAnnounce :: NodeId -> ChattyDungeonM () +enterAndAnnounce n = do + r <- enterRoom n + rs <- getRoomState + roomTriggerOnAnnounceOf rs + when r $ roomTriggerOnLookOf rs + +-- | Construct a new room using the room monad. +constructRoom :: (Monad m,MonadDungeon (t m),MonadTrans t) => RoomT m a -> t m NodeId +constructRoom m = do + (_,rs) <- lift $ runRoomT m $ RoomState (pack "") (pack "") EmptyAVL (return ()) (return ()) (return ()) (return ()) (return ()) + s <- getDungeonState + let (nid,g) = addNode' rs $ roomsOf s + s' = if isNothing $ currentRoomOf s then s{roomsOf=g,playerOf=fmap (\p -> p{playerRoomOf=nid}) $ playerOf s} else s{roomsOf=g} + putDungeonState s' + return nid + +-- | Run a function in the context of the given room. +withRoom :: MonadDungeon m => NodeId -> RoomT m a -> m a +withRoom n m = do + s <- getDungeonState + let rs = getNode n $ roomsOf s + (a,rs') <- runRoomT m rs + putDungeonState s{roomsOf=setNode n rs' $ roomsOf s} + return a + +-- | Establish a path from one room to another one (one-way only). +establishWay :: MonadDungeon m => NodeId -> NodeId -> Direction -> m () +establishWay f t d = do + s <- getDungeonState + let g = addEdge f t 0 d $ roomsOf s + putDungeonState s{roomsOf=g} + +-- | Enter a neighbouring room by its direction. +changeRoom :: Direction -> ChattyDungeonM () +changeRoom d = do + s <- getDungeonState + case currentRoomOf s of + Just r -> case followEdge r d (roomsOf s) of + Just n -> enterAndAnnounce n + Nothing -> throwError CantWalkThereError + +-- | Add a new object to the current room. It is contructed using the object monad. +addRoomObject :: (Monad m,MonadCounter (t m),MonadRoom (t m),MonadTrans t) => ObjectT m a -> t m ObjectId +addRoomObject m = do + i <- countOn + (_,o) <- lift $ runObjectT m $ ObjectState + (ObjectId i) -- id + (pack "Something") -- title + (pack "I don't know what this is.") -- desc + [] [] False False False False -- names, attr, 1seen?, 1acq?, 1insp?, 1eq? + 100 100 -- maxhp, curhp + EmptyAVL [] -- stats, route + EmptyAVL [] -- feat, impl + (return ()) -- on 1 sight + (return ()) -- on sight + (return ()) -- on 1 acq + (return ()) -- on acq + (return ()) -- on 1 insp + (return ()) -- on insp + (mprintLn "There is nothing special about this.") -- on look at + (mprintLn "There is nothing inside this.") -- on look in + (mprintLn "There is nothing written on this.") -- on read + (mprintLn "You cannot enter this.") -- on enter + (return ()) -- on enter room + (return ()) -- on leave room + (return ()) -- on announce + (return ()) -- on drop + (return ()) -- on 1 eq + (return ()) -- on eq + (return ()) -- on uneq + insertRoomObject o + return $ ObjectId i + +-- | Remove an object from the current room and return its state. +removeRoomObject :: MonadRoom m => ObjectId -> m ObjectState +removeRoomObject i = do + s <- getRoomState + let Just o = avlLookup i $ roomObjectsOf s + putRoomState s{roomObjectsOf=avlRemove i $ roomObjectsOf s} + return o + +-- | Insert an already constructed object to the current room. +insertRoomObject :: MonadRoom m => ObjectState -> m () +insertRoomObject o = modifyRoomState $ \s -> s{roomObjectsOf=avlInsert o $ roomObjectsOf s} + +-- | Modify the object state +modifyObjectState :: MonadObject m => (ObjectState -> ObjectState) -> m () +modifyObjectState f = do + s <- getObjectState + putObjectState $ f s + +-- | Get the object's title +getObjectTitle :: (MonadObject m,IsText t) => m t +getObjectTitle = do + s <- getObjectState + return (fromText $ objectTitleOf s) + +-- | Set the object's title +setObjectTitle :: (MonadObject m,IsText t) => t -> m () +setObjectTitle t = modifyObjectState $ \s -> s{objectTitleOf=toText t} + +-- | Get the object's description +getObjectDesc :: (MonadObject m,IsText t) => m t +getObjectDesc = do + s <- getObjectState + return (fromText $ objectDescOf s) + +-- | Set the object's description +setObjectDesc :: (MonadObject m,IsText t) => t -> m () +setObjectDesc t = modifyObjectState $ \s -> s{objectDescOf=toText t} + +-- | Get the object's description +getObjectNames :: MonadObject m => m [String] +getObjectNames = do + s <- getObjectState + return $ objectNamesOf s + +-- | Add a name for the current object +addObjectName :: MonadObject m => String -> m () +addObjectName t = modifyObjectState $ \s -> s{objectNamesOf=t:objectNamesOf s} + +-- | Check if the given name matches our current object +matchObjectName :: MonadObject m => String -> m Bool +matchObjectName t = do + s <- getObjectState + return $ elem t $ objectNamesOf s + +-- | Add an attribute for the current object +addObjectAttr :: MonadObject m => String -> m () +addObjectAttr t = modifyObjectState $ \s -> s{objectAttributesOf=t:objectAttributesOf s} + +-- | Create a new player using the player monad +subscribePlayer :: (MonadDungeon (t m),MonadTrans t,Monad m) => PlayerT m a -> t m () +subscribePlayer m = do + s <- getDungeonState + (_,a) <- lift $ runPlayerT m $ PlayerState (rootNode $ roomsOf s) 100 100 EmptyAVL EmptyAVL EmptyAVL + putDungeonState s{playerOf=Just a} + +-- | Modify the player state +modifyPlayerState :: MonadPlayer m => (PlayerState -> PlayerState) -> m () +modifyPlayerState f = do + s <- getPlayerState + putPlayerState $ f s + +-- | Move the current player to the given room, but don't trigger anything. +setPlayerRoom :: MonadPlayer m => NodeId -> m () +setPlayerRoom r = modifyPlayerState $ \p -> p{playerRoomOf=r} + +-- | Check if the current object is a mob. +getObjectIsMob :: (MonadObject m,Functor m) => m Bool +getObjectIsMob = fmap (isJust . avlLookup Mobile . objectFeaturesOf) getObjectState + +-- | Set whether the current object is a mob. +setObjectIsMob :: MonadObject m => Bool -> m () +setObjectIsMob b = modifyObjectState $ \o -> o{objectFeaturesOf=a b $ objectFeaturesOf o} + where a True = avlInsert (Mobile,()) + a False = avlRemove Mobile + +-- | Check if the current object is acquirable. +getObjectIsAcquirable :: (MonadObject m,Functor m) => m Bool +getObjectIsAcquirable = fmap (isJust . avlLookup Acquirable . objectFeaturesOf) getObjectState + +-- | Set whether the current object is acquirable. +setObjectIsAcquirable :: MonadObject m => Bool -> m () +setObjectIsAcquirable b = modifyObjectState $ \o -> o{objectFeaturesOf=a b $ objectFeaturesOf o} + where a True = avlInsert (Acquirable,()) + a False = avlRemove Acquirable + +-- | Schedule an event for a given time offset (in milliseconds). +schedule :: (MonadDungeon m,MonadClock m) => Integer -> Trigger -> m () +schedule ms t = do + now <- mgetstamp + let t' = now + (realToFrac ms / 1000) + s <- getDungeonState + putDungeonState s{timeTriggersOf=avlInsert (t',TriggerBox t) $ timeTriggersOf s} + +-- | Set the current mob's route +setMobRoute :: MonadObject m => [NodeId] -> m () +setMobRoute rs = modifyObjectState $ \s -> s{objectRouteOf=rs} + +-- | The given object may continue its route +continueMobRoute :: ObjectId -> Trigger +continueMobRoute i = do + rs <- roomOfObject i + case rs of + [r] -> do + o <- withRoom r $ removeRoomObject i + guardVisible r $ objectTriggerOnRoomLeaveOf o + let (n:rs) = objectRouteOf o + withRoom n $ insertRoomObject o{objectRouteOf=rs++[n]} + guardVisible n $ objectTriggerOnRoomEnterOf o + return () + [] -> throwError CantSeeOneError + _ -> throwError WhichOneError + +-- | Only run the given function if the player is inside the also given room. +guardVisible :: MonadDungeon m => NodeId -> m () -> m () +guardVisible n m = do + s <- getDungeonState + when (currentRoomOf s == Just n) m + +-- | Determine which rooms contain the given object (won't be more than one, but we're careful) +roomOfObject :: MonadDungeon m => ObjectId -> m [NodeId] +roomOfObject o = (return . map nodeId . filter (isJust . avlLookup o . roomObjectsOf . nodeContent) . allNodes . roomsOf) =<< getDungeonState + +-- | Acquire the given object and put it in the player's inventory +acquireObject :: ObjectId -> ChattyDungeonM () +acquireObject i = do + rs <- roomOfObject i + case rs of + [r] -> do + o <- withRoom r $ removeRoomObject i + modifyPlayerState $ \s -> s{playerInventoryOf=avlInsert o $ playerInventoryOf s} + [] -> throwError CantSeeOneError + _ -> throwError WhichOneError + +-- | Drop the given object and remove it from the player's inventory +dropObject :: ObjectId -> ChattyDungeonM () +dropObject i = do + Just r <- (return . currentRoomOf) =<< getDungeonState + ps <- getPlayerState + let Just o = avlLookup i $ playerInventoryOf ps + putPlayerState ps{playerInventoryOf=avlRemove i $ playerInventoryOf ps} + insertRoomObject o diff --git a/src/Game/Antisplice/Templates.hs b/src/Game/Antisplice/Templates.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Templates.hs @@ -0,0 +1,113 @@ +{-# LANGUAGE TemplateHaskell, QuasiQuotes, FlexibleInstances, MultiParamTypeClasses, TypeSynonymInstances, FlexibleContexts, UndecidableInstances #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides (chatty-compatible) templates for automatical instance derivation. +module Game.Antisplice.Templates where + +import Language.Haskell.TH +import Text.Chatty.Templates +import Game.Antisplice.Utils.Fail +import Game.Antisplice.Utils.Run +import Game.Antisplice.Utils.Counter +import Game.Antisplice.Monad.Dungeon +import Game.Antisplice.Monad.Vocab +import Game.Antisplice.Utils.Atoms +import Control.Monad.Error.Class +import Control.Monad.Trans.Class +import Control.Monad.State.Class +import Control.Monad.IO.Class + +-- | Automatically derive an instance for 'MonadRoom' +mkRoom s = [d| + instance MonadRoom m => MonadRoom ($sx m) where + getRoomState = lift getRoomState + putRoomState = lift . putRoomState + |] + where sx = strToType s + +-- | Automatically derive an instance for 'MonadError e' +mkFail e s = [d| + instance (MonadError $ex m,Run $sx) => MonadError $ex ($sx m) where + throwError = lift . throwError + catchError = error "catchError not implemented for this type." + |] + where sx = strToType s + ex = strToType e + +-- | Automatically derive an instance for 'MonadDungeon' +mkDungeon s = [d| + instance MonadDungeon m => MonadDungeon ($sx m) where + getDungeonState = lift getDungeonState + putDungeonState = lift . putDungeonState + |] + where sx = strToType s + +-- | Automatically derive an instance for 'MonadCounter' +mkCounter s = [d| + instance MonadCounter m => MonadCounter ($sx m) where + countOn = lift countOn + |] + where sx = strToType s + +-- | Automatically derive an instance for 'MonadObject' +mkObject s = [d| + instance MonadObject m => MonadObject ($sx m) where + getObjectState = lift getObjectState + putObjectState = lift . putObjectState + |] + where sx = strToType s + +-- | Automatically derive an instance for 'MonadPlayer' +mkPlayer s = [d| + instance MonadPlayer m => MonadPlayer ($sx m) where + getPlayerState = lift getPlayerState + putPlayerState = lift . putPlayerState + |] + where sx = strToType s + +-- | Automatically derive an instance for 'MonadIO' +mkIO s = [d| + instance MonadIO m => MonadIO ($sx m) where + liftIO = lift . liftIO + |] + where sx = strToType s + +-- | Automatically derive an instance for 'MonadVocab' +mkVocab s = [d| + instance MonadVocab m => MonadVocab ($sx m) where + lookupVocab = lift . lookupVocab + insertVocab k = lift . insertVocab k + vocabKnown = lift . vocabKnown + |] + where sx = strToType s + +-- | Automatically derive an instance for 'MonadAtoms' +mkAtoms s = [d| + instance MonadAtoms m => MonadAtoms ($sx m) where + newAtom = lift newAtom + putAtom k = lift . putAtom k + getAtom = lift . getAtom + dispAtom = lift . dispAtom + cloneAtom = lift . cloneAtom + |] + where sx = strToType s diff --git a/src/Game/Antisplice/Terminal/Repl.hs b/src/Game/Antisplice/Terminal/Repl.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Terminal/Repl.hs @@ -0,0 +1,86 @@ +{-# LANGUAGE FlexibleContexts, ImpredicativeTypes #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a haskeline-based Read Eval Print Loop. +module Game.Antisplice.Terminal.Repl where + +import Text.Chatty.Printer +import Text.Chatty.Scanner +import Text.Chatty.Interactor +import Text.Chatty.Expansion +import Text.Chatty.Extended.Printer +import System.Chatty.Misc +import Game.Antisplice.Monad.Dungeon +import Game.Antisplice.Monad.Vocab +import Game.Antisplice.Monad +import Game.Antisplice.Errors +import Game.Antisplice.Lang +import Game.Antisplice.Utils.Fail +import Game.Antisplice.Utils.Counter +import Game.Antisplice.Utils.AVL +import Game.Antisplice.Utils.Atoms +import Control.Monad +import Control.Concurrent +import Control.Concurrent.MVar +import Control.Monad.Error.Class +import Control.Monad.IO.Class +import Data.Time.Clock +import System.Console.Haskeline +import System.Console.Haskeline.History + +-- | Read Eval Print Loop for Antisplice. +repl :: (ExtendedPrinter m,MonadScanner m,MonadError SplErr m,MonadIO m,MonadExpand m,ExpanderEnv m,MonadDungeon m,MonadAtoms m,MonadRoom m,MonadClock m,MonadVocab m) => m () +repl = do + mv <- liftIO (newEmptyMVar :: IO (MVar (Maybe String))) + cont <- liftIO (newEmptyMVar :: IO (MVar ())) + thr <- liftIO $ forkOS $ runInputT defaultSettings{autoAddHistory=True} $ forever $ do + liftIO $ takeMVar cont + rl <- getInputLine "> " + liftIO $ putMVar mv rl + liftIO $ putMVar cont () + forever $ do + e <- runFailT $ forever $ do + ds <- getDungeonState + now <- mgetstamp + let ts = takeWhile (( do + l' <- expand l + e <- runFailT (act l') + case e of + Right _ -> return () + Left VerbMustFirstError -> mprintLn "Please start with a verb." + Left UnintellegibleError -> mprintLn "I don't understand that." + Left CantWalkThereError -> mprintLn "I can't walk there." + Left WhichOneError -> mprintLn "Which one do you mean?" + Left CantSeeOneError -> mprintLn "I can't see one here." + Left e -> throwError e + throwError DoneError + Just Nothing -> liftIO (killThread thr) >> mprintLn "quit" >> throwError QuitError + Nothing -> liftIO $ threadDelay 100 + case e of + Left DoneError -> liftIO $ putMVar cont () + Left e -> throwError e diff --git a/src/Game/Antisplice/Utils/AVL.hs b/src/Game/Antisplice/Utils/AVL.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Utils/AVL.hs @@ -0,0 +1,159 @@ +{-# LANGUAGE MultiParamTypeClasses, FlexibleInstances #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides an AVL tree. +module Game.Antisplice.Utils.AVL (avlMax,avlMin,avlLookup,avlHeight,avlSize,avlInsert,avlRemove,AVL (EmptyAVL,AVL),avlRoot,avlPreorder,avlPostorder,avlInorder) where + +import Game.Antisplice.Utils.BST + +instance Indexable i o v => AnyBST AVL i o v where + anyBstMax = avlMax + anyBstMin = avlMin + anyBstLookup = avlLookup + anyBstEmpty = EmptyAVL + anyBstInsert = avlInsert + anyBstRemove = avlRemove + +-- | An AVL tree. +data AVL a = EmptyAVL | AVL a Int Int !(AVL a) !(AVL a) + +-- | Get the greatest element. +avlMax :: AVL i -> Maybe i +avlMax EmptyAVL = Nothing +avlMax (AVL a _ _ _ EmptyAVL) = Just a +avlMax (AVL _ _ _ _ r) = avlMax r + +-- | Get the least element. +avlMin :: AVL i -> Maybe i +avlMin EmptyAVL = Nothing +avlMin (AVL a _ _ EmptyAVL _) = Just a +avlMin (AVL _ _ _ l _) = avlMin l + +-- | Lookup a given key. +avlLookup :: Indexable i o v => o -> AVL i -> Maybe v +avlLookup _ EmptyAVL = Nothing +avlLookup o (AVL a _ _ l r) + | o == indexOf a = Just $ valueOf a + | o < indexOf a = avlLookup o l + | o > indexOf a = avlLookup o r + +-- | Get the height of the tree. +avlHeight :: AVL i -> Int +avlHeight EmptyAVL = 0 +avlHeight (AVL _ _ h _ _) = h + +-- | Get the size of the tree. +avlSize :: AVL i -> Int +avlSize EmptyAVL = 0 +avlSize (AVL _ s _ _ _) = s + +avlBalance :: AVL i -> AVL i +avlBalance EmptyAVL = EmptyAVL +avlBalance t@(AVL a _ _ l r) + | abs (avlHeight l - avlHeight r) < 2 = t + | avlHeight l < avlHeight r = case r of + AVL a1 _ _ l1 r1 -> + let child = AVL a (findSize l l1) (findHeight l l1) l l1 + in AVL a1 (findSize child r1) (findHeight child r1) child r1 + | otherwise = case l of + AVL a1 _ _ l1 r1 -> + let child = AVL a (findSize r1 r) (findHeight r1 r) r1 r + in AVL a1 (findSize l1 child) (findHeight l1 child) l1 child + +findSize :: AVL i -> AVL i -> Int +findSize a b = 1 + avlSize a + avlSize b + +findHeight :: AVL i -> AVL i -> Int +findHeight a b = 1 + max (avlHeight a) (avlHeight b) + +-- | Insert into the tree. +avlInsert :: Indexable i o v => i -> AVL i -> AVL i +avlInsert a EmptyAVL = AVL a 1 1 EmptyAVL EmptyAVL +avlInsert a (AVL a1 s h l r) + | indexOf a == indexOf a1 = AVL a s h l r + | indexOf a < indexOf a1 = + let l' = avlInsert a l + in avlBalance $ AVL a1 (s+1) (findHeight l' r) l' r + | otherwise = + let r' = avlInsert a r + in avlBalance $ AVL a1 (s+1) (findHeight l r') l r' + +-- | Remove from the tree. +avlRemove :: Indexable i o v => o -> AVL i -> AVL i +avlRemove _ EmptyAVL = EmptyAVL +avlRemove o t@(AVL a _ _ EmptyAVL EmptyAVL) + | indexOf a == o = EmptyAVL + | otherwise = t +avlRemove o t@(AVL a _ _ l r) + | indexOf a == o = + case t of + AVL _ _ _ EmptyAVL _ -> case getLeft r of + (Just a',r') -> avlBalance $ AVL a' (findSize EmptyAVL r') (findHeight EmptyAVL r') EmptyAVL r' + _ -> case getRight l of + (Just a',l') -> avlBalance $ AVL a' (findSize l' r) (findHeight l' r) l' r + | o < indexOf a = + let l' = avlRemove o l + in avlBalance $ AVL a (findSize l' r) (findHeight l' r) l' r + | otherwise = + let r' = avlRemove o r + in avlBalance $ AVL a (findSize l r') (findHeight l r') l r' + +getLeft :: AVL i -> (Maybe i,AVL i) +getLeft EmptyAVL = (Nothing,EmptyAVL) +getLeft (AVL a _ _ EmptyAVL EmptyAVL) = (Just a,EmptyAVL) +getLeft (AVL a _ _ EmptyAVL r) = (Just a,r) +getLeft (AVL a _ _ l r) = + case getLeft l of + (p, t2) -> (p, AVL a (findSize r t2) (findHeight r t2) t2 r) + +getRight :: AVL i -> (Maybe i,AVL i) +getRight EmptyAVL = (Nothing,EmptyAVL) +getRight (AVL a _ _ EmptyAVL EmptyAVL) = (Just a,EmptyAVL) +getRight (AVL a _ _ l EmptyAVL) = (Just a,l) +getRight (AVL a _ _ l r) = + case getRight r of + (p, t2) -> (p, AVL a (findSize l t2) (findHeight l t2) l t2) + +instance Functor AVL where + fmap _ EmptyAVL = EmptyAVL + fmap f (AVL a s h l r) = AVL (f a) s h (fmap f l) (fmap f r) + +-- | Get the root of the tree. +avlRoot :: AVL i -> i +avlRoot EmptyAVL = error "Trying to get the root of an empty AVL tree." +avlRoot (AVL a _ _ _ _) = a + +-- | Traverse the tree, order (head, left, right) +avlPreorder :: AVL i -> [i] +avlPreorder EmptyAVL = [] +avlPreorder (AVL a _ _ l r) = a : avlPreorder l ++ avlPreorder r + +-- | Traverse the tree, order (left, right, head) +avlPostorder :: AVL i -> [i] +avlPostorder EmptyAVL = [] +avlPostorder (AVL a _ _ l r) = avlPostorder l ++ avlPostorder r ++ [a] + +-- | Traverse the tree, order (left, head, right) +avlInorder :: AVL i -> [i] +avlInorder EmptyAVL = [] +avlInorder (AVL a _ _ l r) = avlInorder l ++ [a] ++ avlInorder r diff --git a/src/Game/Antisplice/Utils/Atoms.hs b/src/Game/Antisplice/Utils/Atoms.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Utils/Atoms.hs @@ -0,0 +1,104 @@ +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a variable-storing monad and functions for access (they almost form an arrow) +module Game.Antisplice.Utils.Atoms where + +import Control.Arrow +import qualified Control.Category as C +import Control.Monad +import Control.Monad.Trans.Class +import Control.Monad.IO.Class +import Data.Dynamic +import Data.Typeable +import Game.Antisplice.Utils.AVL +import Game.Antisplice.Utils.Counter + +-- | Phantom type for atom IDs +newtype Atom a = Atom Int deriving (Ord,Eq) + +-- | The storage monad +newtype AtomStoreT m a = AtomStore { runAtomStoreT :: AVL (Int,Dynamic) -> m (a,AVL (Int,Dynamic)) } + +instance Functor m => Functor (AtomStoreT m) where + fmap f a = AtomStore $ \s -> fmap (first f) $ runAtomStoreT a s + +instance Monad m => Monad (AtomStoreT m) where + return a = AtomStore $ \s -> return (a,s) + m >>= f = AtomStore $ \s -> do (a,s') <- runAtomStoreT m s; runAtomStoreT (f a) s' + +instance MonadTrans AtomStoreT where + lift m = AtomStore $ \s -> do a <- m; return (a,s) + +instance MonadIO m => MonadIO (AtomStoreT m) where + liftIO = lift . liftIO + +instance MonadCounter m => MonadCounter (AtomStoreT m) where + countOn = lift countOn + +-- | Typeclass for all atom-storing monads. +class MonadCounter m => MonadAtoms m where + -- | Reserve a new atom. + newAtom :: Typeable v => m (Atom v) + -- | Save a value for the given atom. + putAtom :: Typeable v => Atom v -> v -> m () + -- | Get the value from a given atom. + getAtom :: Typeable v => Atom v -> m v + -- | Dispose the given atom. + dispAtom :: Atom v -> m () + -- | Clone the given atom. + cloneAtom :: Typeable v => Atom v -> m (Atom v) + cloneAtom a = do + b <- newAtom + v <- getAtom a + putAtom b v + return b + +instance (Functor m,MonadCounter m) => MonadAtoms (AtomStoreT m) where + newAtom = fmap Atom $ lift countOn + putAtom (Atom a) v = AtomStore $ \s -> return ((),avlInsert (a,toDyn v) s) + getAtom (Atom a) = AtomStore $ \s -> let Just v = avlLookup a s in return (fromDyn v undefined,s) + dispAtom (Atom a) = AtomStore $ \s -> return ((),avlRemove a s) + +-- | Atomar operation (almost arrow) +newtype (Typeable a,Typeable b) => Atomar m a b = Atomar { runAtomar :: Atom a -> m (Atom b) } + +{-instance MonadAtoms m => C.Category (Atomar m) where + id = Atomar return + a . b = Atomar (runAtomar a <=< runAtomar b) + +instance MonadAtoms m => Arrow (Atomar m) where + arr = Atomar . mapAtom + first f = Atomar $ \a -> do + b <- cloneAtom a + b' <- mapAtom fst b + c <- runAtomar f b' + v <- getAtom c + mapAtom (first $ const v) a + dispAtom c-} + +-- | Run a pure function on atoms. +mapAtom :: (Typeable a, Typeable b, MonadAtoms m) => (a -> b) -> Atom a -> m (Atom b) +mapAtom f (Atom a) = do + v <- getAtom (Atom a) + putAtom (Atom a) $ f v + return (Atom a) + diff --git a/src/Game/Antisplice/Utils/BST.hs b/src/Game/Antisplice/Utils/BST.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Utils/BST.hs @@ -0,0 +1,110 @@ +{-# LANGUAGE MultiParamTypeClasses, FlexibleInstances, FunctionalDependencies, TypeFamilies #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a typeclass for all binary search trees and an unbalanced implementation +module Game.Antisplice.Utils.BST where + +-- | Only instances of Indexable may be saved in a BST +class Ord o => Indexable i o v | i -> o, i -> v where + type IndexOf i + type ValueOf i + -- | Extract the index + indexOf :: i -> o + -- | Extract the value + valueOf :: i -> v + +instance Indexable Int Int Int where + type IndexOf Int = Int + type ValueOf Int = Int + indexOf = id + valueOf = id + +instance Ord o => Indexable (o,a) o a where + type IndexOf (o,a) = o + type ValueOf (o,a) = a + indexOf = fst + valueOf = snd + +-- | Typeclass for all BSTs that store the given Indexable +class Indexable i o v => AnyBST t i o v where + -- | Insert into the tree + anyBstInsert :: i -> t i -> t i + -- | Remove from the tree + anyBstRemove :: o -> t i -> t i + -- | Get the greatest element + anyBstMax :: t i -> Maybe i + -- | Get the least element + anyBstMin :: t i -> Maybe i + -- | Lookup a given key + anyBstLookup :: o -> t i -> Maybe v + -- | An empty tree + anyBstEmpty :: t i + +instance Indexable i o v => AnyBST BST i o v where + anyBstInsert = bstInsert + anyBstRemove = bstRemove + anyBstMax = bstMax + anyBstMin = bstMin + anyBstLookup = bstLookup + anyBstEmpty = EmptyBST + +-- | An unbalanced binary search tree +data BST a = EmptyBST | BST a !(BST a) !(BST a) + +-- | Insert into the BST +bstInsert :: Indexable i o v => i -> BST i -> BST i +bstInsert i EmptyBST = BST i EmptyBST EmptyBST +bstInsert i (BST a l r) + | indexOf i < indexOf a = BST a (bstInsert i l) r + | indexOf i > indexOf a = BST a l (bstInsert i r) + | otherwise = BST i l r + +-- | Remove from the BST +bstRemove :: Indexable i o v => o -> BST i -> BST i +bstRemove o EmptyBST = EmptyBST +bstRemove o (BST a EmptyBST r) | indexOf a == o = r +bstRemove o (BST a l EmptyBST) | indexOf a == o = l +bstRemove o (BST a l r) + | indexOf a < o = BST a (bstRemove o l) r + | indexOf a > o = BST a l (bstRemove o r) + | otherwise = let (Just m) = bstMax l in BST m (bstRemove (indexOf m) l) r + +-- | Get the greatest element +bstMax :: BST i -> Maybe i +bstMax EmptyBST = Nothing +bstMax (BST a _ EmptyBST) = Just a +bstMax (BST _ _ r) = bstMax r + +-- | Get the least element +bstMin :: BST i -> Maybe i +bstMin EmptyBST = Nothing +bstMin (BST a EmptyBST _) = Just a +bstMin (BST _ l _) = bstMin l + +-- | Lookup a given key +bstLookup :: Indexable i o v => o -> BST i -> Maybe v +bstLookup _ EmptyBST = Nothing +bstLookup o (BST a l r) + | o == indexOf a = Just $ valueOf a + | o < indexOf a = bstLookup o l + | o > indexOf a = bstLookup o r diff --git a/src/Game/Antisplice/Utils/Counter.hs b/src/Game/Antisplice/Utils/Counter.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Utils/Counter.hs @@ -0,0 +1,52 @@ +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a counter monad. +module Game.Antisplice.Utils.Counter where + +import Control.Arrow +import Control.Monad +import Control.Monad.Trans.Class + +-- | A counter monad. +newtype CounterT m a = Counter { runCounterT :: Int -> m (a,Int) } + +instance Functor m => Functor (CounterT m) where + fmap f a = Counter $ \s -> fmap (first f) $ runCounterT a s + +instance Monad m => Monad (CounterT m) where + return a = Counter $ \s -> return (a,s) + m >>= f = Counter $ \s -> do (a,s') <- runCounterT m s; runCounterT (f a) s' + +instance MonadTrans CounterT where + lift m = Counter $ \s -> do a <- m; return (a,s) + +-- | Typeclass for all counter monads. +class Monad m => MonadCounter m where + -- | Tell the current number and increment it + countOn :: m Int + +instance Monad m => MonadCounter (CounterT m) where + countOn = Counter $ \s -> return (s,s+1) + +-- | Run the given function inside a counter +withCounter :: (Monad m,Functor m) => CounterT m a -> m a +withCounter m = fmap fst $ runCounterT m 0 diff --git a/src/Game/Antisplice/Utils/Fail.hs b/src/Game/Antisplice/Utils/Fail.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Utils/Fail.hs @@ -0,0 +1,60 @@ +{-# LANGUAGE FlexibleInstances, MultiParamTypeClasses #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a monad for error handling. Okay, I confess it's equal to ErrorT... +module Game.Antisplice.Utils.Fail where + +import Control.Monad +import Control.Monad.Error.Class +import Control.Monad.Trans.Class + +-- | The error handling monad. +newtype FailT e m a = Fail { runFailT :: m (Either e a) } + +instance Monad m => Functor (FailT e m) where + fmap f a = Fail $ do + v <- runFailT a + case v of + Left e -> return $ Left e + Right x -> return $ Right (f x) + +instance Monad m => Monad (FailT e m) where + return a = Fail $ return $ Right a + m >>= f = Fail $ do + v <- runFailT m + case v of + Left e -> return $ Left e + Right x -> runFailT $ f x + +instance MonadTrans (FailT e) where + lift m = Fail $ do + a <- m + return $ Right a + +instance Monad m => MonadError e (FailT e m) where + throwError e = Fail $ return $ Left e + catchError m h = Fail $ do + v <- runFailT m + case v of + Left e -> runFailT $ h e + Right x -> return v diff --git a/src/Game/Antisplice/Utils/Graph.hs b/src/Game/Antisplice/Utils/Graph.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Utils/Graph.hs @@ -0,0 +1,142 @@ +{-# LANGUAGE MultiParamTypeClasses, TypeFamilies #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a general graph. +module Game.Antisplice.Utils.Graph where + +import Game.Antisplice.Utils.BST +import Game.Antisplice.Utils.AVL + +-- | Phantom type for a node ID +newtype NodeId = NodeId Int deriving (Eq,Show,Ord) + +-- | A general graph +data Graph a b = Graph { nodes :: AVL (Node a), edges :: [Edge b], nextId :: NodeId } + +-- | A node for the graph +data Node a = Node { nodeMarked :: Bool, nodeContent :: a, nodeId :: NodeId } + +-- | An edge for the graph +data Edge b = Edge { fromNode :: NodeId, toNode :: NodeId, weight :: Int, label :: b } + +instance Indexable (Node a) NodeId (Node a) where + type IndexOf (Node a) = NodeId + type ValueOf (Node a) = Node a + indexOf = nodeId + valueOf = id + +--instance (Show a,Show b) => Show (Graph a b) where +-- show (Graph ns es _) = unlines (map show (reverse ns) ++ map show es) + +instance (Show a) => Show (Node a) where + show (Node _ c i) = concat [show i, ": ", show c] + +instance (Show b) => Show (Edge b) where + show (Edge f t w l) = concat [show f, " --", show l, "-> ", show t, " [", show w, "]"] + +-- | Increment a NodeId +incId :: NodeId -> NodeId +incId (NodeId i) = NodeId (i+1) + +-- | An empty graph +emptyGraph :: Graph a b +emptyGraph = Graph EmptyAVL [] (NodeId 0) + +-- | Add a node to the graph +addNode :: a -> Graph a b -> Graph a b +addNode x = snd . addNode' x + +-- | Add a node to the graph and also return its ID +addNode' :: a -> Graph a b -> (NodeId,Graph a b) +addNode' x (Graph ns es nid) = (nid, Graph (avlInsert (Node False x nid) ns) es (incId nid)) + +-- | Add a bunch of nodes +addNodes :: [a] -> Graph a b -> Graph a b +addNodes xs = snd . addNodes' xs + +-- | Add a bunch of nodes and also return their IDs +addNodes' :: [a] -> Graph a b -> ([NodeId],Graph a b) +addNodes' [] g = ([],g) +addNodes' (p:ps) g = let (ls, g'') = addNodes' ps g' + (l, g') = addNode' p g + in (l:ls, g'') + +-- | Return all nodes +allNodes :: Graph a b -> [Node a] +allNodes = avlInorder . nodes + +-- | Return the node in the AVL tree's root +rootNode :: Graph a b -> NodeId +rootNode = nodeId . avlRoot . nodes + +-- | Add a unidirectional edge to the graph (provide both nodes, a weight and a label) +addEdge :: NodeId -> NodeId -> Int -> b -> Graph a b -> Graph a b +addEdge f t w l = addEdge' (Edge f t w l) + +-- | Add a unidirectional edge to the graph (provide the 'Edge') +addEdge' :: Edge b -> Graph a b -> Graph a b +addEdge' e g = g{edges=e:edges g} + +-- | Add a bidirectional edge to the graph (provide both nodes, a weight and a label) +addMutualEdge :: NodeId -> NodeId -> Int -> b -> Graph a b -> Graph a b +addMutualEdge f t w l = addEdge f t w l . addEdge t f w l + +-- | Add a bunch of edges unidirectionally (provide both nodes, a weight and a label) +addEdges :: [(NodeId,NodeId,Int,b)] -> Graph a b -> Graph a b +addEdges es g = foldr (addEdge' . (\(f,t,w,l) -> Edge f t w l)) g es + +-- | Add a bunch of edges unidirectionally (provide the 'Edge's) +addEdges' :: [Edge b] -> Graph a b -> Graph a b +addEdges' = flip $ foldr addEdge' + +-- | Add a bunch of edges bidirectionally (provide both nodes, a weight and a label) +addMutualEdges :: [(NodeId,NodeId,Int,b)] -> Graph a b -> Graph a b +addMutualEdges es = addEdges es . addEdges (map (\(f,t,w,l) -> (t,f,w,l)) es) + +-- | Get the node's content from its ID +getNode :: NodeId -> Graph a b -> a +getNode n = nodeContent . getNode' n + +-- | Get the 'Node' object from its ID +getNode' :: NodeId -> Graph a b -> Node a +getNode' n = (\(Just x) -> x) . avlLookup n . nodes + +-- | Set the node's content by its ID +setNode :: NodeId -> a -> Graph a b -> Graph a b +setNode n a g@(Graph ns _ _) = g{nodes=fmap setNode' ns} + where setNode' (Node m c i) = if i == n then Node m a i else Node m c i + +-- | Mark a node by its ID +markNode :: NodeId -> Graph a b -> Graph a b +markNode n g@(Graph ns _ _) = g{nodes=fmap markNode' ns} + where markNode' (Node m c i) = if i == n then Node True c i else Node m c i + +-- | Follow an edge by its source node and label +followEdge :: Eq b => NodeId -> b -> Graph a b -> Maybe NodeId +followEdge n l g = case filter ((==l).label) $ filter ((==n).fromNode) $ edges g of + [] -> Nothing + (x:_) -> Just (toNode x) + +-- | List all edges from the given node +listEdges :: NodeId -> Graph a b -> [(b,NodeId)] +listEdges n g = fmap (\(Edge _ t _ l) -> (l,t)) $ filter ((==n).fromNode) $ edges g diff --git a/src/Game/Antisplice/Utils/Run.hs b/src/Game/Antisplice/Utils/Run.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Utils/Run.hs @@ -0,0 +1,47 @@ +{-# LANGUAGE TypeFamilies #-} + +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a generalized way of running newtypes. +module Game.Antisplice.Utils.Run where + +import Control.Monad +import Control.Monad.Trans.Class +import Game.Antisplice.Utils.Fail +import Game.Antisplice.Monad.Dungeon + +-- | Typeclass for all runnable newtype 'MonadTrans'ers +class MonadTrans t => Run t where + type Baretype t m a + run :: Monad m => t m a -> Baretype t m a + +instance Run (FailT e) where + type Baretype (FailT e) m a = m (Either e a) + run = runFailT + +instance Run DungeonT where + type Baretype DungeonT m a = DungeonState -> m (a,DungeonState) + run = runDungeonT + +instance Run RoomT where + type Baretype RoomT m a = RoomState -> m (a,RoomState) + run = runRoomT diff --git a/src/Game/Antisplice/Utils/TST.hs b/src/Game/Antisplice/Utils/TST.hs new file mode 100644 --- /dev/null +++ b/src/Game/Antisplice/Utils/TST.hs @@ -0,0 +1,51 @@ +{- + This module is part of Antisplice. + Copyleft (c) 2014 Marvin Cohrs + + All wrongs reversed. Sharing is an act of love, not crime. + Please share Antisplice with everyone you like. + + Antisplice 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. + + Antisplice 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 Antisplice. If not, see . +-} + +-- | Provides a ternary search trie +module Game.Antisplice.Utils.TST where + +import Data.Maybe + +-- | A ternary search trie +data TST a = EmptyTST | TST Char (Maybe a) (TST a) (TST a) (TST a) + +-- | Insert something into the TST +tstInsert :: String -> a -> TST a -> TST a +tstInsert (c:[]) a EmptyTST = TST c (Just a) EmptyTST EmptyTST EmptyTST +tstInsert (c:cs) a EmptyTST = TST c Nothing (tstInsert cs a EmptyTST) EmptyTST EmptyTST +tstInsert cs a (TST c1 a1 f l r) + | head cs < c1 = TST c1 a1 f (tstInsert cs a l) r + | head cs > c1 = TST c1 a1 f l (tstInsert cs a r) + | cs == [c1] = TST c1 (Just a) f l r + | otherwise = TST c1 a1 (tstInsert (tail cs) a f) l r + +-- | Lookup some string in the TST +tstLookup :: String -> TST a -> Maybe a +tstLookup _ EmptyTST = Nothing +tstLookup cs (TST c1 a1 f l r) + | head cs < c1 = tstLookup cs l + | head cs > c1 = tstLookup cs r + | cs == [c1] = a1 + | otherwise = tstLookup (tail cs) f + +-- | Check if the TST contains the given key +tstContains :: String -> TST a -> Bool +tstContains cs = isJust . tstLookup cs