summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAargh Rai <aargh.rai+git@gmail.com>2026-06-19 23:11:10 +0530
committerAargh Rai <aargh.rai+git@gmail.com>2026-06-19 23:11:10 +0530
commitb5d53cd4210a74c65a42b6387dd78c4e5bc9c17f (patch)
tree6f9c2e56b70a3a69d3c44d14e6947ffc07731136
parent058f12c699c9183f93f280ad7eb54c8a1b25f523 (diff)
license & uci
-rw-r--r--.clangd1
-rwxr-xr-x.gitignore2
-rw-r--r--LICENSE674
-rw-r--r--build.c99
-rw-r--r--shell.nix35
-rw-r--r--src/uci.c55
-rw-r--r--src/uci/UCI-Protocol-Specification.txt544
-rw-r--r--src/uci/command.c125
-rw-r--r--src/uci/command.h21
-rw-r--r--src/uci/draft-1.pdfbin0 -> 593597 bytes
-rw-r--r--src/uci/draft-2.pdfbin0 -> 75147 bytes
-rw-r--r--src/uci/response.c103
-rw-r--r--src/uci/response.h9
-rw-r--r--src/uci/uci_min.txt140
14 files changed, 1768 insertions, 40 deletions
diff --git a/.clangd b/.clangd
index 764bc55..a5e5c6b 100644
--- a/.clangd
+++ b/.clangd
@@ -1,3 +1,4 @@
CompileFlags:
Add: [-Wno-override-init]
+ Compiler: arm-none-eabi-gcc
diff --git a/.gitignore b/.gitignore
index b27909b..104c591 100755
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,4 @@
build
*.o
-stockfish
generated
+opt
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/build.c b/build.c
index 041bb57..8af54da 100644
--- a/build.c
+++ b/build.c
@@ -29,10 +29,11 @@ void print_cmd(char** args) {
printf("\n");
}
-int clean_mode();
-int test_mode();
-int server_mode();
-int engine_mode();
+int clean_mode(int run_mode);
+int test_mode(int run_mode);
+int server_mode(int run_mode);
+int engine_mode(int run_mode);
+int uci_mode(int run_mode);
// https://github.com/tsoding/nob.h/blob/0a08926d8094fc4ae678155c5d73ae21d1f96f3f/nob.h#L2413
int needs_rebuild(char* bin_file, char* source_file) {
@@ -54,6 +55,7 @@ int needs_rebuild(char* bin_file, char* source_file) {
#define ENGINE_O "output/engine.o"
#define SERVER_O "output/server.o"
+#define UCI_O "output/uci.o"
#define LOG_O "output/log.o"
#define LOGGER_C "src/logger/logger.c"
@@ -69,60 +71,83 @@ int main(int argc, char** argv) {
execvp(argv[0], argv);
}
- RUN_CMD({"rm", "/dev/mqueue/logs", NULL});
RUN_CMD({"mkdir", "-p", "output", NULL});
- if (argc > 1) {
- if (strcmp(argv[1], "test") == 0) {
- return test_mode();
- }
- if (strcmp(argv[1], "server") == 0) {
- RUN_CMD({CC, "src/log.c", "-o", LOG_O, NULL});
- return server_mode();
- }
- if (strcmp(argv[1], "clean") == 0) {
- RUN_CMD({CC, "src/log.c", "-o", LOG_O, NULL});
- return clean_mode();
- }
+ if (argc <= 1) return 1;
+ int run_mode = argc == 3;
+
+ if (strcmp(argv[1], "test") == 0) {
+ return test_mode(run_mode);
+ }
+ if (strcmp(argv[1], "clean") == 0) {
+ return clean_mode(run_mode);
+ }
+ if (strcmp(argv[1], "uci") == 0) {
+ return uci_mode(run_mode);
+ }
+ RUN_CMD({CC, "src/log.c", "-o", LOG_O, NULL});
+ if (strcmp(argv[1], "engine") == 0) {
+ return engine_mode(run_mode);
+ }
+ if (strcmp(argv[1], "server") == 0) {
+ return server_mode(run_mode);
}
- return engine_mode();
}
-int clean_mode() {
+int clean_mode(int _) {
char* args[] = {"rm", "-r", "output", NULL};
print_cmd(args);
execvp(args[0], args);
return 0;
}
-int test_mode() {
+int test_mode(int run_mode) {
+ if (run_mode) {
+ char* args[] = {"./output/test.o", NULL};
+ print_cmd(args);
+ execvp(args[0], args);
+ }
+
RUN_CMD({CC, "generate/find_tests.c", LOGGER_C, "-o", "output/find_tests.o", NULL});
RUN_CMD({"./output/find_tests.o", NULL});
printf("\n");
RUN_CMD({CC, "tests/main.c", LOGGER_C, "-o", "output/test.o", NULL});
-
- char* args[] = {"./output/test.o", NULL};
- print_cmd(args);
- execvp(args[0], args);
- return 0;
+ return status != 0;
}
-int server_mode() {
- RUN_CMD({"rm", "/dev/mqueue/server_to_engine", "/dev/mqueue/engine_to_server", NULL});
+int server_mode(int run_mode) {
+ if (run_mode) {
+ RUN_CMD({"rm", "/dev/mqueue/logs", NULL});
+ RUN_CMD({"rm", "/dev/mqueue/server_to_engine", "/dev/mqueue/engine_to_server", NULL});
+ char* args[] = {LOG_O, SERVER_O, ENGINE_O, NULL};
+ print_cmd(args);
+ execvp(args[0], args);
+ }
+
RUN_CMD({CC, "src/server.c", LOGGER_C, "-lcrypto", "-o", SERVER_O, NULL});
RUN_CMD({CC, "src/engine.c", LOGGER_C, "-o", ENGINE_O, NULL});
-
- char* args[] = {LOG_O, SERVER_O, ENGINE_O, NULL};
- print_cmd(args);
- execvp(args[0], args);
- return 0;
+ return status != 0;
}
-int engine_mode() {
+int engine_mode(int run_mode) {
+ if (run_mode) {
+ RUN_CMD({"rm", "/dev/mqueue/logs", NULL});
+ char* args[] = {LOG_O, ENGINE_O, NULL};
+ print_cmd(args);
+ execvp(args[0], args);
+ }
+
RUN_CMD({CC, "src/engine.c", LOGGER_C, "-o", ENGINE_O, NULL});
+ return status != 0;
+}
- char* args[] = {LOG_O, ENGINE_O, NULL};
- print_cmd(args);
- execvp(args[0], args);
- return 0;
+int uci_mode(int run_mode) {
+ if (run_mode) {
+ char* args[] = {UCI_O, NULL};
+ print_cmd(args);
+ execvp(args[0], args);
+ }
+
+ RUN_CMD({CC, "src/uci.c", "-o", UCI_O, NULL});
+ return status != 0;
}
diff --git a/shell.nix b/shell.nix
index 9d0bdbb..092bd0e 100644
--- a/shell.nix
+++ b/shell.nix
@@ -1,10 +1,41 @@
{ pkgs ? import <nixpkgs> {} }:
-
+let
+ install_opt_deps = false;
+ libraries = with pkgs; [
+ webkitgtk_4_1
+ gtk3
+ cairo
+ gdk-pixbuf
+ glib
+ dbus
+ openssl
+ librsvg
+ ];
+in
pkgs.mkShell {
packages = with pkgs; [
gcc
+ glib.dev
+ pango
openssl
pkg-config
+ clang-tools
gnumake
- ];
+ ] ++ (if install_opt_deps then [
+ dbus
+ gtk3
+ libsoup_3
+ webkitgtk_4_1
+ librsvg
+ nodejs_22
+ pnpm
+ cargo
+ rustc
+ rustup
+ ] else []);
+ RUST_SRC_PATH = if install_opt_deps then "${pkgs.rust.packages.stable.rustPlatform.rustLibSrc}" else "";
+ shellHook = if install_opt_deps then ''
+ export LD_LIBRARY_PATH=${pkgs.lib.makeLibraryPath libraries}:$LD_LIBRARY_PATH
+ export XDG_DATA_DIRS=${pkgs.gsettings-desktop-schemas}/share/gsettings-schemas/${pkgs.gsettings-desktop-schemas.name}:${pkgs.gtk3}/share/gsettings-schemas/${pkgs.gtk3.name}:$XDG_DATA_DIRS
+ '' else '';
}
diff --git a/src/uci.c b/src/uci.c
new file mode 100644
index 0000000..3c45765
--- /dev/null
+++ b/src/uci.c
@@ -0,0 +1,55 @@
+#include <stdio.h>
+#include <stdbool.h>
+#include <stdlib.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <errno.h>
+#include "uci/command.h"
+#include "uci/response.h"
+
+void load_from_message(ucicmd* cmd, const char* message) {
+ char token[MAX_TOKEN_SIZE];
+ int i = 0, k = 0;
+
+ while (
+ message[i] != 0 &&
+ message[i] != '\n' &&
+ message[i] != '\r'
+ ) {
+ if (message[i] != ' ') {
+ token[k++] = message[i++];
+ continue;
+ }
+ if (k == 0) {
+ i++;
+ continue;
+ }
+ i++;
+ token[k] = 0;
+ ucicmd_add(cmd, token);
+ k = 0;
+ }
+ token[k] = 0;
+ ucicmd_add(cmd, token);
+}
+
+int main() {
+ // https://stackoverflow.com/a/41559081
+ fcntl(STDIN_FILENO, F_SETFL, O_NONBLOCK);
+
+ ucicmd cmd = ucicmd_init();
+ size_t n;
+ char buf[1024];
+ while (true) {
+ cmd.empty = true;
+ cmd.args_count = 0;
+ ssize_t n = read(STDIN_FILENO, buf, sizeof(buf));
+ if (n > 0) {
+ load_from_message(&cmd, buf);
+ }
+ handle_uci(cmd);
+ }
+}
+
+#include "uci/command.c"
+#include "uci/response.c"
diff --git a/src/uci/UCI-Protocol-Specification.txt b/src/uci/UCI-Protocol-Specification.txt
new file mode 100644
index 0000000..f28b730
--- /dev/null
+++ b/src/uci/UCI-Protocol-Specification.txt
@@ -0,0 +1,544 @@
+// Dowloaded from: http://download.shredderchess.com/div/uci.zip
+
+Description of the universal chess interface (UCI) April 2006
+=================================================================
+
+* The specification is independent of the operating system. For Windows,
+ the engine is a normal exe file, either a console or "real" windows application.
+
+* all communication is done via standard input and output with text commands,
+
+* The engine should boot and wait for input from the GUI,
+ the engine should wait for the "isready" or "setoption" command to set up its internal parameters
+ as the boot process should be as quick as possible.
+
+* the engine must always be able to process input from stdin, even while thinking.
+
+* all command strings the engine receives will end with '\n',
+ also all commands the GUI receives should end with '\n',
+ Note: '\n' can be 0x0d or 0x0a0d or any combination depending on your OS.
+ If you use Engine and GUI in the same OS this should be no problem if you communicate in text mode,
+ but be aware of this when for example running a Linux engine in a Windows GUI.
+
+* arbitrary white space between tokens is allowed
+ Example: "debug on\n" and " debug on \n" and "\t debug \t \t\ton\t \n"
+ all set the debug mode of the engine on.
+
+* The engine will always be in forced mode which means it should never start calculating
+ or pondering without receiving a "go" command first.
+
+* Before the engine is asked to search on a position, there will always be a position command
+ to tell the engine about the current position.
+
+* by default all the opening book handling is done by the GUI,
+ but there is an option for the engine to use its own book ("OwnBook" option, see below)
+
+* if the engine or the GUI receives an unknown command or token it should just ignore it and try to
+ parse the rest of the string in this line.
+ Examples: "joho debug on\n" should switch the debug mode on given that joho is not defined,
+ "debug joho on\n" will be undefined however.
+
+* if the engine receives a command which is not supposed to come, for example "stop" when the engine is
+ not calculating, it should also just ignore it.
+
+
+Move format:
+------------
+
+The move format is in long algebraic notation.
+A nullmove from the Engine to the GUI should be sent as 0000.
+Examples: e2e4, e7e5, e1g1 (white short castling), e7e8q (for promotion)
+
+
+
+GUI to engine:
+--------------
+
+These are all the command the engine gets from the interface.
+
+* uci
+ tell engine to use the uci (universal chess interface),
+ this will be sent once as a first command after program boot
+ to tell the engine to switch to uci mode.
+ After receiving the uci command the engine must identify itself with the "id" command
+ and send the "option" commands to tell the GUI which engine settings the engine supports if any.
+ After that the engine should send "uciok" to acknowledge the uci mode.
+ If no uciok is sent within a certain time period, the engine task will be killed by the GUI.
+
+* debug [ on | off ]
+ switch the debug mode of the engine on and off.
+ In debug mode the engine should send additional infos to the GUI, e.g. with the "info string" command,
+ to help debugging, e.g. the commands that the engine has received etc.
+ This mode should be switched off by default and this command can be sent
+ any time, also when the engine is thinking.
+
+* isready
+ this is used to synchronize the engine with the GUI. When the GUI has sent a command or
+ multiple commands that can take some time to complete,
+ this command can be used to wait for the engine to be ready again or
+ to ping the engine to find out if it is still alive.
+ E.g. this should be sent after setting the path to the tablebases as this can take some time.
+ This command is also required once before the engine is asked to do any search
+ to wait for the engine to finish initializing.
+ This command must always be answered with "readyok" and can be sent also when the engine is calculating
+ in which case the engine should also immediately answer with "readyok" without stopping the search.
+
+* setoption name <id> [value <x>]
+ this is sent to the engine when the user wants to change the internal parameters
+ of the engine. For the "button" type no value is needed.
+ One string will be sent for each parameter and this will only be sent when the engine is waiting.
+ The name and value of the option in <id> should not be case sensitive and can inlude spaces.
+ The substrings "value" and "name" should be avoided in <id> and <x> to allow unambiguous parsing,
+ for example do not use <name> = "draw value".
+ Here are some strings for the example below:
+ "setoption name Nullmove value true\n"
+ "setoption name Selectivity value 3\n"
+ "setoption name Style value Risky\n"
+ "setoption name Clear Hash\n"
+ "setoption name NalimovPath value c:\chess\tb\4;c:\chess\tb\5\n"
+
+* register
+ this is the command to try to register an engine or to tell the engine that registration
+ will be done later. This command should always be sent if the engine has sent "registration error"
+ at program startup.
+ The following tokens are allowed:
+ * later
+ the user doesn't want to register the engine now.
+ * name <x>
+ the engine should be registered with the name <x>
+ * code <y>
+ the engine should be registered with the code <y>
+ Example:
+ "register later"
+ "register name Stefan MK code 4359874324"
+
+* ucinewgame
+ this is sent to the engine when the next search (started with "position" and "go") will be from
+ a different game. This can be a new game the engine should play or a new game it should analyse but
+ also the next position from a testsuite with positions only.
+ If the GUI hasn't sent a "ucinewgame" before the first "position" command, the engine shouldn't
+ expect any further ucinewgame commands as the GUI is probably not supporting the ucinewgame command.
+ So the engine should not rely on this command even though all new GUIs should support it.
+ As the engine's reaction to "ucinewgame" can take some time the GUI should always send "isready"
+ after "ucinewgame" to wait for the engine to finish its operation.
+
+* position [fen <fenstring> | startpos ] moves <move1> .... <movei>
+ set up the position described in fenstring on the internal board and
+ play the moves on the internal chess board.
+ if the game was played from the start position the string "startpos" will be sent
+ Note: no "new" command is needed. However, if this position is from a different game than
+ the last position sent to the engine, the GUI should have sent a "ucinewgame" inbetween.
+
+* go
+ start calculating on the current position set up with the "position" command.
+ There are a number of commands that can follow this command, all will be sent in the same string.
+ If one command is not sent its value should be interpreted as it would not influence the search.
+ * searchmoves <move1> .... <movei>
+ restrict search to this moves only
+ Example: After "position startpos" and "go infinite searchmoves e2e4 d2d4"
+ the engine should only search the two moves e2e4 and d2d4 in the initial position.
+ * ponder
+ start searching in pondering mode.
+ Do not exit the search in ponder mode, even if it's mate!
+ This means that the last move sent in in the position string is the ponder move.
+ The engine can do what it wants to do, but after a "ponderhit" command
+ it should execute the suggested move to ponder on. This means that the ponder move sent by
+ the GUI can be interpreted as a recommendation about which move to ponder. However, if the
+ engine decides to ponder on a different move, it should not display any mainlines as they are
+ likely to be misinterpreted by the GUI because the GUI expects the engine to ponder
+ on the suggested move.
+ * wtime <x>
+ white has x msec left on the clock
+ * btime <x>
+ black has x msec left on the clock
+ * winc <x>
+ white increment per move in mseconds if x > 0
+ * binc <x>
+ black increment per move in mseconds if x > 0
+ * movestogo <x>
+ there are x moves to the next time control,
+ this will only be sent if x > 0,
+ if you don't get this and get the wtime and btime it's sudden death
+ * depth <x>
+ search x plies only.
+ * nodes <x>
+ search x nodes only,
+ * mate <x>
+ search for a mate in x moves
+ * movetime <x>
+ search exactly x mseconds
+ * infinite
+ search until the "stop" command. Do not exit the search without being told so in this mode!
+
+* stop
+ stop calculating as soon as possible,
+ don't forget the "bestmove" and possibly the "ponder" token when finishing the search
+
+* ponderhit
+ the user has played the expected move. This will be sent if the engine was told to ponder on the same move
+ the user has played. The engine should continue searching but switch from pondering to normal search.
+
+* quit
+ quit the program as soon as possible
+
+
+Engine to GUI:
+--------------
+
+* id
+ * name <x>
+ this must be sent after receiving the "uci" command to identify the engine,
+ e.g. "id name Shredder X.Y\n"
+ * author <x>
+ this must be sent after receiving the "uci" command to identify the engine,
+ e.g. "id author Stefan MK\n"
+
+* uciok
+ Must be sent after the id and optional options to tell the GUI that the engine
+ has sent all infos and is ready in uci mode.
+
+* readyok
+ This must be sent when the engine has received an "isready" command and has
+ processed all input and is ready to accept new commands now.
+ It is usually sent after a command that can take some time to be able to wait for the engine,
+ but it can be used anytime, even when the engine is searching,
+ and must always be answered with "isready".
+
+* bestmove <move1> [ ponder <move2> ]
+ the engine has stopped searching and found the move <move> best in this position.
+ the engine can send the move it likes to ponder on. The engine must not start pondering automatically.
+ this command must always be sent if the engine stops searching, also in pondering mode if there is a
+ "stop" command, so for every "go" command a "bestmove" command is needed!
+ Directly before that the engine should send a final "info" command with the final search information,
+ the the GUI has the complete statistics about the last search.
+
+* copyprotection
+ this is needed for copyprotected engines. After the uciok command the engine can tell the GUI,
+ that it will check the copy protection now. This is done by "copyprotection checking".
+ If the check is ok the engine should send "copyprotection ok", otherwise "copyprotection error".
+ If there is an error the engine should not function properly but should not quit alone.
+ If the engine reports "copyprotection error" the GUI should not use this engine
+ and display an error message instead!
+ The code in the engine can look like this
+ TellGUI("copyprotection checking\n");
+ // ... check the copy protection here ...
+ if(ok)
+ TellGUI("copyprotection ok\n");
+ else
+ TellGUI("copyprotection error\n");
+
+* registration
+ this is needed for engines that need a username and/or a code to function with all features.
+ Analog to the "copyprotection" command the engine can send "registration checking"
+ after the uciok command followed by either "registration ok" or "registration error".
+ Also after every attempt to register the engine it should answer with "registration checking"
+ and then either "registration ok" or "registration error".
+ In contrast to the "copyprotection" command, the GUI can use the engine after the engine has
+ reported an error, but should inform the user that the engine is not properly registered
+ and might not use all its features.
+ In addition the GUI should offer to open a dialog to
+ enable registration of the engine. To try to register an engine the GUI can send
+ the "register" command.
+ The GUI has to always answer with the "register" command if the engine sends "registration error"
+ at engine startup (this can also be done with "register later")
+ and tell the user somehow that the engine is not registered.
+ This way the engine knows that the GUI can deal with the registration procedure and the user
+ will be informed that the engine is not properly registered.
+
+* info
+ the engine wants to send information to the GUI. This should be done whenever one of the info has changed.
+ The engine can send only selected infos or multiple infos with one info command,
+ e.g. "info currmove e2e4 currmovenumber 1" or
+ "info depth 12 nodes 123456 nps 100000".
+ Also all infos belonging to the pv should be sent together
+ e.g. "info depth 2 score cp 214 time 1242 nodes 2124 nps 34928 pv e2e4 e7e5 g1f3"
+ I suggest to start sending "currmove", "currmovenumber", "currline" and "refutation" only after one second
+ to avoid too much traffic.
+ Additional info:
+ * depth <x>
+ search depth in plies
+ * seldepth <x>
+ selective search depth in plies,
+ if the engine sends seldepth there must also be a "depth" present in the same string.
+ * time <x>
+ the time searched in ms, this should be sent together with the pv.
+ * nodes <x>
+ x nodes searched, the engine should send this info regularly
+ * pv <move1> ... <movei>
+ the best line found
+ * multipv <num>
+ this for the multi pv mode.
+ for the best move/pv add "multipv 1" in the string when you send the pv.
+ in k-best mode always send all k variants in k strings together.
+ * score
+ * cp <x>
+ the score from the engine's point of view in centipawns.
+ * mate <y>
+ mate in y moves, not plies.
+ If the engine is getting mated use negative values for y.
+ * lowerbound
+ the score is just a lower bound.
+ * upperbound
+ the score is just an upper bound.
+ * currmove <move>
+ currently searching this move
+ * currmovenumber <x>
+ currently searching move number x, for the first move x should be 1 not 0.
+ * hashfull <x>
+ the hash is x permill full, the engine should send this info regularly
+ * nps <x>
+ x nodes per second searched, the engine should send this info regularly
+ * tbhits <x>
+ x positions where found in the endgame table bases
+ * sbhits <x>
+ x positions where found in the shredder endgame databases
+ * cpuload <x>
+ the cpu usage of the engine is x permill.
+ * string <str>
+ any string str which will be displayed be the engine,
+ if there is a string command the rest of the line will be interpreted as <str>.
+ * refutation <move1> <move2> ... <movei>
+ move <move1> is refuted by the line <move2> ... <movei>, i can be any number >= 1.
+ Example: after move d1h5 is searched, the engine can send
+ "info refutation d1h5 g6h5"
+ if g6h5 is the best answer after d1h5 or if g6h5 refutes the move d1h5.
+ if there is no refutation for d1h5 found, the engine should just send
+ "info refutation d1h5"
+ The engine should only send this if the option "UCI_ShowRefutations" is set to true.
+ * currline <cpunr> <move1> ... <movei>
+ this is the current line the engine is calculating. <cpunr> is the number of the cpu if
+ the engine is running on more than one cpu. <cpunr> = 1,2,3....
+ if the engine is just using one cpu, <cpunr> can be omitted.
+ If <cpunr> is greater than 1, always send all k lines in k strings together.
+ The engine should only send this if the option "UCI_ShowCurrLine" is set to true.
+
+
+* option
+ This command tells the GUI which parameters can be changed in the engine.
+ This should be sent once at engine startup after the "uci" and the "id" commands
+ if any parameter can be changed in the engine.
+ The GUI should parse this and build a dialog for the user to change the settings.
+ Note that not every option needs to appear in this dialog as some options like
+ "Ponder", "UCI_AnalyseMode", etc. are better handled elsewhere or are set automatically.
+ If the user wants to change some settings, the GUI will send a "setoption" command to the engine.
+ Note that the GUI need not send the setoption command when starting the engine for every option if
+ it doesn't want to change the default value.
+ For all allowed combinations see the examples below,
+ as some combinations of this tokens don't make sense.
+ One string will be sent for each parameter.
+ * name <id>
+ The option has the name id.
+ Certain options have a fixed value for <id>, which means that the semantics of this option is fixed.
+ Usually those options should not be displayed in the normal engine options window of the GUI but
+ get a special treatment. "Pondering" for example should be set automatically when pondering is
+ enabled or disabled in the GUI options. The same for "UCI_AnalyseMode" which should also be set
+ automatically by the GUI. All those certain options have the prefix "UCI_" except for the
+ first 6 options below. If the GUI gets an unknown Option with the prefix "UCI_", it should just
+ ignore it and not display it in the engine's options dialog.
+ * <id> = Hash, type is spin
+ the value in MB for memory for hash tables can be changed,
+ this should be answered with the first "setoptions" command at program boot
+ if the engine has sent the appropriate "option name Hash" command,
+ which should be supported by all engines!
+ So the engine should use a very small hash first as default.
+ * <id> = NalimovPath, type string
+ this is the path on the hard disk to the Nalimov compressed format.
+ Multiple directories can be concatenated with ";"
+ * <id> = NalimovCache, type spin
+ this is the size in MB for the cache for the nalimov table bases
+ These last two options should also be present in the initial options exchange dialog
+ when the engine is booted if the engine supports it
+ * <id> = Ponder, type check
+ this means that the engine is able to ponder.
+ The GUI will send this whenever pondering is possible or not.
+ Note: The engine should not start pondering on its own if this is enabled, this option is only
+ needed because the engine might change its time management algorithm when pondering is allowed.
+ * <id> = OwnBook, type check
+ this means that the engine has its own book which is accessed by the engine itself.
+ if this is set, the engine takes care of the opening book and the GUI will never
+ execute a move out of its book for the engine. If this is set to false by the GUI,
+ the engine should not access its own book.
+ * <id> = MultiPV, type spin
+ the engine supports multi best line or k-best mode. the default value is 1
+ * <id> = UCI_ShowCurrLine, type check, should be false by default,
+ the engine can show the current line it is calculating. see "info currline" above.
+ * <id> = UCI_ShowRefutations, type check, should be false by default,
+ the engine can show a move and its refutation in a line. see "info refutations" above.
+ * <id> = UCI_LimitStrength, type check, should be false by default,
+ The engine is able to limit its strength to a specific Elo number,
+ This should always be implemented together with "UCI_Elo".
+ * <id> = UCI_Elo, type spin
+ The engine can limit its strength in Elo within this interval.
+ If UCI_LimitStrength is set to false, this value should be ignored.
+ If UCI_LimitStrength is set to true, the engine should play with this specific strength.
+ This should always be implemented together with "UCI_LimitStrength".
+ * <id> = UCI_AnalyseMode, type check
+ The engine wants to behave differently when analysing or playing a game.
+ For example when playing it can use some kind of learning.
+ This is set to false if the engine is playing a game, otherwise it is true.
+ * <id> = UCI_Opponent, type string
+ With this command the GUI can send the name, title, elo and if the engine is playing a human
+ or computer to the engine.
+ The format of the string has to be [GM|IM|FM|WGM|WIM|none] [<elo>|none] [computer|human] <name>
+ Examples:
+ "setoption name UCI_Opponent value GM 2800 human Gary Kasparov"
+ "setoption name UCI_Opponent value none none computer Shredder"
+ * <id> = UCI_EngineAbout, type string
+ With this command, the engine tells the GUI information about itself, for example a license text,
+ usually it doesn't make sense that the GUI changes this text with the setoption command.
+ Example:
+ "option name UCI_EngineAbout type string default Shredder by Stefan Meyer-Kahlen, see www.shredderchess.com"
+ * <id> = UCI_ShredderbasesPath, type string
+ this is either the path to the folder on the hard disk containing the Shredder endgame databases or
+ the path and filename of one Shredder endgame datbase.
+ * <id> = UCI_SetPositionValue, type string
+ the GUI can send this to the engine to tell the engine to use a certain value in centipawns from white's
+ point of view if evaluating this specifix position.
+ The string can have the formats:
+ <value> + <fen> | clear + <fen> | clearall
+
+ * type <t>
+ The option has type t.
+ There are 5 different types of options the engine can send
+ * check
+ a checkbox that can either be true or false
+ * spin
+ a spin wheel that can be an integer in a certain range
+ * combo
+ a combo box that can have different predefined strings as a value
+ * button
+ a button that can be pressed to send a command to the engine
+ * string
+ a text field that has a string as a value,
+ an empty string has the value "<empty>"
+ * default <x>
+ the default value of this parameter is x
+ * min <x>
+ the minimum value of this parameter is x
+ * max <x>
+ the maximum value of this parameter is x
+ * var <x>
+ a predefined value of this parameter is x
+ Examples:
+ Here are 5 strings for each of the 5 possible types of options
+ "option name Nullmove type check default true\n"
+ "option name Selectivity type spin default 2 min 0 max 4\n"
+ "option name Style type combo default Normal var Solid var Normal var Risky\n"
+ "option name NalimovPath type string default c:\\n"
+ "option name Clear Hash type button\n"
+
+
+
+Examples:
+---------
+
+This is how the communication when the engine boots can look like:
+
+GUI engine
+
+// tell the engine to switch to UCI mode
+uci
+
+// engine identify
+ id name Shredder
+ id author Stefan MK
+
+// engine sends the options it can change
+// the engine can change the hash size from 1 to 128 MB
+ option name Hash type spin default 1 min 1 max 128
+
+// the engine supports Nalimov endgame tablebases
+ option name NalimovPath type string default <empty>
+ option name NalimovCache type spin default 1 min 1 max 32
+
+// the engine can switch off Nullmove and set the playing style
+ option name Nullmove type check default true
+ option name Style type combo default Normal var Solid var Normal var Risky
+
+// the engine has sent all parameters and is ready
+ uciok
+
+// Note: here the GUI can already send a "quit" command if it just wants to find out
+// details about the engine, so the engine should not initialize its internal
+// parameters before here.
+// now the GUI sets some values in the engine
+// set hash to 32 MB
+setoption name Hash value 32
+
+// init tbs
+setoption name NalimovCache value 1
+setoption name NalimovPath value d:\tb;c\tb
+
+// waiting for the engine to finish initializing
+// this command and the answer is required here!
+isready
+
+// engine has finished setting up the internal values
+ readyok
+
+// now we are ready to go
+
+// if the GUI is supporting it, tell the engine that is is
+// searching on a game that it hasn't searched on before
+ucinewgame
+
+// if the engine supports the "UCI_AnalyseMode" option and the next search is supposed to
+// be an analysis, the GUI should set "UCI_AnalyseMode" to true if it is currently
+// set to false with this engine
+setoption name UCI_AnalyseMode value true
+
+// tell the engine to search infinite from the start position after 1.e4 e5
+position startpos moves e2e4 e7e5
+go infinite
+
+// the engine starts sending infos about the search to the GUI
+// (only some examples are given)
+
+
+ info depth 1 seldepth 0
+ info score cp 13 depth 1 nodes 13 time 15 pv f1b5
+ info depth 2 seldepth 2
+ info nps 15937
+ info score cp 14 depth 2 nodes 255 time 15 pv f1c4 f8c5
+ info depth 2 seldepth 7 nodes 255
+ info depth 3 seldepth 7
+ info nps 26437
+ info score cp 20 depth 3 nodes 423 time 15 pv f1c4 g8f6 b1c3
+ info nps 41562
+ ....
+
+
+// here the user has seen enough and asks to stop the searching
+stop
+
+// the engine has finished searching and is sending the bestmove command
+// which is needed for every "go" command sent to tell the GUI
+// that the engine is ready again
+ bestmove g1f3 ponder d8f6
+
+
+
+Chess960
+========
+
+UCI could easily be extended to support Chess960 (also known as Fischer Random Chess).
+
+The engine has to tell the GUI that it is capable of playing Chess960 and the GUI has to tell
+the engine that is should play according to the Chess960 rules.
+This is done by the special engine option UCI_Chess960. If the engine knows about Chess960
+it should send the command 'option name UCI_Chess960 type check default false'
+to the GUI at program startup.
+Whenever a Chess960 game is played, the GUI should set this engine option to 'true'.
+
+Castling is different in Chess960 and the white king move when castling short is not always e1g1.
+A king move could both be the castling king move or just a normal king move.
+This is why castling moves are sent in the form king "takes" his own rook.
+Example: e1h1 for the white short castle move in the normal chess start position.
+
+In EPD and FEN position strings specifying the castle rights with w and q is not enough as
+there could be more than one rook on the right or left side of the king.
+This is why the castle rights are specified with the letter of the castle rook's line.
+Upper case letters for white's and lower case letters for black's castling rights.
+Example: The normal chess position would be:
+rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w AHah -
+
diff --git a/src/uci/command.c b/src/uci/command.c
new file mode 100644
index 0000000..d82c50c
--- /dev/null
+++ b/src/uci/command.c
@@ -0,0 +1,125 @@
+#include <assert.h>
+#include <stdlib.h>
+#include <string.h>
+#include "command.h"
+
+ucicmd ucicmd_init() {
+ ucicmd output = {0};
+
+ output.empty = true;
+ output.args_capacity = 32;
+ output.args = calloc(sizeof(char) * MAX_TOKEN_SIZE, output.args_capacity);
+
+ return output;
+}
+
+bool is_valid_cmd(const char *token) {
+ return
+ (strcmp(token, "uci") == 0) ||
+ (strcmp(token, "debug") == 0) ||
+ (strcmp(token, "isready") == 0) ||
+ (strcmp(token, "setoption") == 0) ||
+ (strcmp(token, "register") == 0) ||
+ (strcmp(token, "ucinewgame") == 0) ||
+ (strcmp(token, "position") == 0) ||
+ (strcmp(token, "go") == 0) ||
+ (strcmp(token, "stop") == 0) ||
+ (strcmp(token, "ponderhit") == 0) ||
+ (strcmp(token, "quit") == 0) ||
+
+ (strcmp(token, "id") == 0) ||
+ (strcmp(token, "uciok") == 0) ||
+ (strcmp(token, "readyok") == 0) ||
+ (strcmp(token, "bestmove") == 0) ||
+ (strcmp(token, "copyprotection") == 0) ||
+ (strcmp(token, "registration") == 0) ||
+ (strcmp(token, "info") == 0) ||
+ (strcmp(token, "option") == 0);
+}
+
+void ucicmd_add(ucicmd* cmd, const char* token) {
+ if (!cmd->empty) {
+ ucicmd_append_arg(cmd, token);
+ return;
+ }
+ if (is_valid_cmd(token) == 0) return;
+ ucicmd_set_root(cmd, token);
+}
+
+void ucicmd_set_root(ucicmd* cmd, const char* token) {
+ cmd->empty = false;
+ int i = 0;
+ for (; token[i] != 0; i++) {
+ assert(i < MAX_TOKEN_SIZE);
+ cmd->root[i] = token[i];
+ }
+ if (i < MAX_TOKEN_SIZE) cmd->root[i] = 0;
+}
+
+void ucicmd_append_arg(ucicmd* cmd, const char* token) {
+ if (cmd->args_count + 1 > cmd->args_capacity) {
+ cmd->args_capacity += 32;
+ // does realloc set all zeros, like calloc???
+ // NO: https://stackoverflow.com/questions/61237721/does-a-realloc-after-a-calloc-zero-out-bytes
+ cmd->args = realloc(
+ cmd->args,
+ sizeof(char) * MAX_TOKEN_SIZE * cmd->args_capacity
+ );
+ memset(
+ ucicmd_get_arg(*cmd, cmd->args_capacity - 32),
+ 0,
+ 32 * MAX_TOKEN_SIZE
+ );
+ }
+
+ int shift = cmd->args_count++ * sizeof(char) * MAX_TOKEN_SIZE;
+ int i = 0;
+ for (; token[i] != 0; i++) {
+ assert(i < MAX_TOKEN_SIZE);
+ cmd->args[shift + i] = token[i];
+ }
+ if (i < MAX_TOKEN_SIZE) cmd->args[shift + i] = 0;
+}
+
+char* ucicmd_get_arg(ucicmd cmd, int i) {
+ return cmd.args + i * MAX_TOKEN_SIZE;
+}
+
+void ucicmd_deinit(ucicmd cmd) {
+ free(cmd.args);
+}
+
+
+#ifdef TEST_MOD
+#include <stdbool.h>
+#include <string.h>
+
+bool test_ucicmd() {
+ ucicmd cmd = ucicmd_init();
+ ucicmd_set_root(&cmd, "root");
+ ucicmd_append_arg(&cmd, "arg1");
+ ucicmd_append_arg(&cmd, "arg2");
+ ucicmd_append_arg(&cmd, "arg3");
+
+ if (strncmp(cmd.root, "root", MAX_TOKEN_SIZE) != 0) return false;
+ if (strncmp(ucicmd_get_arg(cmd, 0), "arg1", MAX_TOKEN_SIZE) != 0)
+ return false;
+ if (strncmp(ucicmd_get_arg(cmd, 1), "arg2", MAX_TOKEN_SIZE) != 0)
+ return false;
+ if (strncmp(ucicmd_get_arg(cmd, 2), "arg3", MAX_TOKEN_SIZE) != 0)
+ return false;
+ return true;
+}
+
+bool test_invalid_cmd_ucicmd() {
+ ucicmd cmd = ucicmd_init();
+ ucicmd_add(&cmd, "john");
+ ucicmd_add(&cmd, "debug");
+ ucicmd_add(&cmd, "on");
+
+ if (strncmp(cmd.root, "debug", MAX_TOKEN_SIZE) != 0) return false;
+ if (strncmp(ucicmd_get_arg(cmd, 0), "on", MAX_TOKEN_SIZE) != 0)
+ return false;
+ return true;
+}
+#endif
diff --git a/src/uci/command.h b/src/uci/command.h
new file mode 100644
index 0000000..ba9c51d
--- /dev/null
+++ b/src/uci/command.h
@@ -0,0 +1,21 @@
+#ifndef UCI_COMMAND_H
+#define UCI_COMMAND_H
+
+#define MAX_TOKEN_SIZE 32
+
+typedef struct {
+ char root[MAX_TOKEN_SIZE];
+ int args_count;
+ int args_capacity;
+ char* args;
+ bool empty;
+} ucicmd;
+
+ucicmd ucicmd_init();
+void ucicmd_add(ucicmd* cmd, const char* token);
+void ucicmd_set_root(ucicmd* cmd, const char* token);
+void ucicmd_append_arg(ucicmd* cmd, const char* token);
+char* ucicmd_get_arg(ucicmd cmd, int i);
+void ucicmd_deinit(ucicmd cmd);
+
+#endif // UCI_COMMAND_H
diff --git a/src/uci/draft-1.pdf b/src/uci/draft-1.pdf
new file mode 100644
index 0000000..9c68adb
--- /dev/null
+++ b/src/uci/draft-1.pdf
Binary files differ
diff --git a/src/uci/draft-2.pdf b/src/uci/draft-2.pdf
new file mode 100644
index 0000000..d0d4707
--- /dev/null
+++ b/src/uci/draft-2.pdf
Binary files differ
diff --git a/src/uci/response.c b/src/uci/response.c
new file mode 100644
index 0000000..b27bf76
--- /dev/null
+++ b/src/uci/response.c
@@ -0,0 +1,103 @@
+#include <string.h>
+#include <assert.h>
+#include "response.h"
+
+enum {
+ STATE_INITIAL,
+ STATE_IDLE,
+ STATE_SYNC,
+ STATE_PING,
+ STATE_ACTIVE,
+ STATE_HALT,
+};
+int current_state = STATE_INITIAL;
+int debug = false;
+
+void todo() {
+ assert(0);
+}
+
+void handle_uci(ucicmd cmd) {
+ if (current_state == STATE_INITIAL) {
+ return handle_initial(cmd);
+ }
+ if (current_state == STATE_IDLE) {
+ return handle_idle(cmd);
+ }
+ if (current_state == STATE_SYNC) {
+ return handle_sync(cmd);
+ }
+ if (current_state == STATE_PING) {
+ return handle_ping(cmd);
+ }
+ if (current_state == STATE_ACTIVE) {
+ return handle_active(cmd);
+ }
+ return handle_halt(cmd);
+}
+
+void handle_initial(ucicmd cmd) {
+ if (cmd.empty || strcmp(cmd.root, "uci") != 0) return;
+ printf("uciok\n");
+ current_state = STATE_IDLE;
+}
+
+void handle_idle(ucicmd cmd) {
+ if (cmd.empty) return;
+ if (strcmp(cmd.root, "debug") == 0) {
+ debug = strcmp(ucicmd_get_arg(cmd, 0), "on") == 0;
+ } else if (strcmp(cmd.root, "setoption") == 0) {
+ } else if (strcmp(cmd.root, "ucinewgame") == 0) {
+ } else if (strcmp(cmd.root, "position") == 0) {
+ } else if (strcmp(cmd.root, "stop") == 0) {
+ } else if (strcmp(cmd.root, "quit") == 0) {
+ free(cmd.args);
+ exit(0);
+ } else if (strcmp(cmd.root, "isready") == 0) {
+ current_state = STATE_SYNC;
+ } else if (strcmp(cmd.root, "go") == 0) {
+ current_state = STATE_ACTIVE;
+ } else {
+ printf("Invalid command: %s\n", cmd.root);
+ }
+}
+
+void handle_sync(ucicmd cmd) {
+ // when i come up with some info to give:
+ // printf("info\n");
+ printf("readyok\n");
+ current_state = STATE_IDLE;
+}
+
+void handle_ping(ucicmd cmd) {
+ // when i come up with some info to give:
+ // printf("info\n");
+ //
+ // if (TODO) {
+ // printf("bestmove\n");
+ // current_state = STATE_IDLE;
+ // }
+ printf("readyok\n");
+ current_state = STATE_ACTIVE;
+}
+
+void handle_active(ucicmd cmd) {
+ if (cmd.empty) {
+ return;
+ }
+ // TODO: this section will call the engine to analysis
+ if (strcmp(cmd.root, "isready") == 0) {
+ current_state = STATE_PING;
+ } else if (strcmp(cmd.root, "stop") == 0) {
+ current_state = STATE_HALT;
+ } else {
+ printf("Invalid command: %s\n", cmd.root);
+ }
+}
+
+void handle_halt(ucicmd cmd) {
+ // when i come up with some info to give:
+ // printf("info\n");
+ printf("bestmove 0000\n"); // TODO: idk get it rn
+ current_state = STATE_IDLE;
+}
diff --git a/src/uci/response.h b/src/uci/response.h
new file mode 100644
index 0000000..09a0124
--- /dev/null
+++ b/src/uci/response.h
@@ -0,0 +1,9 @@
+#include "command.h"
+
+void handle_uci(ucicmd cmd);
+void handle_initial(ucicmd cmd);
+void handle_idle(ucicmd cmd);
+void handle_sync(ucicmd cmd);
+void handle_ping(ucicmd cmd);
+void handle_active(ucicmd cmd);
+void handle_halt(ucicmd cmd);
diff --git a/src/uci/uci_min.txt b/src/uci/uci_min.txt
new file mode 100644
index 0000000..58a85b6
--- /dev/null
+++ b/src/uci/uci_min.txt
@@ -0,0 +1,140 @@
+GUI to engine:
+* uci
+* debug [ on | off ]
+* isready
+* setoption name <id> [value <x>]
+ Here are some strings for the example below:
+ "setoption name Nullmove value true\n"
+ "setoption name Selectivity value 3\n"
+ "setoption name Style value Risky\n"
+ "setoption name Clear Hash\n"
+ "setoption name NalimovPath value c:\chess\tb\4;c:\chess\tb\5\n"
+
+* register
+ The following tokens are allowed:
+ * later
+ the user doesn't want to register the engine now.
+ * name <x>
+ the engine should be registered with the name <x>
+ * code <y>
+ the engine should be registered with the code <y>
+ Example:
+ "register later"
+ "register name Stefan MK code 4359874324"
+
+* ucinewgame
+* position [fen <fenstring> | startpos ] moves <move1> .... <movei>
+* go
+ * searchmoves <move1> .... <movei>
+ Example: After "position startpos" and "go infinite searchmoves e2e4 d2d4"
+ the engine should only search the two moves e2e4 and d2d4 in the initial position.
+ * ponder
+ * wtime <x>
+ * btime <x>
+ * winc <x>
+ * binc <x>
+ * movestogo <x>
+ * depth <x>
+ * nodes <x>
+ * mate <x>
+ * movetime <x>
+ * infinite
+* stop
+* ponderhit
+* quit
+
+
+Engine to GUI:
+* id
+ * name <x>
+ e.g. "id name Shredder X.Y\n"
+ * author <x>
+ e.g. "id author Stefan MK\n"
+* uciok
+* readyok
+* bestmove <move1> [ ponder <move2> ]
+* copyprotection
+* registration
+* info
+ e.g. "info currmove e2e4 currmovenumber 1" or
+ "info depth 12 nodes 123456 nps 100000".
+ e.g. "info depth 2 score cp 214 time 1242 nodes 2124 nps 34928 pv e2e4 e7e5 g1f3"
+ Additional info:
+ * depth <x>
+ * seldepth <x>
+ * time <x>
+ * nodes <x>
+ * pv <move1> ... <movei>
+ * multipv <num>
+ * score
+ * cp <x>
+ * mate <y>
+ * lowerbound
+ * upperbound
+ * currmove <move>
+ * currmovenumber <x>
+ * hashfull <x>
+ * nps <x>
+ * tbhits <x>
+ * sbhits <x>
+ * cpuload <x>
+ * string <str>
+ * refutation <move1> <move2> ... <movei>
+ Example: after move d1h5 is searched, the engine can send
+ "info refutation d1h5 g6h5"
+ if g6h5 is the best answer after d1h5 or if g6h5 refutes the move d1h5.
+ if there is no refutation for d1h5 found, the engine should just send
+ "info refutation d1h5"
+ * currline <cpunr> <move1> ... <movei>
+
+
+* option
+ * name <id>
+ * <id> = Hash, type is spin
+ * <id> = NalimovPath, type string
+ * <id> = NalimovCache, type spin
+ * <id> = Ponder, type check
+ * <id> = OwnBook, type check
+ * <id> = MultiPV, type spin
+ * <id> = UCI_ShowCurrLine, type check, should be false by default,
+ * <id> = UCI_ShowRefutations, type check, should be false by default,
+ * <id> = UCI_LimitStrength, type check, should be false by default,
+ * <id> = UCI_Elo, type spin
+ * <id> = UCI_AnalyseMode, type check
+ * <id> = UCI_Opponent, type string
+ Examples:
+ "setoption name UCI_Opponent value GM 2800 human Gary Kasparov"
+ "setoption name UCI_Opponent value none none computer Shredder"
+ * <id> = UCI_EngineAbout, type string
+ Example:
+ "option name UCI_EngineAbout type string default Shredder by Stefan Meyer-Kahlen, see www.shredderchess.com"
+ * <id> = UCI_ShredderbasesPath, type string
+ * <id> = UCI_SetPositionValue, type string
+
+ * type <t>
+ * check
+ a checkbox that can either be true or false
+ * spin
+ a spin wheel that can be an integer in a certain range
+ * combo
+ a combo box that can have different predefined strings as a value
+ * button
+ a button that can be pressed to send a command to the engine
+ * string
+ a text field that has a string as a value,
+ an empty string has the value "<empty>"
+ * default <x>
+ the default value of this parameter is x
+ * min <x>
+ the minimum value of this parameter is x
+ * max <x>
+ the maximum value of this parameter is x
+ * var <x>
+ a predefined value of this parameter is x
+ Examples:
+ Here are 5 strings for each of the 5 possible types of options
+ "option name Nullmove type check default true\n"
+ "option name Selectivity type spin default 2 min 0 max 4\n"
+ "option name Style type combo default Normal var Solid var Normal var Risky\n"
+ "option name NalimovPath type string default c:\\n"
+ "option name Clear Hash type button\n"