commit 217525bf2f7353ab241163eab94a9eb6106aab5e Author: John Gebbie Date: Thu Oct 20 14:21:20 2022 +0100 initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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..11dccb2 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# dotool + +dotool reads commands from stdin and simulates keyboard and mouse events. +It works everywhere on Linux, including in X11, Wayland and TTYs. + +It takes about half a second to register the virtual device, but it can be kept using the daemon. + +## Install + +Run `go build` with go (>=1.19) and copy `dotool`, `dotoold` and `dotoolc` into your PATH. + +## Usage + +dotool will usually require root permissions unless you add a udev rule for uinput. +You could run these commands to add a rule for yourself and make it effective: +``` +echo KERNEL==\"uinput\", GROUP=\"$USER\", MODE:=\"0660\" | sudo tee /etc/udev/rules.d/99-dotool-$USER.rules +sudo udevadm trigger +``` + +This greets the world: +`echo 'type Sup, Lads!' | dotool` + +This screams for three seconds: +`{ echo keydown A; sleep 3; echo key H shift+1; } | dotool` + +This drags the mouse: +`printf %s\\n 'buttondown left' 'mousemove 0 100' 'buttonup left' | dotool` + +The daemon and client, `dotoold` and `dotoolc`, can used to keep a persistent virtual device for a quicker initial response: +``` +dotoold & +echo 'type super' | dotoolc +echo 'type speedy' | dotoolc +``` + +## Contact + +You can ask a question or send a patch by composing an email to [~geb/public-inbox@lists.sr.ht](https://lists.sr.ht/~geb/public-inbox). diff --git a/dotool.go b/dotool.go new file mode 100644 index 0000000..5ea14c7 --- /dev/null +++ b/dotool.go @@ -0,0 +1,381 @@ +package main + +import ( + "bufio" + "errors" + "fmt" + "github.com/bendahl/uinput" + "git.sr.ht/~geb/opt" + "math" + "os" + "strconv" + "strings" + "unicode" +) + +func fatal(v ...interface{}) { + fmt.Fprint(os.Stderr, "dotool: ") + fmt.Fprintln(os.Stderr, v...) + os.Exit(1) +} + +func warn(v ...interface{}) { + fmt.Fprint(os.Stderr, "dotool WARNING: ") + fmt.Fprintln(os.Stderr, v...) +} + +func log(err error) { + if err != nil { + warn(err.Error()) + } +} + +type Chord struct { + Super bool + Ctrl bool + Alt bool + Shift bool + Key int +} + +func parseChord(chord string) (Chord, error) { + var c Chord + keys := strings.Split(chord, "+") + for i := 0; i < len(keys) - 1; i++ { + switch strings.ToLower(keys[i]) { + case "super": + c.Super = true + case "ctrl", "control": + c.Ctrl = true + case "alt": + c.Alt = true + case "shift": + c.Shift = true + default: + return c, errors.New("unknown modifier: " + keys[i]) + } + } + + k := keys[len(keys)-1] + if strings.HasPrefix(k, "k:") { + code, err := strconv.Atoi(k[2:]) + if err != nil { + return c, errors.New("invalid keycode: " + k) + } + c.Key = code + } else if strings.HasPrefix(k, "x:") { + if code, ok := xKeysShifted[strings.ToLower(k[2:])]; ok { + if len(k[2:]) > 1 || unicode.IsUpper(rune(k[2])) { + c.Shift = true + } + c.Key = code + } else if code, ok := xKeysNormal[strings.ToLower(k[2:])]; ok { + c.Key = code + } else { + return c, errors.New("unknown X11 key: " + k) + } + } else { + code, ok := linuxKeys[strings.ToLower(k)] + if len(k) == 1 && unicode.IsUpper(rune(k[0])) { + c.Shift = true + } + if !ok { + return c, errors.New("unknown key: " + k) + } + c.Key = code + } + return c, nil +} + +func (c *Chord) Press(kb uinput.Keyboard) { + if c.Super { + log(kb.KeyDown(uinput.KeyLeftmeta)) + } + if c.Ctrl { + log(kb.KeyDown(uinput.KeyLeftctrl)) + } + if c.Alt { + log(kb.KeyDown(uinput.KeyLeftalt)) + } + if c.Shift { + log(kb.KeyDown(uinput.KeyLeftshift)) + } + log(kb.KeyPress(c.Key)) + if c.Super { + log(kb.KeyUp(uinput.KeyLeftmeta)) + } + if c.Ctrl { + log(kb.KeyUp(uinput.KeyLeftctrl)) + } + if c.Alt { + log(kb.KeyUp(uinput.KeyLeftalt)) + } + if c.Shift { + log(kb.KeyUp(uinput.KeyLeftshift)) + } +} + +func (c *Chord) KeyDown(kb uinput.Keyboard) { + if c.Super { + log(kb.KeyDown(uinput.KeyLeftmeta)) + } + if c.Ctrl { + log(kb.KeyDown(uinput.KeyLeftctrl)) + } + if c.Alt { + log(kb.KeyDown(uinput.KeyLeftalt)) + } + if c.Shift { + log(kb.KeyDown(uinput.KeyLeftshift)) + } + log(kb.KeyDown(c.Key)) +} + +func (c *Chord) KeyUp(kb uinput.Keyboard) { + if c.Super { + log(kb.KeyUp(uinput.KeyLeftmeta)) + } + if c.Ctrl { + log(kb.KeyUp(uinput.KeyLeftctrl)) + } + if c.Alt { + log(kb.KeyUp(uinput.KeyLeftalt)) + } + if c.Shift { + log(kb.KeyUp(uinput.KeyLeftshift)) + } + log(kb.KeyUp(c.Key)) +} + + +func usage() { + fmt.Fprintln(os.Stderr, `dotool reads commands from stdin and simulates keyboard and pointer events. + +The commands are: + key CHORD... + keydown CHORD... + keyup CHORD... + type TEXT + click left/middle/right + buttondown left/middle/right + buttonup left/middle/right + scroll NUMBER (where NUMBER is the amount down/up if positive/negative) + mouseto X Y (where X and Y are percentages between 0.0 and 1.0) + mousemove X Y (where X and Y are the number of pixels to move) + +Example: echo "key h i shift+1" | dotool + +The keys are those used by Linux, but can also be specified using X11 names +prefixed with x: like x:exclam, as well as their Linux keycode like k:30. +They are case insensitive, except uppercase character keys also simulate shift. + +The modifiers are: super, ctrl, alt and shift. + +--list-keys + Print the supported Linux keys and their keycodes. + +--list-x-keys + Print the supported X11 keys and their Linux keycodes. +`) +} + +func cutCmd(s, cmd string) (string, bool) { + if strings.HasPrefix(s, cmd + " ") || strings.HasPrefix(s, cmd + "\t") { + return s[len(cmd)+1:], true + } + return "", false +} + +func main() { + { + optset := opt.NewOptionSet() + help := func(bool) error { + usage() + os.Exit(0) + panic("unreachable") + } + listKeys := func(bool) error { + for i := 1; i < 249; i++ { + for name, code := range linuxKeys { + if code == i { + fmt.Printf("%s %d\n", name, code) + break + } + } + } + os.Exit(0) + panic("unreachable") + } + listXKeys := func(bool) error { + for i := 1; i < 249; i++ { + for name, code := range xKeysNormal { + if code == i { + fmt.Print(name) + for name, code := range xKeysShifted { + if code == i { + if len(name) == 1 { + name = strings.ToUpper(name) + } + fmt.Printf(" %s", name) + break + } + } + fmt.Printf(" %d\n", code) + break + } + } + } + os.Exit(0) + panic("unreachable") + } + optset.BoolFunc("h", help) + optset.BoolFunc("help", help) + optset.BoolFunc("list-keys", listKeys) + optset.BoolFunc("list-x-keys", listXKeys) + err := optset.Parse(true, os.Args[1:]) + if err != nil { + fatal(err.Error()) + } + } + + keyboard, err := uinput.CreateKeyboard("/dev/uinput", []byte("dotool keyboard")) + if err != nil { + fatal(err.Error()) + } + defer keyboard.Close() + + const precision = 10000 + touchpad, err := uinput.CreateTouchPad("/dev/uinput", []byte("dotool absolute pointer"), 0, precision, 0, precision) + if err != nil { + fatal(err.Error()) + } + defer touchpad.Close() + + mouse, err := uinput.CreateMouse("/dev/uinput", []byte("dotool relative pointer")) + if err != nil { + fatal(err.Error()) + } + defer mouse.Close() + + sc := bufio.NewScanner(os.Stdin) + for sc.Scan() { + text := strings.TrimLeftFunc(sc.Text(), unicode.IsSpace) + if text == "" { + continue + } + if s, ok := cutCmd(text, "key"); ok { + for _, field := range strings.Fields(s) { + if chord, err := parseChord(field); err == nil { + chord.Press(keyboard) + } else { + warn(err.Error()) + } + } + } else if s, ok := cutCmd(text, "keydown"); ok { + for _, field := range strings.Fields(s) { + if chord, err := parseChord(field); err == nil { + chord.KeyDown(keyboard) + } else { + warn(err.Error()) + } + } + } else if s, ok := cutCmd(text, "keyup"); ok { + for _, field := range strings.Fields(s) { + if chord, err := parseChord(field); err == nil { + chord.KeyUp(keyboard) + } else { + warn(err.Error()) + } + } + } else if s, ok := cutCmd(text, "type"); ok { + for _, r := range s { + if chord, ok := runeChords[unicode.ToLower(r)]; ok { + if unicode.IsUpper(r) { + chord.Shift = true + } + chord.Press(keyboard) + } + } + } else if s, ok := cutCmd(text, "click"); ok { + for _, button := range strings.Fields(s) { + switch button { + case "left", "1": + log(mouse.LeftClick()) + case "middle", "2": + log(mouse.MiddleClick()) + case "right", "3": + log(mouse.RightClick()) + default: + warn("unknown button: " + button) + } + } + } else if s, ok := cutCmd(text, "buttondown"); ok { + for _, button := range strings.Fields(s) { + switch button { + case "left", "1": + log(mouse.LeftPress()) + case "middle", "2": + log(mouse.MiddlePress()) + case "right", "3": + log(mouse.RightPress()) + default: + warn("unknown button: " + button) + } + } + } else if s, ok := cutCmd(text, "buttonup"); ok { + for _, button := range strings.Fields(s) { + switch button { + case "left", "1": + log(mouse.LeftRelease()) + case "middle", "2": + log(mouse.MiddleRelease()) + case "right", "3": + log(mouse.RightRelease()) + default: + warn("unknown button: " + button) + } + } + } else if s, ok := cutCmd(text, "scroll"); ok { + var n float64 + _, err := fmt.Sscanf(s + "\n", "%f\n", &n) + if err == nil { + log(mouse.Wheel(false, int32(-n))) + } else { + warn("invalid scroll amount: " + sc.Text()) + } + } else if s, ok := cutCmd(text, "mouseto"); ok { + var x, y float64 + _, err := fmt.Sscanf(s + "\n", "%f %f\n", &x, &y) + if err == nil { + if x < 0.0 || x > 1.0 || y < 0.0 || y > 1.0 { + warn("clamping percentages between 0.0 and 1.0: " + sc.Text()) + x = math.Max(0, math.Min(x, 1.0)) + y = math.Min(0, math.Min(y, 1.0)) + } + x, y := int32(x * float64(precision)), int32(y * float64(precision)) + err := touchpad.MoveTo(x, y) + if err != nil { + warn(err.Error()) + } + } else { + warn("invalid coordinate: " + sc.Text()) + } + } else if s, ok := cutCmd(text, "mousemove"); ok { + var x, y float64 + _, err := fmt.Sscanf(s + "\n", "%f %f\n", &x, &y) + if err == nil { + err := mouse.Move(int32(x), int32(y)) + if err != nil { + warn(err.Error()) + } + } else { + warn("invalid coordinate: " + sc.Text()) + } + } else { + warn("unknown command: " + sc.Text()) + } + } + if sc.Err() != nil { + fatal(sc.Err().Error()) + } +} diff --git a/dotoolc b/dotoolc new file mode 100755 index 0000000..fadf3e5 --- /dev/null +++ b/dotoolc @@ -0,0 +1,24 @@ +#!/bin/sh +if [ $# != 0 ]; then + echo 'dotoolc writes its stdin to the pipe being read by dotoold. +dotoolc will exit immediately if the pipe is not being read. +The path of the pipe is $DOTOOL_PIPE else /tmp/dotool_pipe. +' > /dev/stderr + [ "$1" = -h ] || [ "$1" = --help ]; exit +fi + +fifo_being_read(){ + [ -p "$1" ] && /bin/echo 1<>"$1" >"$1" +} + +p="${DOTOOL_PIPE:-/tmp/dotool_pipe}" + +if [ -p "$p" ] && ! [ -w "$p" ]; then + echo 'dotoolc: the pipe does not grant write permission' + exit 1 +fi +if ! fifo_being_read "$p"; then + echo 'dotoolc: dotoold is not connected' > /dev/stderr + exit 1 +fi +cat > "$p" diff --git a/dotoold b/dotoold new file mode 100755 index 0000000..7b245ee --- /dev/null +++ b/dotoold @@ -0,0 +1,25 @@ +#!/bin/sh +if [ $# != 0 ]; then + echo 'dotoold runs dotool reading from a pipe for dotoolc to write to. +dotoold will exit immediately if the pipe is already being read. +The path used for the pipe is $DOTOOL_PIPE else /tmp/dotool_pipe. +' > /dev/stderr + [ "$1" = -h ] || [ "$1" = --help ]; exit +fi + +fifo_being_read(){ + [ -p "$1" ] && /bin/echo 1<>"$1" >"$1" +} + +p="${DOTOOL_PIPE:-/tmp/dotool_pipe}" + +if fifo_being_read "$p" 2> /dev/null; then + echo 'dotoold: another instance is already connected' > /dev/stderr + exit 1 +fi + +rm -rf "$p" || exit 1 +trap 'rm -rf "$p"' EXIT INT TERM HUP +mkfifo -m 660 "$p" || exit 1 + +dotool <> "$p" diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..4445e69 --- /dev/null +++ b/go.mod @@ -0,0 +1,8 @@ +module git.sr.ht/~geb/dotool + +go 1.19 + +require ( + git.sr.ht/~geb/opt v0.0.0-20220627180516-52214b5b84a1 + github.com/bendahl/uinput v1.6.0 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..06ca3c6 --- /dev/null +++ b/go.sum @@ -0,0 +1,4 @@ +git.sr.ht/~geb/opt v0.0.0-20220627180516-52214b5b84a1 h1:bmje0IdPzrY5nX6fAx8KuHP5G8EP4XMedMFcrssfJXc= +git.sr.ht/~geb/opt v0.0.0-20220627180516-52214b5b84a1/go.mod h1:T5QFtG9s8i/kW5pDVCke6Mt2WmElJCIfTL1HMdpP7Rk= +github.com/bendahl/uinput v1.6.0 h1:fM6r3OSC17rHh758mizKjSBuqi+XinhiGd4N3pWvZiI= +github.com/bendahl/uinput v1.6.0/go.mod h1:Np7w3DINc9wB83p12fTAM3DPPhFnAKP0WTXRqCQJ6Z8= diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..8b8bc86 --- /dev/null +++ b/install.sh @@ -0,0 +1,2 @@ +#!/bin/sh +go build && cp dotool dotoolc dotoold /usr/local/bin diff --git a/keys.go b/keys.go new file mode 100644 index 0000000..ddb81fa --- /dev/null +++ b/keys.go @@ -0,0 +1,598 @@ +package main + +import "github.com/bendahl/uinput" + +var runeChords = map[rune]Chord{ + 'a': Chord{Key: uinput.KeyA}, + 'b': Chord{Key: uinput.KeyB}, + 'c': Chord{Key: uinput.KeyC}, + 'd': Chord{Key: uinput.KeyD}, + 'e': Chord{Key: uinput.KeyE}, + 'f': Chord{Key: uinput.KeyF}, + 'g': Chord{Key: uinput.KeyG}, + 'h': Chord{Key: uinput.KeyH}, + 'i': Chord{Key: uinput.KeyI}, + 'j': Chord{Key: uinput.KeyJ}, + 'k': Chord{Key: uinput.KeyK}, + 'l': Chord{Key: uinput.KeyL}, + 'm': Chord{Key: uinput.KeyM}, + 'n': Chord{Key: uinput.KeyN}, + 'o': Chord{Key: uinput.KeyO}, + 'p': Chord{Key: uinput.KeyP}, + 'q': Chord{Key: uinput.KeyQ}, + 'r': Chord{Key: uinput.KeyR}, + 's': Chord{Key: uinput.KeyS}, + 't': Chord{Key: uinput.KeyT}, + 'u': Chord{Key: uinput.KeyU}, + 'v': Chord{Key: uinput.KeyV}, + 'w': Chord{Key: uinput.KeyW}, + 'x': Chord{Key: uinput.KeyX}, + 'y': Chord{Key: uinput.KeyY}, + 'z': Chord{Key: uinput.KeyZ}, + '1': Chord{Key: uinput.Key1}, + '!': Chord{Key: uinput.Key1, Shift: true}, + '2': Chord{Key: uinput.Key2}, + '@': Chord{Key: uinput.Key2, Shift: true}, + '3': Chord{Key: uinput.Key3}, + '#': Chord{Key: uinput.Key3, Shift: true}, + '4': Chord{Key: uinput.Key4}, + '$': Chord{Key: uinput.Key4, Shift: true}, + '5': Chord{Key: uinput.Key5}, + '%': Chord{Key: uinput.Key5, Shift: true}, + '6': Chord{Key: uinput.Key6}, + '^': Chord{Key: uinput.Key6, Shift: true}, + '7': Chord{Key: uinput.Key7}, + '&': Chord{Key: uinput.Key7, Shift: true}, + '8': Chord{Key: uinput.Key8}, + '*': Chord{Key: uinput.Key8, Shift: true}, + '9': Chord{Key: uinput.Key9}, + '(': Chord{Key: uinput.Key9, Shift: true}, + '0': Chord{Key: uinput.Key0}, + ')': Chord{Key: uinput.Key0, Shift: true}, + '`': Chord{Key: uinput.KeyGrave}, + '~': Chord{Key: uinput.KeyGrave, Shift: true}, + '-': Chord{Key: uinput.KeyMinus}, + '_': Chord{Key: uinput.KeyMinus, Shift: true}, + '=': Chord{Key: uinput.KeyEqual}, + '+': Chord{Key: uinput.KeyEqual, Shift: true}, + '[': Chord{Key: uinput.KeyLeftbrace}, + '{': Chord{Key: uinput.KeyLeftbrace, Shift: true}, + '}': Chord{Key: uinput.KeyRightbrace}, + ']': Chord{Key: uinput.KeyRightbrace, Shift: true}, + '\\': Chord{Key: uinput.KeyBackslash}, + '|': Chord{Key: uinput.KeyBackslash, Shift: true}, + ';': Chord{Key: uinput.KeySemicolon}, + ':': Chord{Key: uinput.KeySemicolon, Shift: true}, + '\'':Chord{Key: uinput.KeyApostrophe}, + '"': Chord{Key: uinput.KeyApostrophe, Shift: true}, + ',': Chord{Key: uinput.KeyComma}, + '<': Chord{Key: uinput.KeyComma, Shift: true}, + '.': Chord{Key: uinput.KeyDot}, + '>': Chord{Key: uinput.KeyDot, Shift: true}, + '/': Chord{Key: uinput.KeySlash}, + '?': Chord{Key: uinput.KeySlash, Shift: true}, + ' ': Chord{Key: uinput.KeySpace}, + '\t': Chord{Key: uinput.KeyTab}, +} + +// generated with: +// go doc uinput.keyesc | sed '/Key/ !d; s/Key\(\S*\).*/"\L\1\E": uinput.Key\1,/' +var linuxKeys = map[string]int{ + "esc": uinput.KeyEsc, + "1": uinput.Key1, + "2": uinput.Key2, + "3": uinput.Key3, + "4": uinput.Key4, + "5": uinput.Key5, + "6": uinput.Key6, + "7": uinput.Key7, + "8": uinput.Key8, + "9": uinput.Key9, + "0": uinput.Key0, + "minus": uinput.KeyMinus, + "equal": uinput.KeyEqual, + "backspace": uinput.KeyBackspace, + "tab": uinput.KeyTab, + "q": uinput.KeyQ, + "w": uinput.KeyW, + "e": uinput.KeyE, + "r": uinput.KeyR, + "t": uinput.KeyT, + "y": uinput.KeyY, + "u": uinput.KeyU, + "i": uinput.KeyI, + "o": uinput.KeyO, + "p": uinput.KeyP, + "leftbrace": uinput.KeyLeftbrace, + "rightbrace": uinput.KeyRightbrace, + "enter": uinput.KeyEnter, + "leftctrl": uinput.KeyLeftctrl, + "a": uinput.KeyA, + "s": uinput.KeyS, + "d": uinput.KeyD, + "f": uinput.KeyF, + "g": uinput.KeyG, + "h": uinput.KeyH, + "j": uinput.KeyJ, + "k": uinput.KeyK, + "l": uinput.KeyL, + "semicolon": uinput.KeySemicolon, + "apostrophe": uinput.KeyApostrophe, + "grave": uinput.KeyGrave, + "leftshift": uinput.KeyLeftshift, + "backslash": uinput.KeyBackslash, + "z": uinput.KeyZ, + "x": uinput.KeyX, + "c": uinput.KeyC, + "v": uinput.KeyV, + "b": uinput.KeyB, + "n": uinput.KeyN, + "m": uinput.KeyM, + "comma": uinput.KeyComma, + "dot": uinput.KeyDot, + "slash": uinput.KeySlash, + "rightshift": uinput.KeyRightshift, + "kpasterisk": uinput.KeyKpasterisk, + "leftalt": uinput.KeyLeftalt, + "space": uinput.KeySpace, + "capslock": uinput.KeyCapslock, + "f1": uinput.KeyF1, + "f2": uinput.KeyF2, + "f3": uinput.KeyF3, + "f4": uinput.KeyF4, + "f5": uinput.KeyF5, + "f6": uinput.KeyF6, + "f7": uinput.KeyF7, + "f8": uinput.KeyF8, + "f9": uinput.KeyF9, + "f10": uinput.KeyF10, + "numlock": uinput.KeyNumlock, + "scrolllock": uinput.KeyScrolllock, + "kp7": uinput.KeyKp7, + "kp8": uinput.KeyKp8, + "kp9": uinput.KeyKp9, + "kpminus": uinput.KeyKpminus, + "kp4": uinput.KeyKp4, + "kp5": uinput.KeyKp5, + "kp6": uinput.KeyKp6, + "kpplus": uinput.KeyKpplus, + "kp1": uinput.KeyKp1, + "kp2": uinput.KeyKp2, + "kp3": uinput.KeyKp3, + "kp0": uinput.KeyKp0, + "kpdot": uinput.KeyKpdot, + "zenkakuhankaku": uinput.KeyZenkakuhankaku, + "102nd": uinput.Key102Nd, + "f11": uinput.KeyF11, + "f12": uinput.KeyF12, + "ro": uinput.KeyRo, + "katakana": uinput.KeyKatakana, + "hiragana": uinput.KeyHiragana, + "henkan": uinput.KeyHenkan, + "katakanahiragana": uinput.KeyKatakanahiragana, + "muhenkan": uinput.KeyMuhenkan, + "kpjpcomma": uinput.KeyKpjpcomma, + "kpenter": uinput.KeyKpenter, + "rightctrl": uinput.KeyRightctrl, + "kpslash": uinput.KeyKpslash, + "sysrq": uinput.KeySysrq, + "rightalt": uinput.KeyRightalt, + "linefeed": uinput.KeyLinefeed, + "home": uinput.KeyHome, + "up": uinput.KeyUp, + "pageup": uinput.KeyPageup, + "left": uinput.KeyLeft, + "right": uinput.KeyRight, + "end": uinput.KeyEnd, + "down": uinput.KeyDown, + "pagedown": uinput.KeyPagedown, + "insert": uinput.KeyInsert, + "delete": uinput.KeyDelete, + "macro": uinput.KeyMacro, + "mute": uinput.KeyMute, + "volumedown": uinput.KeyVolumedown, + "volumeup": uinput.KeyVolumeup, + "power": uinput.KeyPower, + "kpequal": uinput.KeyKpequal, + "kpplusminus": uinput.KeyKpplusminus, + "pause": uinput.KeyPause, + "scale": uinput.KeyScale, + "kpcomma": uinput.KeyKpcomma, + "hangeul": uinput.KeyHangeul, + "hanja": uinput.KeyHanja, + "yen": uinput.KeyYen, + "leftmeta": uinput.KeyLeftmeta, + "rightmeta": uinput.KeyRightmeta, + "compose": uinput.KeyCompose, + "stop": uinput.KeyStop, + "again": uinput.KeyAgain, + "props": uinput.KeyProps, + "undo": uinput.KeyUndo, + "front": uinput.KeyFront, + "copy": uinput.KeyCopy, + "open": uinput.KeyOpen, + "paste": uinput.KeyPaste, + "find": uinput.KeyFind, + "cut": uinput.KeyCut, + "help": uinput.KeyHelp, + "menu": uinput.KeyMenu, + "calc": uinput.KeyCalc, + "setup": uinput.KeySetup, + "sleep": uinput.KeySleep, + "wakeup": uinput.KeyWakeup, + "file": uinput.KeyFile, + "sendfile": uinput.KeySendfile, + "deletefile": uinput.KeyDeletefile, + "xfer": uinput.KeyXfer, + "prog1": uinput.KeyProg1, + "prog2": uinput.KeyProg2, + "www": uinput.KeyWww, + "msdos": uinput.KeyMsdos, + "coffee": uinput.KeyCoffee, + "direction": uinput.KeyDirection, + "cyclewindows": uinput.KeyCyclewindows, + "mail": uinput.KeyMail, + "bookmarks": uinput.KeyBookmarks, + "computer": uinput.KeyComputer, + "back": uinput.KeyBack, + "forward": uinput.KeyForward, + "closecd": uinput.KeyClosecd, + "ejectcd": uinput.KeyEjectcd, + "ejectclosecd": uinput.KeyEjectclosecd, + "nextsong": uinput.KeyNextsong, + "playpause": uinput.KeyPlaypause, + "previoussong": uinput.KeyPrevioussong, + "stopcd": uinput.KeyStopcd, + "record": uinput.KeyRecord, + "rewind": uinput.KeyRewind, + "phone": uinput.KeyPhone, + "iso": uinput.KeyIso, + "config": uinput.KeyConfig, + "homepage": uinput.KeyHomepage, + "refresh": uinput.KeyRefresh, + "exit": uinput.KeyExit, + "move": uinput.KeyMove, + "edit": uinput.KeyEdit, + "scrollup": uinput.KeyScrollup, + "scrolldown": uinput.KeyScrolldown, + "kpleftparen": uinput.KeyKpleftparen, + "kprightparen": uinput.KeyKprightparen, + "new": uinput.KeyNew, + "redo": uinput.KeyRedo, + "f13": uinput.KeyF13, + "f14": uinput.KeyF14, + "f15": uinput.KeyF15, + "f16": uinput.KeyF16, + "f17": uinput.KeyF17, + "f18": uinput.KeyF18, + "f19": uinput.KeyF19, + "f20": uinput.KeyF20, + "f21": uinput.KeyF21, + "f22": uinput.KeyF22, + "f23": uinput.KeyF23, + "f24": uinput.KeyF24, + "playcd": uinput.KeyPlaycd, + "pausecd": uinput.KeyPausecd, + "prog3": uinput.KeyProg3, + "prog4": uinput.KeyProg4, + "dashboard": uinput.KeyDashboard, + "suspend": uinput.KeySuspend, + "close": uinput.KeyClose, + "play": uinput.KeyPlay, + "fastforward": uinput.KeyFastforward, + "bassboost": uinput.KeyBassboost, + "print": uinput.KeyPrint, + "hp": uinput.KeyHp, + "camera": uinput.KeyCamera, + "sound": uinput.KeySound, + "question": uinput.KeyQuestion, + "email": uinput.KeyEmail, + "chat": uinput.KeyChat, + "search": uinput.KeySearch, + "connect": uinput.KeyConnect, + "finance": uinput.KeyFinance, + "sport": uinput.KeySport, + "shop": uinput.KeyShop, + "alterase": uinput.KeyAlterase, + "cancel": uinput.KeyCancel, + "brightnessdown": uinput.KeyBrightnessdown, + "brightnessup": uinput.KeyBrightnessup, + "media": uinput.KeyMedia, + "switchvideomode": uinput.KeySwitchvideomode, + "kbdillumtoggle": uinput.KeyKbdillumtoggle, + "kbdillumdown": uinput.KeyKbdillumdown, + "kbdillumup": uinput.KeyKbdillumup, + "send": uinput.KeySend, + "reply": uinput.KeyReply, + "forwardmail": uinput.KeyForwardmail, + "save": uinput.KeySave, + "documents": uinput.KeyDocuments, + "battery": uinput.KeyBattery, + "bluetooth": uinput.KeyBluetooth, + "wlan": uinput.KeyWlan, + "uwb": uinput.KeyUwb, + "unknown": uinput.KeyUnknown, + "videonext": uinput.KeyVideoNext, + "videoprev": uinput.KeyVideoPrev, + "brightnesscycle": uinput.KeyBrightnessCycle, + "brightnesszero": uinput.KeyBrightnessZero, + "displayoff": uinput.KeyDisplayOff, + "wimax": uinput.KeyWimax, + "rfkill": uinput.KeyRfkill, + "micmute": uinput.KeyMicmute, +} + +// generated by ./xkeys.bash +var xKeysNormal = map[string]int{ + "escape": uinput.KeyEsc, + "1": uinput.Key1, + "2": uinput.Key2, + "3": uinput.Key3, + "4": uinput.Key4, + "5": uinput.Key5, + "6": uinput.Key6, + "7": uinput.Key7, + "8": uinput.Key8, + "9": uinput.Key9, + "0": uinput.Key0, + "minus": uinput.KeyMinus, + "equal": uinput.KeyEqual, + "backspace": uinput.KeyBackspace, + "tab": uinput.KeyTab, + "q": uinput.KeyQ, + "w": uinput.KeyW, + "e": uinput.KeyE, + "r": uinput.KeyR, + "t": uinput.KeyT, + "y": uinput.KeyY, + "u": uinput.KeyU, + "i": uinput.KeyI, + "o": uinput.KeyO, + "p": uinput.KeyP, + "bracketleft": uinput.KeyLeftbrace, + "bracketright": uinput.KeyRightbrace, + "return": uinput.KeyEnter, + "control_l": uinput.KeyLeftctrl, + "a": uinput.KeyA, + "s": uinput.KeyS, + "d": uinput.KeyD, + "f": uinput.KeyF, + "g": uinput.KeyG, + "h": uinput.KeyH, + "j": uinput.KeyJ, + "k": uinput.KeyK, + "l": uinput.KeyL, + "semicolon": uinput.KeySemicolon, + "apostrophe": uinput.KeyApostrophe, + "grave": uinput.KeyGrave, + "shift_l": uinput.KeyLeftshift, + "backslash": uinput.KeyBackslash, + "z": uinput.KeyZ, + "x": uinput.KeyX, + "c": uinput.KeyC, + "v": uinput.KeyV, + "b": uinput.KeyB, + "n": uinput.KeyN, + "m": uinput.KeyM, + "comma": uinput.KeyComma, + "period": uinput.KeyDot, + "slash": uinput.KeySlash, + "shift_r": uinput.KeyRightshift, + "kp_multiply": uinput.KeyKpasterisk, + "alt_l": uinput.KeyLeftalt, + "space": uinput.KeySpace, + "caps_lock": uinput.KeyCapslock, + "f1": uinput.KeyF1, + "f2": uinput.KeyF2, + "f3": uinput.KeyF3, + "f4": uinput.KeyF4, + "f5": uinput.KeyF5, + "f6": uinput.KeyF6, + "f7": uinput.KeyF7, + "f8": uinput.KeyF8, + "f9": uinput.KeyF9, + "f10": uinput.KeyF10, + "num_lock": uinput.KeyNumlock, + "scroll_lock": uinput.KeyScrolllock, + "kp_home": uinput.KeyKp7, + "kp_up": uinput.KeyKp8, + "kp_prior": uinput.KeyKp9, + "kp_subtract": uinput.KeyKpminus, + "kp_left": uinput.KeyKp4, + "kp_begin": uinput.KeyKp5, + "kp_right": uinput.KeyKp6, + "kp_add": uinput.KeyKpplus, + "kp_end": uinput.KeyKp1, + "kp_down": uinput.KeyKp2, + "kp_next": uinput.KeyKp3, + "kp_insert": uinput.KeyKp0, + "kp_delete": uinput.KeyKpdot, + "iso_level3_shift": uinput.KeyZenkakuhankaku, + "less": uinput.Key102Nd, + "f11": uinput.KeyF11, + "f12": uinput.KeyF12, + "katakana": uinput.KeyKatakana, + "hiragana": uinput.KeyHiragana, + "henkan_mode": uinput.KeyHenkan, + "hiragana_katakana": uinput.KeyKatakanahiragana, + "muhenkan": uinput.KeyMuhenkan, + "kp_enter": uinput.KeyKpenter, + "control_r": uinput.KeyRightctrl, + "kp_divide": uinput.KeyKpslash, + "alt_r": uinput.KeyRightalt, + "linefeed": uinput.KeyLinefeed, + "home": uinput.KeyHome, + "up": uinput.KeyUp, + "prior": uinput.KeyPageup, + "left": uinput.KeyLeft, + "right": uinput.KeyRight, + "end": uinput.KeyEnd, + "down": uinput.KeyDown, + "next": uinput.KeyPagedown, + "insert": uinput.KeyInsert, + "delete": uinput.KeyDelete, + "xf86audiomute": uinput.KeyMute, + "xf86audiolowervolume": uinput.KeyVolumedown, + "xf86audioraisevolume": uinput.KeyVolumeup, + "xf86poweroff": uinput.KeyPower, + "kp_equal": uinput.KeyKpequal, + "plusminus": uinput.KeyKpplusminus, + "pause": uinput.KeyPause, + "xf86launcha": uinput.KeyScale, + "kp_decimal": uinput.KeyKpcomma, + "hangul": uinput.KeyHangeul, + "hangul_hanja": uinput.KeyHanja, + "super_l": uinput.KeyLeftmeta, + "super_r": uinput.KeyRightmeta, + "menu": uinput.KeyCompose, + "redo": uinput.KeyAgain, + "sunprops": uinput.KeyProps, + "undo": uinput.KeyUndo, + "sunfront": uinput.KeyFront, + "xf86copy": uinput.KeyCopy, + "xf86open": uinput.KeyOpen, + "xf86paste": uinput.KeyPaste, + "find": uinput.KeyFind, + "xf86cut": uinput.KeyCut, + "help": uinput.KeyHelp, + "xf86menukb": uinput.KeyMenu, + "xf86calculator": uinput.KeyCalc, + "xf86sleep": uinput.KeySleep, + "xf86wakeup": uinput.KeyWakeup, + "xf86explorer": uinput.KeyFile, + "xf86xfer": uinput.KeyXfer, + "xf86launch1": uinput.KeyProg1, + "xf86launch2": uinput.KeyProg2, + "xf86www": uinput.KeyWww, + "xf86dos": uinput.KeyMsdos, + "xf86screensaver": uinput.KeyCoffee, + "xf86rotatewindows": uinput.KeyDirection, + "xf86taskpane": uinput.KeyCyclewindows, + "xf86mail": uinput.KeyMail, + "xf86favorites": uinput.KeyBookmarks, + "xf86mycomputer": uinput.KeyComputer, + "xf86back": uinput.KeyBack, + "xf86forward": uinput.KeyForward, + "xf86eject": uinput.KeyEjectcd, + "xf86audionext": uinput.KeyNextsong, + "xf86audioplay": uinput.KeyPlaypause, + "xf86audioprev": uinput.KeyPrevioussong, + "xf86audiostop": uinput.KeyStopcd, + "xf86audiorecord": uinput.KeyRecord, + "xf86audiorewind": uinput.KeyRewind, + "xf86phone": uinput.KeyPhone, + "xf86messenger": uinput.KeyChat, + "xf86search": uinput.KeySearch, + "xf86go": uinput.KeyConnect, + "xf86finance": uinput.KeyFinance, + "xf86game": uinput.KeySport, + "xf86shop": uinput.KeyShop, + "cancel": uinput.KeyCancel, + "xf86monbrightnessdown": uinput.KeyBrightnessdown, + "xf86monbrightnessup": uinput.KeyBrightnessup, + "xf86audiomedia": uinput.KeyMedia, + "xf86display": uinput.KeySwitchvideomode, + "xf86kbdlightonoff": uinput.KeyKbdillumtoggle, + "xf86kbdbrightnessdown": uinput.KeyKbdillumdown, + "xf86kbdbrightnessup": uinput.KeyKbdillumup, + "xf86send": uinput.KeySend, + "xf86reply": uinput.KeyReply, + "xf86mailforward": uinput.KeyForwardmail, + "xf86save": uinput.KeySave, + "xf86documents": uinput.KeyDocuments, + "xf86battery": uinput.KeyBattery, + "xf86bluetooth": uinput.KeyBluetooth, + "xf86wlan": uinput.KeyWlan, + "xf86uwb": uinput.KeyUwb, + "xf86next_vmode": uinput.KeyVideoNext, + "xf86prev_vmode": uinput.KeyVideoPrev, + "xf86monbrightnesscycle": uinput.KeyBrightnessCycle, + "xf86brightnessauto": uinput.KeyBrightnessZero, + "xf86displayoff": uinput.KeyDisplayOff, + "xf86wwan": uinput.KeyWimax, + "xf86rfkill": uinput.KeyRfkill, + "xf86webcam": uinput.KeyCamera, + "print": uinput.KeyPrint, +} + +var xKeysShifted = map[string]int{ + "exclam": uinput.Key1, + "at": uinput.Key2, + "numbersign": uinput.Key3, + "dollar": uinput.Key4, + "percent": uinput.Key5, + "asciicircum": uinput.Key6, + "ampersand": uinput.Key7, + "asterisk": uinput.Key8, + "parenleft": uinput.Key9, + "parenright": uinput.Key0, + "underscore": uinput.KeyMinus, + "plus": uinput.KeyEqual, + "backspace": uinput.KeyBackspace, + "iso_left_tab": uinput.KeyTab, + "q": uinput.KeyQ, + "w": uinput.KeyW, + "e": uinput.KeyE, + "r": uinput.KeyR, + "t": uinput.KeyT, + "y": uinput.KeyY, + "u": uinput.KeyU, + "i": uinput.KeyI, + "o": uinput.KeyO, + "p": uinput.KeyP, + "braceleft": uinput.KeyLeftbrace, + "braceright": uinput.KeyRightbrace, + "a": uinput.KeyA, + "s": uinput.KeyS, + "d": uinput.KeyD, + "f": uinput.KeyF, + "g": uinput.KeyG, + "h": uinput.KeyH, + "j": uinput.KeyJ, + "k": uinput.KeyK, + "l": uinput.KeyL, + "colon": uinput.KeySemicolon, + "quotedbl": uinput.KeyApostrophe, + "asciitilde": uinput.KeyGrave, + "bar": uinput.KeyBackslash, + "z": uinput.KeyZ, + "x": uinput.KeyX, + "c": uinput.KeyC, + "v": uinput.KeyV, + "b": uinput.KeyB, + "n": uinput.KeyN, + "m": uinput.KeyM, + "less": uinput.KeyComma, + "greater": uinput.KeyDot, + "question": uinput.KeySlash, + "kp_multiply": uinput.KeyKpasterisk, + "f1": uinput.KeyF1, + "f2": uinput.KeyF2, + "f3": uinput.KeyF3, + "f4": uinput.KeyF4, + "f5": uinput.KeyF5, + "f6": uinput.KeyF6, + "f7": uinput.KeyF7, + "f8": uinput.KeyF8, + "f9": uinput.KeyF9, + "f10": uinput.KeyF10, + "kp_7": uinput.KeyKp7, + "kp_8": uinput.KeyKp8, + "kp_9": uinput.KeyKp9, + "kp_subtract": uinput.KeyKpminus, + "kp_4": uinput.KeyKp4, + "kp_5": uinput.KeyKp5, + "kp_6": uinput.KeyKp6, + "kp_add": uinput.KeyKpplus, + "kp_1": uinput.KeyKp1, + "kp_2": uinput.KeyKp2, + "kp_3": uinput.KeyKp3, + "kp_0": uinput.KeyKp0, + "kp_decimal": uinput.KeyKpdot, + "f11": uinput.KeyF11, + "f12": uinput.KeyF12, + "kp_divide": uinput.KeyKpslash, + "sys_req": uinput.KeySysrq, + "break": uinput.KeyPause, + "xf86audiopause": uinput.KeyPrevioussong, +} diff --git a/xkeys.bash b/xkeys.bash new file mode 100755 index 0000000..eb8766e --- /dev/null +++ b/xkeys.bash @@ -0,0 +1,42 @@ +#!/bin/bash + +align() { + sed '/\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d + /\/ d' +} + +echo 'var xKeysNormal = map[string]int{' +{ + paste -d ' ' <(xmodmap -pke | sed '1 d; s/.*= /"/; /.*=/ d; s/ .*/":/' | sed '/^"XF86Eject"/ { N; s/.*\n// }') \ + <(go doc uinput.keyesc | sed '/Key/ !d; s/^\s*/uinput./; s/ .*/,/' | align) | + # Skip really non-matching section, we echo some of them below + sed '/^"XF86Tools"/,/^"XF86AudioPreset"/ d' | + # Remove duplicate keys + sed '/^"XF86Mail":.*Email/ d; /^"Cancel":.*Stop/ d; /^"XF86Send":.*file/ d; /^"Print":.*Sysrq/ d' + + echo '"XF86WebCam": uinput.KeyCamera,' + echo '"Print": uinput.KeyPrint,' +} | sed 's/^".*"/\L&/; s/^/\t/' +echo '}' + +echo '' +echo 'var xKeysShifted = map[string]int{' +{ + paste -d ' ' <(xmodmap -pke | sed '1 d; s/.*= /"/; /.*=/ d; s/\S* /"/; s/ .*/":/' | sed '/^"XF86Eject"/ { N; s/.*\n// }') \ + <(go doc uinput.keyesc | sed '/Key/ !d; s/^\s*/uinput./; s/ .*/,/' | align) | sed '/^"NoSymbol"/ d; /^\S*_[LR]"/ d' | + # Remove duplicate keys + sed '/^"KP_Decimal":.*Kpcomma/ d; /\/ d' +} | sed 's/^".*"/\L&/; s/^/\t/' +echo '}'