├── .gitignore ├── LICENSE ├── README.rst ├── flake.lock ├── flake.nix ├── nix ├── keybinder.nix └── x-highlight-region.nix ├── setup.py └── src └── xhighlight ├── __init__.py ├── client ├── __init__.py └── cli.py ├── dimmed.py ├── parsing.py ├── region.py ├── server ├── __init__.py └── cli.py └── util.py /.gitignore: -------------------------------------------------------------------------------- 1 | bin/ 2 | include/ 3 | lib/ 4 | dist/ 5 | pip-selfcheck.json 6 | __pycache__/ 7 | *.egg-info/ 8 | 9 | # Nix 10 | result 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 5 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Library General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License 307 | along with this program; if not, write to the Free Software 308 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 309 | 310 | 311 | Also add information on how to contact you by electronic and paper mail. 312 | 313 | If the program is interactive, make it output a short notice like this 314 | when it starts in an interactive mode: 315 | 316 | Gnomovision version 69, Copyright (C) year name of author 317 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 318 | This is free software, and you are welcome to redistribute it 319 | under certain conditions; type `show c' for details. 320 | 321 | The hypothetical commands `show w' and `show c' should show the appropriate 322 | parts of the General Public License. Of course, the commands you use may 323 | be called something other than `show w' and `show c'; they could even be 324 | mouse-clicks or menu items--whatever suits your program. 325 | 326 | You should also get your employer (if you work as a programmer) or your 327 | school, if any, to sign a "copyright disclaimer" for the program, if 328 | necessary. Here is a sample; alter the names: 329 | 330 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 331 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 332 | 333 | , 1 April 1989 334 | Ty Coon, President of Vice 335 | 336 | This General Public License does not permit incorporating your program into 337 | proprietary programs. If your program is a subroutine library, you may 338 | consider it more useful to permit linking proprietary applications with the 339 | library. If this is what you want to do, use the GNU Library General 340 | Public License instead of this License. 341 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | x-highlight-region 2 | ================== 3 | 4 | x-highlight-region dims everything but selected regions on the screen. It is 5 | meant to be of use when giving presentations or when recording screencasts. 6 | 7 | 8 | .. image:: http://i.imgur.com/CjXPAcz.gif 9 | :target: https://youtu.be/AvvlQfOCBVw 10 | 11 | 12 | Usage 13 | ----- 14 | 15 | x-highlight-region may be invoked as specified below. To disengage, press 16 | *C-Esc*. 17 | 18 | :: 19 | 20 | usage: xhighlight [-h] [--rectangle X Y WIDTH HEIGHT] 21 | [--ellipsis X Y WIDTH HEIGHT] [--clear] [--opacity OPACITY] 22 | 23 | Highlight regions on the screen. 24 | 25 | optional arguments: 26 | -h, --help show this help message and exit 27 | --rectangle X Y WIDTH HEIGHT, -r X Y WIDTH HEIGHT 28 | highlight a rectangular region (may occur multiple 29 | times) 30 | --ellipsis X Y WIDTH HEIGHT, -e X Y WIDTH HEIGHT 31 | highlight an ellipsoid region (may occur multiple 32 | times) 33 | --clear, -c clear everything 34 | --opacity OPACITY, -o OPACITY 35 | opacity of the dim overlay (0 ≤ o ≤ 1), where 1 is 36 | perfectly opaque 37 | 38 | Regions intended for highlighting can be conveniently selected using `slop 39 | `__: 40 | 41 | :: 42 | 43 | alias xhl='xhighlight -r $(slop -f "%x %y %w %h")' 44 | 45 | To conveniently trigger highlighting via a global keyboard-shortcut, please 46 | refer to a hotkey daemon such as `sxhkd 47 | `__. 48 | 49 | Regions can be selected incrementally. When the first invocation has not been 50 | disengaged, further calls to `xhighlight` will add new highlighted regions to 51 | earlier ones. 52 | 53 | 54 | Requirements 55 | ------------ 56 | 57 | x-highlight-region relies on Gtk+ 3, pycairo, pygobject, python-dbus, and 58 | `python3-keybinder `__. It can be 59 | installed as customary, either by invoking ``setup.py``, or using ``pip``. Since 60 | pygobject, python-dbus, and pycairo are not distributed via pypi, these must be 61 | installed via your distribution’s package manager. 62 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "nixpkgs": { 4 | "locked": { 5 | "lastModified": 1700787330, 6 | "narHash": "sha256-4VIBCyfqnEsdVP/SgKZ3rudwzxGdEqpKfgoWETs/I6k=", 7 | "owner": "NixOS", 8 | "repo": "nixpkgs", 9 | "rev": "7f7851dfc570812c305d89438681b715a4f7beba", 10 | "type": "github" 11 | }, 12 | "original": { 13 | "id": "nixpkgs", 14 | "ref": "nixos-23.11", 15 | "type": "indirect" 16 | } 17 | }, 18 | "root": { 19 | "inputs": { 20 | "nixpkgs": "nixpkgs", 21 | "utils": "utils" 22 | } 23 | }, 24 | "systems": { 25 | "locked": { 26 | "lastModified": 1681028828, 27 | "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", 28 | "owner": "nix-systems", 29 | "repo": "default", 30 | "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", 31 | "type": "github" 32 | }, 33 | "original": { 34 | "owner": "nix-systems", 35 | "repo": "default", 36 | "type": "github" 37 | } 38 | }, 39 | "utils": { 40 | "inputs": { 41 | "systems": "systems" 42 | }, 43 | "locked": { 44 | "lastModified": 1694529238, 45 | "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=", 46 | "owner": "numtide", 47 | "repo": "flake-utils", 48 | "rev": "ff7b65b44d01cf9ba6a71320833626af21126384", 49 | "type": "github" 50 | }, 51 | "original": { 52 | "owner": "numtide", 53 | "repo": "flake-utils", 54 | "type": "github" 55 | } 56 | } 57 | }, 58 | "root": "root", 59 | "version": 7 60 | } 61 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | description = "x-highlight-region"; 3 | inputs = { 4 | nixpkgs.url = "nixpkgs/nixos-23.11"; 5 | utils.url = "github:numtide/flake-utils"; 6 | }; 7 | outputs = { self, nixpkgs, utils }: 8 | (utils.lib.eachDefaultSystem (system: 9 | let 10 | pkgs = import nixpkgs { 11 | inherit system; 12 | overlays = [ 13 | (final: prev: { 14 | python3 = prev.python3.override { 15 | packageOverrides = (final-python: prev-python: { 16 | keybinder = final-python.callPackage ./nix/keybinder.nix { }; 17 | }); 18 | }; 19 | x-highlight-region = 20 | final.callPackage ./nix/x-highlight-region.nix { }; 21 | }) 22 | ]; 23 | }; 24 | in rec { 25 | packages = rec { 26 | default = x-highlight-region; 27 | x-highlight-region = pkgs.x-highlight-region; 28 | }; 29 | apps = { 30 | default = { 31 | type = "app"; 32 | program = "${packages.x-highlight-region}/bin/xhighlight"; 33 | }; 34 | }; 35 | })); 36 | } 37 | -------------------------------------------------------------------------------- /nix/keybinder.nix: -------------------------------------------------------------------------------- 1 | { lib, python3Packages }: 2 | python3Packages.buildPythonPackage rec { 3 | pname = "python3-keybinder"; 4 | version = "1.1.2"; 5 | src = python3Packages.fetchPypi { 6 | inherit pname version; 7 | sha256 = "0kwf9r84cpwv5fl2awwivbi1vv802g54ygm37rigp8wplllmk92b"; 8 | }; 9 | doCheck = false; 10 | meta = with lib; { license = licenses.gpl3; }; 11 | } 12 | -------------------------------------------------------------------------------- /nix/x-highlight-region.nix: -------------------------------------------------------------------------------- 1 | { atk, cairo, gtk3, gdk-pixbuf, gobject-introspection, pango, wrapGAppsHook 2 | , python3 }: 3 | python3.pkgs.buildPythonApplication { 4 | pname = "x-highlight-region"; 5 | version = "0.4.1.1"; 6 | nativeBuildInputs = 7 | [ atk cairo gdk-pixbuf gobject-introspection pango wrapGAppsHook ]; 8 | propagatedBuildInputs = 9 | (with python3.pkgs; [ pygobject3 pycairo dbus-python xlib keybinder ]) 10 | ++ [ gtk3 ]; 11 | src = ../.; 12 | preFixup = '' 13 | makeWrapperArgs+=( 14 | "''${gappsWrapperArgs[@]}" \ 15 | --unset GDK_SCALE \ 16 | --unset GDK_DPI_SCALE 17 | ) 18 | ''; 19 | } 20 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import subprocess 4 | import shlex 5 | from setuptools import setup 6 | 7 | version = '0.4.1.1' 8 | 9 | try: 10 | hash = ( 11 | subprocess 12 | .check_output(shlex.split('git rev-parse --short HEAD')) 13 | .rstrip() 14 | .decode('ASCII') 15 | ) 16 | commit = ( 17 | subprocess 18 | .check_output(shlex.split('git rev-list --count HEAD')) 19 | .rstrip() 20 | .decode('ASCII') 21 | ) 22 | except: 23 | pass 24 | else: 25 | version = '{}.dev{}+{}'.format(version, commit, hash) 26 | 27 | 28 | setup( 29 | name='x-highlight-region', 30 | version=version, 31 | description="Dims everything but a selected region of the screen.", 32 | author="Sebastian Reuße", 33 | author_email='seb@wirrsal.net', 34 | url='https://github.com/eigengrau/x-highlight-region', 35 | packages=[ 36 | 'xhighlight', 37 | 'xhighlight.server', 38 | 'xhighlight.client' 39 | ], 40 | package_dir={'': 'src'}, 41 | install_requires=[ 42 | 'pygobject >= 3.18, < 3.47', 43 | 'python3-keybinder >= 1.1, < 1.2' 44 | ], 45 | license="GPL3", 46 | entry_points={ 47 | 'console_scripts': [ 48 | 'xhighlight-server = xhighlight.server.cli:console_entry', 49 | 'xhighlight = xhighlight.client.cli:console_entry' 50 | ], 51 | } 52 | ) 53 | -------------------------------------------------------------------------------- /src/xhighlight/__init__.py: -------------------------------------------------------------------------------- 1 | """Dim everything but a selected region of the screen. 2 | 3 | x-highlight-region dims everything but selected regions on the screen. It is 4 | meant to be of use when giving presentations or when recording screencasts. 5 | """ 6 | -------------------------------------------------------------------------------- /src/xhighlight/client/__init__.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import os 3 | import time 4 | 5 | import dbus 6 | 7 | import xhighlight.server 8 | from xhighlight.region import Shape 9 | 10 | 11 | def get_server_proxy(block=False): 12 | 13 | bus = dbus.SessionBus() 14 | 15 | while True: 16 | 17 | if bus.name_has_owner('net.wirrsal.xhighlight'): 18 | 19 | server = bus.get_object('net.wirrsal.xhighlight', '/') 20 | return server 21 | 22 | if not block: 23 | 24 | # python-dbus seems to cache the connection object somehow, and will 25 | # be unhappy when we fork() later on in client() if the connection 26 | # isn’t closed. 27 | 28 | bus.close() 29 | 30 | raise dbus.exceptions.DBusException 31 | 32 | # While we could wait for a NameOwnerChange signal to see when the 33 | # server has appeared, dbus-python wants to use the GLib main loop for 34 | # this, and odd things will happen when doing so because we used fork(). 35 | # So instead, we poll manually. 36 | 37 | time.sleep(0.1) 38 | 39 | 40 | def highlight_regions(regions, server_opacity): 41 | 42 | try: 43 | 44 | server = get_server_proxy() 45 | 46 | except dbus.exceptions.DBusException: 47 | 48 | # If no server is running, start one. We could rely on DBus activation, 49 | # but this would require users to install the service files (which 50 | # can’t be done automatically by setuptools). Additionally, starting 51 | # the server from the client allows us to set the server opacity on the 52 | # client command-line, which would otherwise require a global config 53 | # file for the server. 54 | 55 | pid = os.fork() 56 | 57 | if pid == 0: 58 | 59 | xhighlight.server.server(server_opacity) 60 | sys.exit() 61 | 62 | else: 63 | 64 | server = get_server_proxy(block=True) 65 | 66 | for region in regions: 67 | 68 | if region.shape == Shape.rectangular: 69 | 70 | method = server.highlight_rectangle 71 | 72 | elif region.shape == Shape.ellipsoid: 73 | 74 | method = server.highlight_ellipsis 75 | 76 | else: 77 | 78 | raise TypeError("Do not know how to process region: %s" % region) 79 | 80 | method( 81 | region.x, 82 | region.y, 83 | region.width, 84 | region.height 85 | ) 86 | 87 | 88 | def server_quit(): 89 | 90 | bus = dbus.SessionBus() 91 | 92 | if bus.name_has_owner('net.wirrsal.xhighlight'): 93 | 94 | server = get_server_proxy() 95 | server.server_quit() 96 | -------------------------------------------------------------------------------- /src/xhighlight/client/cli.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | 3 | import gi 4 | gi.require_version('Gtk', '3.0') 5 | gi.require_version('Gdk', '3.0') 6 | 7 | from xhighlight import client 8 | from xhighlight.parsing import RegionAction 9 | from xhighlight.region import Region, Shape 10 | from xhighlight.util import ensure_screen_composited 11 | 12 | 13 | argparser = argparse.ArgumentParser( 14 | description="Highlight regions on the screen." 15 | ) 16 | 17 | argparser.add_argument( 18 | '--rectangle', '-r', 19 | dest='rectangles', 20 | nargs=4, 21 | type=int, 22 | action=RegionAction, 23 | shape=Shape.rectangular, 24 | help="highlight a rectangular region (may occur multiple times)" 25 | ) 26 | 27 | argparser.add_argument( 28 | '--ellipsis', '-e', 29 | dest='ellipsoids', 30 | nargs=4, 31 | type=int, 32 | action=RegionAction, 33 | shape=Shape.ellipsoid, 34 | help="highlight an ellipsoid region (may occur multiple times)" 35 | ) 36 | 37 | argparser.add_argument( 38 | '--clear', '-c', 39 | dest='server_quit', 40 | action='store_true', 41 | help="clear everything" 42 | ) 43 | 44 | argparser.add_argument( 45 | '--opacity', '-o', 46 | default=.6, 47 | type=float, 48 | help="opacity of the dim overlay (0 ≤ o ≤ 1), where 1 is perfectly opaque" 49 | ) 50 | 51 | 52 | def console_entry(): 53 | 54 | ensure_screen_composited() 55 | args = argparser.parse_args() 56 | 57 | if args.server_quit: 58 | 59 | client.server_quit() 60 | 61 | else: 62 | 63 | regions = args.rectangles + args.ellipsoids 64 | client.highlight_regions(regions, args.opacity) 65 | -------------------------------------------------------------------------------- /src/xhighlight/dimmed.py: -------------------------------------------------------------------------------- 1 | """A semi-transparent Gtk window useful to dim the brightness of regions on the 2 | screen. 3 | 4 | """ 5 | 6 | import math 7 | 8 | import cairo 9 | from gi.repository import Gtk, Gdk 10 | 11 | from xhighlight.region import Region, Shape 12 | 13 | 14 | class Dimmed (Gtk.Window): 15 | 16 | def __init__(self, opacity=.6): 17 | """A semi-transparent screen overlay which supports masking out clear 18 | regions. 19 | 20 | """ 21 | 22 | super().__init__(Gtk.WindowType.POPUP) 23 | 24 | # Be transparent. 25 | self.set_app_paintable(True) 26 | screen = self.get_screen() 27 | visual = screen.get_rgba_visual() 28 | self.set_visual(visual) 29 | self.show_all() 30 | 31 | # Set geometry. 32 | width, height = screen.get_width(), screen.get_height() 33 | self.resize(width, height) 34 | self.move(0, 0) 35 | 36 | # Make the window not look like a regular window. 37 | self.fullscreen() 38 | self.set_decorated(False) 39 | self.set_skip_taskbar_hint(True) 40 | self.set_skip_pager_hint(True) 41 | self.set_keep_above(True) 42 | self.set_type_hint(Gdk.WindowTypeHint.NOTIFICATION) 43 | 44 | # Don’t take focus. 45 | self.set_accept_focus(False) 46 | self.set_focus_on_map(False) 47 | self.input_shape_combine_region(cairo.Region()) 48 | 49 | # Keep state. 50 | self._regions = [] 51 | self.opacity = opacity 52 | 53 | self.connect('draw', self._on_draw) 54 | 55 | def _on_draw(self, _wid, ctx): 56 | 57 | ctx.save() 58 | 59 | # Dim everything. 60 | ctx.set_source_rgba(0, 0, 0, self.opacity) 61 | ctx.set_operator(cairo.OPERATOR_SOURCE) 62 | ctx.paint() 63 | 64 | # Process highlighted regions. 65 | ctx.set_operator(cairo.OPERATOR_CLEAR) 66 | for region in self._regions: 67 | 68 | if region.shape == Shape.rectangular: 69 | 70 | ctx.rectangle( 71 | region.x, 72 | region.y, 73 | region.width, 74 | region.height 75 | ) 76 | ctx.fill() 77 | 78 | elif region.shape == Shape.ellipsoid: 79 | 80 | ctx.save() 81 | ctx.translate( 82 | region.x+region.width/2, 83 | region.y+region.height/2 84 | ) 85 | ctx.scale(region.width/2, region.height/2) 86 | ctx.arc(0, 0, 1, 0, math.radians(360)) 87 | ctx.fill() 88 | ctx.restore() 89 | 90 | else: 91 | 92 | raise ValueError( 93 | "Don’t know how to process region: %s" % region 94 | ) 95 | 96 | ctx.restore() 97 | 98 | def clear_region(self, region): 99 | """Highlight a region on the screen.""" 100 | 101 | self._regions.append(region) 102 | self.queue_draw() 103 | -------------------------------------------------------------------------------- /src/xhighlight/parsing.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | from xhighlight.region import Region, Shape 3 | 4 | 5 | class RegionAction (argparse.Action): 6 | 7 | def __init__(self, *args, shape=None, **kwargs): 8 | 9 | if shape is None: 10 | raise ValueError("region_type must be set.") 11 | 12 | super().__init__(*args, **kwargs) 13 | self.default = [] 14 | self.shape = shape 15 | self.metavar = ('X', 'Y', 'WIDTH', 'HEIGHT') 16 | 17 | def __call__(self, parser, namespace, values, option_string): 18 | 19 | regions = getattr(namespace, self.dest) 20 | if regions is None: 21 | regions = [] 22 | setattr(namespace, self.dest, regions) 23 | region = Region(self.shape, *values) 24 | regions.append(region) 25 | -------------------------------------------------------------------------------- /src/xhighlight/region.py: -------------------------------------------------------------------------------- 1 | import enum 2 | 3 | 4 | class Shape (enum.Enum): 5 | 6 | rectangular = 1 7 | ellipsoid = 2 8 | 9 | 10 | class Region: 11 | 12 | def __init__(self, shape, x, y, width, height): 13 | 14 | self.x = x 15 | self.y = y 16 | self.width = width 17 | self.height = height 18 | self.shape = shape 19 | -------------------------------------------------------------------------------- /src/xhighlight/server/__init__.py: -------------------------------------------------------------------------------- 1 | import signal 2 | import queue 3 | 4 | import dbus 5 | import dbus.service 6 | import dbus.mainloop.glib 7 | 8 | import gi 9 | gi.require_version('Gtk', '3.0') 10 | gi.require_version('Gdk', '3.0') 11 | from gi.repository import Gtk, GLib 12 | from keybinder.keybinder_gtk import KeybinderGtk 13 | 14 | from xhighlight.dimmed import Dimmed 15 | from xhighlight.region import Region, Shape 16 | 17 | 18 | def server(opacity): 19 | 20 | dimmed = Dimmed(opacity) 21 | 22 | keybinder = KeybinderGtk() 23 | keybinder.register('Escape', Gtk.main_quit) 24 | keybinder.start() 25 | 26 | signal.signal(signal.SIGTERM, Gtk.main_quit) 27 | signal.signal(signal.SIGINT, Gtk.main_quit) 28 | 29 | ControlReader(dimmed).start() 30 | Gtk.main() 31 | 32 | 33 | class ControlReader (dbus.service.Object): 34 | 35 | # Bad things will happen if we call directly into add_clear from a 36 | # separate thread. So we use a queue instead, which will be read from 37 | # within the Gtk main loop. 38 | 39 | def __init__(self, dimmed): 40 | 41 | bus = dbus.SessionBus( 42 | mainloop=dbus.mainloop.glib.DBusGMainLoop() 43 | ) 44 | bus_name = dbus.service.BusName( 45 | 'net.wirrsal.xhighlight', 46 | bus 47 | ) 48 | super().__init__(bus_name, '/') 49 | 50 | self.dimmed = dimmed 51 | self.read_queue = None 52 | 53 | def start(self): 54 | 55 | self.read_queue = queue.Queue() 56 | GLib.timeout_add(50, self.mainloop_handle_queue) 57 | 58 | def put(self, item): 59 | 60 | self.read_queue.put(item) 61 | 62 | @dbus.service.method('net.wirrsal.xhighlight') 63 | def highlight_rectangle(self, x, y, width, height): 64 | 65 | region = Region(Shape.rectangular, x, y, width, height) 66 | self.put(region) 67 | 68 | @dbus.service.method('net.wirrsal.xhighlight') 69 | def highlight_ellipsis(self, x, y, width, height): 70 | 71 | region = Region(Shape.ellipsoid, x, y, width, height) 72 | self.put(region) 73 | 74 | @dbus.service.method('net.wirrsal.xhighlight') 75 | def server_quit(self): 76 | 77 | Gtk.main_quit() 78 | 79 | def mainloop_handle_queue(self): 80 | 81 | # Callback used to read the queue from within the Gtk main loop. 82 | 83 | try: 84 | region = self.read_queue.get_nowait() 85 | 86 | except queue.Empty: 87 | pass 88 | 89 | else: 90 | self.dimmed.clear_region(region) 91 | 92 | return True 93 | -------------------------------------------------------------------------------- /src/xhighlight/server/cli.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | 3 | import gi 4 | gi.require_version('Gtk', '3.0') 5 | gi.require_version('Gdk', '3.0') 6 | 7 | from xhighlight.server import server 8 | from xhighlight.util import ensure_screen_composited 9 | 10 | 11 | argparser = argparse.ArgumentParser( 12 | description="DBus server for xhighlight (usually invoked automatically)." 13 | ) 14 | 15 | argparser.add_argument( 16 | '--opacity', '-o', 17 | type=float, 18 | default=.6, 19 | help="Opacity of the dim overlay (0 ≤ o ≤ 1), where 1 is perfectly opaque." 20 | ) 21 | 22 | 23 | def console_entry(): 24 | 25 | ensure_screen_composited() 26 | args = argparser.parse_args() 27 | server(args.opacity) 28 | -------------------------------------------------------------------------------- /src/xhighlight/util.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from ctypes import cdll 3 | 4 | from gi.repository import Gdk 5 | 6 | 7 | def ensure_screen_composited(): 8 | 9 | root = Gdk.get_default_root_window() 10 | screen = root.get_screen() 11 | if not screen.is_composited(): 12 | print("This program requires a composited screen.") 13 | sys.exit(1) 14 | --------------------------------------------------------------------------------