├── debian ├── compat ├── docs ├── source │ └── format ├── dirs ├── rules ├── caffeine.lintian-overrides ├── control ├── copyright └── changelog ├── share ├── pixmaps │ └── caffeine.png ├── man │ └── man1 │ │ └── caffeine-plus.1.gz ├── icons │ ├── hicolor │ │ ├── 16x16 │ │ │ ├── apps │ │ │ │ └── caffeine.png │ │ │ └── status │ │ │ │ ├── caffeine-cup-empty.png │ │ │ │ └── caffeine-cup-full.png │ │ ├── 22x22 │ │ │ ├── apps │ │ │ │ └── caffeine.png │ │ │ └── status │ │ │ │ ├── caffeine-cup-empty.png │ │ │ │ └── caffeine-cup-full.png │ │ ├── 24x24 │ │ │ ├── apps │ │ │ │ └── caffeine.png │ │ │ └── status │ │ │ │ ├── caffeine-cup-empty.png │ │ │ │ └── caffeine-cup-full.png │ │ ├── 32x32 │ │ │ ├── apps │ │ │ │ └── caffeine.png │ │ │ └── status │ │ │ │ ├── caffeine-cup-empty.png │ │ │ │ └── caffeine-cup-full.png │ │ ├── 48x48 │ │ │ ├── apps │ │ │ │ └── caffeine.png │ │ │ └── status │ │ │ │ ├── caffeine-cup-empty.png │ │ │ │ └── caffeine-cup-full.png │ │ ├── index.theme │ │ └── scalable │ │ │ ├── status │ │ │ ├── caffeine-cup-empty.svg │ │ │ └── caffeine-cup-full.svg │ │ │ └── apps │ │ │ └── caffeine.svg │ └── ubuntu-mono-dark │ │ └── status │ │ ├── 16 │ │ ├── caffeine-cup-full.png │ │ └── caffeine-cup-empty.png │ │ ├── 22 │ │ ├── caffeine-cup-full.png │ │ └── caffeine-cup-empty.png │ │ ├── 24 │ │ ├── caffeine-cup-full.png │ │ └── caffeine-cup-empty.png │ │ ├── 32 │ │ ├── caffeine-cup-full.png │ │ └── caffeine-cup-empty.png │ │ ├── 48 │ │ ├── caffeine-cup-full.png │ │ └── caffeine-cup-empty.png │ │ └── scalable │ │ ├── caffeine-cup-empty.svg │ │ └── caffeine-cup-full.svg └── applications │ └── caffeine-plus.desktop ├── .gitignore ├── .bzrignore ├── setup.py ├── README.md ├── caffeine-plus ├── LICENSE.LESSER ├── ewmh.py └── LICENSE /debian/compat: -------------------------------------------------------------------------------- 1 | 7 2 | -------------------------------------------------------------------------------- /debian/docs: -------------------------------------------------------------------------------- 1 | README 2 | -------------------------------------------------------------------------------- /debian/source/format: -------------------------------------------------------------------------------- 1 | 1.0 -------------------------------------------------------------------------------- /debian/dirs: -------------------------------------------------------------------------------- 1 | usr/bin 2 | usr/share/applications 3 | etc/xdg/autostart 4 | -------------------------------------------------------------------------------- /share/pixmaps/caffeine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/pixmaps/caffeine.png -------------------------------------------------------------------------------- /share/man/man1/caffeine-plus.1.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/man/man1/caffeine-plus.1.gz -------------------------------------------------------------------------------- /debian/rules: -------------------------------------------------------------------------------- 1 | #!/usr/bin/make -f 2 | 3 | export PYBUILD_NAME=caffeine 4 | 5 | %: 6 | dh $@ --with python3 --buildsystem=pybuild 7 | -------------------------------------------------------------------------------- /debian/caffeine.lintian-overrides: -------------------------------------------------------------------------------- 1 | # Allow short extended description 2 | caffeine binary: extended-description-is-probably-too-short 3 | -------------------------------------------------------------------------------- /share/icons/hicolor/16x16/apps/caffeine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/16x16/apps/caffeine.png -------------------------------------------------------------------------------- /share/icons/hicolor/22x22/apps/caffeine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/22x22/apps/caffeine.png -------------------------------------------------------------------------------- /share/icons/hicolor/24x24/apps/caffeine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/24x24/apps/caffeine.png -------------------------------------------------------------------------------- /share/icons/hicolor/32x32/apps/caffeine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/32x32/apps/caffeine.png -------------------------------------------------------------------------------- /share/icons/hicolor/48x48/apps/caffeine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/48x48/apps/caffeine.png -------------------------------------------------------------------------------- /share/icons/hicolor/16x16/status/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/16x16/status/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/hicolor/16x16/status/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/16x16/status/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/hicolor/22x22/status/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/22x22/status/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/hicolor/22x22/status/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/22x22/status/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/hicolor/24x24/status/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/24x24/status/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/hicolor/24x24/status/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/24x24/status/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/hicolor/32x32/status/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/32x32/status/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/hicolor/32x32/status/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/32x32/status/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/hicolor/48x48/status/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/48x48/status/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/hicolor/48x48/status/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/hicolor/48x48/status/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/16/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/16/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/22/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/22/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/24/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/24/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/32/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/32/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/48/caffeine-cup-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/48/caffeine-cup-full.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/16/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/16/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/22/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/22/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/24/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/24/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/32/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/32/caffeine-cup-empty.png -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/48/caffeine-cup-empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mildmojo/caffeine-plus/HEAD/share/icons/ubuntu-mono-dark/status/48/caffeine-cup-empty.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .pybuild 2 | __pycache__ 3 | build 4 | debian/caffeine.debhelper.log 5 | debian/caffeine.*.debhelper 6 | debian/caffeine.substvars 7 | debian/files 8 | debian/caffeine 9 | etc 10 | -------------------------------------------------------------------------------- /.bzrignore: -------------------------------------------------------------------------------- 1 | ./.pybuild 2 | ./__pycache__ 3 | ./build 4 | ./debian/caffeine.debhelper.log 5 | ./debian/caffeine.*.debhelper 6 | ./debian/caffeine.substvars 7 | ./debian/files 8 | ./debian/caffeine 9 | ./etc 10 | -------------------------------------------------------------------------------- /share/applications/caffeine-plus.desktop: -------------------------------------------------------------------------------- 1 | [Desktop Entry] 2 | Icon=caffeine 3 | Name=Caffeine Plus 4 | Comment=Temporarily deactivate the screensaver and sleep mode 5 | Exec=/usr/bin/caffeine-plus 6 | Terminal=false 7 | Type=Application 8 | Categories=Utility;TrayIcon; 9 | Keywords=Screensaver,Power,Saving,Blank 10 | OnlyShowIn=GNOME;Unity; 11 | StartupNotify=false 12 | -------------------------------------------------------------------------------- /debian/control: -------------------------------------------------------------------------------- 1 | Source: caffeine 2 | Section: misc 3 | Priority: optional 4 | Maintainer: Reuben Thomas 5 | Build-Depends: debhelper (>= 8), dh-python, python3-all, python-setuptools 6 | Standards-Version: 3.9.5 7 | Homepage: https://launchpad.net/caffeine 8 | 9 | Package: caffeine 10 | Architecture: all 11 | Depends:${misc:Depends}, ${python3:Depends}, 12 | gir1.2-glib-2.0, python3-xlib, python3-dbus 13 | Description: Prevent the desktop becoming idle in full-screen mode 14 | Caffeine stops the desktop becoming idle when an application 15 | is running full-screen. 16 | -------------------------------------------------------------------------------- /share/icons/hicolor/index.theme: -------------------------------------------------------------------------------- 1 | [Icon Theme] 2 | Name=hicolor 3 | 4 | # Directory list 5 | Directories=16x16/apps,22x22/apps,24x24/apps,32x32/apps,48x48/apps,64x64/apps,128x128/apps,192x192/apps,scalable/apps 6 | 7 | [16x16/apps] 8 | Size=16 9 | Context=Apps 10 | Type=Fixed 11 | 12 | [22x22/apps] 13 | Size=22 14 | Context=Apps 15 | Type=Fixed 16 | 17 | [24x24/apps] 18 | Size=24 19 | Context=Apps 20 | Type=Fixed 21 | 22 | [32x32/apps] 23 | Size=32 24 | Context=Apps 25 | Type=Fixed 26 | 27 | [48x48/apps] 28 | Size=48 29 | Context=Apps 30 | Type=Fixed 31 | 32 | [64x64/apps] 33 | Size=64 34 | Context=Apps 35 | Type=Fixed 36 | 37 | [128x128/apps] 38 | Size=128 39 | Context=Apps 40 | Type=Fixed 41 | 42 | [192x192/apps] 43 | Size=192 44 | Context=Apps 45 | Type=Fixed 46 | 47 | [scalable/apps] 48 | Size=128 49 | Context=Apps 50 | Type=Scalable 51 | MinSize=10 52 | MaxSize=256 53 | -------------------------------------------------------------------------------- /debian/copyright: -------------------------------------------------------------------------------- 1 | Upstream Authors: 2 | 3 | Isaiah Heyer freshapplepy@gmail.com 4 | Tommy Brunn tommy.brunn@gmail.com 5 | Brad Smith bnsmith@gmail.com 6 | Reuben Thomas rrt@sc3d.org 7 | 8 | Copyright: 9 | 10 | Copyright (C) 2009-2013 Isaiah Heyer, Tommy Brunn, Brad Smith and Reuben Thomas 11 | 12 | License: 13 | 14 | This package is free software; you can redistribute it and/or modify 15 | it under the terms of the GNU General Public License as published by 16 | the Free Software Foundation; either version 3 of the License, or 17 | (at your option) any later version. 18 | 19 | This package is distributed in the hope that it will be useful, 20 | but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | GNU General Public License for more details. 23 | 24 | You should have received a copy of the GNU General Public License 25 | along with this package; if not, write to the Free Software 26 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 27 | 28 | On Debian systems, the complete text of the GNU General 29 | Public License can be found in `/usr/share/common-licenses/GPL'. 30 | 31 | The Debian packaging is (C) 2009-2013 Isaiah Heyer and 32 | Reuben Thomas , and is licensed under the GPL, see above. 33 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from distutils.core import setup 4 | import os 5 | import shutil 6 | 7 | 8 | def main(): 9 | 10 | SHARE_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), 11 | "share") 12 | 13 | data_files = [] 14 | 15 | # don't trash the system icons! 16 | black_list = ['index.theme'] 17 | 18 | for path, dirs, files in os.walk(SHARE_PATH): 19 | 20 | data_files.append(tuple((path.replace(SHARE_PATH,"share", 1), 21 | [os.path.join(path, file) for file in files if file not in 22 | black_list]))) 23 | 24 | desktop_name = "caffeine-plus.desktop" 25 | desktop_file = os.path.join("share", "applications", desktop_name) 26 | autostart_dir = os.path.join("etc", "xdg", "autostart") 27 | if not os.path.exists(autostart_dir): 28 | os.makedirs(autostart_dir) 29 | shutil.copy(desktop_file, autostart_dir) 30 | data_files.append(tuple(("/" + autostart_dir, [os.path.join(autostart_dir, desktop_name)]))) 31 | 32 | setup(name="caffeine-plus", 33 | version="2.7.4", 34 | description="""Stop the desktop from becoming idle in full-screen mode.""", 35 | author="The Caffeine Developers", 36 | author_email="rrt@sc3d.org", 37 | url="https://launchpad.net/caffeine", 38 | py_modules=["ewmh"], 39 | data_files=data_files, 40 | scripts=["caffeine-plus"] 41 | ) 42 | 43 | if __name__ == "__main__": 44 | main() 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DEPRECATED PROJECT, DO NOT USE 2 | 3 | Caffeine Plus was created in response to the original Caffeine developer removing the tray icon UI for controlling Caffeine's behavior. Since then, he's added a companion app that restores the icon. This fork is no longer necessary or maintained. 4 | 5 | Please use the original [caffeine](https://launchpad.net/caffeine) project and add `caffeine-indicator` to your startup applications to get the system tray icon. 6 | 7 | The original README is shown below for archival purposes. This project is no longer maintained. 8 | 9 | 10 | 11 | ## Caffeine Plus 12 | 13 | Caffeine Plus is a small daemon that prevents the desktop from becoming idle 14 | (and hence the screen saver and/or blanker from activating). It does this 15 | automatically when the active window is full-screen, or on demand when enabled 16 | through its system tray icon. 17 | 18 | This is a fork of [Caffeine 2.7](http://launchpad.net/caffeine/) which restores 19 | the system tray icon for toggling it on and off. Manual toggling is the primary 20 | use case for many users, but the original author is [unwilling](https://bugs.launchpad.net/caffeine/+bug/1321750) 21 | to restore that functionality. 22 | 23 | I don't know Python, so this is a bit of copypasta from [Caffeine 2.5](https://github.com/mildmojo/caffeine-plus/tree/2.5) 24 | and the [AppIndicator docs](https://wiki.ubuntu.com/DesktopExperienceTeam/ApplicationIndicators#Python_version). 25 | 26 | ### System requirements 27 | 28 | - Any Linux desktop system that offers the `org.freedesktop.ScreenSaver` DBus API. 29 | This includes, but is not limited to, Linux Mint 16 and Ubuntu 14.04. Probably 30 | works on lots of older distributions, too. 31 | 32 | - Python (Python 3 if you run it directly from the source tree w/o installing) 33 | 34 | - `apt-get install python-xlib gir1.2-appindicator3-0.1` (python3-xlib if 35 | running w/o installing) 36 | 37 | ### Installation 38 | 39 | - `sudo python setup.py install --prefix /usr` 40 | 41 | - (optional) To have Caffeine Plus run on startup, add it to your System 42 | Settings => Startup Programs list. 43 | 44 | ### License 45 | 46 | Caffeine Plus is distributed under the GNU General Public License, either version 47 | 3, or (at your option) any later version. See LICENSE. 48 | 49 | The Caffeine Plus status icons are Copyright (C) 2014 mildmojo 50 | (http://github.com/mildmojo), and distributed under the terms of the GNU Lesser 51 | General Public License, either version 3, or (at your option) any later version. 52 | See LICENSE.LESSER. 53 | 54 | The Caffeine Plus SVG shortcut icons are Copyright (C) 2009 Tommy Brunn 55 | (http://www.blastfromthepast.se/blabbermouth), and distributed under the 56 | terms of the GNU Lesser General Public License, either version 3, or (at 57 | your option) any later version. See LICENSE.LESSER. 58 | 59 | Caffeine Plus uses pyewmh from http://sf.net/projects/pyewmh 60 | -------------------------------------------------------------------------------- /debian/changelog: -------------------------------------------------------------------------------- 1 | caffeine (2.7.2) trusty; urgency=low 2 | 3 | * Fix a crash when there is no active window (LP# 1322291). 4 | * Fix Caffeine not terminating when the session ends (LP #1324304). 5 | 6 | -- Reuben Thomas Mon, 19 May 2014 18:21:22 +0100 7 | 8 | caffeine (2.7.1) trusty; urgency=low 9 | 10 | * Fix a crash when a window disappears during full-screen check. 11 | 12 | -- Reuben Thomas Mon, 19 May 2014 18:21:22 +0100 13 | 14 | caffeine (2.7) trusty; urgency=low 15 | 16 | * Remove manual control, and hence UI. 17 | * Allow multiple instances per user: should really be one per X 18 | display. 19 | 20 | -- Reuben Thomas Thu, 15 May 2014 13:25:50 +0100 21 | 22 | caffeine (2.6.2) saucy; urgency=low 23 | 24 | * Add a build number just to persuade Launchpad to rebuild. 25 | 26 | -- Reuben Thomas Tue, 25 Feb 2014 23:13:15 +0000 27 | 28 | caffeine (2.6) saucy; urgency=low 29 | 30 | * Auto-activate the screensaver when a full-screen window is present. 31 | * Remove the ability to watch processes; applications should inhibit 32 | idleness themselves, and many now do. 33 | * Remove -a and -d command-line arguments: single-instance 34 | nature of Caffeine means it shouldn't be used from the command 35 | line. xdg-screensaver should be used instead. 36 | * Bump to standards 3.9.5 (no change). 37 | 38 | -- Reuben Thomas Thu, 30 Jan 2014 23:13:15 +0000 39 | 40 | caffeine (2.5) saucy; urgency=low 41 | 42 | * New maintainer: Reuben Thomas 43 | * Fix right-click on icon (LP #892663) 44 | * Several new localisations. 45 | * Update and clean up packaging. 46 | * Replace autostart option with an XDG autostart .desktop file. 47 | * Remove specific support for Quake Live. 48 | * Require appindicator3; remove non-appindicator support. 49 | * Put requirement for notify support in package, not code. 50 | * Remove ability to disable icon: this should be done by the desktop 51 | environment, not the application. 52 | * Remove hash-bang lines from non-executable files (fix LP #931875). 53 | * Fix race condition for notifications, patch from André Ericson 54 | (LP #892865). 55 | * Fix i18n issues (LP #941495). 56 | * Fix Open Build Service desktop file errors (LP #931874). 57 | * Add dependencies for all required libraries (LP #1093324). 58 | * Fix recognition of apps which mention their name in their arguments 59 | (LP #1249796). 60 | * Use freedesktop ScreenSaver DBus API instead of per-desktop APIs. 61 | (LP #1239935). 62 | * Put description string on one line in setup.py to placate 63 | rpmbuild (LP #595889). 64 | * Remove non-working Flash support. 65 | * Remove custom logging module. 66 | * Remove --preferences command-line option, no longer needed. 67 | * Remove --time command-line option: we're not supporting timed 68 | disabling any more. 69 | * Make Ctrl+C work (LP #907517). 70 | 71 | -- Reuben Thomas Mon, 09 Dec 2013 00:01:47 +0000 72 | -------------------------------------------------------------------------------- /share/icons/hicolor/scalable/status/caffeine-cup-empty.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 20 | 23 | 31 | 32 | 35 | 43 | 44 | 47 | 55 | 56 | 57 | 79 | 81 | 82 | 84 | image/svg+xml 85 | 87 | 88 | 89 | 90 | 91 | 96 | 102 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /caffeine-plus: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # coding=utf-8 3 | # 4 | # Copyright © 2009-2014 The Caffeine Developers 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | import logging 20 | import argparse 21 | import signal 22 | import sys 23 | from ewmh import EWMH 24 | from subprocess import call 25 | from gi.repository import GObject, Gtk, AppIndicator3 # had to install gir1.2-appindicator3-0.1 26 | 27 | # Handle command-line arguments 28 | parser = argparse.ArgumentParser(prog='caffeine-plus', description='Prevent desktop idleness in full-screen mode') 29 | parser.add_argument('-V', '--version', action='version', version='caffeine-plus 2.7.4') 30 | parser.parse_args() 31 | 32 | ewmh = EWMH() 33 | 34 | class Caffeine(GObject.GObject): 35 | 36 | def __init__(self): 37 | GObject.GObject.__init__(self) 38 | self.manualInhibited = False 39 | self.idlenessInhibited = False 40 | self.screenSaverCookie = None 41 | 42 | self._add_indicator() 43 | 44 | # Add hook for full-screen check (same interval as mplayer's heartbeat command) 45 | # FIXME: add capability to xdg-screensaver to report timeout 46 | GObject.timeout_add(30000, self._check_for_fullscreen) 47 | 48 | def _add_indicator(self): 49 | self.AppInd = AppIndicator3.Indicator.new("caffeine-cup-empty", 50 | "caffeine", 51 | AppIndicator3.IndicatorCategory.APPLICATION_STATUS) 52 | self.AppInd.set_status(AppIndicator3.IndicatorStatus.ACTIVE) 53 | self.AppInd.set_icon ("caffeine-cup-empty") 54 | 55 | self._build_indicator_menu(self.AppInd) 56 | 57 | def _build_indicator_menu(self, indicator): 58 | menu = Gtk.Menu() 59 | 60 | menu_item = Gtk.MenuItem("Toggle Screensaver") 61 | menu.append(menu_item) 62 | menu_item.connect("activate", self.on_toggle) 63 | menu_item.show() 64 | 65 | menu_item = Gtk.MenuItem("Quit") 66 | menu.append(menu_item) 67 | menu_item.connect("activate", self.on_quit) 68 | menu_item.show() 69 | 70 | indicator.set_menu(menu) 71 | 72 | def on_toggle(self, menuitem): 73 | self.manualInhibited = not self.manualInhibited 74 | self._check_for_fullscreen(); 75 | 76 | def on_quit(self, menuitem): 77 | sys.exit(0) 78 | 79 | def _set_icon_disabled(self): 80 | self.AppInd.set_icon('caffeine-cup-empty') 81 | 82 | def _set_icon_enabled(self): 83 | self.AppInd.set_icon('caffeine-cup-full') 84 | 85 | def _check_for_fullscreen(self): 86 | win = ewmh.getActiveWindow() 87 | inhibit = False 88 | if win != None: 89 | try: 90 | inhibit = '_NET_WM_STATE_FULLSCREEN' in ewmh.getWmState(win, str=True) 91 | except: 92 | pass 93 | inhibit = inhibit or self.manualInhibited 94 | 95 | # If inhibition state has changed, take action 96 | if self.idlenessInhibited != inhibit: 97 | self.idlenessInhibited = inhibit 98 | 99 | if inhibit: 100 | self._set_icon_enabled() 101 | self.screenSaverWindowID = hex(win.id) 102 | call(['xdg-screensaver', 'suspend', self.screenSaverWindowID]) 103 | logging.info("Caffeine is inhibiting desktop idleness") 104 | else: 105 | if self.screenSaverWindowID != None: 106 | call(['xdg-screensaver', 'resume', self.screenSaverWindowID]) 107 | self._set_icon_disabled(); 108 | logging.info("Caffeine is no longer inhibiting desktop idleness") 109 | 110 | # Return True so timeout is rerun 111 | return True 112 | 113 | 114 | # Set up and run 115 | logging.basicConfig(level=logging.INFO) 116 | signal.signal(signal.SIGINT, signal.SIG_DFL) 117 | GObject.threads_init() 118 | Caffeine() 119 | Gtk.main() 120 | -------------------------------------------------------------------------------- /share/icons/hicolor/scalable/status/caffeine-cup-full.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 19 | 21 | 24 | 32 | 33 | 34 | 52 | 54 | 55 | 57 | image/svg+xml 58 | 60 | 61 | 62 | 63 | 64 | 69 | 72 | 83 | 91 | 99 | 102 | 114 | 122 | 131 | 140 | 141 | 142 | 143 | 144 | -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/scalable/caffeine-cup-empty.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 21 | 23 | 26 | 34 | 35 | 38 | 46 | 47 | 50 | 58 | 59 | 69 | 74 | 78 | 79 | 89 | 94 | 98 | 99 | 100 | 122 | 124 | 125 | 127 | image/svg+xml 128 | 130 | 131 | 132 | 133 | 134 | 139 | 145 | 154 | 155 | 156 | -------------------------------------------------------------------------------- /share/icons/ubuntu-mono-dark/status/scalable/caffeine-cup-full.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 22 | 24 | 27 | 35 | 36 | 46 | 51 | 55 | 56 | 57 | 75 | 77 | 78 | 80 | image/svg+xml 81 | 83 | 84 | 85 | 86 | 87 | 92 | 96 | 107 | 115 | 123 | 126 | 138 | 146 | 155 | 164 | 165 | 166 | 167 | 168 | -------------------------------------------------------------------------------- /LICENSE.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /share/icons/hicolor/scalable/apps/caffeine.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 19 | 21 | 23 | 27 | 31 | 35 | 39 | 43 | 47 | 48 | 59 | 61 | 65 | 69 | 73 | 74 | 76 | 80 | 84 | 85 | 87 | 91 | 95 | 96 | 98 | 102 | 106 | 110 | 114 | 115 | 122 | 133 | 142 | 153 | 163 | 173 | 183 | 184 | 198 | 206 | 207 | 209 | 210 | 212 | image/svg+xml 213 | 215 | 216 | 217 | 218 | 222 | 232 | 236 | 241 | 246 | 251 | 261 | 271 | 281 | 286 | 299 | 303 | 307 | 311 | 315 | 316 | 317 | -------------------------------------------------------------------------------- /ewmh.py: -------------------------------------------------------------------------------- 1 | """This module intends to provide an implementation of Extended Window Manager Hints, based on 2 | the Xlib modules for python. 3 | 4 | See the freedesktop.org `specification `_ for more information. 5 | """ 6 | 7 | from Xlib import display, X, protocol, Xatom 8 | import time 9 | 10 | class EWMH: 11 | """This class provides the ability to get and set properties defined by the EWMH spec. 12 | 13 | Each property can be accessed in two ways. For example, to get the active window:: 14 | 15 | win = ewmh.getActiveWindow() 16 | # or: win = ewmh.getProperty('_NET_ACTIVE_WINDOW') 17 | 18 | Similarly, to set the active window:: 19 | 20 | ewmh.setActiveWindow(myWindow) 21 | # or: ewmh.setProperty('_NET_ACTIVE_WINDOW', myWindow) 22 | 23 | When a property is written, don't forget to really send the notification by flushing requests:: 24 | 25 | ewmh.display.flush() 26 | 27 | :param _display: the display to use. If not given, Xlib.display.Display() is used. 28 | :param root: the root window to use. If not given, self.display.screen().root is used.""" 29 | 30 | NET_WM_WINDOW_TYPES = ( 31 | '_NET_WM_WINDOW_TYPE_DESKTOP', '_NET_WM_WINDOW_TYPE_DOCK', '_NET_WM_WINDOW_TYPE_TOOLBAR', '_NET_WM_WINDOW_TYPE_MENU', 32 | '_NET_WM_WINDOW_TYPE_UTILITY', '_NET_WM_WINDOW_TYPE_SPLASH', '_NET_WM_WINDOW_TYPE_DIALOG', '_NET_WM_WINDOW_TYPE_DROPDOWN_MENU', 33 | '_NET_WM_WINDOW_TYPE_POPUP_MENU', '_NET_WM_WINDOW_TYPE_NOTIFICATION', '_NET_WM_WINDOW_TYPE_COMBO', '_NET_WM_WINDOW_TYPE_DND', 34 | '_NET_WM_WINDOW_TYPE_NORMAL') 35 | """List of strings representing all known window types.""" 36 | 37 | NET_WM_ACTIONS = ( 38 | '_NET_WM_ACTION_MOVE', '_NET_WM_ACTION_RESIZE', '_NET_WM_ACTION_MINIMIZE', '_NET_WM_ACTION_SHADE', 39 | '_NET_WM_ACTION_STICK', '_NET_WM_ACTION_MAXIMIZE_HORZ', '_NET_WM_ACTION_MAXIMIZE_VERT', '_NET_WM_ACTION_FULLSCREEN', 40 | '_NET_WM_ACTION_CHANGE_DESKTOP', '_NET_WM_ACTION_CLOSE', '_NET_WM_ACTION_ABOVE', '_NET_WM_ACTION_BELOW') 41 | """List of strings representing all known window actions.""" 42 | 43 | NET_WM_STATES = ( 44 | '_NET_WM_STATE_MODAL', '_NET_WM_STATE_STICKY', '_NET_WM_STATE_MAXIMIZED_VERT', '_NET_WM_STATE_MAXIMIZED_HORZ', 45 | '_NET_WM_STATE_SHADED', '_NET_WM_STATE_SKIP_TASKBAR', '_NET_WM_STATE_SKIP_PAGER', '_NET_WM_STATE_HIDDEN', 46 | '_NET_WM_STATE_FULLSCREEN','_NET_WM_STATE_ABOVE', '_NET_WM_STATE_BELOW', '_NET_WM_STATE_DEMANDS_ATTENTION') 47 | """List of strings representing all known window states.""" 48 | 49 | def __init__(self, _display=None, root = None): 50 | self.display = _display or display.Display() 51 | self.root = root or self.display.screen().root 52 | self.__getAttrs = { 53 | '_NET_CLIENT_LIST': self.getClientList, 54 | '_NET_CLIENT_LIST_STACKING': self.getClientListStacking, 55 | '_NET_NUMBER_OF_DESKTOPS': self.getNumberOfDesktops, 56 | '_NET_DESKTOP_GEOMETRY': self.getDesktopGeometry, 57 | '_NET_DESKTOP_VIEWPORT': self.getDesktopViewPort, 58 | '_NET_CURRENT_DESKTOP': self.getCurrentDesktop, 59 | '_NET_ACTIVE_WINDOW': self.getActiveWindow, 60 | '_NET_WORKAREA': self.getWorkArea, 61 | '_NET_SHOWING_DESKTOP': self.getShowingDesktop, 62 | '_NET_WM_NAME': self.getWmName, 63 | '_NET_WM_VISIBLE_NAME': self.getWmVisibleName, 64 | '_NET_WM_DESKTOP': self.getWmDesktop, 65 | '_NET_WM_WINDOW_TYPE': self.getWmWindowType, 66 | '_NET_WM_STATE': self.getWmState, 67 | '_NET_WM_ALLOWED_ACTIONS': self.getWmAllowedActions, 68 | '_NET_WM_PID': self.getWmPid, 69 | } 70 | self.__setAttrs = { 71 | '_NET_NUMBER_OF_DESKTOPS': self.setNumberOfDesktops, 72 | '_NET_DESKTOP_GEOMETRY': self.setDesktopGeometry, 73 | '_NET_DESKTOP_VIEWPORT': self.setDesktopViewport, 74 | '_NET_CURRENT_DESKTOP': self.setCurrentDesktop, 75 | '_NET_ACTIVE_WINDOW': self.setActiveWindow, 76 | '_NET_SHOWING_DESKTOP': self.setShowingDesktop, 77 | '_NET_CLOSE_WINDOW': self.setCloseWindow, 78 | '_NET_MOVERESIZE_WINDOW': self.setMoveResizeWindow, 79 | '_NET_WM_NAME': self.setWmName, 80 | '_NET_WM_VISIBLE_NAME': self.setWmVisibleName, 81 | '_NET_WM_DESKTOP': self.setWmDesktop, 82 | '_NET_WM_STATE': self.setWmState, 83 | } 84 | 85 | # ------------------------ setters properties ------------------------ 86 | 87 | def setNumberOfDesktops(self, nb): 88 | """Set the number of desktops (property _NET_NUMBER_OF_DESKTOPS). 89 | 90 | :param nb: the number of desired desktops""" 91 | self._setProperty('_NET_NUMBER_OF_DESKTOPS', [nb]) 92 | 93 | def setDesktopGeometry(self, w, h): 94 | """Set the desktop geometry (property _NET_DESKTOP_GEOMETRY) 95 | 96 | :param w: desktop width 97 | :param h: desktop height""" 98 | self._setProperty('_NET_DESKTOP_GEOMETRY', [w, h]) 99 | 100 | def setDesktopViewport(self, w, h): 101 | """Set the viewport size of the current desktop (property _NET_DESKTOP_VIEWPORT) 102 | 103 | :param w: desktop width 104 | :param h: desktop height""" 105 | self._setProperty('_NET_DESKTOP_VIEWPORT', [w, h]) 106 | 107 | def setCurrentDesktop(self, i): 108 | """Set the current desktop (property _NET_CURRENT_DESKTOP). 109 | 110 | :param i: the desired desktop number""" 111 | self._setProperty('_NET_CURRENT_DESKTOP', [i, X.CurrentTime]) 112 | 113 | def setActiveWindow(self, win): 114 | """Set the given window active (property _NET_ACTIVE_WINDOW) 115 | 116 | :param win: the window object""" 117 | self._setProperty('_NET_ACTIVE_WINDOW', [1, X.CurrentTime, win.id], win) 118 | 119 | def setShowingDesktop(self, show): 120 | """Set/unset the mode Showing desktop (property _NET_SHOWING_DESKTOP) 121 | 122 | :param show: 1 to set the desktop mode, else 0""" 123 | self._setProperty('_NET_SHOWING_DESKTOP', [show]) 124 | 125 | def setCloseWindow(self, win): 126 | """Colse the given window (property _NET_CLOSE_WINDOW) 127 | 128 | :param win: the window object""" 129 | self._setProperty('_NET_CLOSE_WINDOW', [int(time.mktime(time.localtime())), 1], win) 130 | 131 | def setWmName(self, win, name): 132 | """Set the property _NET_WM_NAME 133 | 134 | :param win: the window object 135 | :param name: desired name""" 136 | self._setProperty('_NET_WM_NAME', name, win) 137 | 138 | def setWmVisibleName(self, win, name): 139 | """Set the property _NET_WM_VISIBLE_NAME 140 | 141 | :param win: the window object 142 | :param name: desired visible name""" 143 | self._setProperty('_NET_WM_VISIBLE_NAME', name, win) 144 | 145 | def setWmDesktop(self, win, i): 146 | """Move the window to the desired desktop by changing the property _NET_WM_DESKTOP. 147 | 148 | :param win: the window object 149 | :param i: desired desktop number""" 150 | self._setProperty('_NET_WM_DESKTOP', [i, 1], win) 151 | 152 | def setMoveResizeWindow(self, win, gravity=0, x=None, y=None, w=None, h=None): 153 | """Set the property _NET_MOVERESIZE_WINDOW to move or resize the given window. 154 | Flags are automatically calculated if x, y, w or h are defined. 155 | 156 | :param win: the window object 157 | :param gravity: gravity (one of the Xlib.X.*Gravity constant or 0) 158 | :param x: int or None 159 | :param y: int or None 160 | :param w: int or None 161 | :param h: int or None""" 162 | gravity_flags = gravity | 0b0000100000000000 # indicate source (application) 163 | if x is None: x = 0 164 | else: gravity_flags = gravity_flags | 0b0000010000000000 # indicate presence of x 165 | if y is None: y = 0 166 | else: gravity_flags = gravity_flags | 0b0000001000000000 # indicate presence of y 167 | if w is None: w = 0 168 | else: gravity_flags = gravity_flags | 0b0000000100000000 # indicate presence of w 169 | if h is None: h = 0 170 | else: gravity_flags = gravity_flags | 0b0000000010000000 # indicate presence of h 171 | self._setProperty('_NET_MOVERESIZE_WINDOW', [gravity_flags, x, y, w, h], win) 172 | 173 | def setWmState(self, win, action, state, state2=0): 174 | """Set/unset one or two state(s) for the given window (property _NET_WM_STATE). 175 | 176 | :param win: the window object 177 | :param action: 0 to remove, 1 to add or 2 to toggle state(s) 178 | :param state: a state 179 | :type state: int or str (see :attr:`NET_WM_STATES`) 180 | :param state2: a state or 0 181 | :type state2: int or str (see :attr:`NET_WM_STATES`)""" 182 | if type(state) != int: state = self.display.get_atom(state, 1) 183 | if type(state2) != int: state2 = self.display.get_atom(state2, 1) 184 | self._setProperty('_NET_WM_STATE', [action, state, state2, 1], win) 185 | 186 | # ------------------------ getters properties ------------------------ 187 | 188 | def getClientList(self): 189 | """Get the list of windows maintained by the window manager for the property 190 | _NET_CLIENT_LIST. 191 | 192 | :return: list of Window objects""" 193 | return map(self._createWindow, self._getProperty('_NET_CLIENT_LIST')) 194 | 195 | def getClientListStacking(self): 196 | """Get the list of windows maintained by the window manager for the property 197 | _NET_CLIENT_LIST_STACKING. 198 | 199 | :return: list of Window objects""" 200 | return map(self._createWindow, self._getProperty('_NET_CLIENT_LIST_STACKING')) 201 | 202 | def getNumberOfDesktops(self): 203 | """Get the number of desktops (property _NET_NUMBER_OF_DESKTOPS). 204 | 205 | :return: int""" 206 | return self._getProperty('_NET_NUMBER_OF_DESKTOPS')[0] 207 | 208 | def getDesktopGeometry(self): 209 | """Get the desktop geometry (property _NET_DESKTOP_GEOMETRY) as an array 210 | of two integers [width, height]. 211 | 212 | :return: [int, int]""" 213 | return self._getProperty('_NET_DESKTOP_GEOMETRY') 214 | 215 | def getDesktopViewPort(self): 216 | """Get the current viewports of each desktop as a list of [x, y] representing 217 | the top left corner (property _NET_DESKTOP_VIEWPORT). 218 | 219 | :return: list of [int, int]""" 220 | return self._getProperty('_NET_DESKTOP_VIEWPORT') 221 | 222 | def getCurrentDesktop(self): 223 | """Get the current desktop number (property _NET_CURRENT_DESKTOP) 224 | 225 | :return: int""" 226 | return self._getProperty('_NET_CURRENT_DESKTOP')[0] 227 | 228 | def getActiveWindow(self): 229 | """Get the current active (toplevel) window or None (property _NET_ACTIVE_WINDOW) 230 | 231 | :return: Window object or None""" 232 | active_window = self._getProperty('_NET_ACTIVE_WINDOW') 233 | if active_window == None: 234 | return None 235 | return self._createWindow(active_window[0]) 236 | 237 | def getWorkArea(self): 238 | """Get the work area for each desktop (property _NET_WORKAREA) as a list of [x, y, width, height] 239 | 240 | :return: a list of [int, int, int, int]""" 241 | return self._getProperty('_NET_WORKAREA') 242 | 243 | def getShowingDesktop(self): 244 | """Get the value of "showing the desktop" mode of the window manager (property _NET_SHOWING_DESKTOP). 245 | 1 means the mode is activated, and 0 means deactivated. 246 | 247 | :return: int""" 248 | return self._getProperty('_NET_SHOWING_DESKTOP')[0] 249 | 250 | def getWmName(self, win): 251 | """Get the property _NET_WM_NAME for the given window as a string. 252 | 253 | :param win: the window object 254 | :return: str""" 255 | return self._getProperty('_NET_WM_NAME', win) 256 | 257 | def getWmVisibleName(self, win): 258 | """Get the property _NET_WM_VISIBLE_NAME for the given window as a string. 259 | 260 | :param win: the window object 261 | :return: str""" 262 | return self._getProperty('_NET_WM_VISIBLE_NAME', win) 263 | 264 | def getWmDesktop(self, win): 265 | """Get the current desktop number of the given window (property _NET_WM_DESKTOP). 266 | 267 | :param win: the window object 268 | :return: int""" 269 | return self._getProperty('_NET_WM_DESKTOP', win)[0] 270 | 271 | def getWmWindowType(self, win, str=False): 272 | """Get the list of window types of the given window (property _NET_WM_WINDOW_TYPE). 273 | 274 | :param win: the window object 275 | :param str: True to get a list of string types instead of int 276 | :return: list of (int|str)""" 277 | types = self._getProperty('_NET_WM_WINDOW_TYPE', win) 278 | if not str: return types 279 | return map(self._getAtomName, wtypes) 280 | 281 | def getWmState(self, win, str=False): 282 | """Get the list of states of the given window (property _NET_WM_STATE). 283 | 284 | :param win: the window object 285 | :param str: True to get a list of string states instead of int 286 | :return: list of (int|str)""" 287 | states = self._getProperty('_NET_WM_STATE', win) 288 | if not str: return states 289 | return map(self._getAtomName, states) 290 | 291 | def getWmAllowedActions(self, win, str=False): 292 | """Get the list of allowed actions for the given window (property _NET_WM_ALLOWED_ACTIONS). 293 | 294 | :param win: the window object 295 | :param str: True to get a list of string allowed actions instead of int 296 | :return: list of (int|str)""" 297 | wAllowedActions = self._getProperty('_NET_WM_ALLOWED_ACTIONS', win) 298 | if not str: return wAllowedActions 299 | return map(self._getAtomName, wAllowedActions) 300 | 301 | def getWmPid(self, win): 302 | """Get the pid of the application associated to the given window (property _NET_WM_PID) 303 | 304 | :param win: the window object""" 305 | return self._getProperty('_NET_WM_PID', win)[0] 306 | 307 | def _getProperty(self, _type, win=None): 308 | if not win: win = self.root 309 | atom = win.get_full_property(self.display.get_atom(_type), X.AnyPropertyType) 310 | if atom: return atom.value 311 | 312 | def _setProperty(self, _type, data, win=None, mask=None): 313 | """Send a ClientMessage event to the root window""" 314 | if not win: win = self.root 315 | if type(data) is str: 316 | dataSize = 8 317 | else: 318 | data = (data+[0]*(5-len(data)))[:5] 319 | dataSize = 32 320 | 321 | ev = protocol.event.ClientMessage(window=win, client_type=self.display.get_atom(_type), data=(dataSize, data)) 322 | 323 | if not mask: 324 | mask = (X.SubstructureRedirectMask|X.SubstructureNotifyMask) 325 | self.root.send_event(ev, event_mask=mask) 326 | 327 | def _getAtomName(self, atom): 328 | try: return self.display.get_atom_name(atom) 329 | except: return 'UNKNOWN' 330 | 331 | def _createWindow(self, wId): 332 | if not wId: return None 333 | return self.display.create_resource_object('window', wId) 334 | 335 | def getReadableProperties(self): 336 | """Get all the readable properties' names""" 337 | return self.__getAttrs.keys() 338 | 339 | def getProperty(self, prop, *args, **kwargs): 340 | """Get the value of a property. See the corresponding method for the required arguments. 341 | For example, for the property _NET_WM_STATE, look for :meth:`getWmState`""" 342 | f = self.__getAttrs.get(prop) 343 | if not f: raise KeyError('Unknow readable property: %s' % prop) 344 | return f(self, *args, **kwargs) 345 | 346 | def getWritableProperties(self): 347 | """Get all the writable properties names""" 348 | return self.__setAttrs.keys() 349 | 350 | def setProperty(self, prop, *args, **kwargs): 351 | """Set the value of a property by sending an event on the root window. See the corresponding method for 352 | the required arguments. For example, for the property _NET_WM_STATE, look for :meth:`setWmState`""" 353 | f = self.__setAttrs.get(prop) 354 | if not f: raise KeyError('Unknow writable property: %s' % prop) 355 | f(self, *args, **kwargs) 356 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------