diff --git a/.gitignore b/.gitignore
old mode 100644
new mode 100755
index 6143e53..62c65c1
--- a/.gitignore
+++ b/.gitignore
@@ -1,22 +1 @@
-# Compiled class file
-*.class
-
-# Log file
-*.log
-
-# BlueJ files
-*.ctxt
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.jar
-*.war
-*.ear
-*.zip
-*.tar.gz
-*.rar
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
+spec.pdf
diff --git a/LICENSE b/LICENSE
old mode 100644
new mode 100755
index 94a9ed0..78df873
--- a/LICENSE
+++ b/LICENSE
@@ -1,674 +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.
-
-
- Copyright (C)
-
- 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:
-
- Copyright (C)
- 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
-.
+ 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.
+
+
+ Copyright (C)
+
+ 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:
+
+ Copyright (C)
+ 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/media/LICENSE b/media/LICENSE
new file mode 100755
index 0000000..20ba94f
--- /dev/null
+++ b/media/LICENSE
@@ -0,0 +1,4 @@
+The image files for the chess pieces were made by Wikipedia user @Cburnett
+ and licensed under a Creative
+Commons BY-SA 3.0 Unported License. More information about this license can be
+found at .
\ No newline at end of file
diff --git a/media/SelectedSquare.jpg b/media/SelectedSquare.jpg
new file mode 100755
index 0000000..cad04e5
Binary files /dev/null and b/media/SelectedSquare.jpg differ
diff --git a/media/black1.png b/media/black1.png
new file mode 100755
index 0000000..cdc215c
Binary files /dev/null and b/media/black1.png differ
diff --git a/media/black2.png b/media/black2.png
new file mode 100755
index 0000000..0f57586
Binary files /dev/null and b/media/black2.png differ
diff --git a/media/black3.png b/media/black3.png
new file mode 100755
index 0000000..16d2284
Binary files /dev/null and b/media/black3.png differ
diff --git a/media/black4.png b/media/black4.png
new file mode 100755
index 0000000..f01529a
Binary files /dev/null and b/media/black4.png differ
diff --git a/media/black5.png b/media/black5.png
new file mode 100755
index 0000000..2f13927
Binary files /dev/null and b/media/black5.png differ
diff --git a/media/black6.png b/media/black6.png
new file mode 100755
index 0000000..cc2e0a9
Binary files /dev/null and b/media/black6.png differ
diff --git a/media/white1.png b/media/white1.png
new file mode 100755
index 0000000..519ee54
Binary files /dev/null and b/media/white1.png differ
diff --git a/media/white2.png b/media/white2.png
new file mode 100755
index 0000000..23a7665
Binary files /dev/null and b/media/white2.png differ
diff --git a/media/white3.png b/media/white3.png
new file mode 100755
index 0000000..c3fed79
Binary files /dev/null and b/media/white3.png differ
diff --git a/media/white4.png b/media/white4.png
new file mode 100755
index 0000000..fa934ea
Binary files /dev/null and b/media/white4.png differ
diff --git a/media/white5.png b/media/white5.png
new file mode 100755
index 0000000..0710c93
Binary files /dev/null and b/media/white5.png differ
diff --git a/media/white6.png b/media/white6.png
new file mode 100755
index 0000000..5b900af
Binary files /dev/null and b/media/white6.png differ
diff --git a/src/ChessBoard.java b/src/ChessBoard.java
new file mode 100755
index 0000000..07ce7e3
--- /dev/null
+++ b/src/ChessBoard.java
@@ -0,0 +1,420 @@
+/******************************************************************************
+ * ChessSim 0.9 *
+ * Copyright © 2015 Ben Goldsworthy (rumperuu) *
+ * *
+ * A program to simulate a game of chess between two human players. *
+ * *
+ * This file is part of ChessSim. *
+ * *
+ * ChessSim 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. *
+ * *
+ * ChessSim 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 ChessSim. If not, see . *
+ ******************************************************************************/
+
+/**
+ ** This class represents a chess board, utilised in the ChessSim program.
+ **/
+
+import javax.swing.*;
+import java.awt.Frame;
+import java.awt.GridLayout;
+import java.awt.Color;
+import java.awt.event.*;
+import java.util.List;
+import java.util.ArrayList;
+
+/**
+ ** @author Ben Goldsworthy (rumperuu)
+ ** @version 0.92
+ **/
+public class ChessBoard implements ActionListener, MouseListener {
+ private final int DEFAULT = 0, PIECESELECTED = 1;
+ private final int PAWN = 0, ROOK = 1, KNIGHT = 2, BISHOP = 3, QUEEN = 4,
+ KING = 5;
+ private final int WHITE = 0, BLACK = 1;
+ private final int NONE = 0, MOVABLE = 1, ATTACKABLE = 2;
+ private final int NULL = 9999;
+
+ private boolean colour = true;
+ // Sets the initial piece (as a BLACK PAWN because the first piece placed
+ // is `piece++`, or the ROOK).
+ private int piece = PAWN, team = BLACK;
+ // Creates the 2D array to hold the `ChessBoard` of `ChessSquare`s.
+ private ChessSquare[][] chessSquare = new ChessSquare[8][8];
+ // Creates a 3D array to hold the `ChessBoard` of chess `Piece`s.
+ private Piece[][][] pieces = new Piece[6][2][8];
+ private Piece selectedPiece;
+ // Admittedly, the `ChessLogic` object doesn't do an awful lot right now
+ // but it'll be useful if I come back to this to add actual game rules
+ // (https://github.com/Rumperuu/ChessSim/issues/1).
+ private ChessLogic logic = new ChessLogic();
+
+ public ChessBoard() {
+ // Initialises the piece indices.
+ int pawnNum = 0, rookNum = 0, knightNum = 0, bishopNum = 0;
+
+ // Sorts out the window, fullscreening and suchlike.
+ JFrame window = new JFrame();
+ window.setExtendedState(Frame.MAXIMIZED_BOTH);
+ window.setUndecorated(true);
+ window.setTitle("Chess, but not as you know it");
+ window.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
+
+ // Creates a grid panel for the `ChessBoard` of `ChessSquare`s.
+ JPanel board = new JPanel();
+ GridLayout grid = new GridLayout(8,8);
+ board.setLayout(grid);
+
+ // For each rank 'y'...
+ for (int y = 0; y <= 7; y++) {
+ // ...switch the populating team to white if the black team's done.
+ if (y == 2) {
+ team = WHITE;
+ pawnNum = 0;
+ rookNum = 0;
+ knightNum = 0;
+ bishopNum = 0;
+ }
+ // Reset the square colour (e.g. the last square of row 0 is black,
+ // meaning the first square of row 1 would be set to white later on
+ // if not for this line).
+ colour = !colour;
+ // Resets the piece to `PAWN`.
+ piece = 0;
+ // ...and for each square in file 'x' of rank 'y'...
+ for (int x = 0; x <= 7; x++) {
+ // ...populate the board array with a new `ChessSquare`.
+ chessSquare[x][y] = new ChessSquare(x,y,colour);
+ // Change the colour for the next square.
+ colour = !colour;
+ // Add the `ChessSquare` to the board.
+ board.add(chessSquare[x][y]);
+ // Checks if the current rank is the top or bottom two
+ // (one of the only current uses of the `ChessLogic` class).
+ if (logic.startingRow(y)) {
+ // Checks if the current rank is the back rank
+ // (one of the other uses).
+ if (logic.backRank(y)) {
+ // If the square in file 'x' is the Queen or lower, increment
+ // `piece`...
+ if (x <= 4) piece++;
+ // ...else, if the square is the King, subtract 2 (to avoid
+ // two Queens).
+ else if (x == 5) piece = piece - 2;
+ // Otherwise, decrement `piece`.
+ else piece--;
+
+ // Depending on the piece currently being added, populate
+ // the appropriate array dimension.
+ switch(piece) {
+ case ROOK:
+ pieces[ROOK][team][rookNum] = new Piece(x,y,team,
+ ROOK,rookNum);
+ chessSquare[x][y].setPiece(pieces[ROOK][team][rookNum++]);
+ break;
+ case KNIGHT:
+ pieces[KNIGHT][team][knightNum]= new Piece(x,y,team,KNIGHT,
+ knightNum);
+ chessSquare[x][y].setPiece(pieces[KNIGHT][team][knightNum++]);
+ break;
+ case BISHOP:
+ pieces[BISHOP][team][bishopNum]= new Piece(x,y,team,BISHOP,
+ bishopNum);
+ chessSquare[x][y].setPiece(pieces[BISHOP][team][bishopNum++]);
+ break;
+ case QUEEN:
+ pieces[QUEEN][team][0] = new Piece(x,y,team,QUEEN,0);
+ chessSquare[x][y].setPiece(pieces[QUEEN][team][0]);
+ break;
+ case KING:
+ pieces[KING][team][0] = new Piece(x,y,team,KING,0);
+ chessSquare[x][y].setPiece(pieces[KING][team][0]);
+ break;
+ }
+ } else {
+ pieces[PAWN][team][pawnNum]= new Piece(x,y,team,PAWN,pawnNum);
+ chessSquare[x][y].setPiece(pieces[PAWN][team][pawnNum++]);
+ }
+ }
+ // Adds the relevant listeners to the `ChessSquare`s.
+ chessSquare[x][y].addActionListener(this);
+ chessSquare[x][y].addMouseListener(this);
+ }
+ }
+ // Finishes off the display.
+ window.setContentPane(board);
+ window.setVisible(true);
+ }
+
+ /*
+ * Handles the event of a `JButton` (or rather a `JButton`-extending
+ * `ChessSquare`) being moused over. As long as no piece is currently
+ * selected, the function displays faintly-highlighted available moves for
+ * the piece moused over.
+ */
+ public void mouseEntered(MouseEvent e) {
+ if (logic.getState() == DEFAULT) {
+ ChessSquare enteredSquare = (ChessSquare)e.getSource();
+ Piece presentPiece = null;
+ if (enteredSquare.hasPiece()) {
+ presentPiece = enteredSquare.getPiece();
+ displayMoves(presentPiece, false);
+ } else defaultSquares();
+ }
+ }
+
+ /*
+ * Handle the other `MouseEvent`s, by not doing anything. Mouse dragging
+ * could potentially be useful in a later version for some sort of click-and-
+ * drag movement of pieces, but for now they're just here to get the compiler
+ * to stop throwing up errors at me.
+ */
+ public void mouseExited(MouseEvent e) {
+ }
+ public void mousePressed(MouseEvent e) {
+ }
+ public void mouseReleased(MouseEvent e) {
+ }
+ public void mouseClicked(MouseEvent e) {
+ }
+
+ /*
+ * Handles the event of a `JButton` (or rather a `JButton`-extending
+ * `ChessSquare`) being clicked. The function, depending on the game state
+ * and state of the `ChessSquare` clicked on, wipes the displayed moves from
+ * the `ChessBoard` or moves the selected piece, removing an attacked piece
+ * is necessary.
+ */
+ public void actionPerformed(ActionEvent e) {
+ switch(logic.getState()) {
+ case DEFAULT:
+ ChessSquare selectedSquare = (ChessSquare) e.getSource();
+ if (selectedSquare.hasPiece()) {
+ selectedPiece = selectedSquare.getPiece();
+ // If no piece is selected, select the clicked piece...
+ displayMoves(selectedPiece, true);
+ logic.setState(PIECESELECTED);
+ }
+ break;
+ case PIECESELECTED:
+ // ...else, if a piece is selected...
+ ChessSquare clickedSquare = (ChessSquare)e.getSource();
+ switch(clickedSquare.getState()) {
+ case NONE:
+ // ...if the square just clicked is an illegal move, wipe all moves
+ // from the `ChessBoard`...
+ defaultSquares();
+ break;
+ case MOVABLE:case ATTACKABLE:
+ // get the coords of the new, clicked square
+ int newX = clickedSquare.getXPosition();
+ int newY = clickedSquare.getYPosition();
+ // and the details of the old, selected piece
+ int oldX = selectedPiece.getXPosition();
+ int oldY = selectedPiece.getYPosition();
+ int oldType = selectedPiece.getType();
+ int oldTeam = selectedPiece.getTeam();
+ int oldIndex = selectedPiece.getIndex();
+ // move (and take the currently-residing piece, if
+ // applicable) to the square clicked
+ chessSquare[oldX][oldY].removePiece();
+ clickedSquare.setPiece(selectedPiece);
+ // update the location of the moved piece
+ pieces[oldType][oldTeam][oldIndex].setXPosition(newX);
+ pieces[oldType][oldTeam][oldIndex].setYPosition(newY);
+ // if the moved piece was a pawn on its first move, disable its
+ // two-square move ability
+ if (oldType == PAWN)
+ pieces[PAWN][oldTeam][oldIndex].usedUpFirstMove();
+
+ // wipes the `ChessBoard` clean
+ defaultSquares();
+ }
+ // resets the state of the game
+ logic.setState(DEFAULT);
+ }
+ }
+
+ /*
+ * Displays the legal moves a selected or hovered-over piece can make,
+ * coloured according to whether the piece is selected or just hovered on.
+ */
+ private void displayMoves(Piece piece, boolean hard) {
+ // get the relevant details of the piece now
+ List moves = new ArrayList();
+ int pieceIndex = piece.getIndex();
+ int pieceTeam = piece.getTeam();
+ int pieceType = piece.getType();
+ // get the relevant piece's complete moveset
+ moves = pieces[pieceType][pieceTeam][pieceIndex].showMoves();
+
+ // wipe the ChessBoard
+ defaultSquares();
+
+ // initialise the variable used to truncate movement paths due to
+ // obstacles
+ boolean skip = false;
+ boolean pawn = (pieceType == PAWN) ? true : false;
+
+ // for the list of moves...
+ for (int i = 0; i < moves.size()-1; i++) {
+ // if the current move isn't the NULL character used as a terminator
+ // between chains of moves (e.g. all in a given direction)...
+ if ((int)moves.get(i) != NULL) {
+ // gets the x- and y-coords for later
+ int moveX = (int)moves.get(i);
+ int moveY = (int)moves.get(++i);
+ // sets skip to false, in case i got here from a truncate
+ skip = false;
+ // determines if the given ChessSquare is legal or illegal
+ skip = highlightSquare(moveX, moveY, pieceTeam, pawn, hard);
+ // if the square is illegal...
+ if (skip) {
+ // sets j to i to start from the current point in the movelist
+ int j = i;
+ // increment down the list from i until the next NULL
+ // separator/end of the line
+ while (((int)moves.get(j) != NULL) && (j < moves.size()-1)) {
+ j++;
+ }
+ // set i to the value after that NULL
+ i = j++;
+ }
+ }
+ }
+
+ // if the given piece is a pawn...
+ if (pieceType == PAWN) {
+ // get the coordinate for the square up and to the right of the pawn
+ // (pX and pY have been used instead of something perhaps more
+ // informative in order to keep the source code within 80
+ // characters' width in the for loop below)
+ int pX = pieces[PAWN][pieceTeam][pieceIndex].getXPosition() + 1;
+ int pY = pieces[PAWN][pieceTeam][pieceIndex].getYPosition();
+
+ // gets the appropriate rank for the direction the pawn is moving
+ if (pieceTeam == WHITE) pY -= 1;
+ else pY += 1;
+
+ // performs the same task as highlightSquare(), but for the squares
+ // a pawn can make an attack to
+ for (int i=0;(pX < 8) && (pX > -1) && (i < 2);pX-=2,i++) {
+ boolean squareEmpty = false;
+ Piece presentPiece = null;
+ if (chessSquare[pX][pY].hasPiece())
+ presentPiece = chessSquare[pX][pY].getPiece();
+ else squareEmpty = true;
+
+ if (!squareEmpty) {
+ if ((presentPiece.getTeam() != pieceTeam)
+ && (presentPiece.getType() != KING)) {
+ if (hard) {
+ chessSquare[pX][pY].setBackground(new Color(255,0,0));
+ chessSquare[pX][pY].setState(ATTACKABLE);
+ } else {
+ chessSquare[pX][pY].setBackground(new Color(127,127,127));
+ }
+ }
+ }
+ }
+ }
+
+ // if this displaySquares() call is as a result of a piece being
+ // selected...
+ if (hard) {
+ // changes the game state
+ logic.setState(PIECESELECTED);
+ }
+ }
+
+ /*
+ * Wipes the ChessBoard restoring the initial black & white checks.
+ */
+ private void defaultSquares() {
+ // this is the same code from the constructor earlier
+ colour = true;
+ for (int x = 0; x <= 7; x++) {
+ colour = !colour;
+ for (int y = 0; y <= 7; y++) {
+ if (colour) chessSquare[x][y].setBackground(new Color(0, 0, 0));
+ else chessSquare[x][y].setBackground(new Color(255, 255, 255));
+ chessSquare[x][y].setState(NONE);
+
+ colour = !colour;
+ }
+ }
+ }
+
+ /*
+ * Highlights a given ChessSquare with colours dependent on a number of
+ * factors.
+ */
+ private boolean highlightSquare(int x, int y, int team,
+ boolean pawn, boolean selected) {
+ boolean squareEmpty = false;
+ // get the piece on the selected square, if applicable
+ Piece presentPiece = null;
+ if (chessSquare[x][y].hasPiece())
+ presentPiece = chessSquare[x][y].getPiece();
+ else squareEmpty = true;
+ // if this highlighting is a result of a piece being selected, rather
+ // than just moused over...
+ if (selected) {
+ // if the square is clear...
+ if (squareEmpty) {
+ // sets the colour to green, and the state to that of a legal move
+ chessSquare[x][y].setBackground(new Color(0, 100, 0));
+ chessSquare[x][y].setState(MOVABLE);
+
+ // return that the square doesn't represent an obstacle
+ return false;
+ // ...else...
+ } else {
+ // ...if the square is occupied by an enemy piece...
+ if (presentPiece.getTeam() != team) {
+ // ...and the selected piece isn't a pawn (because their move
+ // forward can't be used as an attack), and the occupying piece
+ // isn't the enemy's king (because they can't be taken, only
+ // put in check)...
+ if ((!pawn) && (presentPiece.getType() != KING)) {
+ // sets the colour to red, and the state to that of a legal
+ // attack
+ chessSquare[x][y].setBackground(new Color(255, 0, 0));
+ chessSquare[x][y].setState(ATTACKABLE);
+ }
+ }
+
+ // return that the square does represent an obstacle
+ return true;
+ }
+ // ...else, if the piece has just been highlighted over, do the same as
+ // before, but with fainter shades of red and green
+ } else {
+ if (squareEmpty) {
+ chessSquare[x][y].setBackground(new Color(127, 127, 127));
+
+ return false;
+ } else {
+ if (presentPiece.getTeam() != team) {
+ if ((pawn)
+ && (presentPiece.getType() != KING)) {
+ // sets the colour to red, and the state to that of a legal
+ // attack
+ chessSquare[x][y].setBackground(new Color(127, 0, 0));
+ }
+ }
+
+ return true;
+ }
+ }
+ }
+}
diff --git a/src/ChessLogic.java b/src/ChessLogic.java
new file mode 100755
index 0000000..b769e1d
--- /dev/null
+++ b/src/ChessLogic.java
@@ -0,0 +1,80 @@
+/******************************************************************************
+ * ChessSim 0.9 *
+ * Copyright © 2015 Ben Goldsworthy (rumperuu) *
+ * *
+ * A program to simulate a game of chess between two human players. *
+ * *
+ * This file is part of ChessSim. *
+ * *
+ * ChessSim 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. *
+ * *
+ * ChessSim 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 ChessSim. If not, see . *
+ ******************************************************************************/
+
+/**
+ ** This class represents chess logic, utilised in the ChessSim program.
+ **/
+
+/**
+ ** @author Ben Goldsworthy (rumperuu)
+ ** @version 0.90
+ **/
+public class ChessLogic {
+ // rumperuu <3 C-style pre-processor macros
+ private final int DEFAULT = 0, PIECESELECTED = 1;
+
+ // stores the current state of the game
+ private int currentState;
+
+ /**
+ ** Constructor function.
+ **/
+ public ChessLogic() {
+ currentState = DEFAULT;
+ }
+
+ /**
+ ** Determines if a given rank is the top or bottom two.
+ ** @param y the rank number
+ ** @return a boolean value
+ **/
+ public boolean startingRow(int y) {
+ return (((y <= 1) || (y >= 6)) ? true : false);
+ }
+
+ /**
+ ** Determines if a given rank is either team's back rank. Currently
+ ** used to populate pieces, but could also be called to deal with pawn
+ ** promotion if I ever got around to adding that.
+ ** @param y the rank number
+ ** @return a boolean value
+ **/
+ public boolean backRank(int y) {
+ return (((y == 0) || (y == 7)) ? true: false);
+ }
+
+ /**
+ ** Gets the current state of this chess game.
+ ** @return the state of this chess game
+ */
+ public int getState() {
+ return currentState;
+ }
+
+ /**
+ ** Sets the state of this chess game.
+ ** @param state the state of this chess game
+ */
+ public void setState(int state) {
+ currentState = state;
+ }
+}
diff --git a/src/ChessProgram.java b/src/ChessProgram.java
new file mode 100755
index 0000000..f767475
--- /dev/null
+++ b/src/ChessProgram.java
@@ -0,0 +1,32 @@
+/******************************************************************************
+ * ChessSim 0.9 *
+ * Copyright © 2015 Ben Goldsworthy (rumperuu) *
+ * *
+ * A program to simulate a game of chess between two human players. *
+ * *
+ * This file is part of ChessSim. *
+ * *
+ * ChessSim 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. *
+ * *
+ * ChessSim 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 ChessSim. If not, see . *
+ ******************************************************************************/
+
+/**
+ ** @author Ben Goldsworthy (rumperuu)
+ ** @version 0.90
+ **/
+public class ChessProgram {
+ public static void main(String[] arguments) {
+ // creates a new instance of the ChessBoard object
+ ChessBoard board = new ChessBoard();
+ }
+}
diff --git a/src/ChessSquare.java b/src/ChessSquare.java
new file mode 100755
index 0000000..fce7845
--- /dev/null
+++ b/src/ChessSquare.java
@@ -0,0 +1,160 @@
+/******************************************************************************
+ * ChessSim 0.9 *
+ * Copyright © 2015 Ben Goldsworthy (rumperuu) *
+ * *
+ * A program to simulate a game of chess between two human players. *
+ * *
+ * This file is part of ChessSim. *
+ * *
+ * ChessSim 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. *
+ * *
+ * ChessSim 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 ChessSim. If not, see . *
+ ******************************************************************************/
+
+/**
+ ** This class represents a chess square, utilised in the ChessSim program.
+ **/
+
+import javax.swing.*;
+import java.awt.*;
+
+/**
+ ** @author Ben Goldsworthy (rumperuu)
+ ** @version 0.90
+ **/
+public class ChessSquare extends JButton {
+ // C sells C shells on the C shore
+ private final int NONE = 0, MOVABLE = 1, ATTACKABLE = 2;
+ private final int NULL = 9999;
+ private final int WHITE = 0, BLACK = 1;
+
+ // declares the array for piece icons
+ private ImageIcon[][] pieces = new ImageIcon[2][6];
+ // declares the values for storing the details relevant to each instance of
+ // the ChessSquare
+ private Piece currentPiece;
+ private int xPosition, yPosition;
+ private int currentState;
+
+ /**
+ ** Constructor function.
+ ** @param x the x-coord of the square, which doubles as its array x-index
+ ** @param y the y-coord of the square, which doubles as its array y-index
+ ** @param colour the colour of the square
+ **/
+ public ChessSquare(int x, int y, boolean colour) {
+ // populates the array of piece icons
+ for (int i = 1; i <= 6; i++) {
+ pieces[WHITE][i-1] = new ImageIcon("images/white"+i+".png");
+ pieces[BLACK][i-1] = new ImageIcon("images/black"+i+".png");
+ }
+
+ xPosition = x;
+ yPosition = y;
+
+ // sets the background appropriately
+ setBackground(colour ? new Color(0,0,0) : new Color(255,255,255));
+
+ // sets the square to empty
+ currentPiece = null;
+ }
+
+ /**
+ ** Removes the currently-occupying piece of this ChessSquare.
+ **/
+ public void removePiece() {
+ currentPiece = null;
+ setIcon(null);
+ }
+
+ public boolean hasPiece() {
+ if (currentPiece != null) return true;
+ else return false;
+ }
+
+ /**
+ ** Gets the current x-coord of this ChessSquare.
+ ** @return the x-coord of this ChessSquare within the ChessBoard
+ **/
+ public int getXPosition() {
+ return xPosition;
+ }
+
+ /**
+ ** Gets the current y-coord of this ChessSquare.
+ ** @return the y-coord of this ChessSquare within the ChessBoard
+ **/
+ public int getYPosition() {
+ return yPosition;
+ }
+
+ /**
+ ** Gets the current piece on this ChessSquare.
+ ** @return the Piece object on this ChessSquare within the ChessBoard
+ **/
+ public Piece getPiece()
+ {
+ return currentPiece;
+ }
+
+ /**
+ ** Gets the current index of this ChessSquare.
+ ** @return the index of this ChessSquare within the ChessBoard
+ **/
+ public int getPieceIndex()
+ {
+ return currentPiece.getIndex();
+ }
+
+ /**
+ * Obtains the type of the currently-occupying piece of this ChessSquare.
+ * @return the current piece type on this ChessSquare within the ChessBoard
+ */
+ public int getPieceType()
+ {
+ return currentPiece.getType();
+ }
+
+ /**
+ * Obtains the team of the currently-occupying piece of this ChessSquare.
+ * @return the current piece team on this ChessSquare within the ChessBoard
+ */
+ public int getPieceTeam() {
+ return currentPiece.getTeam();
+ }
+
+ /**
+ * Gets the state of this ChessSquare.
+ * @return the state of this ChessSquare within the ChessBoard
+ */
+ public int getState()
+ {
+ return currentState;
+ }
+
+ /**
+ ** Sets the currently-occupying piece on this ChessSquare.
+ ** @param piece the Piece object
+ **/
+ public void setPiece(Piece piece) {
+ currentPiece = piece;
+ setIcon(pieces[piece.getTeam()][piece.getType()]);
+ }
+
+ /**
+ ** Sets the current state of this ChessSquare.
+ ** @param state the new state
+ **/
+ public void setState(int state) {
+ currentState = state;
+ }
+}
diff --git a/src/Piece.java b/src/Piece.java
new file mode 100755
index 0000000..35cc97b
--- /dev/null
+++ b/src/Piece.java
@@ -0,0 +1,322 @@
+/******************************************************************************
+ * ChessSim 0.9 *
+ * Copyright © 2015 Ben Goldsworthy (rumperuu) *
+ * *
+ * A program to simulate a game of chess between two human players. *
+ * *
+ * This file is part of ChessSim. *
+ * *
+ * ChessSim 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. *
+ * *
+ * ChessSim 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 ChessSim. If not, see . *
+ ******************************************************************************/
+
+/**
+ ** This class represents a chess piece, utilised in the ChessSim program.
+ **/
+
+import java.util.*;
+
+/**
+ ** @author Ben Goldsworthy (rumperuu)
+ ** @version 0.92
+ **/
+public class Piece {
+ // they C me rollin', they hatin'
+ private final int NULL = 9999;
+ private final int WHITE = 0, BLACK = 1;
+ private final int PAWN = 0, ROOK = 1, KNIGHT = 2, BISHOP = 3, QUEEN = 4,
+ KING = 5;
+
+ // declares all the variables that every piece, regardless of type, has
+ private int xPosition, yPosition;
+ private int pieceNum;
+ private int pieceTeam;
+ private int pieceType;
+ private List moves = new ArrayList();
+ private boolean firstMove = false;
+
+
+ /**
+ ** Constructor function.
+ ** @param x the x-coord of the piece
+ ** @param y the y-coord of the piece
+ ** @param team the team of the piece
+ ** @param type the type of the piece
+ **/
+ public Piece(int x, int y, int team, int type, int num) {
+ xPosition = x;
+ yPosition = y;
+ pieceTeam = team;
+ pieceType = type;
+ pieceNum = num;
+
+ if (type == PAWN)
+ firstMove = true;
+ }
+
+ /**
+ * Gets whether this is the first move for the piece, if it is a Pawn.
+ * @return a boolean value
+ */
+ public boolean firstMove() {
+ return firstMove;
+ }
+
+ /**
+ ** Sets the first move as used up.
+ **/
+ public void usedUpFirstMove() {
+ firstMove = false;
+ }
+
+ /**
+ ** Populates the movelist of the piece.
+ ** @return The list of moves, with NULL characters seperating linear paths
+ **/
+ public List showMoves() {
+ // clears the movelist
+ getMoves().clear();
+
+ switch(pieceType) {
+ case PAWN:
+ // adds the the square(s) directly ahead of the piece
+ addPawn(firstMove);
+ break;
+ case ROOK:
+ // adds linear paths in all four orthagonal directions
+ addOrthagonals(1, 8);
+ break;
+ case KNIGHT:
+ // adds the non-linear L-shaped jump squares
+ addLs();
+ break;
+ case BISHOP:
+ // adds linear paths in all four diagonal directions
+ addDiagonals(1, 8);
+ break;
+ case QUEEN:
+ // adds linear paths in all four diagonal and orthagonal directions
+ addDiagonals(1, 8);
+ addSeparator();
+ addOrthagonals(1, 8);
+ break;
+ case KING:
+ // adds all adjacent squares
+ addDiagonals(1, 1);
+ addSeparator();
+ addOrthagonals(1, 1);
+ break;
+ }
+
+ // returns the movelist
+ return getMoves();
+ }
+
+ /**
+ ** Gets the current x-coord of this Piece.
+ ** @return the x-coord of this Piece within the ChessBoard.
+ **/
+ public int getXPosition() {
+ return xPosition;
+ }
+
+ /**
+ ** Gets the current y-coord of this Piece.
+ ** @return the y-coord of this Piece within the ChessBoard.
+ **/
+ public int getYPosition() {
+ return yPosition;
+ }
+
+ /**
+ ** Gets the array index of this Piece.
+ ** @return the array index of this Piece within the ChessBoard.
+ **/
+ public int getIndex() {
+ return pieceNum;
+ }
+
+ /**
+ ** Obtains the type of this Piece.
+ ** @return the current type of this Piece within the ChessBoard.
+ **/
+ public int getType() {
+ return pieceType;
+ }
+
+ /**
+ ** Obtains the team of this Piece.
+ ** @return the team of this Piece within the ChessBoard.
+ **/
+ public int getTeam() {
+ return pieceTeam;
+ }
+
+ /**
+ ** Sets the x-coord of this Piece.
+ ** @param x the x-coord of this Piece within the ChessBoard.
+ **/
+ public void setXPosition(int x) {
+ xPosition = x;
+ }
+
+ /**
+ ** Sets the y-coord of this Piece.
+ ** @param y the y-coord of this Piece within the ChessBoard.
+ **/
+ public void setYPosition(int y) {
+ yPosition = y;
+ }
+
+ /*
+ * Adds a move to this Piece.
+ */
+ private void addMovement(int x, int y) {
+ moves.add(x);
+ moves.add(y);
+ }
+
+ /*
+ * Adds a separator to the movelist.
+ */
+ private void addSeparator() {
+ moves.add(NULL);
+ }
+
+ /**
+ ** Gets the list of on-board moves for the piece
+ ** @return the list of moves.
+ **/
+ public List getMoves() {
+ return moves;
+ }
+
+ /*
+ * Determines whether a given move is on the board or not, i.e. that neither
+ * the x- or y-coords are less than 0 or more than 7. The direction passed
+ * as a param starts at diagonally up and to the left, and proceeds
+ * clockwise
+ */
+ private boolean moveOnBoard(int x, int dir) {
+ switch(dir) {
+ case 0:
+ return ((xPosition - x >= 0) && (yPosition - x >= 0));
+ case 1:
+ return (yPosition - x >= 0);
+ case 2:
+ return ((xPosition + x <= 7) && (yPosition - x >= 0));
+ case 3:
+ return (xPosition + x <= 7);
+ case 4:
+ return ((xPosition + x <= 7) && (yPosition + x <= 7));
+ case 5:
+ return (yPosition + x <= 7);
+ case 6:
+ return ((xPosition - x >= 0) && (yPosition + x <= 7));
+ case 7:
+ return (xPosition - x >= 0);
+ default:
+ System.out.println("Error 02: no direction sent.");
+ return false;
+ }
+ }
+
+ /*
+ * Adds a number of diagonal vectors to the movelist, separated by the
+ * NULL separator.
+ */
+ private void addDiagonals(int x1, int x2) {
+ for (int x = x1; x <= x2; x++) {
+ if (moveOnBoard(x, 0))
+ addMovement(xPosition - x, yPosition - x);
+ }
+ addSeparator();
+ for (int x = x1; x <= x2; x++) {
+ if (moveOnBoard(x, 2))
+ addMovement(xPosition + x, yPosition - x);
+ }
+ addSeparator();
+ for (int x = x1; x <= x2; x++) {
+ if (moveOnBoard(x, 4))
+ addMovement(xPosition + x, yPosition + x);
+ }
+ addSeparator();
+ for (int x = x1; x <= x2; x++) {
+ if (moveOnBoard(x, 6))
+ addMovement(xPosition - x, yPosition + x);
+ }
+ }
+
+ /*
+ * Adds a number of orthagonal vectors to the movelist, separated by the
+ * NULL separator.
+ */
+ private void addOrthagonals(int x1, int x2) {
+ for (int x = x1; x <= x2; x++) {
+ if (moveOnBoard(x, 1))
+ addMovement(xPosition, yPosition - x);
+ }
+ addSeparator();
+ for (int x = x1; x <= x2; x++) {
+ if (moveOnBoard(x, 3))
+ addMovement(xPosition + x, yPosition);
+ }
+ addSeparator();
+ for (int x = x1; x <= x2; x++) {
+ if (moveOnBoard(x, 5))
+ addMovement(xPosition, yPosition + x);
+ }
+ addSeparator();
+ for (int x = x1; x <= x2; x++) {
+ if (moveOnBoard(x, 7))
+ addMovement(xPosition - x, yPosition);
+ }
+ }
+
+ /*
+ * Adds a number of non-linear L-shaped paths to the movelist, separated
+ * by the NULL separator.
+ */
+ private void addLs() {
+ for (int x = 1, x2 = 2; x <= 2; x++, x2--) {
+ if ((xPosition + x <= 7) && (yPosition + x2 <= 7))
+ addMovement(xPosition + x, yPosition + x2);
+ addSeparator();
+ if ((xPosition - x >= 0) && (yPosition + x2 <= 7))
+ addMovement(xPosition - x, yPosition + x2);
+ addSeparator();
+ if ((xPosition + x <= 7) && (yPosition - x2 >= 0))
+ addMovement(xPosition + x, yPosition - x2);
+ addSeparator();
+ if ((xPosition - x >= 0) && (yPosition - x2 >= 0))
+ addMovement(xPosition - x, yPosition - x2);
+ if (x2 == 2) addSeparator();
+ }
+ }
+
+ /*
+ * Adds the square(s) directly ahead of the pawn's current coords.
+ */
+ private void addPawn(boolean firstMove) {
+ // adds the the square(s) directly ahead of the piece
+ if (pieceTeam == WHITE) {
+ if (moveOnBoard(1, 1))
+ addMovement(getXPosition(), getYPosition() - 1);
+ if (firstMove) addMovement(getXPosition(), getYPosition() - 2);
+ } else if (pieceTeam == BLACK) {
+ if (moveOnBoard(1, 5))
+ addMovement(getXPosition(), getYPosition() + 1);
+ if (firstMove) addMovement(getXPosition(), getYPosition() + 2);
+ }
+ }
+}