├── README.md
├── mlscroll.el
└── LICENSE
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # MLScroll - Modeline Scrollbar for Emacs
4 | 
5 | A lightweight scrollbar for the Emacs mode line.
6 |
7 | For graphical window systems:
8 |
9 | 
10 |
11 | and terminals too:
12 |
13 | 
14 |
15 |
16 | ## Why?
17 |
18 | Emacs has so many great ways to navigate, I really only ever used scroll-bars as a _visual indication of position and file size_. But recently, to save space, I added `(scroll-bar-mode -1)` to my init. Immediately I missed having that information at a glance. A percentage in the mode line (like `25%`) is not very glanceable, and also gives no information about the ratio of the currently visible content relative to the total line length (i.e. the _length_ of the bar). I wanted something very fast and very lightweight, plus I'm not so into [rainbow cats](https://github.com/TeMPOraL/nyan-mode). Hence MLScroll.
19 |
20 | ## Info
21 |
22 | - Uses [_specified space_](https://www.gnu.org/software/emacs/manual/html_node/elisp/Specified-Space.html) for drawing (only 3 variable-width spaces, actually) for super-fast text-based mode line scroll indication.
23 | - The bar lengths convey the number of _lines_ above/visible/below window. Computes line numbers with caching for performance.
24 | - Works in terminals! Terminal graphics are more granular (the minimum "pixel" is one character wide). You might want to increase `mlscroll-width-chars` there.
25 | - In graphical Emacs, you can interact with the mode line scroll bar — click, click + drag, and wheel-scroll a full window height at a time.
26 | - Another useful feature: clicking on an inactive window's mode line scroll bar scrolls it, but does _not_ activate that window.
27 |
28 | ## Installing
29 |
30 | Get it from MELPA, and arrange to have:
31 |
32 | ```elisp
33 | (mlscroll-mode 1)
34 | ```
35 |
36 | called at init time (or whenever you are feeling scrolly). Toggle on or off anytime.
37 |
38 | Example for `use-package`:
39 |
40 | ```elisp
41 | (use-package mlscroll
42 | :ensure t
43 | :config
44 | (setq mlscroll-shortfun-min-width 11) ; truncate which-func
45 | (mlscroll-mode 1))
46 | ```
47 |
48 | Alternatively, if you start emacs using the command line `--daemon` command (see below):
49 |
50 | ```elisp
51 | (use-package mlscroll
52 | :ensure t
53 | :hook (server-after-make-frame . mlscroll-mode))
54 | ```
55 |
56 | ## Setup
57 |
58 | ### Customization
59 |
60 | Use `M-x customize-group mlscroll` to change background colors, overall scroll bar width, minimum current "thumb" width, border size, and other settings.
61 |
62 | ### Position
63 |
64 | By default, `MLScroll` disables the `XX%` position mode line indication, and puts itself in the mode line variable `mode-line-end-spaces`, prepending a spacer to right-align itself. Optionally, it can instead replace the `XX%` indicator (or be placed anywhere in your mode line). See `mlscroll-alter-percent-position` and `mlscroll-right-align`.
65 |
66 | ### Which-function mode
67 |
68 | The builtin `which-function-mode` by default puts `[full-function-name]` on the right side of the mode line. With long names and the default bar placement, this can push the `MLScroll` bar partially or fully off the mode line. Set `mlscroll-shortfun-min-width` to a minimum width, and `MLScroll` will truncate the `which-function` name to at least that many trailing characters (e.g. `[…function-name]` or similar), to make room for the scrollbar. The amount of truncation can be adjusted using `mlscroll-shortfun-extra-width`.
69 |
70 | ### Integrating with the mode-line
71 |
72 | Note that `MLScroll` is most visually compatible with "plain" mode line formats that don't use `:box` bordering. It will warn you if you try to use a border with a `:box`-full format enabled (removing the border). It also doesn't inherit `:underline` and `:overline` mode line properties unless `mlscroll-border` is set to 0 (these don't work with the combination of specified space and `:box`).
73 |
74 | See the suggestions for configuring [moody](https://github.com/tarsius/moody) for some config ideas.
75 |
76 | For users of `modus-themes`, `(setq modus-themes-mode-line '(moody borderless))` is recommended, or, in more recent versions (>v4):
77 |
78 | ```elisp
79 | (setq modus-themes-common-palette-overrides
80 | '((border-mode-line-active unspecified)
81 | (border-mode-line-inactive unspecified)))
82 | ```
83 |
84 | ## Scroll-bar width: Lines vs. Characters
85 |
86 | The `MLScroll` bar widths are based on the number of _lines_ visible in the window (+ lines before and after it). The normal scroll bar is based on _characters_ shown. Both tend to change as very long/wrapped lines come into view, but in the opposite sense: `MLScroll` sees fewer lines shown and shrinks the current thumb; the default scrollbar sees many characters come in view, and grows it. I find the lines approach to be more sensible, and it has the advantage that with `truncate-lines` on, the thumb doesn't change size as you scroll. If you'd like to see the difference, evaluate `(insert (make-string 5000 ?a) "\n")` in the `*scratch*` buffer amidst other normal text, and scroll through before and after `toggle-truncate-lines`. On the other hand, highly folded documents like org-mode docs will show a changing "thumb size" as you scroll through, as the current window could contain _many_ (hidden) lines. I find that pretty convenient actually.
87 |
88 | ## FAQ's
89 |
90 | - **How does it work?** `MLScroll` places itself by default in `mode-line-end-spaces`, and uses a right-aligned space to align it at the end of the modeline. For drawing the bars themselves, it uses three "specified spaces".
91 |
92 | - **`MLScroll` doesn't work with my fancy mode line mode!** It should work automatically for simple mode lines that end in `mode-line-end-spaces`. If you prefer, set `mlscroll-right-align` to `nil` and `mlscroll-alter-percent-position` to `'replace` to put it in place of the `XX%` percentage indicator. Otherwise, e.g. if you have a highly customized or pre-packaged mode line, you'll need to find somewhere to put `MLScroll`. A general recipe is to:
93 | 1. Set `mlscroll-right-align` to `nil`.
94 | 2. Set the mode line scroller into the relevant mode-line variable directly yourself, like so: `(setq fancy-mode-line-variable-of-some-kind '(:eval (mlscroll-mode-line))`.
95 | 3. Alternatively, if you didn't design your mode line yourself or find this too complicated, ask whoever did to support `MLScroll`.
96 |
97 | - **`MLScroll` starts off very small when I start an emacs session using `--daemon`.** For graphical windows, `MLScroll` needs to know the width of font characters in the mode line (or at least the default font) to draw a pixel-perfect bar. Since `--daemon` doesn't create a frame or know anything about the font widths, loading MLScroll directly under a `--daemon` session misreports the font width as 1 pixel, leading to a very small scroller bar. The solution is either to abandon `--daemon` in favor of [`(server-start)`](https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html) in your init file, or arrange for MLScroll to be initialized _later_, after a frame is created, ala:
98 | ```elisp
99 | (use-package mlscroll
100 | :hook (server-after-make-frame . mlscroll-mode))
101 | ```
102 | - **How can I customize MLScroll?** `M-x customize-group mlscroll [Ret]`.
103 |
104 | - **I want to use `MLScroll` with different themes throughout the day, what should I do?** This should happen automatically since v0.2. Since the `MLScroll` "thumb" color defaults to the foreground color of the `scroll-bar` face, you might configure that face for your theme, rather than `mlscroll-in-color` directly.
105 |
106 | - **I get a message about :box disabling my `MLScroll` border**: `MLScroll` uses the `:box` attribute to draw _border_ (with the help of `:inverse-video`). If your normal mode line face already has a `:box` property, this will interfere and cause the left/right border to show up. If you want a border to make your `MLScroll` less tall, consider disabling the `:box` property on faces `'mode-line` and `'mode-line-inactive` (`M-x customized-group mode-line-faces [Ret]`). See [issue](https://github.com/jdtsmith/mlscroll/issues/3). For users of `modus-themes`, see above.
107 |
108 | ## Other tips
109 |
110 | `MLScroll` takes up a decent (configurable) chunk of your mode line. To save space for it even when the window is somewhat narrow, I use:
111 |
112 | - [minions](https://github.com/tarsius/minions) to hide all minor-modes under a nice menu.
113 | - [cyphejor](https://github.com/mrkkrp/cyphejor) to shorten the names of major mode using single-char emoji and greek characters.
114 | - `(setq mlscroll-shortfun-min-width 11)` to trim down the which-function name as needed.
115 | - removal of mule-info, and a trim of all double-spaces anywhere in the mode line format to a single space:
116 | ```elisp
117 | (setq-default
118 | mode-line-format ;less space, no MULE
119 | (cl-nsubst-if " " (lambda (x) (and (stringp x) (string-blank-p x) (> (length x) 1)))
120 | (remove 'mode-line-mule-info mode-line-format))))
121 | ```
122 |
--------------------------------------------------------------------------------
/mlscroll.el:
--------------------------------------------------------------------------------
1 | ;;; mlscroll.el --- A scroll bar for the modeline -*- lexical-binding: t; -*-
2 |
3 | ;; Copyright (C) 2021-2024 J.D. Smith
4 |
5 | ;; Author: J.D. Smith
6 | ;; Homepage: https://github.com/jdtsmith/mlscroll
7 | ;; Package-Requires: ((emacs "27.1"))
8 | ;; Version: 0.2.3
9 | ;; Keywords: convenience
10 | ;; Prefix: mlscroll
11 | ;; Separator: -
12 |
13 | ;; MLScroll is free software: you can redistribute it and/or
14 | ;; modify it under the terms of the GNU General Public License as
15 | ;; published by the Free Software Foundation, either version 3 of the
16 | ;; License, or (at your option) any later version.
17 |
18 | ;; MLScroll is distributed in the hope that it will be useful,
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 | ;; General Public License for more details.
22 |
23 | ;; You should have received a copy of the GNU General Public License
24 | ;; along with this program. If not, see .
25 |
26 | ;;; Commentary:
27 |
28 | ;; MLScroll provides a small and lean graphical text based scrollbar
29 | ;; for the mode line. To use, simply load the package and add:
30 | ;;
31 | ;; (mlscroll-mode 1)
32 | ;;
33 | ;; to your configuration. To toggle at any time:
34 | ;;
35 | ;; M-x mlscroll-mode.
36 |
37 | (require 'seq)
38 | (require 'cl-lib)
39 |
40 | ;;; Code:
41 | (defgroup mlscroll nil
42 | "Mode-line Scrolling."
43 | :prefix "mlscroll"
44 | :group 'mode-line
45 | :tag "Mode-line scroll")
46 |
47 | (defcustom mlscroll-alter-percent-position t
48 | "Whether to remove or replace the mode line percentage position.
49 | Removes if t, replaces if set to the symbol replace (but only
50 | if `mlscroll-right-align' is nil). Only effective if
51 | `mode-line-percent-position' is at the beginning of
52 | `mode-line-position'."
53 | :type '(choice
54 | (const :tag "do nothing" nil)
55 | (const :tag "remove" t)
56 | (const :tag "replace" replace)))
57 |
58 | (defcustom mlscroll-right-align t
59 | "Whether to right-align the scrollbar within the mode line.
60 | If set to nil, you must arrange to include
61 | \(eval: (mlscroll-mode-line)) somewhere in `mode-line-format'."
62 | :type 'boolean)
63 |
64 | (defcustom mlscroll-in-color nil
65 | "Custom background color for range inside of current window bounds.
66 | If nil, defaults to scroll-bar foreground color, unless that in
67 | unspecified, in which case the background of the region face is
68 | used."
69 | :type '(choice
70 | (const :tag "Default" nil)
71 | color))
72 |
73 | (defcustom mlscroll-out-color nil
74 | "Custom background color for range outside of current window bounds.
75 | If nil, defaults to the default background color."
76 | :type '(choice (const :tag "Default" nil) color))
77 |
78 | (defcustom mlscroll-width-chars 12
79 | "Width of the mode line scroll indicator in characters.
80 | Default is 12 characters wide."
81 | :type 'integer)
82 |
83 | (defcustom mlscroll-minimum-current-width 2
84 | "Minimum pixel width of the current window region (central) bar.
85 | In the terminal, where a \"pixel\" is one character, defaults to 1."
86 | :type 'integer)
87 |
88 | (defcustom mlscroll-border nil
89 | "Border in pixels around the scrollbar.
90 | Drawn in the mode line's background color. Defaults to 1/4 of the
91 | default font's character height."
92 | :type '(choice (integer :tag "Number of border pixels")
93 | (const :tag "No border" nil)))
94 |
95 | (defcustom mlscroll-shortfun-min-width nil
96 | "If non-nil, truncate `which-function' to a minimum of this width in chars.
97 | If `which-function-mode' is enabled, setting this option will
98 | truncate the current function name from the left, but no smaller
99 | than this width. This allows the scroll bar to appear in full on
100 | the mode line in more situations. See also
101 | `mlscroll-shortfun-extra-width'."
102 | :type '(choice (const :tag "Off" nil)
103 | (integer :tag "Minimum Width")))
104 |
105 | (defcustom mlscroll-shortfun-extra-width 2
106 | "Extra characters of padding need for shortfun width calculation.
107 | These may include padding and bracket characters inside
108 | `which-func-format'. Increasing this number causes the
109 | `which-function' string to become more truncated, leaving extra
110 | room for the scrollbar as window width is reduced. See also
111 | `mlscroll-shortfun-min-width'."
112 | :type 'integer)
113 |
114 | (defvar-local mlscroll-linenum-cache '((0 0 0) 0 0 0)
115 | "A per-buffer cache for line number lookup.
116 | Format:
117 | ( (buf-tick point-min point-max)
118 | last-start-pos line-start line-max )")
119 |
120 | (defun mlscroll-line-numbers (&optional win)
121 | "Calculate and return line numbers.
122 | Returns a list of 3 line numbers at: window start, window end,
123 | and `point-max'. Uses caching for speed. If WIN is passed, use the
124 | window limits and `point-max' of the buffer in that window."
125 | (with-current-buffer (window-buffer win)
126 | (let* ((mod (car mlscroll-linenum-cache))
127 | (last-bt (car mod)) (last-pmn (nth 1 mod)) (last-pmx (nth 2 mod))
128 | (cache (cdr mlscroll-linenum-cache))
129 | (old-start (car cache))
130 | (old-line-start (nth 1 cache))
131 | (old-line-max (nth 2 cache))
132 | (wstart (window-start win)) (wend (window-end win))
133 | (pmn (point-min)) (pmx (point-max))
134 | (buf-tick (buffer-chars-modified-tick))
135 | (line-number-display-limit-width 2000000)
136 | lstart lend lmax)
137 | (if (eq wend nil) (setq wend (window-end win t)))
138 | (if (and (= buf-tick last-bt) (= pmn last-pmn) (= pmx last-pmx))
139 | (setq lstart (cond ((= wstart old-start) old-line-start)
140 | ((< (abs (- wstart old-start)) (- wstart pmn -1000))
141 | (funcall (if (> wstart old-start) #'+ #'-)
142 | old-line-start
143 | (- (count-lines wstart old-start) ; +1 when not at \n
144 | (if (eq (char-before (max wstart old-start)) ?\n) 0 1))))
145 | (t (line-number-at-pos wstart)))
146 | lend (+ lstart (count-lines wstart wend))
147 | lmax old-line-max)
148 | (setq mod (list buf-tick pmn pmx)
149 | lstart (line-number-at-pos wstart)
150 | lend (+ lstart (count-lines wstart wend))
151 | lmax (+ lend (count-lines wend pmx))))
152 | (setq mlscroll-linenum-cache (list mod wstart lstart lmax))
153 | (list lstart lend lmax))))
154 |
155 | (defun mlscroll--part-widths-linenos (&optional win)
156 | "Pixel widths of the bars (not including border).
157 | Also returns line numbers at window start & end and (point-max).
158 | If optional argument WIN is passed, it should be a window in
159 | which to evaluate the line positions."
160 | (let* ((lines (mlscroll-line-numbers win))
161 | (start (car lines))
162 | (end (nth 1 lines))
163 | (last (nth 2 lines))
164 | (sizes (terminal-parameter nil 'mlscroll-size))
165 | (scroll-width (cadr sizes))
166 | (border (caddr sizes))
167 | (w (- scroll-width (* 2 border)))
168 | (cur (max (if (display-graphic-p) mlscroll-minimum-current-width 1)
169 | (round
170 | (* w (/ (float (- end start -1))
171 | last)))))
172 | (left (if (and (= start 1) (= last end)) 0
173 | (max 0 (round (* (- w cur)
174 | (/ (- start 1.0)
175 | (+ (- start 1) (- last end))))))))
176 | (right (max 0 (- w cur left))))
177 | (list left cur right start end last)))
178 |
179 | (defun mlscroll-scroll-to (x &optional idx win)
180 | "Scroll to the position identified by position X and component IDX.
181 | IDX, if set, is an integer -- 0, 1, or 2 -- identifying which
182 | component of the scrollbar we are in (0=left, 1=current,
183 | 2=right). If IDX is non-nil, X is a pixel position within that
184 | component, starting from 0 at left, _including_ border (for idx=1
185 | only). If IDX is nil, X can be either a symbol or an integer.
186 | If it's the symbol `up' or `down', the window is scrolled up or
187 | down by half its height. Otherwise, X is interpreted as a pixel
188 | position within the entire scrollbar (_not_ including borders).
189 | If WIN is set, it is a window whose buffer should be scrolled.
190 | Returns the absolute x position within the full bar (with border
191 | width removed)."
192 | (pcase-let* ((`(,left ,cur ,right ,start-line _ ,last-line)
193 | (mlscroll--part-widths-linenos win))
194 | (border (caddr (terminal-parameter nil 'mlscroll-size)))
195 | (barwidth (+ left cur right))
196 | (xpos (cond ((symbolp x) ; scroll wheel
197 | (+ left (if (eq x 'down)
198 | (- (/ (float cur) 2))
199 | (/ (* (float cur) 3) 2))))
200 | ((null idx) x)
201 | ((= idx 0) (- x border))
202 | ((= idx 1) (+ x left))
203 | ((= idx 2) (+ x left cur))
204 | (t x)))
205 | ;; offset to place bar center at click position
206 | (frac (max 0 (min 1 (/ (float xpos) barwidth))))
207 | (target-line (1+ (round (* frac last-line)))))
208 | (when (/= target-line start-line)
209 | (with-current-buffer (window-buffer win)
210 | (set-window-start win (progn
211 | (goto-char (cadr mlscroll-linenum-cache))
212 | (forward-line (- target-line start-line))
213 | (point)))))
214 | xpos))
215 |
216 | (defun mlscroll-wheel (event)
217 | "Handle mouse scroll events on the scroll bar.
218 | EVENT is the mouse scroll event."
219 | (interactive "e")
220 | (let ((type (event-basic-type event))
221 | (win (posn-window (event-start event))))
222 | (mlscroll-scroll-to
223 | (if (eq type mouse-wheel-up-event) 'up 'down)
224 | nil win)))
225 |
226 | (defun mlscroll-find-index (posn-string)
227 | "Find the 0-based index of the POSN-STRING position within the scroll parts."
228 | (let ((string (car posn-string))
229 | (pos (cdr posn-string)))
230 | (if (and (/= pos 0)
231 | (get-text-property (1- pos) 'mlscroll string))
232 | (- pos (previous-single-property-change pos 'mlscroll string 0))
233 | 0)))
234 |
235 | (defun mlscroll-mouse (start-event)
236 | "Handle click and drag mouse events on the mode line scroll bar.
237 | START-EVENT is the automatically passed mouse event."
238 | (interactive "e")
239 | (let* ((start-posn (event-start start-event))
240 | (start-win (posn-window start-posn))
241 | (pstring (posn-string start-posn))
242 | (lcr (mlscroll-find-index pstring))
243 | (x (car (posn-object-x-y start-posn))) ;; Doesn't function for xterm-mouse-mode
244 | (xstart-abs (car (posn-x-y start-posn)))
245 | (xstart (mlscroll-scroll-to x lcr start-win))
246 | event end xnew)
247 | (unless (terminal-parameter nil 'xterm-mouse-mode)
248 | (pcase-let ((`(,_ ,scroll-width ,border)
249 | (terminal-parameter nil 'mlscroll-size))
250 | (mouse-fine-grained-tracking t))
251 | (track-mouse
252 | (setq track-mouse 'dragging)
253 | (while (and (setq event (read-event))
254 | (mouse-movement-p event))
255 | (setq end (event-end event)
256 | xnew (+ xstart (- (car (posn-x-y end)) xstart-abs)))
257 | (when (and
258 | (eq (posn-area end) 'mode-line)
259 | (>= xnew 0)
260 | (<= xnew (- scroll-width border)))
261 | (mlscroll-scroll-to xnew nil start-win))))))))
262 |
263 | (defvar mlscroll-flank-face-properties nil)
264 | (defvar mlscroll-cur-face-properties nil)
265 | (defconst mlscroll-extra-properties
266 | `(local-map
267 | (keymap (mode-line keymap
268 | (down-mouse-1 . mlscroll-mouse)
269 | (wheel-left . ignore)
270 | (wheel-right . ignore)
271 | (,mouse-wheel-up-event . mlscroll-wheel)
272 | (,mouse-wheel-down-event . mlscroll-wheel)))
273 | help-echo "mouse-1: scroll buffer"
274 | mlscroll t))
275 |
276 | (defvar mlscroll-shortfun-saved nil)
277 | (defvar which-func-current)
278 | (defvar which-func-format)
279 | (defun mlscroll-shortfun-unsetup ()
280 | "Reverse the setup."
281 | (when mlscroll-shortfun-saved
282 | (setq which-func-format mlscroll-shortfun-saved)))
283 |
284 | (defvar-local mlscroll--last-which-func-lengths nil)
285 | (defun mlscroll-which-func-short ()
286 | "Return a shortened `which-func' string to make room for the scrollbar.
287 | It is assumed that, aside from the scrollbar, the screen width of
288 | all the other elements on the modeline is correctly estimated as
289 | the `string-width' of the formatted value. See
290 | `mlscroll-shortfun-extra-width' to adjust the calculation."
291 | (let* ((wfc (eval (cadr which-func-current)))
292 | (lwfc (length wfc))
293 | (cur-length
294 | (cdr
295 | (if (eq lwfc (car mlscroll--last-which-func-lengths))
296 | mlscroll--last-which-func-lengths
297 | (let ((which-func-format mlscroll-shortfun-saved))
298 | (setq mlscroll--last-which-func-lengths
299 | (cons lwfc (string-width
300 | (format-mode-line mode-line-format))))))))
301 | (scroll-width (car (terminal-parameter nil 'mlscroll-size)))
302 | (ww (window-width nil t))
303 | (over (- (+ cur-length mlscroll-width-chars mlscroll-shortfun-extra-width)
304 | 3 ;; mlscroll's specified spaces add only 3 spaces
305 | (/ ww scroll-width))))
306 | (if (and wfc (> over 0))
307 | (concat "…" (substring wfc (- (max (min lwfc mlscroll-shortfun-min-width)
308 | (- lwfc over)))))
309 | wfc)))
310 |
311 | (defun mlscroll-shortfun-setup ()
312 | "Setup MLScroll."
313 | (when mlscroll-shortfun-min-width
314 | (setq mlscroll-shortfun-saved which-func-format)
315 | (setq which-func-format
316 | (cl-subst '(:eval (mlscroll-which-func-short))
317 | 'which-func-current which-func-format))))
318 |
319 | (defun mlscroll-mode-line ()
320 | "Generate text for mode line scrollbar.
321 | Intended to be set in an :eval in the mode line, e.g. (as is done
322 | by default if `mlscroll-right-align' is non-nil), in
323 | `mode-line-end-spaces'."
324 | (pcase-let* ((`(,left ,cur ,right) (mlscroll--part-widths-linenos))
325 | (`(,_ ,scroll-width ,scroll-border) (terminal-parameter nil 'mlscroll-size))
326 | (bar (concat
327 | (propertize " " 'face mlscroll-flank-face-properties
328 | 'display
329 | `(space :width (,(+ left scroll-border))))
330 | (propertize " " 'face mlscroll-cur-face-properties
331 | 'display
332 | `(space :width (,cur)))
333 | (propertize " " 'face mlscroll-flank-face-properties
334 | 'display
335 | `(space :width (,(+ right scroll-border)))))))
336 | (add-text-properties 0 (length bar) mlscroll-extra-properties bar)
337 | (if mlscroll-right-align
338 | (list
339 | (propertize " " 'display ; spacer -- align right
340 | `(space :align-to (- (+ right right-margin)
341 | (,(- scroll-width scroll-border)))))
342 | bar)
343 | bar)))
344 |
345 | (defvar mlscroll-saved [nil nil]
346 | "Saved parts of mode line.")
347 |
348 | (defvar mlscroll--size-set [nil nil])
349 | (defun mlscroll--update-size (&optional frame border force)
350 | "Update terminal parameter for terminal of FRAME with scrollbar size info.
351 | Defaults to the current frame. BORDER is the border size to
352 | use (default `mlscroll-border'). A list with 3 sizes is saved:
353 |
354 | (font-width scrollbar-width and scrollbar-border)
355 |
356 | Only updates sizes once for a given terminal type (graphical or
357 | non-graphical), unless FORCE is non-nil."
358 | (let ((dgp (display-graphic-p frame))
359 | (border (or border mlscroll-border)))
360 | (when-let (((or force (not (aref mlscroll--size-set (if dgp 1 0)))))
361 | (fw (or (and dgp
362 | (if-let ((mlf (face-font 'mode-line)) ; may return nil
363 | (fi (font-info mlf))
364 | (mlw (aref fi 11))
365 | ((> mlw 1))) ; sometimes mode-line font fails
366 | mlw))
367 | (with-selected-window (frame-first-window frame)
368 | (default-font-width)))))
369 | (set-terminal-parameter frame 'mlscroll-size
370 | (list fw (* fw mlscroll-width-chars)
371 | (if dgp border 0)))
372 | (setf (aref mlscroll--size-set (if dgp 1 0)) t))))
373 |
374 | (defun mlscroll--calculate-faces (border)
375 | "Update the faces to use for mlscroll's bar.
376 | BORDER is the border to use in pixels."
377 | (let ((in-col (or mlscroll-in-color
378 | (face-attribute 'scroll-bar :foreground nil t)))
379 | (out-col (or mlscroll-out-color
380 | (face-attribute 'default :background))))
381 | (when (eq in-col 'unspecified)
382 | (setq in-col (face-attribute 'region :background nil t)))
383 | (if (and border (> border 0))
384 | (let ((props `(:box (:line-width ,border) :inverse-video t)))
385 | ;; For box to enclose all 3 segments (with no internal borders)
386 | ;; they must have the same :foreground (after inversion)
387 | (setq mlscroll-flank-face-properties `(,@props :foreground ,out-col)
388 | mlscroll-cur-face-properties `(,@props :foreground ,in-col)))
389 | (setq mlscroll-flank-face-properties
390 | `(:background ,out-col)
391 | mlscroll-cur-face-properties
392 | `(:background ,in-col)))))
393 |
394 | (defun mlscroll-layout (&optional force)
395 | "Layout the mlscroll bar's size and appearance.
396 | See `mlscroll--update-size' for FORCE."
397 | (interactive "P")
398 | (let ((mode-line-has-box
399 | (or (and (face-attribute 'mode-line :box)
400 | (not (eq 'unspecified
401 | (face-attribute 'mode-line :box))))
402 | (and (face-attribute 'mode-line-inactive :box)
403 | (not (eq 'unspecified
404 | (face-attribute 'mode-line-inactive :box))))))
405 | (border (or mlscroll-border 0)))
406 | (unless (or mlscroll-border mode-line-has-box)
407 | (setq border (floor (/ (float (default-font-height)) 4))))
408 | (when (and mlscroll-border (> mlscroll-border 0) mode-line-has-box)
409 | (message "MLScroll border is incompatible with mode-line :box, disabling")
410 | (setq border 0))
411 | (mlscroll--update-size nil border force)
412 | (mlscroll--calculate-faces border)))
413 |
414 | (defun mlscroll--install-on-modeline ()
415 | "Install the mlscrollbar in the modeline.
416 | Saves any replaced mode-line elements."
417 | (when mlscroll-right-align
418 | (when (eq mlscroll-alter-percent-position 'replace)
419 | (message "MLScroll: cannot both right-align and replace percent position, disabling replace")
420 | (setq mlscroll-alter-percent-position t)) ; remove only
421 | (setf (aref mlscroll-saved 1) mode-line-end-spaces
422 | mode-line-end-spaces '(:eval (mlscroll-mode-line))))
423 | (when (and mlscroll-alter-percent-position
424 | (catch 'find-in-tree ; search inside car of mode-line-position
425 | (cl-labels ((find-tree (tree val)
426 | (if (atom tree)
427 | (if (eq tree val) (throw 'find-in-tree t))
428 | (find-tree (car tree) val) ; depth-first
429 | (if-let ((siblings (cdr tree)))
430 | (find-tree siblings val)))))
431 | (find-tree (car mode-line-position) 'mode-line-percent-position))))
432 | (setf (aref mlscroll-saved 0) (car mode-line-position))
433 | (if (eq mlscroll-alter-percent-position 'replace) ; put MLScroll there!
434 | (setcar mode-line-position '(:eval (mlscroll-mode-line)))
435 | (setq mode-line-position (cdr mode-line-position)))))
436 |
437 | ;;;###autoload
438 | (define-minor-mode mlscroll-mode
439 | "Minor mode for displaying an interactive scrollbar in the mode line."
440 | :global t
441 | (if mlscroll-mode
442 | (progn
443 | (add-hook 'after-make-frame-functions #'mlscroll--update-size)
444 | (mlscroll-layout)
445 | (if (boundp 'enable-theme-functions)
446 | (add-hook 'enable-theme-functions #'mlscroll-layout))
447 | (mlscroll--install-on-modeline)
448 | (if mlscroll-shortfun-min-width (mlscroll-shortfun-setup)))
449 | ;; Disabling
450 | (remove-hook 'after-make-frame-functions #'mlscroll--update-size)
451 | (mlscroll-shortfun-unsetup)
452 | (if (aref mlscroll-saved 1)
453 | (setq mode-line-end-spaces (aref mlscroll-saved 1)))
454 | (if (aref mlscroll-saved 0)
455 | (if (eq mlscroll-alter-percent-position 'replace)
456 | (setcar mode-line-position (aref mlscroll-saved 0))
457 | (setq mode-line-position (cons (aref mlscroll-saved 0)
458 | mode-line-position))))
459 | (setq mlscroll-saved [nil nil])))
460 |
461 | (provide 'mlscroll)
462 | ;;; mlscroll.el ends here
463 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------