├── etc ├── vs.png └── emacs.png ├── .github ├── dependabot.yml └── workflows │ └── test.yml ├── .gitignore ├── Makefile ├── Eask ├── CHANGELOG.md ├── README.md ├── line-reminder.el └── LICENSE /etc/vs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emacs-vs/line-reminder/HEAD/etc/vs.png -------------------------------------------------------------------------------- /etc/emacs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emacs-vs/line-reminder/HEAD/etc/emacs.png -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: / 5 | schedule: 6 | interval: daily 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ignore these directories 2 | /.git 3 | /recipes 4 | /_test 5 | /video 6 | 7 | # ignore generated files 8 | *.elc 9 | 10 | # eask packages 11 | .eask/ 12 | dist/ 13 | 14 | # packaging 15 | *-autoloads.el 16 | *-pkg.el 17 | 18 | # OS generated 19 | .DS_Store 20 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | EMACS ?= emacs 2 | EASK ?= eask 3 | 4 | .PHONY: clean checkdoc lint package install compile test 5 | 6 | ci: clean package install compile 7 | 8 | package: 9 | @echo "Packaging..." 10 | $(EASK) package 11 | 12 | install: 13 | @echo "Installing..." 14 | $(EASK) install 15 | 16 | compile: 17 | @echo "Compiling..." 18 | $(EASK) compile 19 | 20 | test: 21 | @echo "Testing..." 22 | $(EASK) test ert ./test/*.el 23 | 24 | checkdoc: 25 | @echo "Run checkdoc..." 26 | $(EASK) lint checkdoc 27 | 28 | lint: 29 | @echo "Run package-lint..." 30 | $(EASK) lint package 31 | 32 | clean: 33 | $(EASK) clean all 34 | -------------------------------------------------------------------------------- /Eask: -------------------------------------------------------------------------------- 1 | ;; -*- mode: eask; lexical-binding: t -*- 2 | 3 | (package "line-reminder" 4 | "0.6.0" 5 | "Line annotation for changed and saved lines") 6 | 7 | (website-url "https://github.com/emacs-vs/line-reminder") 8 | (keywords "convenience" "annotation") 9 | 10 | (package-file "line-reminder.el") 11 | 12 | (script "test" "echo \"Error: no test specified\" && exit 1") 13 | 14 | (source "melpa") 15 | 16 | (depends-on "emacs" "25.1") 17 | (depends-on "fringe-helper") 18 | (depends-on "ov") 19 | (depends-on "ht") 20 | 21 | (development 22 | (depends-on "ert-runner")) 23 | 24 | (setq network-security-level 'low) ; see https://github.com/jcs090218/setup-emacs-windows/issues/156#issuecomment-932956432 25 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | workflow_dispatch: 9 | 10 | concurrency: 11 | group: ${{ github.workflow }}-${{ github.ref }} 12 | cancel-in-progress: true 13 | 14 | jobs: 15 | test: 16 | runs-on: ${{ matrix.os }} 17 | continue-on-error: ${{ matrix.experimental }} 18 | strategy: 19 | fail-fast: false 20 | matrix: 21 | os: [ubuntu-latest, macos-latest, windows-latest] 22 | emacs-version: 23 | - 27.2 24 | - 28.2 25 | - 29.4 26 | - 30.2 27 | experimental: [false] 28 | include: 29 | - os: ubuntu-latest 30 | emacs-version: snapshot 31 | experimental: true 32 | - os: macos-latest 33 | emacs-version: snapshot 34 | experimental: true 35 | - os: windows-latest 36 | emacs-version: snapshot 37 | experimental: true 38 | exclude: 39 | - os: macos-latest 40 | emacs-version: 27.2 41 | 42 | steps: 43 | - uses: actions/checkout@v6 44 | 45 | - uses: jcs090218/setup-emacs@master 46 | with: 47 | version: ${{ matrix.emacs-version }} 48 | 49 | - uses: emacs-eask/setup-eask@master 50 | with: 51 | version: 'snapshot' 52 | 53 | - name: Run tests 54 | run: 55 | make ci 56 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. 6 | 7 | 8 | ## 0.6.0 (Unreleased) 9 | > Released N/A 10 | 11 | * perf: Render only display area ([#28](../../pull/28)) 12 | * pref: Only render in post command ([`1892142`](../../commit/1892142ea12af1bbcbd7360eff7df9948e786548)) 13 | * fix: Avoid temp buffers ([`60de6ed`](../../commit/60de6edca98457b72719bbc5176c22e2b41c9140)) 14 | 15 | ## 0.5.2 16 | > Released Oct 27, 2023 17 | 18 | * Use windows size changed hook instead of configuration hook. ([`f34db57`](../../commit/f34db57ae66fe95e502fcf8cd1da959f82bf96df)) 19 | * Remove delay to avoid `window-scroll-functions` being called repeatedly ([`9728edf`](../../commit/9728edf1c0db9efcd2a92055db9bb9747c8b4bf1)) 20 | * Avoid `Scan error: "Unbalanced parentheses"` when custom save file ([`121f553`](../../commit/121f5533038db59fdaca1b0d8da56f9b9efb296b)) 21 | * Refactor to increase performace, for #5 ([`7561700`](../../commit/7561700e37543bc7622e41d81d5b6dd038a8efe0)) 22 | * Render thumbnail by window ([#15](../../pull/15)) 23 | * Never `advice-remove` to `save-buffer` ([#17](../../pull/17)) 24 | * Redesign indicators clean up logic ([#21](../../pull/21)) 25 | 26 | ## 0.5.1 27 | > Released Feb 4, 2022 28 | 29 | * Limit feature undone changes to only valid buffer, unlike `*scratch*` buffer. 30 | * Added thumbnail support on the opposing fringe. 31 | * Use `hash-table` instead of list to improve performance. 32 | * Fix issue when max line cache is `nil` on save. ([`cd60583`](../../commit/cd60583a6d040a9874d273d2d66fe397664ed54d)) 33 | 34 | ## 0.5.0 35 | > Released May 28, 2021 36 | 37 | * Add feature to for undone changes, [#8](../../pull/8). 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) 2 | [![JCS-ELPA](https://raw.githubusercontent.com/jcs-emacs/badges/master/elpa/v/line-reminder.svg)](https://jcs-emacs.github.io/jcs-elpa/#/line-reminder) 3 | [![MELPA](https://melpa.org/packages/line-reminder-badge.svg)](https://melpa.org/#/line-reminder) 4 | [![MELPA Stable](https://stable.melpa.org/packages/line-reminder-badge.svg)](https://stable.melpa.org/#/line-reminder) 5 | 6 | # line-reminder 7 | > Line annotation for changed and saved lines. 8 | 9 | [![CI](https://github.com/emacs-vs/line-reminder/actions/workflows/test.yml/badge.svg)](https://github.com/emacs-vs/line-reminder/actions/workflows/test.yml) 10 | 11 | | Emacs (with `line-reminder`) | Visual Studio | 12 | |:----------------------------:|:---------------:| 13 | | ![](etc/emacs.png) | ![](etc/vs.png) | 14 | 15 | ## 🔨 Usage 16 | 17 | Enable for all buffers. 18 | 19 | ```el 20 | (global-line-reminder-mode t) 21 | ``` 22 | 23 | Or you can just enable in specific buffer you want. 24 | 25 | ```el 26 | (line-reminder-mode t) 27 | ``` 28 | 29 | ## ❗ Display Annotation 30 | 31 | You can either set `line-reminder-show-option` to `linum` or `indicators` like 32 | the following snippet below. 33 | 34 | ```el 35 | (setq line-reminder-show-option 'linum) ; Or set to 'indicators 36 | ``` 37 | 38 | Change display symbol: (Default to `"▐"`) 39 | 40 | ```el 41 | (setq line-reminder-modified-sign "▐" 42 | line-reminder-saved-sign "▐") 43 | ``` 44 | 45 | ### 💥 Using `linum` 46 | 47 | `linum` uses text to display annotation, you can customize the two variables 48 | below to change the display symbol. The default value for both variables is set 49 | to `"▐"`. 50 | 51 | * `line-reminder-modified-sign` 52 | * `line-reminder-saved-sign` 53 | 54 | Customize format for how line annotation is displayed. 55 | 56 | ```el 57 | (setq line-reminder-linum-format "%s ") 58 | ``` 59 | 60 | ### 💥 Using `indicators` 61 | 62 | Customize the symbol of the fringe: (Default to `'line-reminder--default-bitmap`) 63 | 64 | ```el 65 | (setq line-reminder-bitmap 'filled-rectangle) 66 | ``` 67 | 68 | If you change the fringe location by altering this variable: (Default to `'left-fringe`) 69 | 70 | ```el 71 | (setq line-reminder-fringe-placed 'left-fringe) 72 | ``` 73 | 74 | ## 🖼️ Display thumbnail 75 | 76 | You can display thumbnail by setting: 77 | 78 | ```el 79 | (setq line-reminder-thumbnail t) 80 | ``` 81 | 82 | *P.S. fringe is oppsing from variable `line-reminder-fringe-placed`, hence it's 83 | default to `right-fringe`* 84 | 85 | You can change the thumbnail bitmap by: (Defaul to `line-reminder--default-thumbnail-bitmap`) 86 | 87 | ```el 88 | (setq line-reminder-thumbnail-bitmap 'filled-rectangle) 89 | ``` 90 | 91 | Change thumbnail display symbol: (Default to `"▐"`) 92 | 93 | ```el 94 | (setq line-reminder-thumb-modified-sign "▐" 95 | line-reminder-thumb-saved-sign "▐") 96 | ``` 97 | 98 | ## 💨 Face 99 | 100 | List of face you can customize. 101 | 102 | > For regular indicators 103 | 104 | * `line-reminder-modified-sign-face` 105 | * `line-reminder-saved-sign-face` 106 | 107 | > For thumbnail 108 | 109 | * `line-reminder-modified-sign-thumb-face` 110 | * `line-reminder-saved-sign-thumb-face` 111 | 112 | ## 🛠️ Contribute 113 | 114 | [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) 115 | [![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple?logo=gnuemacs&logoColor=white)](https://github.com/bbatsov/emacs-lisp-style-guide) 116 | [![Donate on paypal](https://img.shields.io/badge/paypal-donate-1?logo=paypal&color=blue)](https://www.paypal.me/jcs090218) 117 | [![Become a patron](https://img.shields.io/badge/patreon-become%20a%20patron-orange.svg?logo=patreon)](https://www.patreon.com/jcs090218) 118 | 119 | If you would like to contribute to this project, you may either 120 | clone and make pull requests to this repository. Or you can 121 | clone the project and establish your own branch of this tool. 122 | Any methods are welcome! 123 | 124 | ### 🔬 Development 125 | 126 | To run the test locally, you will need the following tools: 127 | 128 | - [Eask](https://emacs-eask.github.io/) 129 | - [Make](https://www.gnu.org/software/make/) (optional) 130 | 131 | Install all dependencies and development dependencies: 132 | 133 | ```sh 134 | eask install-deps --dev 135 | ``` 136 | 137 | To test the package's installation: 138 | 139 | ```sh 140 | eask package 141 | eask install 142 | ``` 143 | 144 | To test compilation: 145 | 146 | ```sh 147 | eask compile 148 | ``` 149 | 150 | **🪧 The following steps are optional, but we recommend you follow these lint results!** 151 | 152 | The built-in `checkdoc` linter: 153 | 154 | ```sh 155 | eask lint checkdoc 156 | ``` 157 | 158 | The standard `package` linter: 159 | 160 | ```sh 161 | eask lint package 162 | ``` 163 | 164 | *📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.* 165 | 166 | ## ⚜️ License 167 | 168 | This program is free software; you can redistribute it and/or modify 169 | it under the terms of the GNU General Public License as published by 170 | the Free Software Foundation, either version 3 of the License, or 171 | (at your option) any later version. 172 | 173 | This program is distributed in the hope that it will be useful, 174 | but WITHOUT ANY WARRANTY; without even the implied warranty of 175 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 176 | GNU General Public License for more details. 177 | 178 | You should have received a copy of the GNU General Public License 179 | along with this program. If not, see . 180 | 181 | See [`LICENSE`](./LICENSE.txt) for details. 182 | -------------------------------------------------------------------------------- /line-reminder.el: -------------------------------------------------------------------------------- 1 | ;;; line-reminder.el --- Line annotation for changed and saved lines -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2018-2025 Shen, Jen-Chieh 4 | ;; Created date 2018-05-25 15:10:29 5 | 6 | ;; Author: Shen, Jen-Chieh 7 | ;; URL: https://github.com/emacs-vs/line-reminder 8 | ;; Version: 0.6.0 9 | ;; Package-Requires: ((emacs "25.1") (fringe-helper "1.0.1") (ov "1.0.6") (ht "2.0")) 10 | ;; Keywords: convenience annotation 11 | 12 | ;; This file is NOT part of GNU Emacs. 13 | 14 | ;; This program 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 program 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 program. If not, see . 26 | 27 | ;;; Commentary: 28 | ;; 29 | ;; Line annotation for changed and saved lines. 30 | ;; 31 | 32 | ;;; Code: 33 | 34 | (require 'cl-lib) 35 | (require 'subr-x) 36 | 37 | (require 'fringe-helper) 38 | (require 'ht) 39 | (require 'ov) 40 | 41 | (defgroup line-reminder nil 42 | "Line annotation for changed and saved lines." 43 | :prefix "line-reminder-" 44 | :group 'tool 45 | :link '(url-link :tag "Repository" "https://github.com/emacs-vs/line-reminder")) 46 | 47 | (defcustom line-reminder-show-option 'linum 48 | "Option to show indicators in buffer." 49 | :group 'line-reminder 50 | :type '(choice (const :tag "linum" linum) 51 | (const :tag "indicators" indicators))) 52 | 53 | (defface line-reminder-modified-sign-face 54 | `((t :foreground "#EFF284")) 55 | "Modifed sign face." 56 | :group 'line-reminder) 57 | 58 | (defface line-reminder-saved-sign-face 59 | `((t :foreground "#577430")) 60 | "Modifed sign face." 61 | :group 'line-reminder) 62 | 63 | (defcustom line-reminder-modified-sign-priority 20 64 | "Priority for modified lines overlays." 65 | :type 'integer 66 | :group 'line-reminder) 67 | 68 | (defcustom line-reminder-saved-sign-priority 10 69 | "Priority for saved lines overlays." 70 | :type 'integer 71 | :group 'line-reminder) 72 | 73 | (defcustom line-reminder-thumb-modified-sign-priority 20 74 | "Priority for modified lines thumbnail overlays." 75 | :type 'integer 76 | :group 'line-reminder) 77 | 78 | (defcustom line-reminder-thumb-saved-sign-priority 10 79 | "Priority for saved lines thumbnail overlays." 80 | :type 'integer 81 | :group 'line-reminder) 82 | 83 | (defcustom line-reminder-linum-format "%s " 84 | "Format to display annotation using `linum`." 85 | :type 'string 86 | :group 'line-reminder) 87 | 88 | (defcustom line-reminder-modified-sign "▐" 89 | "Modified sign." 90 | :type 'string 91 | :group 'line-reminder) 92 | 93 | (defcustom line-reminder-saved-sign "▐" 94 | "Saved sign." 95 | :type 'string 96 | :group 'line-reminder) 97 | 98 | (defcustom line-reminder-thumb-modified-sign "▐" 99 | "String to display modified line thumbnail." 100 | :type 'string 101 | :group 'line-reminder) 102 | 103 | (defcustom line-reminder-thumb-saved-sign "▐" 104 | "String to display saved line thumbnail." 105 | :type 'string 106 | :group 'line-reminder) 107 | 108 | (defcustom line-reminder-fringe-placed 'left-fringe 109 | "Line indicators fringe location." 110 | :type '(choice (const :tag "On the left fringe" left-fringe) 111 | (const :tag "On the right fringe" right-fringe)) 112 | :group 'line-reminder) 113 | 114 | (fringe-helper-define 'line-reminder--default-bitmap nil 115 | "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." 116 | "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." 117 | "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." "..xxx.." 118 | "..xxx.." "..xxx..") 119 | 120 | (defcustom line-reminder-bitmap 'line-reminder--default-bitmap 121 | "Line indicators fringe symbol." 122 | :type 'symbol 123 | :group 'line-reminder) 124 | 125 | (defcustom line-reminder-disable-commands '() 126 | "List of commands that wouldn't take effect from this package." 127 | :type 'list 128 | :group 'line-reminder) 129 | 130 | (defcustom line-reminder-add-line-function nil 131 | "Function call when add line to mark." 132 | :type 'function 133 | :group 'line-reminder) 134 | 135 | (defvar-local line-reminder--line-status (make-hash-table :test 'equal) 136 | "Reocrd modified/saved lines' status in hash-table.") 137 | 138 | (defvar-local line-reminder--before-max-pt -1 139 | "Record down the point max for out of range calculation.") 140 | 141 | (defvar-local line-reminder--cache-max-line nil 142 | "Cache prevent counting max line twice.") 143 | 144 | (defvar-local line-reminder--before-begin-pt -1 145 | "Record down the before begin point.") 146 | 147 | (defvar-local line-reminder--before-end-pt -1 148 | "Record down the before end point.") 149 | 150 | (defvar-local line-reminder--before-max-linum -1 151 | "Record down the before maximum line number.") 152 | 153 | (defvar-local line-reminder--before-begin-linum -1 154 | "Record down the before begin line number.") 155 | 156 | (defvar-local line-reminder--before-end-linum -1 157 | "Record down the before end line number.") 158 | 159 | (defvar-local line-reminder--render-this-command-p nil 160 | "Set to non-nil if render current command.") 161 | 162 | (defvar-local line-reminder--undo-cancel-p nil 163 | "If non-nil, we should remove record of changes/saved lines for undo actions.") 164 | 165 | ;; 166 | ;; (@* "External" ) 167 | ;; 168 | 169 | (defvar linum-format) 170 | (defvar buffer-undo-tree) 171 | (defvar undo-tree-mode) 172 | 173 | (declare-function undo-tree-current "ext:undo-tree.el") 174 | (declare-function undo-tree-node-previous "ext:undo-tree.el") 175 | 176 | (defvar line-reminder-thumbnail) 177 | 178 | ;; 179 | ;; (@* "Util" ) 180 | ;; 181 | 182 | (defmacro line-reminder--mute-apply (&rest body) 183 | "Execute BODY without message." 184 | (declare (indent 0) (debug t)) 185 | `(let (message-log-max) 186 | (with-temp-message (or (current-message) nil) 187 | (let ((inhibit-message t)) ,@body)))) 188 | 189 | (defmacro line-reminder--with-no-redisplay (&rest body) 190 | "Execute BODY without any redisplay execution." 191 | (declare (indent 0) (debug t)) 192 | `(let ((inhibit-redisplay t) 193 | (inhibit-modification-hooks t) 194 | after-focus-change-function 195 | buffer-list-update-hook 196 | display-buffer-alist 197 | window-configuration-change-hook 198 | window-scroll-functions 199 | window-size-change-functions 200 | window-state-change-hook 201 | jit-lock-mode) 202 | ,@body)) 203 | 204 | (defmacro line-reminder--with-selected-window (window &rest body) 205 | "Same with `with-selected-window' but safe. 206 | 207 | See macro `with-selected-window' description for arguments WINDOW and BODY." 208 | (declare (indent 1) (debug t)) 209 | `(when (window-live-p ,window) (with-selected-window ,window ,@body))) 210 | 211 | (defun line-reminder--walk-window-lines (callback) 212 | "Walk through display window lines and execute CALLBACK on each line." 213 | (let ((wend (window-end nil t)) 214 | (wstart (window-start)) 215 | (line) 216 | (break)) 217 | (save-excursion 218 | (goto-char wstart) 219 | (setq line (line-reminder--line-number-at-pos)) ; Only call this one time! 220 | (while (and (<= (point) wend) (not break)) 221 | (when-let ((sign (ht-get line-reminder--line-status line)) 222 | ((if (functionp line-reminder-add-line-function) 223 | (funcall line-reminder-add-line-function line) 224 | t))) 225 | (funcall callback line sign)) 226 | (cl-incf line) ; This saves up a lot of performance! 227 | (when (eobp) (setq break t)) ; This make it run the last line! 228 | (forward-line 1))))) 229 | 230 | (defun line-reminder--use-indicators-p () 231 | "Return non-nil if using indicator." 232 | (eq line-reminder-show-option 'indicators)) 233 | 234 | (defun line-reminder--line-number-at-pos (&optional pos) 235 | "Return line number at POS with absolute as default." 236 | (ignore-errors (line-number-at-pos pos t))) 237 | 238 | (defun line-reminder--get-string-sign (face) 239 | "Return string sign priority by FACE." 240 | (cl-case face 241 | (`line-reminder-modified-sign-face line-reminder-modified-sign) 242 | (`line-reminder-saved-sign-face line-reminder-saved-sign) 243 | (`line-reminder-thumb-modified-sign-face line-reminder-thumb-modified-sign) 244 | (`line-reminder-thumb-saved-sign-face line-reminder-thumb-saved-sign))) 245 | 246 | (defun line-reminder--get-priority (face) 247 | "Return overlay priority by FACE." 248 | (cl-case face 249 | (`line-reminder-modified-sign-face line-reminder-modified-sign-priority) 250 | (`line-reminder-saved-sign-face line-reminder-saved-sign-priority) 251 | (`line-reminder-thumb-modified-sign-face line-reminder-thumb-modified-sign-priority) 252 | (`line-reminder-thumb-saved-sign-face line-reminder-thumb-saved-sign-priority))) 253 | 254 | (defun line-reminder--get-face (sign &optional thumbnail) 255 | "Return face by SIGN. 256 | 257 | If optional argument THUMBNAIL is non-nil, return in thumbnail faces." 258 | (cond ((numberp sign) 259 | (when-let ((sign (ht-get line-reminder--line-status sign))) 260 | (line-reminder--get-face sign thumbnail))) 261 | (thumbnail 262 | (cl-case sign 263 | (`modified 'line-reminder-thumb-modified-sign-face) 264 | (`saved 'line-reminder-thumb-saved-sign-face))) 265 | (t 266 | (cl-case sign 267 | (`modified 'line-reminder-modified-sign-face) 268 | (`saved 'line-reminder-saved-sign-face))))) 269 | 270 | (defun line-reminder--create-tty-ov (face fringe priority) 271 | "Create single tty overlay with FACE in FRINGE with PRIORITY." 272 | (let* ((msg (line-reminder--get-string-sign face)) 273 | (len (length msg)) 274 | (msg (progn (add-face-text-property 0 len face nil msg) msg)) 275 | (display-string `(space :align-to ,fringe)) 276 | (display-string (concat (propertize "" 'display display-string) msg)) 277 | (ov (make-overlay (line-beginning-position) (line-end-position))) 278 | (window (selected-window))) 279 | (when (eq fringe 'right-fringe) 280 | (put-text-property (line-beginning-position) (1+ (line-beginning-position)) 281 | 'cursor t display-string)) 282 | (ov-set ov 283 | 'after-string display-string 284 | 'line-reminder-window window 285 | 'window window 286 | 'priority priority) 287 | ov)) 288 | 289 | (defun line-reminder--create-fringe-ov (face fringe priority) 290 | "Create single fringe overlay with FACE in FRINGE with PRIORITY." 291 | (let* ((pos (point)) 292 | ;; If `pos' is at the beginning of line, overlay of the 293 | ;; fringe will be on the previous visual line. 294 | (pos (if (= (line-end-position) pos) pos (1+ pos))) 295 | (display-string `(,fringe ,line-reminder-bitmap ,face)) 296 | (ov (make-overlay pos pos)) 297 | (window (selected-window))) 298 | (ov-set ov 299 | 'after-string (propertize "." 'display display-string) 300 | 'fringe-helper t 301 | 'line-reminder-window window 302 | 'window window 303 | 'priority priority) 304 | ov)) 305 | 306 | (defun line-reminder--create-ov (face) 307 | "Create single overlay with FACE." 308 | (let* ((fringe line-reminder-fringe-placed) 309 | (priority (line-reminder--get-priority face)) 310 | (fnc (if (display-graphic-p) 311 | #'line-reminder--create-fringe-ov 312 | #'line-reminder--create-tty-ov)) 313 | (ov (funcall fnc face fringe priority))) 314 | ov)) 315 | 316 | (defun line-reminder--mark-line (_line face) 317 | "Mark the LINE by using FACE name." 318 | (line-reminder--create-ov face)) 319 | 320 | (defun line-reminder--delete-ovs () 321 | "Clean up all the indicators." 322 | (remove-overlays (point-min) (point-max) 'line-reminder-window (selected-window))) 323 | 324 | (defun line-reminder--add-change-line (line) 325 | "Add LINE with `modified' flag." 326 | (unless (equal (ht-get line-reminder--line-status line) 'modified) 327 | (ht-set line-reminder--line-status line 'modified))) 328 | 329 | (defun line-reminder--remove-change-line (line) 330 | "Remove LINE from status." 331 | (ht-remove line-reminder--line-status line)) 332 | 333 | (defsubst line-reminder--linum-format-string-align-right () 334 | "Return format string align on the right." 335 | (let ((w (length (number-to-string (count-lines (point-min) (point-max)))))) 336 | (format "%%%dd" w))) 337 | 338 | (defsubst line-reminder--get-propertized-normal-sign (line) 339 | "Return a default propertized normal sign. 340 | LINE : pass in by `linum-format' variable." 341 | (propertize (format (format line-reminder-linum-format 342 | (line-reminder--linum-format-string-align-right)) 343 | line) 344 | 'face 'linum)) 345 | 346 | (defun line-reminder--propertized-sign-by-type (type &optional line) 347 | "Return a propertized sign string by type. 348 | TYPE : type of the propertize sign you want. 349 | LINE : Pass is line number for normal sign." 350 | (cl-case type 351 | (`normal (if (not line) 352 | (error "Normal line but with no line number pass in") 353 | ;; Just return normal linum format. 354 | (line-reminder--get-propertized-normal-sign line))) 355 | (`modified (propertize line-reminder-modified-sign 'face 'line-reminder-modified-sign-face)) 356 | (`saved (propertize line-reminder-saved-sign 'face 'line-reminder-saved-sign-face)))) 357 | 358 | (defun line-reminder--linum-format (line) 359 | "Core line reminder format string logic here. 360 | 361 | Argument LINE is passed in by `linum-format' variable." 362 | (let ((sign (ht-get line-reminder--line-status line)) 363 | (normal-sign (line-reminder--propertized-sign-by-type 'normal line)) 364 | reminder-sign) 365 | (when sign 366 | (setq reminder-sign (line-reminder--propertized-sign-by-type sign) 367 | ;; If the sign exist, then remove the last character from the normal 368 | ;; sign. So we can keep our the margin/padding the same without 369 | ;; modifing the margin/padding width. 370 | normal-sign (substring normal-sign 0 (1- (length normal-sign))))) 371 | ;; Combnie the result format 372 | (concat normal-sign reminder-sign))) 373 | 374 | ;; 375 | ;; (@* "Entry" ) 376 | ;; 377 | 378 | (defun line-reminder--enable () 379 | "Enable `line-reminder' in current buffer." 380 | (cl-case line-reminder-show-option 381 | (`linum 382 | (require 'linum) 383 | (setq-local linum-format 'line-reminder--linum-format)) 384 | (`indicators )) ; XXX: Nothing to do here. 385 | (ht-clear line-reminder--line-status) 386 | (add-hook 'before-change-functions #'line-reminder--before-change nil t) 387 | (add-hook 'after-change-functions #'line-reminder--after-change -95 t) 388 | (add-hook 'post-command-hook #'line-reminder--post-command nil t) 389 | ;; XXX: We add advice to `save-buffer', but we never need to remove it since 390 | ;; we have checked `line-reminder-mode' inside `line-reminder--save-buffer' 391 | ;; function. 392 | (advice-add 'save-buffer :after #'line-reminder--save-buffer) 393 | ;; XXX: Don't use local for these hooks/functions, without the local flag 394 | ;; it will be much faster for large operations (paste, save, etc) 395 | (progn 396 | (add-hook 'window-scroll-functions #'line-reminder--scroll) 397 | (add-hook 'window-size-change-functions #'line-reminder--size-change))) 398 | 399 | (defun line-reminder--disable () 400 | "Disable `line-reminder' in current buffer." 401 | (remove-hook 'before-change-functions #'line-reminder--before-change t) 402 | (remove-hook 'after-change-functions #'line-reminder--after-change t) 403 | (remove-hook 'post-command-hook #'line-reminder--post-command t) 404 | (line-reminder-clear-reminder-lines-sign) 405 | ;; XXX: Don't use local for these hooks/functions, without the local flag 406 | ;; it will be much faster for large operations (paste, save, etc) 407 | (progn 408 | (remove-hook 'window-scroll-functions #'line-reminder--scroll) 409 | (remove-hook 'window-size-change-functions #'line-reminder--size-change))) 410 | 411 | ;;;###autoload 412 | (define-minor-mode line-reminder-mode 413 | "Minor mode `line-reminder-mode'." 414 | :lighter " LR" 415 | :group line-reminder 416 | (if line-reminder-mode (line-reminder--enable) (line-reminder--disable))) 417 | 418 | (defun line-reminder--turn-on-line-reminder-mode () 419 | "Turn on the `line-reminder-mode'." 420 | (line-reminder-mode 1)) 421 | 422 | ;;;###autoload 423 | (define-globalized-minor-mode global-line-reminder-mode 424 | line-reminder-mode line-reminder--turn-on-line-reminder-mode 425 | :require 'line-reminder) 426 | 427 | ;; 428 | ;; (@* "Core" ) 429 | ;; 430 | 431 | ;;;###autoload 432 | (defun line-reminder-clear-reminder-lines-sign () 433 | "Clear all the reminder lines' sign." 434 | (interactive) 435 | (ht-clear line-reminder--line-status) 436 | (line-reminder--delete-ovs) 437 | (line-reminder--thumb-delete-ovs)) 438 | 439 | (defun line-reminder--temp-buffer-p () 440 | "Return non-nil if current buffer a temp buffer." 441 | (string-prefix-p " *temp*" (or (buffer-name) ""))) 442 | 443 | (defun line-reminder--custom-file-saving () 444 | "Return t if we are saving `custom-file'." 445 | (and (or print-escape-control-characters inhibit-read-only) 446 | (equal (buffer-file-name) (ignore-errors (expand-file-name custom-file))))) 447 | 448 | (defun line-reminder--valid-situation-p (beg end) 449 | "Return non-nil, if the conditions are matched. 450 | 451 | Arguments BEG and END are passed in by before/after change functions." 452 | (and (not (line-reminder--temp-buffer-p)) 453 | (not (line-reminder--custom-file-saving)) 454 | (not buffer-read-only) 455 | (not (memq this-command line-reminder-disable-commands)) 456 | (if (and beg end) (and (<= beg (point-max)) (<= end (point-max))) t))) 457 | 458 | (defmacro line-reminder--with-valid-situation (beg end &rest body) 459 | "Execute BODY around `line-reminder--valid-situation-p' function. 460 | 461 | See function `line-reminder--valid-situation-p' description for arguments BEG 462 | and END." 463 | (declare (indent 2) (debug t)) 464 | `(when (line-reminder--valid-situation-p ,beg ,end) 465 | ,@body)) 466 | 467 | (defun line-reminder--shift-all-lines (start delta) 468 | "Shift all `change`/`saved` lines by from START line with DELTA." 469 | (unless (zerop delta) 470 | (let ((new-ht (make-hash-table))) 471 | (ht-map (lambda (line sign) 472 | (if (< start line) 473 | (let ((new-line (+ line delta))) 474 | (ht-set new-ht new-line sign)) 475 | (ht-set new-ht line sign))) 476 | line-reminder--line-status) 477 | (setq line-reminder--line-status new-ht)))) ; update 478 | 479 | (defun line-reminder--remove-lines-out-range () 480 | "Remove all lines outside of buffer." 481 | (when line-reminder--cache-max-line 482 | (ht-map (lambda (line _value) 483 | (when (or (< line-reminder--cache-max-line line) (<= line 0)) 484 | (line-reminder--remove-change-line line))) 485 | line-reminder--line-status))) 486 | 487 | (defun line-reminder--remove-lines (beg end comm-or-uncomm-p) 488 | "Remove lines from BEG to END depends on COMM-OR-UNCOMM-P." 489 | (let ((cur beg)) 490 | ;; Shift one more line when commenting/uncommenting 491 | (when comm-or-uncomm-p (cl-incf end)) 492 | (while (< cur end) 493 | (if comm-or-uncomm-p 494 | (line-reminder--add-change-line cur) 495 | (line-reminder--remove-change-line cur)) 496 | (cl-incf cur)))) 497 | 498 | (defun line-reminder--add-lines (beg end) 499 | "Add lines from BEG to END." 500 | (let ((cur beg)) 501 | (while (<= cur end) 502 | (line-reminder--add-change-line cur) 503 | (cl-incf cur)))) 504 | 505 | ;;;###autoload 506 | (defun line-reminder-transfer-to-saved-lines () 507 | "Transfer the `change-lines' to `saved-lines'." 508 | (interactive) 509 | (ht-map ; convert to saved 510 | (lambda (line _value) (ht-set line-reminder--line-status line 'saved)) 511 | line-reminder--line-status) 512 | (line-reminder--render-buffer) 513 | (line-reminder--thumb-render-buffer)) 514 | 515 | (defun line-reminder--before-change (beg end) 516 | "Do stuff before buffer is changed with BEG and END." 517 | (line-reminder--with-valid-situation beg end 518 | ;; If buffer consider virtual buffer like `*scratch*`, then always 519 | ;; treat it as modified 520 | (setq line-reminder--undo-cancel-p (and (buffer-file-name) undo-in-progress) 521 | line-reminder--before-max-pt (point-max) 522 | line-reminder--before-max-linum (line-reminder--line-number-at-pos (point-max)) 523 | line-reminder--before-begin-pt beg 524 | line-reminder--before-begin-linum (line-reminder--line-number-at-pos beg) 525 | line-reminder--before-end-pt end 526 | line-reminder--before-end-linum (line-reminder--line-number-at-pos end)))) 527 | 528 | (defun line-reminder--after-change (beg end len) 529 | "Do stuff after buffer is changed with BEG, END and LEN." 530 | (line-reminder--with-valid-situation beg end 531 | ;; When begin and end are not the same, meaning the there is addition/deletion 532 | ;; happening in the current buffer. 533 | (let ((adding-p (< (+ beg len) end)) 534 | begin-linum end-linum delta-lines 535 | starting-line ; Starting line for shift 536 | ;; Flag to check if currently commenting or uncommenting 537 | (comm-or-uncomm-p (and (not (= len 0)) (not (= beg end))))) 538 | (setq line-reminder--before-max-pt 539 | (if (or adding-p comm-or-uncomm-p) 540 | (+ line-reminder--before-max-pt (- end beg)) 541 | (- line-reminder--before-max-pt len))) 542 | 543 | (setq line-reminder--cache-max-line 544 | (line-reminder--line-number-at-pos (min line-reminder--before-max-pt 545 | (point-max)))) 546 | 547 | (if adding-p 548 | (setq end-linum (line-reminder--line-number-at-pos end) 549 | begin-linum (line-reminder--line-number-at-pos beg)) 550 | (setq beg line-reminder--before-begin-pt 551 | end line-reminder--before-end-pt 552 | begin-linum line-reminder--before-begin-linum 553 | end-linum line-reminder--before-end-linum)) 554 | 555 | (if comm-or-uncomm-p 556 | (setq delta-lines (- line-reminder--cache-max-line line-reminder--before-max-linum)) 557 | (setq delta-lines (- end-linum begin-linum)) 558 | (unless adding-p (setq delta-lines (- 0 delta-lines)))) 559 | 560 | ;; If adding line, bound is the begin line number 561 | (setq starting-line begin-linum) 562 | 563 | ;; NOTE: Deletion.. 564 | (unless adding-p 565 | (line-reminder--remove-lines begin-linum end-linum comm-or-uncomm-p) 566 | (line-reminder--shift-all-lines starting-line delta-lines) 567 | (line-reminder--add-change-line begin-linum)) 568 | 569 | ;; NOTE: Addition.. 570 | (when adding-p 571 | (line-reminder--shift-all-lines starting-line delta-lines) 572 | (line-reminder--add-lines begin-linum end-linum)) 573 | 574 | (setq line-reminder--render-this-command-p t)))) 575 | 576 | (defun line-reminder--render-post-command () 577 | "Post command when rendering indicators." 578 | (when line-reminder--render-this-command-p 579 | (line-reminder--render-buffer) 580 | (line-reminder--thumb-render-buffer) 581 | (setq line-reminder--render-this-command-p nil))) 582 | 583 | (defun line-reminder--post-command () 584 | "Post command." 585 | (line-reminder--render-post-command) 586 | (line-reminder--undo-post-command)) 587 | 588 | (defun line-reminder--render () 589 | "Render indicator once." 590 | (line-reminder--remove-lines-out-range) ; Remove out range! 591 | ;; Walk only display lines, this makes performance extremely fast! 592 | (line-reminder--walk-window-lines 593 | (lambda (line sign) 594 | (line-reminder--mark-line line (line-reminder--get-face sign))))) 595 | 596 | (defun line-reminder--size-change (&optional frame &rest _) 597 | "Render for all visible windows from FRAME." 598 | (line-reminder--with-no-redisplay 599 | (dolist (win (window-list frame)) 600 | (line-reminder--render-window win) 601 | (when line-reminder-thumbnail 602 | (line-reminder--thumb-render-window win))))) 603 | 604 | (defun line-reminder--scroll (&optional window &rest _) 605 | "Render on WINDOW." 606 | (line-reminder--with-no-redisplay 607 | (let ((window (or window (selected-window)))) 608 | (line-reminder--render-window window) 609 | (when line-reminder-thumbnail 610 | (line-reminder--thumb-render-window window))))) 611 | 612 | (defun line-reminder--render-buffer () 613 | "Render indicators for current buffer." 614 | (dolist (win (get-buffer-window-list nil nil t)) 615 | (line-reminder--render-window win))) 616 | 617 | (defun line-reminder--render-window (window) 618 | "Render for WINDOW." 619 | (line-reminder--with-selected-window window 620 | (when (and line-reminder-mode 621 | (line-reminder--use-indicators-p)) 622 | (line-reminder--delete-ovs) 623 | (line-reminder--render)))) 624 | 625 | ;; 626 | ;; (@* "Save" ) 627 | ;; 628 | 629 | (defun line-reminder--save-buffer (&rest _) 630 | "Advice execute after function `save-buffer'." 631 | (when line-reminder-mode (line-reminder-transfer-to-saved-lines))) 632 | 633 | ;; 634 | ;; (@* "Undo" ) 635 | ;; 636 | 637 | (defun line-reminder--undo-tree-root-p () 638 | "Return non-nil, if undo is at the root of the undo list." 639 | (or (eq buffer-undo-list t) 640 | (null (undo-tree-node-previous (undo-tree-current buffer-undo-tree))))) 641 | 642 | (defun line-reminder--undo-root-p () 643 | "Compatible version to check root of undo list for different undo packages." 644 | (cond 645 | ((and (featurep 'undo-tree) undo-tree-mode) 646 | (ignore-errors (line-reminder--undo-tree-root-p))) 647 | (t (eq pending-undo-list t)))) 648 | 649 | (defun line-reminder--undo-post-command () 650 | "Post command for undo cancelling." 651 | (when (and line-reminder--undo-cancel-p (line-reminder--undo-root-p)) 652 | (ht-clear line-reminder--line-status) 653 | (line-reminder--delete-ovs) 654 | (line-reminder--thumb-delete-ovs))) 655 | 656 | ;; 657 | ;; (@* "Thumbnail" ) 658 | ;; 659 | 660 | (defcustom line-reminder-thumbnail nil 661 | "Show thumbnail in the opposite fringe from `line-reminder-fringe-placed'." 662 | :type 'boolean 663 | :group 'line-reminder) 664 | 665 | (fringe-helper-define 'line-reminder--default-thumbnail-bitmap nil 666 | "xx...." "xx...." "xx...." "xx...." "xx...." "xx...." "xx...." 667 | "xx...." "xx...." "xx...." "xx...." "xx...." "xx...." "xx...." 668 | "xx...." "xx...." "xx...." "xx...." "xx...." "xx...." "xx...." 669 | "xx...." "xx....") 670 | 671 | (defcustom line-reminder-thumbnail-bitmap 'line-reminder--default-thumbnail-bitmap 672 | "Bitmap for thumbnail." 673 | :type 'symbol 674 | :group 'line-reminder) 675 | 676 | (defface line-reminder-thumb-modified-sign-face 677 | `((t :foreground "#EFF284")) 678 | "Modifed sign face." 679 | :group 'line-reminder) 680 | 681 | (defface line-reminder-thumb-saved-sign-face 682 | `((t :foreground "#577430")) 683 | "Modifed sign face." 684 | :group 'line-reminder) 685 | 686 | (defun line-reminder--oppose-fringe (fringe) 687 | "Return opposite FRINGE type." 688 | (cl-case fringe 689 | (`left-fringe 'right-fringe) 690 | (`right-fringe 'left-fringe))) 691 | 692 | (defun line-reminder--thumb-create-tty-ov (face fringe priority) 693 | "Create single tty thumbnail overlay with FACE in FRINGE with PRIORITY." 694 | (let* ((msg (line-reminder--get-string-sign face)) 695 | (len (length msg)) 696 | (msg (progn (add-face-text-property 0 len face nil msg) msg)) 697 | (display-string `(space :align-to (- ,fringe 2))) 698 | (display-string (concat (propertize "." 'display display-string) msg)) 699 | (ov (make-overlay (line-beginning-position) (line-end-position))) 700 | (window (selected-window))) 701 | (when (eq fringe 'right-fringe) 702 | (put-text-property 0 1 'cursor t display-string)) 703 | (ov-set ov 704 | 'after-string display-string 705 | 'line-reminder-thumb-window window 706 | 'window window 707 | 'priority (1+ priority)) 708 | ov)) 709 | 710 | (defun line-reminder--thumb-create-fringe-ov (face fringe priority) 711 | "Create single fringe thumbnail overlay with FACE in FRINGE with PRIORITY." 712 | (let* ((pos (point)) 713 | ;; If `pos' is at the beginning of line, overlay of the 714 | ;; fringe will be on the previous visual line. 715 | (pos (if (= (line-end-position) pos) pos (1+ pos))) 716 | (display-string `(,fringe ,line-reminder-thumbnail-bitmap ,face)) 717 | (ov (make-overlay pos pos)) 718 | (window (selected-window))) 719 | (ov-set ov 720 | 'after-string (propertize "." 'display display-string) 721 | 'fringe-helper t 722 | 'line-reminder-thumb-window window 723 | 'window window 724 | 'priority (1+ priority)) 725 | ov)) 726 | 727 | (defun line-reminder--thumb-create-ov (face) 728 | "Create single thumbnail overlay with FACE." 729 | (let* ((fringe (line-reminder--oppose-fringe line-reminder-fringe-placed)) 730 | (priority (line-reminder--get-priority face)) 731 | (fnc (if (display-graphic-p) 732 | #'line-reminder--thumb-create-fringe-ov 733 | #'line-reminder--thumb-create-tty-ov)) 734 | (ov (funcall fnc face fringe priority))) 735 | ov)) 736 | 737 | (defun line-reminder--thumb-render (&rest _) 738 | "Render thumbnail." 739 | (line-reminder--with-no-redisplay 740 | (when line-reminder--cache-max-line 741 | (let ((window-lines (float (max 0 (1- (window-text-height))))) 742 | (buffer-lines (float line-reminder--cache-max-line)) 743 | (guard (make-hash-table)) added start-point percent-line face) 744 | (when (< window-lines buffer-lines) 745 | (save-excursion 746 | (goto-char (window-start)) ; start from 0 percent 747 | (setq start-point (point)) 748 | (ht-map 749 | (lambda (line sign) 750 | (setq face (line-reminder--get-face sign t) 751 | percent-line (* (/ line buffer-lines) window-lines) 752 | percent-line (floor percent-line) 753 | added (ht-get guard percent-line)) 754 | ;; Prevent creating overlay twice on the same line 755 | (when (or (null added) ; Never touched 756 | (eq (car added) 'saved)) ; `modified' can overwrite `saved' 757 | (goto-char start-point) 758 | (when (zerop (forward-line percent-line)) 759 | (when added 760 | (delete-overlay (cdr added))) ; Remove old overlay! 761 | (ht-set guard percent-line 762 | `(,sign . ,(line-reminder--thumb-create-ov face)))))) 763 | line-reminder--line-status))))))) 764 | 765 | (defun line-reminder--thumb-render-buffer () 766 | "Render indicators for current buffer." 767 | (dolist (win (get-buffer-window-list nil nil t)) 768 | (line-reminder--thumb-render-window win))) 769 | 770 | (defun line-reminder--thumb-render-window (window) 771 | "Render thumbnail for WINDOW." 772 | (when line-reminder-thumbnail 773 | (line-reminder--with-selected-window window 774 | (when line-reminder-mode 775 | (line-reminder--thumb-delete-ovs) 776 | (line-reminder--thumb-render))))) 777 | 778 | (defun line-reminder--thumb-delete-ovs () 779 | "Delete thumbnail overlays." 780 | (remove-overlays (point-min) (point-max) 'line-reminder-thumb-window (selected-window))) 781 | 782 | (provide 'line-reminder) 783 | ;;; line-reminder.el ends here 784 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | --------------------------------------------------------------------------------