diff --git a/LICENSE b/LICENSE
new file mode 100644
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ {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 .
+
+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:
+
+ haskellscrabble Copyright (C) 2013 Gordon Martin
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/Setup.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/haskellscrabble.cabal b/haskellscrabble.cabal
new file mode 100644
--- /dev/null
+++ b/haskellscrabble.cabal
@@ -0,0 +1,58 @@
+-- Initial haskellscrabble.cabal generated by cabal init. For further
+-- documentation, see http://haskell.org/cabal/users-guide/
+
+name: haskellscrabble
+version: 0.1.0.0
+synopsis: A scrabble library capturing the core game logic of scrabble.
+description: A scrabble library which enforces legal transitions between moves. Intended to facilitate the development of a playable game.
+homepage: http://www.github.com/happy0/haskellscrabble
+license: GPL-3
+license-file: LICENSE
+author: Gordon Martin
+maintainer: gordonhughmartin@gmail.com
+-- copyright:
+category: Game
+build-type: Simple
+cabal-version: >=1.8
+
+library
+ exposed-modules:
+ Wordify.Rules.Pos,
+ Wordify.Rules.Pos.Internal,
+ Wordify.Rules.LetterBag,
+ Wordify.Rules.LetterBag.Internal,
+ Wordify.Rules.Board,
+ Wordify.Rules.Board.Internal,
+ Wordify.Rules.Tile,
+ Wordify.Rules.Dictionary,
+ Wordify.Rules.Square,
+ Wordify.Rules.Player,
+ Wordify.Rules.Game,
+ Wordify.Rules.Move,
+ Wordify.Rules.FormedWord,
+ Wordify.Rules.ScrabbleError
+
+ other-modules: Wordify.Rules.Game.Internal
+
+ build-depends: base < 4.8, containers, array, random, mtl, transformers, QuickCheck,
+ parsec, unordered-containers, semigroups, errors, safe
+ hs-source-dirs: src
+
+test-suite tests
+ type: exitcode-stdio-1.0
+ hs-source-dirs: test .
+ main-is: Tests.hs
+
+ build-depends:
+ haskellscrabble,
+ base < 4.8,
+ QuickCheck,
+ HUnit,
+ test-framework,
+ test-framework-hunit,
+ test-framework-quickcheck2,
+ directory,
+ containers,
+ random,
+ semigroups,
+ filepath
diff --git a/src/Wordify/Rules/Board.hs b/src/Wordify/Rules/Board.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Board.hs
@@ -0,0 +1,107 @@
+module Wordify.Rules.Board(Board, allSquares, emptyBoard, placeTile, occupiedSquareAt,
+ lettersAbove, lettersBelow, lettersLeft, lettersRight, unoccupiedSquareAt) where
+
+ import Wordify.Rules.Square
+ import Wordify.Rules.Pos
+ import Data.Maybe
+ import Wordify.Rules.Tile
+ import qualified Data.Map as Map
+ import Control.Monad
+ import Data.Sequence as Seq
+ import Wordify.Rules.Board.Internal
+ import Control.Applicative
+
+ {- |
+ Returns all the squares on the board, ordered by column then row.
+ -}
+ allSquares :: Board -> [(Pos, Square)]
+ allSquares (Board squares) = Map.toList squares
+
+ {- |
+ Places a tile on a square and yields the new board, if the
+ target square is empty. Otherwise yields 'Nothing'.
+ -}
+ placeTile :: Board -> Tile -> Pos -> Maybe Board
+ placeTile board tile pos =
+ (\sq -> insertSquare board pos (putTileOn sq tile)) <$> unoccupiedSquareAt board pos
+
+ insertSquare :: Board -> Pos -> Square -> Board
+ insertSquare (Board squares) pos square = Board $ Map.insert pos square squares
+
+ squareAt :: Board -> Pos -> Maybe Square
+ squareAt (Board squares) = flip Map.lookup squares
+
+ {- | Returns the square at a given position if it is not occupied by a tile. Otherwise returns Nothing.-}
+ unoccupiedSquareAt :: Board -> Pos -> Maybe Square
+ unoccupiedSquareAt board pos =
+ squareAt board pos >>= (\sq -> if isOccupied sq then Nothing else Just sq)
+
+ {- | Returns the square at a given position if it is occupied by a tile. Otherwise returns Nothing.-}
+ occupiedSquareAt :: Board -> Pos -> Maybe Square
+ occupiedSquareAt board pos = squareAt board pos >>= squareIfOccupied
+
+ {- | All letters immediately above a given square until a non-occupied square -}
+ lettersAbove :: Board -> Pos -> Seq (Pos,Square)
+ lettersAbove board pos = walkFrom board pos above
+
+ {- | All letters immediately below a given square until a non-occupied square -}
+ lettersBelow :: Board -> Pos -> Seq (Pos,Square)
+ lettersBelow board pos = Seq.reverse $ walkFrom board pos below
+
+ {- | All letters immediately left of a given square until a non-occupied square -}
+ lettersLeft :: Board -> Pos -> Seq (Pos,Square)
+ lettersLeft board pos = Seq.reverse $ walkFrom board pos left
+
+ {- | All letters immediately right of a given square until a non-occupied square -}
+ lettersRight :: Board -> Pos -> Seq (Pos,Square)
+ lettersRight board pos = walkFrom board pos right
+
+ {-
+ Walks the tiles from a given position in a given direction
+ until an empty square is found or the boundary of the board
+ is reached.
+ -}
+ walkFrom :: Board -> Pos -> (Pos -> Maybe Pos) -> Seq (Pos,Square)
+ walkFrom board pos direction = maybe mzero (\(next,sq) ->
+ (next, sq) <| walkFrom board next direction) neighbourPos
+ where
+ neighbourPos = direction pos >>= \nextPos -> occupiedSquareAt board nextPos >>=
+ \sq -> return (nextPos, sq)
+
+ {- |
+ Creates an empty board.
+ -}
+ emptyBoard :: Board
+ emptyBoard = Board (Map.fromList posSquares)
+ where
+ layout =
+ [["TW","N","N","DL","N","N","N","TW","N","N","N","DL","N","N","TW"]
+ ,["N","DW","N","N","N","TL","N","N","N","TL","N","N","N","DW","N"]
+ ,["N","N","DW","N","N","N","DL","N","DL","N","N","N","DW","N","N"]
+ ,["DL","N","N","DW","N","N","N","DL","N","N","N","DW","N","N","DL"]
+ ,["N","N","N","N","DW","N","N","N","N","N","DW","N","N","N","N"]
+ ,["N","TL","N","N","N","TL","N","N","N","TL","N","N","N","TL","N"]
+ ,["N","N","DL","N","N","N","DL","N","DL","N","N","N","DL","N","N"]
+ ,["TW","N","N","DL","N","N","N","DW","N","N","N","DL","N","N","TW"]
+ ,["N","N","DL","N","N","N","DL","N","DL","N","N","N","DL","N","N"]
+ ,["N","TL","N","N","N","TL","N","N","N","TL","N","N","N","TL","N"]
+ ,["N","N","N","N","DW","N","N","N","N","N","DW","N","N","N","N"]
+ ,["DL","N","N","DW","N","N","N","DL","N","N","N","DW","N","N","DL"]
+ ,["N","N","DW","N","N","N","DL","N","DL","N","N","N","DW","N","N"]
+ ,["N","DW","N","N","N","TL","N","N","N","TL","N","N","N","DW","N"]
+ ,["TW","N","N","DL","N","N","N","TW","N","N","N","DL","N","N","TW"]]
+
+ squares = (map . map) toSquare layout
+ columns = Prelude.zip [1..15] squares
+ labeledSquares= concatMap (uncurry columnToMapping) columns
+ columnToMapping columnNo columnSquares = Prelude.zipWith (\sq y -> ((columnNo,y),sq)) columnSquares [1..15]
+ posSquares = mapMaybe (\((x,y), sq) -> fmap (\pos -> (pos, sq)) (posAt (x,y))) labeledSquares
+
+ toSquare :: String -> Square
+ toSquare "DL" = DoubleLetter Nothing
+ toSquare "TL" = TripleLetter Nothing
+ toSquare "DW" = DoubleWord Nothing
+ toSquare "TW" = TripleWord Nothing
+ toSquare _ = Normal Nothing
+
+
diff --git a/src/Wordify/Rules/Board/Internal.hs b/src/Wordify/Rules/Board/Internal.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Board/Internal.hs
@@ -0,0 +1,7 @@
+module Wordify.Rules.Board.Internal (Board(Board)) where
+
+ import Wordify.Rules.Pos
+ import Wordify.Rules.Square
+ import qualified Data.Map as Map
+
+ data Board = Board (Map.Map Pos Square) deriving (Show, Eq)
diff --git a/src/Wordify/Rules/Dictionary.hs b/src/Wordify/Rules/Dictionary.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Dictionary.hs
@@ -0,0 +1,60 @@
+module Wordify.Rules.Dictionary (Dictionary, isValidWord, makeDictionary, invalidWords, dictionaryFromWords) where
+
+ import qualified Data.HashSet as HashSet
+ import Wordify.Rules.ScrabbleError
+ import qualified Control.Exception as Exc
+ import Text.ParserCombinators.Parsec
+ import Data.Char
+ import Control.Monad
+
+ data Dictionary = Dictionary (HashSet.HashSet String) deriving Show
+
+ {- |
+ Returns the list of words which are not present in the given dictionary from a
+ list of input words.
+ -}
+ invalidWords :: Dictionary -> [String] -> [String]
+ invalidWords dictionary = filter $ not . isValidWord dictionary
+
+ {-
+ Returns true if the given word is in the given dictionary.
+ -}
+ isValidWord :: Dictionary -> String -> Bool
+ isValidWord (Dictionary dictionaryWords) = flip HashSet.member dictionaryWords
+
+ dictionaryFromWords :: [String] -> Dictionary
+ dictionaryFromWords wordList = Dictionary $ HashSet.fromList upperCaseWords
+ where
+ upperCaseWords = (map . map) toUpper wordList
+
+ {- |
+ Creates a dictionary from a file containing a list of valid words, each word being seperated by a newline.
+ -}
+ makeDictionary :: FilePath -> IO (Either ScrabbleError Dictionary)
+ makeDictionary filePath =
+ do
+ fileContents <- Exc.try (readFile filePath) :: IO (Either Exc.IOException String)
+ case fileContents of
+ Left _ -> return $ Left (DictionaryFileNotFound filePath)
+ Right dictContents ->
+ let dictWords = parseFile dictContents
+ in case dictWords of
+ Left _ -> return $ Left (MalformedDictionaryFile filePath)
+ Right wordList -> return $ Right (Dictionary $ HashSet.fromList wordList)
+
+ where
+ toUpperCase = (map . map) toUpper
+ parseFile contents = liftM toUpperCase $ parse dictionaryFile "Malformed dictionary file " contents
+
+ dictionaryFile =
+ do
+ dictWords <- many word
+ _ <- eof
+ return dictWords
+
+ word =
+ do
+ entry <- many letter
+ _ <- newline
+ return entry
+
diff --git a/src/Wordify/Rules/FormedWord.hs b/src/Wordify/Rules/FormedWord.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/FormedWord.hs
@@ -0,0 +1,203 @@
+module Wordify.Rules.FormedWord
+ (
+ FormedWords,
+ FormedWord,
+ wordsFormedMidGame,
+ wordFormedFirstMove,
+ wordStrings,
+ wordsWithScores,
+ mainWord,
+ adjacentWords,
+ playerPlaced,
+ bingoBonusApplied
+ ) where
+
+ import Wordify.Rules.Pos
+ import Wordify.Rules.Square
+ import Wordify.Rules.Tile
+ import Wordify.Rules.Board
+ import Wordify.Rules.ScrabbleError
+ import Data.Sequence as Seq
+ import Data.Map as Map
+ import Control.Applicative
+ import Control.Monad
+ import Data.Foldable as Foldable
+ import qualified Data.Maybe as M
+
+ data FormedWords = FirstWord FormedWord | FormedWords {
+ main :: FormedWord
+ , otherWords :: [FormedWord]
+ , placed :: Map Pos Square
+ } deriving (Show, Eq)
+
+ type FormedWord = Seq (Pos, Square)
+ data Direction = Horizontal | Vertical deriving Eq
+
+ {- |
+ Returns the word formed by the first move on the board. The word must cover
+ the star tile, and be linear. Any blank tiles must be labeled.
+ -}
+ wordFormedFirstMove :: Board -> Map Pos Tile -> Either ScrabbleError FormedWords
+ wordFormedFirstMove board tiles =
+ if starPos `Map.notMember` tiles
+ then Left DoesNotCoverTheStarTile
+ else placedSquares board tiles >>=
+ \squares -> (FirstWord . main) <$> wordsFormed board squares
+
+ {- |
+ Returns the words formed by the tiles played on the board. A played word
+ must be connected to a tile already on the board (or intersect tiles on the board),
+ and be formed linearly. Any blank tiles must be labeled.
+ -}
+ wordsFormedMidGame :: Board -> Map Pos Tile -> Either ScrabbleError FormedWords
+ wordsFormedMidGame board tiles = placedSquares board tiles >>=
+ \squares -> wordsFormed board squares >>= \formed ->
+ let FormedWords x xs _ = formed
+ -- Check it connects to at least one other word on the board
+ in if Seq.length x > Map.size squares || not (Prelude.null xs)
+ then Right $ FormedWords x xs squares
+ else Left DoesNotConnectWithWord
+
+ {- |
+ Returns the main word formed by the played tiles. The main word is
+ the linear stretch of tiles formed by the tiles placed.
+ -}
+ mainWord :: FormedWords -> FormedWord
+ mainWord (FirstWord word) = word
+ mainWord formed = main formed
+
+ {- |
+ Returns the list of words which were adjacent to the main word formed.
+ -}
+ adjacentWords :: FormedWords -> [FormedWord]
+ adjacentWords (FirstWord _) = []
+ adjacentWords formed = otherWords formed
+
+ {- |
+ Returns the list of positions mapped to the squares that the player placed their tiles on.
+ -}
+ playerPlaced :: FormedWords -> [(Pos, Square)]
+ playerPlaced (FirstWord word) = Foldable.toList word
+ playerPlaced formed = Map.toList $ placed formed
+
+ {- |
+ Scores the words formed by the tiles placed. The first item in the tuple is the overall
+ score, while the second item is the list of scores for all the words formed.
+ -}
+ wordsWithScores :: FormedWords -> (Int, [(String, Int)])
+ wordsWithScores (FirstWord firstWord) =
+ let score = scoreWord Seq.empty (fmap snd firstWord)
+ in (bingoBonus score (Seq.length firstWord), [(makeString firstWord, score)])
+ wordsWithScores (FormedWords mainW others played) =
+ (bingoBonus (Prelude.sum scores) (Map.size played), Prelude.zip strings scores)
+ where
+ allWords = mainW : others
+ strings = Prelude.map makeString allWords
+ scores = Prelude.map (\formedWord -> let (notAlreadyPlaced, alreadyPlaced) = partitionPlaced formedWord
+ in scoreWord (fmap snd alreadyPlaced) (fmap snd notAlreadyPlaced) ) allWords
+ partitionPlaced = Seq.partition (\(pos, _) -> Map.member pos played)
+
+
+ {-
+ It is a rule in scrabble that if the player manages to place all 7 letters, they receive a bonus of '50'
+ to their score.
+ -}
+ bingoBonus :: Int -> Int -> Int
+ bingoBonus score playedLetters = if playedLetters < 7 then score else score + 50
+
+ {- |
+ Returns true if the player placed all 7 of their letters while forming these words, incurring a + 50 score bonus.
+ -}
+ bingoBonusApplied :: FormedWords -> Bool
+ bingoBonusApplied formed = Prelude.length (playerPlaced formed) == 7
+
+ {- |
+ Returns the words formed by the play as strings.
+ -}
+ wordStrings :: FormedWords -> [String]
+ wordStrings (FirstWord word) = [makeString word]
+ wordStrings formed = Prelude.map makeString $ main formed : otherWords formed
+
+ makeString :: FormedWord -> String
+ makeString word = M.mapMaybe (\(_, sq) -> tileIfOccupied sq >>= tileLetter) $ Foldable.toList word
+
+ {-
+ Checks that the tiles can be placed, and if so turns a map of the squares at the placed positions.
+ A tile may be placed if the square is not already occupied, and if it is not an unlabeled blank tile.
+ -}
+ placedSquares :: Board -> Map Pos Tile -> Either ScrabbleError (Map Pos Square)
+ placedSquares board tiles = squares
+ where
+ squares = Map.fromList <$> sequence ((\ (pos, tile) ->
+ posTileIfNotBlank (pos, tile) >>= squareIfUnoccupied) <$> mapAsList)
+
+ posTileIfNotBlank (pos,tile) =
+ if tile == Blank Nothing then Left (CannotPlaceBlankWithoutLetter pos) else Right (pos, tile)
+ squareIfUnoccupied (pos,tile) = maybe (Left (PlacedTileOnOccupiedSquare pos tile)) (\sq ->
+ Right (pos, putTileOn sq tile)) $ unoccupiedSquareAt board pos
+ mapAsList = Map.toList tiles
+
+ wordsFormed :: Board -> Map Pos Square -> Either ScrabbleError FormedWords
+ wordsFormed board tiles
+ | Map.null tiles = Left NoTilesPlaced
+ | otherwise = formedWords >>= \formed ->
+ case formed of
+ x : xs -> Right $ FormedWords x xs tiles
+ [] -> Left NoTilesPlaced
+ where
+ formedWords = maybe (Left $ MisplacedLetter maxPos) (\direction ->
+ middleFirstWord direction >>= (\middle ->
+ let (midWord, _) = middle
+ in let mainLine = preceding direction minPos >< midWord >< after direction maxPos
+ in Right $ mainLine : adjacentToMain (swapDirection direction) ) ) getDirection
+
+ preceding direction pos = case direction of
+ Horizontal -> lettersLeft board pos
+ Vertical -> lettersBelow board pos
+ after direction pos = case direction of
+ Horizontal -> lettersRight board pos
+ Vertical -> lettersAbove board pos
+
+ (minPos, _) = Map.findMin tiles
+ (maxPos, _) = Map.findMax tiles
+
+ adjacentToMain direction = Prelude.filter (\word -> Seq.length word > 1) $ Prelude.map (\(pos, square) ->
+ (preceding direction pos |> (pos, square)) >< after direction pos) placedList
+
+ middleFirstWord direction =
+ case placedList of
+ x:[] -> Right (Seq.singleton x, minPos)
+ (x:xs) ->
+ foldM (\(word, lastPos) (pos, square) ->
+ if not $ stillOnPath lastPos pos direction
+ then Left $ MisplacedLetter pos
+ else
+ if isDirectlyAfter lastPos pos direction then Right (word |> (pos, square), pos) else
+ let between = after direction lastPos in
+ if expectedLettersInbetween direction lastPos pos between
+ then Right ( word >< ( between |> (pos,square) ), pos)
+ else Left $ MisplacedLetter pos
+ ) (Seq.singleton x, minPos ) xs
+ [] -> Left NoTilesPlaced
+
+ placedList = Map.toAscList tiles
+
+ stillOnPath lastPos thisPos direction = staticDirectionGetter direction thisPos == staticDirectionGetter direction lastPos
+ expectedLettersInbetween direction lastPos currentPos between =
+ Seq.length between + 1 == movingDirectionGetter direction currentPos - movingDirectionGetter direction lastPos
+
+ swapDirection direction = if direction == Horizontal then Vertical else Horizontal
+
+ getDirection
+ -- If only one tile is placed, we look for the first tile it connects with if any. If it connects with none, we return 'Nothing'
+ | (minPos == maxPos) && (not (Seq.null (lettersLeft board minPos)) || not (Seq.null (lettersRight board minPos))) = Just Horizontal
+ | (minPos == maxPos) && (not (Seq.null (lettersBelow board minPos)) || not (Seq.null (lettersAbove board minPos))) = Just Vertical
+ | xPos minPos == xPos maxPos = Just Vertical
+ | yPos minPos == yPos maxPos = Just Horizontal
+ | otherwise = Nothing
+
+ staticDirectionGetter direction pos = if direction == Horizontal then yPos pos else xPos pos
+
+ movingDirectionGetter direction pos = if direction == Horizontal then xPos pos else yPos pos
+
+ isDirectlyAfter pos nextPos direction = movingDirectionGetter direction nextPos == movingDirectionGetter direction pos + 1
diff --git a/src/Wordify/Rules/Game.hs b/src/Wordify/Rules/Game.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Game.hs
@@ -0,0 +1,97 @@
+module Wordify.Rules.Game(Game, player1, player2, optionalPlayers, currentPlayer,
+ board, bag, dictionary, playerNumber, moveNumber, makeGame, getGameStatus,
+ GameStatus(InProgress, Finished), gameStatus, players, passes, numberOfPlayers, history, History(History),movesMade) where
+
+ import Wordify.Rules.Player
+ import Wordify.Rules.Board
+ import Wordify.Rules.Dictionary
+ import Wordify.Rules.LetterBag
+ import Wordify.Rules.ScrabbleError
+ import Data.Maybe
+ import Wordify.Rules.Game.Internal
+ import qualified Data.Sequence as Seq
+ import qualified Data.Foldable as F
+ import Safe
+ import Control.Monad
+ import Control.Applicative
+
+ {- |
+ Starts a new game.
+
+ A game has at least 2 players, and 2 optional players (player 3 and 4.) The players should be newly created,
+ as tiles from the letter bag will be distributed to each player.
+
+ Takes a letter bag and dictionary, which should be localised to the same language.
+
+ Yields a tuple with the first player and the initial game state. Returns a 'Left' if there are not enough
+ tiles in the letter bag to distribute to the players.
+ -}
+ makeGame :: (Player, Player, Maybe (Player, Maybe Player)) -> LetterBag -> Dictionary -> Either ScrabbleError Game
+ makeGame playing startBag dict =
+ do
+ (remainingBag, initialPlayers) <- initialisePlayers playing startBag
+ case initialPlayers of
+ firstPlayer : secondPlayer : optionals ->
+ return $ Game firstPlayer secondPlayer (toOptionalPlayers optionals) emptyBoard
+ remainingBag dict firstPlayer firstPlayerNumber firstMoveNumber initialPasses initialGameState initialHistory
+ _ -> Left $ MiscError "Unexpected error in logic. There were not at least two players. This should never happen."
+ where
+ initialHistory = History startBag Seq.empty
+ firstPlayerNumber = 1
+ firstMoveNumber = 1
+ initialPasses = 0
+ initialGameState = InProgress
+
+ toOptionalPlayers :: [Player] -> Maybe (Player, Maybe Player)
+ toOptionalPlayers (x : []) = Just (x, Nothing)
+ toOptionalPlayers (x : y : []) = Just (x, Just y)
+ toOptionalPlayers _ = Nothing
+
+
+ initialisePlayers :: (Player, Player, Maybe (Player, Maybe Player)) -> LetterBag -> Either ScrabbleError (LetterBag, [Player])
+ initialisePlayers (play1, play2, maybePlayers) initialBag =
+ let transitions = distributeFinite givePlayerTiles initialBag allPlayers
+ in case (join . lastMay) transitions of
+ Nothing -> Left $ NotEnoughLettersInStartingBag (bagSize initialBag)
+ Just (finalBag, _) -> Right (finalBag, map snd (catMaybes transitions))
+ where
+ allPlayers = [play1, play2] ++ optionalsToPlayers maybePlayers
+ givePlayerTiles currentBag giveTo =
+ (\(newTiles, newBag) -> (newBag, giveTiles giveTo newTiles)) <$> takeLetters currentBag 7
+
+ distributeFinite :: (b -> a -> Maybe (b, a)) -> b -> [a] -> [Maybe (b, a)]
+ distributeFinite takeUsing distributeFrom = go takeUsing (Just distributeFrom)
+ where
+ go :: (b -> a -> Maybe (b,a)) -> Maybe b -> [a] -> [Maybe (b, a)]
+ go _ _ [] = []
+ go giveBy Nothing (_ : receivers) = Nothing : go giveBy Nothing receivers
+ go giveBy (Just distributer) (receiver : receivers) =
+ case giveBy distributer receiver of
+ Nothing -> Nothing : go giveBy Nothing receivers
+ Just (currentDistributer, currentReceiver) ->
+ Just (currentDistributer, currentReceiver) : go giveBy (Just currentDistributer) receivers
+
+
+ optionalsToPlayers :: Maybe (Player, Maybe Player) -> [Player]
+ optionalsToPlayers optionals = case optionals of
+ Nothing -> []
+ Just (player3, Nothing) -> [player3]
+ Just (player3, Just player4) -> [player3, player4]
+
+
+ players :: Game -> [Player]
+ players game = [player1 game, player2 game] ++ optionalsToPlayers (optionalPlayers game)
+
+ getGameStatus :: Game -> GameStatus
+ getGameStatus = gameStatus
+
+ numberOfPlayers :: Game -> Int
+ numberOfPlayers game = 2 + maybe 0 (\(_, maybePlayer4) -> if isJust maybePlayer4 then 2 else 1) (optionalPlayers game)
+
+ {- |
+ Returns a history of the moves made in the game.
+ -}
+ movesMade :: Game -> [Move]
+ movesMade game =
+ case history game of
+ History _ moves -> F.toList moves
diff --git a/src/Wordify/Rules/Game/Internal.hs b/src/Wordify/Rules/Game/Internal.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Game/Internal.hs
@@ -0,0 +1,107 @@
+module Wordify.Rules.Game.Internal (updateGame, Game(Game),
+ GameStatus(InProgress, Finished),
+ moveNumber,
+ playerNumber,
+ currentPlayer,
+ passes,
+ nextPlayer,
+ player1,
+ player2,
+ optionalPlayers,
+ gameStatus,
+ board,
+ bag,
+ pass,
+ dictionary,
+ updateHistory,
+ Move(PlaceTiles, Exchange, Pass),
+ History(History),
+ history) where
+
+ import Wordify.Rules.Player
+ import Wordify.Rules.Board
+ import Wordify.Rules.LetterBag
+ import Wordify.Rules.Dictionary
+ import Control.Applicative
+ import Data.Map
+ import Wordify.Rules.Pos
+ import Wordify.Rules.Tile
+ import Data.Sequence
+
+ data Move = PlaceTiles (Map Pos Tile) | Exchange [Tile] | Pass deriving (Eq, Show)
+
+ data History = History LetterBag (Seq Move) deriving (Eq, Show)
+
+ data GameStatus = InProgress | Finished deriving (Eq, Show)
+
+ data Game = Game { player1 :: Player
+ , player2 :: Player
+ , optionalPlayers :: Maybe (Player, Maybe Player)
+ , board :: Board
+ , bag :: LetterBag
+ , dictionary :: Dictionary
+ , currentPlayer :: Player
+ , playerNumber :: Int
+ , moveNumber :: Int
+ , passes :: Int
+ , gameStatus :: GameStatus
+ , history :: History }
+
+ {-
+ Updates the game with the new board and letter bag state, and the last player to play's state after replacing their played
+ tiles with new tiles from the letter bag.
+
+ Yields the next game state.
+ -}
+ updateGame :: Game -> Player -> Board -> LetterBag -> Game
+ updateGame game player newBoard newBag =
+ updatedPlayerGame {board = newBoard, bag = newBag, currentPlayer = newPlayer, playerNumber = newPlayerNum, moveNumber = succ moveNo, passes = 0}
+ where
+ updatedPlayerGame = updateCurrentPlayer game player
+ (newPlayerNum, newPlayer) = nextPlayer game
+ moveNo = moveNumber game
+
+ updateCurrentPlayer :: Game -> Player -> Game
+ updateCurrentPlayer game player =
+ case playing of
+ 1 -> game {player1 = player}
+ 2 -> game {player2 = player}
+ 3 -> game {optionalPlayers = (\(_, player4) -> (player, player4)) <$> maybePlayers }
+ _ -> game {optionalPlayers = (\(player3, _) -> (player3, (Just player))) <$> maybePlayers }
+
+ where
+ playing = playerNumber game
+ maybePlayers = optionalPlayers game
+
+ {- Returns the next player to play. If there are optional players, loops back round to 'player 1' where appropriate. -}
+ nextPlayer :: Game -> (Int, Player)
+ nextPlayer game
+ | (playing == 1) = (2, playr2)
+ | (playing == 2 || playing == 3) =
+ maybe ( (1, playr1) ) (\(player3, player4) ->
+ if (playing == 2) then (3, player3 )
+ else
+ case player4 of
+ Just playr4 -> (4, playr4)
+ Nothing -> (1, playr1)
+ ) $ maybePlayers
+ | otherwise = (1, playr1)
+
+ where
+ playing = playerNumber game
+ playr2 = player2 game
+ playr1 = player1 game
+ maybePlayers = optionalPlayers game
+
+
+ pass :: Game -> Game
+ pass game = game {moveNumber = succ moveNo, playerNumber = playerNo, currentPlayer = player, passes = succ numPasses}
+ where
+ (playerNo, player) = nextPlayer game
+ numPasses = passes game
+ moveNo = moveNumber game
+
+ updateHistory :: Game -> Move -> Game
+ updateHistory game move = game {history = History originalBag (moveList |> move) }
+ where
+ History originalBag moveList = history game
diff --git a/src/Wordify/Rules/LetterBag.hs b/src/Wordify/Rules/LetterBag.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/LetterBag.hs
@@ -0,0 +1,179 @@
+module Wordify.Rules.LetterBag (
+ LetterBag,
+ makeBag,
+ takeLetters,
+ exchangeLetters,
+ shuffleBag, bagSize,
+ tiles,
+ bagFromTiles,
+ makeBagUsingGenerator,
+ getGenerator,
+ shuffleWithNewGenerator) where
+
+import Wordify.Rules.Tile
+import System.Random
+import Data.Array.IO
+import Control.Monad
+import qualified Control.Exception as Exc
+import Wordify.Rules.ScrabbleError
+import Text.ParserCombinators.Parsec
+import Data.Char
+import Wordify.Rules.LetterBag.Internal
+import System.IO
+import Data.Array.ST
+import Control.Monad.ST
+import Data.STRef
+
+{- |
+ Creates a letter bag from a file where each line contains a space delimited letter character, letter value, and letter distribution.
+ A blank letter is represented by a '_' character and has a disribution, but no value.
+
+ If successful, the letter bag is shuffled before it is returned.
+
+-}
+makeBag :: FilePath -> IO (Either ScrabbleError LetterBag)
+makeBag path = do
+ ioOutcome <- Exc.try $ withFile path ReadMode (hGetContents >=> parseBagString path) :: IO (Either Exc.IOException (Either ScrabbleError LetterBag))
+ case ioOutcome of
+ Left _ -> return $ Left (LetterBagFileNotOpenable path)
+ Right x -> return $ fmap shuffleBag x
+
+parseBagString :: String -> String -> IO (Either ScrabbleError LetterBag)
+parseBagString path bagString =
+ let parseResult = parseBag bagString in
+ case parseResult of
+ Left _ -> return $ Left (MalformedLetterBagFile path)
+ Right parsedTiles ->
+ do
+ gen <- newStdGen
+ return $ Right (LetterBag parsedTiles (length parsedTiles) gen)
+
+{- |
+ Creates a letter bag from a list of tiles. The order of the tiles is retained in the resulting letter bag.
+
+ This function is effectful as it is necessary to create a stdGen for list to allow
+ it to be shuffled using this generator in the future.
+-}
+bagFromTiles :: [Tile] -> IO LetterBag
+bagFromTiles bagTiles = newStdGen >>= return . LetterBag bagTiles (length bagTiles)
+
+{- |
+ Takes 'n' numbers from a letter bag, yielding 'Nothing'
+ if there is not enough tiles left in the bag or a 'Just'
+ tuple where the left value is the taken tiles, and the right
+ value is the new bag.
+-}
+takeLetters :: LetterBag -> Int -> Maybe ([Tile], LetterBag)
+takeLetters (LetterBag bagTiles lettersLeft gen) numTake =
+ if (newNumLetters < 0) then Nothing
+ else Just (taken, LetterBag newLetters newNumLetters gen)
+ where
+ newNumLetters = lettersLeft - numTake
+ (taken, newLetters) = splitAt numTake bagTiles
+
+{- |
+ Exchanges given tiles for the same number of tiles from the bag.
+ The exchanged letters are added to the bag, the bag is then shuffled,
+ and then the same number of tiles as exchanged are drawn from the bag.
+
+ Returns 'Nothing' if there are not enough letters in the bag to exchange
+ the given tiles for. Otherwise returns 'Just' with a tuple with the tiles
+ given, and the new letterbag.
+-}
+exchangeLetters :: LetterBag -> [Tile] -> (Maybe ([Tile], LetterBag))
+exchangeLetters (LetterBag bagTiles lettersLeft gen) exchanged =
+ if (lettersLeft == 0) then Nothing else takeLetters (shuffleBag intermediateBag) numLettersGiven
+ where
+ numLettersGiven = length exchanged
+ intermediateBag = LetterBag (exchanged ++ bagTiles) (lettersLeft + numLettersGiven) gen
+
+{- |
+ Shuffles the contents of a letter bag. The bag is shuffled using the random generator which was created
+ while constructing the bag.
+
+ This function should not be used when creating an additional game with a new letter bag as
+ the same seed value will be shared across games (meaning tiles will come out of the bag in
+ the same order.) When constructing an additional game, use shuffleWithNewGenerator.
+-}
+shuffleBag :: LetterBag -> LetterBag
+shuffleBag (LetterBag _ 0 gen) = LetterBag [] 0 gen
+shuffleBag (LetterBag bagTiles size gen) =
+ let (newTiles, newGenerator) = shuffle bagTiles gen size
+ in (LetterBag newTiles size newGenerator)
+
+ where
+ -- Taken from http://www.haskell.org/haskellwiki/Random_shuffle
+ shuffle :: [a] -> StdGen -> Int -> ([a],StdGen)
+ shuffle xs randomGen listLength = runST (do
+ g <- newSTRef randomGen
+ let randomRST lohi = do
+ (a,s') <- liftM (randomR lohi) (readSTRef g)
+ writeSTRef g s'
+ return a
+ ar <- newArr n xs
+ xs' <- forM [1..n] $ \i -> do
+ j <- randomRST (i,n)
+ vi <- readArray ar i
+ vj <- readArray ar j
+ writeArray ar j vi
+ return vj
+ gen' <- readSTRef g
+ return (xs',gen'))
+ where
+ n = listLength
+ newArr :: Int -> [a] -> ST s (STArray s Int a)
+ newArr z zs = newListArray (1,z) zs
+
+{- |
+ Creates a letter bag using a list of tiles, and a generator which should be used when shuffling the bag.
+ This function allows a game to be stepped through from the beginning where the moves and original generator were
+ recorded, with any shuffling yielding the same bag as in the original game.
+-}
+makeBagUsingGenerator :: [Tile] -> StdGen -> LetterBag
+makeBagUsingGenerator bagTiles randomGenerator = LetterBag bagTiles (length bagTiles) randomGenerator
+
+{- |
+ Get the letter bag's current generator, which will be used to shuffle the contents of the bag in the next exchange
+ or shuffle. If taken at the start of the game, with the original list of tiles in the bag in order, the game moves
+ may be replayed in order with the original results of any shuffle retained.
+-}
+getGenerator :: LetterBag -> StdGen
+getGenerator = generator
+
+{- |
+ Shuffles a letter bag using a new random generator. This function should be used when spawning a new game using
+ a letter bag with all the tiles remaining so that letter bags are unique between game instances.
+-}
+shuffleWithNewGenerator :: LetterBag -> IO LetterBag
+shuffleWithNewGenerator letterBag = fmap (\newGen -> shuffleBag $ letterBag { generator = newGen }) newStdGen
+
+parseBag :: String -> Either ParseError [Tile]
+parseBag contents = parse bagFile "Malformed letter bag file" contents
+ where
+ bagFile =
+ do bagTiles <- many bagLine
+ eof
+ let flattenedTiles = concat bagTiles
+ return $ flattenedTiles
+
+ bagLine =
+ do bagTiles <- try (letterTiles) <|> blankTiles
+ return bagTiles
+
+ letterTiles =
+ do
+ tileCharacter <- letter
+ _ <- space
+ value <- many digit
+ _ <- space
+ distribution <- many digit
+ _ <- newline
+ return $ replicate (read distribution) (Letter (toUpper tileCharacter) (read value))
+
+ blankTiles =
+ do
+ _ <- char '_'
+ _ <- space
+ distribution <- many digit
+ _ <- newline
+ return $ replicate (read distribution) (Blank Nothing)
diff --git a/src/Wordify/Rules/LetterBag/Internal.hs b/src/Wordify/Rules/LetterBag/Internal.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/LetterBag/Internal.hs
@@ -0,0 +1,9 @@
+module Wordify.Rules.LetterBag.Internal (LetterBag(LetterBag), tiles, bagSize, generator) where
+
+ import Wordify.Rules.Tile
+ import System.Random
+
+ data LetterBag = LetterBag { tiles :: [Tile], bagSize :: Int, generator :: StdGen } deriving (Show)
+
+ instance Eq LetterBag where
+ bag1 == bag2 = (bagSize bag1 == bagSize bag2 && tiles bag1 == tiles bag2)
diff --git a/src/Wordify/Rules/Move.hs b/src/Wordify/Rules/Move.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Move.hs
@@ -0,0 +1,191 @@
+module Wordify.Rules.Move (makeMove
+ ,Move(PlaceTiles, Exchange, Pass)
+ ,GameTransition(MoveTransition, ExchangeTransition, PassTransition, GameFinished)
+ ,restoreGame
+ ,restoreGameLazy
+ ,newGame) where
+
+ import Wordify.Rules.ScrabbleError
+ import Wordify.Rules.FormedWord
+ import Control.Monad
+ import Control.Applicative
+ import Wordify.Rules.Player
+ import qualified Data.Map as Map
+ import Wordify.Rules.Pos
+ import Wordify.Rules.Tile
+ import Wordify.Rules.LetterBag
+ import Wordify.Rules.Board
+ import Wordify.Rules.Dictionary
+ import Wordify.Rules.Game.Internal
+ import Wordify.Rules.Game
+ import qualified Data.List.NonEmpty as NE
+ import qualified Data.Traversable as T
+ import qualified Data.Map as M
+ import Control.Error.Util
+ import Control.Arrow
+
+ data GameTransition = -- | The new player (with their updated letter rack and score), new game state, and the words formed by the move
+ MoveTransition Player Game FormedWords
+ -- | The new game state, and the player with their rack before and after the exchange respectively.
+ | ExchangeTransition Game Player Player
+ -- | The new game state with the opportunity to play passed on to the next player.
+ | PassTransition Game
+ {- |
+ The game has finished. The final game state, and the final words formed (if the game was ended by a
+ player placing their final tiles.) The players before their scores were increased or decreased is also
+ given.
+ -}
+ | GameFinished Game (Maybe FormedWords) [Player]
+
+ {-|
+ Transitiions the game to the next state. If the move places tiles, the player must have the tiles to place and
+ place the tiles legally. If the move exchanges tiles, the bag must not be empty and the player must have the
+ tiles to exchange. A ScrabbleError is returned if these condtions are not the case.
+ -}
+ makeMove :: Game -> Move -> Either ScrabbleError GameTransition
+ makeMove game move
+ | gameStatus game /= InProgress = Left GameNotInProgress
+ | otherwise = flip addMoveToHistory move <$> gameTransition
+ where
+ gameTransition = case move of
+ PlaceTiles placed -> makeBoardMove game placed
+ Exchange exchanged -> exchangeMove game exchanged
+ Pass -> passMove game
+
+ makeBoardMove :: Game -> M.Map Pos Tile -> Either ScrabbleError GameTransition
+ makeBoardMove game placed =
+ do
+ formed <- formedWords
+ (overallScore, _) <- scoresIfWordsLegal dict formed
+ nextBoard <- newBoard currentBoard placed
+ intermediatePlayer <- removeLettersandGiveScore player playedTiles overallScore
+
+ if hasEmptyRack intermediatePlayer && (bagSize letterBag == 0)
+ then
+ do
+ let beforeFinalisingGame = updateGame game intermediatePlayer nextBoard letterBag
+ let finalisedGame = finaliseGame beforeFinalisingGame
+ return $ GameFinished finalisedGame (Just formed) (players beforeFinalisingGame)
+ else
+ do
+ let (newPlayer, newBag) = updatePlayerRackAndBag intermediatePlayer letterBag (Map.size placed)
+ let updatedGame = updateGame game newPlayer nextBoard newBag
+ return $ MoveTransition newPlayer updatedGame formed
+ where
+ player = currentPlayer game
+ playedTiles = Map.elems placed
+ currentBoard = board game
+ dict = dictionary game
+ letterBag = bag game
+
+ formedWords = if any isPlaceMove (movesMade game)
+ then wordsFormedMidGame currentBoard placed
+ else wordFormedFirstMove currentBoard placed
+
+ isPlaceMove mv = case mv of
+ PlaceTiles _ -> True
+ _ -> False
+
+
+ exchangeMove :: Game -> [Tile] -> Either ScrabbleError GameTransition
+ exchangeMove game exchangedTiles =
+ let exchangeOutcome = exchangeLetters (bag game) exchangedTiles
+ in case exchangeOutcome of
+ Nothing -> Left CannotExchangeWhenNoLettersInBag
+ Just (givenTiles, newBag) ->
+ let newPlayer = exchange player exchangedTiles givenTiles
+ in maybe (Left $ PlayerCannotExchange (rack player) exchangedTiles) (\exchangedPlayer ->
+ let gameState = updateGame game exchangedPlayer (board game) newBag
+ in Right $ ExchangeTransition gameState player exchangedPlayer) newPlayer
+ where
+ player = currentPlayer game
+
+ passMove :: Game -> Either ScrabbleError GameTransition
+ passMove game =
+ let gameState = pass game
+ in
+ Right $
+ if gameFinished
+ then GameFinished (finaliseGame gameState) Nothing (players gameState)
+ else PassTransition gameState
+ where
+ numPasses = passes game + 1
+ gameFinished = numPasses == numberOfPlayers game * 2
+
+ {- |
+ Restores a game from a list of moves. The game must be set up in the way the original game was set up
+ (including the letter bag constructed with the same tiles and random generator, dictionary and the list of players
+ in the original order.)
+
+ If the game is not set up as it was originally, this function will return a scrabble error with the move which was invalid
+ with the given state. For example, if the original players are not ordered in the correct way then the player will not have
+ the required tiles to make the move.
+ -}
+ restoreGame :: Game -> NE.NonEmpty Move -> Either ScrabbleError (NE.NonEmpty GameTransition)
+ restoreGame game = T.sequence . restoreGameLazy game
+
+ {- |
+ Maps each move to a resulting game transition, if the move is legal. Has the same semantics as 'restoreGame'
+ but returns a list of 'Either' so that laziness can be maintained, meaning all the game transitions
+ dont have to be buffered before they can be consumed.
+ -}
+ restoreGameLazy :: Game -> NE.NonEmpty Move -> NE.NonEmpty (Either ScrabbleError GameTransition)
+ restoreGameLazy game (mv NE.:| moves) = NE.scanl nextMove (makeMove game mv) moves
+ where
+ nextMove transition move = transition >>= \success -> makeMove (newGame success) move
+
+ newGame :: GameTransition -> Game
+ newGame (MoveTransition _ game _) = game
+ newGame (ExchangeTransition game _ _) = game
+ newGame (PassTransition game) = game
+ newGame (GameFinished game _ _) = game
+
+ addMoveToHistory :: GameTransition -> Move -> GameTransition
+ addMoveToHistory (MoveTransition player game formedWords) move = MoveTransition player (updateHistory game move) formedWords
+ addMoveToHistory (ExchangeTransition game oldPlayer newPlayer ) move = ExchangeTransition (updateHistory game move) oldPlayer newPlayer
+ addMoveToHistory (PassTransition game) move = PassTransition (updateHistory game move)
+ addMoveToHistory (GameFinished game wordsFormed allPlayers) move = GameFinished (updateHistory game move) wordsFormed allPlayers
+
+ finaliseGame :: Game -> Game
+ finaliseGame game
+ | gameStatus game == Finished = game
+ | otherwise = game {player1 = play1, player2 = play2, optionalPlayers = optionals, gameStatus = Finished, moveNumber = pred moveNo}
+ where
+ unplayedValues = Prelude.sum $ Prelude.map tileValues allPlayers
+ allPlayers = players game
+ moveNo = moveNumber game
+
+ play1 = finalisePlayer (player1 game)
+ play2 = finalisePlayer (player2 game)
+ optionals = optionalPlayers game >>= (\(player3, maybePlayer4) ->
+ Just (finalisePlayer player3, finalisePlayer <$> maybePlayer4 ) )
+
+ finalisePlayer player = if hasEmptyRack player then increaseScore player unplayedValues
+ else reduceScore player (tileValues player)
+
+ updatePlayerRackAndBag :: Player -> LetterBag -> Int -> (Player, LetterBag)
+ updatePlayerRackAndBag player letterBag numPlayed
+ | tilesInBag == 0 = (player, letterBag)
+ | tilesInBag >= numPlayed =
+ maybe (player, letterBag) (first (giveTiles player)) $ takeLetters letterBag numPlayed
+ | otherwise = maybe (player, letterBag) (first (giveTiles player)) $ takeLetters letterBag tilesInBag
+ where
+ tilesInBag = bagSize letterBag
+
+ newBoard :: Board -> M.Map Pos Tile -> Either ScrabbleError Board
+ newBoard currentBoard placed = foldM (\oldBoard (pos, tile) -> newBoardIfUnoccupied oldBoard pos tile) currentBoard $ Map.toList placed
+ where
+ newBoardIfUnoccupied brd pos tile = note (PlacedTileOnOccupiedSquare pos tile) $ placeTile brd tile pos
+
+
+ removeLettersandGiveScore :: Player -> [Tile] -> Int -> Either ScrabbleError Player
+ removeLettersandGiveScore player playedTiles justScored =
+ let newPlayer = flip increaseScore justScored <$> removePlayedTiles player playedTiles
+ in note (PlayerCannotPlace (rack player) playedTiles) newPlayer
+
+ scoresIfWordsLegal :: Dictionary -> FormedWords -> Either ScrabbleError (Int, [(String, Int)])
+ scoresIfWordsLegal dict formedWords =
+ let strings = wordStrings formedWords
+ in case invalidWords dict strings of
+ []-> Right $ wordsWithScores formedWords
+ xs -> Left $ WordsNotInDictionary xs
diff --git a/src/Wordify/Rules/Player.hs b/src/Wordify/Rules/Player.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Player.hs
@@ -0,0 +1,108 @@
+module Wordify.Rules.Player (Player, LetterRack, name, rack, score, makePlayer, increaseScore, giveTiles, tilesOnRack,
+ removePlayedTiles, removeTiles, hasEmptyRack, tileValues, reduceScore, exchange) where
+
+ import Wordify.Rules.Tile
+ import Data.List
+ import Data.Maybe
+ import qualified Data.Map as Map
+
+ type Score = Int
+ type Name = String
+
+ data LetterRack = LetterRack [Tile] deriving (Show, Eq)
+
+ data Player = Player {name :: Name
+ , rack :: LetterRack
+ , score :: Score } deriving (Show, Eq)
+
+ makePlayer :: String -> Player
+ makePlayer playerName = Player playerName (LetterRack []) 0
+
+ tilesOnRack :: Player -> [Tile]
+ tilesOnRack (Player _ (LetterRack letters) _) = letters
+
+ increaseScore :: Player -> Int -> Player
+ increaseScore player justScored = player {score = currentScore + justScored}
+ where
+ currentScore = score player
+
+ reduceScore :: Player -> Int -> Player
+ reduceScore player removeScore = player {score = currentScore - removeScore}
+ where
+ currentScore = score player
+
+ hasEmptyRack :: Player -> Bool
+ hasEmptyRack player = null $ tilesOnRack player
+
+ tileValues :: Player -> Int
+ tileValues player = sum $ map tileValue (tilesOnRack player)
+
+ {-
+ Adds tiles to the player's tile rack.
+ -}
+ giveTiles :: Player -> [Tile] -> Player
+ giveTiles player newTiles = player {rack = LetterRack $ newTiles ++ tilesOnRack player}
+
+ removeTiles :: Player -> [Tile] -> Player
+ removeTiles player toRemove = player {rack = LetterRack $ tilesOnRack player \\ toRemove}
+
+ {- |
+ Removes played tiles from the player's tile rack, if it was possible for the player
+ to play those tiles in the first place. A player may play a tile on his rack, unless
+ it is a blank, which must first be assigned a letter.
+ -}
+ removePlayedTiles :: Player -> [Tile] -> Maybe Player
+ removePlayedTiles player tiles =
+ if (playerCanPlace player tiles)
+ then Just $ player `removedFromRack` tiles
+ else Nothing
+ where
+ removedFromRack playing playedTiles = player {rack = LetterRack (deleteFirstsBy isPlayable (tilesOnRack playing) playedTiles) }
+
+ {- |
+ Returns true if the player cannot place any of the given tiles. A player cannot play
+ a Blank tile that they have not given a letter, or a tile not on their rack.
+ -}
+ playerCanPlace :: Player -> [Tile] -> Bool
+ playerCanPlace player played = isNothing $ find isInvalid playedList
+ where
+ (playedFrequencies, rackFrequencies) = tileFrequencies played $ tilesOnRack player
+ playedList = Map.toList playedFrequencies
+
+ isInvalid (tile, freq) =
+ case tile of
+ -- Tried to play a blank without a letter
+ Blank Nothing -> False
+ -- Player doesn't have tiles
+ Blank _ -> freq > Map.findWithDefault 0 (Blank Nothing) rackFrequencies
+ Letter chr val -> freq > Map.findWithDefault 0 (Letter chr val) rackFrequencies
+
+ exchange :: Player -> [Tile] -> [Tile] -> Maybe Player
+ exchange player exchanged received =
+ if not (playerCanExchange player exchanged) then Nothing
+ else
+ Just $ giveTiles (removeTiles player exchanged) received
+
+ playerCanExchange :: Player -> [Tile] -> Bool
+ playerCanExchange (Player _ ( LetterRack letterRack) _ ) exchanged = isNothing $ find cannotExchange exchangedList
+
+ where
+ (exchangedFrequencies, rackFrequencies) = tileFrequencies exchanged letterRack
+ exchangedList = Map.toList exchangedFrequencies
+
+ cannotExchange (tile, freq) =
+ case tile of
+ -- Tried to exchange a blank letter which has been labeled. Client error.
+ Blank (Just _) -> False
+ -- Player doesn't have tiles
+ Blank _ -> freq > Map.findWithDefault 0 (Blank Nothing) rackFrequencies
+ Letter chr val -> freq > Map.findWithDefault 0 (Letter chr val) rackFrequencies
+
+ tileFrequencies :: [Tile] -> [Tile] -> ((Map.Map Tile Int), (Map.Map Tile Int))
+ tileFrequencies given letterRack = (givenFrequencies, rackFrequencies)
+ where
+ buildFrequencies tiles = foldl addFrequency (Map.empty) tiles
+ addFrequency dict tile = Map.alter newFrequency tile dict
+ newFrequency m = Just $ maybe 1 succ m -- Default freq of one, or inc existing frequency
+ givenFrequencies = buildFrequencies given
+ rackFrequencies = buildFrequencies letterRack
diff --git a/src/Wordify/Rules/Pos.hs b/src/Wordify/Rules/Pos.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Pos.hs
@@ -0,0 +1,54 @@
+
+module Wordify.Rules.Pos (Pos, posAt, above, below, left, right, xPos, yPos, gridValue, starPos, posMin, posMax) where
+
+ import qualified Data.Map as Map
+ import Wordify.Rules.Pos.Internal
+ import Data.Maybe
+
+ posMin :: Int
+ posMin = 1
+
+ posMax :: Int
+ posMax = 15
+
+ posAt :: (Int, Int) -> Maybe Pos
+ posAt = flip Map.lookup posMap
+
+ -- | The position above the given position, if it exists.
+ above :: Pos -> Maybe Pos
+ above (Pos x y _) = posAt (x,y + 1)
+
+ -- | The position below the given position, if it exists.
+ below :: Pos -> Maybe Pos
+ below (Pos x y _) = posAt (x, y - 1 )
+
+ -- | The position to the left of the given position, if it exists.
+ left :: Pos -> Maybe Pos
+ left (Pos x y _) = posAt (x - 1, y)
+
+ -- | The position to the right of the given position, if it exists.
+ right :: Pos -> Maybe Pos
+ right (Pos x y _) = posAt (x + 1, y)
+
+ -- | The position of the star square
+ starPos :: Pos
+ starPos = Pos 8 8 "H8"
+
+ {- A map keyed by tuples representing (x,y) co-ordinates, and valued by their
+ corresponding Pos types -}
+ posMap :: Map.Map (Int, Int) Pos
+ posMap = Map.fromList $ catMaybes coordTuples
+ where
+ coordTuples = zipWith makeTuple (sequence [[posMin..posMax], [posMin..posMax]]) $ cycle ['A'..'O']
+ makeTuple (x:y:_) gridLetter = Just $ ((y,x) , Pos y x (gridLetter : show x) )
+ makeTuple _ _ = Nothing
+
+ xPos :: Pos -> Int
+ xPos (Pos x _ _) = x
+
+ yPos :: Pos -> Int
+ yPos (Pos _ y _) = y
+
+ gridValue :: Pos -> String
+ gridValue (Pos _ _ grid) = grid
+
diff --git a/src/Wordify/Rules/Pos/Internal.hs b/src/Wordify/Rules/Pos/Internal.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Pos/Internal.hs
@@ -0,0 +1,3 @@
+module Wordify.Rules.Pos.Internal ( Pos(Pos) ) where
+
+ data Pos = Pos !Int !Int !String deriving (Eq,Show, Ord)
diff --git a/src/Wordify/Rules/ScrabbleError.hs b/src/Wordify/Rules/ScrabbleError.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/ScrabbleError.hs
@@ -0,0 +1,64 @@
+module Wordify.Rules.ScrabbleError (ScrabbleError(LetterBagFileNotOpenable, MalformedLetterBagFile,
+ MalformedDictionaryFile, DictionaryFileNotFound, NotEnoughLettersInStartingBag,
+ MisplacedLetter, DoesNotConnectWithWord, NoTilesPlaced, DoesNotCoverTheStarTile,
+ PlacedTileOnOccupiedSquare, CannotPlaceBlankWithoutLetter, WordsNotInDictionary, PlayerCannotPlace,
+ GameNotInProgress, CannotExchangeWhenNoLettersInBag, PlayerCannotExchange, MiscError)) where
+
+ import Wordify.Rules.Pos
+ import Wordify.Rules.Tile
+ import Wordify.Rules.Player
+
+ data ScrabbleError =
+ -- | The caller has supplied an invalid path to a letter bag file, or the file is not openable
+ LetterBagFileNotOpenable String
+ -- | The letter bag file is marformed, so could not be parsed.
+ | MalformedLetterBagFile FilePath
+ -- | The path given to a dictionary file was invalid.
+ | DictionaryFileNotFound FilePath
+ -- | The dictionary file could not be parsed as it was malformed.
+ | MalformedDictionaryFile FilePath
+ -- | A letter bag with insufficient tiles was used to create a game.
+ | NotEnoughLettersInStartingBag Int
+ -- | The player has made an illegal tile placement. Tiles placed must form a line of tiles.
+ | MisplacedLetter Pos
+ -- | The tiles the player placed do not connect with any word (applies after the first move on the board)
+ | DoesNotConnectWithWord
+ -- | The client put the player in the situation to be able to place no tiles.
+ | NoTilesPlaced
+ -- | The first move on the board does not cover the star.
+ | DoesNotCoverTheStarTile
+ -- | The client allowed the player to place tiles on a square that is already occupied with tiles.
+ | PlacedTileOnOccupiedSquare Pos Tile
+ -- | A blank tile must be labeled with a letter before being placed.
+ | CannotPlaceBlankWithoutLetter Pos
+ -- | The tiles the player placed formed one or more words which are not in the dictionary.
+ | WordsNotInDictionary [String]
+ -- | The caller allowed the client to place tiles on the board which were not in their rack.
+ | PlayerCannotPlace LetterRack [Tile]
+ -- | The caller allowed the player to attempt to exchange when no letters were left in the bag.
+ | CannotExchangeWhenNoLettersInBag
+ -- | The caller allowed the player to attempt to exchange tiles that they do not have.
+ | PlayerCannotExchange LetterRack [Tile]
+ -- | The caller allowed a move to be made when the game is finished.
+ | GameNotInProgress
+ | MiscError String deriving Eq
+
+ instance Show ScrabbleError
+ where
+ show (MalformedDictionaryFile path) = "Dictionary file " ++ path ++ " was malformed."
+ show (MalformedLetterBagFile path) = "Letter bag file " ++ path ++ " was malformed."
+ show (DictionaryFileNotFound path) = "Dictionary file " ++ path ++ " was not found."
+ show (LetterBagFileNotOpenable path) = "Letter bag file " ++ path ++ " was not openable"
+ show (NotEnoughLettersInStartingBag num) = "A starting bag must have enough tiles to distribute to the players to start a game. Bag has " ++ show num ++ " tiles."
+ show (MisplacedLetter pos) = "Placed tiles were not legally placed. Starting at tile placed at pos: " ++ show pos
+ show (DoesNotConnectWithWord) = "Placed tiles do not connect with an existing word on the board."
+ show (NoTilesPlaced) = "No tiles were placed in the move."
+ show (DoesNotCoverTheStarTile) = "First move must go through the star."
+ show (PlacedTileOnOccupiedSquare pos _) = "Move replaces a tile already on the board at " ++ show pos ++ ". This is not a legal move."
+ show (CannotPlaceBlankWithoutLetter pos) = "A played blank tile must be given a letter. Blank tile played at " ++ show pos ++ " was not given a letter."
+ show (WordsNotInDictionary xs) = "The following words are not in the scrabble dictionary: " ++ show xs
+ show (PlayerCannotPlace letterRack tiles) = "The player cannot place: " ++ show tiles ++ ". Tiles on rack: " ++ show letterRack ++ ". Blank tiles must be labeled and the placed tiles must be on the rack."
+ show (CannotExchangeWhenNoLettersInBag) = "Cannot exchange letters when there are no letters in the bag."
+ show (PlayerCannotExchange letterRack tiles) = "Player does not have the letters to exchange " ++ show tiles ++ ". Tiles on rack: " ++ show letterRack ++ ". Blank tiles must not be labeled."
+ show (GameNotInProgress) = "A move was attempted on a game that is not in progress."
+ show (MiscError str) = str
diff --git a/src/Wordify/Rules/Square.hs b/src/Wordify/Rules/Square.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Square.hs
@@ -0,0 +1,75 @@
+module Wordify.Rules.Square (Square(Normal, DoubleLetter, TripleLetter, DoubleWord, TripleWord),
+ isOccupied, scoreWord, squareIfOccupied, putTileOn, tileIfOccupied) where
+
+ import Wordify.Rules.Tile
+ import Data.Sequence as Seq
+ import qualified Data.Foldable as F
+ import Data.Maybe
+
+ data Square = Normal (Maybe Tile)
+ | DoubleLetter (Maybe Tile)
+ | TripleLetter (Maybe Tile)
+ | DoubleWord (Maybe Tile)
+ | TripleWord (Maybe Tile) deriving (Show,Eq,Ord)
+
+ putTileOn :: Square -> Tile -> Square
+ putTileOn (Normal _) tile = Normal $ Just tile
+ putTileOn (DoubleLetter _) tile = DoubleLetter $ Just tile
+ putTileOn (TripleLetter _) tile = TripleLetter $ Just tile
+ putTileOn (DoubleWord _) tile = DoubleWord $ Just tile
+ putTileOn (TripleWord _) tile = TripleWord $ Just tile
+
+ {- |
+ Calculates the score of one played word.
+
+ The first list contains squares that are already on the board
+ (and thus are not subject to bonuses).
+
+ The second list contains squares that are newly occupied.
+ -}
+ scoreWord :: Seq Square -> Seq Square -> Int
+ -- Calculate the base score then add the letter bonuses (doubleLetter, doubleWord),
+ -- then multiply by word bonuses (DoubleWord, TripleWord)
+ scoreWord xs ys = addBonuses (addBonuses baseScore letterBonuses) wordBonuses
+ where
+ calcBaseScore = F.foldr (\square acc -> baseValue square + acc) 0
+ addBonuses = F.foldr applyWordBonus
+ baseScore = calcBaseScore xs + calcBaseScore ys
+ (wordBonuses, letterBonuses) = Seq.partition isWordBonus ys
+
+ {- |
+ The bonus operations that should be applied to the score of a word
+ once it has been calculated. When using to calculate score,
+ double and triple word bonuses should be applied last.
+
+ -}
+ applyWordBonus :: Square -> Int -> Int
+ applyWordBonus (Normal _ ) = (+0)
+ applyWordBonus (DoubleLetter (Just tile)) = (+ tileValue tile)
+ applyWordBonus (TripleLetter (Just tile)) = (+ tileValue tile * 2)
+ applyWordBonus (DoubleWord _) = (*2)
+ applyWordBonus (TripleWord _) = (*3)
+ applyWordBonus _ = (+0)
+
+ isWordBonus :: Square -> Bool
+ isWordBonus (DoubleWord _) = True
+ isWordBonus (TripleWord _) = True
+ isWordBonus _ = False
+
+ -- | Base value of a square, without bonuses
+ baseValue :: Square -> Int
+ baseValue sq = maybe 0 tileValue $ tileIfOccupied sq
+
+ squareIfOccupied :: Square -> Maybe Square
+ squareIfOccupied sq = tileIfOccupied sq >> Just sq
+
+ tileIfOccupied :: Square -> Maybe Tile
+ tileIfOccupied (Normal (Just tile)) = Just tile
+ tileIfOccupied (DoubleLetter (Just tile)) = Just tile
+ tileIfOccupied (TripleLetter (Just tile)) = Just tile
+ tileIfOccupied (DoubleWord (Just tile)) = Just tile
+ tileIfOccupied (TripleWord (Just tile)) = Just tile
+ tileIfOccupied _ = Nothing
+
+ isOccupied :: Square -> Bool
+ isOccupied = isJust . squareIfOccupied
diff --git a/src/Wordify/Rules/Tile.hs b/src/Wordify/Rules/Tile.hs
new file mode 100644
--- /dev/null
+++ b/src/Wordify/Rules/Tile.hs
@@ -0,0 +1,27 @@
+module Wordify.Rules.Tile (Tile(Letter, Blank), tileValue, isPlayable, tileLetter) where
+
+{- |
+A tile is a letter with a value, or a Blank tile
+which may have been given a letter. Blank tiles
+always have the value '0'.
+-}
+data Tile = Letter Char Int | Blank (Maybe Char) deriving (Show, Eq, Ord)
+
+tileValue :: Tile -> Int
+tileValue (Letter _ val) = val
+tileValue (Blank _) = 0
+
+tileLetter :: Tile -> Maybe Char
+tileLetter (Letter char _) = Just char
+tileLetter (Blank (Just char)) = Just char
+tileLetter (Blank Nothing) = Nothing
+
+{- |
+ isPlayble, applied to a played tile and compared against a tile
+ returns true if a player returned a letter tile on their rack,
+ or if the player played a Blank that has been given a letter
+-}
+isPlayable :: Tile -> Tile -> Bool
+isPlayable (Letter a b) (Letter x y) = (a == x) && (b == y)
+isPlayable (Blank (Just _)) (Blank Nothing) = True
+isPlayable _ _ = False
diff --git a/test/Tests.hs b/test/Tests.hs
new file mode 100644
--- /dev/null
+++ b/test/Tests.hs
@@ -0,0 +1,12 @@
+-- Following the example of: https://github.com/bos/text/blob/master/tests/Tests.hs
+module Main
+ ( main
+ ) where
+
+import Test.Framework.Runners.Console
+
+import qualified Tests.Properties as Properties
+import qualified Tests.Regressions as Regressions
+
+main :: IO ()
+main = defaultMain [Properties.tests, Regressions.tests]