aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorInigoGutierrez <inigogf.95@gmail.com>2021-01-24 20:47:26 +0100
committerInigoGutierrez <inigogf.95@gmail.com>2021-01-24 20:59:17 +0100
commitddde2a9a43daf870c26bef33f47abe45b414c3d0 (patch)
tree52576f8a97011f733360bc9904f1890867cd8bfd
downloadimago-ddde2a9a43daf870c26bef33f47abe45b414c3d0.tar.gz
imago-ddde2a9a43daf870c26bef33f47abe45b414c3d0.zip
First commit!
-rw-r--r--.gitignore14
-rw-r--r--LICENSE674
-rw-r--r--README.md31
-rw-r--r--doc/Makefile23
-rw-r--r--doc/diagrams/ASTNode.pumlc10
-rw-r--r--doc/diagrams/GameMove.pumlc13
-rw-r--r--doc/diagrams/GameState.pumlc14
-rw-r--r--doc/diagrams/GameTree.pumlc8
-rw-r--r--doc/diagrams/MoveParser.pumlc7
-rw-r--r--doc/diagrams/SGF.pumlc8
-rw-r--r--doc/diagrams/gameRepresentation.puml14
-rw-r--r--doc/diagrams/gtpEngine.puml29
-rw-r--r--doc/diagrams/modules.puml9
-rw-r--r--doc/diagrams/sgfModule.puml17
-rw-r--r--doc/diagrams/sgflex.pumlc8
-rw-r--r--doc/diagrams/sgfyacc.pumlc8
-rw-r--r--doc/diagrams/skinparams.puml9
-rw-r--r--doc/tex/implementation.tex64
-rw-r--r--doc/tex/interface.tex6
-rw-r--r--doc/tex/introduction.tex16
-rw-r--r--doc/tex/previousWorks.tex21
-rw-r--r--doc/tex/tfg.tex60
-rwxr-xr-xgo.py31
-rw-r--r--imago/__init__.py0
-rw-r--r--imago/data/__init__.py0
-rw-r--r--imago/data/enums.py18
-rw-r--r--imago/engine/__init__.py0
-rw-r--r--imago/engine/core.py68
-rw-r--r--imago/engine/imagoIO.py157
-rw-r--r--imago/engine/parseHelpers.py91
-rw-r--r--imago/gameLogic/__init__.py0
-rw-r--r--imago/gameLogic/gameBoard.py177
-rw-r--r--imago/gameLogic/gameData.py51
-rw-r--r--imago/gameLogic/gameMove.py19
-rw-r--r--imago/gameLogic/gameState.py105
-rw-r--r--imago/gameLogic/gameTree.py8
-rw-r--r--imago/sgfParser/__init__.py0
-rw-r--r--imago/sgfParser/astNode.py127
-rw-r--r--imago/sgfParser/sgf.py11
-rwxr-xr-ximago/sgfParser/sgflex.py81
-rwxr-xr-ximago/sgfParser/sgfyacc.py61
-rwxr-xr-ximagocli.py9
-rwxr-xr-xtest.sh2
-rw-r--r--tests/test_parseHelpers.py99
44 files changed, 2178 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..750838b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,14 @@
+*.sgf
+
+# doc
+*.pdf
+doc/out/
+doc/diagrams/*.png
+
+# src
+__pycache__/
+.coverage
+
+# ply
+parser.out
+parsetab.py
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ccd8f6c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Imago
+
+A Go AI.
+
+## The project
+
+Imago is a Go AI developed as a TFG (Final Degree Project) for the Bachelor of
+Software Engineering of the University of Oviedo.
+
+## Implementation
+
+Imago is written in Python and the source code is inside the `imago` folder. The
+implementation is on an early stage and includes core game logic, a basic GTP
+engine and a placeholder AI function which plays on random empty vertices.
+
+A game of go with no AI can be played by running the `go.py` script. This is
+useful to test the core game logic. The GTP engine can be started by the
+`imagocli.py` script. Following the GTP specification, known commands can be
+listed by entering `list_commands` on the GTP engine's interface.
+
+Tests are stored in the `tests` folder which as of now contains an example
+tests file. The tests can be run with the `test.sh` script which uses the
+Python package `coverage` to get coverage statistics.
+
+## Documentation
+
+The source code for a work in progress documentation is laid out inside the
+`doc` folder, including a Makefile to compile it. This documentation compiling
+process depends on `xelatex`, `biber`, `plantuml` and some `LaTeX` packages.
+This documentation is fully subject to change in any moment of development and
+it probably already contradicts the actual implementation.
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..954ae3c
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,23 @@
+.SUFFIXES: .puml .png
+
+docName = tfg
+outputFolder = out
+
+texFiles = tex/tfg.tex tex/introduction.tex tex/previousWorks.tex tex/interface.tex tex/implementation.tex
+diagramImgs = diagrams/gameRepresentation.png diagrams/modules.png diagrams/sgfModule.png diagrams/gtpEngine.png
+
+all: $(docName).pdf
+
+$(docName).pdf: $(texFiles) $(diagramImgs)
+ [ -d $(outputFolder) ] || mkdir $(outputFolder)
+ xelatex -output-directory $(outputFolder) tex/$(docName).tex
+ biber $(outputFolder)/$(docName)
+ xelatex -output-directory $(outputFolder) tex/$(docName).tex
+ mv $(outputFolder)/$(docName).pdf .
+
+.puml.png:
+ plantuml $<
+
+clean:
+ rm -r $(outputFolder)
+ rm diagrams/*.png
diff --git a/doc/diagrams/ASTNode.pumlc b/doc/diagrams/ASTNode.pumlc
new file mode 100644
index 0000000..05c13ac
--- /dev/null
+++ b/doc/diagrams/ASTNode.pumlc
@@ -0,0 +1,10 @@
+@startuml
+
+class ASTNode {
+ ASTNode[] children
+ Property properties
+ void addtoSequence()
+ GameTree toGameTree()
+}
+
+@enduml
diff --git a/doc/diagrams/GameMove.pumlc b/doc/diagrams/GameMove.pumlc
new file mode 100644
index 0000000..7dcb5e3
--- /dev/null
+++ b/doc/diagrams/GameMove.pumlc
@@ -0,0 +1,13 @@
+@startuml
+
+class GameMove {
+ int player
+ int row
+ int col
+ int[2] makesKo
+ int[] board
+ GameMove[] nextMoves
+ GameMove previousMove
+}
+
+@enduml
diff --git a/doc/diagrams/GameState.pumlc b/doc/diagrams/GameState.pumlc
new file mode 100644
index 0000000..db39d8f
--- /dev/null
+++ b/doc/diagrams/GameState.pumlc
@@ -0,0 +1,14 @@
+@startuml
+
+class GameState {
+ int player
+ int capturesBlack
+ int capturesWhite
+ List board
+ List prevBoards # for ko
+ GameTree gameTree
+ GameMove lastMove
+ GameData gameData
+}
+
+@enduml
diff --git a/doc/diagrams/GameTree.pumlc b/doc/diagrams/GameTree.pumlc
new file mode 100644
index 0000000..85859d8
--- /dev/null
+++ b/doc/diagrams/GameTree.pumlc
@@ -0,0 +1,8 @@
+@startuml
+
+class GameTree {
+ GameNode[] firstMoves
+ GameData gameData
+}
+
+@enduml
diff --git a/doc/diagrams/MoveParser.pumlc b/doc/diagrams/MoveParser.pumlc
new file mode 100644
index 0000000..4c0dc00
--- /dev/null
+++ b/doc/diagrams/MoveParser.pumlc
@@ -0,0 +1,7 @@
+@startuml
+
+class MoveParser {
+ int[] parseMove(input)
+}
+
+@enduml
diff --git a/doc/diagrams/SGF.pumlc b/doc/diagrams/SGF.pumlc
new file mode 100644
index 0000000..2c30202
--- /dev/null
+++ b/doc/diagrams/SGF.pumlc
@@ -0,0 +1,8 @@
+@startuml
+
+class SGF {
+ GameTree loadGameTree(file)
+ void saveGameTree(file)
+}
+
+@enduml
diff --git a/doc/diagrams/gameRepresentation.puml b/doc/diagrams/gameRepresentation.puml
new file mode 100644
index 0000000..9a869f1
--- /dev/null
+++ b/doc/diagrams/gameRepresentation.puml
@@ -0,0 +1,14 @@
+@startuml
+
+!include skinparams.puml
+
+!include GameState.pumlc
+!include GameTree.pumlc
+!include GameMove.pumlc
+
+GameState --> GameTree
+GameState --> GameMove: Current move
+GameTree *--> GameMove
+GameMove -> GameMove
+
+@enduml
diff --git a/doc/diagrams/gtpEngine.puml b/doc/diagrams/gtpEngine.puml
new file mode 100644
index 0000000..c4caf32
--- /dev/null
+++ b/doc/diagrams/gtpEngine.puml
@@ -0,0 +1,29 @@
+@startuml
+
+!include skinparams.puml
+
+class EngineCore {
+}
+
+class IO {
+ processComand()
+}
+
+!include GameState.pumlc
+
+'class EngineBoard {
+' setSize()
+' setKomi()
+' play()
+' undo()
+'}
+
+class EngineAI {
+ genmove(board)
+}
+
+EngineCore --> IO
+EngineCore --> GameState
+EngineCore --> EngineAI
+
+@enduml
diff --git a/doc/diagrams/modules.puml b/doc/diagrams/modules.puml
new file mode 100644
index 0000000..064be1d
--- /dev/null
+++ b/doc/diagrams/modules.puml
@@ -0,0 +1,9 @@
+@startuml
+
+!include ./skinparams.puml
+
+!include GameState.pumlc
+!include SGF.pumlc
+!include MoveParser.pumlc
+
+@enduml
diff --git a/doc/diagrams/sgfModule.puml b/doc/diagrams/sgfModule.puml
new file mode 100644
index 0000000..c8b51cd
--- /dev/null
+++ b/doc/diagrams/sgfModule.puml
@@ -0,0 +1,17 @@
+@startuml
+
+!include ./skinparams.puml
+
+package "SGF" {
+ !include sgflex.pumlc
+ !include sgfyacc.pumlc
+ !include ASTNode.pumlc
+}
+
+!include GameTree.pumlc
+
+sgflex <- sgfyacc
+sgfyacc -> "*" ASTNode
+ASTNode "1" -> "1" GameTree
+
+@enduml
diff --git a/doc/diagrams/sgflex.pumlc b/doc/diagrams/sgflex.pumlc
new file mode 100644
index 0000000..9b98885
--- /dev/null
+++ b/doc/diagrams/sgflex.pumlc
@@ -0,0 +1,8 @@
+@startuml
+
+object sgflex {
+ input()
+ token()
+}
+
+@enduml
diff --git a/doc/diagrams/sgfyacc.pumlc b/doc/diagrams/sgfyacc.pumlc
new file mode 100644
index 0000000..72a2f3f
--- /dev/null
+++ b/doc/diagrams/sgfyacc.pumlc
@@ -0,0 +1,8 @@
+@startuml
+
+object sgfyacc {
+ parse()
+}
+
+@enduml
+
diff --git a/doc/diagrams/skinparams.puml b/doc/diagrams/skinparams.puml
new file mode 100644
index 0000000..cde3da7
--- /dev/null
+++ b/doc/diagrams/skinparams.puml
@@ -0,0 +1,9 @@
+@startuml
+
+skinparam {
+ monochrome true
+ shadowing false
+ linetype polyline
+}
+
+@enduml
diff --git a/doc/tex/implementation.tex b/doc/tex/implementation.tex
new file mode 100644
index 0000000..9e42313
--- /dev/null
+++ b/doc/tex/implementation.tex
@@ -0,0 +1,64 @@
+\section{Implementation}
+
+\subsection{Engine}
+
+An engine implementing GTP.\@ It is designed to be used by a software controller
+but can also be directly run, mostly for debugging purposes. Its design is shown
+in \fref{fig:engine}
+
+\begin{figure}[h]
+ \begin{center}
+ \includegraphics[width=\textwidth]{diagrams/gtpEngine.png}
+ \caption{Design of the GTP engine.}\label{fig:engine}
+ \end{center}
+\end{figure}
+
+\subsection{Modules}
+
+One module to store the state of the game and the game tree. One module to parse
+moves. One module to read and write SGF files. Modules are shown in
+\fref{fig:modules}.
+
+\begin{figure}[h]
+ \begin{center}
+ \includegraphics[width=\textwidth]{diagrams/modules.png}
+ \caption{Modules.}\label{fig:modules}
+ \end{center}
+\end{figure}
+
+\subsection{Representation of a match}
+
+Strictly said, a match is composed of a series of moves. But since game review
+and variants exploration is an important part of Go learing, \program{} allows
+for navigation back and forth through the board states of a match and for new
+variants to be created from each of these board states. Therefore, a match is
+represented as a tree of moves. The state of the game must also be present so
+liberties, captures and legality of moves can be addressed, so it is represented
+with its own class, which holds a reference both to the game tree and the
+current move. This classes and their relationship can be seen in
+\fref{fig:gameRepresentation}.
+
+\begin{figure}[h]
+ \begin{center}
+ \includegraphics[width=0.7\textwidth]{diagrams/gameRepresentation.png}
+ \caption{A game is represented as a tree of moves.}\label{fig:gameRepresentation}
+ \end{center}
+\end{figure}
+
+\subsection{SGF}
+
+To parse SGF files a lexer and parser have been implemented using PLY.\@ The
+result of the parsing is an AST (Annotated Syntax Tree) reflecting the contents
+of the text input, each node with zero or more properties, and with the ability
+to convert themselves and their corresponding subtree into a GameTree. This is
+done for the root node, since from the SGF specification there are some
+properties only usable in the root node, like those which specify general game
+information and properties such as rank of players or komi. These components are
+shown in \fref{fig:sgfModule}.
+
+\begin{figure}[h]
+ \begin{center}
+ \includegraphics[width=\textwidth]{diagrams/sgfModule.png}
+ \caption{Components of the SGF file parsing module.}\label{fig:sgfModule}
+ \end{center}
+\end{figure}
diff --git a/doc/tex/interface.tex b/doc/tex/interface.tex
new file mode 100644
index 0000000..9caa78d
--- /dev/null
+++ b/doc/tex/interface.tex
@@ -0,0 +1,6 @@
+\section{Interface}
+
+\subsection{Importing and exporting games}
+
+The format chosen to read and write games is SGF (Smart Game Format). It is a
+widely used text format which allows for variants, comments and other metadata.
diff --git a/doc/tex/introduction.tex b/doc/tex/introduction.tex
new file mode 100644
index 0000000..6defbd9
--- /dev/null
+++ b/doc/tex/introduction.tex
@@ -0,0 +1,16 @@
+\section{Introduction}
+
+\begin{displayquote}
+ Go is an ancient game which, from its forgotten origins in China, spread first
+ to the rest of East Asia, and then to the entire world. How ancient? Historians
+ aren't sure; it has a definite history of over 3000 years, but according to
+ tradition Go was invented more than 4000 years ago. The English name comes from
+ the Japanese name Igo, which means ``surrounding boardgame''.
+
+ In this game, each player tries to use threats of death, capture, or isolation
+ to assert control over more of the board than his opponent. An abstract strategy
+ game at heart, Go has nonetheless been interpreted as a stylized representation
+ of fighting a war, settling a frontier, cornering a market, thrashing out an
+ argument, or even of fortune-telling and prophecy. Go has always been one of the
+ most played games in the world. \parencite{sl_go}
+\end{displayquote}
diff --git a/doc/tex/previousWorks.tex b/doc/tex/previousWorks.tex
new file mode 100644
index 0000000..6ba5dce
--- /dev/null
+++ b/doc/tex/previousWorks.tex
@@ -0,0 +1,21 @@
+\section{Previous works}
+
+\subsection{SGF}
+
+SGF (\textit{Smart Go Format} or \textit{Smart Game Format}) is a text file
+format specification for records of games or even collections of them. It was
+devised for Go but it supports other games with similar turns structure. It
+supports move variations, annotations, setups and game metadata. By supporting
+SGF, our application can be used to analyse existing games registered by other
+applications, such as those played on online Go servers.
+
+The SGF specification can be found at
+\url{https://www.red-bean.com/sgf/user_guide/index.html}
+
+\subsection{GTP}
+
+GTP (\textit{Go Text Protocol}) is a text based protocol for communication with
+computer go programs. [ref https://www.lysator.liu.se/~gunnar/gtp/] It is the
+protocol used by GNU Go and the more modern and powerful KataGo. By supporting
+GTP, our application can be used with existing GUIs and other programs, making
+it easier to use it with the tools users are already familiar with.
diff --git a/doc/tex/tfg.tex b/doc/tex/tfg.tex
new file mode 100644
index 0000000..9248748
--- /dev/null
+++ b/doc/tex/tfg.tex
@@ -0,0 +1,60 @@
+\documentclass{article}
+
+\usepackage{geometry}
+\usepackage{graphicx}
+\usepackage{booktabs}
+\usepackage{hyperref}
+\usepackage{csquotes}
+
+\usepackage[backend=biber, style=numeric-comp]{biblatex}
+\addbibresource{/home/taamas/docs/biber.bib}
+
+\geometry{left=4.5cm,top=2cm,bottom=2cm,right=4.5cm}
+
+\hypersetup{colorlinks=true,
+ linkcolor=black,
+ filecolor=magenta,
+ urlcolor=black,
+ bookmarks=true
+}
+
+\urlstyle{mono}
+
+%\renewcommand{\contentsname}{Contenidos}
+%\renewcommand{\figurename}{Figura}
+
+\newcommand{\program}{Go-AI}
+
+\newcommand{\inputtex}[1]{\input{tex/#1}}
+\newcommand{\fref}[1]{Fig.~\ref{#1}}
+%\newcommand{\uurl}[1]{\underline{\url{#1}}}
+
+\begin{document}
+
+\frenchspacing
+
+\title{\program}
+
+\author{รรฑigo Gutiรฉrrez Fernรกndez}
+
+\date{}
+
+\maketitle
+
+\begin{abstract}
+ This is the abstract.
+\end{abstract}
+
+\tableofcontents
+
+\inputtex{introduction.tex}
+
+\inputtex{previousWorks.tex}
+
+\inputtex{interface.tex}
+
+\inputtex{implementation.tex}
+
+\printbibliography{}
+
+\end{document}
diff --git a/go.py b/go.py
new file mode 100755
index 0000000..548df38
--- /dev/null
+++ b/go.py
@@ -0,0 +1,31 @@
+#!/usr/bin/python
+
+"""Play Go!"""
+
+from imago.engine.parseHelpers import ParseCodes, parseVertex
+from imago.gameLogic.gameState import GameState
+
+if __name__ == "__main__":
+
+ #GAMESTATE = GameState(5)
+ GAMESTATE = GameState(19)
+
+ while 1:
+
+ GAMESTATE.getBoard().printBoard()
+
+ move = input("Move (" + GAMESTATE.getPlayerCode() + "): ")
+ move = parseVertex(move, GAMESTATE.size)
+
+ if move == ParseCodes.ERROR:
+ print("Invalid move syntax. Example of move: A1")
+ continue
+
+ print()
+
+ player = str(GAMESTATE.getPlayerCode())
+
+ moveRow = move[0]
+ moveCol = move[1]
+
+ GAMESTATE.playMove(moveRow, moveCol)
diff --git a/imago/__init__.py b/imago/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/imago/__init__.py
diff --git a/imago/data/__init__.py b/imago/data/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/imago/data/__init__.py
diff --git a/imago/data/enums.py b/imago/data/enums.py
new file mode 100644
index 0000000..9d963ec
--- /dev/null
+++ b/imago/data/enums.py
@@ -0,0 +1,18 @@
+"""Enums"""
+
+from enum import Enum, auto as enumAuto
+
+class Player(Enum):
+ """Possibilities for players and the state of a cell."""
+ EMPTY = enumAuto()
+ BLACK = enumAuto()
+ WHITE = enumAuto()
+
+ @classmethod
+ def otherPlayer(cls, player):
+ """If argument is BLACK or WHITE returns the other, else it returns EMPTY."""
+ if player == cls.BLACK:
+ return cls.WHITE
+ if player == cls.WHITE:
+ return cls.BLACK
+ return cls.EMPTY
diff --git a/imago/engine/__init__.py b/imago/engine/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/imago/engine/__init__.py
diff --git a/imago/engine/core.py b/imago/engine/core.py
new file mode 100644
index 0000000..28166b8
--- /dev/null
+++ b/imago/engine/core.py
@@ -0,0 +1,68 @@
+#!/usr/bin/python
+
+"""Imago GTP engine"""
+
+from random import randrange
+
+from imago.data.enums import Player
+from imago.gameLogic.gameState import GameState
+
+DEF_SIZE = 19
+DEF_KOMI = 5.5
+
+class GameEngine:
+ """Plays the game of Go."""
+
+ def __init__(self):
+ self.komi = DEF_KOMI
+ self.gameState = GameState(DEF_SIZE)
+
+ def setBoardsize(self, newSize):
+ """Changes the size of the board.
+ Board state, number of stones and move history become arbitrary.
+ It is wise to call clear_board after this command.
+ """
+ self.gameState = GameState(newSize)
+
+ def clearBoard(self):
+ """The board is cleared, the number of captured stones reset to zero and the move
+ history reset to empty.
+ """
+ self.gameState.clearBoard()
+
+ def setKomi(self, komi):
+ """Sets a new value of komi."""
+ self.komi = komi
+
+ def setFixedHandicap(self, stones):
+ """Sets handicap stones in fixed vertexes."""
+ if stones < 1 or stones > 9:
+ raise Exception("Wrong number of handicap stones")
+ # TODO: Set handicap stones
+ return [[0,0], [0,1]]
+
+ def play(self, color, vertex):
+ """Plays in the vertex passed as argument"""
+ row = vertex[0]
+ col = vertex[1]
+ self.gameState.playMoveForPlayer(row, col, color)
+
+ def genmove(self, color):
+ """The key of this TFG."""
+ validCells = []
+ board = self.gameState.getBoard().board
+ size = self.gameState.size
+ for row in range(size):
+ for col in range(size):
+ if board[row][col] == Player.EMPTY:
+ validCells.append([row, col])
+ randIndex = randrange(0, len(validCells))
+ move = validCells[randIndex]
+ self.gameState.playMoveForPlayer(move[0], move[1], color)
+ return move
+
+ def undo(self):
+ """The board configuration and number of captured stones are reset to the state
+ before the last move, which is removed from the move history.
+ """
+ self.gameState.undo()
diff --git a/imago/engine/imagoIO.py b/imago/engine/imagoIO.py
new file mode 100644
index 0000000..b929788
--- /dev/null
+++ b/imago/engine/imagoIO.py
@@ -0,0 +1,157 @@
+#!/usr/bin/python
+
+"""Imago GTP engine input output"""
+
+import sys
+
+from imago.engine import parseHelpers
+from imago.engine.core import GameEngine
+
+def protocol_version(_):
+ """Version of the GTP Protocol"""
+ print("2")
+
+def name(_):
+ """Name of the engine"""
+ print("Imago")
+
+def version(_):
+ """Version of the engine"""
+ print("0.0.0")
+
+def getCoordsText(row, col):
+ """Returns a string representation of row and col.
+ In GTP A1 is bottom left corner.
+ """
+ return "%s%d" % (chr(65+row), col+1)
+
+class ImagoIO:
+ """Recieves and handles commands."""
+
+ def __init__(self):
+ self.commands_set = {
+ protocol_version,
+ name,
+ version,
+ self.known_command,
+ self.list_commands,
+ self.boardsize,
+ self.clear_board,
+ self.komi,
+ self.fixed_handicap,
+ self.place_free_handicap,
+ self.set_free_handicap,
+ self.play,
+ self.genmove,
+ self.undo
+ }
+ self.gameEngine = GameEngine()
+
+ def start(self):
+ """Starts reading commands interactively."""
+ while True:
+ input_tokens = input().split()
+
+ if input_tokens[0] == "quit":
+ sys.exit(0)
+
+ command = None
+ for comm in self.commands_set:
+ if comm.__name__ == input_tokens[0]:
+ command = comm
+
+ if command is not None:
+ arguments = input_tokens[1:]
+ #print("[DEBUG]:Selected command: %s; args: %s" % (command, arguments))
+ command(arguments)
+ else:
+ print("unknown command")
+
+ def known_command(self, args):
+ """True if command is known, false otherwise"""
+ if len(args) != 1:
+ print ("Wrong number of args.")
+ print ("Usage: known_command COMMAND_NAME")
+ sys.exit(0)
+ out = "false"
+ for c in self.commands_set:
+ if c.__name__ == args[0]:
+ out = "true"
+ print(out)
+
+ def list_commands(self, _):
+ """List of commands, one per row"""
+ for c in self.commands_set:
+ print("%s - %s" % (c.__name__, c.__doc__))
+
+ def boardsize(self, args):
+ """Changes the size of the board.
+ Board state, number of stones and move history become arbitrary.
+ It is wise to call clear_board after this command.
+ """
+ if len(args) != 1:
+ print("Error - Wrong n of args")
+ sys.exit(1)
+ size = int(args[0])
+ self.gameEngine.setBoardsize(size)
+
+ def clear_board(self, _):
+ """The board is cleared, the number of captured stones reset to zero and the move
+ history reset to empty.
+ """
+ self.gameEngine.clearBoard()
+
+ def komi(self, args):
+ """Sets a new value of komi."""
+ if len(args) != 1:
+ print("Error - Wrong n of args")
+ sys.exit(1)
+ komi = float(args[0])
+ self.gameEngine.setKomi(komi)
+
+ def fixed_handicap(self, args):
+ """Handicap stones are placed on the board on standard vertices.
+ These vertices follow the GTP specification.
+ """
+ if len(args) != 1:
+ print("Error - Wrong n of args")
+ sys.exit(1)
+ stones = float(args[0])
+ vertices = self.gameEngine.setFixedHandicap(stones)
+ out = getCoordsText(vertices[0][0], vertices[0][1])
+ for vertex in vertices[1:]:
+ out += " " + getCoordsText(vertex[0], vertex[1])
+ print(out)
+
+ def place_free_handicap(self, args):
+ """Handicap stones are placed on the board by the AI criteria."""
+ #TODO
+
+ def set_free_handicap(self, args):
+ """Handicap stones are placed on the board as requested."""
+ #TODO
+
+ def play(self, args):
+ """A stone of the requested color is played at the requested vertex."""
+ if len(args) != 2:
+ print("Error - Wrong n of args")
+ sys.exit(1)
+ move = parseHelpers.parseMove(args, self.gameEngine.gameState.size)
+ self.gameEngine.play(move.color, move.vertex)
+
+ def genmove(self, args):
+ """A stone of the requested color is played where the engine chooses."""
+ if len(args) != 1:
+ print("Error - Wrong n of args")
+ sys.exit(1)
+ color = parseHelpers.parseColor(args[0])
+ output = parseHelpers.vertexToString(self.gameEngine.genmove(color),
+ self.gameEngine.gameState.size)
+ print(output)
+ self.gameEngine.gameState.getBoard().printBoard()
+
+ def undo(self, _):
+ """The board configuration and number of captured stones are reset to the state
+ before the last move, which is removed from the move history.
+ """
+ self.gameEngine.undo()
diff --git a/imago/engine/parseHelpers.py b/imago/engine/parseHelpers.py
new file mode 100644
index 0000000..32f0753
--- /dev/null
+++ b/imago/engine/parseHelpers.py
@@ -0,0 +1,91 @@
+"""Handles translation of input text to internal data and vice versa."""
+
+import re
+from enum import Enum, auto as enumAuto
+
+from imago.data.enums import Player
+
+VALID_WHITE_STRINGS = {
+ "W",
+ "WHITE"
+}
+
+VALID_BLACK_STRINGS = {
+ "B",
+ "BLACK"
+}
+
+class ParseCodes(Enum):
+ """Return values of the move parser."""
+ ERROR = enumAuto()
+ QUIT = enumAuto()
+
+def parseMove(args, boardsize):
+ """Converts the textual input of a move to a move instance."""
+ if len(args) != 2:
+ print("[ERROR] - Wrong n of args for move")
+ return ParseCodes.ERROR
+ color = parseColor(args[0])
+ vertex = parseVertex(args[1], boardsize)
+ return GtpMove(color, vertex)
+
+def parseColor(text):
+ """Returns color of a move given its input string."""
+ text = text.upper()
+ if text in VALID_WHITE_STRINGS:
+ return Player.WHITE
+ if text in VALID_BLACK_STRINGS:
+ return Player.BLACK
+ print("[ERROR] - Unknown color.")
+ return ParseCodes.ERROR
+
+def parseVertex(text, boardSize):
+ """Returns row and column of a vertex given its input string.
+
+ GTP uses A1 style notation: columns are letters left to right, rows are number bottom
+ to top.
+ """
+ text = text.upper()
+
+ if not re.match("^[A-HJ-Z][1-9][0-9]*$", text):
+ return ParseCodes.ERROR
+
+ vertexCol = ord(text[0])
+ # Column 'I' does not exist
+ if vertexCol > ord('I'):
+ vertexCol -= 1
+ vertexCol -= ord('A')
+
+ vertexRow = boardSize - int(text[1:])
+
+ if (vertexCol < 0 or vertexRow < 0
+ or vertexCol >= boardSize or vertexRow >= boardSize):
+ return ParseCodes.ERROR
+
+ return [vertexRow, vertexCol]
+
+def vertexToString(vertex, boardSize):
+ """Returns a string representing the vertex.
+
+ GTP uses A1 style notation: columns are letters left to right, rows are number bottom
+ to top.
+ """
+ if len(vertex) != 2:
+ return ParseCodes.ERROR
+ if vertex[0] >= boardSize or vertex[1] >= boardSize or vertex[0] < 0 or vertex[1] < 0:
+ return ParseCodes.ERROR
+
+ vertexRow = boardSize - vertex[0]
+ vertexCol = ord('A') + vertex[1]
+
+ # Column 'I' does not exist
+ if vertexCol >= ord('I'):
+ vertexCol += 1
+
+ return "%s%d" % (chr(vertexCol), vertexRow)
+
+class GtpMove:
+ """Stores the info of a move according to GTP specification: color and vertex."""
+ def __init__(self, color, vertex):
+ self.color = color
+ self.vertex = vertex
diff --git a/imago/gameLogic/__init__.py b/imago/gameLogic/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/imago/gameLogic/__init__.py
diff --git a/imago/gameLogic/gameBoard.py b/imago/gameLogic/gameBoard.py
new file mode 100644
index 0000000..265b646
--- /dev/null
+++ b/imago/gameLogic/gameBoard.py
@@ -0,0 +1,177 @@
+"""Representation of a board. Contains played stones and captured stones."""
+
+from copy import deepcopy
+
+from imago.data.enums import Player
+
+def getNewBoard(size):
+ """Return a new board."""
+ board = []
+ for row in range(size):
+ board.append([])
+ for _ in range(size):
+ board[row].append(Player.EMPTY)
+ return board
+
+class GameBoard:
+
+ def __init__(self, size):
+ self.board = getNewBoard(size)
+ self.capturesBlack = 0
+ self.capturesWhite = 0
+ self.lastStone = None
+
+ def getDeepCopy(self):
+ """Returns a copy GameBoard."""
+ newBoard = GameBoard(len(self.board))
+ newBoard.capturesBlack = self.capturesBlack
+ newBoard.capturesWhite = self.capturesWhite
+ newBoard.lastStone = self.lastStone
+ newBoard.board = deepcopy(self.board)
+ return newBoard
+
+ def getGroupLiberties(self, row, col):
+ """Returns the empty vertexes adjacent to the group occupying a cell (its
+ liberties) or -1 if the cell is empty.
+ """
+ groupColor = self.board[row][col]
+ if groupColor == Player.EMPTY:
+ return -1
+ emptyCells = set()
+ exploredCells = set()
+ self.__exploreLiberties(row, col, groupColor, emptyCells, exploredCells)
+ return emptyCells
+
+ def __exploreLiberties(self, row, col, groupColor, emptyCells, exploredCells):
+ """Adds surrounding empty cells to array if they have not been added yet
+ and explores adjacent occupied cells of the same group.
+ """
+ if (row, col) in exploredCells:
+ return
+
+ exploredCells.add((row, col))
+
+ cellColor = self.board[row][col]
+
+ if cellColor != groupColor:
+ if cellColor == Player.EMPTY:
+ emptyCells.add((row, col))
+ return
+
+ # Up
+ if row > 0:
+ self.__exploreLiberties(row-1, col, groupColor, emptyCells, exploredCells)
+
+ # Right
+ if col < len(self.board[0])-1:
+ self.__exploreLiberties(row, col+1, groupColor, emptyCells, exploredCells)
+
+ # Down
+ if row < len(self.board)-1:
+ self.__exploreLiberties(row+1, col, groupColor, emptyCells, exploredCells)
+
+ # Left
+ if col > 0:
+ self.__exploreLiberties(row, col-1, groupColor, emptyCells, exploredCells)
+
+ def getGroupCells(self, row, col):
+ """Returns a set containing the cells occupied by the group in the given cell."""
+ groupColor = self.board[row][col]
+ if groupColor == Player.EMPTY:
+ return 0
+ cells = set()
+ self.__exploreGroup(row, col, groupColor, cells)
+ return cells
+
+ def __exploreGroup(self, row, col, groupColor, cells):
+ if self.board[row][col] != groupColor or (row, col) in cells:
+ return
+ cells.add((row, col))
+
+ # Up
+ if row > 0:
+ self.__exploreGroup(row-1, col, groupColor, cells)
+
+ # Right
+ if col < len(self.board[0])-1:
+ self.__exploreGroup(row, col+1, groupColor, cells)
+
+ # Down
+ if row < len(self.board)-1:
+ self.__exploreGroup(row+1, col, groupColor, cells)
+
+ # Left
+ if col > 0:
+ self.__exploreGroup(row, col-1, groupColor, cells)
+
+
+ def moveCapture(self, row, col, player):
+ """Checks surrounding captures of a move, removes them and returns the number of
+ stones captured.
+ """
+ captured = 0
+ if row > 0:
+ if (self.board[row-1][col] != player
+ and self.board[row-1][col] != Player.EMPTY
+ and len(self.getGroupLiberties(row-1, col)) == 0):
+ captured += self.captureGroup(row-1, col)
+ if row < len(self.board)-1:
+ if (self.board[row+1][col] != player
+ and self.board[row+1][col] != Player.EMPTY
+ and len(self.getGroupLiberties(row+1, col)) == 0):
+ captured += self.captureGroup(row+1, col)
+ if col > 0:
+ if (self.board[row][col-1] != player
+ and self.board[row][col-1] != Player.EMPTY
+ and len(self.getGroupLiberties(row, col-1)) == 0):
+ captured += self.captureGroup(row, col-1)
+ if col < len(self.board[0])-1:
+ if (self.board[row][col+1] != player
+ and self.board[row][col+1] != Player.EMPTY
+ and len(self.getGroupLiberties(row, col+1)) == 0):
+ captured += self.captureGroup(row, col+1)
+ return captured
+
+ def captureGroup(self, row, col):
+ """Removes all the stones from the group occupying the given cell and returns the
+ number of removed stones.
+ """
+ cellsToCapture = self.getGroupCells(row, col)
+ count = 0
+ for cell in cellsToCapture:
+ self.board[cell[0]][cell[1]] = Player.EMPTY
+ count += 1
+ return count
+
+ def printBoard(self):
+ """Print the board."""
+ colTitle = 'A'
+ rowTitlePadding = 2
+
+ # Print column names
+ rowText = " " * (rowTitlePadding + 2)
+ for col in range(len(self.board[0])):
+ rowText += colTitle + " "
+ colTitle = chr(ord(colTitle)+1)
+ if colTitle == "I": # Skip I
+ colTitle = "J"
+ print(rowText)
+
+ # Print rows
+ rowTitle = len(self.board)
+ for row in self.board:
+ rowText = ""
+ for col in row:
+ rowText += cellToString(col) + " "
+ print(str(rowTitle) + " " * rowTitlePadding + rowText)
+ rowTitle -= 1
+ if rowTitle == 9:
+ rowTitlePadding += 1
+
+def cellToString(code):
+ """Returns the text representation of a cell."""
+ if code == Player.WHITE:
+ return 'W'
+ if code == Player.BLACK:
+ return 'B'
+ return 'ยท'
diff --git a/imago/gameLogic/gameData.py b/imago/gameLogic/gameData.py
new file mode 100644
index 0000000..6cc4d7e
--- /dev/null
+++ b/imago/gameLogic/gameData.py
@@ -0,0 +1,51 @@
+"""Invariable data pertaining a match."""
+
+class GameData:
+ """Invariable data pertaining a match."""
+
+ def __init__(self,
+ name = None,
+ size = 19,
+ annotator = None,
+ date = None,
+ blackRank = "?",
+ whiteRank = "?",
+ blackName = None,
+ whiteName = None,
+ blackTeam = None,
+ whiteTeam = None,
+ copyrightInfo = None,
+ event = None,
+ gameComment = None,
+ openingInfo = None,
+ timeInfo = None,
+ overtimeInfo = None,
+ placeInfo = None,
+ result = "?",
+ roundInfo = None,
+ rules = None,
+ source = None,
+ user = None
+ ):
+ self.name = name
+ self.size = size
+ self.annotator = annotator
+ self.date = date
+ self.blackRank = blackRank
+ self.whiteRank = whiteRank
+ self.blackName = blackName
+ self.whiteName = whiteName
+ self.blackTeam = blackTeam
+ self.whiteTeam = whiteTeam
+ self.copyrightInfo = copyrightInfo
+ self.event = event
+ self.gameComment = gameComment
+ self.openingInfo = openingInfo
+ self.timeInfo = timeInfo
+ self.overtimeInfo = overtimeInfo
+ self.placeInfo = placeInfo
+ self.result = result
+ self.roundInfo = roundInfo
+ self.rules = rules
+ self.source = source
+ self.user = user
diff --git a/imago/gameLogic/gameMove.py b/imago/gameLogic/gameMove.py
new file mode 100644
index 0000000..bd210b4
--- /dev/null
+++ b/imago/gameLogic/gameMove.py
@@ -0,0 +1,19 @@
+"""Information about one move."""
+
+class GameMove:
+
+ def __init__(self, player, row, col, makesKo, board):
+ self.player = player
+ self.row = row
+ self.col = col
+ self.makesKo = makesKo
+ self.board = board
+ self.nextMoves = []
+ self.previousMove = None
+
+ def addMove(self, player, row, col, makesKo, board):
+ """Adds a move to the next moves list."""
+ newMove = GameMove(player, row, col, makesKo, board)
+ newMove.previousMove = self
+ self.nextMoves.append(newMove)
+ return newMove
diff --git a/imago/gameLogic/gameState.py b/imago/gameLogic/gameState.py
new file mode 100644
index 0000000..7a96962
--- /dev/null
+++ b/imago/gameLogic/gameState.py
@@ -0,0 +1,105 @@
+"""Storing state of the game."""
+
+from imago.data.enums import Player
+from imago.gameLogic.gameTree import GameTree
+from imago.gameLogic.gameMove import GameMove
+from imago.gameLogic.gameBoard import GameBoard, cellToString
+
+class GameState:
+ """Stores the state of the game."""
+
+ def __init__(self, size):
+ self.size = size
+ self.gameTree = None
+ self.lastMove = None
+ self.initState()
+
+ def getCurrentPlayer(self):
+ """Gets the player who should make the next move."""
+ if self.lastMove is None:
+ return Player.BLACK
+ return Player.otherPlayer(self.lastMove.player)
+
+ def getPlayerCode(self):
+ """Gets a string representation of the current player."""
+ return cellToString(self.getCurrentPlayer())
+
+ def getBoard(self):
+ """Returns the board as of the last move."""
+ if self.lastMove is None:
+ return GameBoard(self.size)
+ return self.lastMove.board
+
+ def playMove(self, row, col):
+ """Execute a move on the board for the current player and switches players."""
+ return self.playMoveForPlayer(row, col, self.getCurrentPlayer())
+
+ def playMoveForPlayer(self, row, col, player):
+ """Execute a move on the board for the given player."""
+
+ # Check valid move
+ if not self.prevalidateMove(row, col):
+ print("Invalid move!")
+ return False
+
+ newBoard = self.getBoard().getDeepCopy()
+
+ newBoard.board[row][col] = player
+
+ groupLiberties = newBoard.getGroupLiberties(row, col)
+
+ # Check suicide
+ killed = newBoard.moveCapture(row, col, player)
+ if killed == 0 and len(groupLiberties) == 0:
+ print("Invalid move! (Suicide)")
+ return False
+
+ # Check ko
+ if self.lastMove is not None:
+ illegalKoVertex = self.lastMove.makesKo
+ if illegalKoVertex is not None:
+ if row == illegalKoVertex[0] and col == illegalKoVertex[1]:
+ print("Invalid move! (Ko)")
+ return False
+
+ # Move is legal
+
+ # Check if move makes ko
+ makesKo = None
+ if killed == 1 and len(groupLiberties) == 1:
+ makesKo = groupLiberties[0]
+
+ self.__addMove(player, row, col, makesKo, newBoard)
+ return True
+
+ def undo(self):
+ """Sets the move before the last move as the new last move."""
+ self.lastMove = self.lastMove.previousMove
+
+ def initState(self):
+ """Starts current player, captured stones, board and game tree."""
+ self.capturesBlack = 0
+ self.capturesWhite = 0
+ self.gameTree = GameTree()
+ self.lastMove = None
+
+ def clearBoard(self):
+ """Clears the board, captured stones and game tree."""
+ self.initState()
+
+ def prevalidateMove(self, row, col):
+ """Returns True if move is valid, False if not."""
+ if (row < 0 or row >= self.size
+ or col < 0 or col >= self.size):
+ return False
+ if self.getBoard().board[row][col] != Player.EMPTY:
+ return False
+ return True
+
+ def __addMove(self, player, row, col, makesKo, newBoard):
+ if self.lastMove is None:
+ self.lastMove = GameMove(player, row, col, makesKo, newBoard)
+ self.gameTree.firstMoves.append(self.lastMove)
+ else:
+ self.lastMove = self.lastMove.addMove(player, row, col, makesKo, newBoard)
+ return self.lastMove
diff --git a/imago/gameLogic/gameTree.py b/imago/gameLogic/gameTree.py
new file mode 100644
index 0000000..4b88c4d
--- /dev/null
+++ b/imago/gameLogic/gameTree.py
@@ -0,0 +1,8 @@
+"""A tree storing a match's history, variants and information."""
+
+# This class will not be necessary if it just keeps being a list of moves
+
+class GameTree:
+
+ def __init__(self):
+ self.firstMoves = []
diff --git a/imago/sgfParser/__init__.py b/imago/sgfParser/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/imago/sgfParser/__init__.py
diff --git a/imago/sgfParser/astNode.py b/imago/sgfParser/astNode.py
new file mode 100644
index 0000000..ec28c2a
--- /dev/null
+++ b/imago/sgfParser/astNode.py
@@ -0,0 +1,127 @@
+from imago.gameLogic.gameTree import GameTree
+from imago.gameLogic.gameData import GameData
+from imago.gameLogic.gameMove import GameMove
+from imago.gameLogic.gameState import Player
+
+class ASTNode:
+ """Abstract Syntax Tree Node of SGF parser"""
+ def __init__(self, children=None, leaf=None, props=None):
+ if children:
+ self.children = children
+ else:
+ self.children = []
+ if props:
+ self.props = props
+ else:
+ self.props = {}
+ self.leaf = leaf
+
+ def addToSequence(self, move):
+ """Appends a move to the last of the sequence started by this move"""
+ children = self.children
+ while len(children) > 0:
+ children = children[0].children
+ children.append(move)
+
+ def toGameTree(self):
+ """Converts this node and its subtree into a GameTree"""
+ gameData = GameData()
+ for prop in self.props:
+ if prop.name == "GM": # Type of game, 1 is Go
+ if prop.value != 1:
+ print("ERROR") # TODO: Error handling
+ if prop.name == "SZ": # Size of board. [19] for squared, [10:12] for rect.
+ gameData.size = prop.value
+ if prop.name == "AN": # Annotator
+ gameData.annotator = prop.value
+ if prop.name == "BR": # Rank of black player
+ gameData.blackRank = prop.value
+ if prop.name == "WR": # Rank of white player
+ gameData.whiteRank = prop.value
+ if prop.name == "PB": # Name of black player
+ gameData.blackName = prop.value
+ if prop.name == "PW": # Name of white player
+ gameData.whiteName = prop.value
+ if prop.name == "BT": # Name of black team
+ gameData.blackTeam = prop.value
+ if prop.name == "WT": # Name of white team
+ gameData.whiteTeam = prop.value
+ if prop.name == "CP": # Copyright information
+ gameData.copyright = prop.value
+ if prop.name == "DT": # Date
+ gameData.date = prop.value
+ if prop.name == "EV": # Event information
+ gameData.event = prop.value
+ if prop.name == "GN": # Game nae
+ gameData.name = prop.value
+ if prop.name == "GC": # Extra game comment
+ gameData.gameComment = prop.value
+ if prop.name == "ON": # Description of opening played
+ gameData.openingInfo = prop.value
+ if prop.name == "OT": # Overtime method
+ gameData.overtimeInfo = prop.value
+ if prop.name == "PC": # Place where the game took place
+ gameData.place = prop.value
+ if prop.name == "RE": # Result of the game
+ gameData.result = prop.value
+ if prop.name == "RO": # Round number and type
+ gameData.roundInfo = prop.value
+ if prop.name == "RU": # Rules used for the game
+ gameData.rules = prop.value
+ if prop.name == "SO": # Source of the gamw
+ gameData.source = prop.source
+ if prop.name == "TM": # Time limit in seconds
+ gameData.timeInfo = prop.source
+ if prop.name == "US": # User or program which entered the game
+ gameData.user = prop.source
+
+ firstMoves = []
+ for child in self.children:
+ firstMoves.append(child.toGameMoveTree)
+
+ return GameTree(firstMoves, gameData)
+
+ def toGameMoveTree(self):
+ player = 0
+ coords = []
+ for prop in self.props:
+ if prop.name == "B": # White move
+ player = Player.BLACK
+ coords = textToCoords(prop.value)
+ if prop.name == "W": # White move
+ player = Player.WHITE
+ coords = textToCoords(prop.value)
+ gameMove = GameMove(player, coords[0], coords[1])
+ for child in self.children:
+ newMove = child.toGameMoveTree()
+ gameMove.nextMoves.append(newMove)
+ newMove.previousMove = gameMove
+ return gameMove
+
+def textToCoords(text): # Poner en PropertyMove, subclase de Property
+ col = ord(text[1]) - ord('a')
+ row = ord(text[0]) - ord('a')
+ return [row, col]
+
+
+ def toString(self):
+ """Returns a depth-first representation of the tree."""
+ out = '(' + str(self.props) + ')'
+ out += "in"
+ for node in self.children:
+ out = out + node.toString()
+ out += "out"
+ return out
+
+class Property:
+ """Property of a Node"""
+ def __init__(self, name, value):
+ self.name = name
+ self.value = value
+
+ def addValue(self, value):
+ """Adds a new value to this properties value, making it a list if necessary"""
+ if type(self.value) == list:
+ self.value.append(value)
+ else:
+ self.value = [self.value, value]
diff --git a/imago/sgfParser/sgf.py b/imago/sgfParser/sgf.py
new file mode 100644
index 0000000..b5c0be2
--- /dev/null
+++ b/imago/sgfParser/sgf.py
@@ -0,0 +1,11 @@
+"""Module for reading and writing of SGF files."""
+
+from imago.gameLogic.gameTree import GameTree
+from imago.gameLogic.gameMove import GameMove
+
+# def loadGameTree(filename):
+# PLY?
+# """Parses a GameTree instance from a source SGF file."""
+# sgf = open(filename, "r")
+#
+# a = GameTree()
diff --git a/imago/sgfParser/sgflex.py b/imago/sgfParser/sgflex.py
new file mode 100755
index 0000000..07fb404
--- /dev/null
+++ b/imago/sgfParser/sgflex.py
@@ -0,0 +1,81 @@
+#!/bin/python
+
+# --------------------------------------
+# sgflex.py
+""" Tokenizer for SGF """
+# --------------------------------------
+
+import ply.lex as lex
+
+# List of token names
+tokens = (
+ 'LPAREN',
+ 'RPAREN',
+ 'SCOLON',
+ 'LSQBRACKET',
+ 'RSQBRACKET',
+ 'PROPID',
+ 'UCLETTER',
+ 'DIGIT',
+ 'NUMBER',
+ 'REAL',
+ 'DOUBLE',
+ 'COLOR',
+ 'PROPVALUE'
+)
+
+# Regular expression rules for simple tokens
+
+t_LPAREN = r'\('
+t_RPAREN = r'\)'
+t_SCOLON = r';'
+t_LSQBRACKET = r'\['
+t_RSQBRACKET = r'\]'
+t_PROPID = r'[A-Z][A-Z]?'
+t_UCLETTER = r'[A-Z]'
+t_DIGIT = r'[0-9]'
+t_COLOR = r'[BW]'
+
+def t_NUMBER(t):
+ r'[+-]?[0-9]+'
+ t.value = int(t.value)
+ return t
+
+def t_REAL(t):
+ r'[+-]?[0-9]+\.[0-9]+'
+ t.value = int(t.value)
+ return t
+
+def t_DOUBLE(t):
+ r'[12]'
+ t.value = int(t.value)
+ return t
+
+def t_PROPVALUE(t):
+ r'\[[^\]]*\]'
+ t.value = t.value.strip('[').strip(']')
+ return t
+
+# Rule to track line numbers
+def t_newline(t):
+ r'\n+'
+ t.lexer.lineno += len(t.value)
+
+t_ignore = ' \t'
+
+def t_error(t):
+ """Error handling rule"""
+ print("Illegal character '%s'" % t.value[0])
+ t.lexer.skip(1)
+
+#data='''
+#B[aa ]
+#W[AB]W[ab]
+#B[bb]
+#'''
+
+lexer = lex.lex()
+#lexer.input(data)
+
+#for token in lexer:
+# print(token)
diff --git a/imago/sgfParser/sgfyacc.py b/imago/sgfParser/sgfyacc.py
new file mode 100755
index 0000000..bd00df6
--- /dev/null
+++ b/imago/sgfParser/sgfyacc.py
@@ -0,0 +1,61 @@
+#!/bin/python
+
+# --------------------------------------
+# sgyacc.py
+""" Parser for SGF """
+# --------------------------------------
+
+import ply.yacc as yacc
+
+from sgflex import tokens
+from astNode import ASTNode, Property
+
+def p_tree(p):
+ '''tree : LPAREN node RPAREN
+ | LPAREN tree RPAREN'''
+ p[0] = p[2]
+
+def p_node_sequence(p):
+ '''node : node node'''
+ p[1].addToSequence(p[2])
+ p[0] = p[1]
+
+def p_node_tree(p):
+ '''node : node tree'''
+ p[1].children.append(p[2])
+ p[0] = p[1]
+
+def p_node(p):
+ 'node : SCOLON'
+ p[0] = ASTNode()
+
+def p_node_prop(p):
+ 'node : node property'
+ p[1].props[p[2].name] = p[2].value
+ p[0] = p[1]
+
+def p_property(p):
+ 'property : PROPID PROPVALUE'
+ p[0] = Property(p[1], p[2])
+
+def p_property_value(p):
+ 'property : property PROPVALUE'
+ p[1].addValue(p[2])
+ p[0] = p[1]
+
+def p_error(_):
+ """Error rule for syntax errors"""
+ print("Syntax error in input!")
+
+# Build the parser
+parser = yacc.yacc()
+
+while True:
+ try:
+ s = input('calc > ')
+ except EOFError:
+ break
+ if not s:
+ continue
+ result = parser.parse(s)
+ print(result.toString())
diff --git a/imagocli.py b/imagocli.py
new file mode 100755
index 0000000..e8e4580
--- /dev/null
+++ b/imagocli.py
@@ -0,0 +1,9 @@
+#!/usr/bin/python
+
+"""Run the Imago engine."""
+
+from imago.engine.imagoIO import ImagoIO
+
+if __name__ == "__main__":
+ io = ImagoIO()
+ io.start()
diff --git a/test.sh b/test.sh
new file mode 100755
index 0000000..b929249
--- /dev/null
+++ b/test.sh
@@ -0,0 +1,2 @@
+#!/bin/sh
+coverage run --source=imago -m unittest discover tests/ && coverage report -m --skip-empty
diff --git a/tests/test_parseHelpers.py b/tests/test_parseHelpers.py
new file mode 100644
index 0000000..cf1fa9f
--- /dev/null
+++ b/tests/test_parseHelpers.py
@@ -0,0 +1,99 @@
+"""Tests for parseHelpers module."""
+
+import unittest
+
+from imago.data.enums import Player
+from imago.engine import parseHelpers
+
+TEST_BOARD_SIZE = 19
+
+class TestParseHelpers(unittest.TestCase):
+ """Test parseHelpers module."""
+
+ def testParseMove(self):
+ """Test parsing of GtpMove"""
+
+ self.assertEqual(parseHelpers.parseMove(["B"], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.parseMove(["A1"], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.parseMove(["B", "A1", "W"], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+
+ parsedMove = parseHelpers.parseMove(["B", "t1"], TEST_BOARD_SIZE)
+
+ targetMove = parseHelpers.GtpMove(Player.BLACK, [18, 18])
+ self.assertEqual(parsedMove.color, targetMove.color)
+ self.assertEqual(parsedMove.vertex, targetMove.vertex)
+
+ def testParseColor(self):
+ """Test parsing of color"""
+ self.assertEqual(parseHelpers.parseColor("b"), Player.BLACK)
+ self.assertEqual(parseHelpers.parseColor("B"), Player.BLACK)
+ self.assertEqual(parseHelpers.parseColor("w"), Player.WHITE)
+ self.assertEqual(parseHelpers.parseColor("W"), Player.WHITE)
+ self.assertEqual(parseHelpers.parseColor("bw"), parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.parseColor("wb"), parseHelpers.ParseCodes.ERROR)
+
+ def testParseVertexWrongInputs(self):
+ """Test wrong inputs for parseVertex."""
+ inputs = ( "a", "1", "1a", "aa1", "a0", "u1", "a"+str(TEST_BOARD_SIZE+1) )
+ for text in inputs:
+ self.assertEqual(parseHelpers.parseVertex(text, TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+
+ def testParseVertexCorrectInputs(self):
+ """Test correct inputs and their resulting coordinates for parseVertex."""
+ self.assertEqual(parseHelpers.parseVertex(
+ "a1", TEST_BOARD_SIZE),
+ [18,0])
+ self.assertEqual(parseHelpers.parseVertex(
+ "b1", TEST_BOARD_SIZE),
+ [18,1])
+ self.assertEqual(parseHelpers.parseVertex(
+ "a2", TEST_BOARD_SIZE),
+ [17,0])
+ self.assertEqual(parseHelpers.parseVertex(
+ "b2", TEST_BOARD_SIZE),
+ [17,1])
+
+ self.assertEqual(parseHelpers.parseVertex(
+ "T1", TEST_BOARD_SIZE),
+ [18,18])
+ self.assertEqual(parseHelpers.parseVertex(
+ "T19", TEST_BOARD_SIZE),
+ [0,18])
+ self.assertEqual(parseHelpers.parseVertex(
+ "A19", TEST_BOARD_SIZE),
+ [0,0])
+
+ def testVertexToString(self):
+ """Test converting vertices to strings."""
+ self.assertEqual(parseHelpers.vertexToString([0,0], TEST_BOARD_SIZE), "A19")
+ self.assertEqual(parseHelpers.vertexToString([1,0], TEST_BOARD_SIZE), "A18")
+ self.assertEqual(parseHelpers.vertexToString([2,0], TEST_BOARD_SIZE), "A17")
+ self.assertEqual(parseHelpers.vertexToString([0,1], TEST_BOARD_SIZE), "B19")
+ self.assertEqual(parseHelpers.vertexToString([0,2], TEST_BOARD_SIZE), "C19")
+ self.assertEqual(parseHelpers.vertexToString([0,18], TEST_BOARD_SIZE), "T19")
+ self.assertEqual(parseHelpers.vertexToString([18,0], TEST_BOARD_SIZE), "A1")
+ self.assertEqual(parseHelpers.vertexToString([18,18], TEST_BOARD_SIZE), "T1")
+
+ self.assertEqual(parseHelpers.vertexToString([-1,0], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.vertexToString([0,-1], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.vertexToString([-1,-1], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.vertexToString([19,0], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.vertexToString([0,19], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.vertexToString([19,19], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.vertexToString([0], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+ self.assertEqual(parseHelpers.vertexToString([0,0,0], TEST_BOARD_SIZE),
+ parseHelpers.ParseCodes.ERROR)
+
+if __name__ == '__main__':
+ unittest.main()