├── README.md ├── outli.el └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # outli 2 | [![MELPA](https://melpa.org/packages/outli-badge.svg)](https://melpa.org/#/outli) 3 | 4 | Simple and stylish comment-based outlines with speed keys for Emacs. 5 | image 6 | 7 | `outli` is a simple Emacs outliner for code, documents, and more which provides hierarchical hide/show, styles your headings, and emulates org-mode navigation and structure editing. It builds on the built-in `outline-minor-mode` and is simple by design, providing just a few key additional features beyond what outline already offers: 8 | 9 | - Configurable heading syntax based on the concept of a `stem` (fixed first characters) and `repeat-char` (the number of which determines a heading's depth). Example level-two headers include classics such as `;;;;` and `# **`, but anything's possible. 10 | - Default header syntax based on comment char that just works for most modes. 11 | - Header style options including color-matched overline and blended background color for the initial heading info. 12 | - `Tab` and `Shift-Tab` work just like you'd expect from org-mode to toggle headings or document visibility. 13 | - _Speed keys_ mirroring org-mode for easy navigation, visibility, and structure editing at headlines. Hit `?` for the list of available keys. Additions include `h` to hide sub-levels below the current level, and `1`-`5` to specify such a level directly. 14 | - Exposes headings to imenu. A fast imenu browser like [consult-imenu](https://github.com/minad/consult) is recommended. 15 | 16 | # Configuration 17 | `outli` is in MELPA. Either install from there, or clone and point `use-package` at the correct path (or use [straight](https://github.com/radian-software/straight.el), etc.). 18 | 19 | ```elisp 20 | (use-package outli 21 | ;:after lispy ; uncomment only if you use lispy; it also sets speed keys on headers! 22 | :bind (:map outli-mode-map ; convenience key to get back to containing heading 23 | ("C-c C-p" . (lambda () (interactive) (outline-back-to-heading)))) 24 | :hook ((prog-mode text-mode) . outli-mode)) ; or whichever modes you prefer 25 | ``` 26 | 27 | You should probably not enable `outli` in `org-mode` (which by default is prevented), or with other packages which operate on headings or use similar short bindings, like outshine or pdf-tools. If you want to disable individual modes within some larger mode hierarchy (like `text-mode`), you can either opt-in by adding them one-by-one, or include those modes in `outli-heading-config` with a disable entry; see below. 28 | 29 | # Customization 30 | ## Headline style 31 | The main variable to customize is `outli-heading-config`, where you can set the _stem_ and _repeat char_, and influence the styling, including whether to style the stem and repeat chars the same, whether to include the overline, or whether to omit styling altogether. Note that the `t` member of this alist is the default used for all modes which are not explicitly specified. 32 | 33 | Configured defaults are: 34 | 35 | - **emacs-lisp-mode**: stem `;;`, repeat-char `;` 36 | - **tex-mode**: `%%`, `%` 37 | - **markdown-mode**: (empty stem), `#` 38 | - **org-mode**: disabled 39 | - **all others**: `comment-start` + a space, `*` 40 | 41 | The custom variable `outli-blend` controls whether a blended background is used to start the headline. After configuring `outli-heading-config`, you should restart `outli-mode` in any open buffers using it. 42 | 43 | ## Style Defaults 44 | 45 | You can set defaults for the `STYLE` and `NOBAR` properties for all modes, which take effect if these parameters are omitted or `nil` in the `outli-heading-config`; see `outli-default-style` and `outli-default-nobar`. 46 | 47 | ## Faces and maximum depth 48 | 49 | `outli` inherits the underlying faces (colors) from `outline-mode`. By default, `outline-mode` only defines 8 faces. If you'd like headings to go deeper than this, increase `outli-maximum-depth`. At greater depths, the `outline` face a given `outli` face inherits from will "wrap around". If you'd like distinct heading faces at high depth, define more `outline` faces, e.g.: 50 | s 51 | ```elisp 52 | (defface outline-9 53 | '((t :inherit warning :weight bold)) 54 | "Level 9.") 55 | ``` 56 | 57 | ## Speed keys 58 | Customize `outli-speed-commands` to alter or disable speed keys, which work at the beginning of heading lines only (similar to org speed keys). 59 | 60 | ## Folding/unfolding automatically when hopping around buffers 61 | 62 | Try `reveal-mode`; see below. 63 | 64 | # Release information 65 | 66 | (Significant releases only.) 67 | 68 | - **v0.3**: Support heading depths greater than 8. 69 | - **v0.2.4**: Released on MELPA 70 | - **v0.1**: Allow indented headlines 71 | 72 | # FAQ 73 | - **How does this relate to outline-minor-mode?** 74 | 75 | `outli` is mostly a convenient wrapper around functionality that is built-in to `outline-mode`, adding a few things like `narrow-to-subtree` and `insert-heading-respect-content` (ala `org-mode`). And of course the speed-key bindings, automatic comments-as-header patterns, and styling. 76 | - **How does this relate to outshine?** 77 | 78 | Mostly just conceptually. Outshine also provides (different) speed keys, for example. And a lot more, much of which isn't as relevant to modern emacs. Since it builds more directly on the built-in capabilities of outline-minor-mode, `outli` is a _much_ smaller and simpler package. 79 | 80 | - **I wish `outli` styling would update when I change themes**: This should happen automatically in Emacs 29.1 and later. For earlier version, add the following to your `use-package` stanza: 81 | 82 | ```elisp 83 | :config (advice-add 'load-theme :after #'outli-handle-theme-change) ``` 84 | ``` 85 | 86 | - **What is the syntax of `outli-heading-config`?** 87 | 88 | It's an _alist_, each entry of which looks like: 89 | 90 | `(MAJOR-MODE STEM REPEAT-CHAR STYLE NO-BAR)` to configure a mode. 91 | or 92 | 93 | `(MAJOR-MODE . nil)` to explicitly prevent `outli` from running in this mode. 94 | 95 | I recommend using the customize interface to configure `outli`: `M-x customize-group outli`. But it may help to know: 96 | - `MAJOR-MODE`: A symbol for a major mode, or parent mode from which the current mode inherits, like `'text-mode` (note: omit the single apostrophe in the customize interface: it knows it's a symbol). A value of `t` is used to specify the default config. 97 | - `STEM`: A string like `"# "`. The fixed "stem" of the headline pattern (omit quotes in the customize interface). Can also be an elisp expression which evaluates to a string. 98 | - `REPEAT-CHAR`: A _character_ like `?*`. The repeating character which specifies the level of a headline (again: no `?` needed in customize, just type the character). Can also be an elisp expression which evaluates to a character. 99 | - `STYLE`: A style flag (symbol). `nil` for default (maximum) styling, the symbol `none` for no special styling of headlines, and `t` for matched styling between stem and repeat char. Can be omitted (defaults to `nil`). See also `outli-default-style`. 100 | - `NO-BAR`: A flag for the overline bar. If non-`nil`, omit the overline. Can be omitted (defaults to `nil`). See also `outli-default-nobar`. 101 | 102 | # Tips 103 | - You can use arbitrary expressions for the stem and repeat chars; they'll get evaluated at run-time. 104 | - It's useful to target high-level modes like `prog-mode` or `text-mode`, from which many modes inherit (see [mode-minder](https://github.com/jdtsmith/mode-minder) to get a list of your major mode hierarchy). 105 | - Try out the `h` key at headline start: it folds everything up to be no deeper than the current header's level. 106 | - To prevent `outli` from being enabled in a given mode (or family of derived modes), just include `(MODE . nil)` in `outli-heading-config`. By default, `org-mode` is excluded in this way (since it has its own styling system). 107 | - Some emacs tools like `isearch` are smart about folding/unfolding text as you navigate through a buffer with them. But not all. To fix this, you can consider enabling `reveal-mode` in buffers where you use `outli`, then tools like `xref`, etc. will reveal folded targets, re-hiding them when you navigate away. 108 | - I recommend `consult-org-heading` and/or `consult-outline` for quickly browsing `outli` headings. You can even combine these into one command, like: 109 | ```elisp 110 | (defun my/consult-org-heading-or-outline () 111 | (interactive) 112 | (if (derived-mode-p 'org-mode) 113 | (consult-org-heading) 114 | (consult-outline))) 115 | ``` 116 | 117 | If you use `consult-imenu`, you might like to separate headings, by adding this to the `consult-imenu` config: 118 | 119 | ```elisp 120 | (push '(?h "Headings") 121 | (plist-get (cdr (assoc 'emacs-lisp-mode consult-imenu-config)) :types)) 122 | ``` 123 | 124 | # Related Packages 125 | - `outline-minor-mode`: The built-in minor mode for outlining documents on which `outli` builds. 126 | - [orgmode](https://orgmode.org): The do-everything outliner mode. 127 | - [outshine](https://github.com/alphapapa/outshine): A feature-full `outline-minor-mode` enhancement from which `outli` took its inspiration. Has many legacy features. 128 | - [outorg](https://github.com/alphapapa/outorg): Required by `outshine`, this mode enables editing comment blocks in temporary `org-mode` buffers (the inverse of code-blocks in `org`). 129 | - See [more related packages for org-like behavior outside of org](https://orgmode.org/worg/org-tutorials/org-outside-org.html). 130 | -------------------------------------------------------------------------------- /outli.el: -------------------------------------------------------------------------------- 1 | ;;; outli.el --- Org-like code outliner -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2022-2025 4 | 5 | ;; Author: J.D. Smith 6 | ;; URL: https://github.com/jdtsmith/outli 7 | ;; Package-Requires: ((emacs "27.1")) 8 | ;; Version: 0.3.0 9 | ;; Keywords: convenience, outlines, Org 10 | 11 | ;; outli is free software: you can redistribute it 12 | ;; and/or modify it under the terms of the GNU General Public License 13 | ;; as published by the Free Software Foundation, either version 3 of 14 | ;; the License, or (at your option) any later version. 15 | 16 | ;; outli is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19 | ;; General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; outli-mode is a simple minor-mode using outline-minor-mode to 27 | ;; support configurable special comment lines as level-aware outline 28 | ;; headings. As in org-mode, headings can be collapsed, navigated, 29 | ;; moved, etc. outli styles headings for easy level recognition and 30 | ;; provides a org-mode-like header navigation and editing 31 | ;; capabilities, including "speed keys" which are activated at the 32 | ;; start of headings. 33 | ;; 34 | ;; Customize `outli-heading-config' to set the "stem" and "repeat" 35 | ;; character for comment-based headings and to influence how the 36 | ;; headings are styled. Customize `outli-speed-commands' to alter or 37 | ;; disable speed keys, which work at the beginning of heading lines 38 | ;; only. Outli inherits heading colors from the `outline-*' faces. 39 | 40 | ;;; Code: 41 | (require 'outline) 42 | (require 'color) 43 | 44 | ;;;; Variables 45 | (defgroup outli nil 46 | "Simple comment outlining." 47 | :tag "Outli" 48 | :group 'outlines) 49 | 50 | (defcustom outli-maximum-depth 8 51 | "Maximum depth for outli headers in the buffer. 52 | Note that `outline-mode' defines only 8 faces by default. Outli faces 53 | at higher depth will wrap back around, reusing faces at low depth. To 54 | achieve distinct faces at high depths, you can define new outline faces." 55 | :type 'natnum) 56 | 57 | (defcustom outli-heading-config 58 | '((emacs-lisp-mode ";;" ?\; t) 59 | (tex-mode "%%" ?% t) 60 | (markdown-mode "" ?# none t) 61 | (org-mode . nil) 62 | (t (let* ((c (or comment-start "#")) 63 | (space (unless (eq (aref c (1- (length c))) ?\s) " "))) 64 | (concat c space)) 65 | ?*)) 66 | "Formatting configuration for outli comment headings. 67 | The configuration is an alist with each element in one of two forms: 68 | 69 | (MAJOR-MODE STEM REPEAT-CHAR [STYLE NO-BAR]) 70 | 71 | with entries for the first form: 72 | 73 | - key MAJOR-MODE (a mode symbol, or t) 74 | - initial string STEM 75 | - REPEAT-CHAR, a character the count of which denotes heading 76 | depth 77 | - optional STYLE, a symbol. If the symbol none, no styling of any kind 78 | is applied to headings. If otherwise non-nil, the stem and repeat 79 | character parts of the heading both get identical stem-styling. 80 | - optional boolean NO-BAR: if non-nil, omit the overline styling for 81 | this mode. 82 | 83 | or 84 | 85 | (MAJOR-MODE . nil) 86 | 87 | which will disable `outli' in any modes derived from this mode. 88 | 89 | STEM and REPEAT-CHAR are eval'd if expressions. To provide a 90 | default setting for any mode as backup, specify MAJOR-MODE as t. 91 | Note that ordering is important, as settings from the first 92 | matching mode are used. Note that the first MAJOR-MODE from 93 | which the current mode derives will match." 94 | :type '(alist :key-type (choice (const :tag "Default" t) (symbol :tag "Major Mode")) 95 | :value-type 96 | (choice (const :tag "Disable" nil) 97 | (list :tag "Configure" 98 | (choice :tag "Stem" string sexp) 99 | (character :tag "Repeat Char") 100 | (choice :tag "Style" 101 | (const :tag "No Styling" none) 102 | (const :tag "Uniform Style" t) 103 | (const :tag "Default Style" nil)) 104 | (boolean :tag "Omit Overline"))))) 105 | 106 | (defcustom outli-allow-indented-headlines nil 107 | "Whether to allow initial space at the beginning of the line." 108 | :type 'boolean) 109 | 110 | (defcustom outli-default-style nil 111 | "Default STYLE to use, if not set in `outli-heading-config'." 112 | :type '(choice (const :tag "Use heading-config" nil) 113 | (const :tag "None" none) 114 | (const :tag "Stem Matched" t))) 115 | 116 | (defcustom outli-default-nobar nil 117 | "If set, NOBAR will be implied for all modes." 118 | :type 'boolean) 119 | 120 | (defcustom outli-blend 0.25 121 | "Blended color to decorate initial heading background. 122 | Either nil for no blended background, or a floating point number 123 | <=1.0, representing the fraction of the heading foreground color 124 | to blend with the background." 125 | :type '(choice (const :tag "Disable" nil) float)) 126 | 127 | (defcustom outli-speed-commands 128 | '(("Outline Navigation") 129 | ("n" . outline-next-visible-heading) 130 | ("p" . outline-previous-visible-heading) 131 | ("f" . outline-forward-same-level) 132 | ("b" . outline-backward-same-level) 133 | ("u" . outline-up-heading) 134 | ("Outline Visibility") 135 | ("c" . outline-cycle) 136 | ("C" . outline-cycle-buffer) 137 | ("s" . outli-toggle-narrow-to-subtree) 138 | ("h" . outline-hide-sublevels) 139 | ("1" . (outline-hide-sublevels 1)) 140 | ("2" . (outline-hide-sublevels 2)) 141 | ("3" . (outline-hide-sublevels 3)) 142 | ("4" . (outline-hide-sublevels 4)) 143 | ("5" . (outline-hide-sublevels 5)) 144 | ("Outline Structure Editing") 145 | ("U" . outline-move-subtree-up) 146 | ("D" . outline-move-subtree-down) 147 | ("r" . outline-demote) 148 | ("l" . outline-promote) 149 | ("i" . outli-insert-heading-respect-content) 150 | ("@" . outline-mark-subtree) 151 | ("?" . outli-speed-command-help)) 152 | "Alist of speed commands. 153 | 154 | The car of each entry is a string with a single letter, which 155 | must be assigned to `self-insert-command' in the global map. 156 | 157 | The cdr is either a command to be called interactively, a 158 | function to be called, or a form to be evaluated. 159 | 160 | An entry that is just a list with a single string will be 161 | interpreted as a descriptive headline that will be added when 162 | listing the speed commands in the Help buffer using the `?' speed 163 | command." 164 | :type '(repeat :value ("k" . ignore) 165 | (choice :value ("k" . ignore) 166 | (list :tag "Descriptive Headline" (string :tag "Headline")) 167 | (cons :tag "Letter and Command" 168 | (string :tag "Command letter") 169 | (choice 170 | (function) 171 | (sexp)))))) 172 | 173 | (defvar-local outli-heading-stem nil 174 | "The initial stem for headings. Defaults to 2x `comment-start'.") 175 | 176 | (defvar-local outli-heading-char nil 177 | "Character used to indicate heading depth. Defaults to `commment-start'.") 178 | 179 | ;;;; Outline Headings 180 | (defun outli-heading-regexp () 181 | "Compute heading regexp based on stem and repeat char." 182 | (when (and outli-heading-stem outli-heading-char) 183 | (rx-to-string `(and ,@(if outli-allow-indented-headlines '((* space))) 184 | (group ,outli-heading-stem (+ ,outli-heading-char) ?\s))))) 185 | 186 | (defun outli-indent-level () 187 | "Return the indent level for the most recently matched heading." 188 | (if-let ((match (match-string 1))) 189 | (or (cdr (assoc match outline-heading-alist)) 190 | (- (length match) (length outli-heading-stem) 1)))) 191 | 192 | (defun outli--on-heading (cmd) 193 | "Return the argument CMD if on heading." 194 | (if (outline-on-heading-p) cmd)) 195 | 196 | (defun outli--at-heading (cmd) 197 | "Return argument CMD if on a heading line." 198 | (and 199 | outline-regexp 200 | (if (bolp) 201 | (looking-at outline-regexp) 202 | (and (save-excursion 203 | (forward-line 0) 204 | (looking-at outline-regexp)) 205 | (> (match-end 0) (point)))) 206 | cmd)) 207 | 208 | ;;;; Outline Commands 209 | (defun outli-toggle-narrow-to-subtree () 210 | "Narrow to sub-tree or widen if already narrowed." 211 | (interactive) 212 | (if (buffer-narrowed-p) 213 | (widen) 214 | (let ((beg)) 215 | (if (outline-on-heading-p) 216 | (beginning-of-line) 217 | (outline-previous-visible-heading 1)) 218 | (setq beg (point)) 219 | (save-excursion 220 | (outline-end-of-subtree) 221 | (narrow-to-region beg (point)))))) 222 | 223 | (defun outli-insert-heading-respect-content () 224 | "Add a new heading at the current level after any contents." 225 | (interactive) 226 | (let ((head (save-excursion 227 | (condition-case nil 228 | (outline-back-to-heading) 229 | (error (outline-next-heading))) 230 | (if (eobp) 231 | (or (caar outline-heading-alist) "") 232 | (match-string 0))))) 233 | (unless (or (string-match "[ \t]\\'" head) 234 | (not (string-match (concat "\\`\\(?:" outline-regexp "\\)") 235 | (concat head " ")))) 236 | (setq head (concat head " "))) 237 | (outline-end-of-subtree) 238 | (unless (bolp) (insert "\n")) 239 | (insert head) 240 | (unless (eolp) 241 | (save-excursion (newline-and-indent))) 242 | (run-hooks 'outline-insert-heading-hook))) 243 | 244 | ;;;; Fontification 245 | (defun outli-fontify-background-blend (fg) 246 | "Compute blended background color for headline match based on foreground FG. 247 | Returns blended background color." 248 | (let* ((frac (- 1.0 outli-blend)) 249 | (bg (frame-parameter nil 'background-color)) 250 | (cols (mapcar #'color-name-to-rgb `(,bg ,fg)))) 251 | (if (cl-every (lambda (c) (and (consp c) (cl-every #'numberp c))) cols) 252 | (apply #'color-rgb-to-hex 253 | (apply #'cl-mapcar (lambda (a b) 254 | (+ (* a frac) 255 | (* b (- 1.0 frac)))) 256 | cols))))) 257 | 258 | (defvar-local outli-font-lock-keywords nil) 259 | 260 | (defun outli--face-name (mode depth &optional repeat) 261 | "Return the face symbol for MODE, DEPTH, and REPEAT." 262 | (let ((mode-string (if (eq mode t) "" (concat (symbol-name mode) "-")))) 263 | (intern (format "outli-%s-%s%d" (if repeat "repeat" "stem") mode-string depth)))) 264 | 265 | (defun outli-handle-theme-change (_theme) 266 | "Reset all faces on theme change." 267 | (outli-reset-all-faces)) 268 | 269 | (defun outli-reset-all-faces () 270 | "Reset all faces defined by outli. 271 | Useful for calling after theme changes." 272 | (interactive) 273 | (cl-loop for (mode stem _ style nobar) in outli-heading-config 274 | if stem do (outli--setup-faces style nobar mode))) 275 | 276 | (defvar outli--max-outline-depth nil) 277 | 278 | (defun outli--setup-faces (style nobar mode) 279 | "Setup outli faces based on the outline faces. 280 | STYLE, NOBAR, and MODE are as in `outli-fontify-headlines'." 281 | (let ((style (or style outli-default-style)) 282 | (nobar (or nobar outli-default-nobar))) 283 | (cl-loop 284 | for i downfrom outli-maximum-depth to 1 285 | with ot = (unless nobar '(:overline t)) 286 | for ol-face = (intern-soft 287 | (format "outline-%d" (1+ (mod (1- i) outli--max-outline-depth)))) 288 | for otl-stem-face = (outli--face-name mode i) 289 | for fg = (face-attribute ol-face :foreground nil t) 290 | for blend = (and outli-blend (outli-fontify-background-blend fg)) 291 | for ofg = (unless nobar `(:overline ,fg)) 292 | do 293 | (face-spec-set otl-stem-face 294 | (if blend 295 | `((t (:background ,blend ,@ofg))) 296 | `((t ,@(and ofg `(,ofg)))))) 297 | (unless style 298 | (face-spec-set 299 | (outli--face-name mode i 'repeat) 300 | `((t (:inherit ,ol-face 301 | ,@(and blend `(:background ,blend)) ,@ot)))))))) 302 | 303 | (defun outli-fontify-headlines (style nobar mode) 304 | "Calculate and enable font-lock regexps to match headings. 305 | If STYLE is non-nil, do not style the stem and depth characters 306 | differently. If it is the symbol `none', omit all styling. If NOBAR is 307 | non-nil, omit the overlines. MODE is the symbol for the mode which this 308 | styling applies to, or t for the default. If STYLE and NOBAR are nil, 309 | their values will be set using the variables `outli-default-style' and 310 | `outli-default-nobar'." 311 | (let ((style (or style outli-default-style)) 312 | (nobar (or nobar outli-default-nobar))) 313 | (outli--setup-faces style nobar mode) 314 | (unless (eq style 'none) 315 | (font-lock-add-keywords 316 | nil 317 | (setq 318 | outli-font-lock-keywords 319 | (cl-loop for i downfrom outli-maximum-depth to 1 320 | for ol-face = (intern-soft 321 | (format "outline-%d" 322 | (1+ (mod (1- i) outli--max-outline-depth)))) 323 | for hrx = (rx-to-string 324 | `(and 325 | bol ,@(if outli-allow-indented-headlines '((* space))) 326 | (group (group (literal ,outli-heading-stem)) ; 1=2+3 2 = stem 327 | (group (= ,i ,outli-heading-char))) ; 3 = repeat 328 | (group ?\s (* nonl) (or ?\n eol))) ; 4 = rest of headline 329 | t) 330 | for header-highlight = 331 | `(4 '(:inherit ,ol-face :extend t 332 | ,@(unless nobar '(:overline t))) 333 | t) 334 | for stem-highlight = 335 | (if (or style (not outli-blend)) 336 | `((1 ',(outli--face-name mode i) append)) ; all same 337 | `((2 ',(outli--face-name mode i) append) 338 | (3 ',(outli--face-name mode i 'repeat) t))) 339 | collect `(,hrx ,header-highlight ,@stem-highlight)))) 340 | (mapc (lambda (x) (cl-pushnew x font-lock-extra-managed-props)) 341 | `(extend overline ,@(if outli-blend '(background)))) 342 | (font-lock-flush)))) 343 | 344 | (defun outli-unfontify () 345 | "Remove existing fontification." 346 | (font-lock-remove-keywords nil outli-font-lock-keywords) 347 | (setq outli-font-lock-keywords nil) 348 | (font-lock-flush)) 349 | 350 | ;;;; Key Bindings 351 | (defun outli--print-speed-command (speed-command) 352 | "Print information about SPEED-COMMAND in help buffer. 353 | Based on `org--print-speed-command'." 354 | (if (> (length (car speed-command)) 1) 355 | (progn 356 | (princ "\n") 357 | (princ (car speed-command)) 358 | (princ "\n") 359 | (princ (make-string (length (car speed-command)) ?-)) 360 | (princ "\n")) 361 | (princ (car speed-command)) 362 | (princ " ") 363 | (if (symbolp (cdr speed-command)) 364 | (princ (symbol-name (cdr speed-command))) 365 | (prin1 (cdr speed-command))) 366 | (princ "\n"))) 367 | 368 | (defun outli-speed-command-help () 369 | "Show the available speed commands." 370 | (interactive) 371 | (with-output-to-temp-buffer "*Help*" 372 | (princ "Speed commands\n==============\n") 373 | (mapc #'outli--print-speed-command outli-speed-commands)) 374 | (with-current-buffer "*Help*" 375 | (setq truncate-lines t))) 376 | 377 | (defvar outli-mode-map 378 | (let ((map (make-sparse-keymap))) 379 | ;; Tab: cycle, if on heading 380 | (define-key map (kbd "") 381 | `(menu-item "" outline-cycle :filter outli--on-heading)) 382 | (define-key map (kbd "TAB") ; for terminal emacs 383 | `(menu-item "" outline-cycle :filter outli--on-heading)) 384 | ;; Shift-Tab: cycle buffer 385 | (define-key map (kbd "S-") #'outline-cycle-buffer) 386 | (define-key map (kbd "") #'outline-cycle-buffer) ; sometimes S-Tab=backtab 387 | map)) 388 | 389 | ;;;; Outli mode 390 | ;;;###autoload 391 | (define-minor-mode outli-mode 392 | "Simple outline mode interaction based on comment-headings." 393 | :keymap outli-mode-map 394 | (if outli-mode 395 | (let ((config (seq-find 396 | (lambda (e) (derived-mode-p (car e))) 397 | outli-heading-config))) 398 | (setq outli--max-outline-depth 399 | (cl-loop for i downfrom outli-maximum-depth to 1 400 | for ol-face = (intern-soft (format "outline-%d" i)) 401 | if (facep ol-face) return i)) 402 | (if (and config (eq (cdr config) nil)) 403 | (setq outli-mode nil) ; Mode explicitly disabled 404 | ;; Speed keys 405 | (cl-loop for (key . com) in outli-speed-commands do 406 | (when-let ((func 407 | (cond 408 | ((functionp com) com) 409 | ((consp com) (eval `(lambda () (interactive) ,com)))))) 410 | (define-key outli-mode-map (kbd key) 411 | `(menu-item "" ,func :filter outli--at-heading)))) 412 | (add-hook 'enable-theme-functions #'outli-handle-theme-change) 413 | ;; Setup the heading matchers 414 | (pcase-let ((`(,mode ,stem ,rchar ,style ,nobar) 415 | (or config 416 | (assq t outli-heading-config) 417 | '(t nil nil nil)))) 418 | (setq outli-heading-char 419 | (or (if (consp rchar) (eval rchar) (if (characterp rchar) rchar)) ?*) 420 | outli-heading-stem 421 | (or (and (consp stem) (eval stem)) (and (stringp stem) stem) "# ")) 422 | (setq-local 423 | outline-level #'outli-indent-level 424 | outline-regexp (outli-heading-regexp) 425 | outline-heading-end-regexp "\n" 426 | outline-search-function nil) 427 | ;; pre-seed the level alist for efficiency 428 | (cl-loop for level downfrom outli-maximum-depth to 1 do 429 | (push (cons (concat outli-heading-stem 430 | (make-string level outli-heading-char) " ") 431 | level) 432 | outline-heading-alist)) 433 | (cl-pushnew `("Headings" ,(rx bol (regexp outline-regexp) (group-n 2 (* nonl) eol)) 2) 434 | imenu-generic-expression) 435 | (outli-fontify-headlines style nobar mode)) 436 | (outline-minor-mode 1))) 437 | (outline-minor-mode -1) 438 | (outli-unfontify))) 439 | 440 | ;;;; Footer 441 | (provide 'outli) 442 | 443 | ;;; outli.el ends here 444 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------