├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── xcape.1 └── xcape.c /.gitignore: -------------------------------------------------------------------------------- 1 | xcape 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | INSTALL=install 2 | PREFIX=/usr 3 | MANDIR?=/local/man/man1 4 | 5 | TARGET := xcape 6 | 7 | CFLAGS += -Wall 8 | CFLAGS += `pkg-config --cflags xtst x11` 9 | LDFLAGS += `pkg-config --libs xtst x11` 10 | LDFLAGS += -pthread 11 | 12 | all: $(TARGET) 13 | 14 | $(TARGET): xcape.c 15 | $(CC) $(CFLAGS) -o $@ $< $(LDFLAGS) 16 | 17 | install: 18 | $(INSTALL) -d -m 0755 $(DESTDIR)$(PREFIX)/bin 19 | $(INSTALL) -d -m 0755 $(DESTDIR)$(PREFIX)$(MANDIR) 20 | $(INSTALL) -m 0755 $(TARGET) $(DESTDIR)$(PREFIX)/bin/$(TARGET) 21 | $(INSTALL) -m 0644 xcape.1 $(DESTDIR)$(PREFIX)$(MANDIR)/xcape.1 22 | 23 | clean: 24 | rm $(TARGET) 25 | 26 | .PHONY: all clean install 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | XCAPE 2 | ===== 3 | 4 | xcape allows you to use a modifier key as another key when pressed and 5 | released on its own. Note that it is slightly slower than pressing the 6 | original key, because the pressed event does not occur until the key is 7 | released. The default behaviour is to generate the Escape key when Left 8 | Control is pressed and released on its own. (If you don't understand why 9 | anybody would want this, I'm guessing that Vim is not your favourite text 10 | editor ;) 11 | 12 | Minimal building instructions 13 | ----------------------------- 14 | 15 | First install the development dependencies. On Debian-based systems 16 | (including Ubuntu and Linux Mint), run: 17 | 18 | $ sudo apt-get install git gcc make pkg-config libx11-dev libxtst-dev libxi-dev 19 | 20 | On Fedora-based systems, run: 21 | 22 | $ sudo dnf install git gcc make pkgconfig libX11-devel libXtst-devel libXi-devel 23 | 24 | Then run: 25 | 26 | $ git clone https://github.com/alols/xcape.git 27 | $ cd xcape 28 | $ make 29 | $ sudo make install 30 | 31 | Usage 32 | ----- 33 | $ xcape [-d] [-f] [-t ] [-e ] 34 | 35 | ### `-d` 36 | 37 | Debug mode. Does not fork into the background. Prints debug information. 38 | 39 | ### `-f` 40 | 41 | Foreground mode. Does not fork into the background. 42 | 43 | ### `-t ` 44 | 45 | If you hold a key longer than this timeout, xcape will not generate a key 46 | event. Default is 500 ms. 47 | 48 | ### `-e ` 49 | 50 | The expression has the grammar `'ModKey=Key[|OtherKey][;NextExpression]'` 51 | 52 | The list of key names is found in the header file `X11/keysymdef.h` (remove 53 | the `XK_` prefix). Note that due to limitations of X11 shifted keys *must* 54 | be specified as a shift key followed by the key to be pressed rather than 55 | the actual name of the character. For example to generate "{" the 56 | expression `'ModKey=Shift_L|bracketleft'` could be used (assuming that you 57 | have a key with "{" above "["). 58 | 59 | You can also specify keys in decimal (prefix `#`), octal (`#0`), or 60 | hexadecimal (`#0x`). They will be interpreted as keycodes unless no corresponding 61 | key name is found. 62 | 63 | #### Examples 64 | 65 | + This will make Left Shift generate Escape when pressed and released on 66 | its own, and Left Control generate Ctrl-O combination when pressed and 67 | released on its own. 68 | 69 | xcape -e 'Shift_L=Escape;Control_L=Control_L|O' 70 | 71 | + In conjunction with xmodmap it is possible to make an ordinary key act 72 | as an extra modifier. First map the key to the modifier with xmodmap 73 | and then the modifier back to the key with xcape. However, this has 74 | several limitations: the key will not work as ordinary until it is 75 | released, and in particular, *it may act as a modifier unintentionally if 76 | you type too fast.* This is not a bug in xcape, but an unavoidable 77 | consequence of using these two tools together in this way. 78 | As an example, we can make the space bar work as an additional ctrl 79 | key when held (similar to 80 | [Space2ctrl](https://github.com/r0adrunner/Space2Ctrl)) with the 81 | following sequence of commands. 82 | 83 | # Map an unused modifier's keysym to the spacebar's keycode and make it a 84 | # control modifier. It needs to be an existing key so that emacs won't 85 | # spazz out when you press it. Hyper_L is a good candidate. 86 | spare_modifier="Hyper_L" 87 | xmodmap -e "keycode 65 = $spare_modifier" 88 | xmodmap -e "remove mod4 = $spare_modifier" # hyper_l is mod4 by default 89 | xmodmap -e "add Control = $spare_modifier" 90 | 91 | # Map space to an unused keycode (to keep it around for xcape to 92 | # use). 93 | xmodmap -e "keycode any = space" 94 | 95 | # Finally use xcape to cause the space bar to generate a space when tapped. 96 | xcape -e "$spare_modifier=space" 97 | 98 | 99 | Note regarding xmodmap 100 | ---------------------- 101 | 102 | If you are in the habit of remapping keycodes to keysyms (eg, using xmodmap), 103 | there are two issues you may encounter. 104 | 105 | 1. You will need to restart xcape after every time you modify the mapping from 106 | keycodes to keysyms (eg, with xmodmap), or xcape will still use the old 107 | mapping. 108 | 109 | 2. The key you wish to send must have a defined keycode. So for example, with 110 | the default mapping `Control_L=Escape`, you still need an escape key defined 111 | in your xmodmap mapping. (I get around this by using 255, which my keyboard 112 | cannot send). 113 | 114 | Contact 115 | ------- 116 | 117 | Find the latest version at 118 | https://github.com/alols/xcape 119 | 120 | The author can be reached at 121 | albin dot olsson at gmail dot com 122 | -------------------------------------------------------------------------------- /xcape.1: -------------------------------------------------------------------------------- 1 | .TH XCAPE 1 2017-07-03 "John Hill" "xcape Manual" 2 | 3 | .SH NAME 4 | xcape \- use a modifier key as another key 5 | 6 | .SH SYNOPSIS 7 | .B xcape 8 | [\fB-d\fR] 9 | [\fB-f\fR] 10 | [\fB-t\fR \fItimeout\fR] 11 | [\fB-e\fR \fImap-expression\fR] 12 | 13 | .SH DESCRIPTION 14 | \fBxcape\fR allows a modifier key to be used as another key when it is pressed 15 | and released on its own. The default behaviour is to generate the \fIEscape\fR 16 | key in place of \fIControl_L\fR (Left Control). 17 | 18 | .SH OPTIONS 19 | .TP 20 | .BR \-d 21 | Debug mode. Will run as a foreground process and print debug information. 22 | .TP 23 | .BR \-f 24 | Foreground mode. Will run as a foreground process. 25 | .TP 26 | .BR \-t " " \fItimeout\fR 27 | Give a \fItimeout\fR in milliseconds. If you hold a key longer than 28 | \fItimeout\fR a key event will not be generated. 29 | .TP 30 | .BR \-e " " \fImap-expression\fR 31 | Use \fImap-expression\fR as the expression(s). 32 | 33 | .SH EXPRESSION SYNTAX 34 | Expression syntax is \'\fBModKey\fR=\fBKey\fR[|\fBOtherKey\fR]\'. Multiple 35 | expressions can be passed, delimited by semi-colons (;). 36 | .PP 37 | A list of keysyms can be found in the header file <\fIX11/keysymdef.h\fR> 38 | (without the \fIXK_\fR prefix). 39 | .PP 40 | Note that shifted keys must be specified as a shift key followed by the key to 41 | be pressed rather than the actual name of the character. For example to 42 | generate "\fI{\fR" the expression 43 | \'\fIModKey\fR=\fIShift_L\fR|\fIbracketleft\fR\' could be used 44 | (assuming that you have a key with \'{\' above \'[\'). 45 | .PP 46 | You can also specify \fBModKey\fR in decimal (prefix \fI#\fR), octal 47 | (\fI#0\fR), or hexadecimal (\fI#0x\fR). It will be interpreted as a keycode 48 | unless no corresponding key name is 49 | found. 50 | 51 | .SH EXAMPLES 52 | .PP 53 | Make Left Shift generate Escape when pressed and released on it's own, and Left 54 | Control generate Ctrl\-O combination when pressed and released on it's own: 55 | .RS 56 | \fBxcape\fR \fB-e\fR '\fIShift_L\fR=\fIEscape\fR;\fIControl_L\fR=\fIControl_L\fR|\fIO\fR' 57 | .RE 58 | .PP 59 | In conjugation with xmodmap it is possible to make an ordinary key act as an 60 | extra modifier. First map the key to the modifier with xmodmap and then the 61 | modifier back to the key with \fBxcape\fR. As an example, we can make the space 62 | bar work as an additional ctrl key when held with the following sequence of 63 | commands: 64 | .PP 65 | First, map an unused modifier's keysym to the spacebar's keycode and make it a 66 | control modifier. It needs to be an existing key so that emacs won't spazz out 67 | when you press it. Hyper_L is a good candidate. 68 | .PP 69 | .RS 70 | .nf 71 | \fBspare_modifier\fR="\fIHyper_L\fR" 72 | \fBxmodmap\fR \fB-e\fR "\fBkeycode\fR \fI65\fR = \fI$spare_modifier\fR" 73 | \fBxmodmap\fR \fB-e\fR "\fBremove\fR \fImod4\fR = \fI$spare_modifier\fR" 74 | # hyper_l is mod4 by default 75 | \fBxmodmap\fR \fB-e\fR "\fBadd\fR \fIControl\fR = \fI$spare_modifier\fR" 76 | .fi 77 | .RE 78 | .PP 79 | Next, map space to an unused keycode (to keep it around for \fBxcape\fR to use). 80 | .PP 81 | .RS 82 | \fBxmodmap\fR \fR-e\fR "\fBkeycode\fR \fIany\fR = \fIspace\fR" 83 | .RE 84 | .PP 85 | Finally use \fBxcape\fR to cause the space bar to generate a space when tapped. 86 | .PP 87 | .RS 88 | \fBxcape\fR \fB-e\fR "\fI$spare_modifier\fR=\fIspace\fR" 89 | .RE 90 | 91 | .SH SEE ALSO 92 | \fBxmodmap\fR(1), \fBxev\fR(1) 93 | 94 | .SH AUTHOR 95 | \fBxcape\fR was written by Albin Olsson 96 | (albin dot olsson at gmail dot com) 97 | -------------------------------------------------------------------------------- /xcape.c: -------------------------------------------------------------------------------- 1 | /************************************************************************ 2 | * xcape.c 3 | * 4 | * Copyright 2015 Albin Olsson 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | * 19 | ***********************************************************************/ 20 | 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | #include 34 | 35 | 36 | /************************************************************************ 37 | * Internal data types 38 | ***********************************************************************/ 39 | typedef struct _Key_t 40 | { 41 | KeyCode key; 42 | struct _Key_t *next; 43 | } Key_t; 44 | 45 | typedef struct _KeyMap_t 46 | { 47 | Bool UseKeyCode; /* (for from) instead of KeySym; ignore latter */ 48 | KeySym from_ks; 49 | KeyCode from_kc; 50 | Key_t *to_keys; 51 | Bool used; 52 | Bool pressed; 53 | Bool mouse; 54 | struct timeval down_at; 55 | struct _KeyMap_t *next; 56 | } KeyMap_t; 57 | 58 | typedef struct _XCape_t 59 | { 60 | Display *data_conn; 61 | Display *ctrl_conn; 62 | XRecordContext record_ctx; 63 | pthread_t sigwait_thread; 64 | sigset_t sigset; 65 | Bool foreground; 66 | Bool debug; 67 | KeyMap_t *map; 68 | Key_t *generated; 69 | struct timeval timeout; 70 | } XCape_t; 71 | 72 | /************************************************************************ 73 | * Internal function declarations 74 | ***********************************************************************/ 75 | void *sig_handler (void *user_data); 76 | 77 | void intercept (XPointer user_data, XRecordInterceptData *data); 78 | 79 | KeyMap_t *parse_mapping (Display *ctrl_conn, char *mapping, Bool debug); 80 | 81 | void delete_mapping (KeyMap_t *map); 82 | 83 | Key_t *key_add_key (Key_t *keys, KeyCode key); 84 | 85 | void delete_keys (Key_t *keys); 86 | 87 | void print_usage (const char *program_name); 88 | 89 | /************************************************************************ 90 | * Main function 91 | ***********************************************************************/ 92 | int main (int argc, char **argv) 93 | { 94 | XCape_t *self = malloc (sizeof (XCape_t)); 95 | 96 | int dummy, ch; 97 | 98 | static char default_mapping[] = "Control_L=Escape"; 99 | char *mapping = default_mapping; 100 | 101 | XRecordRange *rec_range = XRecordAllocRange(); 102 | XRecordClientSpec client_spec = XRecordAllClients; 103 | 104 | self->foreground = False; 105 | self->debug = False; 106 | self->timeout.tv_sec = 0; 107 | self->timeout.tv_usec = 500000; 108 | self->generated = NULL; 109 | 110 | rec_range->device_events.first = KeyPress; 111 | rec_range->device_events.last = ButtonRelease; 112 | 113 | while ((ch = getopt (argc, argv, "dfe:t:")) != -1) 114 | { 115 | switch (ch) 116 | { 117 | case 'd': 118 | self->debug = True; 119 | /* imply -f (no break) */ 120 | case 'f': 121 | self->foreground = True; 122 | break; 123 | case 'e': 124 | mapping = optarg; 125 | break; 126 | case 't': 127 | { 128 | int ms = atoi (optarg); 129 | if (ms > 0) 130 | { 131 | self->timeout.tv_sec = ms / 1000; 132 | self->timeout.tv_usec = (ms % 1000) * 1000; 133 | } 134 | else 135 | { 136 | fprintf (stderr, "Invalid argument for '-t': %s.\n", optarg); 137 | print_usage (argv[0]); 138 | return EXIT_FAILURE; 139 | } 140 | } 141 | break; 142 | default: 143 | print_usage (argv[0]); 144 | return EXIT_SUCCESS; 145 | } 146 | } 147 | 148 | if (optind < argc) 149 | { 150 | fprintf (stderr, "Not a command line option: '%s'\n", argv[optind]); 151 | print_usage (argv[0]); 152 | return EXIT_SUCCESS; 153 | } 154 | 155 | if (!XInitThreads ()) 156 | { 157 | fprintf (stderr, "Failed to initialize threads.\n"); 158 | exit (EXIT_FAILURE); 159 | } 160 | 161 | self->data_conn = XOpenDisplay (NULL); 162 | self->ctrl_conn = XOpenDisplay (NULL); 163 | 164 | if (!self->data_conn || !self->ctrl_conn) 165 | { 166 | fprintf (stderr, "Unable to connect to X11 display. Is $DISPLAY set?\n"); 167 | exit (EXIT_FAILURE); 168 | } 169 | if (!XQueryExtension (self->ctrl_conn, 170 | "XTEST", &dummy, &dummy, &dummy)) 171 | { 172 | fprintf (stderr, "Xtst extension missing\n"); 173 | exit (EXIT_FAILURE); 174 | } 175 | if (!XRecordQueryVersion (self->ctrl_conn, &dummy, &dummy)) 176 | { 177 | fprintf (stderr, "Failed to obtain xrecord version\n"); 178 | exit (EXIT_FAILURE); 179 | } 180 | if (!XkbQueryExtension (self->ctrl_conn, &dummy, &dummy, 181 | &dummy, &dummy, &dummy)) 182 | { 183 | fprintf (stderr, "Failed to obtain xkb version\n"); 184 | exit (EXIT_FAILURE); 185 | } 186 | 187 | self->map = parse_mapping (self->ctrl_conn, mapping, self->debug); 188 | 189 | if (self->map == NULL) 190 | { 191 | fprintf (stderr, "Failed to parse_mapping\n"); 192 | exit (EXIT_FAILURE); 193 | } 194 | 195 | if (self->foreground != True) 196 | daemon (0, 0); 197 | 198 | sigemptyset (&self->sigset); 199 | sigaddset (&self->sigset, SIGINT); 200 | sigaddset (&self->sigset, SIGTERM); 201 | pthread_sigmask (SIG_BLOCK, &self->sigset, NULL); 202 | 203 | pthread_create (&self->sigwait_thread, 204 | NULL, sig_handler, self); 205 | 206 | self->record_ctx = XRecordCreateContext (self->ctrl_conn, 207 | 0, &client_spec, 1, &rec_range, 1); 208 | 209 | if (self->record_ctx == 0) 210 | { 211 | fprintf (stderr, "Failed to create xrecord context\n"); 212 | exit (EXIT_FAILURE); 213 | } 214 | 215 | XSync (self->ctrl_conn, False); 216 | 217 | if (!XRecordEnableContext (self->data_conn, 218 | self->record_ctx, intercept, (XPointer)self)) 219 | { 220 | fprintf (stderr, "Failed to enable xrecord context\n"); 221 | exit (EXIT_FAILURE); 222 | } 223 | 224 | pthread_join (self->sigwait_thread, NULL); 225 | 226 | if (!XRecordFreeContext (self->ctrl_conn, self->record_ctx)) 227 | { 228 | fprintf (stderr, "Failed to free xrecord context\n"); 229 | } 230 | 231 | if (self->debug) fprintf (stdout, "main exiting\n"); 232 | 233 | XFree (rec_range); 234 | 235 | XCloseDisplay (self->ctrl_conn); 236 | XCloseDisplay (self->data_conn); 237 | 238 | delete_mapping (self->map); 239 | 240 | free (self); 241 | 242 | return EXIT_SUCCESS; 243 | } 244 | 245 | 246 | /************************************************************************ 247 | * Internal functions 248 | ***********************************************************************/ 249 | void *sig_handler (void *user_data) 250 | { 251 | XCape_t *self = (XCape_t*)user_data; 252 | int sig; 253 | 254 | if (self->debug) fprintf (stdout, "sig_handler running...\n"); 255 | 256 | sigwait(&self->sigset, &sig); 257 | 258 | if (self->debug) fprintf (stdout, "Caught signal %d!\n", sig); 259 | 260 | XLockDisplay (self->ctrl_conn); 261 | 262 | if (!XRecordDisableContext (self->ctrl_conn, 263 | self->record_ctx)) 264 | { 265 | fprintf (stderr, "Failed to disable xrecord context\n"); 266 | exit(EXIT_FAILURE); 267 | } 268 | 269 | XSync (self->ctrl_conn, False); 270 | 271 | XUnlockDisplay (self->ctrl_conn); 272 | 273 | if (self->debug) fprintf (stdout, "sig_handler exiting...\n"); 274 | 275 | return NULL; 276 | } 277 | 278 | Key_t *key_add_key (Key_t *keys, KeyCode key) 279 | { 280 | Key_t *rval = keys; 281 | 282 | if (keys == NULL) 283 | { 284 | keys = malloc (sizeof (Key_t)); 285 | rval = keys; 286 | } 287 | else 288 | { 289 | while (keys->next != NULL) keys = keys->next; 290 | keys = (keys->next = malloc (sizeof (Key_t))); 291 | } 292 | 293 | keys->key = key; 294 | keys->next = NULL; 295 | 296 | return rval; 297 | } 298 | 299 | void handle_key (XCape_t *self, KeyMap_t *key, 300 | Bool mouse_pressed, int key_event) 301 | { 302 | Key_t *k; 303 | 304 | if (key_event == KeyPress) 305 | { 306 | if (self->debug) fprintf (stdout, "Key pressed!\n"); 307 | 308 | key->pressed = True; 309 | 310 | gettimeofday (&key->down_at, NULL); 311 | 312 | if (mouse_pressed) 313 | { 314 | key->used = True; 315 | } 316 | } 317 | else 318 | { 319 | if (self->debug) fprintf (stdout, "Key released!\n"); 320 | if (key->used == False) 321 | { 322 | struct timeval timev = self->timeout; 323 | gettimeofday (&timev, NULL); 324 | timersub (&timev, &key->down_at, &timev); 325 | 326 | if (timercmp (&timev, &self->timeout, <)) 327 | { 328 | for (k = key->to_keys; k != NULL; k = k->next) 329 | { 330 | if (self->debug) fprintf (stdout, "Generating %s!\n", 331 | XKeysymToString (XkbKeycodeToKeysym (self->ctrl_conn, 332 | k->key, 0, 0))); 333 | 334 | XTestFakeKeyEvent (self->ctrl_conn, 335 | k->key, True, 0); 336 | self->generated = key_add_key (self->generated, k->key); 337 | } 338 | for (k = key->to_keys; k != NULL; k = k->next) 339 | { 340 | XTestFakeKeyEvent (self->ctrl_conn, 341 | k->key, False, 0); 342 | self->generated = key_add_key (self->generated, k->key); 343 | } 344 | XFlush (self->ctrl_conn); 345 | } 346 | } 347 | key->used = False; 348 | key->pressed = False; 349 | } 350 | } 351 | 352 | void intercept (XPointer user_data, XRecordInterceptData *data) 353 | { 354 | XCape_t *self = (XCape_t*)user_data; 355 | static Bool mouse_pressed = False; 356 | KeyMap_t *km; 357 | 358 | XLockDisplay (self->ctrl_conn); 359 | 360 | if (data->category == XRecordFromServer) 361 | { 362 | int key_event = data->data[0]; 363 | KeyCode key_code = data->data[1]; 364 | Key_t *g, *g_prev = NULL; 365 | 366 | for (g = self->generated; g != NULL; g = g->next) 367 | { 368 | if (g->key == key_code) 369 | { 370 | if (self->debug) fprintf (stdout, 371 | "Ignoring generated event.\n"); 372 | if (g_prev != NULL) 373 | { 374 | g_prev->next = g->next; 375 | } 376 | else 377 | { 378 | self->generated = g->next; 379 | } 380 | free (g); 381 | goto exit; 382 | } 383 | g_prev = g; 384 | } 385 | 386 | if (self->debug) fprintf (stdout, 387 | "Intercepted key event %d, key code %d\n", 388 | key_event, key_code); 389 | 390 | if (key_event == ButtonPress) 391 | { 392 | mouse_pressed = True; 393 | } 394 | else if (key_event == ButtonRelease) 395 | { 396 | mouse_pressed = False; 397 | } 398 | for (km = self->map; km != NULL; km = km->next) 399 | { 400 | if ((km->UseKeyCode == False 401 | && XkbKeycodeToKeysym (self->ctrl_conn, key_code, 0, 0) 402 | == km->from_ks) 403 | || (km->UseKeyCode == True 404 | && key_code == km->from_kc)) 405 | { 406 | handle_key (self, km, mouse_pressed, key_event); 407 | } 408 | else if (km->pressed 409 | && (key_event == KeyPress || key_event == ButtonPress)) 410 | { 411 | km->used = True; 412 | } 413 | } 414 | } 415 | 416 | exit: 417 | XUnlockDisplay (self->ctrl_conn); 418 | XRecordFreeData (data); 419 | } 420 | 421 | KeyMap_t *parse_token (Display *dpy, char *token, Bool debug) 422 | { 423 | KeyMap_t *km = NULL; 424 | KeySym ks; 425 | char *from, *to, *key; 426 | KeyCode code; /* keycode */ 427 | long parsed_code; /* parsed keycode value */ 428 | 429 | to = token; 430 | from = strsep (&to, "="); 431 | if (to != NULL) 432 | { 433 | km = calloc (1, sizeof (KeyMap_t)); 434 | 435 | if (!strncmp (from, "#", 1) 436 | && strsep (&from, "#") != NULL) 437 | { 438 | errno = 0; 439 | parsed_code = strtoul (from, NULL, 0); /* dec, oct, hex automatically */ 440 | if (errno == 0 441 | && parsed_code <=255 442 | && XkbKeycodeToKeysym (dpy, (KeyCode) parsed_code, 0, 0) != NoSymbol) 443 | { 444 | km->UseKeyCode = True; 445 | km->from_kc = (KeyCode) parsed_code; 446 | if (debug) 447 | { 448 | KeySym ks_temp = XkbKeycodeToKeysym (dpy, (KeyCode) parsed_code, 0, 0); 449 | fprintf(stderr, "Assigned mapping from \"%s\" ( keysym 0x%x, " 450 | "key code %d)\n", 451 | XKeysymToString(ks_temp), 452 | (unsigned) ks_temp, 453 | (unsigned) km->from_kc); 454 | } 455 | } 456 | else 457 | { 458 | fprintf (stderr, "Invalid keycode: %s\n", from); 459 | return NULL; 460 | } 461 | } 462 | else 463 | { 464 | if ((ks = XStringToKeysym (from)) == NoSymbol) 465 | { 466 | fprintf (stderr, "Invalid key: %s\n", token); 467 | return NULL; 468 | } 469 | 470 | km->UseKeyCode = False; 471 | km->from_ks = ks; 472 | km->to_keys = NULL; 473 | 474 | if (debug) 475 | { 476 | fprintf(stderr, "Assigned mapping from \"%s\" ( keysym 0x%x, " 477 | "key code %d)\n", 478 | XKeysymToString (km->from_ks), 479 | (unsigned) km->from_ks, 480 | (unsigned) XKeysymToKeycode (dpy, km->from_ks)); 481 | } 482 | } 483 | 484 | for(;;) 485 | { 486 | key = strsep (&to, "|"); 487 | if (key == NULL) 488 | break; 489 | 490 | if (!strncmp (key, "#", 1) 491 | && strsep (&key, "#") != NULL) 492 | { 493 | errno = 0; 494 | parsed_code = strtoul (key, NULL, 0); /* dec, oct, hex automatically */ 495 | if (!(errno == 0 496 | && parsed_code <=255 497 | && XkbKeycodeToKeysym (dpy, (KeyCode) parsed_code, 0, 0) != NoSymbol)) 498 | { 499 | fprintf (stderr, "Invalid keycode: %s\n", key); 500 | return NULL; 501 | } 502 | 503 | code = (KeyCode) parsed_code; 504 | } 505 | else 506 | { 507 | if ((ks = XStringToKeysym (key)) == NoSymbol) 508 | { 509 | fprintf (stderr, "Invalid key: %s\n", key); 510 | return NULL; 511 | } 512 | 513 | code = XKeysymToKeycode (dpy, ks); 514 | if (code == 0) 515 | { 516 | fprintf (stderr, "WARNING: No keycode found for keysym " 517 | "%s (0x%x) in mapping %s. Ignoring this " 518 | "mapping.\n", key, (unsigned int)ks, token); 519 | return NULL; 520 | } 521 | } 522 | 523 | km->to_keys = key_add_key (km->to_keys, code); 524 | if (debug) 525 | { 526 | KeySym ks_temp = XkbKeycodeToKeysym (dpy, code, 0, 0); 527 | fprintf(stderr, "to \"%s\" (keysym 0x%x, key code %d)\n", 528 | XKeysymToString(ks_temp), 529 | (unsigned) ks_temp, 530 | (unsigned) code); 531 | } 532 | } 533 | } 534 | else 535 | fprintf (stderr, "WARNING: Mapping without = has no effect: '%s'\n", token); 536 | 537 | 538 | return km; 539 | } 540 | 541 | KeyMap_t *parse_mapping (Display *ctrl_conn, char *mapping, Bool debug) 542 | { 543 | char *token; 544 | KeyMap_t *rval, *km, *nkm; 545 | 546 | rval = km = NULL; 547 | 548 | for(;;) 549 | { 550 | token = strsep (&mapping, ";"); 551 | if (token == NULL) 552 | break; 553 | 554 | nkm = parse_token (ctrl_conn, token, debug); 555 | 556 | if (nkm != NULL) 557 | { 558 | if (km == NULL) 559 | rval = km = nkm; 560 | else 561 | { 562 | km->next = nkm; 563 | km = nkm; 564 | } 565 | } 566 | } 567 | 568 | return rval; 569 | } 570 | 571 | void delete_mapping (KeyMap_t *map) 572 | { 573 | while (map != NULL) { 574 | KeyMap_t *next = map->next; 575 | delete_keys (map->to_keys); 576 | free (map); 577 | map = next; 578 | } 579 | } 580 | 581 | void delete_keys (Key_t *keys) 582 | { 583 | while (keys != NULL) { 584 | Key_t *next = keys->next; 585 | free (keys); 586 | keys = next; 587 | } 588 | } 589 | 590 | void print_usage (const char *program_name) 591 | { 592 | fprintf (stdout, "Usage: %s [-d] [-f] [-t timeout_ms] [-e ]\n", program_name); 593 | fprintf (stdout, "Runs as a daemon unless -d or -f flag is set\n"); 594 | } 595 | --------------------------------------------------------------------------------