├── .gitignore ├── README.md ├── tramp-hlo-tests.el ├── tramp-hlo.el └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled 2 | *.elc 3 | 4 | # Packaging 5 | .cask/ 6 | .eask/ 7 | .eldev/ 8 | .keg/ 9 | 10 | # Built distribution 11 | dist/ 12 | 13 | # Backup files 14 | *~ 15 | 16 | # Undo-tree save-files 17 | *.~undo-tree 18 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tramp-hlo 2 | Higher level emacs functions as optimized tramp operations 3 | 4 | Normally a tramp handler only contains implementations of the emacs 5 | primitive file operations. Implementing this set of operations allows 6 | emacs to do anything on a remote host, but many of the common 7 | functions in the emacs standard library will trigger multiple file 8 | operations for a single call. This can cause performance issues, 9 | because each file operation involves a roundtrip to the remote host. 10 | 11 | This module implements some of those operations as single round trip 12 | tramp operations. The bulk of the operation is implemented as a server 13 | side bash script, rather than an elisp function. In practice this 14 | makes a lot of day to day editing on remote hosts much more responsive. 15 | 16 | # Installation 17 | 18 | Install from GNU ELPA: 19 | 20 | ## package.el 21 | 22 | ``` 23 | M-x package-install tramp-hlo 24 | M-x tramp-hlo-setup 25 | ``` 26 | 27 | ## use-package 28 | ``` 29 | (use-package tramp-hlo 30 | :ensure t 31 | :config 32 | (tramp-hlo-setup) 33 | ) 34 | ``` 35 | 36 | # Configuration 37 | 38 | * Enable: `M-x tramp-hlo-setup` or add `(tramp-hlo-setup)` to 39 | `init.el`. 40 | * Disable: `M-x tramp-hlo-remove` or add `(tramp-hlo-remove)` to `init.el` 41 | 42 | # Targeted operations 43 | 44 | A first set of operations were targetted that perform poorly over 45 | tramp due to roundtrips, andhave a large impact on day to day use, 46 | 47 | ## `locate-dominating-file` 48 | 49 | The emacs builtin function `locate-dominating-file` doesn't have a 50 | tramp specific implementation, relying on regular directory traversal 51 | and test functions. This can result in 10s of round-trips per-call, 52 | depending on the depth of the path searched and the dominating file 53 | name searched for. Rewriting this as a server-side script reduces this 54 | to a single round-trip. This greatly speeds up packages like `vc` 55 | which repeatedly look for repository root files. 56 | 57 | ## `dir-locals` 58 | 59 | The function `dir-locals-find-file` not only makes use of 60 | `locate-dominating-file`, but uses it with a predicate that performs 61 | tramp operations of its own. Encapsulating the logic to use one large 62 | server side script also reduces 10s of round-trips to just two. 63 | 64 | # Testing 65 | 66 | A suite of tests is included using ERT, in addition to using it in my 67 | day to day workflow. If you are using it in an environment I haven't 68 | tested and find an issue, feel free to report issues on github. 69 | 70 | -------------------------------------------------------------------------------- /tramp-hlo-tests.el: -------------------------------------------------------------------------------- 1 | ;;; tramp-hlo-tests.el --- Tests of tramp-hlo -*- lexical-binding:t -*- 2 | 3 | ;; Copyright (C) 2025 Free Software Foundation, Inc. 4 | 5 | ;; Author: Michael Albinus 6 | 7 | ;; This file is not part of GNU Emacs. 8 | 9 | ;; This program is free software: you can redistribute it and/or modify 10 | ;; it under the terms of the GNU General Public License as published by 11 | ;; the Free Software Foundation, either version 3 of the License, or 12 | ;; (at your option) any later version. 13 | 14 | ;; This program is distributed in the hope that it will be useful, 15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | ;; GNU General Public License for more details. 18 | 19 | ;; You should have received a copy of the GNU General Public License 20 | ;; along with GNU Emacs. If not, see . 21 | 22 | ;;; Commentary: 23 | 24 | ;; Some of the tests require access to a remote host files. Since 25 | ;; this could be problematic, a mock-up connection method "mock" is 26 | ;; used. Emulating a remote connection, it simply calls "sh -i". 27 | ;; Tramp's file name handlers still run, so this test is sufficient 28 | ;; except for connection establishing. 29 | 30 | ;; If you want to test a real Tramp connection, set 31 | ;; $REMOTE_TEMPORARY_FILE_DIRECTORY to a suitable value in order to 32 | ;; overwrite the default value. If you want to skip tests accessing a 33 | ;; remote host, set this environment variable to "/dev/null" or 34 | ;; whatever is appropriate on your system. 35 | 36 | ;;; Code: 37 | 38 | ;; Add load-path for batch mode 39 | (when load-file-name noninteractive 40 | (add-to-list 'load-path (file-name-directory load-file-name)) 41 | (add-to-list 42 | 'load-path 43 | (file-name-concat (file-name-directory load-file-name) ".." "tramp"))) 44 | (require 'tramp) 45 | (require 'tramp-hlo) 46 | (require 'ert-x) 47 | 48 | (setq auth-source-cache-expiry nil 49 | auth-source-save-behavior nil 50 | password-cache-expiry nil 51 | remote-file-name-inhibit-cache nil 52 | tramp-allow-unsafe-temporary-files t 53 | tramp-cache-read-persistent-data t ;; For auth-sources. 54 | tramp-copy-size-limit nil 55 | tramp-error-show-message-timeout nil 56 | tramp-persistency-file-name nil 57 | tramp-verbose 0) 58 | 59 | (defvar tramp-hlo--test-enabled-checked nil 60 | "Cached result of `tramp-hlo--test-enabled'. 61 | If the function did run, the value is a cons cell, the `cdr' 62 | being the result.") 63 | 64 | (defun tramp-hlo--test-enabled () 65 | "Whether remote file access is enabled." 66 | (unless (consp tramp-hlo--test-enabled-checked) 67 | (setq 68 | tramp-hlo--test-enabled-checked 69 | (cons 70 | t (ignore-errors 71 | (and 72 | (file-remote-p ert-remote-temporary-file-directory) 73 | (file-directory-p ert-remote-temporary-file-directory) 74 | (file-writable-p ert-remote-temporary-file-directory) 75 | (tramp-sh-file-name-handler-p 76 | (tramp-dissect-file-name ert-remote-temporary-file-directory))))))) 77 | 78 | (cdr tramp-hlo--test-enabled-checked)) 79 | 80 | (defun tramp-hlo--test-advice-function (&rest args) 81 | "Advice funtion." 82 | (message "tramp-hlo been here %S" args)) 83 | 84 | (defun tramp-hlo--run-test (fun &rest args) 85 | "Run `(apply FUN ARGS)' with and without tramp-hlo handlers. 86 | The result must be equal." 87 | (let ((hlo-fun (intern (concat "tramp-hlo-" (symbol-name fun)))) 88 | expected received) 89 | (unwind-protect 90 | (progn 91 | ;; Advice `hlo-fun'. 92 | (add-function 93 | :before (symbol-function hlo-fun) #'tramp-hlo--test-advice-function) 94 | ;; Check result w/o tramp-hlo. 95 | (ert-with-message-capture captured-messages 96 | (tramp-hlo-remove) 97 | (setq expected (apply fun args)) 98 | (should-not 99 | (string-match-p "tramp-hlo been here" captured-messages))) 100 | ;; Check result with tramp-hlo. 101 | (ert-with-message-capture captured-messages 102 | (tramp-hlo-setup) 103 | (setq received (apply fun args)) 104 | (should (string-match-p "tramp-hlo been here" captured-messages))) 105 | ;; Compare results. 106 | ;(message "%s %s\n%s\n%s\n" fun args expected received) 107 | (should (equal expected received))) 108 | 109 | ;; Cleanup. 110 | (remove-function 111 | (symbol-function hlo-fun) #'tramp-hlo--test-advice-function)))) 112 | 113 | ;; See tramp-tests.el for more examples. 114 | (defconst tramp-hlo--special-names 115 | '(" foo\tbar baz\t" "&foo&bar&baz&" "$foo$bar$$baz$" "'foo\"bar'baz\"") 116 | "File names with special characters.") 117 | 118 | (ert-deftest tramp-hlo-test-dir-locals--all-files () 119 | "Test `dir-locals--all-files'." 120 | (skip-unless (tramp-hlo--test-enabled)) 121 | 122 | (ert-with-temp-directory tmpdir 123 | :prefix (file-name-as-directory ert-remote-temporary-file-directory) 124 | (make-empty-file (expand-file-name dir-locals-file tmpdir)) 125 | (make-empty-file 126 | (expand-file-name (string-replace ".el" "-2.el" dir-locals-file) tmpdir)) 127 | 128 | ;; Use absolute directory. 129 | (tramp-hlo--run-test 'dir-locals--all-files tmpdir) 130 | 131 | ;; Use relative directory. 132 | (let ((default-directory tmpdir)) 133 | (tramp-hlo--run-test 'dir-locals--all-files "./"))) 134 | 135 | ;; Try directories with special characters. 136 | (dolist (prefix tramp-hlo--special-names) 137 | (ert-with-temp-directory tmpdir 138 | :prefix (expand-file-name prefix ert-remote-temporary-file-directory) 139 | (make-empty-file (expand-file-name dir-locals-file tmpdir)) 140 | (make-empty-file 141 | (expand-file-name (string-replace ".el" "-2.el" dir-locals-file) tmpdir)) 142 | 143 | (tramp-hlo--run-test 'dir-locals--all-files tmpdir))) 144 | 145 | ;; Use another `dir-locals-file'. 146 | (ert-with-temp-directory tmpdir 147 | :prefix (file-name-as-directory ert-remote-temporary-file-directory) 148 | (dolist (dir-locals-file 149 | (mapcar (lambda (s) (concat s ".el")) 150 | (cons "foo" tramp-hlo--special-names))) 151 | (make-empty-file (expand-file-name dir-locals-file tmpdir)) 152 | (make-empty-file 153 | (expand-file-name (string-replace ".el" "-2.el" dir-locals-file) tmpdir)) 154 | 155 | (tramp-hlo--run-test 'dir-locals--all-files tmpdir)))) 156 | 157 | (ert-deftest tramp-hlo-test-dir-locals-find-file () 158 | "Test `dir-locals-find-file'." 159 | (skip-unless (tramp-hlo--test-enabled)) 160 | 161 | (ert-with-temp-directory tmpdir 162 | :prefix (file-name-as-directory ert-remote-temporary-file-directory) 163 | (make-directory (file-name-concat tmpdir "foo" "bar") 'parents) 164 | (make-empty-file (expand-file-name dir-locals-file tmpdir)) 165 | (make-empty-file 166 | (expand-file-name (string-replace ".el" "-2.el" dir-locals-file) tmpdir)) 167 | 168 | ;; Use absolute directory. 169 | (tramp-hlo--run-test 170 | 'dir-locals-find-file (file-name-concat tmpdir "foo" "bar" "baz")) 171 | 172 | ;; Subdirectory that doesn't exist yet 173 | (tramp-hlo--run-test 174 | 'dir-locals-find-file 175 | (file-name-concat tmpdir "foo" "bar" "baz" "blah" "bloo")) 176 | 177 | ;; Use relative directory 178 | (let ((default-directory (file-name-concat tmpdir "foo" "bar" "baz"))) 179 | (tramp-hlo--run-test 'dir-locals-find-file "./")) 180 | 181 | ;; Try directories with special characters. 182 | (dolist (bar tramp-hlo--special-names) 183 | (make-directory (file-name-concat tmpdir "foo" bar) 'parents) 184 | ;; Use another `dir-locals-file'. 185 | (dolist (dir-locals-file 186 | (mapcar (lambda (s) (concat s ".el")) 187 | (cons "foo" tramp-hlo--special-names))) 188 | ;; Use absolute directory. 189 | (tramp-hlo--run-test 190 | 'dir-locals-find-file (file-name-concat tmpdir "foo" bar "baz")) 191 | 192 | ;; Subdirectory that doesn't exist yet 193 | (tramp-hlo--run-test 194 | 'dir-locals-find-file 195 | (file-name-concat tmpdir "foo" bar "baz" "blah" "bloo")) 196 | 197 | ;; Use relative directory 198 | (let ((default-directory (file-name-concat tmpdir "foo" bar "baz"))) 199 | (tramp-hlo--run-test 'dir-locals-find-file "./") 200 | (tramp-hlo--run-test 'dir-locals-find-file "./blah/bleh")))))) 201 | 202 | (ert-deftest tramp-hlo-test-locate-dominating-file () 203 | "Test `locate-dominating-file'." 204 | (skip-unless (tramp-hlo--test-enabled)) 205 | 206 | (ert-with-temp-directory tmpdir 207 | :prefix (file-name-as-directory ert-remote-temporary-file-directory) 208 | (make-directory (file-name-concat tmpdir "foo" "bar") 'parents) 209 | (make-empty-file (expand-file-name dir-locals-file tmpdir)) 210 | 211 | ;; Use absolute directory. Search for regular file and directory. 212 | (tramp-hlo--run-test 213 | 'locate-dominating-file 214 | (file-name-concat tmpdir "foo" "bar" "baz") dir-locals-file) 215 | (tramp-hlo--run-test 216 | 'locate-dominating-file (file-name-concat tmpdir "foo" "bar" "baz") "foo") 217 | 218 | ;; Use subdirectory that doesn't exist yet 219 | (tramp-hlo--run-test 220 | 'locate-dominating-file 221 | (file-name-concat tmpdir "foo" "bar" "baz" "blah" "bleh") dir-locals-file) 222 | (tramp-hlo--run-test 223 | 'locate-dominating-file 224 | (file-name-concat tmpdir "foo" "bar" "baz" "blah" "bleh") "foo") 225 | ;; Use relative directory. 226 | (let ((default-directory (file-name-concat tmpdir "foo" "bar" "baz"))) 227 | (tramp-hlo--run-test 'locate-dominating-file "./" dir-locals-file) 228 | (tramp-hlo--run-test 'locate-dominating-file "./" "foo") 229 | (tramp-hlo--run-test 'locate-dominating-file "./blah/bleh" "foo") 230 | (tramp-hlo--run-test 231 | 'locate-dominating-file "./blah/bleh" dir-locals-file)) 232 | 233 | ;; Try directories with special characters. 234 | (dolist (bar tramp-hlo--special-names) 235 | (make-directory (file-name-concat tmpdir "foo" bar) 'parents) 236 | ;; Use another `dir-locals-file'. 237 | (dolist (dir-locals-file 238 | (mapcar (lambda (s) (concat s ".el")) 239 | (cons "foo" tramp-hlo--special-names))) 240 | ;; Use absolute directory. Search for regular file and directory. 241 | (tramp-hlo--run-test 242 | 'locate-dominating-file 243 | (file-name-concat tmpdir "foo" bar "baz") dir-locals-file) 244 | (tramp-hlo--run-test 245 | 'locate-dominating-file (file-name-concat tmpdir "foo" bar "baz") "foo") 246 | 247 | ;; Use subdirectory that doesn't exist yet 248 | (tramp-hlo--run-test 249 | 'locate-dominating-file 250 | (file-name-concat tmpdir "foo" bar "baz" "blah" "bleh") 251 | dir-locals-file) 252 | (tramp-hlo--run-test 253 | 'locate-dominating-file 254 | (file-name-concat tmpdir "foo" bar "blah" "bleh") "foo") 255 | ;; Use relative directory. 256 | (let ((default-directory (file-name-concat tmpdir "foo" bar "baz"))) 257 | (tramp-hlo--run-test 'locate-dominating-file "./" dir-locals-file) 258 | (tramp-hlo--run-test 'locate-dominating-file "./" "foo") 259 | (tramp-hlo--run-test 'locate-dominating-file "./blah/bleh" "foo") 260 | (tramp-hlo--run-test 261 | 'locate-dominating-file "./blah/bleh" dir-locals-file)))))) 262 | 263 | (provide 'tramp-hlo-tests) 264 | 265 | ;;; tramp-hlo-tests.el ends here 266 | -------------------------------------------------------------------------------- /tramp-hlo.el: -------------------------------------------------------------------------------- 1 | ;;; tramp-hlo.el --- High level operations as Tramp handlers -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2025 Free Software Foundation, Inc. 4 | 5 | ;; Author: Joe Sadusk 6 | ;; Version: 0.0.2 7 | ;; Package-Requires: ((tramp "2.8.0.5")) 8 | ;; URL: https://github.com/jsadusk/tramp-hlo 9 | 10 | ;; This file is not part of GNU Emacs. 11 | 12 | ;; This program is free software: you can redistribute it and/or modify 13 | ;; it under the terms of the GNU General Public License as published by 14 | ;; the Free Software Foundation, either version 3 of the License, or 15 | ;; (at your option) any later version. 16 | 17 | ;; This program is distributed in the hope that it will be useful, 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | ;; GNU General Public License for more details. 21 | 22 | ;; You should have received a copy of the GNU General Public License 23 | ;; along with GNU Emacs. If not, see . 24 | 25 | ;;; Commentary 26 | 27 | ;; This is an attempt to optimize Tramp remote editing with slow 28 | ;; connection by building higher level core lisp functions as Tramp 29 | ;; operations. The idea is to reduce round trips by doing more on the 30 | ;; server in one request. It applies only to shell-based remote 31 | ;; connections, as declared in tramp-sh.el and tramp-container.el. 32 | 33 | ;; In order to enable it, call \\[tramp-hlo-setup]. 34 | 35 | ;;; Code: 36 | 37 | (require 'tramp) 38 | (require 'tramp-sh) 39 | 40 | (defconst tramp-hlo-test-files-in-dir-script "\ 41 | DIR=\"$1\" 42 | shift 43 | if [ ! -d \"$DIR\" ]; then 44 | echo nil 45 | else 46 | DIR=\"$(realpath \"$DIR\")\" 47 | cd \"$DIR\" 48 | echo \\( 49 | for FILE in \"$@\"; do 50 | if [ -r \"$FILE\" ] && [ -f \"$FILE\" ] && [ ! -d \"$FILE\" ]; then 51 | %k \"$DIR/$FILE\"; printf \"\\n\" 52 | fi 53 | done 54 | echo \\) 55 | fi 56 | " 57 | "Script to check for `dir-locals' in a remote directory. 58 | The arguments are `DIRECTORY FILE1 FILE2 ...', with optional FILE*. 59 | Format specifiers are replaced by `tramp-expand-script', percent 60 | characters need to be doubled.") 61 | 62 | (defconst tramp-hlo-list-parents-script "\ 63 | FILE=\"$1\" 64 | TEST=\"$(dirname \"$FILE\")\" 65 | echo \\( 66 | while [ \"$TEST\" != \"\" ]; do 67 | if [ -d \"$TEST\" ]; then 68 | echo \"\\\"$TEST/\\\"\" | sed \"s|^$HOME|~|\" 69 | TEST=\"${TEST%%/*}\" 70 | fi 71 | done 72 | echo \\\"/\\\" 73 | echo \\) 74 | " 75 | "Script to list all parents in upward order of a DIRECTORY. 76 | If possible, the parents use home abbreviations. 77 | Format specifiers are replaced by `tramp-expand-script', percent 78 | characters need to be doubled.") 79 | 80 | (defconst tramp-hlo-locate-dominating-file-multi-script "\ 81 | FILE=\"$1\" 82 | shift 83 | TEST=\"$(dirname \"$FILE\")\" 84 | echo \\( 85 | FOUND=\"\" 86 | while [ ! -z \"$TEST\" ] && [ -z \"$FOUND\" ]; do 87 | if [ -d \"$TEST\" ]; then 88 | for NAME in \"$@\"; do 89 | if [ -e \"$TEST/$NAME\" ]; then 90 | %k \"$TEST/$NAME\" 91 | FOUND=1 92 | fi 93 | done 94 | fi 95 | if [ -z \"$FOUND\" ]; then 96 | if [ \"$TEST\" = \"/\" ]; then 97 | TEST=\"\" 98 | else 99 | TEST=\"${TEST%%/*}\" 100 | if [ -z \"$TEST\" ]; then 101 | TEST=\"/\" 102 | fi 103 | fi 104 | fi 105 | done 106 | echo \\) 107 | " 108 | "Script to find several dominating files on a remote host. 109 | Arguments are like in `locate-dominating-file', but with supporting 110 | several NAMEs. 111 | Format specifiers are replaced by `tramp-expand-script', percent 112 | characters need to be doubled.") 113 | 114 | (defconst tramp-hlo-dir-locals-find-file-cache-update-script "\ 115 | FILE=\"$1\" 116 | shift 117 | NAMES=\"$1\" 118 | shift 119 | STAT_FORMAT=\"%%Y\" 120 | 121 | # If FILE doesn't exist yet, find the first ancestor that does 122 | TEST=\"$FILE\" 123 | if [ -e \"$FILE\" ]; then 124 | FILE=\"$(realpath \"$FILE\")\" 125 | STARTING=\"$FILE\" 126 | else 127 | STARTING=\"\" 128 | while [ -z \"$STARTING\" ] && [ ! -z \"$TEST\" ]; do 129 | if [ -d \"$TEST\" ]; then 130 | STARTING=\"$TEST\" 131 | else 132 | if [ \"$TEST\" = \"/\" ]; then 133 | TEST=\"\" 134 | else 135 | TEST=\"${TEST%%/*}\" 136 | if [ -z \"$TEST\" ]; then 137 | TEST=\"/\" 138 | fi 139 | fi 140 | fi 141 | done 142 | fi 143 | 144 | # If we haven't found an ancestor, that's an error 145 | if [ -z \"$STARTING\" ]; then 146 | echo nil 147 | else 148 | TEST=\"$(realpath \"$STARTING\")\" 149 | 150 | # Make sure we're looking directories 151 | if [ ! -d \"$TEST\" ]; then 152 | TEST=\"$(dirname \"$TEST\")\" 153 | fi 154 | 155 | # Start the plist with the real filename 156 | echo \"(\" 157 | printf \":file \"; %k \"$FILE\"; printf \"\\n\" 158 | 159 | # Walk up the directory structure looking for the search files 160 | FOUND=\"\" 161 | while [ ! -z \"$TEST\" ] && [ -z \"$FOUND\" ]; do 162 | for NAME in $NAMES; do 163 | if [ -f \"$TEST/$NAME\" ]; then 164 | DOMINATING_DIR=\"$TEST\" 165 | MTIME=\"$(stat -c \"$STAT_FORMAT\" \"$TEST/$NAME\")\" 166 | FOUND=\"$FOUND ( \\\"$NAME\\\" . $MTIME ) \" 167 | fi 168 | done 169 | if [ -z \"$FOUND\" ]; then 170 | if [ \"$TEST\" = \"/\" ]; then 171 | TEST=\"\" 172 | else 173 | TEST=\"${TEST%%/*}\" 174 | if [ -z \"$TEST\" ]; then 175 | TEST=\"/\" 176 | fi 177 | fi 178 | fi 179 | done 180 | 181 | # Add found files to the plist 182 | if [ ! -z \"$FOUND\" ]; then 183 | printf \":locals (\"; %k \"$DOMINATING_DIR/\"; echo \" $FOUND)\" 184 | fi 185 | 186 | # Test cached dirs for updated mtime 187 | DOMINATING_DIR_LEN=$(expr length \"$DOMINATING_DIR\") 188 | FOUND_CACHEDIR=\"\" 189 | FOUND_CACHEDIR_LEN=0 190 | for CACHEDIR in \"$@\"; do 191 | CACHEDIR_LEN=$(expr length \"$CACHEDIR\") 192 | 193 | if [ -d \"$CACHEDIR\" ] \\ 194 | && [ \"$CACHEDIR_LEN\" -gt \"$FOUND_CACHEDIR_LEN\" ] \\ 195 | && [ \"${FILE#$CACHEDIR}\" != \"$FILE\" ]; then 196 | FOUND_CACHEDIR=\"$CACHEDIR\" 197 | FOUND_CACHEDIR_LEN=$CACHEDIR_LEN 198 | fi 199 | done 200 | 201 | # Add updated cachedirs to plist 202 | if [ ! -z \"$FOUND_CACHEDIR\" ]; then 203 | echo \":cache ( \\\"$FOUND_CACHEDIR\\\" \" 204 | for NAME in $NAMES; do 205 | if [ -f \"$FOUND_CACHEDIR/$NAME\" ]; then 206 | MTIME=\"$(stat -c \"$STAT_FORMAT\" \"$FOUND_CACHEDIR/$NAME\")\" 207 | echo \"( \\\"$NAME\\\" . $MTIME ) \" 208 | fi 209 | done 210 | echo \")\" 211 | fi 212 | 213 | echo \")\" 214 | fi 215 | " 216 | "Support script for `dir-locals-find-file'. 217 | Format specifiers are replaced by `tramp-expand-script', percent 218 | characters need to be doubled.") 219 | 220 | (defun tramp-hlo-dir-locals--all-files (directory) 221 | "Tramp optimized version of `dir-locals--all-files'. 222 | Return a list of all readable dir-locals files in DIRECTORY. 223 | The returned list is sorted by increasing priority. That is, 224 | values specified in the last file should take precedence over 225 | those in the first. 226 | 227 | The optional argument BASE-EL-ONLY will only consider the base dir locals file." 228 | (with-parsed-tramp-file-name 229 | (if (file-name-absolute-p directory) 230 | directory (file-name-concat default-directory directory)) 231 | vec 232 | (let* ((localdir (directory-file-name (tramp-file-name-localname vec))) 233 | (file-1 dir-locals-file) 234 | (file-2 (and (string-match "\\.el\\'" file-1) 235 | (replace-match "-2.el" t nil file-1)))) 236 | (tramp-maybe-send-script vec tramp-hlo-test-files-in-dir-script 237 | "test_files_in_dir") 238 | (mapcar (lambda (name) (tramp-make-tramp-file-name vec name)) 239 | (tramp-send-command-and-read 240 | vec 241 | (format "test_files_in_dir %s %s %s" 242 | (tramp-shell-quote-argument localdir) 243 | (tramp-shell-quote-argument file-1) 244 | (tramp-shell-quote-argument file-2))))))) 245 | 246 | (defun tramp-hlo-locate-dominating-file-pred (vec pred) 247 | "Implementation of `tramp-hlo-locate-dominating-file' for a name predicate. 248 | Starting at the file represented by VEC, look up directory hierarchy for 249 | directory identified by PRED. 250 | Stop at the first parent directory matched, and return the directory. Return nil 251 | if not found. 252 | PRED takes one argument, a directory, and returns a non-nil value if that 253 | directory is the one for which we're looking." 254 | (tramp-maybe-send-script vec tramp-hlo-list-parents-script "list_parents") 255 | (let* ((localfile (tramp-shell-quote-argument (tramp-file-name-localname vec))) 256 | (command (format "list_parents %s" localfile)) 257 | (parents (tramp-send-command-and-read vec command))) 258 | (while (and parents 259 | (not (funcall pred 260 | (tramp-make-tramp-file-name vec (car parents))))) 261 | (pop parents)) 262 | (when parents 263 | (tramp-make-tramp-file-name vec (car parents))))) 264 | 265 | (defun tramp-hlo-locate-dominating-file-list (vec names) 266 | "Implementation of `tramp-hlo-locate-dominating-file' for a list of names. 267 | Starting at the file represented by VEC, look up directory hierarchy for 268 | directory containing any files in list NAMES. 269 | Stop at the first parent directory matched, and return the directory. Return nil 270 | if not found." 271 | (tramp-maybe-send-script vec tramp-hlo-locate-dominating-file-multi-script 272 | "locate_dominating_file_multi") 273 | (let* ((localfile (tramp-shell-quote-argument (tramp-file-name-localname vec))) 274 | (quoted-names (mapcar #'tramp-shell-quote-argument names)) 275 | (quoted-names-str (string-join quoted-names " ")) 276 | (command (format 277 | "locate_dominating_file_multi %s %s" 278 | localfile quoted-names-str)) 279 | (local-dominating (tramp-send-command-and-read vec command))) 280 | (mapcar (lambda (result) 281 | (tramp-make-tramp-file-name vec result)) 282 | local-dominating))) 283 | 284 | (defun tramp-hlo-locate-dominating-file (file name) 285 | "Tramp version of `locate-dominating-file'. 286 | Starting at FILE, look up directory hierarchy for directory containing NAME. 287 | FILE can be a file or a directory. If it's a file, its directory will 288 | serve as the starting point for searching the hierarchy of directories. 289 | Stop at the first parent directory containing a file NAME, 290 | and return the directory. Return nil if not found. 291 | Instead of a string, NAME can also be a predicate taking one argument 292 | \(a directory) and returning a non-nil value if that directory is the one for 293 | which we're looking. The predicate will be called with every file/directory 294 | the function needs to examine, starting with FILE." 295 | ;; FIXME: What about `locate-dominating-stop-dir-regexp'? 296 | (with-parsed-tramp-file-name 297 | (if (file-name-absolute-p file) 298 | file (file-name-concat default-directory file)) 299 | vec 300 | (if (functionp name) 301 | (tramp-hlo-locate-dominating-file-pred vec name) 302 | (let* ((names (ensure-list name)) 303 | (file-list (tramp-hlo-locate-dominating-file-list vec names))) 304 | (when file-list 305 | (file-name-directory (car file-list))))))) 306 | 307 | (defun tramp-hlo-dir-locals-find-file-cache-update (file cache) 308 | "Prepare inputs and run support script for `tramp-hlo-dir-locals-find-file'. 309 | Perform the equivalent of `expand-file-name', `locate-dominating-file' and 310 | `file-attribute-modification-time' in one Tramp operation. 311 | The operations performed are: 312 | - Expand the filename of FILE 313 | - Locate the dominating directory-locals files for the directory containing 314 | FILE 315 | - Resolve the mtime for all directory-locals files located 316 | - Find cache directories from CACHE which is equivalent to 317 | `dir-locals-directory-cache' that are on the same remote as FILE 318 | - Find the highest level cache directory located under the expanded path of 319 | FILE, if it exists 320 | - Resolve the mtime of all directory-locals files under the cache directory 321 | 322 | This function returns a plist with the fields: 323 | - `:file' containing the expanded filename of FILE 324 | - `:locals' containing a list with the located dir-locals directory under FILE 325 | and a dotted pair list of dir-locals files under that directory with their 326 | mtime 327 | - `:cache' containing the most appropriate cache directory under FILE with a 328 | dotted pair list of dir-locals file and mtime 329 | `:locals' and `:cache' are optional fields, and are missing if not found." 330 | (with-parsed-tramp-file-name 331 | (if (file-name-absolute-p file) 332 | file (file-name-concat default-directory file)) 333 | vec 334 | (tramp-maybe-send-script 335 | vec 336 | tramp-hlo-dir-locals-find-file-cache-update-script 337 | "dir_locals_find_file_cache_update") 338 | (let* ((file-connection (file-remote-p file)) 339 | (cache-dirs-quoted 340 | (seq-uniq 341 | (cl-loop 342 | for cache-entry in cache 343 | when (string= file-connection (file-remote-p (car cache-entry))) 344 | collect (tramp-shell-quote-argument 345 | (file-local-name (car cache-entry)))))) 346 | (cache-dirs-string (string-join cache-dirs-quoted " ")) 347 | (command 348 | (format 349 | "dir_locals_find_file_cache_update %s \"%s %s\" %s" 350 | (tramp-shell-quote-argument (tramp-file-local-name file)) 351 | (tramp-shell-quote-argument dir-locals-file) 352 | (tramp-shell-quote-argument 353 | (string-replace ".el" "-2.el" dir-locals-file)) 354 | cache-dirs-string))) 355 | (tramp-send-command-and-read vec command)))) 356 | 357 | (defun tramp-hlo-dir-locals-find-file (file) 358 | "Tramp implementation of `dir-locals-find-file'. 359 | Find the directory-local variables for FILE. 360 | This searches upward in the directory tree from FILE. 361 | It stops at the first directory that has been registered in 362 | `dir-locals-directory-cache' or contains a `dir-locals-file'. 363 | If it finds an entry in the cache, it checks that it is valid. 364 | A cache entry with no modification time element (normally, one that 365 | has been assigned directly using `dir-locals-set-directory-class', not 366 | set from a file) is always valid. 367 | A cache entry based on a `dir-locals-file' is valid if the modification 368 | time stored in the cache matches the current file modification time. 369 | If not, the cache entry is cleared so that the file will be re-read. 370 | 371 | This function returns either: 372 | - nil (no directory local variables found), 373 | - the matching entry from `dir-locals-directory-cache' (a list), 374 | - or the full path to the directory (a string) containing at 375 | least one `dir-locals-file' in the case of no valid cache 376 | entry." 377 | (let* ((file (if (file-name-absolute-p file) 378 | file (file-name-concat default-directory file))) 379 | (file-connection (file-remote-p file)) 380 | (cache-update (tramp-hlo-dir-locals-find-file-cache-update 381 | file dir-locals-directory-cache)) 382 | (locals-dir-update (plist-get cache-update :locals)) 383 | (locals-dir (if locals-dir-update 384 | (concat file-connection 385 | (car locals-dir-update)))) 386 | (cache-dir-update (plist-get cache-update :cache)) 387 | (cache-dir (if cache-dir-update 388 | (concat file-connection 389 | (car cache-dir-update)))) 390 | (dir-elt (if cache-dir-update 391 | (seq-find 392 | (lambda (elt) 393 | (string= (car elt) cache-dir)) 394 | dir-locals-directory-cache)))) 395 | (if (and dir-elt 396 | (or (null locals-dir) 397 | (<= (length locals-dir) 398 | (length (car dir-elt))))) 399 | ;; Found a potential cache entry. Check validity. 400 | ;; A cache entry with no MTIME is assumed to always be valid 401 | ;; (ie, set directly, not from a dir-locals file). 402 | ;; Note, we don't bother to check that there is a matching class 403 | ;; element in dir-locals-class-alist, since that's done by 404 | ;; dir-locals-set-directory-class. 405 | (if (or (null (nth 2 dir-elt)) 406 | (let ((cached-files (cdr cache-dir-update))) 407 | ;; The entry MTIME should match the most recent 408 | ;; MTIME among matching files. 409 | (and cached-files 410 | (time-equal-p 411 | (nth 2 dir-elt) 412 | (let ((latest 0)) 413 | (dolist (f cached-files latest) 414 | (let ((f-time 415 | (seconds-to-time (cdr f)))) 416 | (if (time-less-p latest f-time) 417 | (setq latest f-time))))))))) 418 | ;; This cache entry is OK. 419 | dir-elt 420 | (progn 421 | ;; This cache entry is invalid; clear it. 422 | (setq dir-locals-directory-cache 423 | (delq dir-elt dir-locals-directory-cache)) 424 | ;; Return the first existing dir-locals file. Might be the same 425 | ;; as dir-elt's, might not (eg latter might have been deleted). 426 | locals-dir)) 427 | ;; No cache entry. 428 | locals-dir))) 429 | 430 | (defun tramp-hlo-setup () 431 | "Setup Tramp high-level functions. 432 | Adds Tramp external operations for the following Emacs built-in functions: 433 | - `dir-locals--all-files' 434 | - `locate-dominating-file' 435 | - `dir-locals-find-file'" 436 | (interactive) 437 | (tramp-add-external-operation 'dir-locals--all-files 438 | #'tramp-hlo-dir-locals--all-files 'tramp-sh) 439 | (tramp-add-external-operation 'locate-dominating-file 440 | #'tramp-hlo-locate-dominating-file 'tramp-sh) 441 | (tramp-add-external-operation 'dir-locals-find-file 442 | #'tramp-hlo-dir-locals-find-file 'tramp-sh)) 443 | 444 | (defun tramp-hlo-remove () 445 | "Remove Tramp high-level functions. 446 | Remove Tramp external operations for the following Emacs built-in functions: 447 | - `dir-locals--all-files' 448 | - `locate-dominating-file' 449 | - `dir-locals-find-file'" 450 | (interactive) 451 | (tramp-remove-external-operation 'dir-locals--all-files 'tramp-sh) 452 | (tramp-remove-external-operation 'locate-dominating-file 'tramp-sh) 453 | (tramp-remove-external-operation 'dir-locals-find-file 'tramp-sh)) 454 | 455 | (provide 'tramp-hlo) 456 | ;;; tramp-hlo.el ends here 457 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------