files-x.el 28.5 KB
Newer Older
Juri Linkov's avatar
Juri Linkov committed
1 2
;;; files-x.el --- extended file handling commands

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2009-2019 Free Software Foundation, Inc.
Juri Linkov's avatar
Juri Linkov committed
4 5

;; Author: Juri Linkov <juri@jurta.org>
6
;; Maintainer: emacs-devel@gnu.org
Juri Linkov's avatar
Juri Linkov committed
7
;; Keywords: files
8
;; Package: emacs
Juri Linkov's avatar
Juri Linkov committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Juri Linkov's avatar
Juri Linkov committed
24 25 26 27 28 29 30 31 32

;;; Commentary:

;; This file defines additional infrequently used file- and
;; directory-handling commands that should not be in files.el
;; to not make the dumped image bigger.

;;; Code:

33 34
(eval-when-compile (require 'subr-x)) ; for string-trim-right

Juri Linkov's avatar
Juri Linkov committed
35 36 37 38 39 40 41 42

;;; Commands to add/delete file-local/directory-local variables.

(defun read-file-local-variable (prompt)
  "Read file-local variable using PROMPT and completion.
Intended to be used in the `interactive' spec of
`add-file-local-variable', `delete-file-local-variable',
`add-dir-local-variable', `delete-dir-local-variable'."
43 44
  (let* ((default (variable-at-point))
         (default (and (symbolp default) (boundp default)
Juri Linkov's avatar
Juri Linkov committed
45
		       (symbol-name default)))
46
         (variable
Juri Linkov's avatar
Juri Linkov committed
47 48 49 50 51 52
	  (completing-read
	   (if default
	       (format "%s (default %s): " prompt default)
	     (format "%s: " prompt))
	   obarray
	   (lambda (sym)
53
	     (or (custom-variable-p sym)
54
                 (get sym 'safe-local-variable)
Juri Linkov's avatar
Juri Linkov committed
55
		 (memq sym '(mode eval coding unibyte))))
56
	   nil nil nil default nil)))
Juri Linkov's avatar
Juri Linkov committed
57 58 59 60 61 62
    (and (stringp variable) (intern variable))))

(defun read-file-local-variable-value (variable)
  "Read value of file-local VARIABLE using completion.
Intended to be used in the `interactive' spec of
`add-file-local-variable' and `add-dir-local-variable'."
63 64 65 66 67 68 69 70 71 72 73 74
  (cond
   ((eq variable 'mode)
    (let* ((default (and (symbolp major-mode) (symbol-name major-mode)))
           (value
            (completing-read
             (if default
                 (format "Add %s with value (default %s): " variable default)
               (format "Add %s with value: " variable))
             obarray
             (lambda (sym)
               (string-match-p "-mode\\'" (symbol-name sym)))
             nil nil nil default nil)))
Juri Linkov's avatar
Juri Linkov committed
75
      (and (stringp value)
76 77 78 79 80 81
           (intern (replace-regexp-in-string "-mode\\'" "" value)))))
   ((eq variable 'eval)
    (read--expression (format "Add %s with expression: " variable)))
   ((eq variable 'coding)
    (let ((default (and (symbolp buffer-file-coding-system)
                        (symbol-name buffer-file-coding-system))))
Juri Linkov's avatar
Juri Linkov committed
82 83
      (read-coding-system
       (if default
84 85 86 87 88 89 90 91 92 93 94
           (format "Add %s with value (default %s): " variable default)
         (format "Add %s with value: " variable))
       default)))
   (t
    (let ((default (format "%S"
                           (cond ((eq variable 'unibyte) t)
                                 ((boundp variable)
                                  (symbol-value variable)))))
          (minibuffer-completing-symbol t))
      (read-from-minibuffer (format "Add %s with value: " variable)
                            nil read-expression-map t
95 96
                            'set-variable-value-history
			    default)))))
Juri Linkov's avatar
Juri Linkov committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110

(defun read-file-local-variable-mode ()
  "Read per-directory file-local variable's mode using completion.
Intended to be used in the `interactive' spec of
`add-dir-local-variable', `delete-dir-local-variable'."
  (let* ((default (and (symbolp major-mode) (symbol-name major-mode)))
	 (mode
	  (completing-read
	   (if default
	       (format "Mode or subdirectory (default %s): " default)
	     (format "Mode or subdirectory: "))
	   obarray
	   (lambda (sym)
	     (and (string-match-p "-mode\\'" (symbol-name sym))
111 112 113
		  (not (or (memq sym minor-mode-list)
                           (string-match-p "-minor-mode\\'"
                                           (symbol-name sym))))))
Juri Linkov's avatar
Juri Linkov committed
114 115 116 117 118 119
	   nil nil nil default nil)))
    (cond
     ((equal mode "nil") nil)
     ((and (stringp mode) (fboundp (intern mode))) (intern mode))
     (t mode))))

120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
(defun modify-file-local-variable-message (variable value op)
  (let* ((not-value (make-symbol ""))
	 (old-value (cond ((eq variable 'mode)
			   major-mode)
			  ((eq variable 'coding)
			   buffer-file-coding-system)
			  (t (if (and (symbolp variable)
				      (boundp variable))
				 (symbol-value variable)
			       not-value))))
	 (new-value (if (eq op 'delete)
			(cond ((eq variable 'mode)
			       (default-value 'major-mode))
			      ((eq variable 'coding)
			       (default-value 'buffer-file-coding-system))
			      (t (if (and (symbolp variable)
					  (default-boundp variable))
				     (default-value variable)
				   not-value)))
		      (cond ((eq variable 'mode)
			     (let ((string (format "%S" value)))
			       (if (string-match-p "-mode\\'" string)
				   value
				 (intern (concat string "-mode")))))
			    (t value)))))
    (when (or (eq old-value not-value)
	      (eq new-value not-value)
	      (not (equal old-value new-value)))
      (message "%s" (substitute-command-keys
		     "For this change to take effect revisit file using \\[revert-buffer]")))))

(defun modify-file-local-variable (variable value op &optional interactive)
Juri Linkov's avatar
Juri Linkov committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
  "Modify file-local VARIABLE in Local Variables depending on operation OP.

If OP is `add-or-replace' then delete all existing settings of
VARIABLE (except `mode' and `eval') and add a new file-local VARIABLE
with VALUE to the Local Variables list.

If there is no Local Variables list in the current file buffer and OP
is not `delete' then this function adds the first line containing the
string `Local Variables:' and the last line containing the string `End:'.

If OP is `delete' then delete all existing settings of VARIABLE
from the Local Variables list ignoring the input argument VALUE."
  (catch 'exit
    (let ((beg (point)) end replaced-pos)
      (unless enable-local-variables
	(throw 'exit (message "File-local variables are disabled")))

      ;; Look for "Local variables:" line in last page.
      (widen)
      (goto-char (point-max))
      (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)

      ;; Add "Local variables:" list if not found.
      (unless (let ((case-fold-search t))
		(search-forward "Local Variables:" nil t))

	;; Don't add "Local variables:" list for the deletion operation.
	(when (eq op 'delete)
	  (throw 'exit (progn (goto-char beg)
			      (message "Local Variables not found"))))

	(goto-char (point-max))
	(let ((comment-style 'plain)
185
	      (comment-start (or comment-start ";; ")))
Juri Linkov's avatar
Juri Linkov committed
186 187 188 189 190 191 192 193
	  (comment-region
	   (prog1 (setq beg (point))
	     (insert "\nLocal Variables:\nEnd:\n"))
	   (point)))

	(unless (let ((case-fold-search t))
		  (goto-char beg)
		  (search-forward "Local Variables:" nil t))
194
	  (throw 'exit (message "Can't add file-local variables"))))
Juri Linkov's avatar
Juri Linkov committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233

      ;; prefix is what comes before "local variables:" in its line.
      ;; suffix is what comes after "local variables:" in its line.
      (let* ((prefix (buffer-substring (line-beginning-position)
				       (match-beginning 0)))
	     (suffix (buffer-substring (point) (line-end-position)))
	     (prefix-re (concat "^" (regexp-quote prefix)))
	     (suffix-re (concat (regexp-quote suffix) "$")))

	;; Find or add missing "End:".
	(forward-line 1)
	(setq beg (point))
	(save-excursion
	  (unless (let ((case-fold-search t))
		    (re-search-forward
		     (concat prefix-re "[ \t]*End:[ \t]*" suffix-re)
		     nil t))
	    (save-excursion
	      (insert (format "%sEnd:%s\n" prefix suffix))))
	  (beginning-of-line)
	  (setq end (point-marker)))

	;; Find and delete all existing variable/value pairs.
	(when (member op '(add-or-replace delete))
	  (if (and (eq op 'add-or-replace) (memq variable '(mode eval)))
	      (goto-char end)
	    (goto-char beg)
	    (while (re-search-forward
		    (format "%s%S:.*%s" prefix-re variable suffix-re) end t)
	      (delete-region (match-beginning 0) (1+ (match-end 0)))
	      (setq replaced-pos (point)))))

	;; Add a new variable/value pair.  Add `mode' to the start, add new
	;; variable to the end, and add a replaced variable to its last location.
	(when (eq op 'add-or-replace)
	  (cond
	   ((eq variable 'mode) (goto-char beg))
	   ((null replaced-pos) (goto-char end))
	   (replaced-pos (goto-char replaced-pos)))
234 235 236 237
	  (insert (format "%s%S: %S%s\n" prefix variable value suffix))))

      (when interactive
	(modify-file-local-variable-message variable value op)))))
Juri Linkov's avatar
Juri Linkov committed
238 239

;;;###autoload
240
(defun add-file-local-variable (variable value &optional interactive)
Juri Linkov's avatar
Juri Linkov committed
241 242 243 244 245 246 247 248 249 250 251
  "Add file-local VARIABLE with its VALUE to the Local Variables list.

This command deletes all existing settings of VARIABLE (except `mode'
and `eval') and adds a new file-local VARIABLE with VALUE to the
Local Variables list.

If there is no Local Variables list in the current file buffer
then this function adds the first line containing the string
`Local Variables:' and the last line containing the string `End:'."
  (interactive
   (let ((variable (read-file-local-variable "Add file-local variable")))
252 253 254 255
     ;; Error before reading value.
     (if (equal variable 'lexical-binding)
	 (user-error "The `%s' variable must be set at the start of the file"
		     variable))
256
     (list variable (read-file-local-variable-value variable) t)))
257 258 259
  (if (equal variable 'lexical-binding)
      (user-error "The `%s' variable must be set at the start of the file"
                  variable))
260
  (modify-file-local-variable variable value 'add-or-replace interactive))
Juri Linkov's avatar
Juri Linkov committed
261 262

;;;###autoload
263
(defun delete-file-local-variable (variable &optional interactive)
Juri Linkov's avatar
Juri Linkov committed
264 265
  "Delete all settings of file-local VARIABLE from the Local Variables list."
  (interactive
266 267
   (list (read-file-local-variable "Delete file-local variable") t))
  (modify-file-local-variable variable nil 'delete interactive))
Juri Linkov's avatar
Juri Linkov committed
268

269
(defun modify-file-local-variable-prop-line (variable value op &optional interactive)
Juri Linkov's avatar
Juri Linkov committed
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
  "Modify file-local VARIABLE in the -*- line depending on operation OP.

If OP is `add-or-replace' then delete all existing settings of
VARIABLE (except `mode' and `eval') and add a new file-local VARIABLE
with VALUE to the -*- line.

If there is no -*- line at the beginning of the current file buffer
and OP is not `delete' then this function adds the -*- line.

If OP is `delete' then delete all existing settings of VARIABLE
from the -*- line ignoring the input argument VALUE."
  (catch 'exit
    (let ((beg (point)) end replaced-pos)
      (unless enable-local-variables
	(throw 'exit (message "File-local variables are disabled")))

      ;; Find the -*- line at the beginning of the current buffer.
      (widen)
      (goto-char (point-min))
      (setq end (set-auto-mode-1))

      (if end
	  (setq beg (point-marker) end (copy-marker end))

	;; Add the -*- line if not found.
	;; Don't add the -*- line for the deletion operation.
	(when (eq op 'delete)
	  (throw 'exit (progn (goto-char beg)
			      (message "The -*- line not found"))))

	(goto-char (point-min))

302 303 304
	;; Skip interpreter magic line "#!" or XML declaration.
	(when (or (looking-at file-auto-mode-skip)
		  (looking-at "<\\?xml[^>\n]*>$"))
Juri Linkov's avatar
Juri Linkov committed
305 306 307
	  (forward-line 1))

	(let ((comment-style 'plain)
308 309 310
	      (comment-start (or comment-start ";;; "))
	      (line-beg (line-beginning-position))
	      (ce nil))
311
	  (comment-normalize-vars)
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
	  ;; If the first line contains a comment.
	  (if (save-excursion
		(and (looking-at comment-start-skip)
		     (goto-char (match-end 0))
		     (re-search-forward comment-end-skip)
		     (goto-char (match-beginning 0))
		     ;; Still on the same line?
		     (equal line-beg (line-beginning-position))
		     (setq ce (point))))
	      ;; Add local variables to the end of the existing comment.
	      (progn
		(goto-char ce)
		(insert "  -*-")
		(setq beg (point-marker))
		(setq end (point-marker))
		(insert "-*-"))
	    ;; Otherwise, add a new comment before the first line.
	    (comment-region
	     (prog1 (point)
	       (insert "-*-")
	       (setq beg (point-marker))
	       (setq end (point-marker))
	       (insert "-*-\n"))
	     (point)))))
Juri Linkov's avatar
Juri Linkov committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

      (cond
       ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
	;; Simple form: "-*- MODENAME -*-".
	(if (eq variable 'mode)
	    ;; Replace or delete MODENAME
	    (progn
	      (when (member op '(add-or-replace delete))
		(delete-region (match-beginning 1) (match-end 1)))
	      (when (eq op 'add-or-replace)
		(goto-char (match-beginning 1))
		(insert (format "%S" value))))
	  ;; Else, turn `MODENAME' into `mode:MODENAME'
	  ;; and add `VARIABLE: VALUE;'
	  (goto-char (match-beginning 2))
	  (insert (format "; %S: %S; " variable value))
	  (goto-char (match-beginning 1))
	  (insert " mode: ")))

       (t
	;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
	;; Find and delete all existing variable/value pairs.
	(when (member op '(add-or-replace delete))
	  (if (and (eq op 'add-or-replace) (memq variable '(mode eval)))
	      (goto-char end)
	    (goto-char beg)
	    (while (< (point) end)
	      (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
		  (throw 'exit (message "Malformed -*- line")))
	      (goto-char (match-end 0))
366 367 368 369 370
	      (let ((key (intern (match-string 1))))
                (save-restriction
                  (narrow-to-region (point) end)
                  (let ((read-circle nil))
                    (read (current-buffer))))
Juri Linkov's avatar
Juri Linkov committed
371 372 373 374 375 376 377 378 379 380 381
		(skip-chars-forward " \t;")
		(when (eq key variable)
		  (delete-region (match-beginning 0) (point))
		  (setq replaced-pos (point)))))))
	;; Add a new variable/value pair.  Add `mode' to the start, add new
	;; variable to the end, and add a replaced variable to its last location.
	(when (eq op 'add-or-replace)
	  (cond
	   ((eq variable 'mode) (goto-char beg))
	   ((null replaced-pos) (goto-char end))
	   (replaced-pos (goto-char replaced-pos)))
382 383 384
          (if (and (save-excursion
                     (skip-chars-backward " \t")
                     (not (eq (char-before) ?\;)))
385 386 387
		   (not (equal (point) (marker-position beg)))
		   ;; When existing `-*- -*-' is empty, beg > end.
		   (not (> (marker-position beg) (marker-position end))))
Juri Linkov's avatar
Juri Linkov committed
388 389 390
	      (insert ";"))
	  (unless (eq (char-before) ?\s) (insert " "))
	  (insert (format "%S: %S;" variable value))
391 392 393 394
	  (unless (eq (char-after) ?\s) (insert " ")))))

      (when interactive
	(modify-file-local-variable-message variable value op)))))
Juri Linkov's avatar
Juri Linkov committed
395 396

;;;###autoload
397
(defun add-file-local-variable-prop-line (variable value &optional interactive)
Juri Linkov's avatar
Juri Linkov committed
398 399 400 401 402 403 404 405 406 407
  "Add file-local VARIABLE with its VALUE to the -*- line.

This command deletes all existing settings of VARIABLE (except `mode'
and `eval') and adds a new file-local VARIABLE with VALUE to
the -*- line.

If there is no -*- line at the beginning of the current file buffer
then this function adds it."
  (interactive
   (let ((variable (read-file-local-variable "Add -*- file-local variable")))
408 409
     (list variable (read-file-local-variable-value variable) t)))
  (modify-file-local-variable-prop-line variable value 'add-or-replace interactive))
Juri Linkov's avatar
Juri Linkov committed
410 411

;;;###autoload
412
(defun delete-file-local-variable-prop-line (variable &optional interactive)
Juri Linkov's avatar
Juri Linkov committed
413 414
  "Delete all settings of file-local VARIABLE from the -*- line."
  (interactive
415 416
   (list (read-file-local-variable "Delete -*- file-local variable") t))
  (modify-file-local-variable-prop-line variable nil 'delete interactive))
Juri Linkov's avatar
Juri Linkov committed
417

418 419
(defvar auto-insert) ; from autoinsert.el

Juri Linkov's avatar
Juri Linkov committed
420 421 422 423 424 425 426 427 428 429 430 431
(defun modify-dir-local-variable (mode variable value op)
  "Modify directory-local VARIABLE in .dir-locals.el depending on operation OP.

If OP is `add-or-replace' then delete all existing settings of
VARIABLE (except `mode' and `eval') and add a new directory-local VARIABLE
with VALUE to the MODE alist where MODE can be a mode name symbol or
a subdirectory name.

If .dir-locals.el was not found and OP is not `delete' then create
this file in the current directory.

If OP is `delete' then delete all existing settings of VARIABLE
432
from the MODE alist ignoring the input argument VALUE."
Juri Linkov's avatar
Juri Linkov committed
433 434 435
  (catch 'exit
    (unless enable-local-variables
      (throw 'exit (message "Directory-local variables are disabled")))
436 437 438 439
    (let* ((dir-or-cache (and (buffer-file-name)
                              (not (file-remote-p (buffer-file-name)))
                              (dir-locals-find-file (buffer-file-name))))
           (variables-file
440 441
            ;; If there are several .dir-locals, the user probably
            ;; wants to edit the last one (the highest priority).
442 443 444 445 446 447 448 449 450
            (cond ((stringp dir-or-cache)
                   (car (last (dir-locals--all-files dir-or-cache))))
                  ((consp dir-or-cache)	; result from cache
                   ;; If cache element has an mtime, assume it came
                   ;; from a file.  Otherwise, assume it was set
                   ;; directly.
                   (if (nth 2 dir-or-cache)
                       (car (last (dir-locals--all-files (car dir-or-cache))))
                     (cadr dir-or-cache)))
451
                  ;; Try to make a proper file-name.
452 453
                  (t (expand-file-name dir-locals-file))))
           variables)
454 455 456 457 458
      ;; I can't be bothered to handle this case right now.
      ;; Dir locals were set directly from a class.  You need to
      ;; directly modify the class in dir-locals-class-alist.
      (and variables-file (not (stringp variables-file))
	   (throw 'exit (message "Directory locals were not set from a file")))
Juri Linkov's avatar
Juri Linkov committed
459
      ;; Don't create ".dir-locals.el" for the deletion operation.
460 461 462 463
      (and (eq op 'delete)
	   (or (not variables-file)
	       (not (file-exists-p variables-file)))
	   (throw 'exit (message "No .dir-locals.el file was found")))
Juri Linkov's avatar
Juri Linkov committed
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
      (let ((auto-insert nil))
	(find-file variables-file))
      (widen)
      (goto-char (point-min))

      ;; Read alist of directory-local variables.
      (ignore-errors
	(delete-region
	 (prog1 (point)
	   (setq variables (let ((read-circle nil))
			     (read (current-buffer)))))
	 (point)))

      ;; Add or replace variable in alist of directory-local variables.
      (let ((mode-assoc (assoc mode variables)))
	(if mode-assoc
	    (setq variables
		  (cons (cons mode
			      (if (eq op 'delete)
				  (assq-delete-all variable (cdr mode-assoc))
				(cons
				 (cons variable value)
				 (if (memq variable '(mode eval))
				     (cdr mode-assoc)
				   (assq-delete-all variable (cdr mode-assoc))))))
489
			(assoc-delete-all mode variables)))
Juri Linkov's avatar
Juri Linkov committed
490 491 492 493 494 495
	  (setq variables
		(cons `(,mode . ((,variable . ,value)))
		      variables))))

      ;; Insert modified alist of directory-local variables.
      (insert ";;; Directory Local Variables\n")
496
      (insert ";;; For more information see (info \"(emacs) Directory Variables\")\n\n")
497
      (princ (dir-locals-to-string
498 499 500 501 502 503 504 505 506 507 508 509
              (sort variables
		    (lambda (a b)
		      (cond
		       ((null (car a)) t)
		       ((null (car b)) nil)
		       ((and (symbolp (car a)) (stringp (car b))) t)
		       ((and (symbolp (car b)) (stringp (car a))) nil)
		       (t (string< (car a) (car b)))))))
             (current-buffer))
      (goto-char (point-min))
      (indent-sexp))))

510
(defun dir-locals-to-string (variables)
511 512
  "Output alists of VARIABLES to string in dotted pair notation syntax."
  (format "(%s)" (mapconcat
513
                  (lambda (mode-variables)
514
                    (format "(%S . %s)"
515
                            (car mode-variables)
516 517
                            (format "(%s)" (mapconcat
                                            (lambda (variable-value)
518
                                              (format "(%S . %s)"
519
                                                      (car variable-value)
520 521 522
                                                      (string-trim-right
                                                       (pp-to-string
                                                        (cdr variable-value)))))
523
                                            (cdr mode-variables) "\n"))))
524
                  variables "\n")))
Juri Linkov's avatar
Juri Linkov committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562

;;;###autoload
(defun add-dir-local-variable (mode variable value)
  "Add directory-local VARIABLE with its VALUE and MODE to .dir-locals.el."
  (interactive
   (let (variable)
     (list
      (read-file-local-variable-mode)
      (setq variable (read-file-local-variable "Add directory-local variable"))
      (read-file-local-variable-value variable))))
  (modify-dir-local-variable mode variable value 'add-or-replace))

;;;###autoload
(defun delete-dir-local-variable (mode variable)
  "Delete all MODE settings of file-local VARIABLE from .dir-locals.el."
  (interactive
   (list
    (read-file-local-variable-mode)
    (read-file-local-variable "Delete directory-local variable")))
  (modify-dir-local-variable mode variable nil 'delete))

;;;###autoload
(defun copy-file-locals-to-dir-locals ()
  "Copy file-local variables to .dir-locals.el."
  (interactive)
  (dolist (elt file-local-variables-alist)
    (unless (assq (car elt) dir-local-variables-alist)
      (add-dir-local-variable major-mode (car elt) (cdr elt)))))

;;;###autoload
(defun copy-dir-locals-to-file-locals ()
  "Copy directory-local variables to the Local Variables list."
  (interactive)
  (dolist (elt dir-local-variables-alist)
    (add-file-local-variable (car elt) (cdr elt))))

;;;###autoload
(defun copy-dir-locals-to-file-locals-prop-line ()
563
  "Copy directory-local variables to the -*- line."
Juri Linkov's avatar
Juri Linkov committed
564 565 566 567
  (interactive)
  (dolist (elt dir-local-variables-alist)
    (add-file-local-variable-prop-line (car elt) (cdr elt))))

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584

;;; connection-local variables.

;;;###autoload
(defvar enable-connection-local-variables t
  "Non-nil means enable use of connection-local variables.")

(defvar connection-local-variables-alist nil
  "Alist of connection-local variable settings in the current buffer.
Each element in this list has the form (VAR . VALUE), where VAR
is a connection-local variable (a symbol) and VALUE is its value.
The actual value in the buffer may differ from VALUE, if it is
changed by the user.")
(make-variable-buffer-local 'connection-local-variables-alist)
(setq ignored-local-variables
      (cons 'connection-local-variables-alist ignored-local-variables))

585
(defvar connection-local-profile-alist nil
586 587 588
  "Alist mapping connection profiles to variable lists.
Each element in this list has the form (PROFILE VARIABLES).
PROFILE is the name of a connection profile (a symbol).
589
VARIABLES is a list that declares connection-local variables for
590 591
PROFILE.  An element in VARIABLES is an alist whose elements are
of the form (VAR . VALUE).")
592

593
(defvar connection-local-criteria-alist nil
594 595 596 597 598 599 600 601 602 603
  "Alist mapping connection criteria to connection profiles.
Each element in this list has the form (CRITERIA PROFILES).
CRITERIA is a plist identifying a connection and the application
using this connection.  Property names might be `:application',
`:protocol', `:user' and `:machine'.  The property value of
`:application' is a symbol, all other property values are
strings.  All properties are optional; if CRITERIA is nil, it
always applies.
PROFILES is a list of connection profiles (symbols).")

Michael Albinus's avatar
Michael Albinus committed
604 605 606 607 608
(defsubst connection-local-normalize-criteria (criteria)
  "Normalize plist CRITERIA according to properties.
Return a reordered plist."
  (apply
   'append
609 610
   (mapcar
    (lambda (property)
611
      (when (and (plist-member criteria property) (plist-get criteria property))
612
        (list property (plist-get criteria property))))
Michael Albinus's avatar
Michael Albinus committed
613
    '(:application :protocol :user :machine))))
614 615 616 617 618

(defsubst connection-local-get-profiles (criteria)
  "Return the connection profiles list for CRITERIA.
CRITERIA is a plist identifying a connection and the application
using this connection, see `connection-local-criteria-alist'."
Michael Albinus's avatar
Michael Albinus committed
619 620 621 622 623 624 625 626 627 628 629 630
  (let (profiles)
    (dolist (crit-alist connection-local-criteria-alist)
      (let ((crit criteria)
            (match t))
        (while (and crit match)
          (when (plist-member (car crit-alist) (car crit))
            (setq match (equal (plist-get (car crit-alist) (car crit))
                               (plist-get criteria (car crit)))))
          (setq crit (cddr crit)))
        (when match
          (setq profiles (append profiles (cdr crit-alist))))))
    (delete-dups profiles)))
631 632

;;;###autoload
633
(defun connection-local-set-profiles (criteria &rest profiles)
634 635 636 637
  "Add PROFILES for CRITERIA.
CRITERIA is a plist identifying a connection and the application
using this connection, see `connection-local-criteria-alist'.
PROFILES are the names of connection profiles (a symbol).
638 639

When a connection to a remote server is opened and CRITERIA
640 641 642 643 644
matches to that server, the connection-local variables from
PROFILES are applied to the corresponding process buffer.  The
variables for a connection profile are defined using
`connection-local-set-profile-variables'."
  (unless (listp criteria)
645
    (error "Wrong criteria `%s'" criteria))
646 647 648
  (dolist (profile profiles)
    (unless (assq profile connection-local-profile-alist)
      (error "No such connection profile `%s'" (symbol-name profile))))
Michael Albinus's avatar
Michael Albinus committed
649
  (let* ((criteria (connection-local-normalize-criteria criteria))
650
         (slot (assoc criteria connection-local-criteria-alist)))
651
    (if slot
652
        (setcdr slot (delete-dups (append (cdr slot) profiles)))
653
      (setq connection-local-criteria-alist
654
            (cons (cons criteria (delete-dups profiles))
655 656
		  connection-local-criteria-alist)))))

657 658 659
(defsubst connection-local-get-profile-variables (profile)
  "Return the connection-local variable list for PROFILE."
  (cdr (assq profile connection-local-profile-alist)))
660 661

;;;###autoload
662 663
(defun connection-local-set-profile-variables (profile variables)
  "Map the symbol PROFILE to a list of variable settings.
664
VARIABLES is a list that declares connection-local variables for
665 666
the connection profile.  An element in VARIABLES is an alist
whose elements are of the form (VAR . VALUE).
667 668

When a connection to a remote server is opened, the server's
669
connection profiles are found.  A server may be assigned a
670
connection profile using `connection-local-set-profiles'.  Then
671 672 673 674 675 676 677 678 679
variables are set in the server's process buffer according to the
VARIABLES list of the connection profile.  The list is processed
in order."
  (setf (alist-get profile connection-local-profile-alist) variables))

(defun hack-connection-local-variables (criteria)
  "Read connection-local variables according to CRITERIA.
Store the connection-local variables in buffer local
variable`connection-local-variables-alist'.
680 681

This does nothing if `enable-connection-local-variables' is nil."
682 683 684 685 686 687
  (when enable-connection-local-variables
    ;; Filter connection profiles.
    (dolist (profile (connection-local-get-profiles criteria))
      ;; Loop over variables.
      (dolist (variable (connection-local-get-profile-variables profile))
        (unless (assq (car variable) connection-local-variables-alist)
688
          (push variable connection-local-variables-alist))))
Michael Albinus's avatar
Michael Albinus committed
689 690 691
    ;; Push them to `file-local-variables-alist'.  Connection-local
    ;; variables do not appear from external files.  So we can regard
    ;; them as safe.
692
    (let ((enable-local-variables :all))
Michael Albinus's avatar
Michael Albinus committed
693
      (hack-local-variables-filter connection-local-variables-alist nil))))
694 695

;;;###autoload
696 697
(defun hack-connection-local-variables-apply (criteria)
 "Apply connection-local variables identified by CRITERIA.
698 699
Other local variables, like file-local and dir-local variables,
will not be changed."
700
 (hack-connection-local-variables criteria)
701 702 703 704
 (let ((file-local-variables-alist
        (copy-tree connection-local-variables-alist)))
   (hack-local-variables-apply)))

705 706 707 708 709 710 711 712
(defsubst connection-local-criteria-for-default-directory ()
  "Return a connection-local criteria, which represents `default-directory'."
  (when (file-remote-p default-directory)
    `(:application tramp
       :protocol ,(file-remote-p default-directory 'method)
       :user     ,(file-remote-p default-directory 'user)
       :machine  ,(file-remote-p default-directory 'host))))

713
;;;###autoload
714 715
(defmacro with-connection-local-variables (&rest body)
  "Apply connection-local variables according to `default-directory'.
716
Execute BODY, and unwind connection-local variables."
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
  (declare (debug t))
  `(if (file-remote-p default-directory)
       (let ((enable-connection-local-variables t)
             (old-buffer-local-variables (buffer-local-variables))
	     connection-local-variables-alist)
	 (hack-connection-local-variables-apply
	  (connection-local-criteria-for-default-directory))
	 (unwind-protect
             (progn ,@body)
	   ;; Cleanup.
	   (dolist (variable connection-local-variables-alist)
	     (let ((elt (assq (car variable) old-buffer-local-variables)))
	       (if elt
		   (set (make-local-variable (car elt)) (cdr elt))
		 (kill-local-variable (car variable)))))))
     ;; No connection-local variables to apply.
     ,@body))
734

Juri Linkov's avatar
Juri Linkov committed
735 736 737


(provide 'files-x)
Miles Bader's avatar
Miles Bader committed
738

Juri Linkov's avatar
Juri Linkov committed
739
;;; files-x.el ends here