diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e62ec04 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4fefd0b --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# tic_tac_toe_bot + A tic tac toe bot made using a neural network from scratch diff --git a/badCursesDebugger.py b/badCursesDebugger.py new file mode 100644 index 0000000..a481bba --- /dev/null +++ b/badCursesDebugger.py @@ -0,0 +1,14 @@ +'A module for printing outputs after a curses program has ended' +to_print = [] + +def buffer(*args): + 'adds the provided arguments to be printed later' + to_print.append(args) + +def output(): + 'prints everything that was to be printed later' + for i in to_print: + if type(i) == tuple: + print(*i) + else: + print(i) \ No newline at end of file diff --git a/boardDrawer.py b/boardDrawer.py new file mode 100644 index 0000000..964fb2b --- /dev/null +++ b/boardDrawer.py @@ -0,0 +1,24 @@ +upright = "|" +sideways = "_" +empty = " " + +def drawBoard(**kwargs): + square_length = kwargs.pop("square_length", 5) + square_height = kwargs.pop("square_height", 3) + board_length = kwargs.pop("board_length", 5) + board = [] + true_board_height = board_length*square_height + true_board_length = board_length*square_length+(board_length-1) + #print(true_board_height, true_board_length) + for rowNo in range(true_board_height): + row = [empty] * true_board_length + if (rowNo+1) % square_height == 0 and rowNo != true_board_height-1: + row = [sideways] * true_board_length + for line in range(board_length-1): + row[((line+1)*square_length)+line] = upright + board.append("".join(row)) + return board + +if __name__ == "__main__": + for i in drawBoard(): + print(i) \ No newline at end of file diff --git a/fileOne.pkl b/fileOne.pkl new file mode 100644 index 0000000..4bf19f8 Binary files /dev/null and b/fileOne.pkl differ diff --git a/fileTwo.pkl b/fileTwo.pkl new file mode 100644 index 0000000..1721f03 Binary files /dev/null and b/fileTwo.pkl differ diff --git a/game.py b/game.py new file mode 100644 index 0000000..f9df451 --- /dev/null +++ b/game.py @@ -0,0 +1,253 @@ +'contains the Game class' +import curses +import math +import time + +from badCursesDebugger import buffer +from boardDrawer import drawBoard +from nnTrainer import Trainer + +char_map = { + True: "X", + False: "0" +} + +render_map = { + True: 1, + False: 2 +} + +game_movecursor_map = { + "KEY_UP": [-1, 0], + "KEY_DOWN": [1, 0], + "KEY_LEFT": [0, -1], + "KEY_RIGHT": [0, 1], + "w": [-1, 0], + "s": [1, 0], + "a": [0, -1], + "d": [0, 1] +} + +def board_val_to_char(num): + 'returns the assigned character of a board value e.g. 1 -> X, 2 -> 0' + return char_map[{render_map[k]:k for k in render_map}[num]] + +SQUARE_LENGTH = 9 +SQUARE_HEIGHT = 5 +CURSOR_OFFSET = 2 +WIN_POS = [5, 0] +WIN_WAIT = 1 + +class Game: + 'the class for the tic tac toe game' + def __init__(self, options, stdscr=None): + self.ai = None + self.length = options["board length"] + if options["ai"]: + self.generate_trainer(options, self.length, stdscr) + self.training = True + else: + self.training = False + if stdscr is not None: + self.stdscr = stdscr + stdscr.clear() + stdscr.refresh() + self.running = False + self.won = None + if self.length > 4: + self.match_length = math.ceil(self.length*0.75) + else: + self.match_length = 3 + self.true_length = self.length*SQUARE_LENGTH+self.length + self.board = [[0 for i in range(self.length)] \ + for j in range(self.length)] + self.win = None + self.rendered_board = drawBoard( + board_length=self.length, + square_length=SQUARE_LENGTH, + square_height=SQUARE_HEIGHT + ) + self.original_rendered_board = self.rendered_board.copy() + self.turn = options["start first"] + self.past_game_pos = None + self.cursor_pos = [0, 0] + + def generate_trainer(self, options, length, stdscr): + 'generates player for ai' + self.ai_file_name = options["ai file"] + self.ai = Trainer( + { + "board_length": length, + "select file1": self.ai_file_name, + "select file2": "", + "show training": True, + "start first": options["start first"], + "slowAmt": 0, + "new": False, + "rounds": 1 + }, + stdscr, + self + ) + + def update_rendered_board(self): + 'updates the rendered board' + for row_no, row in enumerate(self.board): + for index in range(len(self.board[row_no])): + box = row[index] + if box != 0: + box = board_val_to_char(box) + true_pos_y = math.ceil(SQUARE_HEIGHT/2) \ + + (row_no-1) \ + * SQUARE_HEIGHT \ + + SQUARE_HEIGHT-1 + true_pos_x = math.ceil(SQUARE_LENGTH/2) + ((index) * SQUARE_LENGTH) + index-1 + chars = list(self.rendered_board[true_pos_y]) + chars[true_pos_x] = box + self.rendered_board[true_pos_y] = "".join(chars) + + def render_board(self): + 'renders the board' + for i,string in enumerate(self.rendered_board): + self.win.addstr(i,0,string) + self.win.box() + self.win.refresh() + + def render_cursor(self): + 'renders the cursor' + cursor = curses.newwin(3, 5, ( + self.cursor_pos[0] + * (SQUARE_HEIGHT)) + + round(CURSOR_OFFSET/2) + + WIN_POS[0], + (self.cursor_pos[1] + * (SQUARE_LENGTH+1) + ) + CURSOR_OFFSET+WIN_POS[1]) + + cursor.box() + if self.get_cursor_selected_val() != 0: + cursor.move(1,2) + + cursor.addch(board_val_to_char(self.get_cursor_selected_val())) + cursor.refresh() + + def render(self): + 'combines all the render methods and renders some additional text' + self.win = curses.newwin( + self.length*SQUARE_HEIGHT, + self.true_length, + WIN_POS[0], + WIN_POS[1] + ) + self.update_rendered_board() + self.render_board() + self.render_cursor() + self.stdscr.move(WIN_POS[0]-1, round(WIN_POS[1]+self.true_length/3)) + self.stdscr.addstr(char_map[self.turn]+"'s turn") + self.stdscr.move(WIN_POS[0]-2, round(WIN_POS[1]+self.true_length/3)) + self.stdscr.addstr("match "+str(self.match_length)+" in a row to win") + self.stdscr.move(WIN_POS[0]-3, round(WIN_POS[1]+self.true_length/3)) + self.stdscr.addstr(str(self.length)+"x"+str(self.length)+" grid") + + def get_cursor_selected_val(self): + 'returns the value at the selected position' + return self.board[self.cursor_pos[0]][self.cursor_pos[1]] + + def move_cursor(self, directions): + 'changes cursor_pos according to the direction' + if (0 <= self.cursor_pos[0] + directions[0] <= self.length-1) \ + and (0 <= self.cursor_pos[1] + directions[1] <= self.length-1): + self.cursor_pos[0] += directions[0] + self.cursor_pos[1] += directions[1] + + def has_draw(self): + 'checks if the game has drawn' + draw = False + for row in self.board: + draw = row.count(0) == 0 + if draw is False: + break + return draw + + def haswon(self): + 'checks if the game has ended and its outcome' + current_turn = not self.turn + if self.has_draw(): + self.won = 3 + return + for row_no in range(self.length): + check_list = [ + self.board[row_no], # horizontally + [self.board[x][row_no] for x in range(self.length)], # vertically + [self.board[x][x] for x in range(self.length)], # diagonally downwards + [self.board[x][self.length-x-1] for x in range(self.length)] # diagonally upwards + ] + for compre in check_list: + if compre.count(render_map[current_turn]) == self.match_length: + self.won = current_turn + return + + def terminate(self, immediate=False): + 'terminates the game object' + self.stdscr.move(round(self.true_length/3), round(self.true_length/3)) + if self.won != 3: + self.stdscr.addstr(char_map[self.won]+" has won!") + else: + self.stdscr.addstr("Draw!") + self.stdscr.refresh() + if not immediate: + time.sleep(WIN_WAIT) + self.running = False + + def reset(self): + 'resets the board and everything for playing again' + if self.ai: + self.ai.save() + self.terminate() + return + self.board = [[0 for i in range(self.length)] for j in range(self.length)] + self.turn = True + self.cursor_pos = [0, 0] + self.won = None + self.rendered_board = self.original_rendered_board.copy() + + def place(self): + 'attempts to place x or 0 according to the cursor_pos' + if self.get_cursor_selected_val() == 0: + self.board[self.cursor_pos[0]][self.cursor_pos[1]] = render_map[self.turn] + self.turn = not self.turn + self.haswon() + if not self.training: + self.render() + if (self.won is not None) and (not self.training): + self.terminate() + return True + return False + + def process_input(self): + 'receives input and makes the game respond accordingly' + INPUT = self.stdscr.getkey() + if INPUT in game_movecursor_map: + directions = game_movecursor_map[INPUT] + self.move_cursor(directions) + elif INPUT in (" ", "\n"): + self.place() + elif INPUT == "q": + self.won = not self.turn + self.terminate(True) + + def run(self): + 'runs the game' + self.running = True + if self.ai is not None: + self.past_game_pos = [] + while self.running: + self.render() + if not self.turn: + self.ai.network_play(self.ai.network1, self, self.past_game_pos, 500) + else: + self.process_input() + else: + while self.running: + self.render() + self.process_input() diff --git a/main.py b/main.py new file mode 100644 index 0000000..9ed7df9 --- /dev/null +++ b/main.py @@ -0,0 +1,55 @@ +import curses + +from game import Game +from nnTrainer import Trainer +from program import Program +from badCursesDebugger import output + +def better_wrapper(func): + """wraps curses""" + try: + stdscr = curses.initscr() + curses.filter() + curses.noecho() + curses.cbreak() + #curses.curs_set(False) + stdscr.keypad(True) + stdscr.clear() + return func(stdscr) + finally: + curses.nocbreak() + stdscr.keypad(False) + curses.echo() + curses.curs_set(True) + curses.endwin() + output() + +def main(stdscr): + 'main' + Program(stdscr, "tic tac toe", { + "game": { + "options": { + "board length": 3, + "ai": True, + "ai file": "fileOne", + "start first": True + }, + "program_class": Game + }, + "AI training": { + "options": { + "board_length": 3, + "select file1": "fileOne", + "select file2": "fileTwo", + "show training": True, + "slowAmt": 0, + "new": True, + "rounds": 10, + "start first": True + }, + "program_class": Trainer + } + }).run() + +if __name__ == "__main__": + better_wrapper(main) diff --git a/nn.py b/nn.py new file mode 100644 index 0000000..adfe318 --- /dev/null +++ b/nn.py @@ -0,0 +1,107 @@ +'neural network' +import warnings +import numpy as np + +warnings.filterwarnings('ignore') + +BOARD_LENGTH = 3 + +INPUT_LAYER_AMT = BOARD_LENGTH ** 2 +HIDDEN_LAYER_AMT = INPUT_LAYER_AMT + BOARD_LENGTH +OUTPUT_LAYER_AMT = INPUT_LAYER_AMT +EPOCHS = 100 +LEARNING_RATE = 1 + +def sigmoid(z): + 'returns sigmoid of z' + return 1/(1+np.exp(-z)) + +def deriv_sigmoid(z): + 'returns the derivative of the sigmoid of z' + return sigmoid(z)*(1-sigmoid(z)) + +def rand(shape): + 'returns a numpy array of values -1 to 1 with the given shape' + return np.random.uniform(-1, 1, shape) + +def gradient_descent(layer, prev_layer, y=None, cost=None, learning_rate=1): # i give up + 'performs gradient descent on the layer' + if cost is None: + cost = layer.input-y + dy_yhat = cost + dz_y = deriv_sigmoid(layer.input) + dw_z = prev_layer.input.T + dw_yhat = dy_yhat * dz_y * dw_z + da_yhat = dy_yhat * dz_y * layer.array.sum(axis=1)[:, np.newaxis] + da_yhat = da_yhat.sum(axis=1)[:, np.newaxis].T + layer.array -= (dw_yhat*learning_rate) + db_yhat = dy_yhat * dz_y + layer.biases -= (db_yhat.T*learning_rate) + return da_yhat + +class NetworkLayer: + 'layer for NeuralNetwork class' + def __init__(self, nparray=None, biases=None): + self.array = nparray + self.input = None + self.biases = biases + + def __len__(self): + return len(self.array) + +class NeuralNetwork: + 'makes a neural network' + def __init__(self, hidden_layers, output_layer, board_length): + self.input_layer = NetworkLayer(np.array(0)) + self.hidden_layers = [NetworkLayer(hidden[0], hidden[1]) for hidden in hidden_layers] + self.output_layer = NetworkLayer(output_layer[0], output_layer[1]) + self.layers = [self.input_layer] + self.value = None + self.board_length = board_length + for hidden_layer in self.hidden_layers: + self.layers.append(hidden_layer) + self.layers.append(self.output_layer) + + def output(self): + 'outputs the network weights' + for a in self.layers: + print(a.array) + + def forward_prop(self, x) -> np.ndarray: + 'Forward propagates the network' + mult1 = x[:, np.newaxis].T + mult2 = self.hidden_layers[0].array + self.input_layer.input = mult1 + for index, network_layer in enumerate(self.layers[1:]): + dot = mult2 * mult1.T + add_bias = dot.T.sum(axis=1) + network_layer.biases.T + mult1 = sigmoid(add_bias) + network_layer.input = mult1 + if index == len(self.layers)-2: + break + mult2 = self.layers[index+2].array + return mult1 + + def back_prop(self, y, learning_rate, da_yhat=None): + 'Back propagates the network' + if da_yhat is None: + da_yhat = gradient_descent( + self.output_layer, + self.hidden_layers[-1], + y, + learning_rate=learning_rate + ) + for index, layer in reversed(list(enumerate(self.layers[1:-1]))): + index += 1 + da_yhat = gradient_descent( + layer, + self.layers[index-1], + None, + da_yhat, + learning_rate=learning_rate + ) + + def clear_input(self): + 'clears the input from all the layers' + for layer in self.layers: + layer.input = None diff --git a/nnTrainer.py b/nnTrainer.py new file mode 100644 index 0000000..2608bac --- /dev/null +++ b/nnTrainer.py @@ -0,0 +1,167 @@ +'Trainer class to train neural network to play tic tac toe' +import math +import random +import time +import pickle as pk +import numpy as np + +from nn import HIDDEN_LAYER_AMT, INPUT_LAYER_AMT, LEARNING_RATE, OUTPUT_LAYER_AMT, rand +from nn import NeuralNetwork + +from badCursesDebugger import buffer + +def relish(file_name, obj): + 'pickles the python object into the provided file' + if file_name is None: + return False + with open(file_name, "wb") as f: + pk.dump(obj, f) + return True + +def unrelish(file_name): + 'loads the python object from a pickle file' + if file_name is None: + return False + with open(file_name, "rb") as f: + return pk.load(f) + +def rand_weights_n_biases(): + 'returns random weights and biases for the neural network' + return [[rand((INPUT_LAYER_AMT, HIDDEN_LAYER_AMT)), rand((HIDDEN_LAYER_AMT, 1))], \ + [rand((HIDDEN_LAYER_AMT, HIDDEN_LAYER_AMT)), rand((HIDDEN_LAYER_AMT, 1))]], \ + [rand((HIDDEN_LAYER_AMT, OUTPUT_LAYER_AMT)), rand((OUTPUT_LAYER_AMT, 1))] + +class Trainer: + 'Trainer class for neural network to play tic tac toe' + def __init__(self, options, stdscr, game): + self.file1 = options["select file1"]+".pkl" + self.file2 = options["select file2"]+".pkl" + self.original_file2 = options["select file2"] + self.game = game + + if stdscr is not None: + self.stdscr = stdscr + self.show_training = options["show training"] + self.slow_amt = options["slowAmt"] + self.new = options["new"] + self.board_length = options["board_length"] + self.rounds = options["rounds"] + + self.training = False + + if self.new: + self.network1 = NeuralNetwork(*rand_weights_n_biases(), self.board_length) + self.network2 = NeuralNetwork(*rand_weights_n_biases(), self.board_length) + self.network1.value = options["start first"] + self.network2.value = not self.network1.value + else: + self.network1 = unrelish(self.file1) + self.network1.value = options["start first"] # determines which network is which + if self.original_file2 != "": + self.network2 = unrelish(self.file2) + self.network2.value = not self.network1.value + + def __del__(self): + self.save() + + def save(self): + 'saves the neural networks into their pickle files' + buffer("saving...") + relish(self.file1, self.network1) + if self.original_file2 != "": + relish(self.file2, self.network2) + + def learn(self, network, past_game_pos, y): + 'makes the network learn through back propagation' + learning_rate = LEARNING_RATE + change = [{"array": layer.array, "biases": layer.biases} for layer in network.layers] + for layers in past_game_pos[::-1]: + learning_rate *= 0.6 + network.input_layer.input = layers[0]["input"].copy() + for index, layer in enumerate(layers[1::]): + index += 1 + network.layers[index].array = layer["array"].copy() + network.layers[index].input = layer["input"].copy() + network.layers[index].biases = layer["biases"].copy() + network.back_prop(y, learning_rate) + for index, layer in enumerate(network.layers[1::]): + index += 1 + change[index]["array"] += (layer.array - layers[index]["array"]) + change[index]["biases"] += (layer.biases - layers[index]["biases"]) + for index, lay in enumerate(change[1::]): + index += 1 + network.layers[index].array -= lay["array"] / len(past_game_pos) + network.layers[index].biases -= lay["biases"] / len(past_game_pos) + + def check(self, game, network, past_game_pos, selected, prev_past_game_pos_len, exists): + 'dishes out "rewards" or "punishments" to the neural network according to how well it performed' + y = np.ones(self.board_length**2) + y[selected] = 0 + + if self.show_training: + game.render() + game.stdscr.refresh() + + if exists: + layers = [] + for layer in network.layers: + layers.append( + { + "array": layer.array, + "input": layer.input, + "biases": layer.biases + } + ) + past_game_pos.append(layers) + else: + new_output = network.output_layer.input.copy() + new_output[0][selected] = 0 + network.back_prop(new_output, LEARNING_RATE) + if game.won is not None: + self.rounds -= 1 + if len(past_game_pos) > prev_past_game_pos_len: + self.learn(network, past_game_pos, y) + if game.won in (network.value, 3): + y = np.zeros(self.board_length**2) + y[selected] = 1 + self.learn(network, past_game_pos, y) + game.reset() + elif game.won == (not network.value): + self.learn(network, past_game_pos, y) + game.reset() + + def network_play(self, network, game, past_game_pos, prev_past_game_pos_len): + 'lets the network select which tile to place and makes it learn from its mistakes' + output = network.forward_prop(np.array(game.board).reshape(self.board_length**2))[0] + output = np.nan_to_num(output) + selected = np.where(output == np.amax(output))[0] + game.ai_last_place = selected + if len(selected) > 1: + rand_index = random.randrange(0, len(selected)) + selected = selected[rand_index] + else: + selected = selected[0] + selected = selected.tolist() + game.cursor_pos = [math.floor(selected / game.length), selected % game.length] + self.check(game, network, past_game_pos, selected, prev_past_game_pos_len, game.place()) + + time.sleep(self.slow_amt / 10) + + def run(self): + 'runs the network Trainer' + if (self.network1.board_length != self.board_length) or (self.network2.board_length != self.board_length): + return "Board length does not match the file provided" # error message + self.training = True + self.game.training = True + past_game_pos1 = [] + past_game_pos2 = [] + prev_past_game_pos1_len = 0 + prev_past_game_pos2_len = 0 + start = time.time() + while self.rounds > 0: + self.network_play(self.network1, self.game, past_game_pos1, prev_past_game_pos1_len) + self.network_play(self.network2, self.game, past_game_pos2, prev_past_game_pos2_len) + end = time.time() + buffer("elapsed time:", end - start) + self.save() + return True diff --git a/program.py b/program.py new file mode 100644 index 0000000..88576e6 --- /dev/null +++ b/program.py @@ -0,0 +1,138 @@ +'program class for terminal ui, used to adjust settings and use different programs' +import curses +from badCursesDebugger import buffer + +def space(self): + 'selects object below cursor' + if self.options is None: + program_name = list(self.programs.keys())[self.cursor] + self.options = self.programs[program_name]["options"] + self.selected_program = program_name + self.cursor = 0 + +def down(self): + 'moves the cursor down' + if self.options is not None: + if self.cursor+1 < len(self.options.items()): + self.cursor += 1 + return + if self.cursor+1 < len(self.programs.items()): + self.cursor += 1 + +def up(self): + 'moves the cursor up' + if self.cursor-1 >= 0: + self.cursor -= 1 + +def out(self): + 'exits the scope' + if self.options: + self.options = None + self.selected_program = None + return + self.running = False + +def enter(self): + 'starts the selected program' + if self.selected_program is not None: + program = self.programs[self.selected_program]["program_class"] + if self.selected_program == "game": + program(self.options, self.stdscr).run() + else: + game = self.programs["game"]["program_class"]( + { + "board length": self.options["board_length"], + "ai": False, + "start first": self.options["start first"] + }, + self.stdscr + ) + program(self.options, self.stdscr, game).run() + +input_map = { + " ": space, + "KEY_UP": up, + "KEY_DOWN": down, + "q": out, + "\n": enter +} + +class Program: + 'program class' + def __init__(self, stdscr, title, programs): + self.programs = programs + self.selected_program = None + self.cursor = 0 + self.options = None + self.title = title + self.stdscr = stdscr + self.win = None + self.running = True + + def render_options(self, options=None): + """renders options""" + self.stdscr.clear() + self.stdscr.move(1, 0) + self.stdscr.addstr(self.title) + if options is None: + options = list(self.programs.keys()) + self.stdscr.refresh() + self.win = curses.newwin(len(options)+2, 30, 2, 0) + self.win.box() + for index, option in enumerate(options): + original_value = option + self.win.move(index+1, 2) + self.win.addstr(option) + if isinstance(options, dict): + self.win.move(index+1, 3+len(option)) + if options[original_value] is not None: + self.win.addstr(str(options[original_value])) + self.stdscr.move(self.cursor+3, 1) + self.win.refresh() + + def validate_input(self, INPUT): + 'checks if input is valid and passes it into options if so' + if self.options is not None: + option_values = list(self.options.values()) + option_keys = list(self.options.keys()) + selected_key = option_keys[self.cursor] + + value = option_values[self.cursor] + + if INPUT == "KEY_BACKSPACE" and not isinstance(value, bool): + if isinstance(value, str): + self.options[selected_key] = value[:-1] + return + if len(str(value)) != 1 and value is not None: + self.options[selected_key] = int(str(value)[:-1]) + return + self.options[selected_key] = None + return + + if len(str(value)) > 10: + return + + if isinstance(value, bool): + if INPUT in ("KEY_LEFT", "KEY_RIGHT"): + self.options[selected_key] = not value + return + + if (not "KEY" in INPUT) and (INPUT != '\n'): + if INPUT.isnumeric() or isinstance(INPUT, int): + if isinstance(value, int): + self.options[selected_key] = int(str(value) + INPUT) + elif value is None: + self.options[selected_key] = int(INPUT) + return + if isinstance(value, str): + self.options[selected_key] = value + INPUT + + def run(self): + 'runs the program' + while self.running: + self.render_options(self.options) + INPUT = self.stdscr.getkey() + if INPUT in input_map: + input_map[INPUT](self) + else: + self.validate_input(INPUT)