Liquorice (empty) → 0.0.1
raw patch · 13 files changed
+2504/−0 lines, 13 filesdep +HTFdep +basedep +binarysetup-changedbinary-added
Dependencies added: HTF, base, binary, bytestring, mtl
Files
- COPYING +674/−0
- Liquorice.cabal +54/−0
- Liquorice.hs +118/−0
- Liquorice/Line.hs +182/−0
- Liquorice/Monad.hs +191/−0
- Liquorice/Pure.hs +261/−0
- Liquorice/Render.hs +193/−0
- Liquorice/Wad.hs +239/−0
- README.md +136/−0
- Setup.hs +2/−0
- TestMain.hs +18/−0
- examples/birds.hs +436/−0
- logo.png binary
+ COPYING view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU General Public License is a free, copyleft license for+software and other kinds of works.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+the GNU General Public License is intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users. We, the Free Software Foundation, use the+GNU General Public License for most of our software; it applies also to+any other work released this way by its authors. You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++ To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights. Therefore, you have+certain responsibilities if you distribute copies of the software, or if+you modify it: responsibilities to respect the freedom of others.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received. You must make sure that they, too, receive+or can get the source code. And you must show them these terms so they+know their rights.++ Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++ For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software. For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++ Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the manufacturer+can do so. This is fundamentally incompatible with the aim of+protecting users' freedom to change the software. The systematic+pattern of such abuse occurs in the area of products for individuals to+use, which is precisely where it is most unacceptable. Therefore, we+have designed this version of the GPL to prohibit the practice for those+products. If such problems arise substantially in other domains, we+stand ready to extend this provision to those domains in future versions+of the GPL, as needed to protect the freedom of users.++ Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish to+avoid the special danger that patents applied to a free program could+make it effectively proprietary. To prevent this, the GPL assures that+patents cannot be used to render the program non-free.++ The precise terms and conditions for copying, distribution and+modification follow.++ TERMS AND CONDITIONS++ 0. Definitions.++ "This License" refers to version 3 of the GNU General Public License.++ "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++ "The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++ To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy. The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++ A "covered work" means either the unmodified Program or a work based+on the Program.++ To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++ To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++ An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++ 1. Source Code.++ The "source code" for a work means the preferred form of the work+for making modifications to it. "Object code" means any non-source+form of a work.++ A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++ The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++ The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++ The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++ The Corresponding Source for a work in source code form is that+same work.++ 2. Basic Permissions.++ All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++ You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force. You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright. Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++ Conveying under any other circumstances is permitted solely under+the conditions stated below. Sublicensing is not allowed; section 10+makes it unnecessary.++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++ No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++ When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++ 4. Conveying Verbatim Copies.++ You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++ You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++ 5. Conveying Modified Source Versions.++ You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++ a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.++ b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under section+ 7. This requirement modifies the requirement in section 4 to+ "keep intact all notices".++ c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.++ d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++ A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++ 6. Conveying Non-Source Forms.++ You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++ a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.++ b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the+ Corresponding Source from a network server at no charge.++ c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.++ d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.++ e) Convey the object code using peer-to-peer transmission, provided+ you inform other peers where the object code and Corresponding+ Source of the work are being offered to the general public at no+ charge under subsection 6d.++ A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++ A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling. In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage. For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product. A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++ "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source. The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++ If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++ The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed. Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++ Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++ 7. Additional Terms.++ "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++ When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++ Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++ a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or++ b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or++ c) Prohibiting misrepresentation of the origin of that material, or+ requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or++ d) Limiting the use for publicity purposes of names of licensors or+ authors of the material; or++ e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or++ f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions of+ it) with contractual assumptions of liability to the recipient, for+ any liability that these contractual assumptions directly impose on+ those licensors and authors.++ All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++ If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++ Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++ 8. Termination.++ You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++ However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++ Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++ Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++ 9. Acceptance Not Required for Having Copies.++ You are not required to accept this License in order to receive or+run a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++ 10. Automatic Licensing of Downstream Recipients.++ Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++ An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++ You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++ 11. Patents.++ A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++ A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++ Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++ In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++ If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++ If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++ A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License. You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++ Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++ 12. No Surrender of Others' Freedom.++ If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all. For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++ 13. Use with the GNU Affero General Public License.++ Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU General Public License from time to time. Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++ Each version is given a distinguishing version number. If the+Program specifies that a certain numbered version of the GNU General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation. If the Program does not specify a version number of the+GNU General Public License, you may choose any version ever published+by the Free Software Foundation.++ If the Program specifies that a proxy can decide which future+versions of the GNU General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation, either version 3 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License+ along with this program. If not, see <http://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If the program does terminal interaction, make it output a short+notice like this when it starts in an interactive mode:++ <program> Copyright (C) <year> <name of author>+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, your program's commands+might be different; for a GUI interface, you would use an "about box".++ You should also get your employer (if you work as a programmer) or school,+if any, to sign a "copyright disclaimer" for the program, if necessary.+For more information on this, and how to apply and follow the GNU GPL, see+<http://www.gnu.org/licenses/>.++ The GNU General Public License does not permit incorporating your program+into proprietary programs. If your program is a subroutine library, you+may consider it more useful to permit linking proprietary applications with+the library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License. But first, please read+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ Liquorice.cabal view
@@ -0,0 +1,54 @@+name: Liquorice+version: 0.0.1+synopsis: Algorithmic Doom map generation+description: A system for constructing maps for the computer game Doom+ by writing algorithms to describe the geometry. A Liquorice+ program is a series of instructions to move a virtual+ "turtle" or "pen", which define the walls, floors, rooms+ and monsters as it goes.+homepage: https://jmtd.net/doom/liquorice/+bug-reports: https://github.com/jmtd/liquorice/issues+license: GPL-3+license-file: COPYING+author: Jonathan Dowland+maintainer: jon+hackage@dow.land+copyright: © 2020 Jonathan Dowland+category: Game+build-type: Simple+cabal-version: 1.18+extra-doc-files: README.md, examples/birds.hs, logo.png++test-suite test-hwadc+ hs-source-dirs: .+ type: exitcode-stdio-1.0+ Main-is: TestMain.hs+ build-depends: base >= 4.11.1 && < 4.13,+ binary >= 0.8.5 && < 0.9,+ bytestring >= 0.10.8 && < 0.11,+ HTF >= 0.13.2 && < 0.14,+ mtl >= 2.2.2 && < 2.3+ Default-language: Haskell98+ other-modules: Liquorice,+ Liquorice.Wad,+ Liquorice.Line,+ Liquorice.Monad,+ Liquorice.Pure,+ Liquorice.Render+library+ exposed-modules: Liquorice,+ Liquorice.Wad,+ Liquorice.Line,+ Liquorice.Monad,+ Liquorice.Pure,+ Liquorice.Render+ build-depends: base >= 4.11.1 && < 4.13,+ binary,+ bytestring,+ HTF,+ mtl+ Default-language: Haskell98+ hs-source-dirs: .++source-repository head+ type: git+ location: https://github.com/jmtd/liquorice/
+ Liquorice.hs view
@@ -0,0 +1,118 @@+{-# OPTIONS_GHC -F -pgmF htfpp #-}+{-# OPTIONS_HADDOCK prune #-}++{-|+Module : Liquorice+Description : Liquorice fundamental data-types.+Copyright : © Jonathan Dowland, 2020+License : GPL-3+Maintainer : jon+hackage@dow.land+Stability : experimental+Portability : POSIX++The Liquorice fundamental data-types.+-}+module Liquorice+ (+ Context(..)+ , Point+ , Orientation(..)+ , prev+ , next+ , Thing(..)+ , Sector(..)++ , start++ , htf_thisModulesTests+ ) where++import Test.Framework+import Data.Function ((&))+import Data.List (nub)++import Liquorice.Line++-- | Utility function, a wrapping alternative to `succ`.+next :: (Eq a, Bounded a, Enum a) => a -> a+next a = if a == maxBound then minBound else succ a++-- | Utility function, a wrapping alternative to `pred`.+prev :: (Eq a, Bounded a, Enum a) => a -> a+prev a = if a == minBound then maxBound else pred a++-- | Possible orientations for the Pen: The four cardinal directions.+data Orientation = North | East | South | West deriving (Show, Eq, Enum, Bounded)++-- | A `Context` holds the entirety of all geometry that has been defined at+-- a point in a program: properties of the Pen: `location` and `orientation`;+-- "Palette"-like properties of the Pen: the current thing Type, textures for+-- parts of `Line`s and `Sector`s, etc.;+-- Lists of geometric objects (`linedefs`,`sectors`,`things`).+data Context = Context { location :: Point+ , orientation :: Orientation++ , linedefs :: [Line]+ , sectors :: [Sector]+ , things :: [Thing]++ -- "palette": thing type; texture choices, etc+ , curThingType :: Int+ , paletteTop :: String+ , paletteMid :: String+ , paletteBot :: String+ , paletteFloor :: String+ , paletteCeil :: String+ , paletteLineType :: Int+ , paletteLineTag :: Int+ , paletteSectorType :: Int+ , paletteSectorTag :: Int+ , paletteXoff :: Int+ , paletteYoff :: Int+ , mapName :: String++ } deriving (Show, Eq)++-- | An approximation of Doom's Sector data-type, with unboxed fields.+-- Unlike Doom's Sector data structure, we maintain a list of lines+-- that belong to a given Sector.+data Sector = Sector { floorHeight :: Int+ , ceilHeight :: Int+ , floorFlat :: String+ , ceilFlat :: String+ , lightLevel :: Int+ , sectorType :: Int+ , sectorTag :: Int+ , sectorLines :: [Line]+ } deriving (Show, Eq)+-- XXX all are short (unsigned?) ints, 8 byte strings++-- | An approximation of Doom's Thing data-type, with unboxed fields.+data Thing = Thing { thingPos :: Point+ , thingAngle :: Int -- all shorts+ , thingType :: Int+ , thingFlags :: Int+ } deriving (Show, Eq)++-- | An initial Context, from which to derive a new map. `Empty` lines+-- and `Sector` lists and sensible default values for "palette" parameters.+start :: Context+start = Context { location=(0,0)+ , orientation=North+ , linedefs=[]+ , sectors=[]+ , curThingType=1+ , things=[]+ , paletteTop="STARTAN3"+ , paletteMid="STARTAN3"+ , paletteBot="STARTAN3"+ , paletteFloor="FLAT23"+ , paletteCeil="F_SKY1"+ , paletteLineType=0+ , paletteLineTag=0+ , paletteSectorType=0+ , paletteSectorTag=0+ , mapName="MAP01"+ , paletteXoff=0+ , paletteYoff=0+ }
+ Liquorice/Line.hs view
@@ -0,0 +1,182 @@+{-# OPTIONS_GHC -F -pgmF htfpp #-}+{-# OPTIONS_HADDOCK prune #-}++{-|+Module : Liquorice.Line+Description : Functions for manipulating Lines.+Copyright : © Jonathan Dowland, 2020+License : GPL-3+Maintainer : jon+hackage@dow.land+Stability : experimental+Portability : POSIX++The Point and Line data-types and functions for manipulating Lines.+-}+module Liquorice.Line( Line(..)+ , Point+ , flipline+ , splitLine+ , checkIntersect+ , splitLines++ , htf_thisModulesTests+ ) where++import Data.List+import Test.Framework+import Control.Monad++-- | A 2D coordinate.+type Point = (Int, Int)++-- | The Line data-type corresponds closely to the Doom equivalent but+-- has with unboxed fields.+data Line = Line { from :: Point+ , to :: Point+ , lineTop :: String+ , lineMid :: String+ , lineBot :: String+ , lineType:: Int+ , lineTag :: Int+ , lineXoff:: Int+ , lineYoff:: Int+ } deriving (Show, Eq)++-- | Swap a `Line`'s direction.+flipline :: Line -> Line+flipline l = l { from = to l, to = from l }++-- | Ordering function for `Line`s.+lineOrient :: Line -> Ordering+lineOrient l = let (a,b) = (from l, to l) in if a < b then GT else LT++-- | Do the supplied `Line`s intersect?+checkIntersect :: Line -> Line -> Bool+checkIntersect a b = (sameXAxis a b || sameYAxis a b) && newCheckIntersect a b++-- | Are the supplied `Line`s on the same point on the X axis?+sameXAxis x y = all (==(fst (from x))) (map fst [to x, from y, to y])++-- | Are the supplied `Line`s on the same point on the Y axis?+sameYAxis x y = all (==(snd (from x))) (map snd [to x, from y, to y])++-- | Utility function for `checkIntersect`. Check whether two `Line`s on the+-- same plane intersect or not.+-- takes advantage of tuple `Ord`.+newCheckIntersect :: Line -> Line -> Bool+newCheckIntersect l1 l2 = let nl1 = normalizeLine l1+ nl2 = normalizeLine l2+ (x1,y1) = (from nl1, to nl1)+ (x2,y2) = (from nl2, to nl2)+ in x2 >= x1 && x2 < y1 || -- start of line2 within line1+ y2 > x1 && y2 <= y1 || -- end of line2 within line1+ x2 <= x1 && y2 >= y1 -- line2 superset or equal to line1++mktestLine a b = Line a b "" "" "" 0 0 0 0+l1 = mktestLine (0,0) (10,0)+l2 = mktestLine (0,1) ( 0,4)+l3 = mktestLine (4,0) ( 8,0)+l4 = mktestLine (0,2) ( 0,5)+l5 = mktestLine (4,2) ( 7,2)++test_xaxis_intersect = assertBool $checkIntersect l1 l3+test_xaxis_none =(assertBool . not)$checkIntersect l1 l2+test_yaxis_intersect = assertBool $checkIntersect l2 l4+test_yaxis_none =(assertBool . not)$checkIntersect l2 l3+test_xaxis_none2 =(assertBool . not)$checkIntersect l1 l5++l9 = mktestLine (0,128) (128,128)+l10= mktestLine (128,128) (192,128)+test_from_example7 = (assertBool.not) $ checkIntersect l9 l10++main = htfMain htf_thisModulesTests++-- | Split `Line`s in a list with a splitter line (which we don't insert)+splitLines :: [Line] -> Line -> [Line]+splitLines [] _ = []+splitLines (l:ls) c =+ if not (checkIntersect c l)+ then l : splitLines ls c+ else if l == c+ then l:ls+ else splitLine l c ++ ls++test_splitlines = assertEqual 3 (length (splitLines [l1] l3))+test_nosplitlines = assertEqual 1 (length (splitLines [l2] l1))++-- | Split a `Line` by another; return the bits.+splitLine :: Line -> Line -> [Line]+splitLine l cut = let (a,b) = (from l, to l)+ (c,d) = (from cut, to cut)+ in+ if normalizeLine l == normalizeLine cut+ then [l]+ else let [e,f,g,h] = sort [a,b,c,d]+ nl1 = l { from = e, to = f }+ nl2 = l { from = f, to = g }+ nl3 = l { from = g, to = h }+ in map (if lineOrient l == LT then flipline else id) $+ filter (\m -> from m /= to m+ && checkIntersect l m) [nl1, nl2, nl3]++test_splitline_self1 = assertEqual [l1] $ splitLine l1 (flipline l1)+test_splitline_self2 = assertEqual [l1] $ splitLine l1 l1+test_splitline_self3 = assertEqual [flipline l1] $ splitLine (flipline l1) l1++l11 = mktestLine (0,64) (0,128)+l12 = mktestLine (0,192) (0,64)+l13 = mktestLine (0,0) (0,128)++test_nosplit = assertEqual [l11] (splitLine l11 l12)++-- temporarily straight line!+-- limit the range of possible coordinate values to increase the likelyhood+-- of overlap for the default number of tests. Doom's actual range is+-- -32768 to +32767, but a more realistic upper limit is a range of about+-- 5000 units (MAP29)++instance Arbitrary Line where+ arbitrary = do+ vs <- replicateM 2 (choose (-2500, 2500))+ let [x,y] = vs+ return (mktestLine (x,0) (y,0))++prop_splitline_sameorient :: Line -> Line -> Bool+prop_splitline_sameorient x y = (>0) $ length $ filter (== (lineOrient x)) $ map lineOrient (splitLine x y)++test_splitline_sameorient1 = assertBool (prop_splitline_sameorient l12 l13)+test_splitline_sameorient2 = assertBool (prop_splitline_sameorient l13 l12)++-- catch case where the new lines from a split intersect existing lines+l6 = mktestLine (0,0) (0,2)+l7 = mktestLine (0,4) (0,6)+l8 = mktestLine (0,1) (0,5)+test_alldone = let split1 = splitLines [l6,l7] l8+ repeat = split1 !! 2+ split2 = splitLines split1 repeat+ in assertEqual split1 split2+-- (probably worth writing a property, too)++-- again leveraging Ord tuple+instance Ord Line where+ x <= y = let (a,b,c,d) = (from x, to x, from y, to y) in (a,b) < (c,d)++normalizeLine l = if (from l) > (to l) then flipline l else l++test_rev_xaxis_intersect = assertBool $checkIntersect l1 (flipline l3)+test_rev_xaxis_none =(assertBool . not)$checkIntersect l1 (flipline l2)++test_rev_yaxis_intersect = assertBool $checkIntersect l2 (flipline l4)+test_rev_yaxis_intersect2 = assertBool $checkIntersect (flipline l2) (flipline l4)++test_rev_yaxis_none =(assertBool . not)$checkIntersect l2 (flipline l3)+test_rev_xaxis_none2 =(assertBool . not)$checkIntersect l1 (flipline l5)+test_rev_splitlines = assertEqual 3 (length (splitLines [l1] (flipline l3)))+test_rev_nosplitlines = assertEqual 1 (length (splitLines [l2] (flipline l1)))++test_rev_recurse = assertEqual 1 (length (splitLines [l1] (flipline l1)))++l14 = mktestLine (0,0) (128,0)+l15 = mktestLine (256,0) (384,0)+l16 = mktestLine (-256,0) (512,0)+-- XXX need a test here (import example9)
+ Liquorice/Monad.hs view
@@ -0,0 +1,191 @@+{-# OPTIONS_GHC -F -pgmF htfpp #-}+{- We can't use Haddock "prune" here until we document all the wrapped+ - Pure functions -}++{-|+Module : Liquorice.Monad+Description : Liquorice functions under the `State` Monad.+Copyright : © Jonathan Dowland, 2020+License : GPL-3+Maintainer : jon+hackage@dow.land+Stability : experimental+Portability : POSIX++Core `Liquorice` functions for building maps. These are all under the+`State` Monad, the state which is passed around is the `Context` being+operated on.++Many of these functions are wrapped versions of those in `Liquorice.Pure`.+-}+module Liquorice.Monad+( twice+ , triple+ , quad+ , box+ , ibox+ , pushpop+ , place+ , straight+ , turnright+ , turnleft+ , turnaround+ , rightsector+ , innerrightsector+ , innerleftsector+ , popsector+ , leftsector+ , step+ , draw+ , thing+ , mid+ , upper+ , lower+ , xoff+ , yoff+ , ceil+ , floorflat+ , linetype+ , sectortype+ , setthing+ , mapname+ , withXoff++ , runWadL++ , htf_thisModulesTests+) where++import Test.Framework hiding (wrap)+import Control.Monad.State.Lazy+import Control.Monad++import Liquorice+import qualified Liquorice.Pure as P++------------------------------------------------------------------------------+-- monadic versions++-- wraps a function above and takes a return value to propagate+wrapR :: a -> (Context -> Context) -> State Context a+wrapR r fn = do+ old <- get+ put (fn old)+ return r++-- return-less version of above+wrap = wrapR ()++-- | Evaluate the supplied State Context to produce a pure Context. In other words,+-- run the supplied Liquorice DSL program and calculate the resulting structure.+runWadL x = snd $ runState x start++-- wrapped pure functions with icky names+turnright = wrap P.turnright+turnleft = wrap P.turnleft+turnaround = wrap P.turnaround+step x y = wrap $ P.step x y+draw x y = wrap $ P.draw x y+rightsector f c l = wrap $ P.rightsector f c l+innerrightsector f c l = wrap $ P.innerrightsector f c l+innerleftsector f c l = wrap $ P.innerleftsector f c l+popsector = wrap $ P.popsector+leftsector f c l = wrap $ P.leftsector f c l+thing = wrap P.thing+mid s = wrap $ P.mid s+upper s = wrap $ P.upper s+lower s = wrap $ P.lower s+xoff x = wrap $ P.xoff x+yoff y = wrap $ P.yoff y+floorflat s = wrap $ P.floorflat s+ceil s = wrap $ P.ceil s+linetype ty ta = wrap $ P.linetype ty ta+sectortype ty ta = wrap $ P.sectortype ty ta+setthing s = wrap $ P.setthing s+mapname s = wrap $ P.mapname s++straight n = draw n 0++blah = runWadL $ do+ straight 64+ turnright+ straight 64+ turnright+ straight 64+ turnright+ straight 64+ turnright+ rightsector 0 128 160++-- | Perform the supplied action twice.+twice = replicateM_ 2++-- | Perform the supplied action three times.+triple x = replicateM_ 3 x++-- | Perform the supplied action four times.+quad x = replicateM_ 4 x++-- | Draw a primitive rectangular box, X and Y in size, and give the resulting+-- sector's properties as `f` floor height, `c` ceiling height and `l` light+-- level.+box x y f c l = do+ twice $ do+ straight x+ turnright+ straight y+ turnright+ rightsector f c l++-- | Draw a primitive rectangular box, similar to `box`, but as an inner sector+-- parented by the last-drawn Sector.+ibox h w f c l = wrap $ P.ibox h w f c l++-- | Perform the actions `x` and then return the pen `location` to the value+-- it had prior to `x`.+pushpop :: State Context () -> State Context ()+pushpop x = do+ old <- get+ x+ new <- get+ put new { location = location old }++-- | Perform the action `stuff at an offset of (`x`,`y`) from the current+-- `location` move the pen back that relative amount afterwards.+place x y stuff = do+ step x y+ r <- stuff+ step (-1 * x) (-1 * y)+ return r+-- XXX this should probably be "and return the pen to that location afterwards."++-- | Perform the supplied actions with `paletteXoff` set to the supplied value,+-- then reset `paletteXoff`.+withXoff :: Int -> State Context () -> State Context ()+withXoff x c = do+ old <- get+ xoff x+ c+ xoff (paletteXoff old)++test_box_orientation = assertEqual (orientation a) (orientation b) where+ a = start+ b = runWadL $ box 64 64 0 0 0++test_box_pos = assertEqual (location a) (location b) where+ a = start+ b = runWadL $ box 64 64 0 0 0++nicerBlah = runWadL $ do+ box 64 64 0 128 160++test_equiv1 = assertEqual blah nicerBlah++blah2 = runWadL (straight 64)+test_lines_generated = assertEqual 1 (length (linedefs blah2))++blah3 = runWadL $ do+ straight 64+ rightsector 0 0 0+test_lines_consumed = assertEqual 0 (length (linedefs blah3))++main = htfMain htf_thisModulesTests
+ Liquorice/Pure.hs view
@@ -0,0 +1,261 @@+{-# OPTIONS_GHC -F -pgmF htfpp #-}+{-# OPTIONS_HADDOCK prune #-}++{-|+Module : Liquorice.Pure+Description : Pure functions for building Liquorice programs+Copyright : © Jonathan Dowland, 2020+License : GPL-3+Maintainer : jon+hackage@dow.land+Stability : experimental+Portability : POSIX++These Pure functions are the basic Liquorice primitives for constructing+Liquorice programs that evaluate to Doom maps. Monadic equivalents are defined+in `Liquorice.Monad`. Most people may find those more convenient.+-}+module Liquorice.Pure+ ( draw+ , rightsector+ , step+ , turnright+ , turnleft+ , turnaround+ , innerrightsector+ , innerleftsector+ , leftsector+ , popsector+ , thing+ , mid+ , upper+ , lower+ , xoff+ , yoff+ , floorflat+ , ceil+ , linetype+ , sectortype+ , setthing+ , mapname+ , box+ , ibox+ , pushpop+ , place+ , addLine++ , htf_thisModulesTests+ ) where++import Test.Framework+import Data.Function ((&))+import Data.List (nub)++import Liquorice+import Liquorice.Line++main = htfMain htf_thisModulesTests++-- | Move the pen forwards and sideways by the supplied amounts.+step :: Int -> Int -> Context -> Context+step forward sideways c = c { location = newloc }+ where+ newloc = step' (location c) (orientation c)+ step' (x,y) North = (x+sideways, y+forward)+ step' (x,y) South = (x-sideways, y-forward)+ step' (x,y) East = (x+forward, y-sideways)+ step' (x,y) West = (x-forward, y+sideways)++-- | Define a line from the current `location` to a new one reached by+-- moving forwards and sideways by the supplied amounts.+draw :: Int -> Int -> Context -> Context+draw forward sideways oldc = let+ newc = step forward sideways oldc+ newline = Line (location oldc) (location newc) (paletteTop oldc)+ (paletteMid oldc) (paletteBot oldc) (paletteLineType oldc) (paletteLineTag oldc)+ (paletteXoff oldc) (paletteYoff oldc)+ in addLine newline newc++-- | Rotate the pen to the right.+turnright :: Context -> Context+turnright c = c { orientation=next (orientation c) }++-- | Rotate the pen to the left.+turnleft :: Context -> Context+turnleft c = c { orientation=prev (orientation c) }++-- | Rotate the pen 180°.+turnaround :: Context -> Context+turnaround c = c { orientation=(next.next.orientation) c }++-- | Define a new Sector on the right-hand side of the pen.+rightsector :: Int -> Int -> Int -> Context -> Context+rightsector f c l ctx = let s = Sector f c (paletteFloor ctx) (paletteCeil ctx) l (paletteSectorType ctx) (paletteSectorTag ctx) (linedefs ctx)+ newsectors = s : sectors ctx+ in ctx { sectors = newsectors, linedefs = [] }++-- | Define a new Sector on the left-hand side of the pen.+leftsector :: Int -> Int -> Int -> Context -> Context+leftsector f c l ctx = let ls = map flipline (linedefs ctx)+ s = Sector f c (paletteFloor ctx) (paletteCeil ctx) l (paletteSectorType ctx) (paletteSectorTag ctx) ls+ newsectors = s : sectors ctx+ in ctx { sectors = newsectors, linedefs = [] }++-- | Define a new inner-Sector on the right-hand side of the pen.+innerrightsector :: Int -> Int -> Int -> Context -> Context+innerrightsector f c l ctx = let last = head (sectors ctx)+ flipped = map flipline (linedefs ctx)+ newlast = last { sectorLines = sectorLines last ++ flipped }+ nctx = ctx { sectors = newlast : tail (sectors ctx) }+ in rightsector f c l nctx++-- | Define a new inner-Sector on the left-hand side of the pen.+innerleftsector :: Int -> Int -> Int -> Context -> Context+innerleftsector f c l ctx = let last = head (sectors ctx)+ newlast = last { sectorLines = sectorLines last ++ (linedefs ctx)}+ nctx = ctx { sectors = newlast : tail (sectors ctx) }+ in leftsector f c l nctx++-- | Pop the last-defined `Sector` from the stack of defined `Sector`s and re-insert+-- it at the bottom. It remains defined, but the second-last-defined `Sector` is+-- promoted for subsequent operations that use the last-defined `Sector`.+popsector :: Context -> Context+popsector c = case length (sectors c) of+ 0 -> c -- XXX catch error+ 1 -> c -- XXX catch error+ _ -> let pop = head (sectors c)+ news = tail (sectors c) ++ [pop]+ in c { sectors = news }++-- XXX TESTS!!!++-- | Define a new `Thing` at the current pen location.+thing :: Context -> Context+thing c = let newthing = Thing (location c) angle (curThingType c) 7 -- all skills+ angle = case orientation c of+ North -> 90+ East -> 0+ South -> 270+ West -> 180+ in c { things = newthing : things c }++-- | Set the mid-texture value for future lines.+mid :: String -> Context -> Context+mid s c = c { paletteMid = s }++-- | Set the lower-texture value for future lines.+lower :: String -> Context -> Context+lower s c = c { paletteBot = s }++-- | Set the texture x-offset value for future lines.+xoff :: Int -> Context -> Context+xoff x c = c { paletteXoff = x }++-- | Set the texture y-offset value for future lines.+yoff :: Int -> Context -> Context+yoff y c = c { paletteYoff = y }++-- | Set the upper-texture value for future lines.+upper :: String -> Context -> Context+upper s c = c { paletteTop = s }++-- | Set the Sector floor texture for future Sectors.+floorflat :: String -> Context -> Context+floorflat s c = c { paletteFloor = s }+-- XXX: rename/harmonize with ceil++-- | Set the Sector ceiling texture for future Sectors.+ceil :: String -> Context -> Context+ceil s c = c { paletteCeil = s }++-- | Set the type and tag values for future defined `Line`s.+linetype :: Int -> Int -> Context -> Context+linetype ty tag c = c { paletteLineType = ty, paletteLineTag = tag }++-- | Set the type and tag values for future defined `Sector`s.+sectortype :: Int -> Int -> Context -> Context+sectortype ty tag c = c { paletteSectorType = ty, paletteSectorTag = tag }++-- | Set the type of future-defined `Thing`s.+setthing :: Int -> Context -> Context+setthing s c = c { curThingType = s }++-- | Set the name of the current map.+mapname :: String -> Context -> Context+mapname s c = c { mapName = s }++-- | Evaluate `fn` at a `location` offset of (x,y) from the current pen+-- location and then move the pen location back by the same relative amount.+place :: Int -> Int -> (Context -> Context) -> Context -> Context+place x y fn c = c & step x y+ & fn+ & step (-1 * x) (-1 * y)++test_place_pos = assertEqual (location a) (location b) where+ a = start+ b = place 64 64 thing start++-- | Evaluate `fn` and then re-define the `location` to the value it was+-- prior to evaluation.+pushpop :: (Context -> Context) -> Context -> Context+pushpop fn c = (fn c) { location = location c }++test_pushpop_pos = assertEqual (location a) (location b) where+ a = start+ b = pushpop (thing . step 64 64) start++test_no_things = assertEqual 0 (length (things start))+test_one_thing = assertEqual 1 (length (things (start & thing)))++-- | Evaluate `f` twice.+twice :: (Context -> Context) -> Context -> Context+twice f c = iterate f c !! 2++-- | Evaluate `f` four times.+quad :: (Context -> Context) -> Context -> Context+quad f c = iterate f c !! 4++-- | Define a straight `Line` of length n from the current pen position along the+-- current orientation.+straight n = draw n 0++box' :: Int -> Int -> Context -> Context+box' h w = twice (\c -> c+ & straight h+ & turnright+ & straight w+ & turnright)++-- | Define a rectangular `Sector` of the supplied size and properties.+box :: Int -> Int -> Int -> Int -> Int -> Context -> Context+box h w f ceil l c = c+ & box' h w+ & rightsector f ceil l++-- | Define a rectangular inner-`Sector` of the supplied size and properties,+-- parented to the last-drawn Sector.+ibox :: Int -> Int -> Int -> Int -> Int -> Context -> Context+ibox h w f ceil l c = c+ & box' h w+ & innerrightsector f ceil l++-- | Check intersections against all existing lines+addLine :: Line -> Context -> Context+addLine l c = let+ news = map (\s-> s { sectorLines = splitLines (sectorLines s) l }) (sectors c)+ alllines = linedefs c ++ concatMap sectorLines news+ intersects = filter (checkIntersect l) alllines+ newlines = if length intersects > 0+ then workbest [l] intersects+ else [l]+ in c { sectors = news, linedefs = linedefs c ++ newlines }++-- XXX rename!+-- lines cuts lines+workbest :: [Line] -> [Line] -> [Line]+workbest [] _ = []+workbest ls [] = ls+workbest (l:ls) (c:cs) =+ let x = splitLine l c+ y = workbest x cs+ z = workbest ls (c:cs)+ in y ++ z
+ Liquorice/Render.hs view
@@ -0,0 +1,193 @@+{-# OPTIONS_GHC -F -pgmF htfpp #-}+{-# OPTIONS_HADDOCK prune #-}++{-|+Module : Liquorice.Render+Description : High-level functions for rendering Liquorice programs to PWAD files.+Copyright : © Jonathan Dowland, 2020+License : GPL-3+Maintainer : jon+hackage@dow.land+Stability : experimental+Portability : POSIX++This module exposes a high-level function `buildWad` that can be used to evaluate+a Liquorice program, convert the resulting Context into Doom data structures and+write out a Doom-format PWAD file.+-}++module Liquorice.Render ( buildWad+ , htf_thisModulesTests+ ) where++import qualified Data.ByteString.Lazy as L+import Test.Framework+import Data.List (elemIndex)+import Data.Function ((&))++import Liquorice+import Liquorice.Pure+import Liquorice.Line+import Liquorice.Wad++-- utility stuff -------------------------------------------------------------++addUnique :: Eq a => [a] -> a -> (Int,[a])+addUnique vs v = case elemIndex v vs of+ Nothing -> (length vs, vs++[v])+ Just l -> (l, vs)++prop_AddUniqueWorks :: [Int] -> Int -> Bool+prop_AddUniqueWorks vs v = let (index,vs2) = addUnique vs v+ in v == vs2 !! index++-- converting Liquorice structures into WAD structures ---------------------------++convertWadL :: Context -> WadMap+convertWadL c = let baseMap = WadMap (mapName c) (things c) [] [] [] []+ in convertWadL' (sectors c) 0 baseMap+ where+ convertWadL' :: [Sector] -> Int -> WadMap -> WadMap+ convertWadL' [] _ m = m+ convertWadL' (s:ss) n m = let newS = s { sectorLines = [] } -- a hack+ m2 = convertLines (sectorLines s) n m+ m3 = m2 { mapSectors = mapSectors m2 ++ [newS] }+ in convertWadL' ss (n+1) m3+ where+ convertLines :: [Line] -> Int -> WadMap -> WadMap+ convertLines [] _ m = m+ convertLines (l:ls) n m = convertLines ls n (line2Def l n m)++-- XXX: detect existing line (backwards possibly); if present modify to 2 sided+-- (means generating two new sidedefs)++partitionLines :: Int -> Int -> WadMap -> [[Linedef]]+partitionLines vfrom vto m = let existingLines = mapLinedefs m+ pred = \l -> (ldFrom l, ldTo l) `elem` [(vfrom,vto), (vto,vfrom)]+ before = takeWhile (not . pred) existingLines+ after = drop (length before) existingLines+ in [before,after]+-- output if there's a match: [[all linedefs before], [match, all after]]+-- output if there isn't: [[all linedefs], []]+-- (need to avoid tail in "after" for the [] case)++line2Def :: Line -> Int -> WadMap -> WadMap+line2Def l secno m = let+ (vfrom, vs1) = addUnique (mapVertexes m) (from l)+ (vto, vs2) = addUnique vs1 (to l)+ [before,after] = partitionLines vfrom vto m++ in case after of+ -- old case, no overlap, single-sided+ [] -> let+ sidedef = Sidedef (lineXoff l) (lineYoff l) (lineTop l) (lineBot l) (lineMid l) secno+ (sno,sd2) = addUnique (mapSidedefs m) sidedef+ newline = Linedef vfrom vto 1 (lineType l) (lineTag l) sno (-1)+ newlines = mapLinedefs m ++ [newline]+ in m { mapVertexes = vs2, mapSidedefs = sd2, mapLinedefs = newlines }++ -- new case, 2-sided, replace existing line definition+ (oldline:ls) -> let+ oldside = (mapSidedefs m) !! (ldFront oldline)+ (so1,sd1) = addUnique (mapSidedefs m) oldside { sdMid = "-" }+ (so2,sd2) = addUnique sd1 (Sidedef (lineXoff l) (lineYoff l) (lineTop l) (lineBot l) "-" secno)+ newline = oldline { ldFlags = 4, ldFront = so1, ldBack = so2 }+ newlines = before ++ newline:ls+ in m { mapVertexes = vs2, mapSidedefs = sd2, mapLinedefs = newlines }++-- | Convert the geometry described by the supplied Context into Doom-format+-- structures and write them out as a PWAD file to the supplied FilePath.+buildWad outfile wadcsrc =+ L.writeFile outfile $ (dumpWad . mapWad2Wad . convertWadL) wadcsrc++-- tests ---------------------------------------------------------------------++-- test 1: single triangular sector, unique texture per line+wad1 = WadMap { mapLabel = "MAP01"+ , mapThings = [Thing (32, 64) 90 1 7]+ , mapLinedefs = [ Linedef 0 1 1 0 0 0 (-1)+ , Linedef 1 2 1 0 0 1 (-1)+ , Linedef 2 0 1 0 0 2 (-1)+ ]+ , mapSidedefs = [ Sidedef 0 0 "STARTAN3" "STARTAN3" "ZZWOLF1" 0+ , Sidedef 0 0 "STARTAN3" "STARTAN3" "ZZWOLF2" 0+ , Sidedef 0 0 "STARTAN3" "STARTAN3" "ZZWOLF3" 0 ]+ , mapVertexes = [(0, 0), (0, 128), (128, 128)]+ , mapSectors = [Sector 0 128 "FLAT23" "F_SKY1" 160 0 0 [] ]+ }++example1 = start+ & mid "ZZWOLF1"+ & draw 128 0+ & mid "ZZWOLF2"+ & draw 0 128+ & turnaround+ & mid "ZZWOLF3"+ & draw 128 128+ & rightsector 0 128 160+ & turnaround+ & step 64 32+ & thing++test_equiv1 = assertEqual (convertWadL example1) wad1++-- test 2: two (disconnected) sectors+example3 = start+ & box 128 128 0 128 160+ & step 64 64+ & thing+ & step 128 (-64)+ & box 128 128 0 128 160++wad3 = WadMap { mapLabel = "MAP01"+ , mapThings = [Thing (64, 64) 90 1 0]+ , mapLinedefs = [ Linedef 0 1 1 0 0 0 (-1)+ , Linedef 2 0 1 0 0 0 (-1)+ , Linedef 3 2 1 0 0 0 (-1)+ , Linedef 1 3 1 0 0 0 (-1)+ , Linedef 4 5 1 0 0 1 (-1)+ , Linedef 6 4 1 0 0 1 (-1)+ , Linedef 7 6 1 0 0 1 (-1)+ , Linedef 5 7 1 0 0 1 (-1)+ ]+ , mapSidedefs = [ Sidedef 0 0 "STARTAN3" "STARTAN3" "STARTAN3" 0+ , Sidedef 0 0 "STARTAN3" "STARTAN3" "STARTAN3" 1 ]+ , mapVertexes = [(128, 192), (0, 192), (128, 320), (0, 320),+ (128, 0), (0, 0), (128, 128), (0, 128)]++ , mapSectors = [ Sector 0 128 "FLAT23" "F_SKY1" 160 0 0 []+ , Sector 0 128 "FLAT23" "F_SKY1" 160 0 0 []+ ]+ }++--test_equiv3 = assertEqual (convertWadL example3) wad3++-- test 3: two adjacent sectors (2s line) (based on example4)++example4 = start+ & box 128 128 0 128 160+ & pushpop (\c -> c & step 64 64 & thing)+ & step 128 0+ & box 128 128 0 128 160++wad4 = WadMap { mapLabel = "MAP01"+ , mapThings = [Thing (64, 64) 90 1 7]+ , mapLinedefs = [ Linedef 0 1 1 0 0 0 (-1)+ , Linedef 1 2 1 0 0 0 (-1)+ , Linedef 2 3 1 0 0 0 (-1)+ , Linedef 3 0 4 0 0 2 3+ , Linedef 4 0 1 0 0 1 (-1)+ , Linedef 3 5 1 0 0 1 (-1)+ , Linedef 5 4 1 0 0 1 (-1) ]+ , mapSidedefs = [ Sidedef 0 0 "STARTAN3" "STARTAN3" "STARTAN3" 0+ , Sidedef 0 0 "STARTAN3" "STARTAN3" "STARTAN3" 1+ , Sidedef 0 0 "STARTAN3" "STARTAN3" "-" 0+ , Sidedef 0 0 "STARTAN3" "STARTAN3" "-" 1 ]+ , mapVertexes = [(0,128),(0,256),(128,256),(128,128),(0,0),(128,0)]++ , mapSectors = [ Sector 0 128 "FLAT23" "F_SKY1" 160 0 0 []+ , Sector 0 128 "FLAT23" "F_SKY1" 160 0 0 [] ]+ }++test_equiv4 = assertEqual (convertWadL example4) wad4++main = htfMain htf_thisModulesTests
+ Liquorice/Wad.hs view
@@ -0,0 +1,239 @@+{-# OPTIONS_GHC -F -pgmF htfpp #-}+{-# OPTIONS_HADDOCK prune #-}++{-|+Module : Liquorice.Wad+Description : Data types modelling Doom internal data structures+Copyright : © Jonathan Dowland, 2020+License : GPL-3+Maintainer : jon+hackage@dow.land+Stability : experimental+Portability : POSIX++Data types that model the internal data structures in Doom to represent+maps, as well as an interim data-type (`WadMap`) to bridge between these+and Liquorice's more abstract types.+-}+module Liquorice.Wad ( WadLump(..)+ , wadLumpLength+ , wadLumpName+ , Linedef(..)+ , Sidedef(..)+ , WadMap(..)+ , mapWad2Wad+ , dumpWad++ , htf_thisModulesTests+ ) where++import qualified Data.ByteString.Lazy as L+import qualified Data.ByteString.Lazy.Char8 as LC+import Data.Binary+import Data.Binary.Put+import Test.Framework++import Liquorice++-- local cheats+str8 :: String -> L.ByteString+str8 s = let bit = take 8 s+ len = length bit+ pad = take (8 - len) (repeat '\0')+ in+ LC.pack $ bit ++ pad++putShort = putInt16le . fromIntegral+putInt = putInt32le . fromIntegral++-- data structures to closely represent WAD lumps ----------------------------++-- | Enumeration (of sorts) of supported WAD lump types.+data WadLump = WadLabel String+ | WadThings [Thing] -- re-used from Liquorice+ | WadVertexes [Point] -- re-used from Liquorice+ | WadSectors [Sector] -- re-used from Liquorice (but might not want to)+ | WadLinedefs [Linedef]+ | WadSidedefs [Sidedef]+ | WadLump String L.ByteString deriving (Show)++-- | Calculate the lump length of a given WadLump type.+wadLumpLength :: WadLump -> Int+wadLumpLength (WadLabel _) = 0+wadLumpLength (WadThings ts) = 10 * length ts+wadLumpLength (WadLump _ l) = fromIntegral (LC.length l)+wadLumpLength (WadVertexes vs) = 4 * length vs+wadLumpLength (WadSectors ss) = 26 * length ss+wadLumpLength (WadLinedefs ls) = 14 * length ls+wadLumpLength (WadSidedefs ss) = 30 * length ss++-- | Determine the lump name for a given WadLump.+wadLumpName :: WadLump -> String+wadLumpName (WadLabel s) = s+wadLumpName (WadThings _) = "THINGS"+wadLumpName (WadVertexes _) = "VERTEXES"+wadLumpName (WadSectors _) = "SECTORS"+wadLumpName (WadLinedefs _)= "LINEDEFS"+wadLumpName (WadSidedefs _)= "SIDEDEFS"+wadLumpName (WadLump s _) = s++-- | A Doom Line definition.+data Linedef = Linedef { ldFrom :: Int -- all shorts+ , ldTo :: Int+ , ldFlags :: Int+ , ldSpecial :: Int+ , ldTag :: Int+ , ldFront :: Int+ , ldBack :: Int+ } deriving (Show, Eq)++-- | A Doom Line "Side" definition.+data Sidedef = Sidedef { sdXoff :: Int -- shorts or 8-byte strings+ , sdYoff :: Int+ , sdUpper :: String+ , sdLower :: String+ , sdMid :: String+ , sdSector :: Int+ } deriving (Show, Eq)++-- converting those data structures to ByteStrings ---------------------------++nope = error "not implemented"++instance Binary WadLump where+ get = nope+ put (WadLabel l) = return ()+ put (WadLump _ d) = put d -- XXX probably wrong! we want some literal put+ put (WadThings ts) = mapM_ put ts+ put (WadVertexes vs) = mapM_ (\ (x,y) -> (putShort x >> putShort y)) vs+ put (WadSectors ss) = mapM_ put ss+ put (WadLinedefs ls) = mapM_ put ls+ put (WadSidedefs ss) = mapM_ put ss++instance Binary Sector where+ get = nope+ put (Sector f c fflat cflat ll stype tag _) = do+ putShort f+ putShort c+ putLazyByteString (str8 fflat)+ putLazyByteString (str8 cflat)+ putShort ll+ putShort stype+ putShort tag++instance Binary Linedef where+ get = nope+ put (Linedef from to flags special tag front back) = do+ putShort from+ putShort to+ putShort flags+ putShort special+ putShort tag+ putShort front+ putShort back++instance Binary Sidedef where+ get = nope+ put (Sidedef xoff yoff upper lower mid sector) = do+ putShort xoff+ putShort yoff+ putLazyByteString (str8 upper)+ putLazyByteString (str8 lower)+ putLazyByteString (str8 mid)+ putShort sector++instance Binary Thing where+ get = nope+ put (Thing (x,y) angle ty flags) = do+ putShort x+ putShort y+ putShort angle+ putShort ty+ putShort flags++wadHeader :: Int -> Int -> L.ByteString+wadHeader numents diroffs = runPut $ do+ putStringUtf8 "PWAD"+ putInt numents+ putInt diroffs++-- convert a directory into bytes to write out+dumpWadDir :: [(Int,Int,String)] -> L.ByteString+dumpWadDir xs = L.concat (map dumpWadDir' xs) where+ dumpWadDir' :: (Int,Int,String) -> L.ByteString+ dumpWadDir' (offs,len,name) = runPut $ do+ putInt offs+ putInt len+ putLazyByteString (str8 name)++-- | Convert a list of `WadLump`s into a PWAD represented as a Lazy+-- `ByteString`.+dumpWad :: [WadLump] -> L.ByteString+dumpWad ws = let numents = length ws+ diroffs = 12 + sum (map wadLumpLength ws)+ header = wadHeader numents diroffs+ dir = dumpWadDir (buildWadDir ws)+ in L.concat (header : (map encode ws) ++ [dir])+-- XXX: rename++buildWadDir :: [WadLump] -> [(Int,Int,String)] -- offs,len,name+buildWadDir ws = buildWadDir' 12 ws where+ buildWadDir' :: Int -> [WadLump] -> [(Int,Int,String)]+ buildWadDir' _ [] = []+ buildWadDir' offs (w:ws) = let len = wadLumpLength w+ in (offs, len, wadLumpName w):(buildWadDir' (offs+len) ws)++-- similar to above; but exactly one map-related lump ------------------------++-- | A representation of all the WAD lumps that are required for a Doom map.+data WadMap = WadMap { mapLabel :: String+ , mapThings :: [Thing]+ , mapLinedefs :: [Linedef]+ , mapSidedefs :: [Sidedef]+ , mapVertexes :: [Point]+ , mapSectors :: [Sector]+ } deriving (Show, Eq)++-- | Process a `WadMap` into a list of `WadLumps` that could be written to+-- a PWAD.+mapWad2Wad :: WadMap -> [WadLump]+mapWad2Wad (WadMap label things lines sides vertexes sectors) =+ [ WadLabel label, WadThings things, WadLinedefs lines,+ WadSidedefs sides, WadVertexes vertexes, WadSectors sectors ]++-- | Convert a `WadMap` into a list of lumps and dump them into a PWAD.+buildMapWad :: WadMap -> L.ByteString+buildMapWad = dumpWad . mapWad2Wad++-- test data - raw PWAD read into a ByteString -------------------------------++main = htfMain htf_thisModulesTests+wad1 = LC.pack "PWAD\ACK\NUL\NUL\NUL\192\NUL\NUL\NUL \NUL@\NULZ\NUL\SOH\NUL\NUL\NUL\NUL\NUL\SOH\NUL\SOH\NUL\NUL\NUL\NUL\NUL\NUL\NUL\255\255\STX\NUL\NUL\NUL\SOH\NUL\NUL\NUL\NUL\NUL\SOH\NUL\255\255\SOH\NUL\STX\NUL\SOH\NUL\NUL\NUL\NUL\NUL\STX\NUL\255\255\NUL\NUL\NUL\NUL-\NUL\NUL\NUL\NUL\NUL\NUL\NUL-\NUL\NUL\NUL\NUL\NUL\NUL\NULZZWOLF3\NUL\NUL\NUL\NUL\NUL\NUL\NUL-\NUL\NUL\NUL\NUL\NUL\NUL\NUL-\NUL\NUL\NUL\NUL\NUL\NUL\NULZZWOLF2\NUL\NUL\NUL\NUL\NUL\NUL\NUL-\NUL\NUL\NUL\NUL\NUL\NUL\NUL-\NUL\NUL\NUL\NUL\NUL\NUL\NULZZWOLF1\NUL\NUL\NUL\128\NUL\128\NUL\NUL\NUL\NUL\NUL\NUL\NUL\128\NUL\NUL\NUL\128\NULFLAT23\NUL\NULF_SKY1\NUL\NUL\160\NUL\NUL\NUL\NUL\NUL\f\NUL\NUL\NUL\NUL\NUL\NUL\NULMAP01\NUL\NUL\NUL\f\NUL\NUL\NUL\n\NUL\NUL\NULTHINGS\NUL\NUL\SYN\NUL\NUL\NUL*\NUL\NUL\NULLINEDEFS@\NUL\NUL\NULZ\NUL\NUL\NULSIDEDEFS\154\NUL\NUL\NUL\f\NUL\NUL\NULVERTEXES\166\NUL\NUL\NUL\SUB\NUL\NUL\NULSECTORS\NUL"++wad8 :: [WadLump]+wad8 = [ WadLabel "MAP01"+ , WadThings [Thing (32,64) 90 1 0]+ , WadLinedefs [ Linedef 0 1 1 0 0 0 (-1)+ , Linedef 2 0 1 0 0 1 (-1)+ , Linedef 1 2 1 0 0 2 (-1) ]+ , WadSidedefs [ Sidedef 0 0 "-" "-" "ZZWOLF3" 0+ , Sidedef 0 0 "-" "-" "ZZWOLF2" 0+ , Sidedef 0 0 "-" "-" "ZZWOLF1" 0 ]+ , WadVertexes [(128,128), (0,0), (0,128)]+ , WadSectors [Sector 0 128 "FLAT23" "F_SKY1" 160 0 0 [] ]+ ]++test_equiv8 = assertEqual (dumpWad wad8) wad1++wad9 = WadMap { mapLabel = "MAP01"+ , mapThings = [Thing (32, 64) 90 1 0]+ , mapLinedefs = [ Linedef 0 1 1 0 0 0 (-1)+ , Linedef 2 0 1 0 0 1 (-1)+ , Linedef 1 2 1 0 0 2 (-1) ]+ , mapSidedefs = [ Sidedef 0 0 "-" "-" "ZZWOLF3" 0+ , Sidedef 0 0 "-" "-" "ZZWOLF2" 0+ , Sidedef 0 0 "-" "-" "ZZWOLF1" 0 ]+ , mapVertexes = [(128, 128), (0, 0), (0, 128)]+ , mapSectors = [Sector 0 128 "FLAT23" "F_SKY1" 160 0 0 [] ]+ }++test_equiv9 = assertEqual ((dumpWad . mapWad2Wad) wad9) wad1
+ README.md view
@@ -0,0 +1,136 @@+# Liquorice++++*Liquorice* is a system for constructing maps for the [computer game Doom](https://doomwiki.org/wiki/Doom) by writing algorithms to describe the geometry. A *Liquorice* program is a series of instructions to move a virtual "turtle" or "pen", which define the walls, floors, rooms and monsters as it goes.++More specifically, *Liquorice* is an embedded domain-specific language (eDSL) within the pure functional programming language [Haskell](https://www.haskell.org/).++## Quick example++ -- simple example, triangle (for orientation); unique texture per line+ import Liquorice.Monad+ import Liquorice.Render++ main = buildWad "example1.wad" $ runWadL $ do+ mid "ZZWOLF1"+ draw 128 0+ mid "ZZWOLF2"+ draw 0 128+ turnaround+ mid "ZZWOLF3"+ draw 128 128+ rightsector 0 128 160+ turnaround+ step 64 32+ thing++## More detailed example++See [examples/birds.hs](examples/birds.hs), for an example program+that generates a complete playable map. The map targets Doom 1 / The+Ultimate Doom (map slot E2M8), and requires a doom engine with raised+engine limits, such as [Crispy Doom](https://www.chocolate-doom.org/wiki/Crispy_Doom).++The generated PWAD, with nodes, ready to play: [birds.zip](https://redmars.org/liquorice/birds.zip)++*birds.hs* is a re-implementation/transformation of ["Bird Cage"+for WadC](https://redmars.org/wadc/examples/#_birds_wl).++## Getting Started++### For Doom novices++Doom's engine source code was open-sourced in 1996, but you need a copy of+the game's data files to use them. You can buy [The Ultimate Doom](https://www.gog.com/game/the_ultimate_doom) and [Doom II](https://www.gog.com/game/doom_ii_final_doom) at [Gog](http://www.gog.com/), amongst other places. Failing that, you could try [FreeDoom](https://freedoom.github.io/), a free-content game for Doom engines.++Examples of powerful open source engines include [Crispy Doom](https://www.chocolate-doom.org/wiki/index.php/Crispy_Doom), [Eternity Engine](http://eternity.youfailit.net/wiki/Main_Page) and [GZDoom](https://zdoom.org/index).++### For Haskell novices++…++## Evaluation++The commands that a typical *Liquorice* program will use are predominantly+monadic, and so make use of Haskell's "do-notation" for ordering. Internally,+the majority of these monadic functions are wrappers around pure equivalents+which transform an input `Context` type into an output, e.g.:++ xoff :: Int -> Context -> Context+ xoff x c = c { paletteXoff = x }++ place :: Int -> Int -> (Context -> Context) -> Context -> Context+ place x y fn c = c & step x y+ & fn+ & step (-1 * x) (-1 * y)++The pure functions can be combined using the infix operator `&` (from+`Data.Function`), or the more usual composition operator (which reads+back-to-front). However, the monadic versions are probably more user-+friendly, and so the separate pure implementations might go away or+stop being explicitly exported at some point. We also probably need to+use the monadic versions if we want to introduce randomness or debug IO+in the middle of a program.++A series of monadic Liquorice statements are converted into a final `Context`+via `runWadL`. A `Context` is written to an output PWAD file via++ buildWad :: FilePath -> Context -> IO ()++Internally, `buildWad` first converts a `Context` into an intermediate data+structure `WadMap`, which closely resembles the binary structure of a PWAD.+(`WadMap` itself is a specialisation of `Wad`, imposing the presence of map+ specific lumps)+++## Pros/Cons++Pros:++* Unlike WadC, you have full access to the Context at any point in your+ program, which you can inspect or transform as you wish.+* You also have the full power of the Haskell programming language.+* In particular simply infix numeric operators are hugely useful.++Cons:++* There's no GUI.+* The Pure-versus-Monadic functions are a bit awkward and I might get rid of the+pure versions altogether in the future+* There are some slow parts (line splitting in particular)+* If you don't know Haskell, this will be very hard to use and most error messages+will make little sense.+* You need a Haskell development environment installed to use *Liquorice*.++## Code overview++The following three source files are the ones that you will want to import+as modules to your Liquorice program:++ * `Liquorice.hs` — The main `Context` definition and most basic pure operations+ * `Liquorice/Monad.hs` — monadic wrappers around the above, + some more+ * `Liquorice/Render.hs` — exports `buildWad` for exporting a PWAD++These are back-end implementation details:++ * `Liquorice/Pure.hs` — most of the "standard library", in pure functions+ * `Liquorice/Line.hs` — `Line` type, line splitting and tests+ * `Liquorice/Wad.hs` — Wad and WadMap definitions and binary serialisation+ * `TestMain.hs` — HTF test harness++## Author++*Liquorice* was created by [Jonathan Dowland](https://jmtd.net/) and is+distributed under the terms of the GNU Public License, version 3 (see+[COPYING](COPYING)).++The design of *Liquorice* is heavily+influenced by [Wad Language (WadC)](https://jmtd.net/wadc/), which in turn owes+a debt to [LOGO](http://el.media.mit.edu/logo-foundation/what_is_logo/logo_programming.html).++## See also++ * [Jonathan Dowland's homepage](https://jmtd.net/)+ * [WadC](https://jmtd.net/wadc/)+ * [The Doom Wiki](https://doomwiki.org/)
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ TestMain.hs view
@@ -0,0 +1,18 @@+{-# OPTIONS_GHC -F -pgmF htfpp #-}++module Main where++import Test.Framework++import {-@ HTF_TESTS @-} Liquorice+import {-@ HTF_TESTS @-} Liquorice.Pure+import {-@ HTF_TESTS @-} Liquorice.Monad as M+import {-@ HTF_TESTS @-} Liquorice.Render+import {-@ HTF_TESTS @-} Liquorice.Line+import {-@ HTF_TESTS @-} Liquorice.Wad++test_example9 = let pre = addLine (Line (0,0) (0,128) "" "" "" 0 0 0 0) start+ post = addLine (Line (0,64) (0,192) "" "" "" 0 0 0 0) pre+ in assertEqual 3 (length (linedefs post))++main = htfMain htf_importedTests
+ examples/birds.hs view
@@ -0,0 +1,436 @@+{-+ A Liquorice conversion of WadC's "birds.wl" - adjusted to Doom E2M8+ Requires a limit-removing port+ -}+import Control.Monad.State.Lazy+import Data.Tuple (swap)++import Liquorice+import Liquorice.Monad+import Liquorice.Render++-- stuff to move elsewhere ---------------------------------------------------++right x = turnright >> straight x+left x = turnleft >> straight x++cluster stuff dist = do+ turnaround+ step dist dist+ turnaround+ pushpop $ triple $ do+ pushpop $ triple $ do+ stuff+ step dist 0+ step 0 dist++surround stuff dist = do+ pushpop $ do+ step (-1 * dist) (-1 * dist)+ quad $ do+ twice $ do+ stuff+ step dist 0+ stuff+ turnright++getLoc :: State Context (Point, Orientation)+getLoc = do+ ctx <- get+ return (location ctx, orientation ctx)++setLoc :: (Point, Orientation) -> State Context ()+setLoc (p,o) = do+ ctx <- get+ put ctx { location = p, orientation = o }++deathmatchstart = setthing 11+boxofrockets = setthing 2046+rocket = setthing 2010+stimpak = setthing 2011+greenarmor = setthing 2018+rocketlauncher = setthing 2003+lostsoul = setthing 3006+chaingun = setthing 2002+healthpotion = setthing 2014+spiritarmor = setthing 2015+cyberdemon = setthing 16+shortredfirestick = setthing 57+player1start = setthing 1+player2start = setthing 2+player3start = setthing 3+player4start = setthing 4+teleportdest = setthing 14+candle = setthing 34+soulsphere = setthing 2013++floor_w1_down_HnF = 19+floor_w1_down_LnF_TxTy = 37+crusher_w1_slow = 0 -- XXX real value+exit_w1_normal = 52+teleport_wr = 97++extendsector :: State Context ()+extendsector = do+ old <- get+ let lines = linedefs old+ olds = head (sectors old)+ news = olds { sectorLines = sectorLines olds ++ lines }+ new = old { sectors = news : (tail (sectors old)), linedefs = [] }+ put new++-- constants for this map ----------------------------------------------------++skyheight = 192+wallheight = 96+turretheight = 160+ceilheight = 136+skybright = 150+housebright = 200++-- nasty way to sort out tag values, temporary+[tomb1,tomb2,tomb3,spoke1,spoke2,spoke3,spoke4,windowtag,pillar2,pillar3,pillar4,crushme,lastbutton,exittag] =+ [1..14]++main = buildWad "birds.wad" $ runWadL $ do+-- undefx+ mapname "E2M8"+ housetex+ start <- getLoc+ ~[north,east,south,west] <- hub++ setLoc north+ spoke starts tomb1 tomb1 floor_w1_down_HnF spiritarmor spoke1+ setLoc east+ spoke (deathmatchstart >> thing >> greenarmor >> thing)+ tomb1 tomb2 floor_w1_down_HnF healthpotion spoke2+ setLoc west+ spoke (chaingun >> thing >> deathmatchstart >> thing)+ tomb2 tomb3 floor_w1_down_HnF healthpotion spoke3+ setLoc south+ spoke (deathmatchstart >> thing >> rocketlauncher >> thing)+ tomb3 windowtag floor_w1_down_LnF_TxTy spiritarmor spoke4++ -- outertag, innertag, walktag, triggertype, outer button tag, outer button type+ setLoc north -- northeast+ courtyard tomb1 pillar2 pillar3 floor_w1_down_LnF_TxTy 0 0 (soulsphere >> thing >> lostsoul >> surround thing 48)+ setLoc east+ courtyard tomb2 pillar3 pillar4 floor_w1_down_LnF_TxTy 0 0 (lostsoul >> surround thing 48)+ setLoc south+ courtyard tomb3 pillar4 lastbutton floor_w1_down_HnF crushme crusher_w1_slow (lostsoul >> surround thing 48)+ setLoc west+ courtyard windowtag windowtag pillar2 floor_w1_down_LnF_TxTy 0 0 (cyberdemon >> thing)++housetex = do+ floorflat "DEM1_6"+ ceil "DEM1_5"+ upper "MARBLE3"+ mid "MARBLE3"+ lower "MARBLE3"++outdoors = do+ floorflat "MFLR8_4"+ ceil "F_SKY1"+ mid "BROWNHUG"+ lower "BROWNHUG"++hub :: State Context [(Point, Orientation)]+hub = do+ let seg = do+ turnright+ draw 192 0+ draw 128 128+ hub <- getLoc+ turnleft+ west <- place 0 32 getLoc+ seg+ north <- place 0 32 getLoc+ seg+ east <- place 0 32 getLoc+ seg+ south <- place 0 32 getLoc+ seg+ rightsector 8 ceilheight housebright+ turnright++ step 0 128+ ceil "F_SKY1"+ floorflat "MFLR8_3"+ edged_ibox (-16) skyheight (24+housebright) 192 192 32+ step 64 64+ lower "SP_DUDE6"+ floorflat "DEM1_5"+ ibox 64 64 128 ceilheight (48+housebright)+ housetex+ step 32 0+ twice popsector+ return [north,east,south,west]++spoke x tombtag walktag trig ammo spoketag = do+ spoke <- getLoc+ sectortype 0 spoketag+ housetex+ box 512 128 8 ceilheight housebright+ sectortype 0 0+ ammo+ pushpop $ do+ step 96 64+ triple $ do+ thing -- easyonly+ step 128 0+ pushpop $ do+ step 160 64+ triple $ do+ thing -- easy+ step 128 0+ step 16 32+ sectortype 0 tombtag+ lower "STONGARG"+ withXoff 60 $ ibox 16 64 64 ceilheight housebright+ sectortype 0 0+ popsector+ -- ceiling openings & windows+ setLoc spoke+ step 0 16+ skylights 512+ setLoc spoke+ step 512 (128+16)+ turnaround+ windows 512+ setLoc spoke+ step 512 0+ turnaround+ windows 512++ setLoc spoke+ step 512 0++ -- diamond tip+ let points = [ (64,-64), (64,0), (128,128) ]+ mapM_ (\(x,y) -> draw x y) points+ mapM_ (\(x,y) -> draw x y) (map (\(x,y) -> (-1*x,y)) (reverse points))++ draw 0 (-128)++ rightsector 8 ceilheight housebright++ step 64 0+ nicebutton (-16) ceilheight 200 0 0 trig walktag+ step 16 16+ turnaround+ x++---- nicebutton: draws a nice 64x64 button, with a raised 32x32 button+---- on the inside. Outer and inner lines are set to outer/inner trigger+---- and tag values. The button sector triggers itself (expected to be+---- used with floor lowering types)++nicebutton f c l outertrig outertag innertrig innertag = do+ floorflat "MFLR8_3"+ linetype outertrig outertag+ edged_ibox f c l 104 104 32+ step 20 20+ linetype innertrig innertag+ sectortype 0 innertag+ floorflat "DEM1_6"+ ibox 64 64 (16+f) c l+ sectortype 0 0+ linetype 0 0++--a box (w wide h tall) with a wedge cut out of the corners (wedge length √(2e²))++edged_ibox f c l w h e = do+ step e 0+ straight (h - (2*e))+ draw e e+ turnright+ straight (w - (2*e))+ draw e e+ turnright+ straight (h - (2*e))+ draw e e+ turnright+ straight (w - (2*e))+ draw e e+ turnright+ innerrightsector f c l+ step (-1*e) 0+++skylights :: Int -> State Context ()+skylights x = when (x >= 256) $ do+ step 48 0+ edged_ibox 8 (skyheight-32) (housebright+16) 96 160 16+ ceil "F_SKY1"+ pushpop $ do+ step 17 17+ edged_ibox 8 skyheight (housebright+24) (96-34) (160-34) 8+ housetex+ twice popsector+ step (80+128) 0+ skylights (x-256)++windows :: Int -> State Context ()+windows x = when ((24+128) <= x) $ do+ step 24 0+ sectortype 0 windowtag+ box 128 16 40 128 housebright -- window+ sectortype 0 0+ step 128 0+ windows (x - (24+128))++--a pointy-ceiling. TODO: generalise/extrapolate the 32/16 specifics+--holy crap this is slow :( probably splitlines+step_slope_ceiling f c l =+ mapM_ (\i -> do box 2 16 f (c+i) l >> step 2 0) ([1..32] ++ [32,31..1])++window :: State Context ()+window = do+ loc <- getLoc+ sectortype 0 windowtag+ step_slope_ceiling 40 64 housebright+ setLoc loc+ sectortype 0 0++courtyard outertag innertag walktag triggertype outer_button_tag outer_button_type monsters = do+ step (-56) 232 -- we're now half way along the diagonal hub walls, offset ~8+ loc <- getLoc++ let spokewall = [(88,-88), (416, 0), (64, 0), (64, 64), (64, 0), (144,-144)]++ housetex+ mapM_ (\(x,y) -> draw x y) spokewall++ outdoors+ straight 240+ turnright+ -- <-------- turret shape -------------->+ let outerwall = [(352,0),(32,32),(0,64),(64,0),(32,32),(32,-32),(320,320)]+ mapM_ (\(x,y) -> draw x y) outerwall+ mapM_ (\(x,y) -> draw x y) (map swap (reverse outerwall))++ turnaround+ straight 240++ housetex+ mapM_ (\(x,y) -> draw x y) $ map (\(x,y) -> (x,-1*y)) (reverse spokewall)++ outdoors+ rightsector 0 256 skybright++ -- three timebombs along the diagonal outside edge of the hub+ rocket+ step (-104) (-72)+ triple $ do+ step 44 44+ thing++ -- new demon cubes+ setLoc loc+ place 64 64 demoncube++ setLoc loc+ outdoors+ step 280 280+ step 32 32+ impbox outertag innertag triggertype walktag outer_button_type outer_button_tag monsters++impbox outertag innertag triggertype walktag outer_button_type outer_button_tag monsters = do+ loc <- getLoc+ ceil "F_SKY1"+ lower "MARBFACE"+ floorflat "DEM1_5"+ sectortype 0 innertag+ ibox 128 128 128 skyheight (skybright+32)+ sectortype 0 0+ pushpop $ do+ step 8 8+ lower "MARBLE3"+ floorflat "MFLR8_3"+ ibox (128-16) (128-16) (-8) skyheight (skybright+32)++ -- exit technique+ pushpop $ do+ step 4 4+ nicebutton 0 skyheight (skybright+32) outer_button_type outer_button_tag triggertype walktag+ step 16 16++ step 64 64+ turnleft+ pushpop monsters+ boxofrockets+ surround thing 40+ setLoc loc+ step (-16) (-16)+ shortredfirestick+ quad $ do+ thing+ step (32+128) 0+ turnright++starts = do+ pushpop $ do+ step (-64) 0+ player1start+ thing+ deathmatchstart+ thing+ step 128 0+ player2start+ thing+ step (-64) (-64)+ player3start+ thing+ step 0 128+ player4start+ thing++-- a 128 cube, with a 45° 128 cube on top+demoncube = do+ floorflat "DEM1_5"+ ceil "DEM1_5"+ lower "MARBFACE"+ upper "MARBFACE"+ step 32 0++ -- the inner octagon+ quad (straight 64 >> draw 32 32 >> turnright) -- Lines 1 & 2+ rightsector 128 128 skybright++ -- outer bigger triangles+ floorflat "MFLR8_4"+ quad $ do+ step 64 0+ withXoff 32 $ draw (-64) 0 -- redrawing Linedef 1+ innerrightsector 0 128 skybright+ draw 32 (-28) -- Linedef 9+ draw 32 28 -- Linedef 10+ extendsector++ step 32 32+ turnright++ -- outer smaller triangles+ floorflat "DEM1_5"+ ceil "F_SKY1"+ quad $ do+ step 96 32+ withXoff 42 $ draw (-32) (-32) -- redrawing Linedef 2+ innerrightsector 128 256 skybright+ draw 32 0 -- Linedef 11+ draw 0 32 -- Linedef 12+ extendsector+ turnright++ twice $ quad $ popsector+ popsector++ -- retrace the outer boundary of the demoncube and tie those lines into+ -- the parent sector+ quad $ do+ withXoff 96 $ straight (-32) -- redrawing linedef 12+ withXoff 0 $ draw 0 32 -- redrawing linedef 11+ withXoff 89 $ draw (-28) 32 -- redrawing linedef 10+ withXoff (-2) $ draw 28 32 -- redrawing linedef 9+ turnleft+ extendsector
+ logo.png view
binary file changed (absent → 72110 bytes)