diff --git a/LICENSE b/LICENSE
new file mode 100644
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ place-cursor-at - Utility that moves the mouse cursor using the keyboard
+ Copyright (C) 2017-2021 Viacheslav Lotsmanov
+
+ 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:
+
+ place-cursor-at Copyright (C) 2017-2021 Viacheslav Lotsmanov
+ 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
--- /dev/null
+++ b/README.md
@@ -0,0 +1,216 @@
+
+
+A utility for X11 that moves the mouse cursor using the keyboard.
+Written in Haskell.
+
+This utility only gives you an ability to quickly move your mouse cursor to one
+of 9 common spots of the screen. It’s intended to reduce the use of the mouse,
+but not to replace it completely. It doesn’t provide you accurate aiming, only
+approximate.
+
+You bind a hotkey (in your WM configuration or by using [xbindkeys]) to run
+`place-cursor-at` (say `Super+M`) and when you press it you see 9 windows on
+current screen with letters shown on them. When you press a letter on your
+keyboard that is associated with one of those windows your mouse cursor appear
+at the center of that window and the application closes. Thus you can quickly
+move your mouse cursor to one of 9 different spots by two-step combo.
+
+Other key bindings:
+
+1. Press `Escape` to close the application
+ (when one of the *letter* windows is focused)
+
+2. Move focus to a *letter* window where you want your mouse cursor to be and
+ press `Enter` (this is the same as pressing that *letter* on your keyboard)
+
+I originally created this tool it for myself to use it with
+[xmonad](https://github.com/unclechu/xmonadrc)
+and [i3](https://github.com/unclechu/i3rc).
+
+
+
+## Requirements
+
+Either one:
+
+1. [Nix Package Manager]
+
+2. [The Haskell Tool Stack] and:
+
+ 1. `libX11` development files
+ 2. `libXinerama` development files
+
+## How to use
+
+### With Nix
+
+See [Nix Package Manager].
+
+You can run this application like this:
+
+``` sh
+nix-shell --run place-cursor-at
+```
+
+See also [shell.nix]’s arguments for available options.
+For instance if you want to enter a `nix-shell` with `cabal` available:
+
+``` sh
+nix-shell --arg withCabal true
+```
+
+#### NixOS
+
+You can add this application into your NixOS `configuration.nix` like this:
+
+``` nix
+{ pkgs, ... }:
+let
+ place-cursor-at-src = pkgs.fetchFromGitHub {
+ owner = "unclechu";
+ repo = "place-cursor-at";
+ rev = "ffffffffffffffffffffffffffffffffffffffff"; # Git commit hash
+ sha256 = "0000000000000000000000000000000000000000000000000000";
+ };
+
+ place-cursor-at = pkgs.callPackage place-cursor-at-src {};
+in
+{
+ environment.systemPackages = [ place-cursor-at ];
+}
+```
+
+### With Stack
+
+See [The Haskell Tool Stack].
+
+``` sh
+stack build
+stack exec place-cursor-at
+```
+
+You could install `place-cursor-at` binary to `~/.local/bin` directory
+(make sure you have this directory in your `PATH` environment variable):
+
+``` sh
+stack install
+```
+
+#### NixOS note
+
+If you need to work with Stack under NixOS for whatever reason you would have to
+use `--system-ghc` in order to make it work. You can manually add `--system-ghc`
+to each call of `stack` or define this alias for your convenience:
+
+``` sh
+alias stack='stack --system-ghc'
+```
+
+## Using it as script
+
+You also can run this application as a script
+(`nix-shell` script, so you have to
+[install Nix Package Manager](https://nixos.org/nix/manual/#chap-installation)
+first):
+
+``` sh
+src/place-cursor-at.hs
+```
+
+But this application is intended to be used very often (to be run again and
+again many times) and to be very responsive, so it’s better to precompile it to
+reduce startup time.
+
+## Xinerama note
+
+By default it appears and do its stuff on display where your mouse cursor is.
+But you can specify which display where it should appear on:
+
+``` sh
+place-cursor-at 1
+```
+
+Or on third display:
+
+``` sh
+place-cursor-at 3
+```
+
+## Jump to specific position without GUI
+
+You can immediately jump to specific position of a screen without showing any
+GUI, like this:
+
+``` sh
+place-cursor-at LT
+```
+
+It’s case-insensitive, this also would work:
+
+``` sh
+place-cursor-at lt
+```
+
+And you also can specify a display you want to jump to:
+
+``` sh
+place-cursor-at lt 1
+```
+
+In any order of the arguments:
+
+``` sh
+place-cursor-at 1 lt
+```
+
+### Codes of available positions
+
+```
+| Code | Deciphering |
+| - | - |
+| LT | Left-Top |
+| LC | Left-Center |
+| LB | Left-Bottom |
+| CT | Center-Top |
+| CC | Center-Center |
+| CB | Center-Bottom |
+| RT | Right-Top |
+| RC | Right-Center |
+| RB | Right-Bottom |
+```
+## Author
+
+[Viacheslav Lotsmanov]
+
+## Contributors
+
+The [logo] is created by [psikoz] and
+some technical adjustments are made by [Viacheslav Lotsmanov].
+
+## Licenses
+
+1. **place-cursor-at** — [GNU/GPLv3](https://raw.githubusercontent.com/unclechu/place-cursor-at/b636cb9651c6ededbbda80489c79ff4a68653d96/LICENSE)
+
+2. The logo —
+ [Creative Commons — Attribution 4.0 International (CC BY 4.0)][CC BY 4.0]
+
+ These files in [artwork/logo][logo] directory in particular:
+
+ - [artwork/logo/horizontal.svg](https://raw.githubusercontent.com/unclechu/place-cursor-at/b636cb9651c6ededbbda80489c79ff4a68653d96/artwork/logo/horizontal.svg)
+ - [artwork/logo/horizontal.png](https://raw.githubusercontent.com/unclechu/place-cursor-at/b636cb9651c6ededbbda80489c79ff4a68653d96/artwork/logo/horizontal.png)
+ - [artwork/logo/vertical.svg](https://raw.githubusercontent.com/unclechu/place-cursor-at/b636cb9651c6ededbbda80489c79ff4a68653d96/artwork/logo/vertical.svg)
+ - [artwork/logo/vertical.png](https://raw.githubusercontent.com/unclechu/place-cursor-at/b636cb9651c6ededbbda80489c79ff4a68653d96/artwork/logo/vertical.png)
+ - [artwork/logo/icon.svg](https://raw.githubusercontent.com/unclechu/place-cursor-at/b636cb9651c6ededbbda80489c79ff4a68653d96/artwork/logo/icon.svg)
+ - [artwork/logo/icon.png](https://raw.githubusercontent.com/unclechu/place-cursor-at/b636cb9651c6ededbbda80489c79ff4a68653d96/artwork/logo/icon.png)
+
+[The Haskell Tool Stack]: https://docs.haskellstack.org/en/stable/README/
+[Nix Package Manager]: https://nixos.org/manual/nix/stable/#ch-about-nix
+[xbindkeys]: https://linux.die.net/man/1/xbindkeys
+
+[shell.nix]: https://github.com/unclechu/place-cursor-at/blob/b636cb9651c6ededbbda80489c79ff4a68653d96/shell.nix
+[logo]: https://github.com/unclechu/place-cursor-at/blob/b636cb9651c6ededbbda80489c79ff4a68653d96/artwork/logo
+
+[CC BY 4.0]: https://creativecommons.org/licenses/by/4.0/
+
+[Viacheslav Lotsmanov]: https://github.com/unclechu
+[psikoz]: https://github.com/psikoz
diff --git a/Setup.hs b/Setup.hs
new file mode 100644
--- /dev/null
+++ b/Setup.hs
@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain
diff --git a/place-cursor-at.cabal b/place-cursor-at.cabal
new file mode 100644
--- /dev/null
+++ b/place-cursor-at.cabal
@@ -0,0 +1,42 @@
+cabal-version: 1.12
+
+-- This file has been generated from package.yaml by hpack version 0.34.2.
+--
+-- see: https://github.com/sol/hpack
+--
+-- hash: 66d39f7b6b91273a09289c622d5c81b8bb6f010ee69d032997ed77412a1f96f5
+
+name: place-cursor-at
+version: 1.0.0
+synopsis: A utility for X11 that moves the mouse cursor using the keyboard
+category: Utility, GUI, Desktop, Desktop Environment, X11
+homepage: https://github.com/unclechu/place-cursor-at#readme
+bug-reports: https://github.com/unclechu/place-cursor-at/issues
+author: Viacheslav Lotsmanov
+maintainer: Viacheslav Lotsmanov
+copyright: Copyright © 2017–2021 Viacheslav Lotsmanov
+license: GPL-3
+license-file: LICENSE
+tested-with: GHC ==8.10.4 || ==8.8.4 || ==8.6.4
+build-type: Simple
+extra-source-files:
+ README.md
+
+source-repository head
+ type: git
+ location: https://github.com/unclechu/place-cursor-at
+
+executable place-cursor-at
+ main-is: place-cursor-at.hs
+ hs-source-dirs:
+ src
+ ghc-options: -threaded
+ extra-libraries:
+ Xinerama
+ build-depends:
+ X11 >=1.9 && <2
+ , base >=4.12 && <5
+ , base-unicode-symbols >=0.2 && <0.3
+ other-modules:
+ Paths_place_cursor_at
+ default-language: Haskell2010
diff --git a/src/place-cursor-at.hs b/src/place-cursor-at.hs
new file mode 100644
--- /dev/null
+++ b/src/place-cursor-at.hs
@@ -0,0 +1,605 @@
+#! /usr/bin/env nix-shell
+#! nix-shell -i runhaskell
+#! nix-shell -E "let ghc = n.haskellPackages.ghcWithPackages (p: [p.base-unicode-symbols p.X11]); d = n.mkShell { buildInputs = [ghc]; }; n = import (fetchTarball { url = \"https://github.com/NixOS/nixpkgs/archive/a3fa481cb683d619ab9e1a64877f3c0c5fd24f40.tar.gz\"; sha256 = \"0y5dzi3npv13vyacmb4q93j0cpg6gjgvylq4ckjjvcb6szdsizqi\"; }) {}; in d"
+
+-- Author: Viacheslav Lotsmanov
+-- License: GNU/GPLv3 https://raw.githubusercontent.com/unclechu/place-cursor-at/master/LICENSE
+
+{-# OPTIONS_GHC -Wall -fprint-potential-instances #-}
+{-# LANGUAGE UnicodeSyntax, BangPatterns, MultiWayIf, ViewPatterns, ScopedTypeVariables, GADTs #-}
+{-# LANGUAGE LambdaCase, DerivingStrategies, GeneralizedNewtypeDeriving #-}
+
+import Prelude.Unicode ((∘), (÷), (≡), (⧺), (∧), (≥))
+
+import Data.Bifunctor (first)
+import Data.Bits ((.|.))
+import Data.Bool (bool)
+import Data.Char (toUpper)
+import Data.Functor ((<&>))
+import Data.List (find)
+import Numeric.Natural
+import Text.ParserCombinators.ReadP (satisfy)
+import Text.Read (ReadPrec, Read (readPrec), lift, choice, readMaybe)
+
+import Control.Applicative ((<|>))
+import Control.Arrow ((***), (&&&))
+import Control.Concurrent (forkFinally)
+import Control.Concurrent.MVar (newEmptyMVar, putMVar, readMVar)
+import Control.Exception (SomeException, try, throwIO)
+import Control.Monad (forever, forM_, foldM, void)
+
+import System.Environment (getArgs)
+
+import Graphics.X11.Xlib
+
+import Graphics.X11.Xlib.Extras
+ ( SizeHints (..)
+ , pMinSizeBit
+ , pMaxSizeBit
+ , changeProperty8
+ , propModeReplace
+ , queryTree
+ , getTextProperty
+ , TextProperty (tp_value)
+ , killClient
+ )
+
+import Graphics.X11.Xinerama
+ ( xineramaQueryScreens
+ , XineramaScreenInfo (..)
+ )
+
+import Foreign.C.String (castCharToCChar, peekCString)
+import Foreign.ForeignPtr (ForeignPtr, mallocForeignPtr)
+import Foreign.ForeignPtr.Unsafe (unsafeForeignPtrToPtr)
+import Foreign.Ptr (Ptr)
+import Foreign.Storable (Storable (poke))
+
+foreign import ccall unsafe "XlibExtras.h XSetWMNormalHints"
+ xSetWMNormalHints ∷ Display → Window → Ptr SizeHints → IO ()
+
+foreign import ccall unsafe "XlibExtras.h XSetWMSizeHints"
+ xSetWMSizeHints ∷ Display → Window → Ptr SizeHints → Int → IO ()
+
+
+s, w, h, letterPaddingX, letterPaddingY, offsetPercent ∷ Num a ⇒ a
+s = 40; w = s; h = s
+letterPaddingX = 10; letterPaddingY = 10
+offsetPercent = 10
+
+
+windowClassName ∷ String
+windowClassName = "place-cursor-at"
+
+
+data Pos
+ = PosLT | PosCT | PosRT
+ | PosLC | PosCC | PosRC
+ | PosLB | PosCB | PosRB
+ deriving stock (Eq, Show, Enum, Bounded)
+
+instance Read Pos where
+ readPrec = go where
+ go = choice $ lift <$> x
+ insStr a b = void $ satisfy ((a ≡) ∘ toUpper) *> satisfy ((b ≡) ∘ toUpper)
+
+ x =
+ [ PosLT <$ insStr 'L' 'T', PosCT <$ insStr 'C' 'T', PosRT <$ insStr 'R' 'T'
+ , PosLC <$ insStr 'L' 'C', PosCC <$ insStr 'C' 'C', PosRC <$ insStr 'R' 'C'
+ , PosLB <$ insStr 'L' 'B', PosCB <$ insStr 'C' 'B', PosRB <$ insStr 'R' 'B'
+ ]
+
+
+data Letter
+ = Q | W | E
+ | A | S | D
+ | Z | X | C
+ deriving stock (Eq, Show)
+
+letterToKeyCode ∷ Letter → KeyCode
+letterToKeyCode = \case
+ Q → 24; W → 25; E → 26
+ A → 38; S → 39; D → 40
+ Z → 52; X → 53; C → 54
+
+positionToLetter ∷ Pos → Letter
+positionToLetter = \case
+ PosLT → Q; PosCT → W; PosRT → E
+ PosLC → A; PosCC → S; PosRC → D
+ PosLB → Z; PosCB → X; PosRB → C
+
+
+-- | Position relative to either X or Y axis
+data AbstractPos
+ = MinPos -- ^ Left of Top
+ | MiddlePos -- ^ Center
+ | MaxPos -- ^ Right or Bottom
+ deriving stock (Eq, Show)
+
+getAbstractPosX ∷ Pos → AbstractPos
+getAbstractPosX = \case
+ PosLT → MinPos; PosLC → MinPos; PosLB → MinPos
+ PosCT → MiddlePos; PosCC → MiddlePos; PosCB → MiddlePos
+ PosRT → MaxPos; PosRC → MaxPos; PosRB → MaxPos
+
+getAbstractPosY ∷ Pos → AbstractPos
+getAbstractPosY = \case
+ PosLT → MinPos; PosCT → MinPos; PosRT → MinPos
+ PosLC → MiddlePos; PosCC → MiddlePos; PosRC → MiddlePos
+ PosLB → MaxPos; PosCB → MaxPos; PosRB → MaxPos
+
+abstractPosToCoordinate ∷ Fractional a ⇒ a → AbstractPos → a
+abstractPosToCoordinate x = \case
+ MinPos → x × offsetPercent ÷ 100
+ MiddlePos → x ÷ 2
+ MaxPos → x × (100 - offsetPercent) ÷ 100
+
+
+-- | Command-line arguments
+data Argv
+ = Argv
+ { argvOnDisplay ∷ Maybe SpecificScreenNumber
+ -- ^ Jump to specific display
+ , argvToPosition ∷ Maybe Pos
+ -- ^ Jump to specific position on screen (GUI wont be shown)
+ } deriving stock (Show, Eq)
+
+emptyArgv ∷ Argv
+emptyArgv = Argv Nothing Nothing
+
+
+-- | Screen number that starts with 0.
+--
+-- N.B. In "Read" and "Show" instances it starts with 1.
+-- When parsed or printed it either decrements or increments.
+newtype SpecificScreenNumber
+ = SpecificScreenNumber { fromSpecificScreenNumber ∷ Natural }
+ deriving newtype (Eq, Enum)
+
+-- | Prints wrapped number as a string.
+--
+-- N.B. But printed number increments, it starts with 1 (instead of 0).
+instance Show SpecificScreenNumber where
+ show = fromSpecificScreenNumber • succ • show
+
+-- | It reads screen number as plain number that starts with 1.
+--
+-- N.B. Wrapped value is decremented.
+instance Read SpecificScreenNumber where
+ readPrec =
+ (readPrec ∷ ReadPrec Natural) >>= \x →
+ if x ≡ 0
+ then fail $ unwords ["Incorrect screen number", show x, " (must start with 1)"]
+ else pure ∘ pred ∘ SpecificScreenNumber $ x
+
+
+main ∷ IO ()
+main = do
+ doneHandler ← mkDoneHandler
+ (dpy, rootWnd) ← (id &&& defaultRootWindow) <$> openDisplay ""
+ killPreviousInstanceIfExists dpy
+
+ (xsn, justGoToPos') ←
+ let
+ reducer argv x =
+ case (readMaybe x <&> \x' → argv { argvOnDisplay = Just x' })
+ <|> (readMaybe x <&> \x' → argv { argvToPosition = Just x' })
+ of Just updatedArgv → pure updatedArgv
+ Nothing → fail $ "Unexpected argument: " ⧺ show x
+ in
+ (getArgs >>= foldM reducer emptyArgv) <&> (argvOnDisplay &&& argvToPosition)
+
+ !xsi ← getScreenInfo dpy xsn
+
+ let
+ xX, xY, xW, xH ∷ Rational
+ relativeX, relativeY ∷ Pos → Rational
+
+ from f = fromIntegral $ f xsi
+ xX = from xsi_x_org
+ xY = from xsi_y_org
+ xW = from xsi_width
+ xH = from xsi_height
+ relativeX = getAbstractPosX • abstractPosToCoordinate xW
+ relativeY = getAbstractPosY • abstractPosToCoordinate xH
+
+ toPosition ∷ Rational → Position
+ toPosition = fromInteger ∘ round
+
+ windows ∷ [(Letter, (Position, Position))]
+ windows = [minBound..maxBound] <&> \pos →
+ let
+ x, y ∷ Rational
+ x = xX + relativeX pos - (w ÷ 2)
+ y = xY + relativeY pos - (h ÷ 2)
+ in
+ (positionToLetter pos, (toPosition x, toPosition y))
+
+ places ∷ [(Pos, (Position, Position))]
+ places = [minBound..maxBound] <&> \pos →
+ let
+ x, y ∷ Rational
+ x = xX + relativeX pos
+ y = xY + relativeY pos
+ in
+ (pos, (toPosition x, toPosition y))
+
+ case justGoToPos' of
+ Just pos →
+ case lookup pos places of
+ Just (x, y) → do
+ placeCursorAt dpy rootWnd x y
+ closeDisplay dpy
+
+ Nothing → fail $ "Unexpectedly fail to find a 'place' by " ⧺ show pos
+
+ Nothing → do
+ closeDisplay dpy
+ let places' = places <&> first (letterToKeyCode ∘ positionToLetter)
+ let done = doneWithIt doneHandler
+ forM_ windows $ windowInstance (done (pure ())) places' • (`forkFinally` done)
+ waitBeforeItIsDone doneHandler >>= either throwIO pure
+
+
+-- | Kill previous instance of *place-cursor-at*.
+--
+-- FIXME In some cases it fails the killer with this exception in the log:
+--
+-- @
+-- X Error of failed request: BadValue (integer parameter out of range for operation)
+-- Major opcode of failed request: 113 (X_KillClient)
+-- Value in failed request: 0x6000002
+-- Serial number of failed request: 259
+-- Current serial number in output stream: 260
+-- @
+--
+-- I have no idea what the heck is this. I tried many ways to fix this with no success.
+killPreviousInstanceIfExists ∷ Display → IO ()
+killPreviousInstanceIfExists dpy = go where
+ go = traverseChildWindows (defaultRootWindow dpy)
+ kill = killClient dpy
+
+ traverseChildWindows ∷ Window → IO ()
+ traverseChildWindows wnd = killEmRecursively where
+ killEmRecursively =
+ getAllWindowsList wnd
+ >>= foldM reducer mempty
+ >>= (mapM_ kill *** mapM_ traverseChildWindows) • uncurry (>>)
+
+ reducer ∷ acc ~ ([Window], [Window]) ⇒ acc → Window → IO acc
+ reducer acc x = f where
+ f = isPlaceCursorAtWindow x <&> \is → (x `appendIf` is *** x `appendIf` not is) acc
+ appendIf wndToAppend = bool id (⧺ [wndToAppend])
+
+ getAllWindowsList ∷ Window → IO [Window]
+ getAllWindowsList wnd = queryTree dpy wnd <&> \(_, _, x) → x
+
+ isPlaceCursorAtWindow ∷ Window → IO Bool
+ isPlaceCursorAtWindow wnd = x where
+ x = try matchByWindowClass <&> either (const False ∷ IOError → Bool) id
+
+ matchByWindowClass =
+ getTextProperty dpy wnd wM_CLASS
+ >>= tp_value • peekCString
+ >>= (≡ windowClassName) • pure
+
+
+-- | Get info about screen either under cursor or specified by an argument.
+getScreenInfo ∷ Display → Maybe SpecificScreenNumber → IO XineramaScreenInfo
+getScreenInfo dpy specificScreen = go where
+ xineramaFailureMsg = unwords
+ [ "Could not obtain Xinerama screens information,"
+ , "check that libXinerama dependency is installed"
+ , "and Xinerama X11 extension is active!"
+ ]
+
+ isSpecifiedScreen ∷ SpecificScreenNumber → XineramaScreenInfo → Bool
+ isSpecifiedScreen (SpecificScreenNumber (toInteger • fromInteger → n)) =
+ xsi_screen_number • (≡ n)
+
+ isScreenUnderCursor ∷ (Integer, Integer) → XineramaScreenInfo → Bool
+ isScreenUnderCursor (mX, mY) screenInfo = x where
+ f = fromIntegral
+ (x1, y1) = (f (xsi_x_org screenInfo), f (xsi_y_org screenInfo))
+ (x2, y2) = (x1 + f (xsi_width screenInfo), y1 + f (xsi_height screenInfo))
+ x = (mX ≥ x1 ∧ mY ≥ y1) ∧ (mX < x2 ∧ mY < y2)
+
+ go = do
+ screens ←
+ xineramaQueryScreens dpy >>=
+ maybe (fail xineramaFailureMsg) pure
+
+ (predicateFn ∷ XineramaScreenInfo → Bool, failureMsg ∷ String) ←
+ case specificScreen of
+ Nothing → do
+ mouseCoords ← mousePos dpy (defaultRootWindow dpy) <&> (fromIntegral *** fromIntegral)
+
+ let
+ failureMsg = unwords
+ [ "Could not find a screen which is under cursor, something went wrong"
+ , "(mouse position:", show mouseCoords ⧺ ", screens:", show screens ⧺ ")"
+ ]
+
+ pure (isScreenUnderCursor mouseCoords, failureMsg)
+
+ Just screenNum →
+ let
+ failureMsg = unwords
+ [ "Could not find screen number", show screenNum
+ , "(by Xinerama screen number", show (fromSpecificScreenNumber screenNum) ⧺ "),"
+ , "specified screen number is probably out of range"
+ , "(screens:", show screens ⧺ ")"
+ ]
+ in
+ pure (isSpecifiedScreen screenNum, failureMsg)
+
+ maybe (fail failureMsg) pure (find predicateFn screens)
+
+
+windowInstance
+ ∷ IO ()
+ → [(KeyCode, (Position, Position))]
+ → (Letter, (Position, Position))
+ → IO ()
+
+windowInstance done places (letter, (wndX, wndY)) = do
+
+ dpy ← openDisplay ""
+
+ let
+ rootWnd = defaultRootWindow dpy
+ screen = defaultScreen dpy
+ gc = defaultGC dpy screen
+ blackPx = blackPixel dpy screen
+ whitePx = whitePixel dpy screen
+
+ setLineAttributes dpy gc 3 0 0 0 -- Increase line thickness
+ setForeground dpy gc whitePx
+
+ let
+ placeAt ∷ Position → Position → IO ()
+ placeAt = placeCursorAt dpy rootWnd
+
+ wnd ← createSimpleWindow dpy rootWnd 0 0 w h 0 whitePx blackPx
+ shPtr ← allocSH
+ xSetWMNormalHints dpy wnd shPtr
+ xSetWMSizeHints dpy wnd shPtr $ pMinSizeBit .|. pMaxSizeBit
+
+ storeName dpy wnd $ "Place Cursor At [" ⧺ show letter ⧺ "]"
+ changeProperty8 dpy wnd wM_CLASS sTRING propModeReplace $ castCharToCChar <$> windowClassName
+
+ mapWindow dpy wnd
+ placeWindowAt dpy wnd wndX wndY
+
+ selectInput dpy wnd $ keyPressMask .|. exposureMask
+ () <$ allocaXEvent (forever ∘ evLoop done dpy wnd gc placeAt letter places)
+
+
+allocSH ∷ IO (Ptr SizeHints)
+allocSH = go where
+ go = malloc >>= unsafeForeignPtrToPtr • \ptr → ptr <$ poke ptr sh
+
+ malloc ∷ IO (ForeignPtr SizeHints)
+ malloc = mallocForeignPtr
+
+ sh ∷ SizeHints
+ sh = SizeHints
+ { sh_min_size = Just (w, h)
+ , sh_max_size = Just (w, h)
+ , sh_resize_inc = Nothing
+ , sh_aspect = Nothing
+ , sh_base_size = Nothing
+ , sh_win_gravity = Nothing
+ }
+
+
+mousePos ∷ Display → Window → IO (Integer, Integer)
+mousePos dpy wnd = f <$> queryPointer dpy wnd
+ where f (_, _, _, rootX, rootY, _, _, _) = (toInteger rootX, toInteger rootY)
+
+
+placeWindowAt ∷ Display → Window → Position → Position → IO ()
+placeWindowAt dpy wnd x y = moveResizeWindow dpy wnd x y w h
+
+placeCursorAt ∷ Display → Window → Position → Position → IO ()
+placeCursorAt dpy wnd x y = f where f = warpPointer dpy wnd wnd 0 0 0 0 x y
+
+
+evLoop
+ ∷ IO ()
+ → Display → Window → GC
+ → (Position → Position → IO ())
+ → Letter
+ → [(KeyCode, (Position, Position))]
+ → XEventPtr
+ → IO ()
+
+evLoop done dpy wnd gc placeAt letter places evPtr = do
+ nextEvent dpy evPtr
+ evType ← get_EventType evPtr
+ let getKeyCode (_, _, _, _, _, _, _, _, keyCode, _) = keyCode
+
+ if
+ | evType ≡ keyPress → get_KeyEvent evPtr >>= getKeyCode • handleKey done placeAt places letter
+ | evType ≡ expose → draw dpy wnd gc letter
+ | otherwise → pure ()
+
+
+handleKey
+ ∷ IO ()
+ → (Position → Position → IO ())
+ → [(KeyCode, (Position, Position))]
+ → Letter
+ → KeyCode
+ → IO ()
+
+handleKey done placeAt places letter keyCode
+ | keyCode ≡ 9 = done -- Escape
+ | keyCode ≡ 36 = resolve ∘ letterToKeyCode $ letter -- Enter
+ | otherwise = resolve keyCode
+ where
+ coordsByKeyCode keyCode' = snd <$> find ((≡ keyCode') ∘ fst) places
+ resolve (coordsByKeyCode → Just coords) = uncurry placeAt coords >> done
+ resolve _ = pure ()
+
+
+data LinePointsRelativity = Absolute | Relative deriving stock (Eq, Show)
+data Line = Line LinePointsRelativity [Point] deriving stock (Eq, Show)
+
+draw ∷ Display → Window → GC → Letter → IO ()
+draw dpy wnd gc (letterToLines → linesToRender) =
+ forM_ linesToRender $ \(Line rel points) →
+ let
+ f n rescale = (round ∷ Rational → Position) ∘ rescale ∘ fromIntegral $ n
+
+ rescaledPoints = points <&> \(Point x y) →
+ Point
+ (f x (× ((pred w - letterPaddingX × 2) ÷ 100)))
+ (f y (× ((pred h - letterPaddingY × 2) ÷ 100)))
+
+ coordMode = case rel of
+ Absolute → coordModeOrigin
+ Relative → coordModePrevious
+
+ shiftPadding = case rel of
+ Absolute → fmap shift
+ Relative → \case (x : xs) → shift x : xs; [] → []
+ where shift (Point x y) = Point (x + letterPaddingX) (y + letterPaddingY)
+ in
+ drawLines dpy wnd gc (shiftPadding rescaledPoints) coordMode
+
+-- | Manually draw letters using simple lines.
+--
+-- Coordinates are like percents, in range form 0 to 100.
+letterToLines ∷ Letter → [Line]
+letterToLines = \case
+ Q → [ Line Absolute $ let spacer = 0 in
+ [ Point roundCorner 0
+ , Point (100 - roundCorner) 0
+ , Point 100 roundCorner
+ , Point 100 (100 - roundCorner - spacer)
+ , Point (100 - roundCorner) (100 - spacer)
+ , Point roundCorner (100 - spacer)
+ , Point 0 (100 - spacer - roundCorner)
+ , Point 0 roundCorner
+ , Point roundCorner 0
+ ]
+ , Line Relative
+ [ Point 105 125
+ , Point (-50) (-50)
+ ]
+ ]
+ W → [ Line Absolute
+ [ Point 0 0
+ , Point 0 100
+ , Point 50 55
+ , Point 100 100
+ , Point 100 0
+ ]
+ ]
+ E → [ Line Absolute
+ [ Point 110 0
+ , Point 0 0
+ , Point 0 45
+ , Point 110 45
+ ]
+ , Line Absolute
+ [ Point 0 50
+ , Point 0 100
+ , Point 110 100
+ ]
+ ]
+ A → [ Line Absolute
+ [ Point 0 110
+ , Point 0 roundCorner
+ , Point roundCorner 0
+ , Point (100 - roundCorner) 0
+ , Point 100 roundCorner
+ , Point 100 110
+ ]
+ , Line Absolute
+ [ Point 0 60
+ , Point 100 60
+ ]
+ ]
+ S → [ Line Absolute
+ [ Point 100 roundCorner
+ , Point (100 - roundCorner) 0
+ , Point roundCorner 0
+ , Point 0 roundCorner
+ , Point 0 (48 - roundCorner)
+ , Point roundCorner 48
+ , Point (100 - roundCorner) 48
+ , Point 100 (48 + roundCorner)
+ , Point 100 (100 - roundCorner)
+ , Point (100 - roundCorner) 100
+ , Point roundCorner 100
+ , Point 0 (100 - roundCorner)
+ ]
+ ]
+ D → [ Line Absolute $
+ let roundCorner' = (round ∷ Rational → Position) (fromIntegral roundCorner × (3/2)) in
+ [ Point 0 0
+ , Point 0 100
+ , Point (100 - roundCorner') 100
+ , Point 100 (100 - roundCorner')
+ , Point 100 roundCorner'
+ , Point (100 - roundCorner') 0
+ , Point 0 0
+ ]
+ ]
+ Z → [ Line Absolute
+ [ Point 0 0
+ , Point 90 0
+ , Point 5 100
+ , Point 105 100
+ ]
+ ]
+ X → [ Line Absolute
+ [ Point 0 0
+ , Point 103 103
+ ]
+ , Line Absolute
+ [ Point 0 100
+ , Point 103 (-3)
+ ]
+ ]
+ C → [ Line Absolute
+ [ Point 100 (roundCorner + 8)
+ , Point 100 roundCorner
+ , Point (100 - roundCorner) 0
+ , Point roundCorner 0
+ , Point 0 roundCorner
+ , Point 0 (100 - roundCorner)
+ , Point roundCorner 100
+ , Point (100 - roundCorner) 100
+ , Point 100 (100 - roundCorner)
+ , Point 100 (100 - (roundCorner + 8))
+ ]
+ ]
+ where roundCorner = 12
+
+
+data DoneApi = DoneApi
+ { doneWithIt ∷ Either SomeException () → IO ()
+ , waitBeforeItIsDone ∷ IO (Either SomeException ())
+ }
+
+mkDoneHandler ∷ IO DoneApi
+mkDoneHandler = newEmptyMVar <&> \mvar → DoneApi
+ { doneWithIt = putMVar mvar
+ , waitBeforeItIsDone = readMVar mvar
+ }
+
+
+(•) ∷ (a → b) → (b → c) → a → c
+(•) = flip (∘)
+infixl 9 •
+{-# INLINE (•) #-}
+
+-- This operator is provided by newer version of ‘base-unicode-symbols’.
+-- This adds support for older snaphots.
+(×) ∷ Num a ⇒ a → a → a
+(×) = (Prelude.*)
+infixl 7 ×
+{-# INLINE (×) #-}