From a7f3c4b1d56403bea4e6e2fcaeb32e7f40da5c1d Mon Sep 17 00:00:00 2001 From: Michel Date: Tue, 13 Jun 2023 16:59:20 +0200 Subject: [PATCH] Squashed '.config/kitty/kitty_grab/' content from commit 8e550df git-subtree-dir: .config/kitty/kitty_grab git-subtree-split: 8e550df645333b81400ac2cbeb3131412dd2fda5 --- .gitignore | 3 + LICENSE | 674 +++++++++++++++++++++++++++++++++ README.md | 114 ++++++ _grab_ui.py | 704 +++++++++++++++++++++++++++++++++++ grab-vim.conf.example | 55 +++ grab.conf.example | 86 +++++ grab.py | 33 ++ kitten_options_definition.py | 122 ++++++ kitten_options_parse.py | 53 +++ kitten_options_types.py | 176 +++++++++ kitten_options_utils.py | 71 ++++ kitty.conf.example | 1 + 12 files changed, 2092 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 _grab_ui.py create mode 100644 grab-vim.conf.example create mode 100644 grab.conf.example create mode 100644 grab.py create mode 100644 kitten_options_definition.py create mode 100644 kitten_options_parse.py create mode 100644 kitten_options_types.py create mode 100644 kitten_options_utils.py create mode 100644 kitty.conf.example diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dfb0ae1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*~ +**/__pycache__/ +.mypy_cache diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d1920d0 --- /dev/null +++ b/README.md @@ -0,0 +1,114 @@ +# Keyboard-driven screen grabber for Kitty + +[Kitty][kitty] is a fast GPU-based terminal emulator. + +[kitty]: https://sw.kovidgoyal.net/kitty/ + +Kitty lets you select text in the terminal using your mouse +and copy it to the clipboard using a key shortcut. +However, it lacks a built-in way to select text using the keyboard. + +This project implements keyboard-driven text selection as a kitten. + + +# Minimum requirements + +Kitty ≥0.21.2. + +For Kitty ≥0.13.0, <0.21.0, see the tag `v0.20`, +but be aware that version will not be updated. + + +# Installation and initial configuration + +* Clone this repository into your Kitty configuration directory: + + $ cd ~/.config/kitty + $ git clone https://github.com/yurikhan/kitty_grab.git + +* In the Kitty configuration file (`kitty.conf`), + map a key to run the `grab.py` kitten: + + map Alt+Insert kitten kitty_grab/grab.py + +* Restart kitty or reload the config (`Ctrl`+`Shift`+`F5` by default, see [kitty.conf](https://sw.kovidgoyal.net/kitty/conf/#shortcut-kitty.Reload-kitty.conf)). + + +# Usage + +When you press the key bound to `kitten grab1.py`, +your screen will briefly flash +and its title will change to indicate the grabber is active. + +You can now move your cursor around the screen using arrow keys. +It will scroll if you try to go beyond the screen top or bottom. +Hold down `Shift` while moving to select a stream region, +or `Alt` to select a rectangular (columnar) region. +Press `Enter` to copy the selected region to the clipboard and exit, +or `Esc` or `q` to exit without copying. + + +## Start/end of buffer + +`Ctrl`+`Home`/`End` move (or, with `Shift` or `Alt`, select) +to the top left or bottom right of the buffer, respectively. + +**Note:** By default, Kitty binds `Ctrl`+`Shift`+`Home`/`End` +to scroll the scrollback buffer to top and bottom, respectively. +You might want to install [`kitty_scroll`][kitty_scroll] +to be able to use these shortcuts with `kitty_grab`. + +[kitty_scroll]: https://github.com/yurikhan/kitty-smart-scroll + + map Ctrl+Shift+Home kitten smart_scroll.py scroll_home Ctrl+Shift+Home + map Ctrl+Shift+End kitten smart_scroll.py scroll_end Ctrl+Shift+End + + +## Word motion + +Hold down `Ctrl` while pressing `←`/`→` to move by words. + + +**Note:** By default, Kitty binds `Ctrl`+`Shift`+`←`/`→` +to activate the previous/next tab. +That will prevent `kitty_grab`, +as well as other terminal-based programs, +from seeing these combinations. +You can either bind different keys in `grab.conf`: + + map Shift+Alt+B select stream word left + map Shift+Alt+F select stream word right + +or rebind previous/next tab to different keys in `kitty.conf` +(recommended): + + map kitty_mod+Left no_op + map kitty_mod+Right no_op + map Ctrl+Page_Up previous_tab + map Ctrl+Page_Down next_tab + +(Remember to [reload config](https://sw.kovidgoyal.net/kitty/conf/#shortcut-kitty.Reload-kitty.conf/) if you modify `kitty.conf`.) + + +# Configuration + +See the `grab.conf.example` file. +You will need to copy it to `~/.config/kitty/grab.conf` +and edit to your liking. + +All example entries are commented out. +Remove the `#` at the start of lines you modify. + +You do not need to reload config when you edit `grab.conf`. +It will take effect the next time you use the grabber. + + +# Vim-like Modal Highlighting + +Vim-like modal selecting is available. +Copy the provided `grab-vim.conf.example` file, and copy it to `~/.config/kitty/grab.conf`. + + +# License + +GNU Public License version 3 or later. diff --git a/_grab_ui.py b/_grab_ui.py new file mode 100644 index 0000000..22949eb --- /dev/null +++ b/_grab_ui.py @@ -0,0 +1,704 @@ +from functools import total_ordering +from itertools import takewhile +import json +import os.path +import re +import sys +from typing import (TYPE_CHECKING, Any, Callable, Dict, Iterable, List, + NamedTuple, Optional, Set, Tuple, Type, Union) +import unicodedata + +from kitty.boss import Boss +from kitty.cli import parse_args +from kitten_options_types import Options, defaults +from kitten_options_parse import create_result_dict, merge_result_dicts, parse_conf_item +from kitty.conf.utils import load_config as _load_config, parse_config_base, resolve_config +from kitty.constants import config_dir +from kitty.fast_data_types import truncate_point_for_length, wcswidth +import kitty.key_encoding as kk +from kitty.key_encoding import KeyEvent +from kitty.rgb import color_as_sgr +from kittens.tui.handler import Handler +from kittens.tui.loop import Loop + + +try: + from kitty.clipboard import set_clipboard_string +except ImportError: + from kitty.fast_data_types import set_clipboard_string + + +if TYPE_CHECKING: + from typing_extensions import TypedDict + ResultDict = TypedDict('ResultDict', {'copy': str}) + +AbsoluteLine = int +ScreenLine = int +ScreenColumn = int +SelectionInLine = Union[Tuple[ScreenColumn, ScreenColumn], + Tuple[None, None]] + + +PositionBase = NamedTuple('Position', [ + ('x', ScreenColumn), ('y', ScreenLine), ('top_line', AbsoluteLine)]) +class Position(PositionBase): + """ + Coordinates of a cell. + + :param x: 0-based, left of window, to the right + :param y: 0-based, top of window, down + :param top_line: 1-based, start of scrollback, down + """ + @property + def line(self) -> AbsoluteLine: + """ + Return 1-based absolute line number. + """ + return self.y + self.top_line + + def moved(self, dx: int = 0, dy: int = 0, + dtop: int = 0) -> 'Position': + """ + Return a new position specified relative to self. + """ + return self._replace(x=self.x + dx, y=self.y + dy, + top_line=self.top_line + dtop) + + def scrolled(self, dtop: int = 0) -> 'Position': + """ + Return a new position equivalent to self + but scrolled dtop lines. + """ + return self.moved(dy=-dtop, dtop=dtop) + + def scrolled_up(self, rows: ScreenLine) -> 'Position': + """ + Return a new position equivalent to self + but with top_line as small as possible. + """ + return self.scrolled(-min(self.top_line - 1, + rows - 1 - self.y)) + + def scrolled_down(self, rows: ScreenLine, + lines: AbsoluteLine) -> 'Position': + """ + Return a new position equivalent to self + but with top_line as large as possible. + """ + return self.scrolled(min(lines - rows + 1 - self.top_line, + self.y)) + + def scrolled_towards(self, other: 'Position', rows: ScreenLine, + lines: Optional[AbsoluteLine] = None) -> 'Position': + """ + Return a new position equivalent to self. + If self and other fit within a single screen, + scroll as little as possible to make both visible. + Otherwise, scroll as much as possible towards other. + """ + # @ + # .| . @| . . + # |.| |. |.| |. |.| + # |*| |*| |*| |*| |*| + # |. |.| |. |.| |@| + # . .| . @| . + # @ + if other.line <= self.line - rows: # above, unreachable + return self.scrolled_up(rows) + if other.line >= self.line + rows: # below, unreachable + assert lines is not None + return self.scrolled_down(rows, lines) + if other.line < self.top_line: # above, reachable + return self.scrolled(other.line - self.top_line) + if other.line > self.top_line + rows - 1: # below, reachable + return self.scrolled(other.line - self.top_line - rows + 1) + return self # visible + + def __str__(self) -> str: + return '{},{}+{}'.format(self.x, self.y, self.top_line) + + def __lt__(self, other: Any) -> bool: + if not isinstance(other, Position): + return NotImplemented + return (self.line, self.x) < (other.line, other.x) + + def __le__(self, other: Any) -> bool: + if not isinstance(other, Position): + return NotImplemented + return (self.line, self.x) <= (other.line, other.x) + + def __gt__(self, other: Any) -> bool: + if not isinstance(other, Position): + return NotImplemented + return (self.line, self.x) > (other.line, other.x) + + def __ge__(self, other: Any) -> bool: + if not isinstance(other, Position): + return NotImplemented + return (self.line, self.x) >= (other.line, other.x) + + def __eq__(self, other: Any) -> bool: + if not isinstance(other, Position): + return NotImplemented + return (self.line, self.x) == (other.line, other.x) + + def __ne__(self, other: Any) -> bool: + if not isinstance(other, Position): + return NotImplemented + return (self.line, self.x) != (other.line, other.x) + + +def _span(line: AbsoluteLine, *lines: AbsoluteLine) -> Set[AbsoluteLine]: + return set(range(min(line, *lines), max(line, *lines) + 1)) + + +class Region: + name = None # type: Optional[str] + uses_mark = False + + @staticmethod + def line_inside_region(current_line: AbsoluteLine, + start: Position, end: Position) -> bool: + """ + Return True if current_line is entirely inside the region + defined by start and end. + """ + return False + + @staticmethod + def line_outside_region(current_line: AbsoluteLine, + start: Position, end: Position) -> bool: + """ + Return True if current_line is entirely outside the region + defined by start and end. + """ + return current_line < start.line or end.line < current_line + + @staticmethod + def adjust(start: Position, end: Position) -> Tuple[Position, Position]: + """ + Return the normalized pair of markers + equivalent to start and end. This is region-type-specific. + """ + return start, end + + @staticmethod + def selection_in_line( + current_line: int, start: Position, end: Position, + maxx: int) -> SelectionInLine: + """ + Return bounds of the part of current_line + that are within the region defined by start and end. + """ + return None, None + + @staticmethod + def lines_affected(mark: Optional[Position], old_point: Position, + point: Position) -> Set[AbsoluteLine]: + """ + Return the set of lines (1-based, top of scrollback, down) + that must be redrawn when point moves from old_point. + """ + return set() + + @staticmethod + def page_up(mark: Optional[Position], point: Position, + rows: ScreenLine, lines: AbsoluteLine) -> Position: + """ + Return the position page up from point. + """ + # ........ + # ....$...| + # ........ ....$...| ........| + # |....$...| |....^...| |....^...| + # |....^...| |........| |........ + # |........| |........ |........ + # ........ ........ ........ + if point.y > 0: + return Position(point.x, 0, point.top_line) + assert point.y == 0 + return Position(point.x, 0, + max(1, point.top_line - rows + 1)) + + @staticmethod + def page_down(mark: Optional[Position], point: Position, + rows: ScreenLine, lines: AbsoluteLine) -> Position: + """ + Return the position page down from point. + """ + # ........ ........ ........ + # |........| |........ |........ + # |....^...| |........| |........ + # |....$...| |....^...| |....^...| + # ........ ....$...| ........| + # ....$...| + # ........ + maxy = rows - 1 + if point.y < maxy: + return Position(point.x, maxy, point.top_line) + assert point.y == maxy + return Position(point.x, maxy, + min(lines - maxy, point.top_line + maxy)) + + +class NoRegion(Region): + name = 'unselected' + uses_mark = False + + @staticmethod + def line_outside_region(current_line: AbsoluteLine, + start: Position, end: Position) -> bool: + return False + + +class MarkedRegion(Region): + uses_mark = True + + # When a region is marked, + # override page up and down motion + # to keep as much region visible as possible. + # + # This means, + # after computing the position in the usual way, + # do the minimum possible scroll adjustment + # to bring both mark and point on screen. + # If that is not possible, + # do the maximum possible scroll adjustment + # towards mark + # that keeps point on screen. + @staticmethod + def page_up(mark: Optional[Position], point: Position, + rows: ScreenLine, lines: AbsoluteLine) -> Position: + assert mark is not None + return (Region.page_up(mark, point, rows, lines) + .scrolled_towards(mark, rows, lines)) + + @staticmethod + def page_down(mark: Optional[Position], point: Position, + rows: ScreenLine, lines: AbsoluteLine) -> Position: + assert mark is not None + return (Region.page_down(mark, point, rows, lines) + .scrolled_towards(mark, rows, lines)) + + +class StreamRegion(MarkedRegion): + name = 'stream' + + @staticmethod + def line_inside_region(current_line: AbsoluteLine, + start: Position, end: Position) -> bool: + return start.line < current_line < end.line + + @staticmethod + def selection_in_line( + current_line: AbsoluteLine, start: Position, end: Position, + maxx: ScreenColumn) -> SelectionInLine: + if StreamRegion.line_outside_region(current_line, start, end): + return None, None + return (start.x if current_line == start.line else 0, + end.x if current_line == end.line else maxx) + + @staticmethod + def lines_affected(mark: Optional[Position], old_point: Position, + point: Position) -> Set[AbsoluteLine]: + return _span(old_point.line, point.line) + + +class ColumnarRegion(MarkedRegion): + name = 'columnar' + + @staticmethod + def adjust(start: Position, end: Position) -> Tuple[Position, Position]: + return (start._replace(x=min(start.x, end.x)), + end._replace(x=max(start.x, end.x))) + + @staticmethod + def selection_in_line( + current_line: AbsoluteLine, start: Position, end: Position, + maxx: ScreenColumn) -> SelectionInLine: + if ColumnarRegion.line_outside_region(current_line, start, end): + return None, None + return start.x, end.x + + @staticmethod + def lines_affected(mark: Optional[Position], old_point: Position, + point: Position) -> Set[AbsoluteLine]: + assert mark is not None + # If column changes, all lines change. + if old_point.x != point.x: + return _span(mark.line, old_point.line, point.line) + # If point passes mark, all passed lines change except mark line. + if old_point < mark < point or point < mark < old_point: + return _span(old_point.line, point.line) - {mark.line} + # If point moves away from mark, + # all passed lines change except old point line. + elif mark < old_point < point or point < old_point < mark: + return _span(old_point.line, point.line) - {old_point.line} + # Otherwise, point moves toward mark, + # and all passed lines change except new point line. + else: + return _span(old_point.line, point.line) - {point.line} + + +ActionName = str +ActionArgs = tuple +ShortcutMods = int +KeyName = str +Namespace = Any # kitty.cli.Namespace (< 0.17.0) +OptionName = str +OptionValues = Dict[OptionName, Any] +TypeMap = Dict[OptionName, Callable[[Any], Any]] + + +def load_config(*paths: str, overrides: Optional[Iterable[str]] = None) -> Options: + + def parse_config(lines: Iterable[str]) -> Dict[str, Any]: + ans: Dict[str, Any] = create_result_dict() + parse_config_base( + lines, + parse_conf_item, + ans, + ) + return ans + + configs = list(resolve_config('/etc/xdg/kitty/grab.conf', + os.path.join(config_dir, 'grab.conf'), + config_files_on_cmd_line=[])) + overrides = tuple(overrides) if overrides is not None else () + opts_dict, paths = _load_config(defaults, parse_config, merge_result_dicts, *configs, overrides=overrides) + opts = Options(opts_dict) + opts.config_paths = paths + opts.config_overrides = overrides + return opts + + +def unstyled(s: str) -> str: + s = re.sub(r'\x1b\[[0-9;:]*m', '', s) + s = re.sub(r'\x1b\](?:[^\x07\x1b]+|\x1b[^\\])*(?:\x1b\\|\x07)', '', s) + return s + + +def string_slice(s: str, start_x: ScreenColumn, + end_x: ScreenColumn) -> Tuple[str, bool]: + prev_pos = (truncate_point_for_length(s, start_x - 1) if start_x > 0 + else None) + start_pos = truncate_point_for_length(s, start_x) + end_pos = truncate_point_for_length(s, end_x - 1) + 1 + return s[start_pos:end_pos], prev_pos == start_pos + + +DirectionStr = str +RegionTypeStr = str +ModeTypeStr = str + + +class GrabHandler(Handler): + def __init__(self, args: Namespace, opts: Options, + lines: List[str]) -> None: + super().__init__() + self.args = args + self.opts = opts + self.lines = lines + self.point = Position(args.x, args.y, args.top_line) + self.mark = None # type: Optional[Position] + self.mark_type = NoRegion # type: Type[Region] + self.mode = 'normal' # type: ModeTypeStr + self.result = None # type: Optional[ResultDict] + for spec, action in self.opts.map: + self.add_shortcut(action, spec) + + def _start_end(self) -> Tuple[Position, Position]: + start, end = sorted([self.point, self.mark or self.point]) + return self.mark_type.adjust(start, end) + + def _draw_line(self, current_line: AbsoluteLine) -> None: + y = current_line - self.point.top_line # type: ScreenLine + line = self.lines[current_line - 1] + clear_eol = '\x1b[m\x1b[K' + sgr0 = '\x1b[m' + + plain = unstyled(line) + selection_sgr = '\x1b[38{};48{}m'.format( + color_as_sgr(self.opts.selection_foreground), + color_as_sgr(self.opts.selection_background)) + start, end = self._start_end() + + # anti-flicker optimization + if self.mark_type.line_inside_region(current_line, start, end): + self.cmd.set_cursor_position(0, y) + self.print('{}{}'.format(selection_sgr, plain), + end=clear_eol) + return + + self.cmd.set_cursor_position(0, y) + self.print('{}{}'.format(sgr0, line), end=clear_eol) + + if self.mark_type.line_outside_region(current_line, start, end): + return + + start_x, end_x = self.mark_type.selection_in_line( + current_line, start, end, wcswidth(plain)) + if start_x is None or end_x is None: + return + + line_slice, half = string_slice(plain, start_x, end_x) + self.cmd.set_cursor_position(start_x - (1 if half else 0), y) + self.print('{}{}'.format(selection_sgr, line_slice), end='') + + def _update(self) -> None: + self.cmd.set_window_title('Grab – {} {} {},{}+{} to {},{}+{}'.format( + self.args.title, + self.mark_type.name, + getattr(self.mark, 'x', None), getattr(self.mark, 'y', None), + getattr(self.mark, 'top_line', None), + self.point.x, self.point.y, self.point.top_line)) + self.cmd.set_cursor_position(self.point.x, self.point.y) + + def _redraw_lines(self, lines: Iterable[AbsoluteLine]) -> None: + for line in lines: + self._draw_line(line) + self._update() + + def _redraw(self) -> None: + self._redraw_lines(range( + self.point.top_line, + self.point.top_line + self.screen_size.rows)) + + def initialize(self) -> None: + self.cmd.set_window_title('Grab – {}'.format(self.args.title)) + self._redraw() + + def perform_default_key_action(self, key_event: KeyEvent) -> bool: + return False + + def on_key_event(self, key_event: KeyEvent, in_bracketed_paste: bool = False) -> None: + action = self.shortcut_action(key_event) + if (key_event.type not in [kk.PRESS, kk.REPEAT] + or action is None): + return + self.perform_action(action) + + def perform_action(self, action: Tuple[ActionName, ActionArgs]) -> None: + func, args = action + getattr(self, func)(*args) + + def quit(self, *args: Any) -> None: + self.quit_loop(1) + + region_types = {'stream': StreamRegion, + 'columnar': ColumnarRegion + } # type: Dict[RegionTypeStr, Type[Region]] + + mode_types = {'normal': NoRegion, + 'visual': StreamRegion, + 'block': ColumnarRegion, + } # type: Dict[ModeTypeStr, Type[Region]] + + def _ensure_mark(self, mark_type: Type[Region] = StreamRegion) -> None: + need_redraw = mark_type is not self.mark_type + self.mark_type = mark_type + self.mark = (self.mark or self.point) if mark_type.uses_mark else None + if need_redraw: + self._redraw() + + def _scroll(self, dtop: int) -> None: + rows = self.screen_size.rows + new_point = self.point.moved(dtop=dtop) + if not (0 < new_point.top_line <= 1 + len(self.lines) - rows): + return + self.point = new_point + self._redraw() + + def scroll(self, direction: DirectionStr) -> None: + self._scroll(dtop={'up': -1, 'down': 1}[direction]) + + def left(self) -> Position: + return self.point.moved(dx=-1) if self.point.x > 0 else self.point + + def right(self) -> Position: + return (self.point.moved(dx=1) + if self.point.x + 1 < self.screen_size.cols + else self.point) + + def up(self) -> Position: + return (self.point.moved(dy=-1) if self.point.y > 0 else + self.point.moved(dtop=-1) if self.point.top_line > 0 else + self.point) + + def down(self) -> Position: + return (self.point.moved(dy=1) + if self.point.y + 1 < self.screen_size.rows + else self.point.moved(dtop=1) + if self.point.line < len(self.lines) + else self.point) + + def page_up(self) -> Position: + return self.mark_type.page_up( + self.mark, self.point, self.screen_size.rows, + max(self.screen_size.rows, len(self.lines))) + + def page_down(self) -> Position: + return self.mark_type.page_down( + self.mark, self.point, self.screen_size.rows, + max(self.screen_size.rows, len(self.lines))) + + def first(self) -> Position: + return Position(0, self.point.y, self.point.top_line) + + def first_nonwhite(self) -> Position: + line = unstyled(self.lines[self.point.line - 1]) + prefix = ''.join(takewhile(str.isspace, line)) + return Position(wcswidth(prefix), self.point.y, self.point.top_line) + + def last_nonwhite(self) -> Position: + line = unstyled(self.lines[self.point.line - 1]) + suffix = ''.join(takewhile(str.isspace, reversed(line))) + return Position(wcswidth(line[:len(line) - len(suffix)]), + self.point.y, self.point.top_line) + + def last(self) -> Position: + return Position(self.screen_size.cols, + self.point.y, self.point.top_line) + + def top(self) -> Position: + return Position(0, 0, 1) + + def bottom(self) -> Position: + x = wcswidth(unstyled(self.lines[-1])) + y = min(len(self.lines) - self.point.top_line, + self.screen_size.rows - 1) + return Position(x, y, len(self.lines) - y) + + def noop(self) -> Position: + return self.point + + @property + def _select_by_word_characters(self) -> str: + return (self.opts.select_by_word_characters + or (json.loads(os.getenv('KITTY_COMMON_OPTS', '{}')) + .get('select_by_word_characters', '@-./_~?&=%+#'))) + + def _is_word_char(self, c: str) -> bool: + return (unicodedata.category(c)[0] in 'LN' + or c in self._select_by_word_characters) + + def _is_word_separator(self, c: str) -> bool: + return (unicodedata.category(c)[0] not in 'LN' + and c not in self._select_by_word_characters) + + def word_left(self) -> Position: + if self.point.x > 0: + line = unstyled(self.lines[self.point.line - 1]) + pos = truncate_point_for_length(line, self.point.x) + pred = (self._is_word_char if self._is_word_char(line[pos - 1]) + else self._is_word_separator) + new_pos = pos - len(''.join(takewhile(pred, reversed(line[:pos])))) + return Position(wcswidth(line[:new_pos]), + self.point.y, self.point.top_line) + if self.point.y > 0: + return Position(wcswidth(unstyled(self.lines[self.point.line - 2])), + self.point.y - 1, self.point.top_line) + if self.point.top_line > 1: + return Position(wcswidth(unstyled(self.lines[self.point.line - 2])), + self.point.y, self.point.top_line - 1) + return self.point + + def word_right(self) -> Position: + line = unstyled(self.lines[self.point.line - 1]) + pos = truncate_point_for_length(line, self.point.x) + if pos < len(line): + pred = (self._is_word_char if self._is_word_char(line[pos]) + else self._is_word_separator) + new_pos = pos + len(''.join(takewhile(pred, line[pos:]))) + return Position(wcswidth(line[:new_pos]), + self.point.y, self.point.top_line) + if self.point.y < self.screen_size.rows - 1: + return Position(0, self.point.y + 1, self.point.top_line) + if self.point.top_line + self.point.y < len(self.lines): + return Position(0, self.point.y, self.point.top_line + 1) + return self.point + + def _select(self, direction: DirectionStr, + mark_type: Type[Region]) -> None: + self._ensure_mark(mark_type) + old_point = self.point + self.point = (getattr(self, direction))() + if self.point.top_line != old_point.top_line: + self._redraw() + else: + self._redraw_lines(self.mark_type.lines_affected( + self.mark, old_point, self.point)) + + def move(self, direction: DirectionStr) -> None: + self._select(direction, self.mode_types[self.mode]) + + def select(self, region_type: RegionTypeStr, + direction: DirectionStr) -> None: + self._select(direction, self.region_types[region_type]) + + def set_mode(self, mode: ModeTypeStr) -> None: + self.mode = mode + self._select('noop', self.mode_types[mode]) + + def confirm(self, *args: Any) -> None: + start, end = self._start_end() + self.result = {'copy': '\n'.join( + line_slice + for line in range(start.line, end.line + 1) + for plain in [unstyled(self.lines[line - 1])] + for start_x, end_x in [self.mark_type.selection_in_line( + line, start, end, len(plain))] + if start_x is not None and end_x is not None + for line_slice, _half in [string_slice(plain, start_x, end_x)])} + self.quit_loop(0) + + +def main(args: List[str]) -> Optional['ResultDict']: + def ospec() -> str: + return ''' +--cursor-x +dest=x +type=int +(Internal) Starting cursor column, 0-based. + + +--cursor-y +dest=y +type=int +(Internal) Starting cursor line, 0-based. + + +--top-line +dest=top_line +type=int +(Internal) Window scroll offset, 1-based. + + +--title +(Internal)''' + + try: + args, _rest = parse_args(args[1:], ospec) + tty = open(os.ctermid()) + lines = (sys.stdin.buffer.read().decode('utf-8') + .split('\n')[:-1]) # last line ends with \n, too + sys.stdin = tty + opts = load_config() + handler = GrabHandler(args, opts, lines) + loop = Loop() + loop.loop(handler) + return handler.result + except Exception as e: + from kittens.tui.loop import debug + from traceback import format_exc + debug(format_exc()) + raise + + +WindowId = int + + +def handle_result(args: List[str], result: 'ResultDict', + target_window_id: WindowId, boss: Boss) -> None: + if 'copy' in result: + set_clipboard_string(result['copy']) diff --git a/grab-vim.conf.example b/grab-vim.conf.example new file mode 100644 index 0000000..2e4e1a7 --- /dev/null +++ b/grab-vim.conf.example @@ -0,0 +1,55 @@ +# vim:fileencoding=utf-8:ft=conf:foldmethod=marker + +#: Colors {{{ + +# selection_foreground #FFFFFF +# selection_background #5294E2 + +#: Colors for selected text while grabbing. + +#: }}} + +#: Key shortcuts {{{ + +# map q quit + +#: Exit the grabber without copying anything. + +# map Enter confirm +map y confirm + +#: Copy the selected region to clipboard and exit. + +map h move left +map l move right +map k move up +map j move down +map Ctrl+u move page up +map Ctrl+d move page down +map 0 move first +map ^ move first nonwhite +map $ move last nonwhite +map g move top +map G move bottom +map b move word left +map w move word right + +#: Move the cursor around the screen. +#: This will scroll the buffer if needed and possible. +#: Note that due to https://github.com/kovidgoyal/kitty/issues/5469, the ctrl+d +#: shortcut will only work with kitty >= 0.26.2 + +map Ctrl+y scroll up +map Ctrl+e scroll down + +#: Scroll the buffer, if possible. +#: Cursor stays in the same position relative to the screen. + +map v set_mode visual +map Ctrl+v set_mode block +map Ctrl+Left_Bracket set_mode normal +map Escape set_mode normal + +#: Change the selecting mode. + +#: }}} diff --git a/grab.conf.example b/grab.conf.example new file mode 100644 index 0000000..f2d33fd --- /dev/null +++ b/grab.conf.example @@ -0,0 +1,86 @@ +# vim:fileencoding=utf-8:ft=conf:foldmethod=marker + +#: Colors {{{ + +# selection_foreground #FFFFFF +# selection_background #5294E2 + +#: Colors for selected text while grabbing. + +#: }}} + +#: Key shortcuts {{{ + +# map q quit +# map Escape quit + +#: Exit the grabber without copying anything. + +# map Enter confirm + +#: Copy the selected region to clipboard and exit. + +# map Left move left +# map Right move right +# map Up move up +# map Down move down +# map Page_Up move page up +# map Page_Down move page down +# map Home move first +# map a move first nonwhite +# map End move last nonwhite +# map e move last +# map Ctrl+Home move top +# map Ctrl+End move bottom +# map Ctrl+Left move word left +# map Ctrl+Right move word right + +#: Cancel selection and move the cursor around the screen. +#: This will scroll the buffer if needed and possible. + +# map Ctrl+Up scroll up +# map Ctrl+Down scroll down + +#: Scroll the buffer, if possible. +#: Cursor stays in the same position relative to the screen. + +# map Shift+Left select stream left +# map Shift+Right select stream right +# map Shift+Up select stream up +# map Shift+Down select stream down +# map Shift+Page_Up select stream page up +# map Shift+Page_Down select stream page down +# map Shift+Home select stream first +# map A select stream first nonwhite +# map Shift+End select stream last nonwhite +# map E select stream last +# map Shift+Ctrl+Home select stream top +# map Shift+Ctrl+End select stream bottom +# map Shift+Ctrl+Left select stream word left +# map Shift+Ctrl+Right select stream word right + +#: Extend a stream selection. +#: If no region is selected, start selecting. +#: Stream selection includes all characters between the region ends. + +# map Alt+Left select columnar left +# map Alt+Right select columnar right +# map Alt+Up select columnar up +# map Alt+Down select columnar down +# map Alt+Page_Up select columnar page up +# map Alt+Page_Down select columnar page down +# map Alt+Home select columnar first +# map Alt+A select columnar first nonwhite +# map Alt+End select columnar last nonwhite +# map Alt+E select columnar last +# map Alt+Ctrl+Home select columnar top +# map Alt+Ctrl+End select columnar bottom +# map Alt+Ctrl+Left select columnar word left +# map Alt+Ctrl+Right select columnar word right + +#: Extend a columnar selection. +#: If no region is selected, start selecting. +#: Columnar selection includes characters in the rectangle +#: defined by the region ends. + +#: }}} diff --git a/grab.py b/grab.py new file mode 100644 index 0000000..5ca77c5 --- /dev/null +++ b/grab.py @@ -0,0 +1,33 @@ +import os +from typing import Any, Dict, List, Sequence + +from kittens.tui.handler import result_handler +from kitty.typing import BossType + +import _grab_ui + + +def main(args: List[str]) -> None: + pass + + +@result_handler(no_ui=True) +def handle_result(args: List[str], data: Dict[str, Any], target_window_id: int, boss: BossType) -> None: + window = boss.window_id_map.get(target_window_id) + if window is None: + return + tab = window.tabref() + if tab is None: + return + content = window.as_text(as_ansi=True, add_history=True, + add_wrap_markers=True) + content = content.replace('\r\n', '\n').replace('\r', '\n') + n_lines = content.count('\n') + top_line = (n_lines - (window.screen.lines - 1) - window.screen.scrolled_by) + boss._run_kitten(_grab_ui.__file__, args=[ + '--title={}'.format(window.title), + '--cursor-x={}'.format(window.screen.cursor.x), + '--cursor-y={}'.format(window.screen.cursor.y), + '--top-line={}'.format(top_line)], + input_data=content.encode('utf-8'), + window=window) diff --git a/kitten_options_definition.py b/kitten_options_definition.py new file mode 100644 index 0000000..234d31c --- /dev/null +++ b/kitten_options_definition.py @@ -0,0 +1,122 @@ +from kitty.conf.types import Action, Definition + +definition = Definition( + '!kitten_options_utils', + Action( + 'map', 'parse_map', + {'key_definitions': 'kitty.conf.utils.KittensKeyMap'}, + ['kitty.types.ParsedShortcut', 'kitty.conf.utils.KeyAction'] + ), +) + +agr = definition.add_group +egr = definition.end_group +opt = definition.add_option +map = definition.add_map + +# color options {{{ +agr('color', 'Color') + +opt('selection_foreground', '#FFFFFF', + option_type='to_color', + long_text=''' +Foreground color for selected text while grabbing.''') +opt('selection_background', '#5294E2', + option_type='to_color', + long_text=''' +Background color for selected text while grabbing.''') + +egr() # }}} + +# shortcuts {{{ +agr('shortcuts', 'Keyboard shortcuts') + +long_text = ''' +Exit the grabber without copying anything.''' +map('Quit', 'quit q quit') +map('Quit', 'quit Escape quit', long_text=long_text) + +long_text = ''' +Copy the selected region to clipboard and exit.''' +map('Confirm', 'confirm Enter confirm', long_text=long_text) + +long_text = ''' +Cancel selection and move the cursor around the screen. +This will scroll the buffer if needed and possible.''' +map('Move left', 'move Left move left') +map('Move right', 'move Right move right') +map('Move up', 'move Up move up') +map('Move down', 'move Down move down') +map('Move page up', 'move Page_Up move page up') +map('Move page down', 'move Page_Down move page down') +map('Move first', 'move Home move first') +map('Move first nonwhite', 'move a move first nonwhite') +map('Move last nonwhite', 'move End move last nonwhite') +map('Move last', 'move e move last') +map('Move top', 'move Ctrl+Home move top') +map('Move bottom', 'move Ctrl+End move bottom') +map('Move word left', 'move Ctrl+Left move word left') +map('Move word right', 'move Ctrl+Right move word right', long_text=long_text) + +long_text = ''' +Scroll the buffer, if possible. +Cursor stays in the same position relative to the screen.''' +map('Scroll up', 'scroll Ctrl+Up scroll up') +map('Scroll down', 'scroll Ctrl+Down scroll down', long_text=long_text) + +long_text = ''' +#: Extend a stream selection. +#: If no region is selected, start selecting. +#: Stream selection includes all characters between the region ends.''' +map('SelectStream left', 'select_stream Shift+Left select stream left') +map('SelectStream right', 'select_stream Shift+Right select stream right') +map('SelectStream up', 'select_stream Shift+Up select stream up') +map('SelectStream down', 'select_stream Shift+Down select stream down') +map('SelectStream page up', 'select_stream Shift+Page_Up select stream page up') +map('SelectStream page down', 'select_stream Shift+Page_Down select stream page down') +map('SelectStream first', 'select_stream Shift+Home select stream first') +map('SelectStream first nonwhite', 'select_stream A select stream first nonwhite') +map('SelectStream last nonwhite', 'select_stream Shift+End select stream last nonwhite') +map('SelectStream last', 'select_stream E select stream last') +map('SelectStream top', 'select_stream Shift+Ctrl+Home select stream top') +map('SelectStream bottom', 'select_stream Shift+Ctrl+End select stream bottom') +map('SelectStream word left', 'select_stream Shift+Ctrl+Left select stream word left') +map('SelectStream word right', 'select_stream Shift+Ctrl+Right select stream word right', long_text=long_text) + +long_text = ''' +Extend a columnar selection. +If no region is selected, start selecting. +Columnar selection includes characters in the rectangle +defined by the region ends.''' +map('SelectColumnar left', 'select_columnar Alt+Left select columnar left') +map('SelectColumnar right', 'select_columnar Alt+Right select columnar right') +map('SelectColumnar up', 'select_columnar Alt+Up select columnar up') +map('SelectColumnar down', 'select_columnar Alt+Down select columnar down') +map('SelectColumnar page up', 'select_columnar Alt+Page_Up select columnar page up') +map('SelectColumnar page down', 'select_columnar Alt+Page_Down select columnar page down') +map('SelectColumnar first', 'select_columnar Alt+Home select columnar first') +map('SelectColumnar first nonwhite', 'select_columnar Alt+A select columnar first nonwhite') +map('SelectColumnar last nonwhite', 'select_columnar Alt+End select columnar last nonwhite') +map('SelectColumnar last', 'select_columnar Alt+E select columnar last') +map('SelectColumnar top', 'select_columnar Alt+Ctrl+Home select columnar top') +map('SelectColumnar bottom', 'select_columnar Alt+Ctrl+End select columnar bottom') +map('SelectColumnar word left', 'select_columnar Alt+Ctrl+Left select columnar word left') +map('SelectColumnar word right', 'select_columnar Alt+Ctrl+Right select columnar word right', long_text=long_text) + +long_text = ''' +Keys to enable vim-like modal selecting.''' +map('SetMode visual', 'set_mode v set_mode visual') +map('SetMode block', 'set_mode Ctrl+v set_mode block') +map('SetMode normal', 'set_mode Ctrl+LeftBracket set_mode normal', long_text=long_text) + +egr() # }}} + +agr('behavior', 'Behavior') # {{{ + +opt('select_by_word_characters', '', + option_type='str', + long_text=''' +Characters considered part of a word when moving by words. +By default, those are taken from main Kitty config.''') + +egr() # }}} diff --git a/kitten_options_parse.py b/kitten_options_parse.py new file mode 100644 index 0000000..52010d7 --- /dev/null +++ b/kitten_options_parse.py @@ -0,0 +1,53 @@ +# generated by gen-config.py DO NOT edit + +import typing +from kitten_options_utils import parse_map +from kitty.conf.utils import merge_dicts, to_color + + +class Parser: + + def select_by_word_characters(self, val: str, ans: typing.Dict[str, typing.Any]) -> None: + ans['select_by_word_characters'] = str(val) + + def selection_background(self, val: str, ans: typing.Dict[str, typing.Any]) -> None: + ans['selection_background'] = to_color(val) + + def selection_foreground(self, val: str, ans: typing.Dict[str, typing.Any]) -> None: + ans['selection_foreground'] = to_color(val) + + def map(self, val: str, ans: typing.Dict[str, typing.Any]) -> None: + for k in parse_map(val): + ans['map'].append(k) + + +def create_result_dict() -> typing.Dict[str, typing.Any]: + return { + 'map': [], + } + + +actions: typing.FrozenSet[str] = frozenset(('map',)) + + +def merge_result_dicts(defaults: typing.Dict[str, typing.Any], vals: typing.Dict[str, typing.Any]) -> typing.Dict[str, typing.Any]: + ans = {} + for k, v in defaults.items(): + if isinstance(v, dict): + ans[k] = merge_dicts(v, vals.get(k, {})) + elif k in actions: + ans[k] = v + vals.get(k, []) + else: + ans[k] = vals.get(k, v) + return ans + + +parser = Parser() + + +def parse_conf_item(key: str, val: str, ans: typing.Dict[str, typing.Any]) -> bool: + func = getattr(parser, key, None) + if func is not None: + func(val, ans) + return True + return False diff --git a/kitten_options_types.py b/kitten_options_types.py new file mode 100644 index 0000000..79654c7 --- /dev/null +++ b/kitten_options_types.py @@ -0,0 +1,176 @@ +# generated by gen-config.py DO NOT edit + +import typing +from kitty.conf.utils import KeyAction, KittensKeyMap +import kitty.conf.utils +from kitty.fast_data_types import Color +import kitty.fast_data_types +from kitty.types import ParsedShortcut +import kitty.types + + +option_names = ( # {{{ + 'map', + 'select_by_word_characters', + 'selection_background', + 'selection_foreground') # }}} + + +class Options: + select_by_word_characters: str = '' + selection_background: Color = Color(82, 148, 226) + selection_foreground: Color = Color(255, 255, 255) + map: typing.List[typing.Tuple[kitty.types.ParsedShortcut, kitty.conf.utils.KeyAction]] = [] + key_definitions: KittensKeyMap = {} + config_paths: typing.Tuple[str, ...] = () + config_overrides: typing.Tuple[str, ...] = () + + def __init__(self, options_dict: typing.Optional[typing.Dict[str, typing.Any]] = None) -> None: + if options_dict is not None: + null = object() + for key in option_names: + val = options_dict.get(key, null) + if val is not null: + setattr(self, key, val) + + @property + def _fields(self) -> typing.Tuple[str, ...]: + return option_names + + def __iter__(self) -> typing.Iterator[str]: + return iter(self._fields) + + def __len__(self) -> int: + return len(self._fields) + + def _copy_of_val(self, name: str) -> typing.Any: + ans = getattr(self, name) + if isinstance(ans, dict): + ans = ans.copy() + elif isinstance(ans, list): + ans = ans[:] + return ans + + def _asdict(self) -> typing.Dict[str, typing.Any]: + return {k: self._copy_of_val(k) for k in self} + + def _replace(self, **kw: typing.Any) -> "Options": + ans = Options() + for name in self: + setattr(ans, name, self._copy_of_val(name)) + for name, val in kw.items(): + setattr(ans, name, val) + return ans + + def __getitem__(self, key: typing.Union[int, str]) -> typing.Any: + k = option_names[key] if isinstance(key, int) else key + try: + return getattr(self, k) + except AttributeError: + pass + raise KeyError(f"No option named: {k}") + + +defaults = Options() +defaults.map = [ + # quit + (ParsedShortcut(mods=0, key_name='q'), KeyAction('quit')), # noqa + # quit + (ParsedShortcut(mods=0, key_name='ESCAPE'), KeyAction('quit')), # noqa + # confirm + (ParsedShortcut(mods=0, key_name='ENTER'), KeyAction('confirm')), # noqa + # move + (ParsedShortcut(mods=0, key_name='LEFT'), KeyAction('move', ('left',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='RIGHT'), KeyAction('move', ('right',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='UP'), KeyAction('move', ('up',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='DOWN'), KeyAction('move', ('down',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='PAGE_UP'), KeyAction('move', ('page_up',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='PAGE_DOWN'), KeyAction('move', ('page_down',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='HOME'), KeyAction('move', ('first',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='a'), KeyAction('move', ('first_nonwhite',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='END'), KeyAction('move', ('last_nonwhite',))), # noqa + # move + (ParsedShortcut(mods=0, key_name='e'), KeyAction('move', ('last',))), # noqa + # move + (ParsedShortcut(mods=4, key_name='HOME'), KeyAction('move', ('top',))), # noqa + # move + (ParsedShortcut(mods=4, key_name='END'), KeyAction('move', ('bottom',))), # noqa + # move + (ParsedShortcut(mods=4, key_name='LEFT'), KeyAction('move', ('word_left',))), # noqa + # move + (ParsedShortcut(mods=4, key_name='RIGHT'), KeyAction('move', ('word_right',))), # noqa + # scroll + (ParsedShortcut(mods=4, key_name='UP'), KeyAction('scroll', ('up',))), # noqa + # scroll + (ParsedShortcut(mods=4, key_name='DOWN'), KeyAction('scroll', ('down',))), # noqa + # select_stream + (ParsedShortcut(mods=1, key_name='LEFT'), KeyAction('select', ('stream', 'left'))), # noqa + # select_stream + (ParsedShortcut(mods=1, key_name='RIGHT'), KeyAction('select', ('stream', 'right'))), # noqa + # select_stream + (ParsedShortcut(mods=1, key_name='UP'), KeyAction('select', ('stream', 'up'))), # noqa + # select_stream + (ParsedShortcut(mods=1, key_name='DOWN'), KeyAction('select', ('stream', 'down'))), # noqa + # select_stream + (ParsedShortcut(mods=1, key_name='PAGE_UP'), KeyAction('select', ('stream', 'page_up'))), # noqa + # select_stream + (ParsedShortcut(mods=1, key_name='PAGE_DOWN'), KeyAction('select', ('stream', 'page_down'))), # noqa + # select_stream + (ParsedShortcut(mods=1, key_name='HOME'), KeyAction('select', ('stream', 'first'))), # noqa + # select_stream + (ParsedShortcut(mods=0, key_name='A'), KeyAction('select', ('stream', 'first_nonwhite'))), # noqa + # select_stream + (ParsedShortcut(mods=1, key_name='END'), KeyAction('select', ('stream', 'last_nonwhite'))), # noqa + # select_stream + (ParsedShortcut(mods=0, key_name='E'), KeyAction('select', ('stream', 'last'))), # noqa + # select_stream + (ParsedShortcut(mods=5, key_name='HOME'), KeyAction('select', ('stream', 'top'))), # noqa + # select_stream + (ParsedShortcut(mods=5, key_name='END'), KeyAction('select', ('stream', 'bottom'))), # noqa + # select_stream + (ParsedShortcut(mods=5, key_name='LEFT'), KeyAction('select', ('stream', 'word_left'))), # noqa + # select_stream + (ParsedShortcut(mods=5, key_name='RIGHT'), KeyAction('select', ('stream', 'word_right'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='LEFT'), KeyAction('select', ('columnar', 'left'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='RIGHT'), KeyAction('select', ('columnar', 'right'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='UP'), KeyAction('select', ('columnar', 'up'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='DOWN'), KeyAction('select', ('columnar', 'down'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='PAGE_UP'), KeyAction('select', ('columnar', 'page_up'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='PAGE_DOWN'), KeyAction('select', ('columnar', 'page_down'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='HOME'), KeyAction('select', ('columnar', 'first'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='A'), KeyAction('select', ('columnar', 'first_nonwhite'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='END'), KeyAction('select', ('columnar', 'last_nonwhite'))), # noqa + # select_columnar + (ParsedShortcut(mods=2, key_name='E'), KeyAction('select', ('columnar', 'last'))), # noqa + # select_columnar + (ParsedShortcut(mods=6, key_name='HOME'), KeyAction('select', ('columnar', 'top'))), # noqa + # select_columnar + (ParsedShortcut(mods=6, key_name='END'), KeyAction('select', ('columnar', 'bottom'))), # noqa + # select_columnar + (ParsedShortcut(mods=6, key_name='LEFT'), KeyAction('select', ('columnar', 'word_left'))), # noqa + # select_columnar + (ParsedShortcut(mods=6, key_name='RIGHT'), KeyAction('select', ('columnar', 'word_right'))), # noqa + # set_mode + (ParsedShortcut(mods=0, key_name='v'), KeyAction('set_mode', ('visual',))), # noqa + # set_mode + (ParsedShortcut(mods=4, key_name='v'), KeyAction('set_mode', ('block',))), # noqa + # set_mode + (ParsedShortcut(mods=4, key_name='LeftBracket'), KeyAction('set_mode', ('normal',))), # noqa +] diff --git a/kitten_options_utils.py b/kitten_options_utils.py new file mode 100644 index 0000000..5c525c5 --- /dev/null +++ b/kitten_options_utils.py @@ -0,0 +1,71 @@ +from typing import Any, Callable, Iterable, Sequence, Tuple + +from kitty.conf.utils import KittensKeyDefinition, parse_kittens_key + +FuncArgsType = Tuple[str, Sequence[Any]] + +try: + from kitty.conf.utils import KeyFuncWrapper + func_with_args = KeyFuncWrapper[FuncArgsType]() +except ImportError: + from kitty.conf.utils import key_func + func_with_args, args_funcs = key_func() + func_with_args.args_funcs = args_funcs + + + +def parse_map(val: str) -> Iterable[KittensKeyDefinition]: + x = parse_kittens_key(val, func_with_args.args_funcs) + if x is not None: + yield x + + +def parse_region_type(region_type: str) -> str: + result = region_type.lower() + assert result in ['stream', 'columnar'] + return result + + +def parse_direction(direction: str) -> str: + direction_lc = direction.lower() + assert direction_lc in ['left', 'right', 'up', 'down', + 'page up', 'page down', + 'first', 'first nonwhite', + 'last nonwhite', 'last', + 'top', 'bottom', + 'word left', 'word right'] + return direction_lc.replace(' ', '_') + + +def parse_scroll_direction(direction: str) -> str: + result = direction.lower() + assert result in ['up', 'down'] + return result + + +def parse_mode(mode: str) -> str: + result = mode.lower() + assert result in ['normal', 'visual', 'block'] + return result + + +@func_with_args('move') +def move(func: Callable, direction: str) -> Tuple[Callable, str]: + return func, parse_direction(direction) + + +@func_with_args('scroll') +def scroll(func: Callable, direction: str) -> Tuple[Callable, str]: + return func, parse_scroll_direction(direction) + + +@func_with_args('select') +def select(func: Callable, args: str) -> Tuple[Callable, Tuple[str, str]]: + region_type, direction = args.split(' ', 1) + return func, (parse_region_type(region_type), + parse_direction(direction)) + + +@func_with_args("set_mode") +def set_mode(func: Callable, mode: str) -> Tuple[Callable, str]: + return func, parse_mode(mode) diff --git a/kitty.conf.example b/kitty.conf.example new file mode 100644 index 0000000..5e1dabe --- /dev/null +++ b/kitty.conf.example @@ -0,0 +1 @@ +map alt+insert kitten kitty_grab/grab.py