pax_global_header00006660000000000000000000000064136403711420014513gustar00rootroot0000000000000052 comment=6388a49e0f431d6d5fcbd152b8ae4fa8e87884ee wshowkeys-1.0/000077500000000000000000000000001364037114200134165ustar00rootroot00000000000000wshowkeys-1.0/.gitignore000066400000000000000000000000061364037114200154020ustar00rootroot00000000000000build wshowkeys-1.0/LICENSE000066400000000000000000001045151364037114200144310ustar00rootroot00000000000000 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 . wshowkeys-1.0/README.md000066400000000000000000000021201364037114200146700ustar00rootroot00000000000000# wshowkeys Displays keypresses on screen on supported Wayland compositors (requires `wlr_layer_shell_v1` support). ![](https://sr.ht/xGs2.png) ## Installation Dependencies: - cairo - libinput - pango - udev - wayland - xkbcommon ``` $ meson build $ ninja -C build # ninja -C build install # chmod a+s /usr/bin/wshowkeys ``` wshowkeys must be configured as setuid during installation. It requires root permissions to read input events. These permissions are dropped after startup. ## Usage ``` wshowkeys [-b|-f|-s #RRGGBB[AA]] [-F font] [-t timeout] [-a top|left|right|bottom] [-m margin] [-o output] ``` - *-b #RRGGBB[AA]*: set background color - *-f #RRGGBB[AA]*: set foreground color - *-s #RRGGBB[AA]*: set color for special keys - *-F font*: set font (Pango format, e.g. 'monospace 24') - *-t timeout*: set timeout before clearing old keystrokes - *-a top|left|right|bottom*: anchor the keystrokes to an edge. May be specified twice. - *-m margin*: set a margin (in pixels) from the nearest edge - *-o output*: request wshowkeys is shown on the specified output (unimplemented) wshowkeys-1.0/devmgr.c000066400000000000000000000100071364037114200150440ustar00rootroot00000000000000/* * Portions of this file taken from wlroots; MIT licensed. Its purpose is to * run a child process as root for opening evdev devices. * * NOTICE: Most of this code runs as root. */ #ifdef __FreeBSD__ #define __BSD_VISIBLE 1 #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include "devmgr.h" enum msg_type { MSG_OPEN, MSG_END, }; struct msg { enum msg_type msg_type; char path[PATH_MAX]; }; static ssize_t recv_msg(int sock, int *fd_out, void *buf, size_t buf_len) { char control[CMSG_SPACE(sizeof(*fd_out))] = {0}; struct iovec iovec = { .iov_base = buf, .iov_len = buf_len }; struct msghdr msghdr = {0}; if (buf) { msghdr.msg_iov = &iovec; msghdr.msg_iovlen = 1; } if (fd_out) { msghdr.msg_control = &control; msghdr.msg_controllen = sizeof(control); } ssize_t ret; do { ret = recvmsg(sock, &msghdr, MSG_CMSG_CLOEXEC); } while (ret < 0 && errno == EINTR); if (fd_out) { struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msghdr); if (cmsg) { memcpy(fd_out, CMSG_DATA(cmsg), sizeof(*fd_out)); } else { *fd_out = -1; } } return ret; } static void send_msg(int sock, int fd, void *buf, size_t buf_len) { char control[CMSG_SPACE(sizeof(fd))] = {0}; struct iovec iovec = { .iov_base = buf, .iov_len = buf_len }; struct msghdr msghdr = {0}; if (buf) { msghdr.msg_iov = &iovec; msghdr.msg_iovlen = 1; } if (fd >= 0) { msghdr.msg_control = &control; msghdr.msg_controllen = sizeof(control); struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msghdr); *cmsg = (struct cmsghdr) { .cmsg_level = SOL_SOCKET, .cmsg_type = SCM_RIGHTS, .cmsg_len = CMSG_LEN(sizeof(fd)), }; memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd)); } ssize_t ret; do { ret = sendmsg(sock, &msghdr, 0); } while (ret < 0 && errno == EINTR); } static void devmgr_run(int sockfd, const char *devpath) { struct msg msg; int fdin = -1; bool running = true; while (running && recv_msg(sockfd, &fdin, &msg, sizeof(msg)) > 0) { switch (msg.msg_type) { case MSG_OPEN: errno = 0; if (strstr(msg.path, devpath) != msg.path) { /* Hackerman detected */ exit(1); } int fd = open(msg.path, O_RDONLY|O_CLOEXEC|O_NOCTTY|O_NONBLOCK); int ret = errno; send_msg(sockfd, ret ? -1 : fd, &ret, sizeof(ret)); if (fd >= 0) { close(fd); } break; case MSG_END: running = false; send_msg(sockfd, -1, NULL, 0); break; } } exit(0); } int devmgr_start(int *fd, pid_t *pid, const char *devpath) { if (geteuid() != 0) { fprintf(stderr, "wshowkeys needs to be setuid to read input events\n"); return 1; } int sock[2]; if (socketpair(AF_UNIX, SOCK_SEQPACKET, 0, sock) < 0) { fprintf(stderr, "devmgr: socketpair: %s", strerror(errno)); return -1; } pid_t child = fork(); if (child < 0) { fprintf(stderr, "devmgr: fork: %s", strerror(errno)); close(sock[0]); close(sock[1]); return 1; } else if (child == 0) { close(sock[0]); devmgr_run(sock[1], devpath); /* Does not return */ } close(sock[1]); *fd = sock[0]; *pid = child; if (setgid(getgid()) != 0) { fprintf(stderr, "devmgr: setgid: %s\n", strerror(errno)); return 1; } if (setuid(getuid()) != 0) { fprintf(stderr, "devmgr: setuid: %s\n", strerror(errno)); return 1; } if (setuid(0) != -1) { fprintf(stderr, "devmgr: failed to drop root\n"); return 1; } return 0; } int devmgr_open(int sockfd, const char *path) { struct msg msg = { .msg_type = MSG_OPEN }; snprintf(msg.path, sizeof(msg.path), "%s", path); send_msg(sockfd, -1, &msg, sizeof(msg)); int fd, err, ret; int retry = 0; do { ret = recv_msg(sockfd, &fd, &err, sizeof(err)); } while (ret == 0 && retry++ < 3); return err ? -err : fd; } void devmgr_finish(int sock, pid_t pid) { struct msg msg = { .msg_type = MSG_END }; send_msg(sock, -1, &msg, sizeof(msg)); recv_msg(sock, NULL, NULL, 0); waitpid(pid, NULL, 0); close(sock); } wshowkeys-1.0/devmgr.h000066400000000000000000000003011364037114200150450ustar00rootroot00000000000000#ifndef _DEVMGR_H #define _DEVMGR_H int devmgr_start(int *fd, pid_t *pid, const char *devpath); int devmgr_open(int sockfd, const char *path); void devmgr_finish(int sock, pid_t pid); #endif wshowkeys-1.0/main.c000066400000000000000000000461421364037114200145150ustar00rootroot00000000000000#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "devmgr.h" #include "shm.h" #include "pango.h" #include "wlr-layer-shell-unstable-v1-client-protocol.h" #include "xdg-output-unstable-v1-client-protocol.h" struct wsk_keypress { xkb_keysym_t sym; char name[128]; char utf8[128]; struct wsk_keypress *next; }; struct wsk_output { struct wl_output *output; int scale; enum wl_output_subpixel subpixel; struct wsk_output *next; }; struct wsk_state { int devmgr; pid_t devmgr_pid; struct udev *udev; struct libinput *libinput; uint32_t foreground, background, specialfg; const char *font; int timeout; struct wl_display *display; struct wl_registry *registry; struct wl_compositor *compositor; struct wl_shm *shm; struct wl_seat *seat; struct wl_keyboard *keyboard; struct zxdg_output_manager_v1 *output_mgr; struct zwlr_layer_shell_v1 *layer_shell; struct wl_surface *surface; struct zwlr_layer_surface_v1 *layer_surface; uint32_t width, height; bool frame_scheduled, dirty; struct pool_buffer buffers[2]; struct pool_buffer *current_buffer; struct wsk_output *output, *outputs; struct xkb_state *xkb_state; struct xkb_context *xkb_context; struct xkb_keymap *xkb_keymap; struct wsk_keypress *keys; struct timespec last_key; bool run; }; static void cairo_set_source_u32(cairo_t *cairo, uint32_t color) { cairo_set_source_rgba(cairo, (color >> (3*8) & 0xFF) / 255.0, (color >> (2*8) & 0xFF) / 255.0, (color >> (1*8) & 0xFF) / 255.0, (color >> (0*8) & 0xFF) / 255.0); } static cairo_subpixel_order_t to_cairo_subpixel_order( enum wl_output_subpixel subpixel) { switch (subpixel) { case WL_OUTPUT_SUBPIXEL_HORIZONTAL_RGB: return CAIRO_SUBPIXEL_ORDER_RGB; case WL_OUTPUT_SUBPIXEL_HORIZONTAL_BGR: return CAIRO_SUBPIXEL_ORDER_BGR; case WL_OUTPUT_SUBPIXEL_VERTICAL_RGB: return CAIRO_SUBPIXEL_ORDER_VRGB; case WL_OUTPUT_SUBPIXEL_VERTICAL_BGR: return CAIRO_SUBPIXEL_ORDER_VBGR; default: return CAIRO_SUBPIXEL_ORDER_DEFAULT; } return CAIRO_SUBPIXEL_ORDER_DEFAULT; } static void render_to_cairo(cairo_t *cairo, struct wsk_state *state, int scale, uint32_t *width, uint32_t *height) { cairo_set_operator(cairo, CAIRO_OPERATOR_SOURCE); cairo_set_source_u32(cairo, state->background); cairo_paint(cairo); struct wsk_keypress *key = state->keys; while (key) { bool special = false; const char *name = key->utf8; if (!name[0]) { special = true; cairo_set_source_u32(cairo, state->specialfg); name = key->name; } else { cairo_set_source_u32(cairo, state->foreground); } cairo_move_to(cairo, *width, 0); int w, h; if (special) { get_text_size(cairo, state->font, &w, &h, NULL, scale, "%s+", name); pango_printf(cairo, state->font, scale, "%s+", name); } else { get_text_size(cairo, state->font, &w, &h, NULL, scale, "%s", name); pango_printf(cairo, state->font, scale, "%s", name); } *width = *width + w; if ((int)*height < h) { *height = h; } key = key->next; } } static void render_frame(struct wsk_state *state) { cairo_surface_t *recorder = cairo_recording_surface_create( CAIRO_CONTENT_COLOR_ALPHA, NULL); cairo_t *cairo = cairo_create(recorder); cairo_set_antialias(cairo, CAIRO_ANTIALIAS_BEST); cairo_font_options_t *fo = cairo_font_options_create(); cairo_font_options_set_hint_style(fo, CAIRO_HINT_STYLE_FULL); cairo_font_options_set_antialias(fo, CAIRO_ANTIALIAS_SUBPIXEL); if (state->output) { cairo_font_options_set_subpixel_order( fo, to_cairo_subpixel_order(state->output->subpixel)); } cairo_set_font_options(cairo, fo); cairo_font_options_destroy(fo); cairo_save(cairo); cairo_set_operator(cairo, CAIRO_OPERATOR_CLEAR); cairo_paint(cairo); cairo_restore(cairo); int scale = state->output ? state->output->scale : 1; uint32_t width = 0, height = 0; render_to_cairo(cairo, state, scale, &width, &height); if (height / scale != state->height || width / scale != state->width || state->width == 0) { // Reconfigure surface if (width == 0 || height == 0) { wl_surface_attach(state->surface, NULL, 0, 0); } else { zwlr_layer_surface_v1_set_size( state->layer_surface, width / scale, height / scale); } // TODO: this could infinite loop if the compositor assigns us a // different height than what we asked for wl_surface_commit(state->surface); } else if (height > 0) { // Replay recording into shm and send it off state->current_buffer = get_next_buffer(state->shm, state->buffers, state->width * scale, state->height * scale); if (!state->current_buffer) { cairo_surface_destroy(recorder); cairo_destroy(cairo); return; } cairo_t *shm = state->current_buffer->cairo; cairo_save(shm); cairo_set_operator(shm, CAIRO_OPERATOR_CLEAR); cairo_paint(shm); cairo_restore(shm); cairo_set_source_surface(shm, recorder, 0.0, 0.0); cairo_paint(shm); wl_surface_set_buffer_scale(state->surface, scale); wl_surface_attach(state->surface, state->current_buffer->buffer, 0, 0); wl_surface_damage_buffer(state->surface, 0, 0, state->width, state->height); wl_surface_commit(state->surface); } } static void set_dirty(struct wsk_state *state) { if (state->frame_scheduled) { state->dirty = true; } else if (state->surface) { render_frame(state); } } static void layer_surface_configure(void *data, struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1, uint32_t serial, uint32_t width, uint32_t height) { struct wsk_state *state = data; state->width = width; state->height = height; zwlr_layer_surface_v1_ack_configure(zwlr_layer_surface_v1, serial); set_dirty(state); } static void layer_surface_closed(void *data, struct zwlr_layer_surface_v1 *zwlr_layer_surface_v1) { struct wsk_state *state = data; state->run = false; } static const struct zwlr_layer_surface_v1_listener layer_surface_listener = { .configure = layer_surface_configure, .closed = layer_surface_closed, }; static void surface_enter(void *data, struct wl_surface *wl_surface, struct wl_output *output) { struct wsk_state *state = data; struct wsk_output *wsk_output = state->outputs; while (wsk_output->output != output) { wsk_output = wsk_output->next; } state->output = wsk_output; } static void surface_leave(void *data, struct wl_surface *wl_surface, struct wl_output *output) { // Who cares (not really possible with layer shell) } static const struct wl_surface_listener wl_surface_listener = { .enter = surface_enter, .leave = surface_leave, }; static void keyboard_keymap(void *data, struct wl_keyboard *wl_keyboard, uint32_t format, int32_t fd, uint32_t size) { struct wsk_state *state = data; char *map_shm = mmap(NULL, size, PROT_READ, MAP_SHARED, fd, 0); if (map_shm == MAP_FAILED) { close(fd); fprintf(stderr, "Unable to mmap keymap: %s", strerror(errno)); return; } if (format != WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1) { munmap(map_shm, size); close(fd); return; } struct xkb_keymap *keymap = xkb_keymap_new_from_string( state->xkb_context, map_shm, XKB_KEYMAP_FORMAT_TEXT_V1, XKB_KEYMAP_COMPILE_NO_FLAGS); munmap(map_shm, size); close(fd); struct xkb_state *xkb_state = xkb_state_new(keymap); xkb_keymap_unref(state->xkb_keymap); xkb_state_unref(state->xkb_state); state->xkb_keymap = keymap; state->xkb_state = xkb_state; } static void keyboard_enter(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, struct wl_surface *surface, struct wl_array *keys) { // Who cares } static void keyboard_leave(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, struct wl_surface *surface) { // Who cares } static void keyboard_key(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, uint32_t time, uint32_t key, uint32_t state) { // Who cares } static void keyboard_modifiers(void *data, struct wl_keyboard *wl_keyboard, uint32_t serial, uint32_t mods_depressed, uint32_t mods_latched, uint32_t mods_locked, uint32_t group) { // Who cares } static void keyboard_repeat_info(void *data, struct wl_keyboard *wl_keyboard, int32_t rate, int32_t delay) { // TODO } static const struct wl_keyboard_listener wl_keyboard_listener = { .keymap = keyboard_keymap, .enter = keyboard_enter, .leave = keyboard_leave, .key = keyboard_key, .modifiers = keyboard_modifiers, .repeat_info = keyboard_repeat_info, }; static void seat_capabilities( void *data, struct wl_seat *wl_seat, uint32_t capabilities) { struct wsk_state *state = data; if (state->keyboard) { // TODO: support multiple seats return; } if (!(capabilities & WL_SEAT_CAPABILITY_KEYBOARD)) { fprintf(stderr, "wl_seat does not support keyboard"); state->run = false; return; } state->keyboard = wl_seat_get_keyboard(wl_seat); wl_keyboard_add_listener(state->keyboard, &wl_keyboard_listener, state); } static void seat_name(void *data, struct wl_seat *wl_seat, const char *name) { struct wsk_state *state = data; /* TODO: support multiple seats */ if (libinput_udev_assign_seat(state->libinput, "seat0") != 0) { fprintf(stderr, "Failed to assign libinput seat\n"); state->run = false; return; } } static const struct wl_seat_listener wl_seat_listener = { .capabilities = seat_capabilities, .name = seat_name, }; static void output_geometry(void *data, struct wl_output *wl_output, int32_t x, int32_t y, int32_t physical_width, int32_t physical_height, int32_t subpixel, const char *make, const char *model, int32_t transform) { struct wsk_output *output = data; output->subpixel = subpixel; } static void output_mode(void *data, struct wl_output *wl_output, uint32_t flags, int32_t width, int32_t height, int32_t refresh) { // Who cares } static void output_done(void *data, struct wl_output *wl_output) { // Who cares } static void output_scale(void *data, struct wl_output *wl_output, int32_t factor) { struct wsk_output *output = data; output->scale = factor; } static const struct wl_output_listener wl_output_listener = { .geometry = output_geometry, .mode = output_mode, .done = output_done, .scale = output_scale, }; static void registry_global(void *data, struct wl_registry *wl_registry, uint32_t name, const char *interface, uint32_t version) { struct wsk_state *state = data; if (strcmp(interface, wl_compositor_interface.name) == 0) { state->compositor = wl_registry_bind(wl_registry, name, &wl_compositor_interface, 4); } else if (strcmp(interface, wl_shm_interface.name) == 0) { state->shm = wl_registry_bind(wl_registry, name, &wl_shm_interface, 1); } else if (strcmp(interface, wl_seat_interface.name) == 0) { state->seat = wl_registry_bind(wl_registry, name, &wl_seat_interface, 5); } else if (strcmp(interface, zxdg_output_manager_v1_interface.name) == 0) { state->output_mgr = wl_registry_bind(wl_registry, name, &zxdg_output_manager_v1_interface, 1); } else if (strcmp(interface, zwlr_layer_shell_v1_interface.name) == 0) { state->layer_shell = wl_registry_bind(wl_registry, name, &zwlr_layer_shell_v1_interface, 1); } else if (strcmp(interface, wl_output_interface.name) == 0) { struct wsk_output *output = calloc(1, sizeof(struct wsk_output)); output->output = wl_registry_bind(wl_registry, name, &wl_output_interface, 3); output->scale = 1; struct wsk_output **link = &state->outputs; while (*link) { link = &(*link)->next; } *link = output; wl_output_add_listener(output->output, &wl_output_listener, output); } } static void registry_global_remove(void *data, struct wl_registry *wl_registry, uint32_t name) { /* This space deliberately left blank */ } static const struct wl_registry_listener registry_listener = { .global = registry_global, .global_remove = registry_global_remove, }; static void handle_libinput_event(struct wsk_state *state, struct libinput_event *event) { if (!state->xkb_state) { return; } enum libinput_event_type event_type = libinput_event_get_type(event); if (event_type != LIBINPUT_EVENT_KEYBOARD_KEY) { return; } struct libinput_event_keyboard *kbevent = libinput_event_get_keyboard_event(event); uint32_t keycode = libinput_event_keyboard_get_key(kbevent) + 8; enum libinput_key_state key_state = libinput_event_keyboard_get_key_state(kbevent); xkb_state_update_key(state->xkb_state, keycode, key_state == LIBINPUT_KEY_STATE_RELEASED ? XKB_KEY_UP : XKB_KEY_DOWN); xkb_keysym_t keysym = xkb_state_key_get_one_sym(state->xkb_state, keycode); struct wsk_keypress *keypress; switch (key_state) { case LIBINPUT_KEY_STATE_RELEASED: /* Who cares */ break; case LIBINPUT_KEY_STATE_PRESSED: keypress = calloc(1, sizeof(struct wsk_keypress)); assert(keypress); keypress->sym = keysym; xkb_keysym_get_name(keypress->sym, keypress->name, sizeof(keypress->name)); if (xkb_state_key_get_utf8(state->xkb_state, keycode, keypress->utf8, sizeof(keypress->utf8)) <= 0 || keypress->utf8[0] <= ' ') { keypress->utf8[0] = '\0'; } struct wsk_keypress **link = &state->keys; while (*link) { link = &(*link)->next; } *link = keypress; break; } clock_gettime(CLOCK_MONOTONIC, &state->last_key); set_dirty(state); } static int libinput_open_restricted(const char *path, int flags, void *data) { int *fd = data; return devmgr_open(*fd, path); } static void libinput_close_restricted(int fd, void *data) { close(fd); } static const struct libinput_interface libinput_impl = { .open_restricted = libinput_open_restricted, .close_restricted = libinput_close_restricted, }; static uint32_t parse_color(const char *color) { if (color[0] == '#') { ++color; } int len = strlen(color); if (len != 6 && len != 8) { fprintf(stderr, "Invalid color %s, defaulting to color " "0xFFFFFFFF\n", color); return 0xFFFFFFFF; } uint32_t res = (uint32_t)strtoul(color, NULL, 16); if (strlen(color) == 6) { res = (res << 8) | 0xFF; } return res; } int main(int argc, char *argv[]) { /* NOTICE: This code runs as root */ struct wsk_state state = { 0 }; if (devmgr_start(&state.devmgr, &state.devmgr_pid, INPUTDEVPATH) > 0) { return 1; } /* Begin normal user code: */ int ret = 0; unsigned int anchor = 0; int margin = 32; state.background = 0x000000CC; state.specialfg = 0xAAAAAAFF; state.foreground = 0xFFFFFFFF; state.font = "monospace 24"; state.timeout = 1; int c; while ((c = getopt(argc, argv, "hb:f:s:F:t:a:m:o:")) != -1) { switch (c) { case 'b': state.background = parse_color(optarg); break; case 'f': state.foreground = parse_color(optarg); break; case 's': state.specialfg = parse_color(optarg); break; case 'F': state.font = optarg; break; case 't': state.timeout = atoi(optarg); break; case 'a': if (strcmp(optarg, "top") == 0) { anchor |= ZWLR_LAYER_SURFACE_V1_ANCHOR_TOP; } else if (strcmp(optarg, "left") == 0) { anchor |= ZWLR_LAYER_SURFACE_V1_ANCHOR_LEFT; } else if (strcmp(optarg, "right") == 0) { anchor |= ZWLR_LAYER_SURFACE_V1_ANCHOR_RIGHT; } else if (strcmp(optarg, "bottom") == 0) { anchor |= ZWLR_LAYER_SURFACE_V1_ANCHOR_BOTTOM; } break; case 'm': margin = atoi(optarg); break; case 'o': fprintf(stderr, "-o is unimplemented\n"); return 0; default: fprintf(stderr, "usage: wshowkeys [-b|-f|-s #RRGGBB[AA]] [-F font] " "[-t timeout]\n\t[-a top|left|right|bottom] [-m margin] " "[-o output]\n"); return 1; } } state.udev = udev_new(); if (!state.udev) { fprintf(stderr, "udev_create: %s\n", strerror(errno)); ret = 1; goto exit; } state.libinput = libinput_udev_create_context( &libinput_impl, &state.devmgr, state.udev); udev_unref(state.udev); if (!state.libinput) { fprintf(stderr, "libinput_udev_create_context: %s\n", strerror(errno)); ret = 1; goto exit; } state.xkb_context = xkb_context_new(XKB_CONTEXT_NO_FLAGS); if (!state.xkb_context) { fprintf(stderr, "xkb_context_new: %s\n", strerror(errno)); ret = 1; goto exit; } state.display = wl_display_connect(NULL); if (!state.display) { fprintf(stderr, "wl_display_connect: %s\n", strerror(errno)); ret = 1; goto exit; } state.registry = wl_display_get_registry(state.display); assert(state.registry); wl_registry_add_listener(state.registry, ®istry_listener, &state); wl_display_roundtrip(state.display); struct { const char *name; void *ptr; } need_globals[] = { "wl_compositor", &state.compositor, "wl_shm", &state.shm, "wl_seat", &state.seat, "wlr_layer_shell", &state.layer_shell, }; for (size_t i = 0; i < sizeof(need_globals) / sizeof(need_globals[0]); ++i) { if (!need_globals[i].ptr) { fprintf(stderr, "Error: required Wayland interface '%s' " "is not present\n", need_globals[i].name); ret = 1; goto exit; } } // TODO: Listener for xdg output wl_seat_add_listener(state.seat, &wl_seat_listener, &state); wl_display_roundtrip(state.display); state.surface = wl_compositor_create_surface(state.compositor); assert(state.surface); wl_surface_add_listener(state.surface, &wl_surface_listener, &state); state.layer_surface = zwlr_layer_shell_v1_get_layer_surface( state.layer_shell, state.surface, NULL, ZWLR_LAYER_SHELL_V1_LAYER_TOP, "showkeys"); assert(state.layer_surface); zwlr_layer_surface_v1_add_listener( state.layer_surface, &layer_surface_listener, &state); zwlr_layer_surface_v1_set_anchor(state.layer_surface, anchor); zwlr_layer_surface_v1_set_margin(state.layer_surface, margin, margin, margin, margin); zwlr_layer_surface_v1_set_exclusive_zone(state.layer_surface, -1); wl_surface_commit(state.surface); struct pollfd pollfds[] = { { .fd = libinput_get_fd(state.libinput), .events = POLLIN, }, { .fd = wl_display_get_fd(state.display), .events = POLLIN, }, }; state.run = true; while (state.run) { errno = 0; do { if (wl_display_flush(state.display) == -1 && errno != EAGAIN) { fprintf(stderr, "wl_display_flush: %s\n", strerror(errno)); break; } } while (errno == EAGAIN); int timeout = -1; if (state.keys) { timeout = 100; } if (poll(pollfds, sizeof(pollfds) / sizeof(pollfds[0]), timeout) < 0) { fprintf(stderr, "poll: %s\n", strerror(errno)); break; } /* Clear out old keys */ struct timespec now; clock_gettime(CLOCK_MONOTONIC, &now); if (now.tv_sec >= state.last_key.tv_sec + state.timeout && now.tv_nsec >= state.last_key.tv_nsec) { struct wsk_keypress *key = state.keys; while (key) { struct wsk_keypress *next = key->next; free(key); key = next; } state.keys = NULL; set_dirty(&state); } if ((pollfds[0].revents & POLLIN)) { if (libinput_dispatch(state.libinput) != 0) { fprintf(stderr, "libinput_dispatch: %s\n", strerror(errno)); break; } struct libinput_event *event; while ((event = libinput_get_event(state.libinput))) { handle_libinput_event(&state, event); libinput_event_destroy(event); } } if ((pollfds[1].revents & POLLIN) && wl_display_dispatch(state.display) == -1) { fprintf(stderr, "wl_display_dispatch: %s\n", strerror(errno)); break; } } exit: wl_display_disconnect(state.display); libinput_unref(state.libinput); devmgr_finish(state.devmgr, state.devmgr_pid); return ret; } wshowkeys-1.0/meson.build000066400000000000000000000025101364037114200155560ustar00rootroot00000000000000project( 'wshowkeys', 'c', version: '0.1.0', license: 'GPL', meson_version: '>=0.48.0', default_options: [ 'c_std=c11', 'warning_level=2', 'werror=true', ], ) cc = meson.get_compiler('c') add_project_arguments(cc.get_supported_arguments([ '-D_POSIX_C_SOURCE=200809L', '-Wundef', '-Wlogical-op', '-Wmissing-include-dirs', '-Wold-style-definition', '-Wpointer-arith', '-Winit-self', '-Wstrict-prototypes', '-Wimplicit-fallthrough=2', '-Wendif-labels', '-Wstrict-aliasing=2', '-Woverflow', '-Wno-missing-braces', '-Wno-missing-field-initializers', '-Wno-unused-parameter', ]), language: 'c') add_project_arguments([ '-DINPUTDEVPATH="@0@"'.format(get_option('devpath')), ], language: 'c') cairo = dependency('cairo') libinput = dependency('libinput') pango = dependency('pango') pangocairo = dependency('pangocairo') udev = dependency('libudev') wayland_client = dependency('wayland-client') wayland_protos = dependency('wayland-protocols') xkbcommon = dependency('xkbcommon') rt = cc.find_library('rt') subdir('protocols') executable( 'wshowkeys', files( 'devmgr.c', 'main.c', 'pango.c', 'shm.c', ), dependencies: [ cairo, client_protos, libinput, pango, pangocairo, rt, udev, wayland_client, wayland_protos, xkbcommon, ], install: true, ) wshowkeys-1.0/meson_options.txt000066400000000000000000000002641364037114200170550ustar00rootroot00000000000000option('devpath', type: 'string', value: '/dev/input/', description: 'Platform-specific path to input device files. This must be as specific as possible for security reasons.') wshowkeys-1.0/pango.c000066400000000000000000000043651364037114200146760ustar00rootroot00000000000000#include #include #include #include #include #include #include #include #include "cairo.h" PangoLayout *get_pango_layout(cairo_t *cairo, const char *font, const char *text, double scale) { PangoLayout *layout = pango_cairo_create_layout(cairo); PangoAttrList *attrs = pango_attr_list_new(); pango_layout_set_text(layout, text, -1); pango_attr_list_insert(attrs, pango_attr_scale_new(scale)); PangoFontDescription *desc = pango_font_description_from_string(font); pango_layout_set_font_description(layout, desc); pango_layout_set_single_paragraph_mode(layout, 1); pango_layout_set_attributes(layout, attrs); pango_attr_list_unref(attrs); pango_font_description_free(desc); return layout; } void get_text_size(cairo_t *cairo, const char *font, int *width, int *height, int *baseline, double scale, const char *fmt, ...) { va_list args; va_start(args, fmt); // Add one since vsnprintf excludes null terminator. int length = vsnprintf(NULL, 0, fmt, args) + 1; va_end(args); char *buf = malloc(length); if (buf == NULL) { return; } va_start(args, fmt); vsnprintf(buf, length, fmt, args); va_end(args); PangoLayout *layout = get_pango_layout(cairo, font, buf, scale); pango_cairo_update_layout(cairo, layout); pango_layout_get_pixel_size(layout, width, height); if (baseline) { *baseline = pango_layout_get_baseline(layout) / PANGO_SCALE; } g_object_unref(layout); free(buf); } void pango_printf(cairo_t *cairo, const char *font, double scale, const char *fmt, ...) { va_list args; va_start(args, fmt); // Add one since vsnprintf excludes null terminator. int length = vsnprintf(NULL, 0, fmt, args) + 1; va_end(args); char *buf = malloc(length); if (buf == NULL) { return; } va_start(args, fmt); vsnprintf(buf, length, fmt, args); va_end(args); PangoLayout *layout = get_pango_layout(cairo, font, buf, scale); cairo_font_options_t *fo = cairo_font_options_create(); cairo_get_font_options(cairo, fo); pango_cairo_context_set_font_options(pango_layout_get_context(layout), fo); cairo_font_options_destroy(fo); pango_cairo_update_layout(cairo, layout); pango_cairo_show_layout(cairo, layout); g_object_unref(layout); free(buf); } wshowkeys-1.0/pango.h000066400000000000000000000007511364037114200146760ustar00rootroot00000000000000#ifndef _WSK_PANGO_H #define _WSK_PANGO_H #include #include #include #include #include PangoLayout *get_pango_layout(cairo_t *cairo, const char *font, const char *text, double scale); void get_text_size(cairo_t *cairo, const char *font, int *width, int *height, int *baseline, double scale, const char *fmt, ...); void pango_printf(cairo_t *cairo, const char *font, double scale, const char *fmt, ...); #endif wshowkeys-1.0/protocols/000077500000000000000000000000001364037114200154425ustar00rootroot00000000000000wshowkeys-1.0/protocols/meson.build000066400000000000000000000024371364037114200176120ustar00rootroot00000000000000wl_protocol_dir = wayland_protos.get_pkgconfig_variable('pkgdatadir') wayland_scanner_dep = dependency('wayland-scanner', required: false, native: true) if wayland_scanner_dep.found() wayland_scanner = find_program( wayland_scanner_dep.get_pkgconfig_variable('wayland_scanner'), native: true, ) else wayland_scanner = find_program('wayland-scanner', native: true) endif protocols = [ [wl_protocol_dir, 'unstable/xdg-output/xdg-output-unstable-v1.xml'], [wl_protocol_dir, 'stable/xdg-shell/xdg-shell.xml'], ['wlr-layer-shell-unstable-v1.xml'], ] wl_protos_src = [] wl_protos_headers = [] foreach p : protocols xml = join_paths(p) wl_protos_src += custom_target( xml.underscorify() + '_protocol_c', input: xml, output: '@BASENAME@-protocol.c', command: [wayland_scanner, 'private-code', '@INPUT@', '@OUTPUT@'], ) wl_protos_headers += custom_target( xml.underscorify() + '_client_h', input: xml, output: '@BASENAME@-client-protocol.h', command: [wayland_scanner, 'client-header', '@INPUT@', '@OUTPUT@'], ) endforeach lib_client_protos = static_library( 'client_protos', wl_protos_src + wl_protos_headers, dependencies: wayland_client.partial_dependency(compile_args: true), ) client_protos = declare_dependency( link_with: lib_client_protos, sources: wl_protos_headers, ) wshowkeys-1.0/protocols/wlr-layer-shell-unstable-v1.xml000066400000000000000000000320701364037114200233500ustar00rootroot00000000000000 Copyright © 2017 Drew DeVault Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the copyright holders not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The copyright holders make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Clients can use this interface to assign the surface_layer role to wl_surfaces. Such surfaces are assigned to a "layer" of the output and rendered with a defined z-depth respective to each other. They may also be anchored to the edges and corners of a screen and specify input handling semantics. This interface should be suitable for the implementation of many desktop shell components, and a broad number of other applications that interact with the desktop. Create a layer surface for an existing surface. This assigns the role of layer_surface, or raises a protocol error if another role is already assigned. Creating a layer surface from a wl_surface which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first layer_surface.configure call must also be treated as errors. You may pass NULL for output to allow the compositor to decide which output to use. Generally this will be the one that the user most recently interacted with. Clients can specify a namespace that defines the purpose of the layer surface. These values indicate which layers a surface can be rendered in. They are ordered by z depth, bottom-most first. Traditional shell surfaces will typically be rendered between the bottom and top layers. Fullscreen shell surfaces are typically rendered at the top layer. Multiple surfaces can share a single layer, and ordering within a single layer is undefined. An interface that may be implemented by a wl_surface, for surfaces that are designed to be rendered as a layer of a stacked desktop-like environment. Layer surface state (size, anchor, exclusive zone, margin, interactivity) is double-buffered, and will be applied at the time wl_surface.commit of the corresponding wl_surface is called. Sets the size of the surface in surface-local coordinates. The compositor will display the surface centered with respect to its anchors. If you pass 0 for either value, the compositor will assign it and inform you of the assignment in the configure event. You must set your anchor to opposite edges in the dimensions you omit; not doing so is a protocol error. Both values are 0 by default. Size is double-buffered, see wl_surface.commit. Requests that the compositor anchor the surface to the specified edges and corners. If two orthogonal edges are specified (e.g. 'top' and 'left'), then the anchor point will be the intersection of the edges (e.g. the top left corner of the output); otherwise the anchor point will be centered on that edge, or in the center if none is specified. Anchor is double-buffered, see wl_surface.commit. Requests that the compositor avoids occluding an area of the surface with other surfaces. The compositor's use of this information is implementation-dependent - do not assume that this region will not actually be occluded. A positive value is only meaningful if the surface is anchored to an edge, rather than a corner. The zone is the number of surface-local coordinates from the edge that is considered exclusive. Surfaces that do not wish to have an exclusive zone may instead specify how they should interact with surfaces that do. If set to zero, the surface indicates that it would like to be moved to avoid occluding surfaces with a positive exclusive zone. If set to -1, the surface indicates that it would not like to be moved to accommodate for other surfaces, and the compositor should extend it all the way to the edges it is anchored to. For example, a panel might set its exclusive zone to 10, so that maximized shell surfaces are not shown on top of it. A notification might set its exclusive zone to 0, so that it is moved to avoid occluding the panel, but shell surfaces are shown underneath it. A wallpaper or lock screen might set their exclusive zone to -1, so that they stretch below or over the panel. The default value is 0. Exclusive zone is double-buffered, see wl_surface.commit. Requests that the surface be placed some distance away from the anchor point on the output, in surface-local coordinates. Setting this value for edges you are not anchored to has no effect. The exclusive zone includes the margin. Margin is double-buffered, see wl_surface.commit. Set to 1 to request that the seat send keyboard events to this layer surface. For layers below the shell surface layer, the seat will use normal focus semantics. For layers above the shell surface layers, the seat will always give exclusive keyboard focus to the top-most layer which has keyboard interactivity set to true. Layer surfaces receive pointer, touch, and tablet events normally. If you do not want to receive them, set the input region on your surface to an empty region. Events is double-buffered, see wl_surface.commit. This assigns an xdg_popup's parent to this layer_surface. This popup should have been created via xdg_surface::get_popup with the parent set to NULL, and this request must be invoked before committing the popup's initial state. See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used. When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event. If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event. A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit. A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to. This request destroys the layer surface. The configure event asks the client to resize its surface. Clients should arrange their surface for the new states, and then send an ack_configure request with the serial sent in this configure event at some point before committing the new surface. The client is free to dismiss all but the last configure event it received. The width and height arguments specify the size of the window in surface-local coordinates. The size is a hint, in the sense that the client is free to ignore it if it doesn't resize, pick a smaller size (to satisfy aspect ratio or resize in steps of NxM pixels). If the client picks a smaller size and is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the surface will be centered on this axis. If the width or height arguments are zero, it means the client should decide its own window dimension. The closed event is sent by the compositor when the surface will no longer be shown. The output may have been destroyed or the user may have asked for it to be removed. Further changes to the surface will be ignored. The client should destroy the resource after receiving this event, and create a new surface if they so choose. wshowkeys-1.0/shm.c000066400000000000000000000061631364037114200143570ustar00rootroot00000000000000/* Portions of this file taken from sway, MIT licensed */ #include #include #include #include #include #include #include #include #include #include #include #include "shm.h" static void randname(char *buf) { struct timespec ts; clock_gettime(CLOCK_REALTIME, &ts); long r = ts.tv_nsec; for (int i = 0; i < 6; ++i) { buf[i] = 'A'+(r&15)+(r&16)*2; r >>= 5; } } int create_shm_file(void) { int retries = 100; do { char name[] = "/wl_shm-XXXXXX"; randname(name + strlen(name) - 6); --retries; // CLOEXEC is guaranteed to be set by shm_open int fd = shm_open(name, O_RDWR | O_CREAT | O_EXCL, 0600); if (fd >= 0) { shm_unlink(name); return fd; } } while (retries > 0 && errno == EEXIST); return -1; } int allocate_shm_file(size_t size) { int fd = create_shm_file(); if (fd < 0) { return -1; } int ret; do { ret = ftruncate(fd, size); } while (ret < 0 && errno == EINTR); if (ret < 0) { close(fd); return -1; } return fd; } static void buffer_release(void *data, struct wl_buffer *wl_buffer) { struct pool_buffer *buffer = data; buffer->busy = false; } static const struct wl_buffer_listener buffer_listener = { .release = buffer_release }; static struct pool_buffer *create_buffer(struct wl_shm *shm, struct pool_buffer *buf, int32_t width, int32_t height, uint32_t format) { uint32_t stride = width * 4; size_t size = stride * height; int fd = allocate_shm_file(size); assert(fd != -1); void *data = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); struct wl_shm_pool *pool = wl_shm_create_pool(shm, fd, size); buf->buffer = wl_shm_pool_create_buffer(pool, 0, width, height, stride, format); wl_shm_pool_destroy(pool); close(fd); buf->size = size; buf->width = width; buf->height = height; buf->data = data; buf->surface = cairo_image_surface_create_for_data(data, CAIRO_FORMAT_ARGB32, width, height, stride); buf->cairo = cairo_create(buf->surface); buf->pango = pango_cairo_create_context(buf->cairo); wl_buffer_add_listener(buf->buffer, &buffer_listener, buf); return buf; } void destroy_buffer(struct pool_buffer *buffer) { if (buffer->buffer) { wl_buffer_destroy(buffer->buffer); } if (buffer->cairo) { cairo_destroy(buffer->cairo); } if (buffer->surface) { cairo_surface_destroy(buffer->surface); } if (buffer->pango) { g_object_unref(buffer->pango); } if (buffer->data) { munmap(buffer->data, buffer->size); } memset(buffer, 0, sizeof(struct pool_buffer)); } struct pool_buffer *get_next_buffer(struct wl_shm *shm, struct pool_buffer pool[static 2], uint32_t width, uint32_t height) { struct pool_buffer *buffer = NULL; for (size_t i = 0; i < 2; ++i) { if (pool[i].busy) { continue; } buffer = &pool[i]; } if (!buffer) { return NULL; } if (buffer->width != width || buffer->height != height) { destroy_buffer(buffer); } if (!buffer->buffer) { if (!create_buffer(shm, buffer, width, height, WL_SHM_FORMAT_ARGB8888)) { return NULL; } } buffer->busy = true; return buffer; } wshowkeys-1.0/shm.h000066400000000000000000000010771364037114200143630ustar00rootroot00000000000000#ifndef SHM_H #define SHM_H #include #include #include #include #include int create_shm_file(void); int allocate_shm_file(size_t size); struct pool_buffer { struct wl_buffer *buffer; cairo_surface_t *surface; cairo_t *cairo; PangoContext *pango; uint32_t width, height; void *data; size_t size; bool busy; }; struct pool_buffer *get_next_buffer(struct wl_shm *shm, struct pool_buffer pool[static 2], uint32_t width, uint32_t height); void destroy_buffer(struct pool_buffer *buffer); #endif