├── .gitignore ├── .elpaignore ├── doc └── demo.gif ├── Makefile ├── .github └── workflows │ ├── melpazoid.yml │ └── test.yml ├── engine-mode-test.el ├── engine-mode.el ├── README.org └── LICENSE.md /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | -------------------------------------------------------------------------------- /.elpaignore: -------------------------------------------------------------------------------- 1 | LICENSE.md 2 | -------------------------------------------------------------------------------- /doc/demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hrs/engine-mode/HEAD/doc/demo.gif -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: test 2 | test: engine-mode.el engine-mode-test.el 3 | emacs --quick --batch \ 4 | -f package-initialize \ 5 | --eval "(add-to-list 'package-archives '(\"nongnu\" . \"https://elpa.nongnu.org/nongnu/\") t)" \ 6 | --eval "(when (not (package-installed-p 'buttercup)) (package-refresh-contents) (package-install 'buttercup))" \ 7 | -L . \ 8 | -f buttercup-run-discover 9 | -------------------------------------------------------------------------------- /.github/workflows/melpazoid.yml: -------------------------------------------------------------------------------- 1 | # melpazoid build checks. 2 | 3 | name: Melpazoid 4 | on: pull_request 5 | 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v3 12 | with: 13 | fetch-depth: 0 14 | persist-credentials: false 15 | 16 | - name: Install Emacs 17 | uses: purcell/setup-emacs@master 18 | with: 19 | version: snapshot 20 | 21 | - name: Install Python 22 | uses: actions/setup-python@v1 23 | with: 24 | python-version: 3.9 25 | 26 | - name: Install Melpazoid 27 | run: | 28 | python -m pip install --upgrade pip 29 | git clone https://github.com/riscy/melpazoid.git ~/melpazoid 30 | pip install ~/melpazoid 31 | 32 | - name: Run 33 | env: 34 | LOCAL_REPO: ${{ github.workspace }} 35 | RECIPE: (engine-mode :repo "hrs/engine-mode" :fetcher github) 36 | run: echo $GITHUB_REF && make -C ~/melpazoid 37 | continue-on-error: true 38 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Tests 2 | on: 3 | pull_request: 4 | push: 5 | branches: 6 | - main 7 | permissions: {} 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | emacs_version: 15 | - 24.4 16 | - 24.5 17 | - 25.1 18 | - 25.3 19 | - 26.1 20 | - 26.2 21 | - 26.3 22 | - 27.1 23 | - 27.2 24 | - 28.1 25 | - 28.2 26 | - snapshot 27 | include: 28 | - emacs_version: 'snapshot' 29 | allow_failure: true 30 | 31 | steps: 32 | - uses: actions/checkout@v3 33 | with: 34 | persist-credentials: false 35 | 36 | - name: Install Emacs 37 | uses: purcell/setup-emacs@master 38 | with: 39 | version: ${{ matrix.emacs_version }} 40 | 41 | - name: Run tests 42 | if: matrix.allow_failure != true 43 | run: 'make test' 44 | 45 | - name: Run tests (allow failure) 46 | if: matrix.allow_failure == true 47 | run: 'make test || true' 48 | -------------------------------------------------------------------------------- /engine-mode-test.el: -------------------------------------------------------------------------------- 1 | ;;; engine-mode-test.el --- tests for engine-mode.el -*- lexical-binding: t; -*- 2 | 3 | ;;; Commentary: 4 | 5 | ;; Tests for engine-mode. 6 | 7 | ;;; Code: 8 | 9 | (require 'buttercup) 10 | (load-file "engine-mode.el") 11 | 12 | (describe "engine--search-prompt" 13 | (it "includes the default term in the prompt" 14 | (expect (engine--search-prompt "wikipedia" "the-thing-at-point") 15 | :to-equal 16 | "Search Wikipedia (the-thing-at-point): ")) 17 | 18 | (it "doesn't include the default term if it's empty" 19 | (expect (engine--search-prompt "wikipedia" "") 20 | :to-equal 21 | "Search Wikipedia: "))) 22 | 23 | (describe "engine--prompted-search-term" 24 | (it "reads a string from the user" 25 | (spy-on 'read-string :and-return-value "spy term") 26 | (spy-on 'thing-at-point :and-return-value nil) 27 | 28 | (expect (engine--prompted-search-term "wikipedia") 29 | :to-equal "spy term") 30 | (expect 'read-string :to-have-been-called-with 31 | (engine--search-prompt "wikipedia" "") nil nil "")) 32 | 33 | (it "defaults the term to the thing-at-point, if there is one" 34 | (spy-on 'read-string :and-return-value "spy term") 35 | (with-temp-buffer 36 | (insert "foo") 37 | (goto-char 1) 38 | (expect (engine--prompted-search-term "wikipedia") 39 | :to-equal "spy term")) 40 | 41 | (expect 'read-string :to-have-been-called-with 42 | (engine--search-prompt "wikipedia" "foo") nil nil "foo"))) 43 | 44 | (describe "engine--get-query" 45 | (it "returns a region, if one's active" 46 | (expect (with-temp-buffer 47 | (transient-mark-mode) 48 | 49 | (insert "lorem ipsum") 50 | (goto-char 3) 51 | (push-mark-command (point) t) 52 | (goto-char 10) 53 | 54 | (engine--get-query "wikipedia")) 55 | :to-equal "rem ips")) 56 | 57 | (it "delegates to engine--prompted-search-term if there's no active region" 58 | (spy-on 'read-string :and-return-value "spy term") 59 | (expect (engine--get-query "wikipedia") 60 | :to-equal 61 | (engine--prompted-search-term "wikipedia")))) 62 | 63 | (describe "engine--execute-search" 64 | (it "encodes the search term, interpolates it into the URL, and browses it" 65 | (expect (engine--execute-search 66 | "https://www.wikipedia.org/search-redirect.php?search=%s" 67 | (lambda (url &rest _) (cons 'browsed url)) 68 | "foo bar") 69 | :to-equal 70 | '(browsed . "https://www.wikipedia.org/search-redirect.php?search=foo%20bar")))) 71 | 72 | (describe "engine--function-name" 73 | (it "returns the function name created by the engine with this name" 74 | (expect (engine--function-name 'wikipedia) 75 | :to-equal 76 | 'engine/search-wikipedia)) 77 | 78 | (it "downcases the engine name" 79 | (expect (engine--function-name 'GitHub) 80 | :to-equal 81 | 'engine/search-github))) 82 | 83 | (describe "engine--docstring" 84 | (it "returns a default docstring with the engine name interpolated" 85 | (expect (engine--docstring 'my-engine) 86 | :to-equal 87 | "Search My-Engine for the selected text.\nPrompt for input if none is selected."))) 88 | 89 | (defun expect-binding (function-name desc) 90 | "Test that FUNCTION-NAME has keybinding DESC." 91 | (expect (member desc 92 | (mapcar #'key-description (where-is-internal function-name engine-mode-map))) 93 | :not :to-be nil)) 94 | 95 | (describe "defengine" 96 | (describe ":keybinding" 97 | (before-each 98 | ;; Restore keymaps to their default values 99 | (setq engine-mode-prefixed-map (make-sparse-keymap)) 100 | (setq engine-mode-map 101 | (let ((map (make-sparse-keymap))) 102 | (define-key map (kbd engine/keybinding-prefix) engine-mode-prefixed-map) 103 | map))) 104 | 105 | (it "binds a key with the default prefix" 106 | (defengine wikipedia "" :keybinding "w") 107 | 108 | (expect-binding 'engine/search-wikipedia "C-x / w")) 109 | 110 | (it "binds a key with a custom prefix" 111 | (engine/set-keymap-prefix (kbd "C-c s")) 112 | 113 | (defengine wikipedia "" :keybinding "w") 114 | 115 | (expect-binding 'engine/search-wikipedia "C-c s w")) 116 | 117 | (it "binds sequential keys with the default prefix" 118 | (defengine wikipedia "" :keybinding "w o w") 119 | 120 | (expect-binding 'engine/search-wikipedia "C-x / w o w")) 121 | 122 | (it "binds sequential keys with a custom prefix" 123 | (engine/set-keymap-prefix (kbd "C-c s")) 124 | 125 | (defengine wikipedia "" :keybinding "w o w") 126 | 127 | (expect-binding 'engine/search-wikipedia "C-c s w o w")) 128 | 129 | (it "rebinds the keymap even after engines are defined" 130 | (defengine wikipedia "" :keybinding "w") 131 | 132 | (engine/set-keymap-prefix (kbd "C-c s")) 133 | 134 | (expect-binding 'engine/search-wikipedia "C-c s w"))) 135 | 136 | (describe ":term-transformation-hook" 137 | (it "applies the hook to search terms" 138 | (defengine wikipedia 139 | "https://www.wikipedia.org/search-redirect.php?search=%s" 140 | :term-transformation-hook upcase) 141 | 142 | (let ((engine/browser-function (lambda (url &rest _) url))) 143 | (expect (engine/search-wikipedia "foo bar") 144 | :to-equal 145 | "https://www.wikipedia.org/search-redirect.php?search=FOO%20BAR"))))) 146 | 147 | ;;; engine-mode-test.el ends here 148 | -------------------------------------------------------------------------------- /engine-mode.el: -------------------------------------------------------------------------------- 1 | ;;; engine-mode.el --- Define and query search engines 2 | 3 | ;; Author: Robin Schwartz 4 | ;; Maintainer: Robin Schwartz 5 | ;; Version: 2.2.4 6 | ;; URL: https://github.com/hrs/engine-mode 7 | ;; Package-Requires: ((emacs "24.4")) 8 | 9 | ;; This file is NOT part of GNU Emacs. 10 | 11 | ;; This program is free software: you can redistribute it and/or modify it under 12 | ;; the terms of the GNU General Public License as published by the Free Software 13 | ;; Foundation, either version 3 of the License, or (at your option) any later 14 | ;; version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, but WITHOUT 17 | ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 18 | ;; FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 19 | ;; details. 20 | 21 | ;; You should have received a copy of the GNU General Public License along with 22 | ;; this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; `engine-mode' is a global minor mode for Emacs. It enables you to easily 27 | ;; define search engines, bind them to keybindings, and query them from the 28 | ;; comfort of your editor. 29 | 30 | ;; For example, suppose we want to be able to easily search GitHub: 31 | 32 | ;; (defengine github 33 | ;; "https://github.com/search?ref=simplesearch&q=%s") 34 | 35 | ;; This defines an interactive function `engine/search-github'. When executed it 36 | ;; will take the selected region (or prompt for input, if no region is selected) 37 | ;; and search GitHub for it, displaying the results in your default browser. 38 | 39 | ;; The `defengine' macro can also take an optional key combination, 40 | ;; prefixed with "C-x /": 41 | 42 | ;; (defengine duckduckgo 43 | ;; "https://duckduckgo.com/?q=%s" 44 | ;; :keybinding "d") 45 | 46 | ;; `C-x / d' is now bound to the new function 47 | ;; engine/search-duckduckgo'! Nifty. 48 | 49 | ;;; Code: 50 | (eval-when-compile (require 'cl-lib)) 51 | (require 'format-spec) 52 | 53 | (defgroup engine nil 54 | "Define search engines, bind them to keybindings, and query them." 55 | :group 'external) 56 | 57 | (defcustom engine/keybinding-prefix "C-x /" 58 | "The default `engine-mode' keybindings prefix." 59 | :group 'engine 60 | :type '(choice (string :tag "Key") 61 | (const :tag "No keybinding" nil))) 62 | 63 | (define-prefix-command 'engine-mode-prefixed-map) 64 | (defvar engine-mode-prefixed-map) 65 | 66 | (defvar engine-mode-map 67 | (let ((map (make-sparse-keymap))) 68 | (define-key map (kbd engine/keybinding-prefix) engine-mode-prefixed-map) 69 | map) 70 | "Keymap for `engine-mode'.") 71 | 72 | ;;;###autoload 73 | (define-minor-mode engine-mode 74 | "Minor mode for defining and querying search engines through Emacs. 75 | 76 | \\{engine-mode-map}" 77 | :global t 78 | :keymap engine-mode-map) 79 | 80 | (defun engine/set-keymap-prefix (prefix-key) 81 | "Bind the engine-mode keymap to PREFIX-KEY. 82 | For example, to use \"C-c s\" instead of the default \"C-x /\": 83 | 84 | \(engine/set-keymap-prefix (kbd \"C-c s\"))" 85 | (when engine/keybinding-prefix 86 | (define-key engine-mode-map (kbd engine/keybinding-prefix) nil)) 87 | (define-key engine-mode-map prefix-key engine-mode-prefixed-map)) 88 | 89 | (defcustom engine/browser-function browse-url-browser-function 90 | "The default browser function used when opening a URL in an engine. 91 | Defaults to `browse-url-browser-function'." 92 | :group 'engine 93 | :type 'symbol) 94 | 95 | (defun engine--search-prompt (engine-name default-word) 96 | "Return a search prompt for ENGINE-NAME, defaulting to DEFAULT-WORD." 97 | (if (string= default-word "") 98 | (format "Search %s: " (capitalize engine-name)) 99 | (format "Search %s (%s): " (capitalize engine-name) default-word))) 100 | 101 | (defun engine--prompted-search-term (engine-name) 102 | "Prompt the user for a search term for ENGINE-NAME. 103 | Default to the symbol at point." 104 | (let ((current-word (or (thing-at-point 'symbol 'no-properties) ""))) 105 | (read-string (engine--search-prompt engine-name current-word) 106 | nil nil current-word))) 107 | 108 | (defun engine--get-query (engine-name) 109 | "Return the selected region or prompt the user for a query for ENGINE-NAME." 110 | (if (use-region-p) 111 | (buffer-substring (region-beginning) (region-end)) 112 | (engine--prompted-search-term engine-name))) 113 | 114 | (defun engine--execute-search (search-engine-url browser-function search-term) 115 | "Search SEARCH-ENGINE-URL for SEARCH-TERM. 116 | Display the resulting URL with BROWSER-FUNCTION." 117 | (interactive) 118 | (let ((browse-url-browser-function browser-function)) 119 | (browse-url 120 | (format-spec search-engine-url 121 | (format-spec-make ?s (url-hexify-string search-term)))))) 122 | 123 | (defun engine--function-name (engine-name) 124 | "Return the name of the function for ENGINE-NAME. 125 | 126 | For example, if ENGINE-NAME is the symbol `github', return 127 | `engine/search-github'." 128 | (intern (concat "engine/search-" (downcase (symbol-name engine-name))))) 129 | 130 | (defun engine--docstring (engine-name) 131 | "Construct and return a default docstring for ENGINE-NAME." 132 | (format "Search %s for the selected text.\nPrompt for input if none is selected." 133 | (capitalize (symbol-name engine-name)))) 134 | 135 | (defun engine--bind-key (engine-name keybinding) 136 | "Bind KEYBINDING to ENGINE-NAME in the `engine-mode-prefixed-map'. 137 | 138 | Do nothing if KEYBINDING is nil. 139 | 140 | Use `keymap-set' instead of `define-key' if it's available, since 141 | it permits multiple keys in KEYBINDING." 142 | (when keybinding 143 | (if (fboundp 'keymap-set) 144 | `(keymap-set engine-mode-prefixed-map ,keybinding 145 | (quote ,(engine--function-name engine-name))) 146 | `(define-key engine-mode-prefixed-map (kbd ,keybinding) 147 | (quote ,(engine--function-name engine-name)))))) 148 | 149 | ;;;###autoload 150 | (cl-defmacro defengine (engine-name search-engine-url 151 | &key keybinding docstring 152 | (browser 'engine/browser-function) 153 | (term-transformation-hook 'identity)) 154 | "Define a custom engine ENGINE-NAME searching SEARCH-ENGINE-URL. 155 | 156 | ENGINE-NAME is a symbol naming the engine. 157 | 158 | SEARCH-ENGINE-URL is the url to be queried, with a \"%s\" 159 | standing in for the search term. 160 | 161 | The optional keyword argument DOCSTRING assigns a docstring to 162 | the generated function. A reasonably sensible docstring will be 163 | generated if a custom one isn't provided. 164 | 165 | The optional keyword argument BROWSER assigns the browser 166 | function to be used when opening the URL. 167 | 168 | The optional keyword argument TERM-TRANSFORMATION-HOOK is a 169 | function that will be applied to the search term before it's 170 | substituted into SEARCH-ENGINE-URL. For example, if we wanted to 171 | always upcase our search terms, we might use: 172 | 173 | \(defengine duckduckgo 174 | \"https://duckduckgo.com/?q=%s\" 175 | :term-transformation-hook upcase) 176 | 177 | In this case, searching for \"foobar\" will hit the url 178 | \"https://duckduckgo.com/?q=FOOBAR\". 179 | 180 | The optional keyword argument KEYBINDING is a string describing 181 | the key to bind the new function. 182 | 183 | Keybindings are in `engine-mode-map', so they're prefixed. 184 | 185 | For example, to search Wikipedia, use: 186 | 187 | (defengine wikipedia 188 | \"https://www.wikipedia.org/search-redirect.php?search=%s\" 189 | :keybinding \"w\" 190 | :docstring \"Search Wikipedia!\") 191 | 192 | Hitting \"C-x / w\" will be bound to the newly-defined 193 | `engine/search-wikipedia' function." 194 | (declare (indent 1)) 195 | (cl-assert (symbolp engine-name)) 196 | `(prog1 197 | (defun ,(engine--function-name engine-name) (search-term) 198 | ,(or docstring (engine--docstring engine-name)) 199 | (interactive 200 | (list (engine--get-query ,(symbol-name engine-name)))) 201 | (engine--execute-search ,search-engine-url ,browser (,term-transformation-hook search-term))) 202 | ,(engine--bind-key engine-name keybinding))) 203 | 204 | (provide 'engine-mode) 205 | ;;; engine-mode.el ends here 206 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+title: =engine-mode= 2 | #+options: toc:nil num:nil 3 | 4 | [[https://melpa.org/#/engine-mode][https://melpa.org/packages/engine-mode-badge.svg]] 5 | [[https://stable.melpa.org/#/engine-mode][https://stable.melpa.org/packages/engine-mode-badge.svg]] 6 | [[https://www.gnu.org/licenses/gpl-3.0][https://img.shields.io/badge/License-GPL%20v3-blue.svg]] 7 | [[https://github.com/hrs/engine-mode/actions/workflows/test.yml][https://github.com/hrs/engine-mode/actions/workflows/test.yml/badge.svg?branch=main]] 8 | 9 | ~engine-mode~ is a global minor mode for Emacs. It enables you to easily define 10 | search engines, bind them to keybindings, and query them from the comfort of 11 | your editor. 12 | 13 | #+ATTR_HTML: :alt Demo searching for a term, with the results opening in a browser window. 14 | #+ATTR_HTML: :width 100% 15 | [[file:./doc/demo.gif]] 16 | 17 | For example, suppose we want to be able to easily search GitHub: 18 | 19 | #+begin_src emacs-lisp 20 | (defengine github 21 | "https://github.com/search?ref=simplesearch&q=%s") 22 | #+end_src 23 | 24 | This defines an interactive function ~engine/search-github~. When executed it will 25 | take the selected region (or prompt for input, if no region is selected) and 26 | search GitHub for it, displaying the results in your default browser. 27 | 28 | The ~defengine~ macro can also take an optional key combination, prefixed with 29 | ~engine/keymap-prefix~ (which defaults to =C-x /=). That keybinding will be wrapped 30 | in a call to ~kbd~. 31 | 32 | #+begin_src emacs-lisp 33 | (defengine duckduckgo 34 | "https://duckduckgo.com/?q=%s" 35 | :keybinding "d") 36 | #+end_src 37 | 38 | =C-x / d= is now bound to the new function ~engine/search-duckduckgo~! Nifty. 39 | 40 | If you'd like to see a video on the whys and wherefores of this mode, check out 41 | [[https://www.youtube.com/watch?v=MBhJBMYfWUo][the talk @hrs gave at EmacsNYC]]. 42 | 43 | ** Installation 44 | 45 | ~engine-mode~ is available on MELPA. 46 | 47 | Using ~use-package~: 48 | 49 | #+begin_src emacs-lisp 50 | (use-package engine-mode 51 | :ensure t 52 | 53 | :config 54 | (engine-mode t)) 55 | #+end_src 56 | 57 | You can also install it like any other elisp file by adding it to your load path 58 | and globally enabling it: 59 | 60 | #+begin_src emacs-lisp 61 | (require 'engine-mode) 62 | (engine-mode t) 63 | #+end_src 64 | 65 | ** Changing your default browser 66 | 67 | ~engine-mode~ uses the ~engine/browser-function~ variable to determine which browser 68 | it should use to open the URL it constructs. To change the default browser, 69 | redefine ~engine/browser-function~. For example, to always use Emacs' built-in ~eww~ 70 | browser: 71 | 72 | #+begin_src emacs-lisp 73 | (setq engine/browser-function 'eww-browse-url) 74 | #+end_src 75 | 76 | ~engine/browser-function~ defaults to ~browse-url-browser-function~, which Emacs 77 | uses globally to open links. 78 | 79 | The implementation of the ~browse-url-browser-function~ variable contains a 80 | comprehensive list of possible browser functions. You can get to that by hitting 81 | =C-h v browse-url-browser-function = and following the link to 82 | =browse-url.el=. 83 | 84 | ** Changing your browser on a per-engine basis 85 | 86 | To only change the browser for a single engine, use the ~:browser~ keyword 87 | argument when you define the engine. For example, to use ~eww~ only for your 88 | GitHub search results, try: 89 | 90 | #+begin_src emacs-lisp 91 | (defengine github 92 | "https://github.com/search?ref=simplesearch&q=%s" 93 | :browser 'eww-browse-url) 94 | #+end_src 95 | 96 | As mentioned about, see the implementation of the ~browse-url-browser-function~ 97 | for a definitive list of browsers. 98 | 99 | ** Changing the keymap prefix 100 | 101 | The default keymap prefix for ~engine-mode~ is =C-x /=. If you'd like to bind 102 | the keymap to an additional prefix (say, =C-c s=), you totally can: 103 | 104 | #+begin_src emacs-lisp 105 | (engine/set-keymap-prefix (kbd "C-c s")) 106 | #+end_src 107 | 108 | If you use ~use-package~, you can achieve the same thing with: 109 | 110 | #+begin_src emacs-lisp 111 | :bind-keymap ("C-c s" . engine-mode-prefixed-map) 112 | #+end_src 113 | 114 | ** Custom docstrings 115 | 116 | ~defengine~ assigns each engine a reasonable default docstring, but you can 117 | override that on a case-by-case basis with the ~:docstring~ keyword argument: 118 | 119 | #+begin_src emacs-lisp 120 | (defengine ctan 121 | "https://www.ctan.org/search/?x=1&PORTAL=on&phrase=%s" 122 | :docstring "Search the Comprehensive TeX Archive Network (ctan.org)") 123 | #+end_src 124 | 125 | ** Modifying the search term before sending it 126 | 127 | An engine might want to transform a search term in some way before it 128 | interpolates the term into the URL. Maybe the term should have a different 129 | encoding, or be capitalized differently, or, uh, be passed through [[https://en.wikipedia.org/wiki/ROT13][ROT13]]. 130 | Whatever the reason, you can apply a custom transformation to a search term by 131 | passing a function to ~defengine~ through the ~:term-transformation-hook~ keyword 132 | argument. 133 | 134 | For example, to UPCASE all of your DuckDuckGo searches: 135 | 136 | #+begin_src emacs-lisp 137 | (defengine duckduckgo 138 | "https://duckduckgo.com/?q=%s" 139 | :term-transformation-hook upcase) 140 | #+end_src 141 | 142 | Or, to ensure that all your queries are encoded as latin-1: 143 | 144 | #+begin_src emacs-lisp 145 | (defengine diec2 146 | "dlc.iec.cat/results.asp?txtEntrada=%s" 147 | :term-transformation-hook (lambda (term) (encode-coding-string term latin-1)) 148 | :keybinding "c") 149 | #+end_src 150 | 151 | You could also use a ~:term-transformation-hook~ to make an engine behave 152 | differently when given a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Prefix-Command-Arguments.html][prefix argument]] (i.e. typing =C-u= before invoking the 153 | engine). 154 | 155 | Some search engines support querying for exact phrases by enclosing the search 156 | string with double quotes. Transformations could be useful in this case to 157 | perform a literal search instead if the universal argument is present: 158 | 159 | #+begin_src emacs-lisp 160 | (defengine duckduckgo 161 | "https://duckduckgo.com/?q=%s" 162 | :term-transformation-hook (lambda (term) (if current-prefix-arg 163 | (concat "\"" term "\"") 164 | term)) 165 | :keybinding "d") 166 | #+end_src 167 | 168 | Typing =C-x / d= will perform a regular search, but typing =C-u C-x / d= will 169 | wrap your query in quotes before searching for it. That's especially useful when 170 | searching for the contents of the region. 171 | 172 | ** Importing keyword searches from other browsers 173 | 174 | Since many browsers save keyword searches using the same format as engine-mode 175 | (that is, by using ~%s~ in a url to indicate a search term), it's not too hard to 176 | import them into Emacs. 177 | 178 | [[https://github.com/sshaw][@sshaw]] has written a script to [[https://gist.github.com/sshaw/9b635eabde582ebec442][import from Chrome on OS X]]. Thanks for that! 179 | 180 | ** Comparison with =webjump= 181 | 182 | Emacs has a perfectly lovely built-in =webjump= package which allows the user to 183 | define a set of URLs, interpolate search terms into them, and visit them in the 184 | browser. 185 | 186 | Why might you use =engine-mode= instead of =webjump=? 187 | 188 | - You want to bind specific searches to keybindings. Because =engine-mode= defines 189 | a function for each engine, keybindings in =engine-mode= can be associated 190 | directly with specific searches. 191 | - You'd like to associate browser functions with engines on a case-by-case 192 | basis. For example, if you want to perform some searches in Firefox, and other 193 | searches in =eww=, that's trivial in =engine-mode=. 194 | - You like some of =engine-mode='s minor UI conveniences. If you've got a region 195 | selected, for example, =engine-mode= will use that as the search query, while 196 | =webjump= will ignore it and offer an empty prompt. 197 | 198 | If you're not interested in these features, =webjump= is a great choice! Honestly, 199 | the author of =engine-mode= probably wouldn't have bothered writing it if they'd 200 | known =webjump= existed at the time. :sweat_smile: 201 | 202 | ** Engine examples 203 | 204 | #+begin_src emacs-lisp 205 | (defengine amazon 206 | "https://www.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=%s") 207 | 208 | (defengine duckduckgo 209 | "https://duckduckgo.com/?q=%s" 210 | :keybinding "d") 211 | 212 | (defengine github 213 | "https://github.com/search?ref=simplesearch&q=%s") 214 | 215 | (defengine google 216 | "https://www.google.com/search?ie=utf-8&oe=utf-8&q=%s" 217 | :keybinding "g") 218 | 219 | (defengine google-images 220 | "https://www.google.com/images?hl=en&source=hp&biw=1440&bih=795&gbv=2&aq=f&aqi=&aql=&oq=&q=%s") 221 | 222 | (defengine google-maps 223 | "https://maps.google.com/maps?q=%s" 224 | :docstring "Mappin' it up.") 225 | 226 | (defengine project-gutenberg 227 | "https://www.gutenberg.org/ebooks/search/?query=%s") 228 | 229 | (defengine qwant 230 | "https://www.qwant.com/?q=%s") 231 | 232 | (defengine stack-overflow 233 | "https://stackoverflow.com/search?q=%s") 234 | 235 | (defengine twitter 236 | "https://twitter.com/search?q=%s") 237 | 238 | (defengine wikipedia 239 | "https://www.wikipedia.org/search-redirect.php?language=en&go=Go&search=%s" 240 | :keybinding "w" 241 | :docstring "Searchin' the wikis.") 242 | 243 | (defengine wiktionary 244 | "https://www.wikipedia.org/search-redirect.php?family=wiktionary&language=en&go=Go&search=%s") 245 | 246 | (defengine wolfram-alpha 247 | "https://www.wolframalpha.com/input/?i=%s") 248 | 249 | (defengine youtube 250 | "https://www.youtube.com/results?aq=f&oq=&search_query=%s") 251 | #+end_src 252 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------