├── tdsr ├── backend │ ├── __init__.py │ ├── speechdispatcher.py │ └── mac.py ├── __init__.py ├── __main__.py ├── tdsr.cfg.dist └── tdsr.py ├── .gitignore ├── pylintrc ├── bin └── tdsr ├── .editorconfig ├── pyproject.toml ├── readme.md └── COPYING.txt /tdsr/backend/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.swp 3 | dist/ 4 | build/ 5 | venv/ 6 | -------------------------------------------------------------------------------- /pylintrc: -------------------------------------------------------------------------------- 1 | [MASTER] 2 | 3 | disable= 4 | bad-indentation 5 | -------------------------------------------------------------------------------- /tdsr/__init__.py: -------------------------------------------------------------------------------- 1 | """ A console screen reader for macOS and Linux """ 2 | 3 | __version__: str = "0.0" 4 | -------------------------------------------------------------------------------- /bin/tdsr: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import sys 3 | import os 4 | sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) 5 | import tdsr.__main__ 6 | tdsr.__main__.main() 7 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | end_of_line = lf 6 | indent_style = tab 7 | indent_size = 4 8 | tab_width = 4 9 | 10 | [pylintrc] 11 | indent_style = space 12 | -------------------------------------------------------------------------------- /tdsr/__main__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import termios 3 | import tty 4 | 5 | from tdsr.tdsr import main as tdsr_main 6 | 7 | 8 | def main(): 9 | old = termios.tcgetattr(0) 10 | try: 11 | tty.setraw(0) 12 | tdsr_main(old) 13 | finally: 14 | termios.tcsetattr(0, termios.TCSADRAIN, old) 15 | 16 | 17 | if __name__ == "__main___": 18 | main() 19 | -------------------------------------------------------------------------------- /tdsr/tdsr.cfg.dist: -------------------------------------------------------------------------------- 1 | [speech] 2 | process_symbols = False 3 | prompt = .* 4 | 5 | [commands] 6 | 7 | [plugins] 8 | 9 | [symbols] 10 | 32 = space 11 | 33 = bang 12 | 34 = quote 13 | 35 = number 14 | 36 = dollar 15 | 37 = percent 16 | 38 = and 17 | 39 = tick 18 | 40 = left paren 19 | 41 = right paren 20 | 42 = star 21 | 43 = plus 22 | 44 = comma 23 | 45 = dash 24 | 46 = dot 25 | 47 = slash 26 | 58 = colon 27 | 59 = semi 28 | 60 = less 29 | 61 = equals 30 | 62 = greater 31 | 63 = question 32 | 64 = at 33 | 91 = left bracket 34 | 92 = backslash 35 | 93 = right bracket 36 | 94 = caret 37 | 95 = line 38 | 96 = grav 39 | 123 = left brace 40 | 124 = bar 41 | 125 = right brace 42 | 126 = tilda 43 | 44 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["flit_core >=3.2,<4"] 3 | build-backend = "flit_core.buildapi" 4 | 5 | [project] 6 | name = "tdsr" 7 | authors = [ 8 | {name = "Tyler Spivey", email = "tspivey@pcdesk.net"} 9 | ] 10 | readme = "readme.md" 11 | license = {file = "COPYING.txt"} 12 | classifiers = [ 13 | "Environment :: Console", 14 | "Intended Audience :: End Users/Desktop", 15 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 16 | "Operating System :: MacOS :: MacOS X", 17 | "Operating System :: POSIX :: Linux", 18 | "Programming Language :: Objective C", 19 | "Programming Language :: Python :: 3", 20 | "Programming Language :: Python :: Implementation :: CPython", 21 | "Topic :: Adaptive Technologies" 22 | ] 23 | dynamic = ["version", "description"] 24 | requires-python = ">=3.9" 25 | dependencies = [ 26 | "pyobjc; sys_platform=='darwin'", 27 | "pyte >=0.8.1,<1", 28 | "wcwidth" 29 | ] 30 | 31 | [project.urls] 32 | Home = "https://github.com/tspivey/tdsr" 33 | 34 | [project.scripts] 35 | tdsr = "tdsr.__main__:main" 36 | -------------------------------------------------------------------------------- /tdsr/backend/speechdispatcher.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | #Copyright (C) 2016, 2017 Tyler Spivey 3 | #See the license in COPYING.txt 4 | import io 5 | import sys 6 | import speechd.client 7 | 8 | def check_range(synth, value, low, high, name): 9 | if value >= low and value <= high: 10 | return True 11 | synth.speak('Bogus value for {0}: {1}. Value must be in the range {2} to {3}'.format(name, value, low, high)) 12 | return False 13 | 14 | def main(): 15 | input_stream = io.TextIOWrapper(sys.stdin.buffer, encoding='utf-8') 16 | synth = speechd.client.SSIPClient('tdsr') 17 | line = input_stream.readline() 18 | while line: 19 | line = line.strip('\n') 20 | if line[0] == u"s": 21 | synth.speak(line[1:]) 22 | elif line[0] == u"l": 23 | # TODO capitals. Do pitchrise here, or just 24 | # let it be Speech Dispatcher's problem? 25 | synth.char(line[1:]) 26 | elif line[0] == u"x": 27 | synth.cancel() 28 | elif line[0] == u"r": 29 | rate = int(line[1:]) 30 | if check_range(synth, rate, 0, 100, 'rate'): 31 | synth.set_rate(-100 + rate * 2) 32 | elif line[0] == u"v": 33 | volume = int(line[1:]) 34 | if check_range(synth, volume, 0, 100, 'volume'): 35 | synth.set_volume(-100 + volume * 2) 36 | line = input_stream.readline() 37 | synth.close() 38 | 39 | if __name__ == '__main__': 40 | main() 41 | -------------------------------------------------------------------------------- /tdsr/backend/mac.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | #Copyright (C) 2016, 2017 Tyler Spivey 3 | #See the license in COPYING.txt 4 | from Foundation import ( 5 | NSObject, NSFileHandle, NSNotificationCenter, 6 | NSFileHandleReadCompletionNotification, NSFileHandleNotificationDataItem, 7 | ) 8 | from AVFoundation import AVSpeechSynthesizer, AVSpeechUtterance, AVSpeechBoundaryImmediate, AVSpeechSynthesisVoice 9 | from PyObjCTools import AppHelper 10 | from objc import python_method 11 | import threading 12 | 13 | rate = None 14 | volume = None 15 | voice_idx = None 16 | voices = AVSpeechSynthesisVoice.speechVoices() 17 | avsynth = AVSpeechSynthesizer.new() 18 | 19 | class FileObserver(NSObject): 20 | def initWithFileDescriptor_readCallback_errorCallback_(self, 21 | fileDescriptor, readCallback, errorCallback): 22 | self = self.init() 23 | self.readCallback = readCallback 24 | self.errorCallback = errorCallback 25 | self.fileHandle = NSFileHandle.alloc().initWithFileDescriptor_( 26 | fileDescriptor) 27 | self.nc = NSNotificationCenter.defaultCenter() 28 | self.nc.addObserver_selector_name_object_( 29 | self, 30 | 'fileHandleReadCompleted:', 31 | NSFileHandleReadCompletionNotification, 32 | self.fileHandle) 33 | self.fileHandle.readInBackgroundAndNotify() 34 | return self 35 | 36 | def fileHandleReadCompleted_(self, aNotification): 37 | ui = aNotification.userInfo() 38 | newData = ui.objectForKey_(NSFileHandleNotificationDataItem) 39 | if newData is None: 40 | if self.errorCallback is not None: 41 | self.errorCallback(self, ui.objectForKey_(NSFileHandleError)) 42 | self.close() 43 | else: 44 | self.fileHandle.readInBackgroundAndNotify() 45 | if self.readCallback is not None: 46 | self.readCallback(self, bytes(newData)) 47 | 48 | def close(self): 49 | self.nc.removeObserver_(self) 50 | if self.fileHandle is not None: 51 | self.fileHandle.closeFile() 52 | self.fileHandle = None 53 | # break cycles in case these functions are closed over 54 | # an instance of us 55 | self.readCallback = None 56 | self.errorCallback = None 57 | 58 | def __del__(self): 59 | # Without this, if a notification fires after we are GC'ed 60 | # then the app will crash because NSNotificationCenter 61 | # doesn't retain observers. In this example, it doesn't 62 | # matter, but it's worth pointing out. 63 | self.close() 64 | 65 | def prompt(): 66 | sys.stdout.write("write something: ") 67 | sys.stdout.flush() 68 | 69 | def gotLine(observer, line): 70 | if not line: 71 | AppHelper.stopEventLoop() 72 | return 73 | line = line.strip(b'\n') 74 | for l in line.split(b'\n'): 75 | handle_line(l) 76 | 77 | 78 | 79 | def handle_line(line): 80 | global rate, volume, voice_idx 81 | line = line.decode('utf-8', 'replace') 82 | if line[0] == u"s" or line[0] == "l": 83 | l = line[1:].replace('[[', ' ') 84 | l = l.replace(u'\u23ce', ' ') 85 | u = AVSpeechUtterance.alloc().initWithString_(l) 86 | u.setPrefersAssistiveTechnologySettings_(True) 87 | if rate is not None: 88 | u.setRate_(rate) 89 | if volume is not None: 90 | u.setVolume_(volume) 91 | if voice_idx is not None: 92 | u.setVoice_(voices[voice_idx]) 93 | avsynth.speakUtterance_(u) 94 | elif line[0] == u"x": 95 | avsynth.stopSpeakingAtBoundary_(AVSpeechBoundaryImmediate) 96 | elif line[0] == u"r": 97 | rate = float(line[1:])/100 98 | elif line[0] == u"v": 99 | volume = int(line[1:]) / 100.0 100 | elif line[0] == "V": 101 | voice_idx = int(line[1:]) 102 | if voice_idx >= len(voices): 103 | voice_idx = None 104 | 105 | def gotError(observer, err): 106 | print("error:", err) 107 | AppHelper.stopEventLoop() 108 | 109 | 110 | def main(): 111 | import sys 112 | observer = FileObserver.alloc().initWithFileDescriptor_readCallback_errorCallback_( 113 | sys.stdin.fileno(), gotLine, gotError) 114 | AppHelper.runConsoleEventLoop(installInterrupt=True) 115 | 116 | if __name__ == '__main__': 117 | main() 118 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # TDSR 2 | This is a console-based screen reader. 3 | It has been tested under macOS, Linux and FreeBSD. 4 | It might also run on other \*nix systems, but this hasn't been tested. 5 | 6 | ## What works 7 | * Reading output 8 | * Reading by line, word and character 9 | * cursor keys (waits some amount of time and speaks) 10 | 11 | ## Note 12 | Compatibility is not guaranteed between versions. 13 | ## Requirements 14 | * Python 3 15 | * pyte 16 | * wcwidth 17 | * pyobjc (macOS only) 18 | * speech server 19 | 20 | ## Installation on macOS 21 | 1. Install Python 3. If using [Homebrew](http://brew.sh/), `brew install python3`. 22 | 1. Install uv. If using Homebrew, `brew install uv`. 23 | 24 | There are multiple ways to run tdsr from here. 25 | You can install tdsr and let uv manage the repository for you: 26 | `uv tool install git+https://github.com/tspivey/tdsr.git` 27 | 28 | You can run `~/.local/bin/tdsr` to start it. 29 | 30 | If you want to develop tdsr or make changes to it, clone the repository and install it in editable mode with `uv tool install -e .`. 31 | 32 | ## Installation on Linux 33 | 34 | These instructions assume you are using speech-dispatcher. The Python bindings aren't available via uv. 35 | 1. Install python3 and the speech dispatcher bindings. These might be in a package called `python3-speechd`, or included in speech-dispatcher. 36 | 1. Install `pyte` (`python3-pyte` on Debian). 37 | 1. Run `bin/tdsr`. 38 | 39 | ## Terminal setup 40 | Open Terminal preferences, under Profiles check Use Option as Meta key. 41 | ## Keys 42 | (alt refers to the meta key.) 43 | * alt u, i, o - read previous, current, next line 44 | * alt j, k, l - read previous, current, next word 45 | * alt m, comma, dot - read previous, current, next character 46 | * alt k twice - spell current word 47 | * alt comma twice - say current character phonetically 48 | * alt c - config. 49 | * alt q - quiet mode on/off. When on, text is not automatically read. 50 | * alt r - start/end selection. 51 | * alt v - copy mode. Press l to copy the line the review cursor is on, or s to copy the screen. 52 | 53 | ## Configuration 54 | Once in the config menu, you can use: 55 | * r - set rate. 56 | * v - set volume (value between 0 and 100). 57 | * p - toggle symbol processing. 58 | * d - set cursor delay (in MS). The default is 20. 59 | * l - Toggle pausing at newlines. 60 | * s - Toggle repeated symbols 61 | * Enter - exit, saving the configuration. 62 | 63 | ## Symbols 64 | Symbols can be added in the configuration file (`~/.tdsr.cfg`), 65 | under the symbols section. 66 | 67 | The format is: 68 | ``` 69 | character code = name 70 | ``` 71 | Because of how the config system works, it's best to do this with one TDSR open, then exit and re-launch to see the changes. 72 | 73 | ## Plugins 74 | Custom key binds and handlers can be added via the plugins and commands section of the config files 75 | and a python module in the plugins directory that exports the following method signature: 76 | 77 | ```python 78 | # Name: parse_output 79 | # Parameters: an array of strings (the lines from the terminal) 80 | # Returns: an array of strings (the things to speak) 81 | def parse_output(lines): 82 | return ["a list of things to say"] 83 | ``` 84 | 85 | ### Config file 86 | In ~/.tdsr.cfg you add to the plugins and commands section to modify the shortcut and terminal command that has been run 87 | 88 | Required: [plugins] The plugin section maps to a letter you press with alt to trigger the plugin. 89 | 90 | Optional: [commands] The command section is a regex of the command you ran previous to triggering the plugin (this minimizes processing time) 91 | 92 | Optional: A regex to indicate the start of your prompt line in your terminal 93 | 94 | #### Example 95 | 96 | To add a shortcut for alt d to trigger a plugin called my_plugin add the following under [plugins] 97 | 98 | ``` 99 | my_plugin = d 100 | ``` 101 | If you have sub folders, separate them with a dot e.g. for plugins/me/my_plugin 102 | 103 | ``` 104 | me.my_plugin = d 105 | ``` 106 | 107 | To specify a command of `echo "hi"` (which makes parsing slightly more efficient) add the following under [commands] 108 | ``` 109 | my_plugin = echo "hi" 110 | ``` 111 | Use dots for sub folders, like the plugin config. You can use a regular expression to make it more flexible, e.g. to 112 | specify a command of `echo "hi"` or `echo "bye"` 113 | 114 | ``` 115 | my_plugin = echo "(hi|bye)" 116 | ``` 117 | 118 | The default prompt is match anything, if you use zsh you can use the following regular expression under [speech]: 119 | 120 | ``` 121 | prompt = ^➜\s{2}.+✗? 122 | ``` 123 | 124 | #### Errors 125 | 126 | If you hear "error loading plugin" followed by an error, you can launch tdsr in debug mode 127 | 128 | ```commandline 129 | ~/tdsr --debug 130 | ``` 131 | 132 | And search the logs for "Error loading plugin" to see more details 133 | 134 | ## Repeating symbols 135 | Symbols you would like condensed down to "42 =" instead of "= = = =" you can specify under the speech section 136 | 137 | ``` 138 | repeated_symbols_values = -_=! 139 | ``` 140 | 141 | ## License 142 | Copyright (C) 2016, 2017 Tyler Spivey 143 | 144 | This program is free software: you can redistribute it and/or modify 145 | it under the terms of the GNU General Public License as published by 146 | the Free Software Foundation, either version 3 of the License, or 147 | (at your option) any later version. 148 | 149 | This program is distributed in the hope that it will be useful, 150 | but WITHOUT ANY WARRANTY; without even the implied warranty of 151 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 152 | GNU General Public License for more details. 153 | 154 | You should have received a copy of the GNU General Public License 155 | along with this program. If not, see . 156 | -------------------------------------------------------------------------------- /tdsr/tdsr.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | #tdsr, a terminal screen reader 3 | #Copyright (C) 2016, 2017 Tyler Spivey 4 | #See the license in COPYING.txt 5 | import importlib 6 | import sys 7 | import os 8 | import select 9 | import fcntl 10 | import struct 11 | import termios 12 | import codecs 13 | import pyte 14 | from importlib.resources import as_file, files 15 | from wcwidth import wcwidth 16 | from io import StringIO, SEEK_END 17 | import subprocess 18 | import time 19 | import configparser 20 | import re 21 | import argparse 22 | import shlex 23 | import logging 24 | import platform 25 | import signal 26 | import copy 27 | import tdsr 28 | import tdsr.backend 29 | import re 30 | 31 | logger = logging.getLogger("tdsr") 32 | logger.addHandler(logging.NullHandler()) 33 | 34 | DEFAULT_CONFIG = files(tdsr).joinpath('tdsr.cfg.dist') 35 | CONFIG_FILE = os.path.expanduser('~/.tdsr.cfg') 36 | CURSOR_TIMEOUT = 0.02 37 | REPEAT_KEY_TIMEOUT = 0.5 38 | PHONETICS = {x[0]: x for x in [ 39 | 'alpha', 'bravo', 'charlie', 'delta', 'echo', 'foxtrot', 40 | 'golf', 'hotel', 'india', 'juliet', 'kilo', 'lima', 'mike', 41 | 'november', 'oscar', 'papa', 'quebec', 'romeo', 'sierra', 42 | 'tango', 'uniform', 'victor', 'wiskey', 'x ray', 'yankee', 43 | 'zulu'] 44 | } 45 | 46 | class State: 47 | def __init__(self): 48 | self.revy = 0 49 | self.revx = 0 50 | self.delayed_functions = [] 51 | self.silence = False 52 | self.tempsilence = False 53 | self.key_handlers = [] 54 | self.config = configparser.ConfigParser() 55 | self.config['speech'] = {'process_symbols': 'false', 'key_echo': True, 'cursor_tracking': True, 56 | "line_pause": True, 'repeated_symbols': 'false', 'repeated_symbols_values': '-=!#'} 57 | self.config['symbols'] = {} 58 | self.config['plugins'] = {} 59 | self.symbols_Re = None 60 | self.copy_x = None 61 | self.copy_y = None 62 | self.last_drawn_x = 0 63 | self.last_drawn_y = 0 64 | self.delaying_output = False 65 | 66 | def save_config(self): 67 | with open(CONFIG_FILE, 'w') as fp: 68 | self.config.write(fp) 69 | 70 | def build_symbols_re(self): 71 | candidates = [] 72 | for symbol in self.config['symbols']: 73 | symbol = int(symbol) 74 | if symbol == 32: 75 | continue 76 | candidates.append(re.escape(chr(symbol))) 77 | if not candidates: 78 | return None 79 | return re.compile('|'.join(candidates)) 80 | 81 | class KeyHandler: 82 | PASSTHROUGH = 1 83 | REMOVE = 2 84 | def __init__(self, keymap, fd=None): 85 | self.keymap = keymap 86 | self.fd = fd 87 | self.last_key = None 88 | self.last_key_time = 0.0 89 | 90 | def add(self, key, handler): 91 | if key not in self.keymap: 92 | self.keymap[key] = handler 93 | 94 | def process(self, data): 95 | key_time = time.monotonic() 96 | key_delta = key_time - self.last_key_time 97 | self.last_key_time = key_time 98 | repeat = data + data 99 | if data not in self.keymap: 100 | self.last_key = data 101 | return self.handle_unknown_key(data) 102 | elif self.last_key == data and repeat in self.keymap and key_delta <= REPEAT_KEY_TIMEOUT: 103 | result = self.keymap[repeat]() 104 | self.last_key = data 105 | return result 106 | else: 107 | result = self.keymap[data]() 108 | if result == KeyHandler.PASSTHROUGH: 109 | os.write(self.fd, data) 110 | self.last_key = data 111 | return result 112 | 113 | def handle_unknown_key(self, data): 114 | os.write(self.fd, data) 115 | 116 | class ConfigHandler(KeyHandler): 117 | def __init__(self): 118 | self.keymap = { 119 | b'r': self.set_rate, 120 | b'v': self.set_volume, 121 | b'V': self.set_voice_idx, 122 | b'p': self.set_process_symbols, 123 | b'd': self.set_delay, 124 | b'e': self.set_echo, 125 | b'c': self.set_cursor_tracking, 126 | b'l': self.set_line_pause, 127 | b's': self.set_repeated_symbols, 128 | } 129 | super().__init__(self.keymap) 130 | 131 | def set_rate(self): 132 | say("Rate") 133 | state.key_handlers.append(BufferHandler(on_accept=self.set_rate2)) 134 | 135 | def set_rate2(self, val): 136 | try: 137 | val = int(val) 138 | except ValueError: 139 | say("Invalid value") 140 | return 141 | synth.set_rate(val) 142 | state.config['speech']['rate'] = str(val) 143 | state.save_config() 144 | say("Confirmed") 145 | 146 | def set_volume(self): 147 | say("volume") 148 | state.key_handlers.append(BufferHandler(on_accept=self.set_volume2)) 149 | 150 | def set_volume2(self, val): 151 | try: 152 | val = int(val) 153 | except ValueError: 154 | say("Invalid value") 155 | return 156 | synth.set_volume(val) 157 | state.config['speech']['volume'] = str(val) 158 | state.save_config() 159 | say("Confirmed") 160 | 161 | def set_voice_idx(self): 162 | say("voice index") 163 | state.key_handlers.append(BufferHandler(on_accept=self.set_voice_idx2)) 164 | 165 | def set_voice_idx2(self, val): 166 | try: 167 | val = int(val) 168 | except ValueError: 169 | say("Invalid value") 170 | return 171 | synth.set_voice_idx(val) 172 | state.config['speech']['voice_idx'] = str(val) 173 | state.save_config() 174 | say("Confirmed") 175 | 176 | 177 | def set_process_symbols(self): 178 | current = state.config.getboolean('speech', 'process_symbols', fallback=False) 179 | current = not current 180 | state.config['speech']['process_symbols'] = str(current) 181 | state.save_config() 182 | say("process symbols on" if current else "process symbols off") 183 | 184 | def set_echo(self): 185 | current = state.config.getboolean('speech', 'key_echo', fallback=True) 186 | current = not current 187 | state.config['speech']['key_echo'] = str(current) 188 | state.save_config() 189 | say("character echo on" if current else "character echo off") 190 | 191 | def set_cursor_tracking(self): 192 | current = state.config.getboolean('speech', 'cursor_tracking', fallback=True) 193 | current = not current 194 | state.config['speech']['cursor_tracking'] = str(current) 195 | state.save_config() 196 | say("cursor tracking on" if current else "cursor tracking off") 197 | 198 | def set_line_pause(self): 199 | current = state.config.getboolean('speech', 'line_pause') 200 | current = not current 201 | state.config['speech']['line_pause'] = str(current) 202 | state.save_config() 203 | say("line pause on" if current else "line pause off") 204 | 205 | def set_repeated_symbols(self): 206 | current = state.config.getboolean('speech', 'repeated_symbols', fallback=False) 207 | current = not current 208 | state.config['speech']['repeated_symbols'] = str(current) 209 | state.save_config() 210 | say("repeated symbols on" if current else "repeated symbols off") 211 | 212 | def set_delay(self): 213 | say("Cursor delay") 214 | state.key_handlers.append(BufferHandler(on_accept=self.set_delay2)) 215 | 216 | def set_delay2(self, val): 217 | global CURSOR_TIMEOUT 218 | try: 219 | val = int(val) 220 | except ValueError: 221 | say("Invalid value") 222 | return 223 | val/=1000 224 | CURSOR_TIMEOUT = val 225 | state.config['speech']['cursor_delay'] = str(val) 226 | state.save_config() 227 | say("Confirmed") 228 | 229 | def handle_unknown_key(self, data): 230 | if data == b'\r' or data == b'\n': 231 | say("exit") 232 | return KeyHandler.REMOVE 233 | 234 | class CopyHandler(KeyHandler): 235 | def __init__(self): 236 | keymap = { 237 | b'l': self.copy_line, 238 | b's': self.copy_screen, 239 | } 240 | super().__init__(keymap) 241 | 242 | def copy_line(self): 243 | try: 244 | copy_text(state.revy, 0, state.revy, screen.columns-1) 245 | except: 246 | say("Failed") 247 | else: 248 | say("line") 249 | return KeyHandler.REMOVE 250 | 251 | def copy_screen(self): 252 | try: 253 | copy_text(0, 0, screen.lines - 1, screen.columns - 1) 254 | except: 255 | say("Failed") 256 | else: 257 | say("screen") 258 | return KeyHandler.REMOVE 259 | 260 | def handle_unknown_key(self, data): 261 | say("unknown key") 262 | return KeyHandler.REMOVE 263 | 264 | class BufferHandler(KeyHandler): 265 | def __init__(self, on_accept=None): 266 | self.on_accept = on_accept 267 | self.buffer = '' 268 | super().__init__(keymap={}) 269 | 270 | def process(self, data): 271 | if data == b'\r' or data == b'\n': 272 | self.on_accept(self.buffer) 273 | return KeyHandler.REMOVE 274 | else: 275 | self.buffer += data.decode('utf-8') 276 | 277 | class Synth: 278 | def __init__(self, speech_server): 279 | self.pipe = None 280 | self.speech_server = speech_server 281 | self.rate = None 282 | self.volume = None 283 | self.voice_idx = None 284 | 285 | def start(self): 286 | self.pipe = subprocess.Popen(self.speech_server, stdin=subprocess.PIPE) 287 | 288 | if self.rate is not None: 289 | self.set_rate(self.rate) 290 | if self.volume is not None: 291 | self.set_volume(self.volume) 292 | if self.voice_idx is not None: 293 | self.set_voice_idx(self.voice_idx) 294 | 295 | def send(self, text): 296 | text = text.encode('utf-8') 297 | try: 298 | self.pipe.stdin.write(text) 299 | self.pipe.stdin.flush() 300 | except BrokenPipeError: 301 | try: 302 | self.start() 303 | self.pipe.stdin.write(text) 304 | self.pipe.stdin.flush() 305 | except BrokenPipeError: 306 | pass # We'll try to restart next time something is sent 307 | 308 | def set_rate(self, rate): 309 | self.rate = rate 310 | self.send('r%d\n' % rate) 311 | 312 | def set_volume(self, volume): 313 | self.volume = volume 314 | self.send('v%d\n' % volume) 315 | 316 | def set_voice_idx(self, voice_idx): 317 | self.voice_idx = voice_idx 318 | self.send('V%d\n' % voice_idx) 319 | 320 | def close(self): 321 | self.pipe.stdin.close() 322 | self.pipe.wait() 323 | 324 | state = State() 325 | speech_buffer = StringIO() 326 | lastkey = "" 327 | def main(term_params): 328 | global CURSOR_TIMEOUT, signal_pipe 329 | parser = argparse.ArgumentParser() 330 | parser.add_argument('-s', '--speech-server', action='store', help='speech server command to run') 331 | parser.add_argument('--debug', action='store_true') 332 | parser.add_argument('program', action='store', nargs='*') 333 | args = parser.parse_args() 334 | if args.speech_server is None: 335 | if platform.system() == 'Darwin': 336 | speech_server = [sys.executable, files(tdsr.backend).joinpath('mac.py')] 337 | else: 338 | # Works on Linux, hopefully other places too: 339 | speech_server = files(tdsr.backend).joinpath('speechdispatcher.py') 340 | else: 341 | speech_server = shlex.split(args.speech_server) 342 | if args.debug: 343 | logger.setLevel(logging.DEBUG) 344 | formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') 345 | fh = logging.FileHandler('tdsr.log') 346 | fh.setFormatter(formatter) 347 | logger.addHandler(fh) 348 | logger.debug("TDSR started") 349 | rows, cols = get_terminal_size(0) 350 | global synth, screen 351 | synth = Synth(speech_server) 352 | synth.start() 353 | if not os.path.exists(CONFIG_FILE): 354 | with as_file(DEFAULT_CONFIG) as default_config_path: 355 | state.config.read(default_config_path) 356 | state.save_config() 357 | state.config.read(CONFIG_FILE) 358 | state.symbols_re = state.build_symbols_re() 359 | if 'rate' in state.config['speech']: 360 | synth.set_rate(int(state.config['speech']['rate'])) 361 | if 'volume' in state.config['speech']: 362 | synth.set_volume(int(state.config['speech']['volume'])) 363 | if 'voice_idx' in state.config['speech']: 364 | synth.set_voice_idx(int(state.config['speech']['voice_idx'])) 365 | if 'cursor_delay' in state.config['speech']: 366 | CURSOR_TIMEOUT = float(state.config['speech']['cursor_delay']) 367 | pid, fd = os.forkpty() 368 | if pid == 0: 369 | handle_child(args) 370 | screen = MyScreen(cols, rows) 371 | pyte.Stream.csi['S'] = 'scroll_up' 372 | pyte.Stream.csi['T'] = 'scroll_down' 373 | stream = pyte.Stream() 374 | stream.attach(screen) 375 | screen.define_charset('B', '(') 376 | decoder = codecs.getincrementaldecoder('utf-8')(errors='replace') 377 | default_key_handler = KeyHandler(keymap, fd) 378 | state.key_handlers.append(default_key_handler) 379 | termios.tcsetattr(fd, termios.TCSADRAIN, term_params) 380 | plugins = dict(state.config.items('plugins')) 381 | for plugin, shortcut in plugins.items(): 382 | default_key_handler.add(f'\x1b{shortcut}'.encode(), handle_plugin(plugin)) 383 | 384 | resize_terminal(fd) 385 | signal_pipe = os.pipe() 386 | signal.signal(signal.SIGWINCH, handle_sigwinch) 387 | say("tdsr, presented by Lighthouse of San Francisco") 388 | while True: 389 | r, w, e = select.select([sys.stdin, fd, signal_pipe[0]], [], [], time_until_next_delayed()) 390 | if signal_pipe[0] in r: 391 | os.read(signal_pipe[0], 1) 392 | old_x, old_y = screen.cursor.x, screen.cursor.y 393 | rows, cols = resize_terminal(fd) 394 | screen.resize(rows, cols) 395 | state.revx = min(state.revx, cols - 1) 396 | state.revy = min(state.revy, rows - 1) 397 | screen.cursor.x = min(old_x, cols - 1) 398 | screen.cursor.y = min(old_y, rows - 1) 399 | if sys.stdin in r: 400 | bytes = os.read(0, 4096) 401 | process_input(bytes, fd) 402 | if fd in r: 403 | try: 404 | bytes = read_all(fd) 405 | except (EOFError, OSError): 406 | sb() 407 | synth.close() 408 | sys.exit(0) 409 | decoded_bytes = decoder.decode(bytes) 410 | x, y = screen.cursor.x, screen.cursor.y 411 | stream.feed(decoded_bytes) 412 | if state.config.getboolean('speech', 'cursor_tracking') and (screen.cursor.x != x or screen.cursor.y != y): 413 | state.revx, state.revy = screen.cursor.x, screen.cursor.y 414 | if not state.silence and not state.tempsilence: 415 | if speech_buffer.tell() > 0 and not state.delaying_output: 416 | schedule(0.005, read_buffer_scheduled) 417 | os.write(1, bytes) 418 | run_scheduled() 419 | 420 | def read_buffer_scheduled(): 421 | state.delaying_output = False 422 | sb() 423 | 424 | def read_all(fd): 425 | bytes = os.read(fd, 4096) 426 | if bytes == b'': 427 | raise EOFError 428 | while has_more(fd): 429 | data = os.read(fd, 4096) 430 | if data == b'': 431 | raise EOFError 432 | bytes += data 433 | return bytes 434 | 435 | def handle_child(args): 436 | if args.program: 437 | program = shlex.split(" ".join(args.program)) 438 | else: 439 | program = [os.environ["SHELL"]] 440 | os.execv(program[0], program) 441 | 442 | newbytes = StringIO() 443 | in_escape = False 444 | escsec = "" 445 | def process_input(bytes, fd): 446 | global lastkey 447 | # Busybox ash asks the terminal to send the cursor position, ignore it 448 | if re.match(br'\033\[\d+;\d+R', bytes): 449 | os.write(fd, bytes) 450 | return 451 | lastkey = "" 452 | silence() 453 | state.delayed_functions = [] 454 | state.tempsilence = False 455 | res = state.key_handlers[-1].process(bytes) 456 | if res == KeyHandler.REMOVE: 457 | state.key_handlers = state.key_handlers[:-1] 458 | lastkey = bytes.decode('utf-8', 'replace') 459 | 460 | def handle_backspace(): 461 | x = screen.cursor.x 462 | if x > 0: 463 | say_character(screen.buffer[screen.cursor.y][screen.cursor.x - 1].data) 464 | return KeyHandler.PASSTHROUGH 465 | 466 | def handle_delete(): 467 | x = screen.cursor.x 468 | say_character(screen.buffer[screen.cursor.y][screen.cursor.x].data) 469 | return KeyHandler.PASSTHROUGH 470 | 471 | def handle_plugin(plugin_name): 472 | try: 473 | mod = importlib.import_module(f"plugins.{plugin_name}") 474 | except Exception as e: 475 | logger.error(e) 476 | say(f"Error loading plugin {e.args}") 477 | 478 | prompt_matcher = re.compile(fr"{state.config.get('speech', 'prompt', fallback='.*')}") 479 | command = state.config.get('commands', plugin_name, fallback=None) 480 | check_command = command is not None 481 | if command: 482 | command_matcher = re.compile(command) 483 | 484 | def handle(): 485 | lines = [] 486 | for i in reversed(range(len(screen.buffer))): 487 | line = "".join(screen.buffer[i][x].data for x in range(screen.columns)).strip() 488 | lines.append(line) 489 | if prompt_matcher.search(line) and check_command and command_matcher.search(line): 490 | break 491 | try: 492 | lines_to_read = mod.parse_output(lines) 493 | for line in lines_to_read: 494 | say(line) 495 | except Exception as e: 496 | logger.error(e) 497 | say(f"Error loading plugin {e.args}") 498 | 499 | return handle 500 | 501 | def sayline(y): 502 | line = "".join(screen.buffer[y][x].data for x in range(screen.columns)).strip() 503 | if line == u'': 504 | line = u'blank' 505 | 506 | new_line = replace_duplicate_characters_with_count(line) 507 | 508 | say(new_line) 509 | 510 | 511 | def replace_duplicate_characters_with_count(line): 512 | symbols = state.config.get('speech', 'repeated_symbols_values', fallback='-=!#') 513 | matcher = re.compile(fr'([{symbols}])\1*') 514 | new_line = line 515 | if state.config.getboolean('speech', 'repeated_symbols'): 516 | results = matcher.finditer(line) 517 | for r in results: 518 | match = r.group() 519 | if len(match) > 1: 520 | new_line = new_line.replace(match, f"{len(match)} {r.groups()[0]}", 1) 521 | 522 | return new_line 523 | 524 | 525 | def prevline(): 526 | state.revy -= 1 527 | if state.revy < 0: 528 | say("top") 529 | state.revy = 0 530 | sayline(state.revy) 531 | 532 | def nextline(): 533 | state.revy += 1 534 | if state.revy > screen.lines - 1: 535 | say("bottom") 536 | state.revy = screen.lines - 1 537 | sayline(state.revy) 538 | 539 | def prevchar(): 540 | state.revx -= 1 541 | if state.revx < 0: 542 | say("left") 543 | state.revx = 0 544 | skip_to_previous_char() 545 | saychar(state.revy, state.revx) 546 | 547 | def saychar(y, x, phonetically=False): 548 | char = screen.buffer[y][x].data 549 | lchar = char.lower() 550 | if phonetically and lchar in PHONETICS: 551 | synth.send('s%s\n' % PHONETICS[lchar]) 552 | else: 553 | say_character(char) 554 | 555 | def nextchar(): 556 | state.revx += wcwidth(screen.buffer[state.revy][state.revx].data) 557 | if state.revx > screen.columns - 1: 558 | say("right") 559 | state.revx = screen.columns - 1 560 | skip_to_previous_char() 561 | saychar(state.revy, state.revx) 562 | 563 | def skip_to_previous_char(): 564 | while screen.buffer[state.revy][state.revx].data == '': 565 | state.revx -= 1 566 | 567 | def topOfScreen(): 568 | state.revy = 0 569 | sayline(state.revy) 570 | 571 | def bottomOfScreen(): 572 | state.revy = screen.lines - 1 573 | sayline(state.revy) 574 | 575 | def startOfLine(): 576 | state.revx = 0 577 | saychar(state.revy, state.revx) 578 | 579 | def endOfLine(): 580 | state.revx = screen.columns - 1 581 | saychar(state.revy, state.revx) 582 | 583 | class MyScreen(pyte.Screen): 584 | 585 | def __init__(self, *args, **kwargs): 586 | super().__init__(*args, **kwargs) 587 | self.saved_cursor = None 588 | self.saved_buffer = None 589 | 590 | def set_margins(self, top=None, bottom=None): 591 | if top == 0 and bottom is None: 592 | top = None 593 | super().set_margins(top=top, bottom=bottom) 594 | 595 | def draw(self, text): 596 | for c in text: 597 | self.draw2(c) 598 | 599 | def draw2(self, text): 600 | global lastkey 601 | logger.debug("Drawing %r", text) 602 | add_to_buffer = True 603 | if text == lastkey: 604 | add_to_buffer = False 605 | if len(text) == 1 and state.config.getboolean('speech', 'key_echo', fallback=False): 606 | say_character(text) 607 | lastkey = "" 608 | if screen.cursor.y == state.last_drawn_y and screen.cursor.x - state.last_drawn_x > 1: 609 | speech_buffer.write(' ') 610 | super(MyScreen, self).draw(text) 611 | if add_to_buffer and not state.silence and not state.tempsilence: 612 | speech_buffer.write(text) 613 | state.last_drawn = text 614 | state.last_drawn_x = screen.cursor.x 615 | state.last_drawn_y = screen.cursor.y 616 | 617 | def tab(self): 618 | if not state.silence: 619 | speech_buffer.write(' ') 620 | super().tab() 621 | 622 | def linefeed(self): 623 | if state.config.getboolean('speech', 'line_pause'): 624 | sb() 625 | else: 626 | speech_buffer.seek(0, SEEK_END) 627 | speech_buffer.write(' ') 628 | super(MyScreen, self).linefeed() 629 | 630 | def backspace(self): 631 | if self.cursor.x > 0 and speech_buffer.tell() > 0: 632 | speech_buffer.seek(speech_buffer.tell() - 1) 633 | super(MyScreen, self).backspace() 634 | 635 | def reset_mode(self, *modes, **kwargs): 636 | if 3 in modes: 637 | modes = list(modes) 638 | modes.remove(3) 639 | if 1049 in modes and self.saved_cursor is not None: 640 | self.cursor = self.saved_cursor 641 | self.buffer = self.saved_buffer 642 | self.saved_cursor = None 643 | self.saved_buffer = None 644 | self.dirty.update(range(self.lines)) 645 | super().reset_mode(*modes, **kwargs) 646 | 647 | def set_mode(self, *modes, **kwargs): 648 | if 3 in modes: 649 | modes = list(modes) 650 | modes.remove(3) 651 | if 1049 in modes: 652 | self.saved_cursor = copy.copy(self.cursor) 653 | self.saved_buffer = copy.deepcopy(self.buffer) 654 | self.dirty.update(range(self.lines)) 655 | self.cursor_position() 656 | self.buffer.clear() 657 | super().set_mode(*modes, **kwargs) 658 | 659 | def erase_in_display(self, how=0, private=False): 660 | if how == 3: 661 | return 662 | super().erase_in_display(how, private=private) 663 | 664 | def select_graphic_rendition(self, *attrs, **kwargs): 665 | if 'private' in kwargs: 666 | return 667 | return super().select_graphic_rendition(*attrs) 668 | 669 | def cursor_up(self, count=None): 670 | super().cursor_up(count=count) 671 | speech_buffer.write(' ') 672 | 673 | def scroll_down(self, count): 674 | if count == 0: 675 | count = 1 676 | top, bottom = self.margins or pyte.screens.Margins(0, self.lines - 1) 677 | y = self.cursor.y 678 | self.cursor.y = top 679 | for i in range(count): 680 | self.reverse_index() 681 | self.cursor.y = y 682 | 683 | def scroll_up(self, count): 684 | if count == 0: 685 | count = 1 686 | top, bottom = self.margins or pyte.screens.Margins(0, self.lines - 1) 687 | y = self.cursor.y 688 | self.cursor.y = bottom 689 | for i in range(count): 690 | self.index() 691 | self.cursor.y = y 692 | 693 | def cursor_position(self, line=None, column=None): 694 | if speech_buffer.tell() > 0 and line == state.last_drawn_y and column == state.last_drawn_x + 1 and ord(state.last_drawn) > 127: 695 | pos = speech_buffer.tell() 696 | speech_buffer.seek(speech_buffer.tell() - 1) 697 | c = speech_buffer.read(1) 698 | if c == ' ': 699 | speech_buffer.truncate() 700 | speech_buffer.seek(speech_buffer.tell() - 1) 701 | if column and speech_buffer.tell() > 0 and line > state.last_drawn_y and column == 1: 702 | speech_buffer.write(' ') 703 | super().cursor_position(line, column) 704 | 705 | def cursor_to_line(self, line=None): 706 | super().cursor_to_line(line) 707 | speech_buffer.write(' ') 708 | 709 | def sb(): 710 | data = speech_buffer.getvalue() 711 | speech_buffer.truncate(0) 712 | speech_buffer.seek(0) 713 | if data == u'': 714 | return 715 | if not state.tempsilence: 716 | new_line = replace_duplicate_characters_with_count(data) 717 | say(new_line) 718 | 719 | def say(data, force_process_symbols=False): 720 | data = data.strip() 721 | def replace_symbols(m): 722 | return " %s " % state.config['symbols'][str(ord(m.group(0)))] 723 | if state.symbols_re is not None and (force_process_symbols or state.config.getboolean('speech', 'process_symbols', fallback=False)): 724 | data = state.symbols_re.sub(replace_symbols, data) 725 | synth.send("s" + data + "\n") 726 | 727 | def silence(): 728 | synth.send('x\n') 729 | 730 | def say_character(ch): 731 | if ch == '': 732 | ch = ' ' 733 | key = str(ord(ch)) 734 | if key in state.config['symbols']: 735 | synth.send('s%s\n' % state.config['symbols'][key]) 736 | else: 737 | synth.send('l%s\n' % ch) 738 | 739 | def arrow_up(): 740 | schedule(CURSOR_TIMEOUT, (lambda: sayline(screen.cursor.y)), True) 741 | return KeyHandler.PASSTHROUGH 742 | 743 | def arrow_down(): 744 | schedule(CURSOR_TIMEOUT, (lambda: sayline(screen.cursor.y)), True) 745 | return KeyHandler.PASSTHROUGH 746 | 747 | def arrow_left(): 748 | schedule(CURSOR_TIMEOUT, (lambda: saychar(screen.cursor.y, screen.cursor.x)), True) 749 | return KeyHandler.PASSTHROUGH 750 | 751 | def arrow_right(): 752 | schedule(CURSOR_TIMEOUT, (lambda: saychar(screen.cursor.y, screen.cursor.x)), True) 753 | return KeyHandler.PASSTHROUGH 754 | 755 | def schedule(timeout, func, set_tempsilence=False): 756 | state.delayed_functions.append((time.monotonic() + timeout, func)) 757 | if set_tempsilence: 758 | state.tempsilence = True 759 | 760 | def run_scheduled(): 761 | if not state.delayed_functions: 762 | return 763 | to_remove = [] 764 | curtime = time.monotonic() 765 | for i in state.delayed_functions: 766 | t, f = i 767 | if curtime >= t: 768 | f() 769 | to_remove.append(i) 770 | for i in to_remove: 771 | state.delayed_functions.remove(i) 772 | 773 | def time_until_next_delayed(): 774 | if not state.delayed_functions: 775 | return None 776 | return max(0, state.delayed_functions[0][0] - time.monotonic()) 777 | 778 | def config(): 779 | say("config") 780 | state.key_handlers.append(ConfigHandler()) 781 | 782 | def copy_mode(): 783 | say("copy") 784 | state.key_handlers.append(CopyHandler()) 785 | 786 | def get_char(): 787 | return screen.buffer[state.revy][state.revx].data 788 | 789 | def move_prevchar(): 790 | if state.revx == 0: 791 | if state.revy == 0: 792 | return '' 793 | state.revy -= 1 794 | state.revx = screen.columns - 1 795 | else: 796 | state.revx -= 1 797 | 798 | def move_nextchar(): 799 | if state.revx == screen.columns - 1: 800 | if state.revy == screen.lines - 1: 801 | return '' 802 | state.revy += 1 803 | state.revx = 0 804 | else: 805 | state.revx += 1 806 | 807 | def prevword(): 808 | if state.revx == 0: 809 | say("left") 810 | sayword() 811 | return 812 | #Move over any existing word we might be in the middle of 813 | while state.revx > 0 and get_char() != ' ': 814 | move_prevchar() 815 | #Skip whitespace 816 | while state.revx > 0 and get_char() == ' ': 817 | move_prevchar() 818 | #Move to the beginning of the word we're now on 819 | while state.revx > 0 and get_char() != ' ' and screen.buffer[state.revy][state.revx - 1].data != ' ': 820 | move_prevchar() 821 | sayword() 822 | 823 | def sayword(spell=False): 824 | word = "" 825 | revx, revy = state.revx, state.revy 826 | b = screen.buffer 827 | while state.revx > 0 and get_char() != ' ' and b[state.revy][state.revx - 1].data != ' ': 828 | move_prevchar() 829 | if state.revx == 0 and get_char() == ' ': 830 | say("space") 831 | return 832 | word += get_char() 833 | while state.revx < screen.columns - 1: 834 | move_nextchar() 835 | if get_char() == ' ': 836 | break 837 | word += get_char() 838 | if spell: 839 | say(' '.join(word), force_process_symbols=True) 840 | else: 841 | say(word) 842 | state.revx, state.revy = revx, revy 843 | 844 | def nextword(): 845 | revx, revy = state.revx, state.revy 846 | m = screen.columns - 1 847 | #Move over any existing word we might be in the middle of 848 | while state.revx < m and get_char() != ' ': 849 | move_nextchar() 850 | #Skip whitespace 851 | while state.revx < m and get_char() == ' ': 852 | move_nextchar() 853 | if state.revx == m and get_char() == ' ': 854 | say("right") 855 | state.revx = revx 856 | sayword() 857 | return 858 | sayword() 859 | 860 | def handle_silence(): 861 | state.silence = not state.silence 862 | say("quiet on" if state.silence else "quiet off") 863 | 864 | def handle_clipboard(): 865 | if state.copy_x is None: 866 | state.copy_x = state.revx 867 | state.copy_y = state.revy 868 | say("select") 869 | return 870 | end_x, end_y = state.revx, state.revy 871 | try: 872 | copy_text(state.copy_y, state.copy_x, end_y, end_x) 873 | except: 874 | say("Failed") 875 | else: 876 | say("copied") 877 | state.copy_x = None 878 | 879 | def copy_text(start_y, start_x, end_y, end_x): 880 | if start_x > end_x: 881 | start_x, end_x = end_x, start_x 882 | if start_y > end_y: 883 | start_y, end_y = end_y, start_y 884 | display = screen.display 885 | buf = [] 886 | start = start_x 887 | for y in range(start_y, end_y + 1): 888 | if y < end_y: 889 | end = screen.columns - 1 890 | else: 891 | end = end_x 892 | if y > start_y: 893 | start = 0 894 | chars = [] 895 | for x in range(start, end + 1): 896 | chars.append(screen.buffer[y][x].data) 897 | buf.append("".join(chars).rstrip()) 898 | buf = "\n".join(buf) 899 | copy_to_clip(buf) 900 | 901 | def copy_to_clip(data): 902 | data = data.encode('utf-8') 903 | proc_args = [] 904 | if platform.system() == 'Darwin': 905 | proc_args = ['pbcopy'] 906 | elif platform.system() == 'Linux': 907 | if os.getenv('XDG_SESSION_TYPE') == 'wayland': 908 | proc_args = ['wl-copy'] 909 | else: 910 | proc_args = ['xclip', '-selection', 'clip'] 911 | 912 | if proc_args: 913 | proc = subprocess.Popen(proc_args, stdin=subprocess.PIPE) 914 | proc.stdin.write(data) 915 | proc.stdin.close() 916 | 917 | def has_more(fd): 918 | r, w, e = select.select([fd], [], [], 0) 919 | if fd in r: 920 | return True 921 | return False 922 | 923 | def get_terminal_size(fd): 924 | s = struct.pack('HHHH', 0, 0, 0, 0) 925 | rows, cols, _, _ = struct.unpack('HHHH', fcntl.ioctl(fd, termios.TIOCGWINSZ, s)) 926 | return rows, cols 927 | 928 | def resize_terminal(fd): 929 | s = struct.pack('HHHH', 0, 0, 0, 0) 930 | s = fcntl.ioctl(0, termios.TIOCGWINSZ, s) 931 | fcntl.ioctl(fd, termios.TIOCSWINSZ, s) 932 | rows, cols, _, _ = struct.unpack('hhhh', s) 933 | return rows, cols 934 | 935 | def handle_sigwinch(*args): 936 | os.write(signal_pipe[1], b'w') 937 | 938 | keymap = { 939 | b'\x1bi': lambda: sayline(state.revy), 940 | b'\x1bu': prevline, 941 | b'\x1bo': nextline, 942 | b'\x1bj': prevword, 943 | b'\x1bk': sayword, 944 | b'\x1bk\x1bk': lambda: sayword(spell=True), 945 | b'\x1bl': nextword, 946 | b'\x1bm': prevchar, 947 | b'\x1b,': lambda: saychar(state.revy, state.revx), 948 | b'\x1b,\x1b,': lambda: saychar(state.revy, state.revx, phonetically=True), 949 | b'\x1b.': nextchar, 950 | b'\x1bU': topOfScreen, 951 | b'\x1bO': bottomOfScreen, 952 | b'\x1bM': startOfLine, 953 | b'\x1b>': endOfLine, 954 | # For the Hungarian keyboard layout 955 | b'\x1b:': endOfLine, 956 | b'\x1bc': config, 957 | b'\x1bq': handle_silence, 958 | b'\x1br': handle_clipboard, 959 | b'\x1bv': copy_mode, 960 | b'\x1bx': silence, 961 | b'\x08': handle_backspace, 962 | b'\x7f': handle_backspace, 963 | b'\x1b[3~': handle_delete, 964 | b'\x1b[A': arrow_up, 965 | b'\x1b[B': arrow_down, 966 | b'\x1b[C': arrow_right, 967 | b'\x1b[D': arrow_left, 968 | # 969 | b'\x1bOA': arrow_up, 970 | b'\x1bOB': arrow_down, 971 | b'\x1bOC': arrow_right, 972 | b'\x1bOD': arrow_left, 973 | } 974 | -------------------------------------------------------------------------------- /COPYING.txt: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------