| 1 | ;;; files.el --- file input and output commands for Emacs |
| 2 | |
| 3 | ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996, |
| 4 | ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, |
| 5 | ;; 2006, 2007 Free Software Foundation, Inc. |
| 6 | |
| 7 | ;; Maintainer: FSF |
| 8 | |
| 9 | ;; This file is part of GNU Emacs. |
| 10 | |
| 11 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
| 12 | ;; it under the terms of the GNU General Public License as published by |
| 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
| 14 | ;; any later version. |
| 15 | |
| 16 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 19 | ;; GNU General Public License for more details. |
| 20 | |
| 21 | ;; You should have received a copy of the GNU General Public License |
| 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
| 23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| 24 | ;; Boston, MA 02110-1301, USA. |
| 25 | |
| 26 | ;;; Commentary: |
| 27 | |
| 28 | ;; Defines most of Emacs's file- and directory-handling functions, |
| 29 | ;; including basic file visiting, backup generation, link handling, |
| 30 | ;; ITS-id version control, load- and write-hook handling, and the like. |
| 31 | |
| 32 | ;;; Code: |
| 33 | |
| 34 | (defvar font-lock-keywords) |
| 35 | |
| 36 | |
| 37 | (defgroup backup nil |
| 38 | "Backups of edited data files." |
| 39 | :group 'files) |
| 40 | |
| 41 | (defgroup find-file nil |
| 42 | "Finding files." |
| 43 | :group 'files) |
| 44 | |
| 45 | |
| 46 | (defcustom delete-auto-save-files t |
| 47 | "Non-nil means delete auto-save file when a buffer is saved or killed. |
| 48 | |
| 49 | Note that the auto-save file will not be deleted if the buffer is killed |
| 50 | when it has unsaved changes." |
| 51 | :type 'boolean |
| 52 | :group 'auto-save) |
| 53 | |
| 54 | (defcustom directory-abbrev-alist |
| 55 | nil |
| 56 | "Alist of abbreviations for file directories. |
| 57 | A list of elements of the form (FROM . TO), each meaning to replace |
| 58 | FROM with TO when it appears in a directory name. This replacement is |
| 59 | done when setting up the default directory of a newly visited file. |
| 60 | *Every* FROM string should start with `^'. |
| 61 | |
| 62 | FROM and TO should be equivalent names, which refer to the |
| 63 | same directory. Do not use `~' in the TO strings; |
| 64 | they should be ordinary absolute directory names. |
| 65 | |
| 66 | Use this feature when you have directories which you normally refer to |
| 67 | via absolute symbolic links. Make TO the name of the link, and FROM |
| 68 | the name it is linked to." |
| 69 | :type '(repeat (cons :format "%v" |
| 70 | :value ("" . "") |
| 71 | (regexp :tag "From") |
| 72 | (regexp :tag "To"))) |
| 73 | :group 'abbrev |
| 74 | :group 'find-file) |
| 75 | |
| 76 | ;; Turn off backup files on VMS since it has version numbers. |
| 77 | (defcustom make-backup-files (not (eq system-type 'vax-vms)) |
| 78 | "Non-nil means make a backup of a file the first time it is saved. |
| 79 | This can be done by renaming the file or by copying. |
| 80 | |
| 81 | Renaming means that Emacs renames the existing file so that it is a |
| 82 | backup file, then writes the buffer into a new file. Any other names |
| 83 | that the old file had will now refer to the backup file. The new file |
| 84 | is owned by you and its group is defaulted. |
| 85 | |
| 86 | Copying means that Emacs copies the existing file into the backup |
| 87 | file, then writes the buffer on top of the existing file. Any other |
| 88 | names that the old file had will now refer to the new (edited) file. |
| 89 | The file's owner and group are unchanged. |
| 90 | |
| 91 | The choice of renaming or copying is controlled by the variables |
| 92 | `backup-by-copying', `backup-by-copying-when-linked', |
| 93 | `backup-by-copying-when-mismatch' and |
| 94 | `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'." |
| 95 | :type 'boolean |
| 96 | :group 'backup) |
| 97 | |
| 98 | ;; Do this so that local variables based on the file name |
| 99 | ;; are not overridden by the major mode. |
| 100 | (defvar backup-inhibited nil |
| 101 | "Non-nil means don't make a backup, regardless of the other parameters. |
| 102 | This variable is intended for use by making it local to a buffer. |
| 103 | But it is local only if you make it local.") |
| 104 | (put 'backup-inhibited 'permanent-local t) |
| 105 | |
| 106 | (defcustom backup-by-copying nil |
| 107 | "Non-nil means always use copying to create backup files. |
| 108 | See documentation of variable `make-backup-files'." |
| 109 | :type 'boolean |
| 110 | :group 'backup) |
| 111 | |
| 112 | (defcustom backup-by-copying-when-linked nil |
| 113 | "Non-nil means use copying to create backups for files with multiple names. |
| 114 | This causes the alternate names to refer to the latest version as edited. |
| 115 | This variable is relevant only if `backup-by-copying' is nil." |
| 116 | :type 'boolean |
| 117 | :group 'backup) |
| 118 | |
| 119 | (defcustom backup-by-copying-when-mismatch nil |
| 120 | "Non-nil means create backups by copying if this preserves owner or group. |
| 121 | Renaming may still be used (subject to control of other variables) |
| 122 | when it would not result in changing the owner or group of the file; |
| 123 | that is, for files which are owned by you and whose group matches |
| 124 | the default for a new file created there by you. |
| 125 | This variable is relevant only if `backup-by-copying' is nil." |
| 126 | :type 'boolean |
| 127 | :group 'backup) |
| 128 | |
| 129 | (defcustom backup-by-copying-when-privileged-mismatch 200 |
| 130 | "Non-nil means create backups by copying to preserve a privileged owner. |
| 131 | Renaming may still be used (subject to control of other variables) |
| 132 | when it would not result in changing the owner of the file or if the owner |
| 133 | has a user id greater than the value of this variable. This is useful |
| 134 | when low-numbered uid's are used for special system users (such as root) |
| 135 | that must maintain ownership of certain files. |
| 136 | This variable is relevant only if `backup-by-copying' and |
| 137 | `backup-by-copying-when-mismatch' are nil." |
| 138 | :type '(choice (const nil) integer) |
| 139 | :group 'backup) |
| 140 | |
| 141 | (defvar backup-enable-predicate 'normal-backup-enable-predicate |
| 142 | "Predicate that looks at a file name and decides whether to make backups. |
| 143 | Called with an absolute file name as argument, it returns t to enable backup.") |
| 144 | |
| 145 | (defcustom buffer-offer-save nil |
| 146 | "Non-nil in a buffer means always offer to save buffer on exit. |
| 147 | Do so even if the buffer is not visiting a file. |
| 148 | Automatically local in all buffers." |
| 149 | :type 'boolean |
| 150 | :group 'backup) |
| 151 | (make-variable-buffer-local 'buffer-offer-save) |
| 152 | |
| 153 | (defcustom find-file-existing-other-name t |
| 154 | "Non-nil means find a file under alternative names, in existing buffers. |
| 155 | This means if any existing buffer is visiting the file you want |
| 156 | under another name, you get the existing buffer instead of a new buffer." |
| 157 | :type 'boolean |
| 158 | :group 'find-file) |
| 159 | |
| 160 | (defcustom find-file-visit-truename nil |
| 161 | "*Non-nil means visit a file under its truename. |
| 162 | The truename of a file is found by chasing all links |
| 163 | both at the file level and at the levels of the containing directories." |
| 164 | :type 'boolean |
| 165 | :group 'find-file) |
| 166 | (put 'find-file-visit-truename 'safe-local-variable 'booleanp) |
| 167 | |
| 168 | (defcustom revert-without-query nil |
| 169 | "Specify which files should be reverted without query. |
| 170 | The value is a list of regular expressions. |
| 171 | If the file name matches one of these regular expressions, |
| 172 | then `revert-buffer' reverts the file without querying |
| 173 | if the file has changed on disk and you have not edited the buffer." |
| 174 | :type '(repeat regexp) |
| 175 | :group 'find-file) |
| 176 | |
| 177 | (defvar buffer-file-number nil |
| 178 | "The device number and file number of the file visited in the current buffer. |
| 179 | The value is a list of the form (FILENUM DEVNUM). |
| 180 | This pair of numbers uniquely identifies the file. |
| 181 | If the buffer is visiting a new file, the value is nil.") |
| 182 | (make-variable-buffer-local 'buffer-file-number) |
| 183 | (put 'buffer-file-number 'permanent-local t) |
| 184 | |
| 185 | (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt))) |
| 186 | "Non-nil means that `buffer-file-number' uniquely identifies files.") |
| 187 | |
| 188 | (defvar buffer-file-read-only nil |
| 189 | "Non-nil if visited file was read-only when visited.") |
| 190 | (make-variable-buffer-local 'buffer-file-read-only) |
| 191 | |
| 192 | (defcustom temporary-file-directory |
| 193 | (file-name-as-directory |
| 194 | (cond ((memq system-type '(ms-dos windows-nt)) |
| 195 | (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp")) |
| 196 | ((memq system-type '(vax-vms axp-vms)) |
| 197 | (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:")) |
| 198 | (t |
| 199 | (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp")))) |
| 200 | "The directory for writing temporary files." |
| 201 | :group 'files |
| 202 | :type 'directory) |
| 203 | |
| 204 | (defcustom small-temporary-file-directory |
| 205 | (if (eq system-type 'ms-dos) (getenv "TMPDIR")) |
| 206 | "The directory for writing small temporary files. |
| 207 | If non-nil, this directory is used instead of `temporary-file-directory' |
| 208 | by programs that create small temporary files. This is for systems that |
| 209 | have fast storage with limited space, such as a RAM disk." |
| 210 | :group 'files |
| 211 | :type '(choice (const nil) directory)) |
| 212 | |
| 213 | ;; The system null device. (Should reference NULL_DEVICE from C.) |
| 214 | (defvar null-device "/dev/null" "The system null device.") |
| 215 | |
| 216 | (declare-function msdos-long-file-names "msdos.c") |
| 217 | (declare-function w32-long-file-name "w32proc.c") |
| 218 | (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep)) |
| 219 | (declare-function dired-unmark "dired" (arg)) |
| 220 | (declare-function dired-do-flagged-delete "dired" (&optional nomessage)) |
| 221 | (declare-function dos-8+3-filename "dos-fns" (filename)) |
| 222 | (declare-function vms-read-directory "vms-patch" (dirname switches buffer)) |
| 223 | (declare-function view-mode-disable "view" ()) |
| 224 | |
| 225 | (defvar file-name-invalid-regexp |
| 226 | (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names))) |
| 227 | (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive |
| 228 | "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters |
| 229 | "[\000-\031]\\|" ; control characters |
| 230 | "\\(/\\.\\.?[^/]\\)\\|" ; leading dots |
| 231 | "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot |
| 232 | ((memq system-type '(ms-dos windows-nt cygwin)) |
| 233 | (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive |
| 234 | "[|<>\"?*\000-\031]")) ; invalid characters |
| 235 | (t "[\000]")) |
| 236 | "Regexp recognizing file names which aren't allowed by the filesystem.") |
| 237 | |
| 238 | (defcustom file-precious-flag nil |
| 239 | "Non-nil means protect against I/O errors while saving files. |
| 240 | Some modes set this non-nil in particular buffers. |
| 241 | |
| 242 | This feature works by writing the new contents into a temporary file |
| 243 | and then renaming the temporary file to replace the original. |
| 244 | In this way, any I/O error in writing leaves the original untouched, |
| 245 | and there is never any instant where the file is nonexistent. |
| 246 | |
| 247 | Note that this feature forces backups to be made by copying. |
| 248 | Yet, at the same time, saving a precious file |
| 249 | breaks any hard links between it and other files." |
| 250 | :type 'boolean |
| 251 | :group 'backup) |
| 252 | |
| 253 | (defcustom version-control nil |
| 254 | "Control use of version numbers for backup files. |
| 255 | When t, make numeric backup versions unconditionally. |
| 256 | When nil, make them for files that have some already. |
| 257 | The value `never' means do not make them." |
| 258 | :type '(choice (const :tag "Never" never) |
| 259 | (const :tag "If existing" nil) |
| 260 | (other :tag "Always" t)) |
| 261 | :group 'backup |
| 262 | :group 'vc) |
| 263 | (put 'version-control 'safe-local-variable |
| 264 | '(lambda (x) (or (booleanp x) (equal x 'never)))) |
| 265 | |
| 266 | (defcustom dired-kept-versions 2 |
| 267 | "When cleaning directory, number of versions to keep." |
| 268 | :type 'integer |
| 269 | :group 'backup |
| 270 | :group 'dired) |
| 271 | |
| 272 | (defcustom delete-old-versions nil |
| 273 | "If t, delete excess backup versions silently. |
| 274 | If nil, ask confirmation. Any other value prevents any trimming." |
| 275 | :type '(choice (const :tag "Delete" t) |
| 276 | (const :tag "Ask" nil) |
| 277 | (other :tag "Leave" other)) |
| 278 | :group 'backup) |
| 279 | |
| 280 | (defcustom kept-old-versions 2 |
| 281 | "Number of oldest versions to keep when a new numbered backup is made." |
| 282 | :type 'integer |
| 283 | :group 'backup) |
| 284 | (put 'kept-old-versions 'safe-local-variable 'integerp) |
| 285 | |
| 286 | (defcustom kept-new-versions 2 |
| 287 | "Number of newest versions to keep when a new numbered backup is made. |
| 288 | Includes the new backup. Must be > 0" |
| 289 | :type 'integer |
| 290 | :group 'backup) |
| 291 | (put 'kept-new-versions 'safe-local-variable 'integerp) |
| 292 | |
| 293 | (defcustom require-final-newline nil |
| 294 | "Whether to add a newline automatically at the end of the file. |
| 295 | |
| 296 | A value of t means do this only when the file is about to be saved. |
| 297 | A value of `visit' means do this right after the file is visited. |
| 298 | A value of `visit-save' means do it at both of those times. |
| 299 | Any other non-nil value means ask user whether to add a newline, when saving. |
| 300 | A value of nil means don't add newlines. |
| 301 | |
| 302 | Certain major modes set this locally to the value obtained |
| 303 | from `mode-require-final-newline'." |
| 304 | :type '(choice (const :tag "When visiting" visit) |
| 305 | (const :tag "When saving" t) |
| 306 | (const :tag "When visiting or saving" visit-save) |
| 307 | (const :tag "Don't add newlines" nil) |
| 308 | (other :tag "Ask each time" ask)) |
| 309 | :group 'editing-basics) |
| 310 | |
| 311 | (defcustom mode-require-final-newline t |
| 312 | "Whether to add a newline at end of file, in certain major modes. |
| 313 | Those modes set `require-final-newline' to this value when you enable them. |
| 314 | They do so because they are often used for files that are supposed |
| 315 | to end in newlines, and the question is how to arrange that. |
| 316 | |
| 317 | A value of t means do this only when the file is about to be saved. |
| 318 | A value of `visit' means do this right after the file is visited. |
| 319 | A value of `visit-save' means do it at both of those times. |
| 320 | Any other non-nil value means ask user whether to add a newline, when saving. |
| 321 | |
| 322 | A value of nil means do not add newlines. That is a risky choice in this |
| 323 | variable since this value is used for modes for files that ought to have |
| 324 | final newlines. So if you set this to nil, you must explicitly check and |
| 325 | add a final newline, whenever you save a file that really needs one." |
| 326 | :type '(choice (const :tag "When visiting" visit) |
| 327 | (const :tag "When saving" t) |
| 328 | (const :tag "When visiting or saving" visit-save) |
| 329 | (const :tag "Don't add newlines" nil) |
| 330 | (other :tag "Ask each time" ask)) |
| 331 | :group 'editing-basics |
| 332 | :version "22.1") |
| 333 | |
| 334 | (defcustom auto-save-default t |
| 335 | "Non-nil says by default do auto-saving of every file-visiting buffer." |
| 336 | :type 'boolean |
| 337 | :group 'auto-save) |
| 338 | |
| 339 | (defcustom auto-save-visited-file-name nil |
| 340 | "Non-nil says auto-save a buffer in the file it is visiting, when practical. |
| 341 | Normally auto-save files are written under other names." |
| 342 | :type 'boolean |
| 343 | :group 'auto-save) |
| 344 | |
| 345 | (defcustom auto-save-file-name-transforms |
| 346 | `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'" |
| 347 | ;; Don't put "\\2" inside expand-file-name, since it will be |
| 348 | ;; transformed to "/2" on DOS/Windows. |
| 349 | ,(concat temporary-file-directory "\\2") t)) |
| 350 | "Transforms to apply to buffer file name before making auto-save file name. |
| 351 | Each transform is a list (REGEXP REPLACEMENT UNIQUIFY): |
| 352 | REGEXP is a regular expression to match against the file name. |
| 353 | If it matches, `replace-match' is used to replace the |
| 354 | matching part with REPLACEMENT. |
| 355 | If the optional element UNIQUIFY is non-nil, the auto-save file name is |
| 356 | constructed by taking the directory part of the replaced file-name, |
| 357 | concatenated with the buffer file name with all directory separators |
| 358 | changed to `!' to prevent clashes. This will not work |
| 359 | correctly if your filesystem truncates the resulting name. |
| 360 | |
| 361 | All the transforms in the list are tried, in the order they are listed. |
| 362 | When one transform applies, its result is final; |
| 363 | no further transforms are tried. |
| 364 | |
| 365 | The default value is set up to put the auto-save file into the |
| 366 | temporary directory (see the variable `temporary-file-directory') for |
| 367 | editing a remote file. |
| 368 | |
| 369 | On MS-DOS filesystems without long names this variable is always |
| 370 | ignored." |
| 371 | :group 'auto-save |
| 372 | :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement") |
| 373 | (boolean :tag "Uniquify"))) |
| 374 | :version "21.1") |
| 375 | |
| 376 | (defcustom save-abbrevs t |
| 377 | "Non-nil means save word abbrevs too when files are saved. |
| 378 | If `silently', don't ask the user before saving." |
| 379 | :type '(choice (const t) (const nil) (const silently)) |
| 380 | :group 'abbrev) |
| 381 | |
| 382 | (defcustom find-file-run-dired t |
| 383 | "Non-nil means allow `find-file' to visit directories. |
| 384 | To visit the directory, `find-file' runs `find-directory-functions'." |
| 385 | :type 'boolean |
| 386 | :group 'find-file) |
| 387 | |
| 388 | (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect) |
| 389 | "List of functions to try in sequence to visit a directory. |
| 390 | Each function is called with the directory name as the sole argument |
| 391 | and should return either a buffer or nil." |
| 392 | :type '(hook :options (cvs-dired-noselect dired-noselect)) |
| 393 | :group 'find-file) |
| 394 | |
| 395 | ;;;It is not useful to make this a local variable. |
| 396 | ;;;(put 'find-file-not-found-hooks 'permanent-local t) |
| 397 | (defvar find-file-not-found-functions nil |
| 398 | "List of functions to be called for `find-file' on nonexistent file. |
| 399 | These functions are called as soon as the error is detected. |
| 400 | Variable `buffer-file-name' is already set up. |
| 401 | The functions are called in the order given until one of them returns non-nil.") |
| 402 | (define-obsolete-variable-alias 'find-file-not-found-hooks |
| 403 | 'find-file-not-found-functions "22.1") |
| 404 | |
| 405 | ;;;It is not useful to make this a local variable. |
| 406 | ;;;(put 'find-file-hooks 'permanent-local t) |
| 407 | (defcustom find-file-hook nil |
| 408 | "List of functions to be called after a buffer is loaded from a file. |
| 409 | The buffer's local variables (if any) will have been processed before the |
| 410 | functions are called." |
| 411 | :group 'find-file |
| 412 | :type 'hook |
| 413 | :options '(auto-insert) |
| 414 | :version "22.1") |
| 415 | (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1") |
| 416 | |
| 417 | (defvar write-file-functions nil |
| 418 | "List of functions to be called before writing out a buffer to a file. |
| 419 | If one of them returns non-nil, the file is considered already written |
| 420 | and the rest are not called. |
| 421 | These hooks are considered to pertain to the visited file. |
| 422 | So any buffer-local binding of this variable is discarded if you change |
| 423 | the visited file name with \\[set-visited-file-name], but not when you |
| 424 | change the major mode. |
| 425 | |
| 426 | This hook is not run if any of the functions in |
| 427 | `write-contents-functions' returns non-nil. Both hooks pertain |
| 428 | to how to save a buffer to file, for instance, choosing a suitable |
| 429 | coding system and setting mode bits. (See Info |
| 430 | node `(elisp)Saving Buffers'.) To perform various checks or |
| 431 | updates before the buffer is saved, use `before-save-hook'.") |
| 432 | (put 'write-file-functions 'permanent-local t) |
| 433 | (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1") |
| 434 | |
| 435 | (defvar local-write-file-hooks nil) |
| 436 | (make-variable-buffer-local 'local-write-file-hooks) |
| 437 | (put 'local-write-file-hooks 'permanent-local t) |
| 438 | (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1") |
| 439 | |
| 440 | (defvar write-contents-functions nil |
| 441 | "List of functions to be called before writing out a buffer to a file. |
| 442 | If one of them returns non-nil, the file is considered already written |
| 443 | and the rest are not called and neither are the functions in |
| 444 | `write-file-functions'. |
| 445 | |
| 446 | This variable is meant to be used for hooks that pertain to the |
| 447 | buffer's contents, not to the particular visited file; thus, |
| 448 | `set-visited-file-name' does not clear this variable; but changing the |
| 449 | major mode does clear it. |
| 450 | |
| 451 | For hooks that _do_ pertain to the particular visited file, use |
| 452 | `write-file-functions'. Both this variable and |
| 453 | `write-file-functions' relate to how a buffer is saved to file. |
| 454 | To perform various checks or updates before the buffer is saved, |
| 455 | use `before-save-hook'.") |
| 456 | (make-variable-buffer-local 'write-contents-functions) |
| 457 | (define-obsolete-variable-alias 'write-contents-hooks |
| 458 | 'write-contents-functions "22.1") |
| 459 | |
| 460 | (defcustom enable-local-variables t |
| 461 | "Control use of local variables in files you visit. |
| 462 | The value can be t, nil, :safe, :all, or something else. |
| 463 | |
| 464 | A value of t means file local variables specifications are obeyed |
| 465 | if all the specified variable values are safe; if any values are |
| 466 | not safe, Emacs queries you, once, whether to set them all. |
| 467 | \(When you say yes to certain values, they are remembered as safe.) |
| 468 | |
| 469 | :safe means set the safe variables, and ignore the rest. |
| 470 | :all means set all variables, whether safe or not. |
| 471 | (Don't set it permanently to :all.) |
| 472 | A value of nil means always ignore the file local variables. |
| 473 | |
| 474 | Any other value means always query you once whether to set them all. |
| 475 | \(When you say yes to certain values, they are remembered as safe, but |
| 476 | this has no effect when `enable-local-variables' is \"something else\".) |
| 477 | |
| 478 | This variable also controls use of major modes specified in |
| 479 | a -*- line. |
| 480 | |
| 481 | The command \\[normal-mode], when used interactively, |
| 482 | always obeys file local variable specifications and the -*- line, |
| 483 | and ignores this variable." |
| 484 | :type '(choice (const :tag "Query Unsafe" t) |
| 485 | (const :tag "Safe Only" :safe) |
| 486 | (const :tag "Do all" :all) |
| 487 | (const :tag "Ignore" nil) |
| 488 | (other :tag "Query" other)) |
| 489 | :group 'find-file) |
| 490 | |
| 491 | (defvar local-enable-local-variables t |
| 492 | "Like `enable-local-variables' but meant for buffer-local bindings. |
| 493 | The meaningful values are nil and non-nil. The default is non-nil. |
| 494 | If a major mode sets this to nil, buffer-locally, then any local |
| 495 | variables list in the file will be ignored. |
| 496 | |
| 497 | This variable does not affect the use of major modes |
| 498 | specified in a -*- line.") |
| 499 | |
| 500 | (defcustom enable-local-eval 'maybe |
| 501 | "Control processing of the \"variable\" `eval' in a file's local variables. |
| 502 | The value can be t, nil or something else. |
| 503 | A value of t means obey `eval' variables; |
| 504 | A value of nil means ignore them; anything else means query." |
| 505 | :type '(choice (const :tag "Obey" t) |
| 506 | (const :tag "Ignore" nil) |
| 507 | (other :tag "Query" other)) |
| 508 | :group 'find-file) |
| 509 | |
| 510 | ;; Avoid losing in versions where CLASH_DETECTION is disabled. |
| 511 | (or (fboundp 'lock-buffer) |
| 512 | (defalias 'lock-buffer 'ignore)) |
| 513 | (or (fboundp 'unlock-buffer) |
| 514 | (defalias 'unlock-buffer 'ignore)) |
| 515 | (or (fboundp 'file-locked-p) |
| 516 | (defalias 'file-locked-p 'ignore)) |
| 517 | |
| 518 | (defcustom view-read-only nil |
| 519 | "Non-nil means buffers visiting files read-only do so in view mode. |
| 520 | In fact, this means that all read-only buffers normally have |
| 521 | View mode enabled, including buffers that are read-only because |
| 522 | you visit a file you cannot alter, and buffers you make read-only |
| 523 | using \\[toggle-read-only]." |
| 524 | :type 'boolean |
| 525 | :group 'view) |
| 526 | |
| 527 | (defvar file-name-history nil |
| 528 | "History list of file names entered in the minibuffer. |
| 529 | |
| 530 | Maximum length of the history list is determined by the value |
| 531 | of `history-length', which see.") |
| 532 | \f |
| 533 | (put 'ange-ftp-completion-hook-function 'safe-magic t) |
| 534 | (defun ange-ftp-completion-hook-function (op &rest args) |
| 535 | "Provides support for ange-ftp host name completion. |
| 536 | Runs the usual ange-ftp hook, but only for completion operations." |
| 537 | ;; Having this here avoids the need to load ange-ftp when it's not |
| 538 | ;; really in use. |
| 539 | (if (memq op '(file-name-completion file-name-all-completions)) |
| 540 | (apply 'ange-ftp-hook-function op args) |
| 541 | (let ((inhibit-file-name-handlers |
| 542 | (cons 'ange-ftp-completion-hook-function |
| 543 | (and (eq inhibit-file-name-operation op) |
| 544 | inhibit-file-name-handlers))) |
| 545 | (inhibit-file-name-operation op)) |
| 546 | (apply op args)))) |
| 547 | |
| 548 | (defun convert-standard-filename (filename) |
| 549 | "Convert a standard file's name to something suitable for the OS. |
| 550 | This means to guarantee valid names and perhaps to canonicalize |
| 551 | certain patterns. |
| 552 | |
| 553 | FILENAME should be an absolute file name since the conversion rules |
| 554 | sometimes vary depending on the position in the file name. E.g. c:/foo |
| 555 | is a valid DOS file name, but c:/bar/c:/foo is not. |
| 556 | |
| 557 | This function's standard definition is trivial; it just returns |
| 558 | the argument. However, on Windows and DOS, replace invalid |
| 559 | characters. On DOS, make sure to obey the 8.3 limitations. |
| 560 | In the native Windows build, turn Cygwin names into native names, |
| 561 | and also turn slashes into backslashes if the shell requires it (see |
| 562 | `w32-shell-dos-semantics'). |
| 563 | |
| 564 | See Info node `(elisp)Standard File Names' for more details." |
| 565 | (if (eq system-type 'cygwin) |
| 566 | (let ((name (copy-sequence filename)) |
| 567 | (start 0)) |
| 568 | ;; Replace invalid filename characters with ! |
| 569 | (while (string-match "[?*:<>|\"\000-\037]" name start) |
| 570 | (aset name (match-beginning 0) ?!) |
| 571 | (setq start (match-end 0))) |
| 572 | name) |
| 573 | filename)) |
| 574 | |
| 575 | (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial) |
| 576 | "Read directory name, prompting with PROMPT and completing in directory DIR. |
| 577 | Value is not expanded---you must call `expand-file-name' yourself. |
| 578 | Default name to DEFAULT-DIRNAME if user exits with the same |
| 579 | non-empty string that was inserted by this function. |
| 580 | (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used, |
| 581 | or just DIR if INITIAL is nil.) |
| 582 | If the user exits with an empty minibuffer, this function returns |
| 583 | an empty string. (This can only happen if the user erased the |
| 584 | pre-inserted contents or if `insert-default-directory' is nil.) |
| 585 | Fourth arg MUSTMATCH non-nil means require existing directory's name. |
| 586 | Non-nil and non-t means also require confirmation after completion. |
| 587 | Fifth arg INITIAL specifies text to start with. |
| 588 | DIR should be an absolute directory name. It defaults to |
| 589 | the value of `default-directory'." |
| 590 | (unless dir |
| 591 | (setq dir default-directory)) |
| 592 | (read-file-name prompt dir (or default-dirname |
| 593 | (if initial (expand-file-name initial dir) |
| 594 | dir)) |
| 595 | mustmatch initial |
| 596 | 'file-directory-p)) |
| 597 | |
| 598 | \f |
| 599 | (defun pwd () |
| 600 | "Show the current default directory." |
| 601 | (interactive nil) |
| 602 | (message "Directory %s" default-directory)) |
| 603 | |
| 604 | (defvar cd-path nil |
| 605 | "Value of the CDPATH environment variable, as a list. |
| 606 | Not actually set up until the first time you use it.") |
| 607 | |
| 608 | (defun parse-colon-path (cd-path) |
| 609 | "Explode a search path into a list of directory names. |
| 610 | Directories are separated by occurrences of `path-separator' |
| 611 | \(which is colon in GNU and GNU-like systems)." |
| 612 | ;; We could use split-string here. |
| 613 | (and cd-path |
| 614 | (let (cd-list (cd-start 0) cd-colon) |
| 615 | (setq cd-path (concat cd-path path-separator)) |
| 616 | (while (setq cd-colon (string-match path-separator cd-path cd-start)) |
| 617 | (setq cd-list |
| 618 | (nconc cd-list |
| 619 | (list (if (= cd-start cd-colon) |
| 620 | nil |
| 621 | (substitute-in-file-name |
| 622 | (file-name-as-directory |
| 623 | (substring cd-path cd-start cd-colon))))))) |
| 624 | (setq cd-start (+ cd-colon 1))) |
| 625 | cd-list))) |
| 626 | |
| 627 | (defun cd-absolute (dir) |
| 628 | "Change current directory to given absolute file name DIR." |
| 629 | ;; Put the name into directory syntax now, |
| 630 | ;; because otherwise expand-file-name may give some bad results. |
| 631 | (if (not (eq system-type 'vax-vms)) |
| 632 | (setq dir (file-name-as-directory dir))) |
| 633 | (setq dir (abbreviate-file-name (expand-file-name dir))) |
| 634 | (if (not (file-directory-p dir)) |
| 635 | (if (file-exists-p dir) |
| 636 | (error "%s is not a directory" dir) |
| 637 | (error "%s: no such directory" dir)) |
| 638 | (if (file-executable-p dir) |
| 639 | (setq default-directory dir |
| 640 | list-buffers-directory dir) |
| 641 | (error "Cannot cd to %s: Permission denied" dir)))) |
| 642 | |
| 643 | (defun cd (dir) |
| 644 | "Make DIR become the current buffer's default directory. |
| 645 | If your environment includes a `CDPATH' variable, try each one of |
| 646 | that list of directories (separated by occurrences of |
| 647 | `path-separator') when resolving a relative directory name. |
| 648 | The path separator is colon in GNU and GNU-like systems." |
| 649 | (interactive |
| 650 | (list (read-directory-name "Change default directory: " |
| 651 | default-directory default-directory |
| 652 | (and (member cd-path '(nil ("./"))) |
| 653 | (null (getenv "CDPATH")))))) |
| 654 | (if (file-name-absolute-p dir) |
| 655 | (cd-absolute (expand-file-name dir)) |
| 656 | (if (null cd-path) |
| 657 | (let ((trypath (parse-colon-path (getenv "CDPATH")))) |
| 658 | (setq cd-path (or trypath (list "./"))))) |
| 659 | (if (not (catch 'found |
| 660 | (mapc |
| 661 | (function (lambda (x) |
| 662 | (let ((f (expand-file-name (concat x dir)))) |
| 663 | (if (file-directory-p f) |
| 664 | (progn |
| 665 | (cd-absolute f) |
| 666 | (throw 'found t)))))) |
| 667 | cd-path) |
| 668 | nil)) |
| 669 | (error "No such directory found via CDPATH environment variable")))) |
| 670 | |
| 671 | (defun load-file (file) |
| 672 | "Load the Lisp file named FILE." |
| 673 | ;; This is a case where .elc makes a lot of sense. |
| 674 | (interactive (list (let ((completion-ignored-extensions |
| 675 | (remove ".elc" completion-ignored-extensions))) |
| 676 | (read-file-name "Load file: ")))) |
| 677 | (load (expand-file-name file) nil nil t)) |
| 678 | |
| 679 | (defun locate-file (filename path &optional suffixes predicate) |
| 680 | "Search for FILENAME through PATH. |
| 681 | If found, return the absolute file name of FILENAME, with its suffixes; |
| 682 | otherwise return nil. |
| 683 | PATH should be a list of directories to look in, like the lists in |
| 684 | `exec-path' or `load-path'. |
| 685 | If SUFFIXES is non-nil, it should be a list of suffixes to append to |
| 686 | file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\"). |
| 687 | Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES. |
| 688 | If non-nil, PREDICATE is used instead of `file-readable-p'. |
| 689 | PREDICATE can also be an integer to pass to the `access' system call, |
| 690 | in which case file-name handlers are ignored. This usage is deprecated. |
| 691 | |
| 692 | For compatibility, PREDICATE can also be one of the symbols |
| 693 | `executable', `readable', `writable', or `exists', or a list of |
| 694 | one or more of those symbols." |
| 695 | (if (and predicate (symbolp predicate) (not (functionp predicate))) |
| 696 | (setq predicate (list predicate))) |
| 697 | (when (and (consp predicate) (not (functionp predicate))) |
| 698 | (setq predicate |
| 699 | (logior (if (memq 'executable predicate) 1 0) |
| 700 | (if (memq 'writable predicate) 2 0) |
| 701 | (if (memq 'readable predicate) 4 0)))) |
| 702 | (locate-file-internal filename path suffixes predicate)) |
| 703 | |
| 704 | (defun locate-file-completion (string path-and-suffixes action) |
| 705 | "Do completion for file names passed to `locate-file'. |
| 706 | PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)." |
| 707 | (if (file-name-absolute-p string) |
| 708 | (read-file-name-internal string nil action) |
| 709 | (let ((names nil) |
| 710 | (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'")) |
| 711 | (string-dir (file-name-directory string))) |
| 712 | (dolist (dir (car path-and-suffixes)) |
| 713 | (unless dir |
| 714 | (setq dir default-directory)) |
| 715 | (if string-dir (setq dir (expand-file-name string-dir dir))) |
| 716 | (when (file-directory-p dir) |
| 717 | (dolist (file (file-name-all-completions |
| 718 | (file-name-nondirectory string) dir)) |
| 719 | (add-to-list 'names (if string-dir (concat string-dir file) file)) |
| 720 | (when (string-match suffix file) |
| 721 | (setq file (substring file 0 (match-beginning 0))) |
| 722 | (push (if string-dir (concat string-dir file) file) names))))) |
| 723 | (cond |
| 724 | ((eq action t) (all-completions string names)) |
| 725 | ((null action) (try-completion string names)) |
| 726 | (t (test-completion string names)))))) |
| 727 | |
| 728 | (defun locate-dominating-file (file regexp) |
| 729 | "Look up the directory hierarchy from FILE for a file matching REGEXP." |
| 730 | (while (and file (not (file-directory-p file))) |
| 731 | (setq file (file-name-directory (directory-file-name file)))) |
| 732 | (catch 'found |
| 733 | (let ((user (nth 2 (file-attributes file))) |
| 734 | ;; Abbreviate, so as to stop when we cross ~/. |
| 735 | (dir (abbreviate-file-name (file-name-as-directory file))) |
| 736 | files) |
| 737 | ;; As a heuristic, we stop looking up the hierarchy of directories as |
| 738 | ;; soon as we find a directory belonging to another user. This should |
| 739 | ;; save us from looking in things like /net and /afs. This assumes |
| 740 | ;; that all the files inside a project belong to the same user. |
| 741 | (while (and dir (equal user (nth 2 (file-attributes dir)))) |
| 742 | (if (setq files (directory-files dir 'full regexp)) |
| 743 | (throw 'found (car files)) |
| 744 | (if (equal dir |
| 745 | (setq dir (file-name-directory |
| 746 | (directory-file-name dir)))) |
| 747 | (setq dir nil)))) |
| 748 | nil))) |
| 749 | |
| 750 | (defun executable-find (command) |
| 751 | "Search for COMMAND in `exec-path' and return the absolute file name. |
| 752 | Return nil if COMMAND is not found anywhere in `exec-path'." |
| 753 | ;; Use 1 rather than file-executable-p to better match the behavior of |
| 754 | ;; call-process. |
| 755 | (locate-file command exec-path exec-suffixes 1)) |
| 756 | |
| 757 | (defun load-library (library) |
| 758 | "Load the library named LIBRARY. |
| 759 | This is an interface to the function `load'." |
| 760 | (interactive |
| 761 | (list (completing-read "Load library: " |
| 762 | 'locate-file-completion |
| 763 | (cons load-path (get-load-suffixes))))) |
| 764 | (load library)) |
| 765 | |
| 766 | (defun file-remote-p (file &optional identification connected) |
| 767 | "Test whether FILE specifies a location on a remote system. |
| 768 | Return an identification of the system if the location is indeed |
| 769 | remote. The identification of the system may comprise a method |
| 770 | to access the system and its hostname, amongst other things. |
| 771 | |
| 772 | For example, the filename \"/user@host:/foo\" specifies a location |
| 773 | on the system \"/user@host:\". |
| 774 | |
| 775 | IDENTIFICATION specifies which part of the identification shall |
| 776 | be returned as string. IDENTIFICATION can be the symbol |
| 777 | `method', `user' or `host'; any other value is handled like nil |
| 778 | and means to return the complete identification string. |
| 779 | |
| 780 | If CONNECTED is non-nil, the function returns an identification only |
| 781 | if FILE is located on a remote system, and a connection is established |
| 782 | to that remote system. |
| 783 | |
| 784 | `file-remote-p' will never open a connection on its own." |
| 785 | (let ((handler (find-file-name-handler file 'file-remote-p))) |
| 786 | (if handler |
| 787 | (funcall handler 'file-remote-p file identification connected) |
| 788 | nil))) |
| 789 | |
| 790 | (defun file-local-copy (file) |
| 791 | "Copy the file FILE into a temporary file on this machine. |
| 792 | Returns the name of the local copy, or nil, if FILE is directly |
| 793 | accessible." |
| 794 | ;; This formerly had an optional BUFFER argument that wasn't used by |
| 795 | ;; anything. |
| 796 | (let ((handler (find-file-name-handler file 'file-local-copy))) |
| 797 | (if handler |
| 798 | (funcall handler 'file-local-copy file) |
| 799 | nil))) |
| 800 | |
| 801 | (defun file-truename (filename &optional counter prev-dirs) |
| 802 | "Return the truename of FILENAME, which should be absolute. |
| 803 | The truename of a file name is found by chasing symbolic links |
| 804 | both at the level of the file and at the level of the directories |
| 805 | containing it, until no links are left at any level. |
| 806 | |
| 807 | \(fn FILENAME)" ;; Don't document the optional arguments. |
| 808 | ;; COUNTER and PREV-DIRS are only used in recursive calls. |
| 809 | ;; COUNTER can be a cons cell whose car is the count of how many |
| 810 | ;; more links to chase before getting an error. |
| 811 | ;; PREV-DIRS can be a cons cell whose car is an alist |
| 812 | ;; of truenames we've just recently computed. |
| 813 | (cond ((or (string= filename "") (string= filename "~")) |
| 814 | (setq filename (expand-file-name filename)) |
| 815 | (if (string= filename "") |
| 816 | (setq filename "/"))) |
| 817 | ((and (string= (substring filename 0 1) "~") |
| 818 | (string-match "~[^/]*/?" filename)) |
| 819 | (let ((first-part |
| 820 | (substring filename 0 (match-end 0))) |
| 821 | (rest (substring filename (match-end 0)))) |
| 822 | (setq filename (concat (expand-file-name first-part) rest))))) |
| 823 | |
| 824 | (or counter (setq counter (list 100))) |
| 825 | (let (done |
| 826 | ;; For speed, remove the ange-ftp completion handler from the list. |
| 827 | ;; We know it's not needed here. |
| 828 | ;; For even more speed, do this only on the outermost call. |
| 829 | (file-name-handler-alist |
| 830 | (if prev-dirs file-name-handler-alist |
| 831 | (let ((tem (copy-sequence file-name-handler-alist))) |
| 832 | (delq (rassq 'ange-ftp-completion-hook-function tem) tem))))) |
| 833 | (or prev-dirs (setq prev-dirs (list nil))) |
| 834 | |
| 835 | ;; andrewi@harlequin.co.uk - none of the following code (except for |
| 836 | ;; invoking the file-name handler) currently applies on Windows |
| 837 | ;; (ie. there are no native symlinks), but there is an issue with |
| 838 | ;; case differences being ignored by the OS, and short "8.3 DOS" |
| 839 | ;; name aliases existing for all files. (The short names are not |
| 840 | ;; reported by directory-files, but can be used to refer to files.) |
| 841 | ;; It seems appropriate for file-truename to resolve these issues in |
| 842 | ;; the most natural way, which on Windows is to call the function |
| 843 | ;; `w32-long-file-name' - this returns the exact name of a file as |
| 844 | ;; it is stored on disk (expanding short name aliases with the full |
| 845 | ;; name in the process). |
| 846 | (if (eq system-type 'windows-nt) |
| 847 | (let ((handler (find-file-name-handler filename 'file-truename))) |
| 848 | ;; For file name that has a special handler, call handler. |
| 849 | ;; This is so that ange-ftp can save time by doing a no-op. |
| 850 | (if handler |
| 851 | (setq filename (funcall handler 'file-truename filename)) |
| 852 | ;; If filename contains a wildcard, newname will be the old name. |
| 853 | (unless (string-match "[[*?]" filename) |
| 854 | ;; If filename exists, use the long name |
| 855 | (setq filename (or (w32-long-file-name filename) filename)))) |
| 856 | (setq done t))) |
| 857 | |
| 858 | ;; If this file directly leads to a link, process that iteratively |
| 859 | ;; so that we don't use lots of stack. |
| 860 | (while (not done) |
| 861 | (setcar counter (1- (car counter))) |
| 862 | (if (< (car counter) 0) |
| 863 | (error "Apparent cycle of symbolic links for %s" filename)) |
| 864 | (let ((handler (find-file-name-handler filename 'file-truename))) |
| 865 | ;; For file name that has a special handler, call handler. |
| 866 | ;; This is so that ange-ftp can save time by doing a no-op. |
| 867 | (if handler |
| 868 | (setq filename (funcall handler 'file-truename filename) |
| 869 | done t) |
| 870 | (let ((dir (or (file-name-directory filename) default-directory)) |
| 871 | target dirfile) |
| 872 | ;; Get the truename of the directory. |
| 873 | (setq dirfile (directory-file-name dir)) |
| 874 | ;; If these are equal, we have the (or a) root directory. |
| 875 | (or (string= dir dirfile) |
| 876 | ;; If this is the same dir we last got the truename for, |
| 877 | ;; save time--don't recalculate. |
| 878 | (if (assoc dir (car prev-dirs)) |
| 879 | (setq dir (cdr (assoc dir (car prev-dirs)))) |
| 880 | (let ((old dir) |
| 881 | (new (file-name-as-directory (file-truename dirfile counter prev-dirs)))) |
| 882 | (setcar prev-dirs (cons (cons old new) (car prev-dirs))) |
| 883 | (setq dir new)))) |
| 884 | (if (equal ".." (file-name-nondirectory filename)) |
| 885 | (setq filename |
| 886 | (directory-file-name (file-name-directory (directory-file-name dir))) |
| 887 | done t) |
| 888 | (if (equal "." (file-name-nondirectory filename)) |
| 889 | (setq filename (directory-file-name dir) |
| 890 | done t) |
| 891 | ;; Put it back on the file name. |
| 892 | (setq filename (concat dir (file-name-nondirectory filename))) |
| 893 | ;; Is the file name the name of a link? |
| 894 | (setq target (file-symlink-p filename)) |
| 895 | (if target |
| 896 | ;; Yes => chase that link, then start all over |
| 897 | ;; since the link may point to a directory name that uses links. |
| 898 | ;; We can't safely use expand-file-name here |
| 899 | ;; since target might look like foo/../bar where foo |
| 900 | ;; is itself a link. Instead, we handle . and .. above. |
| 901 | (setq filename |
| 902 | (if (file-name-absolute-p target) |
| 903 | target |
| 904 | (concat dir target)) |
| 905 | done nil) |
| 906 | ;; No, we are done! |
| 907 | (setq done t)))))))) |
| 908 | filename)) |
| 909 | |
| 910 | (defun file-chase-links (filename &optional limit) |
| 911 | "Chase links in FILENAME until a name that is not a link. |
| 912 | Unlike `file-truename', this does not check whether a parent |
| 913 | directory name is a symbolic link. |
| 914 | If the optional argument LIMIT is a number, |
| 915 | it means chase no more than that many links and then stop." |
| 916 | (let (tem (newname filename) |
| 917 | (count 0)) |
| 918 | (while (and (or (null limit) (< count limit)) |
| 919 | (setq tem (file-symlink-p newname))) |
| 920 | (save-match-data |
| 921 | (if (and (null limit) (= count 100)) |
| 922 | (error "Apparent cycle of symbolic links for %s" filename)) |
| 923 | ;; In the context of a link, `//' doesn't mean what Emacs thinks. |
| 924 | (while (string-match "//+" tem) |
| 925 | (setq tem (replace-match "/" nil nil tem))) |
| 926 | ;; Handle `..' by hand, since it needs to work in the |
| 927 | ;; target of any directory symlink. |
| 928 | ;; This code is not quite complete; it does not handle |
| 929 | ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose. |
| 930 | (while (string-match "\\`\\.\\./" tem) |
| 931 | (setq tem (substring tem 3)) |
| 932 | (setq newname (expand-file-name newname)) |
| 933 | ;; Chase links in the default dir of the symlink. |
| 934 | (setq newname |
| 935 | (file-chase-links |
| 936 | (directory-file-name (file-name-directory newname)))) |
| 937 | ;; Now find the parent of that dir. |
| 938 | (setq newname (file-name-directory newname))) |
| 939 | (setq newname (expand-file-name tem (file-name-directory newname))) |
| 940 | (setq count (1+ count)))) |
| 941 | newname)) |
| 942 | |
| 943 | (defun make-temp-file (prefix &optional dir-flag suffix) |
| 944 | "Create a temporary file. |
| 945 | The returned file name (created by appending some random characters at the end |
| 946 | of PREFIX, and expanding against `temporary-file-directory' if necessary), |
| 947 | is guaranteed to point to a newly created empty file. |
| 948 | You can then use `write-region' to write new data into the file. |
| 949 | |
| 950 | If DIR-FLAG is non-nil, create a new empty directory instead of a file. |
| 951 | |
| 952 | If SUFFIX is non-nil, add that at the end of the file name." |
| 953 | (let ((umask (default-file-modes)) |
| 954 | file) |
| 955 | (unwind-protect |
| 956 | (progn |
| 957 | ;; Create temp files with strict access rights. It's easy to |
| 958 | ;; loosen them later, whereas it's impossible to close the |
| 959 | ;; time-window of loose permissions otherwise. |
| 960 | (set-default-file-modes ?\700) |
| 961 | (while (condition-case () |
| 962 | (progn |
| 963 | (setq file |
| 964 | (make-temp-name |
| 965 | (expand-file-name prefix temporary-file-directory))) |
| 966 | (if suffix |
| 967 | (setq file (concat file suffix))) |
| 968 | (if dir-flag |
| 969 | (make-directory file) |
| 970 | (write-region "" nil file nil 'silent nil 'excl)) |
| 971 | nil) |
| 972 | (file-already-exists t)) |
| 973 | ;; the file was somehow created by someone else between |
| 974 | ;; `make-temp-name' and `write-region', let's try again. |
| 975 | nil) |
| 976 | file) |
| 977 | ;; Reset the umask. |
| 978 | (set-default-file-modes umask)))) |
| 979 | |
| 980 | (defun recode-file-name (file coding new-coding &optional ok-if-already-exists) |
| 981 | "Change the encoding of FILE's name from CODING to NEW-CODING. |
| 982 | The value is a new name of FILE. |
| 983 | Signals a `file-already-exists' error if a file of the new name |
| 984 | already exists unless optional fourth argument OK-IF-ALREADY-EXISTS |
| 985 | is non-nil. A number as fourth arg means request confirmation if |
| 986 | the new name already exists. This is what happens in interactive |
| 987 | use with M-x." |
| 988 | (interactive |
| 989 | (let ((default-coding (or file-name-coding-system |
| 990 | default-file-name-coding-system)) |
| 991 | (filename (read-file-name "Recode filename: " nil nil t)) |
| 992 | from-coding to-coding) |
| 993 | (if (and default-coding |
| 994 | ;; We provide the default coding only when it seems that |
| 995 | ;; the filename is correctly decoded by the default |
| 996 | ;; coding. |
| 997 | (let ((charsets (find-charset-string filename))) |
| 998 | (and (not (memq 'eight-bit-control charsets)) |
| 999 | (not (memq 'eight-bit-graphic charsets))))) |
| 1000 | (setq from-coding (read-coding-system |
| 1001 | (format "Recode filename %s from (default %s): " |
| 1002 | filename default-coding) |
| 1003 | default-coding)) |
| 1004 | (setq from-coding (read-coding-system |
| 1005 | (format "Recode filename %s from: " filename)))) |
| 1006 | |
| 1007 | ;; We provide the default coding only when a user is going to |
| 1008 | ;; change the encoding not from the default coding. |
| 1009 | (if (eq from-coding default-coding) |
| 1010 | (setq to-coding (read-coding-system |
| 1011 | (format "Recode filename %s from %s to: " |
| 1012 | filename from-coding))) |
| 1013 | (setq to-coding (read-coding-system |
| 1014 | (format "Recode filename %s from %s to (default %s): " |
| 1015 | filename from-coding default-coding) |
| 1016 | default-coding))) |
| 1017 | (list filename from-coding to-coding))) |
| 1018 | |
| 1019 | (let* ((default-coding (or file-name-coding-system |
| 1020 | default-file-name-coding-system)) |
| 1021 | ;; FILE should have been decoded by DEFAULT-CODING. |
| 1022 | (encoded (encode-coding-string file default-coding)) |
| 1023 | (newname (decode-coding-string encoded coding)) |
| 1024 | (new-encoded (encode-coding-string newname new-coding)) |
| 1025 | ;; Suppress further encoding. |
| 1026 | (file-name-coding-system nil) |
| 1027 | (default-file-name-coding-system nil) |
| 1028 | (locale-coding-system nil)) |
| 1029 | (rename-file encoded new-encoded ok-if-already-exists) |
| 1030 | newname)) |
| 1031 | \f |
| 1032 | (defun switch-to-buffer-other-window (buffer &optional norecord) |
| 1033 | "Select buffer BUFFER in another window. |
| 1034 | If BUFFER does not identify an existing buffer, then this function |
| 1035 | creates a buffer with that name. |
| 1036 | |
| 1037 | When called from Lisp, BUFFER can be a buffer, a string \(a buffer name), |
| 1038 | or nil. If BUFFER is nil, then this function chooses a buffer |
| 1039 | using `other-buffer'. |
| 1040 | Optional second arg NORECORD non-nil means |
| 1041 | do not put this buffer at the front of the list of recently selected ones. |
| 1042 | This function returns the buffer it switched to. |
| 1043 | |
| 1044 | This uses the function `display-buffer' as a subroutine; see its |
| 1045 | documentation for additional customization information." |
| 1046 | (interactive "BSwitch to buffer in other window: ") |
| 1047 | (let ((pop-up-windows t) |
| 1048 | ;; Don't let these interfere. |
| 1049 | same-window-buffer-names same-window-regexps) |
| 1050 | (pop-to-buffer buffer t norecord))) |
| 1051 | |
| 1052 | (defun switch-to-buffer-other-frame (buffer &optional norecord) |
| 1053 | "Switch to buffer BUFFER in another frame. |
| 1054 | Optional second arg NORECORD non-nil means |
| 1055 | do not put this buffer at the front of the list of recently selected ones. |
| 1056 | This function returns the buffer it switched to. |
| 1057 | |
| 1058 | This uses the function `display-buffer' as a subroutine; see its |
| 1059 | documentation for additional customization information." |
| 1060 | (interactive "BSwitch to buffer in other frame: ") |
| 1061 | (let ((pop-up-frames t) |
| 1062 | same-window-buffer-names same-window-regexps) |
| 1063 | (prog1 |
| 1064 | (pop-to-buffer buffer t norecord) |
| 1065 | (raise-frame (window-frame (selected-window)))))) |
| 1066 | |
| 1067 | (defun display-buffer-other-frame (buffer) |
| 1068 | "Switch to buffer BUFFER in another frame. |
| 1069 | This uses the function `display-buffer' as a subroutine; see its |
| 1070 | documentation for additional customization information." |
| 1071 | (interactive "BDisplay buffer in other frame: ") |
| 1072 | (let ((pop-up-frames t) |
| 1073 | same-window-buffer-names same-window-regexps |
| 1074 | (old-window (selected-window)) |
| 1075 | new-window) |
| 1076 | (setq new-window (display-buffer buffer t)) |
| 1077 | (lower-frame (window-frame new-window)) |
| 1078 | (make-frame-invisible (window-frame old-window)) |
| 1079 | (make-frame-visible (window-frame old-window)))) |
| 1080 | |
| 1081 | (defvar find-file-default nil |
| 1082 | "Used within `find-file-read-args'.") |
| 1083 | |
| 1084 | (defmacro minibuffer-with-setup-hook (fun &rest body) |
| 1085 | "Add FUN to `minibuffer-setup-hook' while executing BODY. |
| 1086 | BODY should use the minibuffer at most once. |
| 1087 | Recursive uses of the minibuffer will not be affected." |
| 1088 | (declare (indent 1) (debug t)) |
| 1089 | (let ((hook (make-symbol "setup-hook"))) |
| 1090 | `(let (,hook) |
| 1091 | (setq ,hook |
| 1092 | (lambda () |
| 1093 | ;; Clear out this hook so it does not interfere |
| 1094 | ;; with any recursive minibuffer usage. |
| 1095 | (remove-hook 'minibuffer-setup-hook ,hook) |
| 1096 | (,fun))) |
| 1097 | (unwind-protect |
| 1098 | (progn |
| 1099 | (add-hook 'minibuffer-setup-hook ,hook) |
| 1100 | ,@body) |
| 1101 | (remove-hook 'minibuffer-setup-hook ,hook))))) |
| 1102 | |
| 1103 | (defcustom find-file-confirm-nonexistent-file nil |
| 1104 | "If non-nil, `find-file' requires confirmation before visiting a new file." |
| 1105 | :group 'find-file |
| 1106 | :version "23.1" |
| 1107 | :type 'boolean) |
| 1108 | |
| 1109 | (defun find-file-read-args (prompt mustmatch) |
| 1110 | (list (let ((find-file-default |
| 1111 | (and buffer-file-name |
| 1112 | (abbreviate-file-name buffer-file-name)))) |
| 1113 | (minibuffer-with-setup-hook |
| 1114 | (lambda () (setq minibuffer-default find-file-default)) |
| 1115 | (read-file-name prompt nil default-directory mustmatch))) |
| 1116 | t)) |
| 1117 | |
| 1118 | (defun find-file (filename &optional wildcards) |
| 1119 | "Edit file FILENAME. |
| 1120 | Switch to a buffer visiting file FILENAME, |
| 1121 | creating one if none already exists. |
| 1122 | Interactively, the default if you just type RET is the current directory, |
| 1123 | but the visited file name is available through the minibuffer history: |
| 1124 | type M-n to pull it into the minibuffer. |
| 1125 | |
| 1126 | You can visit files on remote machines by specifying something |
| 1127 | like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can |
| 1128 | also visit local files as a different user by specifying |
| 1129 | /sudo::FILE for the file name. |
| 1130 | See the Info node `(tramp)Filename Syntax' in the Tramp Info |
| 1131 | manual, for more about this. |
| 1132 | |
| 1133 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
| 1134 | expand wildcards (if any) and visit multiple files. You can |
| 1135 | suppress wildcard expansion by setting `find-file-wildcards' to nil. |
| 1136 | |
| 1137 | To visit a file without any kind of conversion and without |
| 1138 | automatically choosing a major mode, use \\[find-file-literally]." |
| 1139 | (interactive |
| 1140 | (find-file-read-args "Find file: " |
| 1141 | (if find-file-confirm-nonexistent-file 'confirm-only))) |
| 1142 | (let ((value (find-file-noselect filename nil nil wildcards))) |
| 1143 | (if (listp value) |
| 1144 | (mapcar 'switch-to-buffer (nreverse value)) |
| 1145 | (switch-to-buffer value)))) |
| 1146 | |
| 1147 | (defun find-file-other-window (filename &optional wildcards) |
| 1148 | "Edit file FILENAME, in another window. |
| 1149 | |
| 1150 | Like \\[find-file] (which see), but creates a new window or reuses |
| 1151 | an existing one. See the function `display-buffer'. |
| 1152 | |
| 1153 | Interactively, the default if you just type RET is the current directory, |
| 1154 | but the visited file name is available through the minibuffer history: |
| 1155 | type M-n to pull it into the minibuffer. |
| 1156 | |
| 1157 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
| 1158 | expand wildcards (if any) and visit multiple files." |
| 1159 | (interactive |
| 1160 | (find-file-read-args "Find file in other window: " |
| 1161 | (if find-file-confirm-nonexistent-file 'confirm-only))) |
| 1162 | (let ((value (find-file-noselect filename nil nil wildcards))) |
| 1163 | (if (listp value) |
| 1164 | (progn |
| 1165 | (setq value (nreverse value)) |
| 1166 | (cons (switch-to-buffer-other-window (car value)) |
| 1167 | (mapcar 'switch-to-buffer (cdr value)))) |
| 1168 | (switch-to-buffer-other-window value)))) |
| 1169 | |
| 1170 | (defun find-file-other-frame (filename &optional wildcards) |
| 1171 | "Edit file FILENAME, in another frame. |
| 1172 | |
| 1173 | Like \\[find-file] (which see), but creates a new frame or reuses |
| 1174 | an existing one. See the function `display-buffer'. |
| 1175 | |
| 1176 | Interactively, the default if you just type RET is the current directory, |
| 1177 | but the visited file name is available through the minibuffer history: |
| 1178 | type M-n to pull it into the minibuffer. |
| 1179 | |
| 1180 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
| 1181 | expand wildcards (if any) and visit multiple files." |
| 1182 | (interactive |
| 1183 | (find-file-read-args "Find file in other frame: " |
| 1184 | (if find-file-confirm-nonexistent-file 'confirm-only))) |
| 1185 | (let ((value (find-file-noselect filename nil nil wildcards))) |
| 1186 | (if (listp value) |
| 1187 | (progn |
| 1188 | (setq value (nreverse value)) |
| 1189 | (cons (switch-to-buffer-other-frame (car value)) |
| 1190 | (mapcar 'switch-to-buffer (cdr value)))) |
| 1191 | (switch-to-buffer-other-frame value)))) |
| 1192 | |
| 1193 | (defun find-file-existing (filename) |
| 1194 | "Edit the existing file FILENAME. |
| 1195 | Like \\[find-file], but only allow a file that exists, and do not allow |
| 1196 | file names with wildcards." |
| 1197 | (interactive (nbutlast (find-file-read-args "Find existing file: " t))) |
| 1198 | (if (and (not (interactive-p)) (not (file-exists-p filename))) |
| 1199 | (error "%s does not exist" filename) |
| 1200 | (find-file filename) |
| 1201 | (current-buffer))) |
| 1202 | |
| 1203 | (defun find-file-read-only (filename &optional wildcards) |
| 1204 | "Edit file FILENAME but don't allow changes. |
| 1205 | Like \\[find-file], but marks buffer as read-only. |
| 1206 | Use \\[toggle-read-only] to permit editing." |
| 1207 | (interactive |
| 1208 | (find-file-read-args "Find file read-only: " |
| 1209 | (if find-file-confirm-nonexistent-file 'confirm-only))) |
| 1210 | (unless (or (and wildcards find-file-wildcards |
| 1211 | (not (string-match "\\`/:" filename)) |
| 1212 | (string-match "[[*?]" filename)) |
| 1213 | (file-exists-p filename)) |
| 1214 | (error "%s does not exist" filename)) |
| 1215 | (let ((value (find-file filename wildcards))) |
| 1216 | (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1))) |
| 1217 | (if (listp value) value (list value))) |
| 1218 | value)) |
| 1219 | |
| 1220 | (defun find-file-read-only-other-window (filename &optional wildcards) |
| 1221 | "Edit file FILENAME in another window but don't allow changes. |
| 1222 | Like \\[find-file-other-window], but marks buffer as read-only. |
| 1223 | Use \\[toggle-read-only] to permit editing." |
| 1224 | (interactive |
| 1225 | (find-file-read-args "Find file read-only other window: " |
| 1226 | (if find-file-confirm-nonexistent-file 'confirm-only))) |
| 1227 | (unless (or (and wildcards find-file-wildcards |
| 1228 | (not (string-match "\\`/:" filename)) |
| 1229 | (string-match "[[*?]" filename)) |
| 1230 | (file-exists-p filename)) |
| 1231 | (error "%s does not exist" filename)) |
| 1232 | (let ((value (find-file-other-window filename wildcards))) |
| 1233 | (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1))) |
| 1234 | (if (listp value) value (list value))) |
| 1235 | value)) |
| 1236 | |
| 1237 | (defun find-file-read-only-other-frame (filename &optional wildcards) |
| 1238 | "Edit file FILENAME in another frame but don't allow changes. |
| 1239 | Like \\[find-file-other-frame], but marks buffer as read-only. |
| 1240 | Use \\[toggle-read-only] to permit editing." |
| 1241 | (interactive |
| 1242 | (find-file-read-args "Find file read-only other frame: " |
| 1243 | (if find-file-confirm-nonexistent-file 'confirm-only))) |
| 1244 | (unless (or (and wildcards find-file-wildcards |
| 1245 | (not (string-match "\\`/:" filename)) |
| 1246 | (string-match "[[*?]" filename)) |
| 1247 | (file-exists-p filename)) |
| 1248 | (error "%s does not exist" filename)) |
| 1249 | (let ((value (find-file-other-frame filename wildcards))) |
| 1250 | (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1))) |
| 1251 | (if (listp value) value (list value))) |
| 1252 | value)) |
| 1253 | |
| 1254 | (defun find-alternate-file-other-window (filename &optional wildcards) |
| 1255 | "Find file FILENAME as a replacement for the file in the next window. |
| 1256 | This command does not select that window. |
| 1257 | |
| 1258 | See \\[find-file] for the possible forms of the FILENAME argument. |
| 1259 | |
| 1260 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
| 1261 | expand wildcards (if any) and replace the file with multiple files." |
| 1262 | (interactive |
| 1263 | (save-selected-window |
| 1264 | (other-window 1) |
| 1265 | (let ((file buffer-file-name) |
| 1266 | (file-name nil) |
| 1267 | (file-dir nil)) |
| 1268 | (and file |
| 1269 | (setq file-name (file-name-nondirectory file) |
| 1270 | file-dir (file-name-directory file))) |
| 1271 | (list (read-file-name |
| 1272 | "Find alternate file: " file-dir nil nil file-name) |
| 1273 | t)))) |
| 1274 | (if (one-window-p) |
| 1275 | (find-file-other-window filename wildcards) |
| 1276 | (save-selected-window |
| 1277 | (other-window 1) |
| 1278 | (find-alternate-file filename wildcards)))) |
| 1279 | |
| 1280 | (defun find-alternate-file (filename &optional wildcards) |
| 1281 | "Find file FILENAME, select its buffer, kill previous buffer. |
| 1282 | If the current buffer now contains an empty file that you just visited |
| 1283 | \(presumably by mistake), use this command to visit the file you really want. |
| 1284 | |
| 1285 | See \\[find-file] for the possible forms of the FILENAME argument. |
| 1286 | |
| 1287 | Interactively, or if WILDCARDS is non-nil in a call from Lisp, |
| 1288 | expand wildcards (if any) and replace the file with multiple files. |
| 1289 | |
| 1290 | If the current buffer is an indirect buffer, or the base buffer |
| 1291 | for one or more indirect buffers, the other buffer(s) are not |
| 1292 | killed." |
| 1293 | (interactive |
| 1294 | (let ((file buffer-file-name) |
| 1295 | (file-name nil) |
| 1296 | (file-dir nil)) |
| 1297 | (and file |
| 1298 | (setq file-name (file-name-nondirectory file) |
| 1299 | file-dir (file-name-directory file))) |
| 1300 | (list (read-file-name |
| 1301 | "Find alternate file: " file-dir nil nil file-name) |
| 1302 | t))) |
| 1303 | (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions) |
| 1304 | (error "Aborted")) |
| 1305 | (when (and (buffer-modified-p) (buffer-file-name)) |
| 1306 | (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? " |
| 1307 | (buffer-name))) |
| 1308 | (unless (yes-or-no-p "Kill and replace the buffer without saving it? ") |
| 1309 | (error "Aborted")) |
| 1310 | (save-buffer))) |
| 1311 | (let ((obuf (current-buffer)) |
| 1312 | (ofile buffer-file-name) |
| 1313 | (onum buffer-file-number) |
| 1314 | (odir dired-directory) |
| 1315 | (otrue buffer-file-truename) |
| 1316 | (oname (buffer-name))) |
| 1317 | (if (get-buffer " **lose**") |
| 1318 | (kill-buffer " **lose**")) |
| 1319 | (rename-buffer " **lose**") |
| 1320 | (unwind-protect |
| 1321 | (progn |
| 1322 | (unlock-buffer) |
| 1323 | ;; This prevents us from finding the same buffer |
| 1324 | ;; if we specified the same file again. |
| 1325 | (setq buffer-file-name nil) |
| 1326 | (setq buffer-file-number nil) |
| 1327 | (setq buffer-file-truename nil) |
| 1328 | ;; Likewise for dired buffers. |
| 1329 | (setq dired-directory nil) |
| 1330 | (find-file filename wildcards)) |
| 1331 | (when (eq obuf (current-buffer)) |
| 1332 | ;; This executes if find-file gets an error |
| 1333 | ;; and does not really find anything. |
| 1334 | ;; We put things back as they were. |
| 1335 | ;; If find-file actually finds something, we kill obuf below. |
| 1336 | (setq buffer-file-name ofile) |
| 1337 | (setq buffer-file-number onum) |
| 1338 | (setq buffer-file-truename otrue) |
| 1339 | (setq dired-directory odir) |
| 1340 | (lock-buffer) |
| 1341 | (rename-buffer oname))) |
| 1342 | (unless (eq (current-buffer) obuf) |
| 1343 | (with-current-buffer obuf |
| 1344 | ;; We already asked; don't ask again. |
| 1345 | (let ((kill-buffer-query-functions)) |
| 1346 | (kill-buffer obuf)))))) |
| 1347 | \f |
| 1348 | (defun create-file-buffer (filename) |
| 1349 | "Create a suitably named buffer for visiting FILENAME, and return it. |
| 1350 | FILENAME (sans directory) is used unchanged if that name is free; |
| 1351 | otherwise a string <2> or <3> or ... is appended to get an unused name. |
| 1352 | Spaces at the start of FILENAME (sans directory) are removed." |
| 1353 | (let ((lastname (file-name-nondirectory filename))) |
| 1354 | (if (string= lastname "") |
| 1355 | (setq lastname filename)) |
| 1356 | (save-match-data |
| 1357 | (string-match "^ *\\(.*\\)" lastname) |
| 1358 | (generate-new-buffer (match-string 1 lastname))))) |
| 1359 | |
| 1360 | (defun generate-new-buffer (name) |
| 1361 | "Create and return a buffer with a name based on NAME. |
| 1362 | Choose the buffer's name using `generate-new-buffer-name'." |
| 1363 | (get-buffer-create (generate-new-buffer-name name))) |
| 1364 | |
| 1365 | (defcustom automount-dir-prefix "^/tmp_mnt/" |
| 1366 | "Regexp to match the automounter prefix in a directory name." |
| 1367 | :group 'files |
| 1368 | :type 'regexp) |
| 1369 | |
| 1370 | (defvar abbreviated-home-dir nil |
| 1371 | "The user's homedir abbreviated according to `directory-abbrev-alist'.") |
| 1372 | |
| 1373 | (defun abbreviate-file-name (filename) |
| 1374 | "Return a version of FILENAME shortened using `directory-abbrev-alist'. |
| 1375 | This also substitutes \"~\" for the user's home directory (unless the |
| 1376 | home directory is a root directory) and removes automounter prefixes |
| 1377 | \(see the variable `automount-dir-prefix')." |
| 1378 | ;; Get rid of the prefixes added by the automounter. |
| 1379 | (save-match-data |
| 1380 | (if (and automount-dir-prefix |
| 1381 | (string-match automount-dir-prefix filename) |
| 1382 | (file-exists-p (file-name-directory |
| 1383 | (substring filename (1- (match-end 0)))))) |
| 1384 | (setq filename (substring filename (1- (match-end 0))))) |
| 1385 | (let ((tail directory-abbrev-alist)) |
| 1386 | ;; If any elt of directory-abbrev-alist matches this name, |
| 1387 | ;; abbreviate accordingly. |
| 1388 | (while tail |
| 1389 | (if (string-match (car (car tail)) filename) |
| 1390 | (setq filename |
| 1391 | (concat (cdr (car tail)) (substring filename (match-end 0))))) |
| 1392 | (setq tail (cdr tail))) |
| 1393 | ;; Compute and save the abbreviated homedir name. |
| 1394 | ;; We defer computing this until the first time it's needed, to |
| 1395 | ;; give time for directory-abbrev-alist to be set properly. |
| 1396 | ;; We include a slash at the end, to avoid spurious matches |
| 1397 | ;; such as `/usr/foobar' when the home dir is `/usr/foo'. |
| 1398 | (or abbreviated-home-dir |
| 1399 | (setq abbreviated-home-dir |
| 1400 | (let ((abbreviated-home-dir "$foo")) |
| 1401 | (concat "^" (abbreviate-file-name (expand-file-name "~")) |
| 1402 | "\\(/\\|\\'\\)")))) |
| 1403 | |
| 1404 | ;; If FILENAME starts with the abbreviated homedir, |
| 1405 | ;; make it start with `~' instead. |
| 1406 | (if (and (string-match abbreviated-home-dir filename) |
| 1407 | ;; If the home dir is just /, don't change it. |
| 1408 | (not (and (= (match-end 0) 1) |
| 1409 | (= (aref filename 0) ?/))) |
| 1410 | ;; MS-DOS root directories can come with a drive letter; |
| 1411 | ;; Novell Netware allows drive letters beyond `Z:'. |
| 1412 | (not (and (or (eq system-type 'ms-dos) |
| 1413 | (eq system-type 'cygwin) |
| 1414 | (eq system-type 'windows-nt)) |
| 1415 | (save-match-data |
| 1416 | (string-match "^[a-zA-`]:/$" filename))))) |
| 1417 | (setq filename |
| 1418 | (concat "~" |
| 1419 | (match-string 1 filename) |
| 1420 | (substring filename (match-end 0))))) |
| 1421 | filename))) |
| 1422 | |
| 1423 | (defcustom find-file-not-true-dirname-list nil |
| 1424 | "List of logical names for which visiting shouldn't save the true dirname. |
| 1425 | On VMS, when you visit a file using a logical name that searches a path, |
| 1426 | you may or may not want the visited file name to record the specific |
| 1427 | directory where the file was found. If you *do not* want that, add the logical |
| 1428 | name to this list as a string." |
| 1429 | :type '(repeat (string :tag "Name")) |
| 1430 | :group 'find-file) |
| 1431 | |
| 1432 | (defun find-buffer-visiting (filename &optional predicate) |
| 1433 | "Return the buffer visiting file FILENAME (a string). |
| 1434 | This is like `get-file-buffer', except that it checks for any buffer |
| 1435 | visiting the same file, possibly under a different name. |
| 1436 | If PREDICATE is non-nil, only buffers satisfying it are eligible, |
| 1437 | and others are ignored. |
| 1438 | If there is no such live buffer, return nil." |
| 1439 | (let ((predicate (or predicate #'identity)) |
| 1440 | (truename (abbreviate-file-name (file-truename filename)))) |
| 1441 | (or (let ((buf (get-file-buffer filename))) |
| 1442 | (when (and buf (funcall predicate buf)) buf)) |
| 1443 | (let ((list (buffer-list)) found) |
| 1444 | (while (and (not found) list) |
| 1445 | (save-excursion |
| 1446 | (set-buffer (car list)) |
| 1447 | (if (and buffer-file-name |
| 1448 | (string= buffer-file-truename truename) |
| 1449 | (funcall predicate (current-buffer))) |
| 1450 | (setq found (car list)))) |
| 1451 | (setq list (cdr list))) |
| 1452 | found) |
| 1453 | (let* ((attributes (file-attributes truename)) |
| 1454 | (number (nthcdr 10 attributes)) |
| 1455 | (list (buffer-list)) found) |
| 1456 | (and buffer-file-numbers-unique |
| 1457 | (car-safe number) ;Make sure the inode is not just nil. |
| 1458 | (while (and (not found) list) |
| 1459 | (with-current-buffer (car list) |
| 1460 | (if (and buffer-file-name |
| 1461 | (equal buffer-file-number number) |
| 1462 | ;; Verify this buffer's file number |
| 1463 | ;; still belongs to its file. |
| 1464 | (file-exists-p buffer-file-name) |
| 1465 | (equal (file-attributes buffer-file-truename) |
| 1466 | attributes) |
| 1467 | (funcall predicate (current-buffer))) |
| 1468 | (setq found (car list)))) |
| 1469 | (setq list (cdr list)))) |
| 1470 | found)))) |
| 1471 | \f |
| 1472 | (defcustom find-file-wildcards t |
| 1473 | "Non-nil means file-visiting commands should handle wildcards. |
| 1474 | For example, if you specify `*.c', that would visit all the files |
| 1475 | whose names match the pattern." |
| 1476 | :group 'files |
| 1477 | :version "20.4" |
| 1478 | :type 'boolean) |
| 1479 | |
| 1480 | (defcustom find-file-suppress-same-file-warnings nil |
| 1481 | "Non-nil means suppress warning messages for symlinked files. |
| 1482 | When nil, Emacs prints a warning when visiting a file that is already |
| 1483 | visited, but with a different name. Setting this option to t |
| 1484 | suppresses this warning." |
| 1485 | :group 'files |
| 1486 | :version "21.1" |
| 1487 | :type 'boolean) |
| 1488 | |
| 1489 | (defcustom large-file-warning-threshold 10000000 |
| 1490 | "Maximum size of file above which a confirmation is requested. |
| 1491 | When nil, never request confirmation." |
| 1492 | :group 'files |
| 1493 | :group 'find-file |
| 1494 | :version "22.1" |
| 1495 | :type '(choice integer (const :tag "Never request confirmation" nil))) |
| 1496 | |
| 1497 | (defun find-file-noselect (filename &optional nowarn rawfile wildcards) |
| 1498 | "Read file FILENAME into a buffer and return the buffer. |
| 1499 | If a buffer exists visiting FILENAME, return that one, but |
| 1500 | verify that the file has not changed since visited or saved. |
| 1501 | The buffer is not selected, just returned to the caller. |
| 1502 | Optional second arg NOWARN non-nil means suppress any warning messages. |
| 1503 | Optional third arg RAWFILE non-nil means the file is read literally. |
| 1504 | Optional fourth arg WILDCARDS non-nil means do wildcard processing |
| 1505 | and visit all the matching files. When wildcards are actually |
| 1506 | used and expanded, return a list of buffers that are visiting |
| 1507 | the various files." |
| 1508 | (setq filename |
| 1509 | (abbreviate-file-name |
| 1510 | (expand-file-name filename))) |
| 1511 | (if (file-directory-p filename) |
| 1512 | (or (and find-file-run-dired |
| 1513 | (run-hook-with-args-until-success |
| 1514 | 'find-directory-functions |
| 1515 | (if find-file-visit-truename |
| 1516 | (abbreviate-file-name (file-truename filename)) |
| 1517 | filename))) |
| 1518 | (error "%s is a directory" filename)) |
| 1519 | (if (and wildcards |
| 1520 | find-file-wildcards |
| 1521 | (not (string-match "\\`/:" filename)) |
| 1522 | (string-match "[[*?]" filename)) |
| 1523 | (let ((files (condition-case nil |
| 1524 | (file-expand-wildcards filename t) |
| 1525 | (error (list filename)))) |
| 1526 | (find-file-wildcards nil)) |
| 1527 | (if (null files) |
| 1528 | (find-file-noselect filename) |
| 1529 | (mapcar #'find-file-noselect files))) |
| 1530 | (let* ((buf (get-file-buffer filename)) |
| 1531 | (truename (abbreviate-file-name (file-truename filename))) |
| 1532 | (attributes (file-attributes truename)) |
| 1533 | (number (nthcdr 10 attributes)) |
| 1534 | ;; Find any buffer for a file which has same truename. |
| 1535 | (other (and (not buf) (find-buffer-visiting filename)))) |
| 1536 | ;; Let user know if there is a buffer with the same truename. |
| 1537 | (if other |
| 1538 | (progn |
| 1539 | (or nowarn |
| 1540 | find-file-suppress-same-file-warnings |
| 1541 | (string-equal filename (buffer-file-name other)) |
| 1542 | (message "%s and %s are the same file" |
| 1543 | filename (buffer-file-name other))) |
| 1544 | ;; Optionally also find that buffer. |
| 1545 | (if (or find-file-existing-other-name find-file-visit-truename) |
| 1546 | (setq buf other)))) |
| 1547 | ;; Check to see if the file looks uncommonly large. |
| 1548 | (when (and large-file-warning-threshold (nth 7 attributes) |
| 1549 | ;; Don't ask again if we already have the file or |
| 1550 | ;; if we're asked to be quiet. |
| 1551 | (not (or buf nowarn)) |
| 1552 | (> (nth 7 attributes) large-file-warning-threshold) |
| 1553 | (not (y-or-n-p |
| 1554 | (format "File %s is large (%dMB), really open? " |
| 1555 | (file-name-nondirectory filename) |
| 1556 | (/ (nth 7 attributes) 1048576))))) |
| 1557 | (error "Aborted")) |
| 1558 | (if buf |
| 1559 | ;; We are using an existing buffer. |
| 1560 | (let (nonexistent) |
| 1561 | (or nowarn |
| 1562 | (verify-visited-file-modtime buf) |
| 1563 | (cond ((not (file-exists-p filename)) |
| 1564 | (setq nonexistent t) |
| 1565 | (message "File %s no longer exists!" filename)) |
| 1566 | ;; Certain files should be reverted automatically |
| 1567 | ;; if they have changed on disk and not in the buffer. |
| 1568 | ((and (not (buffer-modified-p buf)) |
| 1569 | (let ((tail revert-without-query) |
| 1570 | (found nil)) |
| 1571 | (while tail |
| 1572 | (if (string-match (car tail) filename) |
| 1573 | (setq found t)) |
| 1574 | (setq tail (cdr tail))) |
| 1575 | found)) |
| 1576 | (with-current-buffer buf |
| 1577 | (message "Reverting file %s..." filename) |
| 1578 | (revert-buffer t t) |
| 1579 | (message "Reverting file %s...done" filename))) |
| 1580 | ((yes-or-no-p |
| 1581 | (if (string= (file-name-nondirectory filename) |
| 1582 | (buffer-name buf)) |
| 1583 | (format |
| 1584 | (if (buffer-modified-p buf) |
| 1585 | "File %s changed on disk. Discard your edits? " |
| 1586 | "File %s changed on disk. Reread from disk? ") |
| 1587 | (file-name-nondirectory filename)) |
| 1588 | (format |
| 1589 | (if (buffer-modified-p buf) |
| 1590 | "File %s changed on disk. Discard your edits in %s? " |
| 1591 | "File %s changed on disk. Reread from disk into %s? ") |
| 1592 | (file-name-nondirectory filename) |
| 1593 | (buffer-name buf)))) |
| 1594 | (with-current-buffer buf |
| 1595 | (revert-buffer t t))))) |
| 1596 | (with-current-buffer buf |
| 1597 | |
| 1598 | ;; Check if a formerly read-only file has become |
| 1599 | ;; writable and vice versa, but if the buffer agrees |
| 1600 | ;; with the new state of the file, that is ok too. |
| 1601 | (let ((read-only (not (file-writable-p buffer-file-name)))) |
| 1602 | (unless (or nonexistent |
| 1603 | (eq read-only buffer-file-read-only) |
| 1604 | (eq read-only buffer-read-only)) |
| 1605 | (when (or nowarn |
| 1606 | (let ((question |
| 1607 | (format "File %s is %s on disk. Change buffer mode? " |
| 1608 | buffer-file-name |
| 1609 | (if read-only "read-only" "writable")))) |
| 1610 | (y-or-n-p question))) |
| 1611 | (setq buffer-read-only read-only))) |
| 1612 | (setq buffer-file-read-only read-only)) |
| 1613 | |
| 1614 | (when (and (not (eq (not (null rawfile)) |
| 1615 | (not (null find-file-literally)))) |
| 1616 | (not nonexistent) |
| 1617 | ;; It is confusing to ask whether to visit |
| 1618 | ;; non-literally if they have the file in |
| 1619 | ;; hexl-mode. |
| 1620 | (not (eq major-mode 'hexl-mode))) |
| 1621 | (if (buffer-modified-p) |
| 1622 | (if (y-or-n-p |
| 1623 | (format |
| 1624 | (if rawfile |
| 1625 | "The file %s is already visited normally, |
| 1626 | and you have edited the buffer. Now you have asked to visit it literally, |
| 1627 | meaning no coding system handling, format conversion, or local variables. |
| 1628 | Emacs can only visit a file in one way at a time. |
| 1629 | |
| 1630 | Do you want to save the file, and visit it literally instead? " |
| 1631 | "The file %s is already visited literally, |
| 1632 | meaning no coding system handling, format conversion, or local variables. |
| 1633 | You have edited the buffer. Now you have asked to visit the file normally, |
| 1634 | but Emacs can only visit a file in one way at a time. |
| 1635 | |
| 1636 | Do you want to save the file, and visit it normally instead? ") |
| 1637 | (file-name-nondirectory filename))) |
| 1638 | (progn |
| 1639 | (save-buffer) |
| 1640 | (find-file-noselect-1 buf filename nowarn |
| 1641 | rawfile truename number)) |
| 1642 | (if (y-or-n-p |
| 1643 | (format |
| 1644 | (if rawfile |
| 1645 | "\ |
| 1646 | Do you want to discard your changes, and visit the file literally now? " |
| 1647 | "\ |
| 1648 | Do you want to discard your changes, and visit the file normally now? "))) |
| 1649 | (find-file-noselect-1 buf filename nowarn |
| 1650 | rawfile truename number) |
| 1651 | (error (if rawfile "File already visited non-literally" |
| 1652 | "File already visited literally")))) |
| 1653 | (if (y-or-n-p |
| 1654 | (format |
| 1655 | (if rawfile |
| 1656 | "The file %s is already visited normally. |
| 1657 | You have asked to visit it literally, |
| 1658 | meaning no coding system decoding, format conversion, or local variables. |
| 1659 | But Emacs can only visit a file in one way at a time. |
| 1660 | |
| 1661 | Do you want to revisit the file literally now? " |
| 1662 | "The file %s is already visited literally, |
| 1663 | meaning no coding system decoding, format conversion, or local variables. |
| 1664 | You have asked to visit it normally, |
| 1665 | but Emacs can only visit a file in one way at a time. |
| 1666 | |
| 1667 | Do you want to revisit the file normally now? ") |
| 1668 | (file-name-nondirectory filename))) |
| 1669 | (find-file-noselect-1 buf filename nowarn |
| 1670 | rawfile truename number) |
| 1671 | (error (if rawfile "File already visited non-literally" |
| 1672 | "File already visited literally")))))) |
| 1673 | ;; Return the buffer we are using. |
| 1674 | buf) |
| 1675 | ;; Create a new buffer. |
| 1676 | (setq buf (create-file-buffer filename)) |
| 1677 | ;; find-file-noselect-1 may use a different buffer. |
| 1678 | (find-file-noselect-1 buf filename nowarn |
| 1679 | rawfile truename number)))))) |
| 1680 | |
| 1681 | (defun find-file-noselect-1 (buf filename nowarn rawfile truename number) |
| 1682 | (let (error) |
| 1683 | (with-current-buffer buf |
| 1684 | (kill-local-variable 'find-file-literally) |
| 1685 | ;; Needed in case we are re-visiting the file with a different |
| 1686 | ;; text representation. |
| 1687 | (kill-local-variable 'buffer-file-coding-system) |
| 1688 | (kill-local-variable 'cursor-type) |
| 1689 | (let ((inhibit-read-only t)) |
| 1690 | (erase-buffer)) |
| 1691 | (and (default-value 'enable-multibyte-characters) |
| 1692 | (not rawfile) |
| 1693 | (set-buffer-multibyte t)) |
| 1694 | (if rawfile |
| 1695 | (condition-case () |
| 1696 | (let ((inhibit-read-only t)) |
| 1697 | (insert-file-contents-literally filename t)) |
| 1698 | (file-error |
| 1699 | (when (and (file-exists-p filename) |
| 1700 | (not (file-readable-p filename))) |
| 1701 | (kill-buffer buf) |
| 1702 | (signal 'file-error (list "File is not readable" |
| 1703 | filename))) |
| 1704 | ;; Unconditionally set error |
| 1705 | (setq error t))) |
| 1706 | (condition-case () |
| 1707 | (let ((inhibit-read-only t)) |
| 1708 | (insert-file-contents filename t)) |
| 1709 | (file-error |
| 1710 | (when (and (file-exists-p filename) |
| 1711 | (not (file-readable-p filename))) |
| 1712 | (kill-buffer buf) |
| 1713 | (signal 'file-error (list "File is not readable" |
| 1714 | filename))) |
| 1715 | ;; Run find-file-not-found-functions until one returns non-nil. |
| 1716 | (or (run-hook-with-args-until-success 'find-file-not-found-functions) |
| 1717 | ;; If they fail too, set error. |
| 1718 | (setq error t))))) |
| 1719 | ;; Record the file's truename, and maybe use that as visited name. |
| 1720 | (if (equal filename buffer-file-name) |
| 1721 | (setq buffer-file-truename truename) |
| 1722 | (setq buffer-file-truename |
| 1723 | (abbreviate-file-name (file-truename buffer-file-name)))) |
| 1724 | (setq buffer-file-number number) |
| 1725 | ;; On VMS, we may want to remember which directory in a search list |
| 1726 | ;; the file was found in. |
| 1727 | (and (eq system-type 'vax-vms) |
| 1728 | (let (logical) |
| 1729 | (if (string-match ":" (file-name-directory filename)) |
| 1730 | (setq logical (substring (file-name-directory filename) |
| 1731 | 0 (match-beginning 0)))) |
| 1732 | (not (member logical find-file-not-true-dirname-list))) |
| 1733 | (setq buffer-file-name buffer-file-truename)) |
| 1734 | (if find-file-visit-truename |
| 1735 | (setq buffer-file-name (expand-file-name buffer-file-truename))) |
| 1736 | ;; Set buffer's default directory to that of the file. |
| 1737 | (setq default-directory (file-name-directory buffer-file-name)) |
| 1738 | ;; Turn off backup files for certain file names. Since |
| 1739 | ;; this is a permanent local, the major mode won't eliminate it. |
| 1740 | (and backup-enable-predicate |
| 1741 | (not (funcall backup-enable-predicate buffer-file-name)) |
| 1742 | (progn |
| 1743 | (make-local-variable 'backup-inhibited) |
| 1744 | (setq backup-inhibited t))) |
| 1745 | (if rawfile |
| 1746 | (progn |
| 1747 | (set-buffer-multibyte nil) |
| 1748 | (setq buffer-file-coding-system 'no-conversion) |
| 1749 | (set-buffer-major-mode buf) |
| 1750 | (make-local-variable 'find-file-literally) |
| 1751 | (setq find-file-literally t)) |
| 1752 | (after-find-file error (not nowarn))) |
| 1753 | (current-buffer)))) |
| 1754 | \f |
| 1755 | (defun insert-file-contents-literally (filename &optional visit beg end replace) |
| 1756 | "Like `insert-file-contents', but only reads in the file literally. |
| 1757 | A buffer may be modified in several ways after reading into the buffer, |
| 1758 | to Emacs features such as format decoding, character code |
| 1759 | conversion, `find-file-hook', automatic uncompression, etc. |
| 1760 | |
| 1761 | This function ensures that none of these modifications will take place." |
| 1762 | (let ((format-alist nil) |
| 1763 | (after-insert-file-functions nil) |
| 1764 | (coding-system-for-read 'no-conversion) |
| 1765 | (coding-system-for-write 'no-conversion) |
| 1766 | (find-buffer-file-type-function |
| 1767 | (if (fboundp 'find-buffer-file-type) |
| 1768 | (symbol-function 'find-buffer-file-type) |
| 1769 | nil)) |
| 1770 | (inhibit-file-name-handlers |
| 1771 | (append '(jka-compr-handler image-file-handler) |
| 1772 | inhibit-file-name-handlers)) |
| 1773 | (inhibit-file-name-operation 'insert-file-contents)) |
| 1774 | (unwind-protect |
| 1775 | (progn |
| 1776 | (fset 'find-buffer-file-type (lambda (filename) t)) |
| 1777 | (insert-file-contents filename visit beg end replace)) |
| 1778 | (if find-buffer-file-type-function |
| 1779 | (fset 'find-buffer-file-type find-buffer-file-type-function) |
| 1780 | (fmakunbound 'find-buffer-file-type))))) |
| 1781 | |
| 1782 | (defun insert-file-1 (filename insert-func) |
| 1783 | (if (file-directory-p filename) |
| 1784 | (signal 'file-error (list "Opening input file" "file is a directory" |
| 1785 | filename))) |
| 1786 | (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename)) |
| 1787 | #'buffer-modified-p)) |
| 1788 | (tem (funcall insert-func filename))) |
| 1789 | (push-mark (+ (point) (car (cdr tem)))) |
| 1790 | (when buffer |
| 1791 | (message "File %s already visited and modified in buffer %s" |
| 1792 | filename (buffer-name buffer))))) |
| 1793 | |
| 1794 | (defun insert-file-literally (filename) |
| 1795 | "Insert contents of file FILENAME into buffer after point with no conversion. |
| 1796 | |
| 1797 | This function is meant for the user to run interactively. |
| 1798 | Don't call it from programs! Use `insert-file-contents-literally' instead. |
| 1799 | \(Its calling sequence is different; see its documentation)." |
| 1800 | (interactive "*fInsert file literally: ") |
| 1801 | (insert-file-1 filename #'insert-file-contents-literally)) |
| 1802 | |
| 1803 | (defvar find-file-literally nil |
| 1804 | "Non-nil if this buffer was made by `find-file-literally' or equivalent. |
| 1805 | This is a permanent local.") |
| 1806 | (put 'find-file-literally 'permanent-local t) |
| 1807 | |
| 1808 | (defun find-file-literally (filename) |
| 1809 | "Visit file FILENAME with no conversion of any kind. |
| 1810 | Format conversion and character code conversion are both disabled, |
| 1811 | and multibyte characters are disabled in the resulting buffer. |
| 1812 | The major mode used is Fundamental mode regardless of the file name, |
| 1813 | and local variable specifications in the file are ignored. |
| 1814 | Automatic uncompression and adding a newline at the end of the |
| 1815 | file due to `require-final-newline' is also disabled. |
| 1816 | |
| 1817 | You cannot absolutely rely on this function to result in |
| 1818 | visiting the file literally. If Emacs already has a buffer |
| 1819 | which is visiting the file, you get the existing buffer, |
| 1820 | regardless of whether it was created literally or not. |
| 1821 | |
| 1822 | In a Lisp program, if you want to be sure of accessing a file's |
| 1823 | contents literally, you should create a temporary buffer and then read |
| 1824 | the file contents into it using `insert-file-contents-literally'." |
| 1825 | (interactive "FFind file literally: ") |
| 1826 | (switch-to-buffer (find-file-noselect filename nil t))) |
| 1827 | \f |
| 1828 | (defvar after-find-file-from-revert-buffer nil) |
| 1829 | |
| 1830 | (defun after-find-file (&optional error warn noauto |
| 1831 | after-find-file-from-revert-buffer |
| 1832 | nomodes) |
| 1833 | "Called after finding a file and by the default revert function. |
| 1834 | Sets buffer mode, parses local variables. |
| 1835 | Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an |
| 1836 | error in reading the file. WARN non-nil means warn if there |
| 1837 | exists an auto-save file more recent than the visited file. |
| 1838 | NOAUTO means don't mess with auto-save mode. |
| 1839 | Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil |
| 1840 | means this call was from `revert-buffer'. |
| 1841 | Fifth arg NOMODES non-nil means don't alter the file's modes. |
| 1842 | Finishes by calling the functions in `find-file-hook' |
| 1843 | unless NOMODES is non-nil." |
| 1844 | (setq buffer-read-only (not (file-writable-p buffer-file-name))) |
| 1845 | (if noninteractive |
| 1846 | nil |
| 1847 | (let* (not-serious |
| 1848 | (msg |
| 1849 | (cond |
| 1850 | ((not warn) nil) |
| 1851 | ((and error (file-attributes buffer-file-name)) |
| 1852 | (setq buffer-read-only t) |
| 1853 | "File exists, but cannot be read") |
| 1854 | ((not buffer-read-only) |
| 1855 | (if (and warn |
| 1856 | ;; No need to warn if buffer is auto-saved |
| 1857 | ;; under the name of the visited file. |
| 1858 | (not (and buffer-file-name |
| 1859 | auto-save-visited-file-name)) |
| 1860 | (file-newer-than-file-p (or buffer-auto-save-file-name |
| 1861 | (make-auto-save-file-name)) |
| 1862 | buffer-file-name)) |
| 1863 | (format "%s has auto save data; consider M-x recover-this-file" |
| 1864 | (file-name-nondirectory buffer-file-name)) |
| 1865 | (setq not-serious t) |
| 1866 | (if error "(New file)" nil))) |
| 1867 | ((not error) |
| 1868 | (setq not-serious t) |
| 1869 | "Note: file is write protected") |
| 1870 | ((file-attributes (directory-file-name default-directory)) |
| 1871 | "File not found and directory write-protected") |
| 1872 | ((file-exists-p (file-name-directory buffer-file-name)) |
| 1873 | (setq buffer-read-only nil)) |
| 1874 | (t |
| 1875 | (setq buffer-read-only nil) |
| 1876 | "Use M-x make-directory RET RET to create the directory and its parents")))) |
| 1877 | (when msg |
| 1878 | (message "%s" msg) |
| 1879 | (or not-serious (sit-for 1 t)))) |
| 1880 | (when (and auto-save-default (not noauto)) |
| 1881 | (auto-save-mode t))) |
| 1882 | ;; Make people do a little extra work (C-x C-q) |
| 1883 | ;; before altering a backup file. |
| 1884 | (when (backup-file-name-p buffer-file-name) |
| 1885 | (setq buffer-read-only t)) |
| 1886 | ;; When a file is marked read-only, |
| 1887 | ;; make the buffer read-only even if root is looking at it. |
| 1888 | (when (and (file-modes (buffer-file-name)) |
| 1889 | (zerop (logand (file-modes (buffer-file-name)) #o222))) |
| 1890 | (setq buffer-read-only t)) |
| 1891 | (unless nomodes |
| 1892 | (when (and view-read-only view-mode) |
| 1893 | (view-mode-disable)) |
| 1894 | (normal-mode t) |
| 1895 | ;; If requested, add a newline at the end of the file. |
| 1896 | (and (memq require-final-newline '(visit visit-save)) |
| 1897 | (> (point-max) (point-min)) |
| 1898 | (/= (char-after (1- (point-max))) ?\n) |
| 1899 | (not (and (eq selective-display t) |
| 1900 | (= (char-after (1- (point-max))) ?\r))) |
| 1901 | (save-excursion |
| 1902 | (goto-char (point-max)) |
| 1903 | (insert "\n"))) |
| 1904 | (when (and buffer-read-only |
| 1905 | view-read-only |
| 1906 | (not (eq (get major-mode 'mode-class) 'special))) |
| 1907 | (view-mode-enter)) |
| 1908 | (run-hooks 'find-file-hook))) |
| 1909 | |
| 1910 | (defmacro report-errors (format &rest body) |
| 1911 | "Eval BODY and turn any error into a FORMAT message. |
| 1912 | FORMAT can have a %s escape which will be replaced with the actual error. |
| 1913 | If `debug-on-error' is set, errors are not caught, so that you can |
| 1914 | debug them. |
| 1915 | Avoid using a large BODY since it is duplicated." |
| 1916 | (declare (debug t) (indent 1)) |
| 1917 | `(if debug-on-error |
| 1918 | (progn . ,body) |
| 1919 | (condition-case err |
| 1920 | (progn . ,body) |
| 1921 | (error (message ,format (prin1-to-string err)))))) |
| 1922 | |
| 1923 | (defun normal-mode (&optional find-file) |
| 1924 | "Choose the major mode for this buffer automatically. |
| 1925 | Also sets up any specified local variables of the file. |
| 1926 | Uses the visited file name, the -*- line, and the local variables spec. |
| 1927 | |
| 1928 | This function is called automatically from `find-file'. In that case, |
| 1929 | we may set up the file-specified mode and local variables, |
| 1930 | depending on the value of `enable-local-variables'. |
| 1931 | In addition, if `local-enable-local-variables' is nil, we do |
| 1932 | not set local variables (though we do notice a mode specified with -*-.) |
| 1933 | |
| 1934 | `enable-local-variables' is ignored if you run `normal-mode' interactively, |
| 1935 | or from Lisp without specifying the optional argument FIND-FILE; |
| 1936 | in that case, this function acts as if `enable-local-variables' were t." |
| 1937 | (interactive) |
| 1938 | (funcall (or default-major-mode 'fundamental-mode)) |
| 1939 | (let ((enable-local-variables (or (not find-file) enable-local-variables))) |
| 1940 | (report-errors "File mode specification error: %s" |
| 1941 | (set-auto-mode)) |
| 1942 | (report-errors "File local-variables error: %s" |
| 1943 | (hack-local-variables))) |
| 1944 | ;; Turn font lock off and on, to make sure it takes account of |
| 1945 | ;; whatever file local variables are relevant to it. |
| 1946 | (when (and font-lock-mode |
| 1947 | ;; Font-lock-mode (now in font-core.el) can be ON when |
| 1948 | ;; font-lock.el still hasn't been loaded. |
| 1949 | (boundp 'font-lock-keywords) |
| 1950 | (eq (car font-lock-keywords) t)) |
| 1951 | (setq font-lock-keywords (cadr font-lock-keywords)) |
| 1952 | (font-lock-mode 1)) |
| 1953 | |
| 1954 | (if (fboundp 'ucs-set-table-for-input) ; don't lose when building |
| 1955 | (ucs-set-table-for-input))) |
| 1956 | |
| 1957 | (defcustom auto-mode-case-fold nil |
| 1958 | "Non-nil means to try second pass through `auto-mode-alist'. |
| 1959 | This means that if the first case-sensitive search through the alist fails |
| 1960 | to find a matching major mode, a second case-insensitive search is made. |
| 1961 | On systems with case-insensitive file names, this variable is ignored, |
| 1962 | since only a single case-insensitive search through the alist is made." |
| 1963 | :group 'files |
| 1964 | :version "22.1" |
| 1965 | :type 'boolean) |
| 1966 | |
| 1967 | (defvar auto-mode-alist |
| 1968 | ;; Note: The entries for the modes defined in cc-mode.el (c-mode, |
| 1969 | ;; c++-mode, java-mode and more) are added through autoload |
| 1970 | ;; directives in that file. That way is discouraged since it |
| 1971 | ;; spreads out the definition of the initial value. |
| 1972 | (mapcar |
| 1973 | (lambda (elt) |
| 1974 | (cons (purecopy (car elt)) (cdr elt))) |
| 1975 | `(;; do this first, so that .html.pl is Polish html, not Perl |
| 1976 | ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode) |
| 1977 | ("\\.te?xt\\'" . text-mode) |
| 1978 | ("\\.[tT]e[xX]\\'" . tex-mode) |
| 1979 | ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages. |
| 1980 | ("\\.ltx\\'" . latex-mode) |
| 1981 | ("\\.dtx\\'" . doctex-mode) |
| 1982 | ("\\.org\\'" . org-mode) |
| 1983 | ("\\.el\\'" . emacs-lisp-mode) |
| 1984 | ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode) |
| 1985 | ("\\.l\\'" . lisp-mode) |
| 1986 | ("\\.li?sp\\'" . lisp-mode) |
| 1987 | ("\\.[fF]\\'" . fortran-mode) |
| 1988 | ("\\.for\\'" . fortran-mode) |
| 1989 | ("\\.p\\'" . pascal-mode) |
| 1990 | ("\\.pas\\'" . pascal-mode) |
| 1991 | ("\\.ad[abs]\\'" . ada-mode) |
| 1992 | ("\\.ad[bs].dg\\'" . ada-mode) |
| 1993 | ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode) |
| 1994 | ("Imakefile\\'" . makefile-imake-mode) |
| 1995 | ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk |
| 1996 | ("\\.makepp\\'" . makefile-makepp-mode) |
| 1997 | ,@(if (memq system-type '(berkeley-unix next-mach darwin)) |
| 1998 | '(("\\.mk\\'" . makefile-bsdmake-mode) |
| 1999 | ("GNUmakefile\\'" . makefile-gmake-mode) |
| 2000 | ("[Mm]akefile\\'" . makefile-bsdmake-mode)) |
| 2001 | '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage |
| 2002 | ("[Mm]akefile\\'" . makefile-gmake-mode))) |
| 2003 | ("\\.am\\'" . makefile-automake-mode) |
| 2004 | ;; Less common extensions come here |
| 2005 | ;; so more common ones above are found faster. |
| 2006 | ("\\.texinfo\\'" . texinfo-mode) |
| 2007 | ("\\.te?xi\\'" . texinfo-mode) |
| 2008 | ("\\.[sS]\\'" . asm-mode) |
| 2009 | ("\\.asm\\'" . asm-mode) |
| 2010 | ("[cC]hange\\.?[lL]og?\\'" . change-log-mode) |
| 2011 | ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode) |
| 2012 | ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode) |
| 2013 | ("\\.scm\\.[0-9]*\\'" . scheme-mode) |
| 2014 | ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode) |
| 2015 | ("\\.bash\\'" . sh-mode) |
| 2016 | ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode) |
| 2017 | ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode) |
| 2018 | ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode) |
| 2019 | ("\\.m?spec\\'" . sh-mode) |
| 2020 | ("\\.m[mes]\\'" . nroff-mode) |
| 2021 | ("\\.man\\'" . nroff-mode) |
| 2022 | ("\\.sty\\'" . latex-mode) |
| 2023 | ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option |
| 2024 | ("\\.bbl\\'" . latex-mode) |
| 2025 | ("\\.bib\\'" . bibtex-mode) |
| 2026 | ("\\.sql\\'" . sql-mode) |
| 2027 | ("\\.m[4c]\\'" . m4-mode) |
| 2028 | ("\\.mf\\'" . metafont-mode) |
| 2029 | ("\\.mp\\'" . metapost-mode) |
| 2030 | ("\\.vhdl?\\'" . vhdl-mode) |
| 2031 | ("\\.article\\'" . text-mode) |
| 2032 | ("\\.letter\\'" . text-mode) |
| 2033 | ("\\.i?tcl\\'" . tcl-mode) |
| 2034 | ("\\.exp\\'" . tcl-mode) |
| 2035 | ("\\.itk\\'" . tcl-mode) |
| 2036 | ("\\.icn\\'" . icon-mode) |
| 2037 | ("\\.sim\\'" . simula-mode) |
| 2038 | ("\\.mss\\'" . scribe-mode) |
| 2039 | ("\\.f9[05]\\'" . f90-mode) |
| 2040 | ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode |
| 2041 | ("\\.pro\\'" . idlwave-mode) |
| 2042 | ("\\.prolog\\'" . prolog-mode) |
| 2043 | ("\\.tar\\'" . tar-mode) |
| 2044 | ;; The list of archive file extensions should be in sync with |
| 2045 | ;; `auto-coding-alist' with `no-conversion' coding system. |
| 2046 | ("\\.\\(\ |
| 2047 | arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\ |
| 2048 | ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode) |
| 2049 | ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode) ; OpenOffice.org |
| 2050 | ;; Mailer puts message to be edited in |
| 2051 | ;; /tmp/Re.... or Message |
| 2052 | ("\\`/tmp/Re" . text-mode) |
| 2053 | ("/Message[0-9]*\\'" . text-mode) |
| 2054 | ("\\.zone\\'" . zone-mode) |
| 2055 | ;; some news reader is reported to use this |
| 2056 | ("\\`/tmp/fol/" . text-mode) |
| 2057 | ("\\.oak\\'" . scheme-mode) |
| 2058 | ("\\.sgml?\\'" . sgml-mode) |
| 2059 | ("\\.x[ms]l\\'" . xml-mode) |
| 2060 | ("\\.dtd\\'" . sgml-mode) |
| 2061 | ("\\.ds\\(ss\\)?l\\'" . dsssl-mode) |
| 2062 | ("\\.js\\'" . java-mode) ; javascript-mode would be better |
| 2063 | ("\\.d?v\\'" . verilog-mode) |
| 2064 | ;; .emacs or .gnus or .viper following a directory delimiter in |
| 2065 | ;; Unix, MSDOG or VMS syntax. |
| 2066 | ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode) |
| 2067 | ("\\`\\..*emacs\\'" . emacs-lisp-mode) |
| 2068 | ;; _emacs following a directory delimiter |
| 2069 | ;; in MsDos syntax |
| 2070 | ("[:/]_emacs\\'" . emacs-lisp-mode) |
| 2071 | ("/crontab\\.X*[0-9]+\\'" . shell-script-mode) |
| 2072 | ("\\.ml\\'" . lisp-mode) |
| 2073 | ;; Common Lisp ASDF package system. |
| 2074 | ("\\.asd\\'" . lisp-mode) |
| 2075 | ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode) |
| 2076 | ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode) |
| 2077 | ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode) |
| 2078 | ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG |
| 2079 | ("\\.[eE]?[pP][sS]\\'" . ps-mode) |
| 2080 | ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode) |
| 2081 | ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode) |
| 2082 | ("BROWSE\\'" . ebrowse-tree-mode) |
| 2083 | ("\\.ebrowse\\'" . ebrowse-tree-mode) |
| 2084 | ("#\\*mail\\*" . mail-mode) |
| 2085 | ("\\.g\\'" . antlr-mode) |
| 2086 | ("\\.ses\\'" . ses-mode) |
| 2087 | ("\\.\\(soa\\|zone\\)\\'" . dns-mode) |
| 2088 | ("\\.docbook\\'" . sgml-mode) |
| 2089 | ("\\.com\\'" . dcl-mode) |
| 2090 | ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode) |
| 2091 | ;; Windows candidates may be opened case sensitively on Unix |
| 2092 | ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode) |
| 2093 | ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode) |
| 2094 | ("\\.ppd\\'" . conf-ppd-mode) |
| 2095 | ("java.+\\.conf\\'" . conf-javaprop-mode) |
| 2096 | ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode) |
| 2097 | ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config |
| 2098 | ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe) |
| 2099 | ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode) |
| 2100 | ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode) |
| 2101 | ;; ChangeLog.old etc. Other change-log-mode entries are above; |
| 2102 | ;; this has lower priority to avoid matching changelog.sgml etc. |
| 2103 | ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode) |
| 2104 | ;; either user's dot-files or under /etc or some such |
| 2105 | ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode) |
| 2106 | ;; alas not all ~/.*rc files are like this |
| 2107 | ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode) |
| 2108 | ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode) |
| 2109 | ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode) |
| 2110 | ("/X11.+app-defaults/" . conf-xdefaults-mode) |
| 2111 | ("/X11.+locale/.+/Compose\\'" . conf-colon-mode) |
| 2112 | ;; this contains everything twice, with space and with colon :-( |
| 2113 | ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode) |
| 2114 | ;; Get rid of any trailing .n.m and try again. |
| 2115 | ;; This is for files saved by cvs-merge that look like .#<file>.<rev> |
| 2116 | ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~. |
| 2117 | ;; Using mode nil rather than `ignore' would let the search continue |
| 2118 | ;; through this list (with the shortened name) rather than start over. |
| 2119 | ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t) |
| 2120 | ;; The following should come after the ChangeLog pattern |
| 2121 | ;; for the sake of ChangeLog.1, etc. |
| 2122 | ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too. |
| 2123 | ("\\.[1-9]\\'" . nroff-mode) |
| 2124 | ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t))) |
| 2125 | "Alist of filename patterns vs corresponding major mode functions. |
| 2126 | Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL). |
| 2127 | \(NON-NIL stands for anything that is not nil; the value does not matter.) |
| 2128 | Visiting a file whose name matches REGEXP specifies FUNCTION as the |
| 2129 | mode function to use. FUNCTION will be called, unless it is nil. |
| 2130 | |
| 2131 | If the element has the form (REGEXP FUNCTION NON-NIL), then after |
| 2132 | calling FUNCTION (if it's not nil), we delete the suffix that matched |
| 2133 | REGEXP and search the list again for another match. |
| 2134 | |
| 2135 | If the file name matches `inhibit-first-line-modes-regexps', |
| 2136 | then `auto-mode-alist' is not processed. |
| 2137 | |
| 2138 | The extensions whose FUNCTION is `archive-mode' should also |
| 2139 | appear in `auto-coding-alist' with `no-conversion' coding system. |
| 2140 | |
| 2141 | See also `interpreter-mode-alist', which detects executable script modes |
| 2142 | based on the interpreters they specify to run, |
| 2143 | and `magic-mode-alist', which determines modes based on file contents.") |
| 2144 | |
| 2145 | (defun conf-mode-maybe () |
| 2146 | "Select Conf mode or XML mode according to start of file." |
| 2147 | (if (save-excursion |
| 2148 | (save-restriction |
| 2149 | (widen) |
| 2150 | (goto-char (point-min)) |
| 2151 | (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE "))) |
| 2152 | (xml-mode) |
| 2153 | (conf-mode))) |
| 2154 | |
| 2155 | (defvar interpreter-mode-alist |
| 2156 | ;; Note: The entries for the modes defined in cc-mode.el (awk-mode |
| 2157 | ;; and pike-mode) are added through autoload directives in that |
| 2158 | ;; file. That way is discouraged since it spreads out the |
| 2159 | ;; definition of the initial value. |
| 2160 | (mapc |
| 2161 | (lambda (l) |
| 2162 | (cons (purecopy (car l)) (cdr l))) |
| 2163 | '(("perl" . perl-mode) |
| 2164 | ("perl5" . perl-mode) |
| 2165 | ("miniperl" . perl-mode) |
| 2166 | ("wish" . tcl-mode) |
| 2167 | ("wishx" . tcl-mode) |
| 2168 | ("tcl" . tcl-mode) |
| 2169 | ("tclsh" . tcl-mode) |
| 2170 | ("scm" . scheme-mode) |
| 2171 | ("ash" . sh-mode) |
| 2172 | ("bash" . sh-mode) |
| 2173 | ("bash2" . sh-mode) |
| 2174 | ("csh" . sh-mode) |
| 2175 | ("dtksh" . sh-mode) |
| 2176 | ("es" . sh-mode) |
| 2177 | ("itcsh" . sh-mode) |
| 2178 | ("jsh" . sh-mode) |
| 2179 | ("ksh" . sh-mode) |
| 2180 | ("oash" . sh-mode) |
| 2181 | ("pdksh" . sh-mode) |
| 2182 | ("rc" . sh-mode) |
| 2183 | ("rpm" . sh-mode) |
| 2184 | ("sh" . sh-mode) |
| 2185 | ("sh5" . sh-mode) |
| 2186 | ("tcsh" . sh-mode) |
| 2187 | ("wksh" . sh-mode) |
| 2188 | ("wsh" . sh-mode) |
| 2189 | ("zsh" . sh-mode) |
| 2190 | ("tail" . text-mode) |
| 2191 | ("more" . text-mode) |
| 2192 | ("less" . text-mode) |
| 2193 | ("pg" . text-mode) |
| 2194 | ("make" . makefile-gmake-mode) ; Debian uses this |
| 2195 | ("guile" . scheme-mode) |
| 2196 | ("clisp" . lisp-mode))) |
| 2197 | "Alist mapping interpreter names to major modes. |
| 2198 | This is used for files whose first lines match `auto-mode-interpreter-regexp'. |
| 2199 | Each element looks like (INTERPRETER . MODE). |
| 2200 | If INTERPRETER matches the name of the interpreter specified in the first line |
| 2201 | of a script, mode MODE is enabled. |
| 2202 | |
| 2203 | See also `auto-mode-alist'.") |
| 2204 | |
| 2205 | (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'") |
| 2206 | "List of regexps; if one matches a file name, don't look for `-*-'.") |
| 2207 | |
| 2208 | (defvar inhibit-first-line-modes-suffixes nil |
| 2209 | "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'. |
| 2210 | When checking `inhibit-first-line-modes-regexps', we first discard |
| 2211 | from the end of the file name anything that matches one of these regexps.") |
| 2212 | |
| 2213 | (defvar auto-mode-interpreter-regexp |
| 2214 | "#![ \t]?\\([^ \t\n]*\ |
| 2215 | /bin/env[ \t]\\)?\\([^ \t\n]+\\)" |
| 2216 | "Regexp matching interpreters, for file mode determination. |
| 2217 | This regular expression is matched against the first line of a file |
| 2218 | to determine the file's mode in `set-auto-mode'. If it matches, the file |
| 2219 | is assumed to be interpreted by the interpreter matched by the second group |
| 2220 | of the regular expression. The mode is then determined as the mode |
| 2221 | associated with that interpreter in `interpreter-mode-alist'.") |
| 2222 | |
| 2223 | (defvar magic-mode-alist nil |
| 2224 | "Alist of buffer beginnings vs. corresponding major mode functions. |
| 2225 | Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION). |
| 2226 | After visiting a file, if REGEXP matches the text at the beginning of the |
| 2227 | buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will |
| 2228 | call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's |
| 2229 | major mode. |
| 2230 | |
| 2231 | If FUNCTION is nil, then it is not called. (That is a way of saying |
| 2232 | \"allow `auto-mode-alist' to decide for these files.\")") |
| 2233 | (put 'magic-mode-alist 'risky-local-variable t) |
| 2234 | |
| 2235 | (defvar magic-fallback-mode-alist |
| 2236 | `((image-type-auto-detected-p . image-mode) |
| 2237 | ;; The < comes before the groups (but the first) to reduce backtracking. |
| 2238 | ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff. |
| 2239 | ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely. |
| 2240 | (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)") |
| 2241 | (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)"))) |
| 2242 | (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<" |
| 2243 | comment-re "*" |
| 2244 | "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?" |
| 2245 | "[Hh][Tt][Mm][Ll]")) |
| 2246 | . html-mode) |
| 2247 | ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode) |
| 2248 | ;; These two must come after html, because they are more general: |
| 2249 | ("<\\?xml " . xml-mode) |
| 2250 | (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)") |
| 2251 | (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)"))) |
| 2252 | (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE ")) |
| 2253 | . sgml-mode) |
| 2254 | ("%!PS" . ps-mode) |
| 2255 | ("# xmcd " . conf-unix-mode)) |
| 2256 | "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'. |
| 2257 | Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION). |
| 2258 | After visiting a file, if REGEXP matches the text at the beginning of the |
| 2259 | buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will |
| 2260 | call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist' |
| 2261 | have not specified a mode for this file. |
| 2262 | |
| 2263 | If FUNCTION is nil, then it is not called.") |
| 2264 | (put 'magic-fallback-mode-alist 'risky-local-variable t) |
| 2265 | |
| 2266 | (defvar magic-mode-regexp-match-limit 4000 |
| 2267 | "Upper limit on `magic-mode-alist' regexp matches. |
| 2268 | Also applies to `magic-fallback-mode-alist'.") |
| 2269 | |
| 2270 | (defun set-auto-mode (&optional keep-mode-if-same) |
| 2271 | "Select major mode appropriate for current buffer. |
| 2272 | |
| 2273 | To find the right major mode, this function checks for a -*- mode tag, |
| 2274 | checks if it uses an interpreter listed in `interpreter-mode-alist', |
| 2275 | matches the buffer beginning against `magic-mode-alist', |
| 2276 | compares the filename against the entries in `auto-mode-alist', |
| 2277 | then matches the buffer beginning against `magic-fallback-mode-alist'. |
| 2278 | |
| 2279 | It does not check for the `mode:' local variable in the |
| 2280 | Local Variables section of the file; for that, use `hack-local-variables'. |
| 2281 | |
| 2282 | If `enable-local-variables' is nil, this function does not check for a |
| 2283 | -*- mode tag. |
| 2284 | |
| 2285 | If the optional argument KEEP-MODE-IF-SAME is non-nil, then we |
| 2286 | set the major mode only if that would change it. In other words |
| 2287 | we don't actually set it to the same mode the buffer already has." |
| 2288 | ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*- |
| 2289 | (let (end done mode modes) |
| 2290 | ;; Find a -*- mode tag |
| 2291 | (save-excursion |
| 2292 | (goto-char (point-min)) |
| 2293 | (skip-chars-forward " \t\n") |
| 2294 | (and enable-local-variables |
| 2295 | (setq end (set-auto-mode-1)) |
| 2296 | (if (save-excursion (search-forward ":" end t)) |
| 2297 | ;; Find all specifications for the `mode:' variable |
| 2298 | ;; and execute them left to right. |
| 2299 | (while (let ((case-fold-search t)) |
| 2300 | (or (and (looking-at "mode:") |
| 2301 | (goto-char (match-end 0))) |
| 2302 | (re-search-forward "[ \t;]mode:" end t))) |
| 2303 | (skip-chars-forward " \t") |
| 2304 | (let ((beg (point))) |
| 2305 | (if (search-forward ";" end t) |
| 2306 | (forward-char -1) |
| 2307 | (goto-char end)) |
| 2308 | (skip-chars-backward " \t") |
| 2309 | (push (intern (concat (downcase (buffer-substring beg (point))) "-mode")) |
| 2310 | modes))) |
| 2311 | ;; Simple -*-MODE-*- case. |
| 2312 | (push (intern (concat (downcase (buffer-substring (point) end)) |
| 2313 | "-mode")) |
| 2314 | modes)))) |
| 2315 | ;; If we found modes to use, invoke them now, outside the save-excursion. |
| 2316 | (if modes |
| 2317 | (catch 'nop |
| 2318 | (dolist (mode (nreverse modes)) |
| 2319 | (if (not (functionp mode)) |
| 2320 | (message "Ignoring unknown mode `%s'" mode) |
| 2321 | (setq done t) |
| 2322 | (or (set-auto-mode-0 mode keep-mode-if-same) |
| 2323 | ;; continuing would call minor modes again, toggling them off |
| 2324 | (throw 'nop nil)))))) |
| 2325 | ;; If we didn't, look for an interpreter specified in the first line. |
| 2326 | ;; As a special case, allow for things like "#!/bin/env perl", which |
| 2327 | ;; finds the interpreter anywhere in $PATH. |
| 2328 | (unless done |
| 2329 | (setq mode (save-excursion |
| 2330 | (goto-char (point-min)) |
| 2331 | (if (looking-at auto-mode-interpreter-regexp) |
| 2332 | (match-string 2) |
| 2333 | "")) |
| 2334 | ;; Map interpreter name to a mode, signalling we're done at the |
| 2335 | ;; same time. |
| 2336 | done (assoc (file-name-nondirectory mode) |
| 2337 | interpreter-mode-alist)) |
| 2338 | ;; If we found an interpreter mode to use, invoke it now. |
| 2339 | (if done |
| 2340 | (set-auto-mode-0 (cdr done) keep-mode-if-same))) |
| 2341 | ;; Next try matching the buffer beginning against magic-mode-alist. |
| 2342 | (unless done |
| 2343 | (if (setq done (save-excursion |
| 2344 | (goto-char (point-min)) |
| 2345 | (save-restriction |
| 2346 | (narrow-to-region (point-min) |
| 2347 | (min (point-max) |
| 2348 | (+ (point-min) magic-mode-regexp-match-limit))) |
| 2349 | (assoc-default nil magic-mode-alist |
| 2350 | (lambda (re dummy) |
| 2351 | (if (functionp re) |
| 2352 | (funcall re) |
| 2353 | (looking-at re))))))) |
| 2354 | (set-auto-mode-0 done keep-mode-if-same))) |
| 2355 | ;; Next compare the filename against the entries in auto-mode-alist. |
| 2356 | (unless done |
| 2357 | (if buffer-file-name |
| 2358 | (let ((name buffer-file-name) |
| 2359 | (remote-id (file-remote-p buffer-file-name))) |
| 2360 | ;; Remove remote file name identification. |
| 2361 | (when (and (stringp remote-id) |
| 2362 | (string-match (regexp-quote remote-id) name)) |
| 2363 | (setq name (substring name (match-end 0)))) |
| 2364 | ;; Remove backup-suffixes from file name. |
| 2365 | (setq name (file-name-sans-versions name)) |
| 2366 | (while name |
| 2367 | ;; Find first matching alist entry. |
| 2368 | (setq mode |
| 2369 | (if (memq system-type '(vax-vms windows-nt cygwin)) |
| 2370 | ;; System is case-insensitive. |
| 2371 | (let ((case-fold-search t)) |
| 2372 | (assoc-default name auto-mode-alist |
| 2373 | 'string-match)) |
| 2374 | ;; System is case-sensitive. |
| 2375 | (or |
| 2376 | ;; First match case-sensitively. |
| 2377 | (let ((case-fold-search nil)) |
| 2378 | (assoc-default name auto-mode-alist |
| 2379 | 'string-match)) |
| 2380 | ;; Fallback to case-insensitive match. |
| 2381 | (and auto-mode-case-fold |
| 2382 | (let ((case-fold-search t)) |
| 2383 | (assoc-default name auto-mode-alist |
| 2384 | 'string-match)))))) |
| 2385 | (if (and mode |
| 2386 | (consp mode) |
| 2387 | (cadr mode)) |
| 2388 | (setq mode (car mode) |
| 2389 | name (substring name 0 (match-beginning 0))) |
| 2390 | (setq name)) |
| 2391 | (when mode |
| 2392 | (set-auto-mode-0 mode keep-mode-if-same) |
| 2393 | (setq done t)))))) |
| 2394 | ;; Next try matching the buffer beginning against magic-fallback-mode-alist. |
| 2395 | (unless done |
| 2396 | (if (setq done (save-excursion |
| 2397 | (goto-char (point-min)) |
| 2398 | (save-restriction |
| 2399 | (narrow-to-region (point-min) |
| 2400 | (min (point-max) |
| 2401 | (+ (point-min) magic-mode-regexp-match-limit))) |
| 2402 | (assoc-default nil magic-fallback-mode-alist |
| 2403 | (lambda (re dummy) |
| 2404 | (if (functionp re) |
| 2405 | (funcall re) |
| 2406 | (looking-at re))))))) |
| 2407 | (set-auto-mode-0 done keep-mode-if-same))))) |
| 2408 | |
| 2409 | ;; When `keep-mode-if-same' is set, we are working on behalf of |
| 2410 | ;; set-visited-file-name. In that case, if the major mode specified is the |
| 2411 | ;; same one we already have, don't actually reset it. We don't want to lose |
| 2412 | ;; minor modes such as Font Lock. |
| 2413 | (defun set-auto-mode-0 (mode &optional keep-mode-if-same) |
| 2414 | "Apply MODE and return it. |
| 2415 | If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of |
| 2416 | any aliases and compared to current major mode. If they are the |
| 2417 | same, do nothing and return nil." |
| 2418 | (unless (and keep-mode-if-same |
| 2419 | (eq (indirect-function mode) |
| 2420 | (indirect-function major-mode))) |
| 2421 | (when mode |
| 2422 | (funcall mode) |
| 2423 | mode))) |
| 2424 | |
| 2425 | (defun set-auto-mode-1 () |
| 2426 | "Find the -*- spec in the buffer. |
| 2427 | Call with point at the place to start searching from. |
| 2428 | If one is found, set point to the beginning |
| 2429 | and return the position of the end. |
| 2430 | Otherwise, return nil; point may be changed." |
| 2431 | (let (beg end) |
| 2432 | (and |
| 2433 | ;; Don't look for -*- if this file name matches any |
| 2434 | ;; of the regexps in inhibit-first-line-modes-regexps. |
| 2435 | (let ((temp inhibit-first-line-modes-regexps) |
| 2436 | (name (if buffer-file-name |
| 2437 | (file-name-sans-versions buffer-file-name) |
| 2438 | (buffer-name)))) |
| 2439 | (while (let ((sufs inhibit-first-line-modes-suffixes)) |
| 2440 | (while (and sufs (not (string-match (car sufs) name))) |
| 2441 | (setq sufs (cdr sufs))) |
| 2442 | sufs) |
| 2443 | (setq name (substring name 0 (match-beginning 0)))) |
| 2444 | (while (and temp |
| 2445 | (not (string-match (car temp) name))) |
| 2446 | (setq temp (cdr temp))) |
| 2447 | (not temp)) |
| 2448 | |
| 2449 | (search-forward "-*-" (line-end-position |
| 2450 | ;; If the file begins with "#!" |
| 2451 | ;; (exec interpreter magic), look |
| 2452 | ;; for mode frobs in the first two |
| 2453 | ;; lines. You cannot necessarily |
| 2454 | ;; put them in the first line of |
| 2455 | ;; such a file without screwing up |
| 2456 | ;; the interpreter invocation. |
| 2457 | ;; The same holds for |
| 2458 | ;; '\" |
| 2459 | ;; in man pages (preprocessor |
| 2460 | ;; magic for the `man' program). |
| 2461 | (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t) |
| 2462 | (progn |
| 2463 | (skip-chars-forward " \t") |
| 2464 | (setq beg (point)) |
| 2465 | (search-forward "-*-" (line-end-position) t)) |
| 2466 | (progn |
| 2467 | (forward-char -3) |
| 2468 | (skip-chars-backward " \t") |
| 2469 | (setq end (point)) |
| 2470 | (goto-char beg) |
| 2471 | end)))) |
| 2472 | \f |
| 2473 | ;;; Handling file local variables |
| 2474 | |
| 2475 | (defvar ignored-local-variables |
| 2476 | '(ignored-local-variables safe-local-variable-values) |
| 2477 | "Variables to be ignored in a file's local variable spec.") |
| 2478 | |
| 2479 | (defvar hack-local-variables-hook nil |
| 2480 | "Normal hook run after processing a file's local variables specs. |
| 2481 | Major modes can use this to examine user-specified local variables |
| 2482 | in order to initialize other data structure based on them.") |
| 2483 | |
| 2484 | (defcustom safe-local-variable-values nil |
| 2485 | "List variable-value pairs that are considered safe. |
| 2486 | Each element is a cons cell (VAR . VAL), where VAR is a variable |
| 2487 | symbol and VAL is a value that is considered safe." |
| 2488 | :group 'find-file |
| 2489 | :type 'alist) |
| 2490 | |
| 2491 | (defcustom safe-local-eval-forms nil |
| 2492 | "Expressions that are considered safe in an `eval:' local variable. |
| 2493 | Add expressions to this list if you want Emacs to evaluate them, when |
| 2494 | they appear in an `eval' local variable specification, without first |
| 2495 | asking you for confirmation." |
| 2496 | :group 'find-file |
| 2497 | :version "22.1" |
| 2498 | :type '(repeat sexp)) |
| 2499 | |
| 2500 | ;; Risky local variables: |
| 2501 | (mapc (lambda (var) (put var 'risky-local-variable t)) |
| 2502 | '(after-load-alist |
| 2503 | auto-mode-alist |
| 2504 | buffer-auto-save-file-name |
| 2505 | buffer-file-name |
| 2506 | buffer-file-truename |
| 2507 | buffer-undo-list |
| 2508 | dabbrev-case-fold-search |
| 2509 | dabbrev-case-replace |
| 2510 | debugger |
| 2511 | default-text-properties |
| 2512 | display-time-string |
| 2513 | enable-local-eval |
| 2514 | enable-local-variables |
| 2515 | eval |
| 2516 | exec-directory |
| 2517 | exec-path |
| 2518 | file-name-handler-alist |
| 2519 | font-lock-defaults |
| 2520 | format-alist |
| 2521 | frame-title-format |
| 2522 | global-mode-string |
| 2523 | header-line-format |
| 2524 | icon-title-format |
| 2525 | ignored-local-variables |
| 2526 | imenu--index-alist |
| 2527 | imenu-generic-expression |
| 2528 | inhibit-quit |
| 2529 | input-method-alist |
| 2530 | load-path |
| 2531 | max-lisp-eval-depth |
| 2532 | max-specpdl-size |
| 2533 | minor-mode-alist |
| 2534 | minor-mode-map-alist |
| 2535 | minor-mode-overriding-map-alist |
| 2536 | mode-line-buffer-identification |
| 2537 | mode-line-format |
| 2538 | mode-line-client |
| 2539 | mode-line-modes |
| 2540 | mode-line-modified |
| 2541 | mode-line-mule-info |
| 2542 | mode-line-position |
| 2543 | mode-line-process |
| 2544 | mode-line-remote |
| 2545 | mode-name |
| 2546 | outline-level |
| 2547 | overriding-local-map |
| 2548 | overriding-terminal-local-map |
| 2549 | parse-time-rules |
| 2550 | process-environment |
| 2551 | rmail-output-file-alist |
| 2552 | safe-local-variable-values |
| 2553 | safe-local-eval-forms |
| 2554 | save-some-buffers-action-alist |
| 2555 | special-display-buffer-names |
| 2556 | standard-input |
| 2557 | standard-output |
| 2558 | unread-command-events |
| 2559 | vc-mode)) |
| 2560 | |
| 2561 | ;; Safe local variables: |
| 2562 | ;; |
| 2563 | ;; For variables defined by major modes, the safety declarations can go into |
| 2564 | ;; the major mode's file, since that will be loaded before file variables are |
| 2565 | ;; processed. |
| 2566 | ;; |
| 2567 | ;; For variables defined by minor modes, put the safety declarations in the |
| 2568 | ;; file defining the minor mode after the defcustom/defvar using an autoload |
| 2569 | ;; cookie, e.g.: |
| 2570 | ;; |
| 2571 | ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp) |
| 2572 | ;; |
| 2573 | ;; Otherwise, when Emacs visits a file specifying that local variable, the |
| 2574 | ;; minor mode file may not be loaded yet. |
| 2575 | ;; |
| 2576 | ;; For variables defined in the C source code the declaration should go here: |
| 2577 | |
| 2578 | (mapc (lambda (pair) |
| 2579 | (put (car pair) 'safe-local-variable (cdr pair))) |
| 2580 | '((buffer-read-only . booleanp) ;; C source code |
| 2581 | (default-directory . stringp) ;; C source code |
| 2582 | (fill-column . integerp) ;; C source code |
| 2583 | (indent-tabs-mode . booleanp) ;; C source code |
| 2584 | (left-margin . integerp) ;; C source code |
| 2585 | (no-update-autoloads . booleanp) |
| 2586 | (tab-width . integerp) ;; C source code |
| 2587 | (truncate-lines . booleanp))) ;; C source code |
| 2588 | |
| 2589 | (put 'c-set-style 'safe-local-eval-function t) |
| 2590 | |
| 2591 | (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars) |
| 2592 | "Get confirmation before setting up local variable values. |
| 2593 | ALL-VARS is the list of all variables to be set up. |
| 2594 | UNSAFE-VARS is the list of those that aren't marked as safe or risky. |
| 2595 | RISKY-VARS is the list of those that are marked as risky." |
| 2596 | (if noninteractive |
| 2597 | nil |
| 2598 | (let ((name (if buffer-file-name |
| 2599 | (file-name-nondirectory buffer-file-name) |
| 2600 | (concat "buffer " (buffer-name)))) |
| 2601 | (offer-save (and (eq enable-local-variables t) unsafe-vars)) |
| 2602 | prompt char) |
| 2603 | (save-window-excursion |
| 2604 | (let ((buf (get-buffer-create "*Local Variables*"))) |
| 2605 | (pop-to-buffer buf) |
| 2606 | (set (make-local-variable 'cursor-type) nil) |
| 2607 | (erase-buffer) |
| 2608 | (if unsafe-vars |
| 2609 | (insert "The local variables list in " name |
| 2610 | "\ncontains values that may not be safe (*)" |
| 2611 | (if risky-vars |
| 2612 | ", and variables that are risky (**)." |
| 2613 | ".")) |
| 2614 | (if risky-vars |
| 2615 | (insert "The local variables list in " name |
| 2616 | "\ncontains variables that are risky (**).") |
| 2617 | (insert "A local variables list is specified in " name "."))) |
| 2618 | (insert "\n\nDo you want to apply it? You can type |
| 2619 | y -- to apply the local variables list. |
| 2620 | n -- to ignore the local variables list.") |
| 2621 | (if offer-save |
| 2622 | (insert " |
| 2623 | ! -- to apply the local variables list, and permanently mark these |
| 2624 | values (*) as safe (in the future, they will be set automatically.)\n\n") |
| 2625 | (insert "\n\n")) |
| 2626 | (dolist (elt all-vars) |
| 2627 | (cond ((member elt unsafe-vars) |
| 2628 | (insert " * ")) |
| 2629 | ((member elt risky-vars) |
| 2630 | (insert " ** ")) |
| 2631 | (t |
| 2632 | (insert " "))) |
| 2633 | (princ (car elt) buf) |
| 2634 | (insert " : ") |
| 2635 | ;; Make strings with embedded whitespace easier to read. |
| 2636 | (let ((print-escape-newlines t)) |
| 2637 | (prin1 (cdr elt) buf)) |
| 2638 | (insert "\n")) |
| 2639 | (setq prompt |
| 2640 | (format "Please type %s%s: " |
| 2641 | (if offer-save "y, n, or !" "y or n") |
| 2642 | (if (< (line-number-at-pos) (window-body-height)) |
| 2643 | "" |
| 2644 | ", or C-v to scroll"))) |
| 2645 | (goto-char (point-min)) |
| 2646 | (let ((cursor-in-echo-area t) |
| 2647 | (executing-kbd-macro executing-kbd-macro) |
| 2648 | (exit-chars |
| 2649 | (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g))) |
| 2650 | done) |
| 2651 | (while (not done) |
| 2652 | (message "%s" prompt) |
| 2653 | (setq char (read-event)) |
| 2654 | (if (numberp char) |
| 2655 | (cond ((eq char ?\C-v) |
| 2656 | (condition-case nil |
| 2657 | (scroll-up) |
| 2658 | (error (goto-char (point-min))))) |
| 2659 | ;; read-event returns -1 if we are in a kbd |
| 2660 | ;; macro and there are no more events in the |
| 2661 | ;; macro. In that case, attempt to get an |
| 2662 | ;; event interactively. |
| 2663 | ((and executing-kbd-macro (= char -1)) |
| 2664 | (setq executing-kbd-macro nil)) |
| 2665 | (t (setq done (memq (downcase char) exit-chars))))))) |
| 2666 | (setq char (downcase char)) |
| 2667 | (when (and offer-save (= char ?!) unsafe-vars) |
| 2668 | (dolist (elt unsafe-vars) |
| 2669 | (add-to-list 'safe-local-variable-values elt)) |
| 2670 | ;; When this is called from desktop-restore-file-buffer, |
| 2671 | ;; coding-system-for-read may be non-nil. Reset it before |
| 2672 | ;; writing to .emacs. |
| 2673 | (if (or custom-file user-init-file) |
| 2674 | (let ((coding-system-for-read nil)) |
| 2675 | (customize-save-variable |
| 2676 | 'safe-local-variable-values |
| 2677 | safe-local-variable-values)))) |
| 2678 | (kill-buffer buf) |
| 2679 | (or (= char ?!) |
| 2680 | (= char ?\s) |
| 2681 | (= char ?y))))))) |
| 2682 | |
| 2683 | (defun hack-local-variables-prop-line (&optional mode-only) |
| 2684 | "Return local variables specified in the -*- line. |
| 2685 | Ignore any specification for `mode:' and `coding:'; |
| 2686 | `set-auto-mode' should already have handled `mode:', |
| 2687 | `set-auto-coding' should already have handled `coding:'. |
| 2688 | |
| 2689 | If MODE-ONLY is non-nil, all we do is check whether the major |
| 2690 | mode is specified, returning t if it is specified. Otherwise, |
| 2691 | return an alist of elements (VAR . VAL), where VAR is a variable |
| 2692 | and VAL is the specified value." |
| 2693 | (save-excursion |
| 2694 | (goto-char (point-min)) |
| 2695 | (let ((end (set-auto-mode-1)) |
| 2696 | result mode-specified) |
| 2697 | ;; Parse the -*- line into the RESULT alist. |
| 2698 | ;; Also set MODE-SPECIFIED if we see a spec or `mode'. |
| 2699 | (cond ((not end) |
| 2700 | nil) |
| 2701 | ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)") |
| 2702 | ;; Simple form: "-*- MODENAME -*-". Already handled. |
| 2703 | (setq mode-specified t) |
| 2704 | nil) |
| 2705 | (t |
| 2706 | ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-' |
| 2707 | ;; (last ";" is optional). |
| 2708 | (while (< (point) end) |
| 2709 | (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*") |
| 2710 | (error "Malformed -*- line")) |
| 2711 | (goto-char (match-end 0)) |
| 2712 | ;; There used to be a downcase here, |
| 2713 | ;; but the manual didn't say so, |
| 2714 | ;; and people want to set var names that aren't all lc. |
| 2715 | (let ((key (intern (match-string 1))) |
| 2716 | (val (save-restriction |
| 2717 | (narrow-to-region (point) end) |
| 2718 | (read (current-buffer))))) |
| 2719 | ;; It is traditional to ignore |
| 2720 | ;; case when checking for `mode' in set-auto-mode, |
| 2721 | ;; so we must do that here as well. |
| 2722 | ;; That is inconsistent, but we're stuck with it. |
| 2723 | ;; The same can be said for `coding' in set-auto-coding. |
| 2724 | (or (and (equal (downcase (symbol-name key)) "mode") |
| 2725 | (setq mode-specified t)) |
| 2726 | (equal (downcase (symbol-name key)) "coding") |
| 2727 | (condition-case nil |
| 2728 | (push (cons (if (eq key 'eval) |
| 2729 | 'eval |
| 2730 | (indirect-variable key)) |
| 2731 | val) result) |
| 2732 | (error nil))) |
| 2733 | (skip-chars-forward " \t;"))))) |
| 2734 | |
| 2735 | (if mode-only |
| 2736 | mode-specified |
| 2737 | result)))) |
| 2738 | |
| 2739 | (defun hack-local-variables (&optional mode-only) |
| 2740 | "Parse and put into effect this buffer's local variables spec. |
| 2741 | If MODE-ONLY is non-nil, all we do is check whether the major mode |
| 2742 | is specified, returning t if it is specified." |
| 2743 | (let ((enable-local-variables |
| 2744 | (and local-enable-local-variables enable-local-variables)) |
| 2745 | result) |
| 2746 | (when (or mode-only enable-local-variables) |
| 2747 | (setq result (hack-local-variables-prop-line mode-only)) |
| 2748 | ;; Look for "Local variables:" line in last page. |
| 2749 | (save-excursion |
| 2750 | (goto-char (point-max)) |
| 2751 | (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) |
| 2752 | 'move) |
| 2753 | (when (let ((case-fold-search t)) |
| 2754 | (search-forward "Local Variables:" nil t)) |
| 2755 | (skip-chars-forward " \t") |
| 2756 | ;; suffix is what comes after "local variables:" in its line. |
| 2757 | ;; prefix is what comes before "local variables:" in its line. |
| 2758 | (let ((suffix |
| 2759 | (concat |
| 2760 | (regexp-quote (buffer-substring (point) |
| 2761 | (line-end-position))) |
| 2762 | "$")) |
| 2763 | (prefix |
| 2764 | (concat "^" (regexp-quote |
| 2765 | (buffer-substring (line-beginning-position) |
| 2766 | (match-beginning 0))))) |
| 2767 | beg) |
| 2768 | |
| 2769 | (forward-line 1) |
| 2770 | (let ((startpos (point)) |
| 2771 | endpos |
| 2772 | (thisbuf (current-buffer))) |
| 2773 | (save-excursion |
| 2774 | (unless (let ((case-fold-search t)) |
| 2775 | (re-search-forward |
| 2776 | (concat prefix "[ \t]*End:[ \t]*" suffix) |
| 2777 | nil t)) |
| 2778 | (error "Local variables list is not properly terminated")) |
| 2779 | (beginning-of-line) |
| 2780 | (setq endpos (point))) |
| 2781 | |
| 2782 | (with-temp-buffer |
| 2783 | (insert-buffer-substring thisbuf startpos endpos) |
| 2784 | (goto-char (point-min)) |
| 2785 | (subst-char-in-region (point) (point-max) ?\^m ?\n) |
| 2786 | (while (not (eobp)) |
| 2787 | ;; Discard the prefix. |
| 2788 | (if (looking-at prefix) |
| 2789 | (delete-region (point) (match-end 0)) |
| 2790 | (error "Local variables entry is missing the prefix")) |
| 2791 | (end-of-line) |
| 2792 | ;; Discard the suffix. |
| 2793 | (if (looking-back suffix) |
| 2794 | (delete-region (match-beginning 0) (point)) |
| 2795 | (error "Local variables entry is missing the suffix")) |
| 2796 | (forward-line 1)) |
| 2797 | (goto-char (point-min)) |
| 2798 | |
| 2799 | (while (not (eobp)) |
| 2800 | ;; Find the variable name; strip whitespace. |
| 2801 | (skip-chars-forward " \t") |
| 2802 | (setq beg (point)) |
| 2803 | (skip-chars-forward "^:\n") |
| 2804 | (if (eolp) (error "Missing colon in local variables entry")) |
| 2805 | (skip-chars-backward " \t") |
| 2806 | (let* ((str (buffer-substring beg (point))) |
| 2807 | (var (read str)) |
| 2808 | val) |
| 2809 | ;; Read the variable value. |
| 2810 | (skip-chars-forward "^:") |
| 2811 | (forward-char 1) |
| 2812 | (setq val (read (current-buffer))) |
| 2813 | (if mode-only |
| 2814 | (if (eq var 'mode) |
| 2815 | (setq result t)) |
| 2816 | (unless (eq var 'coding) |
| 2817 | (condition-case nil |
| 2818 | (push (cons (if (eq var 'eval) |
| 2819 | 'eval |
| 2820 | (indirect-variable var)) |
| 2821 | val) result) |
| 2822 | (error nil))))) |
| 2823 | (forward-line 1))))))) |
| 2824 | |
| 2825 | ;; We've read all the local variables. Now, return whether the |
| 2826 | ;; mode is specified (if MODE-ONLY is non-nil), or set the |
| 2827 | ;; variables (if MODE-ONLY is nil.) |
| 2828 | (if mode-only |
| 2829 | result |
| 2830 | (dolist (ignored ignored-local-variables) |
| 2831 | (setq result (assq-delete-all ignored result))) |
| 2832 | (if (null enable-local-eval) |
| 2833 | (setq result (assq-delete-all 'eval result))) |
| 2834 | (when result |
| 2835 | (setq result (nreverse result)) |
| 2836 | ;; Find those variables that we may want to save to |
| 2837 | ;; `safe-local-variable-values'. |
| 2838 | (let (risky-vars unsafe-vars) |
| 2839 | (dolist (elt result) |
| 2840 | (let ((var (car elt)) |
| 2841 | (val (cdr elt))) |
| 2842 | (or (eq var 'mode) |
| 2843 | (and (eq var 'eval) |
| 2844 | (or (eq enable-local-eval t) |
| 2845 | (hack-one-local-variable-eval-safep |
| 2846 | (eval (quote val))))) |
| 2847 | (safe-local-variable-p var val) |
| 2848 | (and (risky-local-variable-p var val) |
| 2849 | (push elt risky-vars)) |
| 2850 | (push elt unsafe-vars)))) |
| 2851 | (if (eq enable-local-variables :safe) |
| 2852 | ;; If caller wants only the safe variables, |
| 2853 | ;; install only them. |
| 2854 | (dolist (elt result) |
| 2855 | (unless (or (member elt unsafe-vars) |
| 2856 | (member elt risky-vars)) |
| 2857 | (hack-one-local-variable (car elt) (cdr elt)))) |
| 2858 | ;; Query, except in the case where all are known safe |
| 2859 | ;; if the user wants no quuery in that case. |
| 2860 | (if (or (and (eq enable-local-variables t) |
| 2861 | (null unsafe-vars) |
| 2862 | (null risky-vars)) |
| 2863 | (eq enable-local-variables :all) |
| 2864 | (hack-local-variables-confirm |
| 2865 | result unsafe-vars risky-vars)) |
| 2866 | (dolist (elt result) |
| 2867 | (hack-one-local-variable (car elt) (cdr elt))))))) |
| 2868 | (run-hooks 'hack-local-variables-hook))))) |
| 2869 | |
| 2870 | (defun safe-local-variable-p (sym val) |
| 2871 | "Non-nil if SYM is safe as a file-local variable with value VAL. |
| 2872 | It is safe if any of these conditions are met: |
| 2873 | |
| 2874 | * There is a matching entry (SYM . VAL) in the |
| 2875 | `safe-local-variable-values' user option. |
| 2876 | |
| 2877 | * The `safe-local-variable' property of SYM is a function that |
| 2878 | evaluates to a non-nil value with VAL as an argument." |
| 2879 | (or (member (cons sym val) safe-local-variable-values) |
| 2880 | (let ((safep (get sym 'safe-local-variable))) |
| 2881 | (and (functionp safep) (funcall safep val))))) |
| 2882 | |
| 2883 | (defun risky-local-variable-p (sym &optional ignored) |
| 2884 | "Non-nil if SYM could be dangerous as a file-local variable. |
| 2885 | It is dangerous if either of these conditions are met: |
| 2886 | |
| 2887 | * Its `risky-local-variable' property is non-nil. |
| 2888 | |
| 2889 | * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\", |
| 2890 | \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\", |
| 2891 | \"mode-alist\", \"font-lock-(syntactic-)keyword*\", |
| 2892 | \"map-alist\", or \"bindat-spec\"." |
| 2893 | ;; If this is an alias, check the base name. |
| 2894 | (condition-case nil |
| 2895 | (setq sym (indirect-variable sym)) |
| 2896 | (error nil)) |
| 2897 | (or (get sym 'risky-local-variable) |
| 2898 | (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\ |
| 2899 | -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\ |
| 2900 | -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\ |
| 2901 | -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym)))) |
| 2902 | |
| 2903 | (defun hack-one-local-variable-quotep (exp) |
| 2904 | (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp)))) |
| 2905 | |
| 2906 | (defun hack-one-local-variable-constantp (exp) |
| 2907 | (or (and (not (symbolp exp)) (not (consp exp))) |
| 2908 | (memq exp '(t nil)) |
| 2909 | (keywordp exp) |
| 2910 | (hack-one-local-variable-quotep exp))) |
| 2911 | |
| 2912 | (defun hack-one-local-variable-eval-safep (exp) |
| 2913 | "Return t if it is safe to eval EXP when it is found in a file." |
| 2914 | (or (not (consp exp)) |
| 2915 | ;; Detect certain `put' expressions. |
| 2916 | (and (eq (car exp) 'put) |
| 2917 | (hack-one-local-variable-quotep (nth 1 exp)) |
| 2918 | (hack-one-local-variable-quotep (nth 2 exp)) |
| 2919 | (let ((prop (nth 1 (nth 2 exp))) (val (nth 3 exp))) |
| 2920 | (cond ((eq prop 'lisp-indent-hook) |
| 2921 | ;; Only allow safe values of lisp-indent-hook; |
| 2922 | ;; not functions. |
| 2923 | (or (numberp val) (equal val ''defun))) |
| 2924 | ((eq prop 'edebug-form-spec) |
| 2925 | ;; Only allow indirect form specs. |
| 2926 | ;; During bootstrapping, edebug-basic-spec might not be |
| 2927 | ;; defined yet. |
| 2928 | (and (fboundp 'edebug-basic-spec) |
| 2929 | (hack-one-local-variable-quotep val) |
| 2930 | (edebug-basic-spec (nth 1 val))))))) |
| 2931 | ;; Allow expressions that the user requested. |
| 2932 | (member exp safe-local-eval-forms) |
| 2933 | ;; Certain functions can be allowed with safe arguments |
| 2934 | ;; or can specify verification functions to try. |
| 2935 | (and (symbolp (car exp)) |
| 2936 | (let ((prop (get (car exp) 'safe-local-eval-function))) |
| 2937 | (cond ((eq prop t) |
| 2938 | (let ((ok t)) |
| 2939 | (dolist (arg (cdr exp)) |
| 2940 | (unless (hack-one-local-variable-constantp arg) |
| 2941 | (setq ok nil))) |
| 2942 | ok)) |
| 2943 | ((functionp prop) |
| 2944 | (funcall prop exp)) |
| 2945 | ((listp prop) |
| 2946 | (let ((ok nil)) |
| 2947 | (dolist (function prop) |
| 2948 | (if (funcall function exp) |
| 2949 | (setq ok t))) |
| 2950 | ok))))))) |
| 2951 | |
| 2952 | (defun hack-one-local-variable (var val) |
| 2953 | "Set local variable VAR with value VAL. |
| 2954 | If VAR is `mode', call `VAL-mode' as a function unless it's |
| 2955 | already the major mode." |
| 2956 | (cond ((eq var 'mode) |
| 2957 | (let ((mode (intern (concat (downcase (symbol-name val)) |
| 2958 | "-mode")))) |
| 2959 | (unless (eq (indirect-function mode) |
| 2960 | (indirect-function major-mode)) |
| 2961 | (funcall mode)))) |
| 2962 | ((eq var 'eval) |
| 2963 | (save-excursion (eval val))) |
| 2964 | (t |
| 2965 | ;; Make sure the string has no text properties. |
| 2966 | ;; Some text properties can get evaluated in various ways, |
| 2967 | ;; so it is risky to put them on with a local variable list. |
| 2968 | (if (stringp val) |
| 2969 | (set-text-properties 0 (length val) nil val)) |
| 2970 | (set (make-local-variable var) val)))) |
| 2971 | |
| 2972 | \f |
| 2973 | (defcustom change-major-mode-with-file-name t |
| 2974 | "Non-nil means \\[write-file] should set the major mode from the file name. |
| 2975 | However, the mode will not be changed if |
| 2976 | \(1) a local variables list or the `-*-' line specifies a major mode, or |
| 2977 | \(2) the current major mode is a \"special\" mode, |
| 2978 | \ not suitable for ordinary files, or |
| 2979 | \(3) the new file name does not particularly specify any mode." |
| 2980 | :type 'boolean |
| 2981 | :group 'editing-basics) |
| 2982 | |
| 2983 | (defun set-visited-file-name (filename &optional no-query along-with-file) |
| 2984 | "Change name of file visited in current buffer to FILENAME. |
| 2985 | This also renames the buffer to correspond to the new file. |
| 2986 | The next time the buffer is saved it will go in the newly specified file. |
| 2987 | FILENAME nil or an empty string means mark buffer as not visiting any file. |
| 2988 | Remember to delete the initial contents of the minibuffer |
| 2989 | if you wish to pass an empty string as the argument. |
| 2990 | |
| 2991 | The optional second argument NO-QUERY, if non-nil, inhibits asking for |
| 2992 | confirmation in the case where another buffer is already visiting FILENAME. |
| 2993 | |
| 2994 | The optional third argument ALONG-WITH-FILE, if non-nil, means that |
| 2995 | the old visited file has been renamed to the new name FILENAME." |
| 2996 | (interactive "FSet visited file name: ") |
| 2997 | (if (buffer-base-buffer) |
| 2998 | (error "An indirect buffer cannot visit a file")) |
| 2999 | (let (truename) |
| 3000 | (if filename |
| 3001 | (setq filename |
| 3002 | (if (string-equal filename "") |
| 3003 | nil |
| 3004 | (expand-file-name filename)))) |
| 3005 | (if filename |
| 3006 | (progn |
| 3007 | (setq truename (file-truename filename)) |
| 3008 | (if find-file-visit-truename |
| 3009 | (setq filename truename)))) |
| 3010 | (if filename |
| 3011 | (let ((new-name (file-name-nondirectory filename))) |
| 3012 | (if (string= new-name "") |
| 3013 | (error "Empty file name")))) |
| 3014 | (let ((buffer (and filename (find-buffer-visiting filename)))) |
| 3015 | (and buffer (not (eq buffer (current-buffer))) |
| 3016 | (not no-query) |
| 3017 | (not (y-or-n-p (format "A buffer is visiting %s; proceed? " |
| 3018 | filename))) |
| 3019 | (error "Aborted"))) |
| 3020 | (or (equal filename buffer-file-name) |
| 3021 | (progn |
| 3022 | (and filename (lock-buffer filename)) |
| 3023 | (unlock-buffer))) |
| 3024 | (setq buffer-file-name filename) |
| 3025 | (if filename ; make buffer name reflect filename. |
| 3026 | (let ((new-name (file-name-nondirectory buffer-file-name))) |
| 3027 | (if (eq system-type 'vax-vms) |
| 3028 | (setq new-name (downcase new-name))) |
| 3029 | (setq default-directory (file-name-directory buffer-file-name)) |
| 3030 | ;; If new-name == old-name, renaming would add a spurious <2> |
| 3031 | ;; and it's considered as a feature in rename-buffer. |
| 3032 | (or (string= new-name (buffer-name)) |
| 3033 | (rename-buffer new-name t)))) |
| 3034 | (setq buffer-backed-up nil) |
| 3035 | (or along-with-file |
| 3036 | (clear-visited-file-modtime)) |
| 3037 | ;; Abbreviate the file names of the buffer. |
| 3038 | (if truename |
| 3039 | (progn |
| 3040 | (setq buffer-file-truename (abbreviate-file-name truename)) |
| 3041 | (if find-file-visit-truename |
| 3042 | (setq buffer-file-name truename)))) |
| 3043 | (setq buffer-file-number |
| 3044 | (if filename |
| 3045 | (nthcdr 10 (file-attributes buffer-file-name)) |
| 3046 | nil))) |
| 3047 | ;; write-file-functions is normally used for things like ftp-find-file |
| 3048 | ;; that visit things that are not local files as if they were files. |
| 3049 | ;; Changing to visit an ordinary local file instead should flush the hook. |
| 3050 | (kill-local-variable 'write-file-functions) |
| 3051 | (kill-local-variable 'local-write-file-hooks) |
| 3052 | (kill-local-variable 'revert-buffer-function) |
| 3053 | (kill-local-variable 'backup-inhibited) |
| 3054 | ;; If buffer was read-only because of version control, |
| 3055 | ;; that reason is gone now, so make it writable. |
| 3056 | (if vc-mode |
| 3057 | (setq buffer-read-only nil)) |
| 3058 | (kill-local-variable 'vc-mode) |
| 3059 | ;; Turn off backup files for certain file names. |
| 3060 | ;; Since this is a permanent local, the major mode won't eliminate it. |
| 3061 | (and buffer-file-name |
| 3062 | backup-enable-predicate |
| 3063 | (not (funcall backup-enable-predicate buffer-file-name)) |
| 3064 | (progn |
| 3065 | (make-local-variable 'backup-inhibited) |
| 3066 | (setq backup-inhibited t))) |
| 3067 | (let ((oauto buffer-auto-save-file-name)) |
| 3068 | ;; If auto-save was not already on, turn it on if appropriate. |
| 3069 | (if (not buffer-auto-save-file-name) |
| 3070 | (and buffer-file-name auto-save-default |
| 3071 | (auto-save-mode t)) |
| 3072 | ;; If auto save is on, start using a new name. |
| 3073 | ;; We deliberately don't rename or delete the old auto save |
| 3074 | ;; for the old visited file name. This is because perhaps |
| 3075 | ;; the user wants to save the new state and then compare with the |
| 3076 | ;; previous state from the auto save file. |
| 3077 | (setq buffer-auto-save-file-name |
| 3078 | (make-auto-save-file-name))) |
| 3079 | ;; Rename the old auto save file if any. |
| 3080 | (and oauto buffer-auto-save-file-name |
| 3081 | (file-exists-p oauto) |
| 3082 | (rename-file oauto buffer-auto-save-file-name t))) |
| 3083 | (and buffer-file-name |
| 3084 | (not along-with-file) |
| 3085 | (set-buffer-modified-p t)) |
| 3086 | ;; Update the major mode, if the file name determines it. |
| 3087 | (condition-case nil |
| 3088 | ;; Don't change the mode if it is special. |
| 3089 | (or (not change-major-mode-with-file-name) |
| 3090 | (get major-mode 'mode-class) |
| 3091 | ;; Don't change the mode if the local variable list specifies it. |
| 3092 | (hack-local-variables t) |
| 3093 | (set-auto-mode t)) |
| 3094 | (error nil))) |
| 3095 | |
| 3096 | (defun write-file (filename &optional confirm) |
| 3097 | "Write current buffer into file FILENAME. |
| 3098 | This makes the buffer visit that file, and marks it as not modified. |
| 3099 | |
| 3100 | If you specify just a directory name as FILENAME, that means to use |
| 3101 | the default file name but in that directory. You can also yank |
| 3102 | the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element]. |
| 3103 | |
| 3104 | If the buffer is not already visiting a file, the default file name |
| 3105 | for the output file is the buffer name. |
| 3106 | |
| 3107 | If optional second arg CONFIRM is non-nil, this function |
| 3108 | asks for confirmation before overwriting an existing file. |
| 3109 | Interactively, confirmation is required unless you supply a prefix argument." |
| 3110 | ;; (interactive "FWrite file: ") |
| 3111 | (interactive |
| 3112 | (list (if buffer-file-name |
| 3113 | (read-file-name "Write file: " |
| 3114 | nil nil nil nil) |
| 3115 | (read-file-name "Write file: " default-directory |
| 3116 | (expand-file-name |
| 3117 | (file-name-nondirectory (buffer-name)) |
| 3118 | default-directory) |
| 3119 | nil nil)) |
| 3120 | (not current-prefix-arg))) |
| 3121 | (or (null filename) (string-equal filename "") |
| 3122 | (progn |
| 3123 | ;; If arg is just a directory, |
| 3124 | ;; use the default file name, but in that directory. |
| 3125 | (if (file-directory-p filename) |
| 3126 | (setq filename (concat (file-name-as-directory filename) |
| 3127 | (file-name-nondirectory |
| 3128 | (or buffer-file-name (buffer-name)))))) |
| 3129 | (and confirm |
| 3130 | (file-exists-p filename) |
| 3131 | (or (y-or-n-p (format "File `%s' exists; overwrite? " filename)) |
| 3132 | (error "Canceled"))) |
| 3133 | (set-visited-file-name filename (not confirm)))) |
| 3134 | (set-buffer-modified-p t) |
| 3135 | ;; Make buffer writable if file is writable. |
| 3136 | (and buffer-file-name |
| 3137 | (file-writable-p buffer-file-name) |
| 3138 | (setq buffer-read-only nil)) |
| 3139 | (save-buffer) |
| 3140 | ;; It's likely that the VC status at the new location is different from |
| 3141 | ;; the one at the old location. |
| 3142 | (vc-find-file-hook)) |
| 3143 | \f |
| 3144 | (defun backup-buffer () |
| 3145 | "Make a backup of the disk file visited by the current buffer, if appropriate. |
| 3146 | This is normally done before saving the buffer the first time. |
| 3147 | |
| 3148 | A backup may be done by renaming or by copying; see documentation of |
| 3149 | variable `make-backup-files'. If it's done by renaming, then the file is |
| 3150 | no longer accessible under its old name. |
| 3151 | |
| 3152 | The value is non-nil after a backup was made by renaming. |
| 3153 | It has the form (MODES . BACKUPNAME). |
| 3154 | MODES is the result of `file-modes' on the original |
| 3155 | file; this means that the caller, after saving the buffer, should change |
| 3156 | the modes of the new file to agree with the old modes. |
| 3157 | BACKUPNAME is the backup file name, which is the old file renamed." |
| 3158 | (if (and make-backup-files (not backup-inhibited) |
| 3159 | (not buffer-backed-up) |
| 3160 | (file-exists-p buffer-file-name) |
| 3161 | (memq (aref (elt (file-attributes buffer-file-name) 8) 0) |
| 3162 | '(?- ?l))) |
| 3163 | (let ((real-file-name buffer-file-name) |
| 3164 | backup-info backupname targets setmodes) |
| 3165 | ;; If specified name is a symbolic link, chase it to the target. |
| 3166 | ;; Thus we make the backups in the directory where the real file is. |
| 3167 | (setq real-file-name (file-chase-links real-file-name)) |
| 3168 | (setq backup-info (find-backup-file-name real-file-name) |
| 3169 | backupname (car backup-info) |
| 3170 | targets (cdr backup-info)) |
| 3171 | ;; (if (file-directory-p buffer-file-name) |
| 3172 | ;; (error "Cannot save buffer in directory %s" buffer-file-name)) |
| 3173 | (if backup-info |
| 3174 | (condition-case () |
| 3175 | (let ((delete-old-versions |
| 3176 | ;; If have old versions to maybe delete, |
| 3177 | ;; ask the user to confirm now, before doing anything. |
| 3178 | ;; But don't actually delete til later. |
| 3179 | (and targets |
| 3180 | (or (eq delete-old-versions t) (eq delete-old-versions nil)) |
| 3181 | (or delete-old-versions |
| 3182 | (y-or-n-p (format "Delete excess backup versions of %s? " |
| 3183 | real-file-name))))) |
| 3184 | (modes (file-modes buffer-file-name))) |
| 3185 | ;; Actually write the back up file. |
| 3186 | (condition-case () |
| 3187 | (if (or file-precious-flag |
| 3188 | ; (file-symlink-p buffer-file-name) |
| 3189 | backup-by-copying |
| 3190 | ;; Don't rename a suid or sgid file. |
| 3191 | (and modes (< 0 (logand modes #o6000))) |
| 3192 | (not (file-writable-p (file-name-directory real-file-name))) |
| 3193 | (and backup-by-copying-when-linked |
| 3194 | (> (file-nlinks real-file-name) 1)) |
| 3195 | (and (or backup-by-copying-when-mismatch |
| 3196 | (integerp backup-by-copying-when-privileged-mismatch)) |
| 3197 | (let ((attr (file-attributes real-file-name))) |
| 3198 | (and (or backup-by-copying-when-mismatch |
| 3199 | (and (integerp (nth 2 attr)) |
| 3200 | (integerp backup-by-copying-when-privileged-mismatch) |
| 3201 | (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch))) |
| 3202 | (or (nth 9 attr) |
| 3203 | (not (file-ownership-preserved-p real-file-name))))))) |
| 3204 | (backup-buffer-copy real-file-name backupname modes) |
| 3205 | ;; rename-file should delete old backup. |
| 3206 | (rename-file real-file-name backupname t) |
| 3207 | (setq setmodes (cons modes backupname))) |
| 3208 | (file-error |
| 3209 | ;; If trouble writing the backup, write it in ~. |
| 3210 | (setq backupname (expand-file-name |
| 3211 | (convert-standard-filename |
| 3212 | "~/%backup%~"))) |
| 3213 | (message "Cannot write backup file; backing up in %s" |
| 3214 | backupname) |
| 3215 | (sleep-for 1) |
| 3216 | (backup-buffer-copy real-file-name backupname modes))) |
| 3217 | (setq buffer-backed-up t) |
| 3218 | ;; Now delete the old versions, if desired. |
| 3219 | (if delete-old-versions |
| 3220 | (while targets |
| 3221 | (condition-case () |
| 3222 | (delete-file (car targets)) |
| 3223 | (file-error nil)) |
| 3224 | (setq targets (cdr targets)))) |
| 3225 | setmodes) |
| 3226 | (file-error nil)))))) |
| 3227 | |
| 3228 | (defun backup-buffer-copy (from-name to-name modes) |
| 3229 | (let ((umask (default-file-modes))) |
| 3230 | (unwind-protect |
| 3231 | (progn |
| 3232 | ;; Create temp files with strict access rights. It's easy to |
| 3233 | ;; loosen them later, whereas it's impossible to close the |
| 3234 | ;; time-window of loose permissions otherwise. |
| 3235 | (set-default-file-modes ?\700) |
| 3236 | (when (condition-case nil |
| 3237 | ;; Try to overwrite old backup first. |
| 3238 | (copy-file from-name to-name t t t) |
| 3239 | (error t)) |
| 3240 | (while (condition-case nil |
| 3241 | (progn |
| 3242 | (when (file-exists-p to-name) |
| 3243 | (delete-file to-name)) |
| 3244 | (copy-file from-name to-name nil t t) |
| 3245 | nil) |
| 3246 | (file-already-exists t)) |
| 3247 | ;; The file was somehow created by someone else between |
| 3248 | ;; `delete-file' and `copy-file', so let's try again. |
| 3249 | ;; rms says "I think there is also a possible race |
| 3250 | ;; condition for making backup files" (emacs-devel 20070821). |
| 3251 | nil))) |
| 3252 | ;; Reset the umask. |
| 3253 | (set-default-file-modes umask))) |
| 3254 | (and modes |
| 3255 | (set-file-modes to-name (logand modes #o1777)))) |
| 3256 | |
| 3257 | (defun file-name-sans-versions (name &optional keep-backup-version) |
| 3258 | "Return file NAME sans backup versions or strings. |
| 3259 | This is a separate procedure so your site-init or startup file can |
| 3260 | redefine it. |
| 3261 | If the optional argument KEEP-BACKUP-VERSION is non-nil, |
| 3262 | we do not remove backup version numbers, only true file version numbers." |
| 3263 | (let ((handler (find-file-name-handler name 'file-name-sans-versions))) |
| 3264 | (if handler |
| 3265 | (funcall handler 'file-name-sans-versions name keep-backup-version) |
| 3266 | (substring name 0 |
| 3267 | (if (eq system-type 'vax-vms) |
| 3268 | ;; VMS version number is (a) semicolon, optional |
| 3269 | ;; sign, zero or more digits or (b) period, option |
| 3270 | ;; sign, zero or more digits, provided this is the |
| 3271 | ;; second period encountered outside of the |
| 3272 | ;; device/directory part of the file name. |
| 3273 | (or (string-match ";[-+]?[0-9]*\\'" name) |
| 3274 | (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'" |
| 3275 | name) |
| 3276 | (match-beginning 1)) |
| 3277 | (length name)) |
| 3278 | (if keep-backup-version |
| 3279 | (length name) |
| 3280 | (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name) |
| 3281 | (string-match "~\\'" name) |
| 3282 | (length name)))))))) |
| 3283 | |
| 3284 | (defun file-ownership-preserved-p (file) |
| 3285 | "Return t if deleting FILE and rewriting it would preserve the owner." |
| 3286 | (let ((handler (find-file-name-handler file 'file-ownership-preserved-p))) |
| 3287 | (if handler |
| 3288 | (funcall handler 'file-ownership-preserved-p file) |
| 3289 | (let ((attributes (file-attributes file))) |
| 3290 | ;; Return t if the file doesn't exist, since it's true that no |
| 3291 | ;; information would be lost by an (attempted) delete and create. |
| 3292 | (or (null attributes) |
| 3293 | (= (nth 2 attributes) (user-uid))))))) |
| 3294 | |
| 3295 | (defun file-name-sans-extension (filename) |
| 3296 | "Return FILENAME sans final \"extension\". |
| 3297 | The extension, in a file name, is the part that follows the last `.', |
| 3298 | except that a leading `.', if any, doesn't count." |
| 3299 | (save-match-data |
| 3300 | (let ((file (file-name-sans-versions (file-name-nondirectory filename))) |
| 3301 | directory) |
| 3302 | (if (and (string-match "\\.[^.]*\\'" file) |
| 3303 | (not (eq 0 (match-beginning 0)))) |
| 3304 | (if (setq directory (file-name-directory filename)) |
| 3305 | ;; Don't use expand-file-name here; if DIRECTORY is relative, |
| 3306 | ;; we don't want to expand it. |
| 3307 | (concat directory (substring file 0 (match-beginning 0))) |
| 3308 | (substring file 0 (match-beginning 0))) |
| 3309 | filename)))) |
| 3310 | |
| 3311 | (defun file-name-extension (filename &optional period) |
| 3312 | "Return FILENAME's final \"extension\". |
| 3313 | The extension, in a file name, is the part that follows the last `.', |
| 3314 | excluding version numbers and backup suffixes, |
| 3315 | except that a leading `.', if any, doesn't count. |
| 3316 | Return nil for extensionless file names such as `foo'. |
| 3317 | Return the empty string for file names such as `foo.'. |
| 3318 | |
| 3319 | If PERIOD is non-nil, then the returned value includes the period |
| 3320 | that delimits the extension, and if FILENAME has no extension, |
| 3321 | the value is \"\"." |
| 3322 | (save-match-data |
| 3323 | (let ((file (file-name-sans-versions (file-name-nondirectory filename)))) |
| 3324 | (if (and (string-match "\\.[^.]*\\'" file) |
| 3325 | (not (eq 0 (match-beginning 0)))) |
| 3326 | (substring file (+ (match-beginning 0) (if period 0 1))) |
| 3327 | (if period |
| 3328 | ""))))) |
| 3329 | |
| 3330 | (defcustom make-backup-file-name-function nil |
| 3331 | "A function to use instead of the default `make-backup-file-name'. |
| 3332 | A value of nil gives the default `make-backup-file-name' behavior. |
| 3333 | |
| 3334 | This could be buffer-local to do something special for specific |
| 3335 | files. If you define it, you may need to change `backup-file-name-p' |
| 3336 | and `file-name-sans-versions' too. |
| 3337 | |
| 3338 | See also `backup-directory-alist'." |
| 3339 | :group 'backup |
| 3340 | :type '(choice (const :tag "Default" nil) |
| 3341 | (function :tag "Your function"))) |
| 3342 | |
| 3343 | (defcustom backup-directory-alist nil |
| 3344 | "Alist of filename patterns and backup directory names. |
| 3345 | Each element looks like (REGEXP . DIRECTORY). Backups of files with |
| 3346 | names matching REGEXP will be made in DIRECTORY. DIRECTORY may be |
| 3347 | relative or absolute. If it is absolute, so that all matching files |
| 3348 | are backed up into the same directory, the file names in this |
| 3349 | directory will be the full name of the file backed up with all |
| 3350 | directory separators changed to `!' to prevent clashes. This will not |
| 3351 | work correctly if your filesystem truncates the resulting name. |
| 3352 | |
| 3353 | For the common case of all backups going into one directory, the alist |
| 3354 | should contain a single element pairing \".\" with the appropriate |
| 3355 | directory name. |
| 3356 | |
| 3357 | If this variable is nil, or it fails to match a filename, the backup |
| 3358 | is made in the original file's directory. |
| 3359 | |
| 3360 | On MS-DOS filesystems without long names this variable is always |
| 3361 | ignored." |
| 3362 | :group 'backup |
| 3363 | :type '(repeat (cons (regexp :tag "Regexp matching filename") |
| 3364 | (directory :tag "Backup directory name")))) |
| 3365 | |
| 3366 | (defun normal-backup-enable-predicate (name) |
| 3367 | "Default `backup-enable-predicate' function. |
| 3368 | Checks for files in `temporary-file-directory', |
| 3369 | `small-temporary-file-directory', and /tmp." |
| 3370 | (not (or (let ((comp (compare-strings temporary-file-directory 0 nil |
| 3371 | name 0 nil))) |
| 3372 | ;; Directory is under temporary-file-directory. |
| 3373 | (and (not (eq comp t)) |
| 3374 | (< comp (- (length temporary-file-directory))))) |
| 3375 | (let ((comp (compare-strings "/tmp" 0 nil |
| 3376 | name 0 nil))) |
| 3377 | ;; Directory is under /tmp. |
| 3378 | (and (not (eq comp t)) |
| 3379 | (< comp (- (length "/tmp"))))) |
| 3380 | (if small-temporary-file-directory |
| 3381 | (let ((comp (compare-strings small-temporary-file-directory |
| 3382 | 0 nil |
| 3383 | name 0 nil))) |
| 3384 | ;; Directory is under small-temporary-file-directory. |
| 3385 | (and (not (eq comp t)) |
| 3386 | (< comp (- (length small-temporary-file-directory))))))))) |
| 3387 | |
| 3388 | (defun make-backup-file-name (file) |
| 3389 | "Create the non-numeric backup file name for FILE. |
| 3390 | Normally this will just be the file's name with `~' appended. |
| 3391 | Customization hooks are provided as follows. |
| 3392 | |
| 3393 | If the variable `make-backup-file-name-function' is non-nil, its value |
| 3394 | should be a function which will be called with FILE as its argument; |
| 3395 | the resulting name is used. |
| 3396 | |
| 3397 | Otherwise a match for FILE is sought in `backup-directory-alist'; see |
| 3398 | the documentation of that variable. If the directory for the backup |
| 3399 | doesn't exist, it is created." |
| 3400 | (if make-backup-file-name-function |
| 3401 | (funcall make-backup-file-name-function file) |
| 3402 | (if (and (eq system-type 'ms-dos) |
| 3403 | (not (msdos-long-file-names))) |
| 3404 | (let ((fn (file-name-nondirectory file))) |
| 3405 | (concat (file-name-directory file) |
| 3406 | (or (and (string-match "\\`[^.]+\\'" fn) |
| 3407 | (concat (match-string 0 fn) ".~")) |
| 3408 | (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn) |
| 3409 | (concat (match-string 0 fn) "~"))))) |
| 3410 | (concat (make-backup-file-name-1 file) "~")))) |
| 3411 | |
| 3412 | (defun make-backup-file-name-1 (file) |
| 3413 | "Subroutine of `make-backup-file-name' and `find-backup-file-name'." |
| 3414 | (let ((alist backup-directory-alist) |
| 3415 | elt backup-directory abs-backup-directory) |
| 3416 | (while alist |
| 3417 | (setq elt (pop alist)) |
| 3418 | (if (string-match (car elt) file) |
| 3419 | (setq backup-directory (cdr elt) |
| 3420 | alist nil))) |
| 3421 | ;; If backup-directory is relative, it should be relative to the |
| 3422 | ;; file's directory. By expanding explicitly here, we avoid |
| 3423 | ;; depending on default-directory. |
| 3424 | (if backup-directory |
| 3425 | (setq abs-backup-directory |
| 3426 | (expand-file-name backup-directory |
| 3427 | (file-name-directory file)))) |
| 3428 | (if (and abs-backup-directory (not (file-exists-p abs-backup-directory))) |
| 3429 | (condition-case nil |
| 3430 | (make-directory abs-backup-directory 'parents) |
| 3431 | (file-error (setq backup-directory nil |
| 3432 | abs-backup-directory nil)))) |
| 3433 | (if (null backup-directory) |
| 3434 | file |
| 3435 | (if (file-name-absolute-p backup-directory) |
| 3436 | (progn |
| 3437 | (when (memq system-type '(windows-nt ms-dos cygwin)) |
| 3438 | ;; Normalize DOSish file names: downcase the drive |
| 3439 | ;; letter, if any, and replace the leading "x:" with |
| 3440 | ;; "/drive_x". |
| 3441 | (or (file-name-absolute-p file) |
| 3442 | (setq file (expand-file-name file))) ; make defaults explicit |
| 3443 | ;; Replace any invalid file-name characters (for the |
| 3444 | ;; case of backing up remote files). |
| 3445 | (setq file (expand-file-name (convert-standard-filename file))) |
| 3446 | (if (eq (aref file 1) ?:) |
| 3447 | (setq file (concat "/" |
| 3448 | "drive_" |
| 3449 | (char-to-string (downcase (aref file 0))) |
| 3450 | (if (eq (aref file 2) ?/) |
| 3451 | "" |
| 3452 | "/") |
| 3453 | (substring file 2))))) |
| 3454 | ;; Make the name unique by substituting directory |
| 3455 | ;; separators. It may not really be worth bothering about |
| 3456 | ;; doubling `!'s in the original name... |
| 3457 | (expand-file-name |
| 3458 | (subst-char-in-string |
| 3459 | ?/ ?! |
| 3460 | (replace-regexp-in-string "!" "!!" file)) |
| 3461 | backup-directory)) |
| 3462 | (expand-file-name (file-name-nondirectory file) |
| 3463 | (file-name-as-directory abs-backup-directory)))))) |
| 3464 | |
| 3465 | (defun backup-file-name-p (file) |
| 3466 | "Return non-nil if FILE is a backup file name (numeric or not). |
| 3467 | This is a separate function so you can redefine it for customization. |
| 3468 | You may need to redefine `file-name-sans-versions' as well." |
| 3469 | (string-match "~\\'" file)) |
| 3470 | |
| 3471 | (defvar backup-extract-version-start) |
| 3472 | |
| 3473 | ;; This is used in various files. |
| 3474 | ;; The usage of backup-extract-version-start is not very clean, |
| 3475 | ;; but I can't see a good alternative, so as of now I am leaving it alone. |
| 3476 | (defun backup-extract-version (fn) |
| 3477 | "Given the name of a numeric backup file, FN, return the backup number. |
| 3478 | Uses the free variable `backup-extract-version-start', whose value should be |
| 3479 | the index in the name where the version number begins." |
| 3480 | (if (and (string-match "[0-9]+~$" fn backup-extract-version-start) |
| 3481 | (= (match-beginning 0) backup-extract-version-start)) |
| 3482 | (string-to-number (substring fn backup-extract-version-start -1)) |
| 3483 | 0)) |
| 3484 | |
| 3485 | ;; I believe there is no need to alter this behavior for VMS; |
| 3486 | ;; since backup files are not made on VMS, it should not get called. |
| 3487 | (defun find-backup-file-name (fn) |
| 3488 | "Find a file name for a backup file FN, and suggestions for deletions. |
| 3489 | Value is a list whose car is the name for the backup file |
| 3490 | and whose cdr is a list of old versions to consider deleting now. |
| 3491 | If the value is nil, don't make a backup. |
| 3492 | Uses `backup-directory-alist' in the same way as does |
| 3493 | `make-backup-file-name'." |
| 3494 | (let ((handler (find-file-name-handler fn 'find-backup-file-name))) |
| 3495 | ;; Run a handler for this function so that ange-ftp can refuse to do it. |
| 3496 | (if handler |
| 3497 | (funcall handler 'find-backup-file-name fn) |
| 3498 | (if (or (eq version-control 'never) |
| 3499 | ;; We don't support numbered backups on plain MS-DOS |
| 3500 | ;; when long file names are unavailable. |
| 3501 | (and (eq system-type 'ms-dos) |
| 3502 | (not (msdos-long-file-names)))) |
| 3503 | (list (make-backup-file-name fn)) |
| 3504 | (let* ((basic-name (make-backup-file-name-1 fn)) |
| 3505 | (base-versions (concat (file-name-nondirectory basic-name) |
| 3506 | ".~")) |
| 3507 | (backup-extract-version-start (length base-versions)) |
| 3508 | (high-water-mark 0) |
| 3509 | (number-to-delete 0) |
| 3510 | possibilities deserve-versions-p versions) |
| 3511 | (condition-case () |
| 3512 | (setq possibilities (file-name-all-completions |
| 3513 | base-versions |
| 3514 | (file-name-directory basic-name)) |
| 3515 | versions (sort (mapcar #'backup-extract-version |
| 3516 | possibilities) |
| 3517 | #'<) |
| 3518 | high-water-mark (apply 'max 0 versions) |
| 3519 | deserve-versions-p (or version-control |
| 3520 | (> high-water-mark 0)) |
| 3521 | number-to-delete (- (length versions) |
| 3522 | kept-old-versions |
| 3523 | kept-new-versions |
| 3524 | -1)) |
| 3525 | (file-error (setq possibilities nil))) |
| 3526 | (if (not deserve-versions-p) |
| 3527 | (list (make-backup-file-name fn)) |
| 3528 | (cons (format "%s.~%d~" basic-name (1+ high-water-mark)) |
| 3529 | (if (and (> number-to-delete 0) |
| 3530 | ;; Delete nothing if there is overflow |
| 3531 | ;; in the number of versions to keep. |
| 3532 | (>= (+ kept-new-versions kept-old-versions -1) 0)) |
| 3533 | (mapcar (lambda (n) |
| 3534 | (format "%s.~%d~" basic-name n)) |
| 3535 | (let ((v (nthcdr kept-old-versions versions))) |
| 3536 | (rplacd (nthcdr (1- number-to-delete) v) ()) |
| 3537 | v)))))))))) |
| 3538 | |
| 3539 | (defun file-nlinks (filename) |
| 3540 | "Return number of names file FILENAME has." |
| 3541 | (car (cdr (file-attributes filename)))) |
| 3542 | |
| 3543 | ;; (defun file-relative-name (filename &optional directory) |
| 3544 | ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory'). |
| 3545 | ;; This function returns a relative file name which is equivalent to FILENAME |
| 3546 | ;; when used with that default directory as the default. |
| 3547 | ;; If this is impossible (which can happen on MSDOS and Windows |
| 3548 | ;; when the file name and directory use different drive names) |
| 3549 | ;; then it returns FILENAME." |
| 3550 | ;; (save-match-data |
| 3551 | ;; (let ((fname (expand-file-name filename))) |
| 3552 | ;; (setq directory (file-name-as-directory |
| 3553 | ;; (expand-file-name (or directory default-directory)))) |
| 3554 | ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different |
| 3555 | ;; ;; drive names, they can't be relative, so return the absolute name. |
| 3556 | ;; (if (and (or (eq system-type 'ms-dos) |
| 3557 | ;; (eq system-type 'cygwin) |
| 3558 | ;; (eq system-type 'windows-nt)) |
| 3559 | ;; (not (string-equal (substring fname 0 2) |
| 3560 | ;; (substring directory 0 2)))) |
| 3561 | ;; filename |
| 3562 | ;; (let ((ancestor ".") |
| 3563 | ;; (fname-dir (file-name-as-directory fname))) |
| 3564 | ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir)) |
| 3565 | ;; (not (string-match (concat "^" (regexp-quote directory)) fname))) |
| 3566 | ;; (setq directory (file-name-directory (substring directory 0 -1)) |
| 3567 | ;; ancestor (if (equal ancestor ".") |
| 3568 | ;; ".." |
| 3569 | ;; (concat "../" ancestor)))) |
| 3570 | ;; ;; Now ancestor is empty, or .., or ../.., etc. |
| 3571 | ;; (if (string-match (concat "^" (regexp-quote directory)) fname) |
| 3572 | ;; ;; We matched within FNAME's directory part. |
| 3573 | ;; ;; Add the rest of FNAME onto ANCESTOR. |
| 3574 | ;; (let ((rest (substring fname (match-end 0)))) |
| 3575 | ;; (if (and (equal ancestor ".") |
| 3576 | ;; (not (equal rest ""))) |
| 3577 | ;; ;; But don't bother with ANCESTOR if it would give us `./'. |
| 3578 | ;; rest |
| 3579 | ;; (concat (file-name-as-directory ancestor) rest))) |
| 3580 | ;; ;; We matched FNAME's directory equivalent. |
| 3581 | ;; ancestor)))))) |
| 3582 | |
| 3583 | (defun file-relative-name (filename &optional directory) |
| 3584 | "Convert FILENAME to be relative to DIRECTORY (default: `default-directory'). |
| 3585 | This function returns a relative file name which is equivalent to FILENAME |
| 3586 | when used with that default directory as the default. |
| 3587 | If FILENAME and DIRECTORY lie on different machines or on different drives |
| 3588 | on a DOS/Windows machine, it returns FILENAME in expanded form." |
| 3589 | (save-match-data |
| 3590 | (setq directory |
| 3591 | (file-name-as-directory (expand-file-name (or directory |
| 3592 | default-directory)))) |
| 3593 | (setq filename (expand-file-name filename)) |
| 3594 | (let ((fremote (file-remote-p filename)) |
| 3595 | (dremote (file-remote-p directory))) |
| 3596 | (if ;; Conditions for separate trees |
| 3597 | (or |
| 3598 | ;; Test for different drives on DOS/Windows |
| 3599 | (and |
| 3600 | ;; Should `cygwin' really be included here? --stef |
| 3601 | (memq system-type '(ms-dos cygwin windows-nt)) |
| 3602 | (not (eq t (compare-strings filename 0 2 directory 0 2)))) |
| 3603 | ;; Test for different remote file system identification |
| 3604 | (not (equal fremote dremote))) |
| 3605 | filename |
| 3606 | (let ((ancestor ".") |
| 3607 | (filename-dir (file-name-as-directory filename))) |
| 3608 | (while (not |
| 3609 | (or |
| 3610 | (eq t (compare-strings filename-dir nil (length directory) |
| 3611 | directory nil nil case-fold-search)) |
| 3612 | (eq t (compare-strings filename nil (length directory) |
| 3613 | directory nil nil case-fold-search)))) |
| 3614 | (setq directory (file-name-directory (substring directory 0 -1)) |
| 3615 | ancestor (if (equal ancestor ".") |
| 3616 | ".." |
| 3617 | (concat "../" ancestor)))) |
| 3618 | ;; Now ancestor is empty, or .., or ../.., etc. |
| 3619 | (if (eq t (compare-strings filename nil (length directory) |
| 3620 | directory nil nil case-fold-search)) |
| 3621 | ;; We matched within FILENAME's directory part. |
| 3622 | ;; Add the rest of FILENAME onto ANCESTOR. |
| 3623 | (let ((rest (substring filename (length directory)))) |
| 3624 | (if (and (equal ancestor ".") (not (equal rest ""))) |
| 3625 | ;; But don't bother with ANCESTOR if it would give us `./'. |
| 3626 | rest |
| 3627 | (concat (file-name-as-directory ancestor) rest))) |
| 3628 | ;; We matched FILENAME's directory equivalent. |
| 3629 | ancestor)))))) |
| 3630 | \f |
| 3631 | (defun save-buffer (&optional args) |
| 3632 | "Save current buffer in visited file if modified. |
| 3633 | Variations are described below. |
| 3634 | |
| 3635 | By default, makes the previous version into a backup file |
| 3636 | if previously requested or if this is the first save. |
| 3637 | Prefixed with one \\[universal-argument], marks this version |
| 3638 | to become a backup when the next save is done. |
| 3639 | Prefixed with two \\[universal-argument]'s, |
| 3640 | unconditionally makes the previous version into a backup file. |
| 3641 | Prefixed with three \\[universal-argument]'s, marks this version |
| 3642 | to become a backup when the next save is done, |
| 3643 | and unconditionally makes the previous version into a backup file. |
| 3644 | |
| 3645 | With a numeric argument of 0, never make the previous version |
| 3646 | into a backup file. |
| 3647 | |
| 3648 | If a file's name is FOO, the names of its numbered backup versions are |
| 3649 | FOO.~i~ for various integers i. A non-numbered backup file is called FOO~. |
| 3650 | Numeric backups (rather than FOO~) will be made if value of |
| 3651 | `version-control' is not the atom `never' and either there are already |
| 3652 | numeric versions of the file being backed up, or `version-control' is |
| 3653 | non-nil. |
| 3654 | We don't want excessive versions piling up, so there are variables |
| 3655 | `kept-old-versions', which tells Emacs how many oldest versions to keep, |
| 3656 | and `kept-new-versions', which tells how many newest versions to keep. |
| 3657 | Defaults are 2 old versions and 2 new. |
| 3658 | `dired-kept-versions' controls dired's clean-directory (.) command. |
| 3659 | If `delete-old-versions' is nil, system will query user |
| 3660 | before trimming versions. Otherwise it does it silently. |
| 3661 | |
| 3662 | If `vc-make-backup-files' is nil, which is the default, |
| 3663 | no backup files are made for files managed by version control. |
| 3664 | (This is because the version control system itself records previous versions.) |
| 3665 | |
| 3666 | See the subroutine `basic-save-buffer' for more information." |
| 3667 | (interactive "p") |
| 3668 | (let ((modp (buffer-modified-p)) |
| 3669 | (large (> (buffer-size) 50000)) |
| 3670 | (make-backup-files (or (and make-backup-files (not (eq args 0))) |
| 3671 | (memq args '(16 64))))) |
| 3672 | (and modp (memq args '(16 64)) (setq buffer-backed-up nil)) |
| 3673 | (if (and modp large (buffer-file-name)) |
| 3674 | (message "Saving file %s..." (buffer-file-name))) |
| 3675 | (basic-save-buffer) |
| 3676 | (and modp (memq args '(4 64)) (setq buffer-backed-up nil)))) |
| 3677 | |
| 3678 | (defun delete-auto-save-file-if-necessary (&optional force) |
| 3679 | "Delete auto-save file for current buffer if `delete-auto-save-files' is t. |
| 3680 | Normally delete only if the file was written by this Emacs since |
| 3681 | the last real save, but optional arg FORCE non-nil means delete anyway." |
| 3682 | (and buffer-auto-save-file-name delete-auto-save-files |
| 3683 | (not (string= buffer-file-name buffer-auto-save-file-name)) |
| 3684 | (or force (recent-auto-save-p)) |
| 3685 | (progn |
| 3686 | (condition-case () |
| 3687 | (delete-file buffer-auto-save-file-name) |
| 3688 | (file-error nil)) |
| 3689 | (set-buffer-auto-saved)))) |
| 3690 | |
| 3691 | (defvar auto-save-hook nil |
| 3692 | "Normal hook run just before auto-saving.") |
| 3693 | |
| 3694 | (defcustom before-save-hook nil |
| 3695 | "Normal hook that is run before a buffer is saved to its file." |
| 3696 | :options '(copyright-update time-stamp) |
| 3697 | :type 'hook |
| 3698 | :group 'files) |
| 3699 | |
| 3700 | (defcustom after-save-hook nil |
| 3701 | "Normal hook that is run after a buffer is saved to its file." |
| 3702 | :options '(executable-make-buffer-file-executable-if-script-p) |
| 3703 | :type 'hook |
| 3704 | :group 'files) |
| 3705 | |
| 3706 | (defvar save-buffer-coding-system nil |
| 3707 | "If non-nil, use this coding system for saving the buffer. |
| 3708 | More precisely, use this coding system in place of the |
| 3709 | value of `buffer-file-coding-system', when saving the buffer. |
| 3710 | Calling `write-region' for any purpose other than saving the buffer |
| 3711 | will still use `buffer-file-coding-system'; this variable has no effect |
| 3712 | in such cases.") |
| 3713 | |
| 3714 | (make-variable-buffer-local 'save-buffer-coding-system) |
| 3715 | (put 'save-buffer-coding-system 'permanent-local t) |
| 3716 | |
| 3717 | (defun basic-save-buffer () |
| 3718 | "Save the current buffer in its visited file, if it has been modified. |
| 3719 | The hooks `write-contents-functions' and `write-file-functions' get a chance |
| 3720 | to do the job of saving; if they do not, then the buffer is saved in |
| 3721 | the visited file in the usual way. |
| 3722 | Before and after saving the buffer, this function runs |
| 3723 | `before-save-hook' and `after-save-hook', respectively." |
| 3724 | (interactive) |
| 3725 | (save-current-buffer |
| 3726 | ;; In an indirect buffer, save its base buffer instead. |
| 3727 | (if (buffer-base-buffer) |
| 3728 | (set-buffer (buffer-base-buffer))) |
| 3729 | (if (buffer-modified-p) |
| 3730 | (let ((recent-save (recent-auto-save-p)) |
| 3731 | setmodes) |
| 3732 | ;; On VMS, rename file and buffer to get rid of version number. |
| 3733 | (if (and (eq system-type 'vax-vms) |
| 3734 | (not (string= buffer-file-name |
| 3735 | (file-name-sans-versions buffer-file-name)))) |
| 3736 | (let (buffer-new-name) |
| 3737 | ;; Strip VMS version number before save. |
| 3738 | (setq buffer-file-name |
| 3739 | (file-name-sans-versions buffer-file-name)) |
| 3740 | ;; Construct a (unique) buffer name to correspond. |
| 3741 | (let ((buf (create-file-buffer (downcase buffer-file-name)))) |
| 3742 | (setq buffer-new-name (buffer-name buf)) |
| 3743 | (kill-buffer buf)) |
| 3744 | (rename-buffer buffer-new-name))) |
| 3745 | ;; If buffer has no file name, ask user for one. |
| 3746 | (or buffer-file-name |
| 3747 | (let ((filename |
| 3748 | (expand-file-name |
| 3749 | (read-file-name "File to save in: ") nil))) |
| 3750 | (if (file-exists-p filename) |
| 3751 | (if (file-directory-p filename) |
| 3752 | ;; Signal an error if the user specified the name of an |
| 3753 | ;; existing directory. |
| 3754 | (error "%s is a directory" filename) |
| 3755 | (unless (y-or-n-p (format "File `%s' exists; overwrite? " |
| 3756 | filename)) |
| 3757 | (error "Canceled"))) |
| 3758 | ;; Signal an error if the specified name refers to a |
| 3759 | ;; non-existing directory. |
| 3760 | (let ((dir (file-name-directory filename))) |
| 3761 | (unless (file-directory-p dir) |
| 3762 | (if (file-exists-p dir) |
| 3763 | (error "%s is not a directory" dir) |
| 3764 | (error "%s: no such directory" dir))))) |
| 3765 | (set-visited-file-name filename))) |
| 3766 | (or (verify-visited-file-modtime (current-buffer)) |
| 3767 | (not (file-exists-p buffer-file-name)) |
| 3768 | (yes-or-no-p |
| 3769 | (format "%s has changed since visited or saved. Save anyway? " |
| 3770 | (file-name-nondirectory buffer-file-name))) |
| 3771 | (error "Save not confirmed")) |
| 3772 | (save-restriction |
| 3773 | (widen) |
| 3774 | (save-excursion |
| 3775 | (and (> (point-max) (point-min)) |
| 3776 | (not find-file-literally) |
| 3777 | (/= (char-after (1- (point-max))) ?\n) |
| 3778 | (not (and (eq selective-display t) |
| 3779 | (= (char-after (1- (point-max))) ?\r))) |
| 3780 | (or (eq require-final-newline t) |
| 3781 | (eq require-final-newline 'visit-save) |
| 3782 | (and require-final-newline |
| 3783 | (y-or-n-p |
| 3784 | (format "Buffer %s does not end in newline. Add one? " |
| 3785 | (buffer-name))))) |
| 3786 | (save-excursion |
| 3787 | (goto-char (point-max)) |
| 3788 | (insert ?\n)))) |
| 3789 | ;; Support VC version backups. |
| 3790 | (vc-before-save) |
| 3791 | (run-hooks 'before-save-hook) |
| 3792 | (or (run-hook-with-args-until-success 'write-contents-functions) |
| 3793 | (run-hook-with-args-until-success 'local-write-file-hooks) |
| 3794 | (run-hook-with-args-until-success 'write-file-functions) |
| 3795 | ;; If a hook returned t, file is already "written". |
| 3796 | ;; Otherwise, write it the usual way now. |
| 3797 | (setq setmodes (basic-save-buffer-1))) |
| 3798 | ;; Now we have saved the current buffer. Let's make sure |
| 3799 | ;; that buffer-file-coding-system is fixed to what |
| 3800 | ;; actually used for saving by binding it locally. |
| 3801 | (if save-buffer-coding-system |
| 3802 | (setq save-buffer-coding-system last-coding-system-used) |
| 3803 | (setq buffer-file-coding-system last-coding-system-used)) |
| 3804 | (setq buffer-file-number |
| 3805 | (nthcdr 10 (file-attributes buffer-file-name))) |
| 3806 | (if setmodes |
| 3807 | (condition-case () |
| 3808 | (set-file-modes buffer-file-name (car setmodes)) |
| 3809 | (error nil)))) |
| 3810 | ;; If the auto-save file was recent before this command, |
| 3811 | ;; delete it now. |
| 3812 | (delete-auto-save-file-if-necessary recent-save) |
| 3813 | ;; Support VC `implicit' locking. |
| 3814 | (vc-after-save) |
| 3815 | (run-hooks 'after-save-hook)) |
| 3816 | (message "(No changes need to be saved)")))) |
| 3817 | |
| 3818 | ;; This does the "real job" of writing a buffer into its visited file |
| 3819 | ;; and making a backup file. This is what is normally done |
| 3820 | ;; but inhibited if one of write-file-functions returns non-nil. |
| 3821 | ;; It returns a value (MODES . BACKUPNAME), like backup-buffer. |
| 3822 | (defun basic-save-buffer-1 () |
| 3823 | (prog1 |
| 3824 | (if save-buffer-coding-system |
| 3825 | (let ((coding-system-for-write save-buffer-coding-system)) |
| 3826 | (basic-save-buffer-2)) |
| 3827 | (basic-save-buffer-2)) |
| 3828 | (setq buffer-file-coding-system-explicit last-coding-system-used))) |
| 3829 | |
| 3830 | ;; This returns a value (MODES . BACKUPNAME), like backup-buffer. |
| 3831 | (defun basic-save-buffer-2 () |
| 3832 | (let (tempsetmodes setmodes) |
| 3833 | (if (not (file-writable-p buffer-file-name)) |
| 3834 | (let ((dir (file-name-directory buffer-file-name))) |
| 3835 | (if (not (file-directory-p dir)) |
| 3836 | (if (file-exists-p dir) |
| 3837 | (error "%s is not a directory" dir) |
| 3838 | (error "%s: no such directory" dir)) |
| 3839 | (if (not (file-exists-p buffer-file-name)) |
| 3840 | (error "Directory %s write-protected" dir) |
| 3841 | (if (yes-or-no-p |
| 3842 | (format "File %s is write-protected; try to save anyway? " |
| 3843 | (file-name-nondirectory |
| 3844 | buffer-file-name))) |
| 3845 | (setq tempsetmodes t) |
| 3846 | (error "Attempt to save to a file which you aren't allowed to write")))))) |
| 3847 | (or buffer-backed-up |
| 3848 | (setq setmodes (backup-buffer))) |
| 3849 | (let ((dir (file-name-directory buffer-file-name))) |
| 3850 | (if (and file-precious-flag |
| 3851 | (file-writable-p dir)) |
| 3852 | ;; If file is precious, write temp name, then rename it. |
| 3853 | ;; This requires write access to the containing dir, |
| 3854 | ;; which is why we don't try it if we don't have that access. |
| 3855 | (let ((realname buffer-file-name) |
| 3856 | tempname succeed |
| 3857 | (umask (default-file-modes)) |
| 3858 | (old-modtime (visited-file-modtime))) |
| 3859 | ;; Create temp files with strict access rights. It's easy to |
| 3860 | ;; loosen them later, whereas it's impossible to close the |
| 3861 | ;; time-window of loose permissions otherwise. |
| 3862 | (unwind-protect |
| 3863 | (progn |
| 3864 | (clear-visited-file-modtime) |
| 3865 | (set-default-file-modes ?\700) |
| 3866 | ;; Try various temporary names. |
| 3867 | ;; This code follows the example of make-temp-file, |
| 3868 | ;; but it calls write-region in the appropriate way |
| 3869 | ;; for saving the buffer. |
| 3870 | (while (condition-case () |
| 3871 | (progn |
| 3872 | (setq tempname |
| 3873 | (make-temp-name |
| 3874 | (expand-file-name "tmp" dir))) |
| 3875 | (write-region (point-min) (point-max) |
| 3876 | tempname nil realname |
| 3877 | buffer-file-truename 'excl) |
| 3878 | nil) |
| 3879 | (file-already-exists t)) |
| 3880 | ;; The file was somehow created by someone else between |
| 3881 | ;; `make-temp-name' and `write-region', let's try again. |
| 3882 | nil) |
| 3883 | (setq succeed t)) |
| 3884 | ;; Reset the umask. |
| 3885 | (set-default-file-modes umask) |
| 3886 | ;; If we failed, restore the buffer's modtime. |
| 3887 | (unless succeed |
| 3888 | (set-visited-file-modtime old-modtime))) |
| 3889 | ;; Since we have created an entirely new file, |
| 3890 | ;; make sure it gets the right permission bits set. |
| 3891 | (setq setmodes (or setmodes |
| 3892 | (cons (or (file-modes buffer-file-name) |
| 3893 | (logand ?\666 umask)) |
| 3894 | buffer-file-name))) |
| 3895 | ;; We succeeded in writing the temp file, |
| 3896 | ;; so rename it. |
| 3897 | (rename-file tempname buffer-file-name t)) |
| 3898 | ;; If file not writable, see if we can make it writable |
| 3899 | ;; temporarily while we write it. |
| 3900 | ;; But no need to do so if we have just backed it up |
| 3901 | ;; (setmodes is set) because that says we're superseding. |
| 3902 | (cond ((and tempsetmodes (not setmodes)) |
| 3903 | ;; Change the mode back, after writing. |
| 3904 | (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name)) |
| 3905 | (set-file-modes buffer-file-name (logior (car setmodes) 128)))) |
| 3906 | (let (success) |
| 3907 | (unwind-protect |
| 3908 | (progn |
| 3909 | (write-region (point-min) (point-max) |
| 3910 | buffer-file-name nil t buffer-file-truename) |
| 3911 | (setq success t)) |
| 3912 | ;; If we get an error writing the new file, and we made |
| 3913 | ;; the backup by renaming, undo the backing-up. |
| 3914 | (and setmodes (not success) |
| 3915 | (progn |
| 3916 | (rename-file (cdr setmodes) buffer-file-name t) |
| 3917 | (setq buffer-backed-up nil))))))) |
| 3918 | setmodes)) |
| 3919 | |
| 3920 | (defun diff-buffer-with-file (&optional buffer) |
| 3921 | "View the differences between BUFFER and its associated file. |
| 3922 | This requires the external program `diff' to be in your `exec-path'." |
| 3923 | (interactive "bBuffer: ") |
| 3924 | (with-current-buffer (get-buffer (or buffer (current-buffer))) |
| 3925 | (if (and buffer-file-name |
| 3926 | (file-exists-p buffer-file-name)) |
| 3927 | (let ((tempfile (make-temp-file "buffer-content-"))) |
| 3928 | (unwind-protect |
| 3929 | (save-restriction |
| 3930 | (widen) |
| 3931 | (write-region (point-min) (point-max) tempfile nil 'nomessage) |
| 3932 | (diff buffer-file-name tempfile nil t) |
| 3933 | (sit-for 0)) |
| 3934 | (when (file-exists-p tempfile) |
| 3935 | (delete-file tempfile)))) |
| 3936 | (message "Buffer %s has no associated file on disc" (buffer-name)) |
| 3937 | ;; Display that message for 1 second so that user can read it |
| 3938 | ;; in the minibuffer. |
| 3939 | (sit-for 1))) |
| 3940 | ;; return always nil, so that save-buffers-kill-emacs will not move |
| 3941 | ;; over to the next unsaved buffer when calling `d'. |
| 3942 | nil) |
| 3943 | |
| 3944 | (defvar save-some-buffers-action-alist |
| 3945 | '((?\C-r |
| 3946 | (lambda (buf) |
| 3947 | (view-buffer buf |
| 3948 | (lambda (ignore) |
| 3949 | (exit-recursive-edit))) |
| 3950 | (recursive-edit) |
| 3951 | ;; Return nil to ask about BUF again. |
| 3952 | nil) |
| 3953 | "view this buffer") |
| 3954 | (?d (lambda (buf) |
| 3955 | (save-window-excursion |
| 3956 | (diff-buffer-with-file buf)) |
| 3957 | (view-buffer (get-buffer-create "*Diff*") |
| 3958 | (lambda (ignore) (exit-recursive-edit))) |
| 3959 | (recursive-edit) |
| 3960 | nil) |
| 3961 | "view changes in this buffer")) |
| 3962 | "ACTION-ALIST argument used in call to `map-y-or-n-p'.") |
| 3963 | |
| 3964 | (defvar buffer-save-without-query nil |
| 3965 | "Non-nil means `save-some-buffers' should save this buffer without asking.") |
| 3966 | (make-variable-buffer-local 'buffer-save-without-query) |
| 3967 | |
| 3968 | (defun save-some-buffers (&optional arg pred) |
| 3969 | "Save some modified file-visiting buffers. Asks user about each one. |
| 3970 | You can answer `y' to save, `n' not to save, `C-r' to look at the |
| 3971 | buffer in question with `view-buffer' before deciding or `d' to |
| 3972 | view the differences using `diff-buffer-with-file'. |
| 3973 | |
| 3974 | Optional argument (the prefix) non-nil means save all with no questions. |
| 3975 | Optional second argument PRED determines which buffers are considered: |
| 3976 | If PRED is nil, all the file-visiting buffers are considered. |
| 3977 | If PRED is t, then certain non-file buffers will also be considered. |
| 3978 | If PRED is a zero-argument function, it indicates for each buffer whether |
| 3979 | to consider it or not when called with that buffer current. |
| 3980 | |
| 3981 | See `save-some-buffers-action-alist' if you want to |
| 3982 | change the additional actions you can take on files." |
| 3983 | (interactive "P") |
| 3984 | (save-window-excursion |
| 3985 | (let* (queried some-automatic |
| 3986 | files-done abbrevs-done) |
| 3987 | (dolist (buffer (buffer-list)) |
| 3988 | ;; First save any buffers that we're supposed to save unconditionally. |
| 3989 | ;; That way the following code won't ask about them. |
| 3990 | (with-current-buffer buffer |
| 3991 | (when (and buffer-save-without-query (buffer-modified-p)) |
| 3992 | (setq some-automatic t) |
| 3993 | (save-buffer)))) |
| 3994 | ;; Ask about those buffers that merit it, |
| 3995 | ;; and record the number thus saved. |
| 3996 | (setq files-done |
| 3997 | (map-y-or-n-p |
| 3998 | (function |
| 3999 | (lambda (buffer) |
| 4000 | (and (buffer-modified-p buffer) |
| 4001 | (not (buffer-base-buffer buffer)) |
| 4002 | (or |
| 4003 | (buffer-file-name buffer) |
| 4004 | (and pred |
| 4005 | (progn |
| 4006 | (set-buffer buffer) |
| 4007 | (and buffer-offer-save (> (buffer-size) 0))))) |
| 4008 | (or (not (functionp pred)) |
| 4009 | (with-current-buffer buffer (funcall pred))) |
| 4010 | (if arg |
| 4011 | t |
| 4012 | (setq queried t) |
| 4013 | (if (buffer-file-name buffer) |
| 4014 | (format "Save file %s? " |
| 4015 | (buffer-file-name buffer)) |
| 4016 | (format "Save buffer %s? " |
| 4017 | (buffer-name buffer))))))) |
| 4018 | (function |
| 4019 | (lambda (buffer) |
| 4020 | (set-buffer buffer) |
| 4021 | (save-buffer))) |
| 4022 | (buffer-list) |
| 4023 | '("buffer" "buffers" "save") |
| 4024 | save-some-buffers-action-alist)) |
| 4025 | ;; Maybe to save abbrevs, and record whether |
| 4026 | ;; we either saved them or asked to. |
| 4027 | (and save-abbrevs abbrevs-changed |
| 4028 | (progn |
| 4029 | (if (or arg |
| 4030 | (eq save-abbrevs 'silently) |
| 4031 | (y-or-n-p (format "Save abbrevs in %s? " |
| 4032 | abbrev-file-name))) |
| 4033 | (write-abbrev-file nil)) |
| 4034 | ;; Don't keep bothering user if he says no. |
| 4035 | (setq abbrevs-changed nil) |
| 4036 | (setq abbrevs-done t))) |
| 4037 | (or queried (> files-done 0) abbrevs-done |
| 4038 | (message (if some-automatic |
| 4039 | "(Some special files were saved without asking)" |
| 4040 | "(No files need saving)")))))) |
| 4041 | \f |
| 4042 | (defun not-modified (&optional arg) |
| 4043 | "Mark current buffer as unmodified, not needing to be saved. |
| 4044 | With prefix arg, mark buffer as modified, so \\[save-buffer] will save. |
| 4045 | |
| 4046 | It is not a good idea to use this function in Lisp programs, because it |
| 4047 | prints a message in the minibuffer. Instead, use `set-buffer-modified-p'." |
| 4048 | (interactive "P") |
| 4049 | (message (if arg "Modification-flag set" |
| 4050 | "Modification-flag cleared")) |
| 4051 | (set-buffer-modified-p arg)) |
| 4052 | |
| 4053 | (defun toggle-read-only (&optional arg) |
| 4054 | "Change whether this buffer is visiting its file read-only. |
| 4055 | With prefix argument ARG, make the buffer read-only if ARG is |
| 4056 | positive, otherwise make it writable. If visiting file read-only |
| 4057 | and `view-read-only' is non-nil, enter view mode." |
| 4058 | (interactive "P") |
| 4059 | (if (and arg |
| 4060 | (if (> (prefix-numeric-value arg) 0) buffer-read-only |
| 4061 | (not buffer-read-only))) ; If buffer-read-only is set correctly, |
| 4062 | nil ; do nothing. |
| 4063 | ;; Toggle. |
| 4064 | (cond |
| 4065 | ((and buffer-read-only view-mode) |
| 4066 | (View-exit-and-edit) |
| 4067 | (make-local-variable 'view-read-only) |
| 4068 | (setq view-read-only t)) ; Must leave view mode. |
| 4069 | ((and (not buffer-read-only) view-read-only |
| 4070 | ;; If view-mode is already active, `view-mode-enter' is a nop. |
| 4071 | (not view-mode) |
| 4072 | (not (eq (get major-mode 'mode-class) 'special))) |
| 4073 | (view-mode-enter)) |
| 4074 | (t (setq buffer-read-only (not buffer-read-only)) |
| 4075 | (force-mode-line-update))) |
| 4076 | (if (vc-backend buffer-file-name) |
| 4077 | (message "%s" (substitute-command-keys |
| 4078 | (concat "File is under version-control; " |
| 4079 | "use \\[vc-next-action] to check in/out")))))) |
| 4080 | |
| 4081 | (defun insert-file (filename) |
| 4082 | "Insert contents of file FILENAME into buffer after point. |
| 4083 | Set mark after the inserted text. |
| 4084 | |
| 4085 | This function is meant for the user to run interactively. |
| 4086 | Don't call it from programs! Use `insert-file-contents' instead. |
| 4087 | \(Its calling sequence is different; see its documentation)." |
| 4088 | (interactive "*fInsert file: ") |
| 4089 | (insert-file-1 filename #'insert-file-contents)) |
| 4090 | |
| 4091 | (defun append-to-file (start end filename) |
| 4092 | "Append the contents of the region to the end of file FILENAME. |
| 4093 | When called from a function, expects three arguments, |
| 4094 | START, END and FILENAME. START and END are buffer positions |
| 4095 | saying what text to write." |
| 4096 | (interactive "r\nFAppend to file: ") |
| 4097 | (write-region start end filename t)) |
| 4098 | |
| 4099 | (defun file-newest-backup (filename) |
| 4100 | "Return most recent backup file for FILENAME or nil if no backups exist." |
| 4101 | ;; `make-backup-file-name' will get us the right directory for |
| 4102 | ;; ordinary or numeric backups. It might create a directory for |
| 4103 | ;; backups as a side-effect, according to `backup-directory-alist'. |
| 4104 | (let* ((filename (file-name-sans-versions |
| 4105 | (make-backup-file-name (expand-file-name filename)))) |
| 4106 | (file (file-name-nondirectory filename)) |
| 4107 | (dir (file-name-directory filename)) |
| 4108 | (comp (file-name-all-completions file dir)) |
| 4109 | (newest nil) |
| 4110 | tem) |
| 4111 | (while comp |
| 4112 | (setq tem (pop comp)) |
| 4113 | (cond ((and (backup-file-name-p tem) |
| 4114 | (string= (file-name-sans-versions tem) file)) |
| 4115 | (setq tem (concat dir tem)) |
| 4116 | (if (or (null newest) |
| 4117 | (file-newer-than-file-p tem newest)) |
| 4118 | (setq newest tem))))) |
| 4119 | newest)) |
| 4120 | |
| 4121 | (defun rename-uniquely () |
| 4122 | "Rename current buffer to a similar name not already taken. |
| 4123 | This function is useful for creating multiple shell process buffers |
| 4124 | or multiple mail buffers, etc." |
| 4125 | (interactive) |
| 4126 | (save-match-data |
| 4127 | (let ((base-name (buffer-name))) |
| 4128 | (and (string-match "<[0-9]+>\\'" base-name) |
| 4129 | (not (and buffer-file-name |
| 4130 | (string= base-name |
| 4131 | (file-name-nondirectory buffer-file-name)))) |
| 4132 | ;; If the existing buffer name has a <NNN>, |
| 4133 | ;; which isn't part of the file name (if any), |
| 4134 | ;; then get rid of that. |
| 4135 | (setq base-name (substring base-name 0 (match-beginning 0)))) |
| 4136 | (rename-buffer (generate-new-buffer-name base-name)) |
| 4137 | (force-mode-line-update)))) |
| 4138 | |
| 4139 | (defun make-directory (dir &optional parents) |
| 4140 | "Create the directory DIR and any nonexistent parent dirs. |
| 4141 | If DIR already exists as a directory, do nothing. |
| 4142 | |
| 4143 | Interactively, the default choice of directory to create |
| 4144 | is the current default directory for file names. |
| 4145 | That is useful when you have visited a file in a nonexistent directory. |
| 4146 | |
| 4147 | Noninteractively, the second (optional) argument PARENTS says whether |
| 4148 | to create parent directories if they don't exist. Interactively, |
| 4149 | this happens by default." |
| 4150 | (interactive |
| 4151 | (list (read-file-name "Make directory: " default-directory default-directory |
| 4152 | nil nil) |
| 4153 | t)) |
| 4154 | ;; If default-directory is a remote directory, |
| 4155 | ;; make sure we find its make-directory handler. |
| 4156 | (setq dir (expand-file-name dir)) |
| 4157 | (let ((handler (find-file-name-handler dir 'make-directory))) |
| 4158 | (if handler |
| 4159 | (funcall handler 'make-directory dir parents) |
| 4160 | (if (not parents) |
| 4161 | (make-directory-internal dir) |
| 4162 | (let ((dir (directory-file-name (expand-file-name dir))) |
| 4163 | create-list) |
| 4164 | (while (not (file-exists-p dir)) |
| 4165 | (setq create-list (cons dir create-list) |
| 4166 | dir (directory-file-name (file-name-directory dir)))) |
| 4167 | (while create-list |
| 4168 | (make-directory-internal (car create-list)) |
| 4169 | (setq create-list (cdr create-list)))))))) |
| 4170 | \f |
| 4171 | (put 'revert-buffer-function 'permanent-local t) |
| 4172 | (defvar revert-buffer-function nil |
| 4173 | "Function to use to revert this buffer, or nil to do the default. |
| 4174 | The function receives two arguments IGNORE-AUTO and NOCONFIRM, |
| 4175 | which are the arguments that `revert-buffer' received.") |
| 4176 | |
| 4177 | (put 'revert-buffer-insert-file-contents-function 'permanent-local t) |
| 4178 | (defvar revert-buffer-insert-file-contents-function nil |
| 4179 | "Function to use to insert contents when reverting this buffer. |
| 4180 | Gets two args, first the nominal file name to use, |
| 4181 | and second, t if reading the auto-save file. |
| 4182 | |
| 4183 | The function you specify is responsible for updating (or preserving) point.") |
| 4184 | |
| 4185 | (defvar buffer-stale-function nil |
| 4186 | "Function to check whether a non-file buffer needs reverting. |
| 4187 | This should be a function with one optional argument NOCONFIRM. |
| 4188 | Auto Revert Mode passes t for NOCONFIRM. The function should return |
| 4189 | non-nil if the buffer should be reverted. A return value of |
| 4190 | `fast' means that the need for reverting was not checked, but |
| 4191 | that reverting the buffer is fast. The buffer is current when |
| 4192 | this function is called. |
| 4193 | |
| 4194 | The idea behind the NOCONFIRM argument is that it should be |
| 4195 | non-nil if the buffer is going to be reverted without asking the |
| 4196 | user. In such situations, one has to be careful with potentially |
| 4197 | time consuming operations. |
| 4198 | |
| 4199 | For more information on how this variable is used by Auto Revert mode, |
| 4200 | see Info node `(emacs)Supporting additional buffers'.") |
| 4201 | |
| 4202 | (defvar before-revert-hook nil |
| 4203 | "Normal hook for `revert-buffer' to run before reverting. |
| 4204 | If `revert-buffer-function' is used to override the normal revert |
| 4205 | mechanism, this hook is not used.") |
| 4206 | |
| 4207 | (defvar after-revert-hook nil |
| 4208 | "Normal hook for `revert-buffer' to run after reverting. |
| 4209 | Note that the hook value that it runs is the value that was in effect |
| 4210 | before reverting; that makes a difference if you have buffer-local |
| 4211 | hook functions. |
| 4212 | |
| 4213 | If `revert-buffer-function' is used to override the normal revert |
| 4214 | mechanism, this hook is not used.") |
| 4215 | |
| 4216 | (defvar revert-buffer-internal-hook) |
| 4217 | |
| 4218 | (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes) |
| 4219 | "Replace current buffer text with the text of the visited file on disk. |
| 4220 | This undoes all changes since the file was visited or saved. |
| 4221 | With a prefix argument, offer to revert from latest auto-save file, if |
| 4222 | that is more recent than the visited file. |
| 4223 | |
| 4224 | This command also implements an interface for special buffers |
| 4225 | that contain text which doesn't come from a file, but reflects |
| 4226 | some other data instead (e.g. Dired buffers, `buffer-list' |
| 4227 | buffers). This is done via the variable |
| 4228 | `revert-buffer-function'. In these cases, it should reconstruct |
| 4229 | the buffer contents from the appropriate data. |
| 4230 | |
| 4231 | When called from Lisp, the first argument is IGNORE-AUTO; only offer |
| 4232 | to revert from the auto-save file when this is nil. Note that the |
| 4233 | sense of this argument is the reverse of the prefix argument, for the |
| 4234 | sake of backward compatibility. IGNORE-AUTO is optional, defaulting |
| 4235 | to nil. |
| 4236 | |
| 4237 | Optional second argument NOCONFIRM means don't ask for confirmation at |
| 4238 | all. \(The variable `revert-without-query' offers another way to |
| 4239 | revert buffers without querying for confirmation.) |
| 4240 | |
| 4241 | Optional third argument PRESERVE-MODES non-nil means don't alter |
| 4242 | the files modes. Normally we reinitialize them using `normal-mode'. |
| 4243 | |
| 4244 | If the value of `revert-buffer-function' is non-nil, it is called to |
| 4245 | do all the work for this command. Otherwise, the hooks |
| 4246 | `before-revert-hook' and `after-revert-hook' are run at the beginning |
| 4247 | and the end, and if `revert-buffer-insert-file-contents-function' is |
| 4248 | non-nil, it is called instead of rereading visited file contents." |
| 4249 | |
| 4250 | ;; I admit it's odd to reverse the sense of the prefix argument, but |
| 4251 | ;; there is a lot of code out there which assumes that the first |
| 4252 | ;; argument should be t to avoid consulting the auto-save file, and |
| 4253 | ;; there's no straightforward way to encourage authors to notice a |
| 4254 | ;; reversal of the argument sense. So I'm just changing the user |
| 4255 | ;; interface, but leaving the programmatic interface the same. |
| 4256 | (interactive (list (not current-prefix-arg))) |
| 4257 | (if revert-buffer-function |
| 4258 | (funcall revert-buffer-function ignore-auto noconfirm) |
| 4259 | (with-current-buffer (or (buffer-base-buffer (current-buffer)) |
| 4260 | (current-buffer)) |
| 4261 | (let* ((auto-save-p (and (not ignore-auto) |
| 4262 | (recent-auto-save-p) |
| 4263 | buffer-auto-save-file-name |
| 4264 | (file-readable-p buffer-auto-save-file-name) |
| 4265 | (y-or-n-p |
| 4266 | "Buffer has been auto-saved recently. Revert from auto-save file? "))) |
| 4267 | (file-name (if auto-save-p |
| 4268 | buffer-auto-save-file-name |
| 4269 | buffer-file-name))) |
| 4270 | (cond ((null file-name) |
| 4271 | (error "Buffer does not seem to be associated with any file")) |
| 4272 | ((or noconfirm |
| 4273 | (and (not (buffer-modified-p)) |
| 4274 | (catch 'found |
| 4275 | (dolist (regexp revert-without-query) |
| 4276 | (when (string-match regexp file-name) |
| 4277 | (throw 'found t))))) |
| 4278 | (yes-or-no-p (format "Revert buffer from file %s? " |
| 4279 | file-name))) |
| 4280 | (run-hooks 'before-revert-hook) |
| 4281 | ;; If file was backed up but has changed since, |
| 4282 | ;; we shd make another backup. |
| 4283 | (and (not auto-save-p) |
| 4284 | (not (verify-visited-file-modtime (current-buffer))) |
| 4285 | (setq buffer-backed-up nil)) |
| 4286 | ;; Effectively copy the after-revert-hook status, |
| 4287 | ;; since after-find-file will clobber it. |
| 4288 | (let ((global-hook (default-value 'after-revert-hook)) |
| 4289 | (local-hook (when (local-variable-p 'after-revert-hook) |
| 4290 | after-revert-hook)) |
| 4291 | (inhibit-read-only t)) |
| 4292 | (cond |
| 4293 | (revert-buffer-insert-file-contents-function |
| 4294 | (unless (eq buffer-undo-list t) |
| 4295 | ;; Get rid of all undo records for this buffer. |
| 4296 | (setq buffer-undo-list nil)) |
| 4297 | ;; Don't make undo records for the reversion. |
| 4298 | (let ((buffer-undo-list t)) |
| 4299 | (funcall revert-buffer-insert-file-contents-function |
| 4300 | file-name auto-save-p))) |
| 4301 | ((not (file-exists-p file-name)) |
| 4302 | (error (if buffer-file-number |
| 4303 | "File %s no longer exists!" |
| 4304 | "Cannot revert nonexistent file %s") |
| 4305 | file-name)) |
| 4306 | ((not (file-readable-p file-name)) |
| 4307 | (error (if buffer-file-number |
| 4308 | "File %s no longer readable!" |
| 4309 | "Cannot revert unreadable file %s") |
| 4310 | file-name)) |
| 4311 | (t |
| 4312 | ;; Bind buffer-file-name to nil |
| 4313 | ;; so that we don't try to lock the file. |
| 4314 | (let ((buffer-file-name nil)) |
| 4315 | (or auto-save-p |
| 4316 | (unlock-buffer))) |
| 4317 | (widen) |
| 4318 | (let ((coding-system-for-read |
| 4319 | ;; Auto-saved file should be read by Emacs' |
| 4320 | ;; internal coding. |
| 4321 | (if auto-save-p 'auto-save-coding |
| 4322 | (or coding-system-for-read |
| 4323 | buffer-file-coding-system-explicit)))) |
| 4324 | (if (and (not enable-multibyte-characters) |
| 4325 | coding-system-for-read |
| 4326 | (not (memq (coding-system-base |
| 4327 | coding-system-for-read) |
| 4328 | '(no-conversion raw-text)))) |
| 4329 | ;; As a coding system suitable for multibyte |
| 4330 | ;; buffer is specified, make the current |
| 4331 | ;; buffer multibyte. |
| 4332 | (set-buffer-multibyte t)) |
| 4333 | |
| 4334 | ;; This force after-insert-file-set-coding |
| 4335 | ;; (called from insert-file-contents) to set |
| 4336 | ;; buffer-file-coding-system to a proper value. |
| 4337 | (kill-local-variable 'buffer-file-coding-system) |
| 4338 | |
| 4339 | ;; Note that this preserves point in an intelligent way. |
| 4340 | (if preserve-modes |
| 4341 | (let ((buffer-file-format buffer-file-format)) |
| 4342 | (insert-file-contents file-name (not auto-save-p) |
| 4343 | nil nil t)) |
| 4344 | (insert-file-contents file-name (not auto-save-p) |
| 4345 | nil nil t))))) |
| 4346 | ;; Recompute the truename in case changes in symlinks |
| 4347 | ;; have changed the truename. |
| 4348 | (setq buffer-file-truename |
| 4349 | (abbreviate-file-name (file-truename buffer-file-name))) |
| 4350 | (after-find-file nil nil t t preserve-modes) |
| 4351 | ;; Run after-revert-hook as it was before we reverted. |
| 4352 | (setq-default revert-buffer-internal-hook global-hook) |
| 4353 | (if local-hook |
| 4354 | (set (make-local-variable 'revert-buffer-internal-hook) |
| 4355 | local-hook) |
| 4356 | (kill-local-variable 'revert-buffer-internal-hook)) |
| 4357 | (run-hooks 'revert-buffer-internal-hook)) |
| 4358 | t)))))) |
| 4359 | |
| 4360 | (defun recover-this-file () |
| 4361 | "Recover the visited file--get contents from its last auto-save file." |
| 4362 | (interactive) |
| 4363 | (recover-file buffer-file-name)) |
| 4364 | |
| 4365 | (defun recover-file (file) |
| 4366 | "Visit file FILE, but get contents from its last auto-save file." |
| 4367 | ;; Actually putting the file name in the minibuffer should be used |
| 4368 | ;; only rarely. |
| 4369 | ;; Not just because users often use the default. |
| 4370 | (interactive "FRecover file: ") |
| 4371 | (setq file (expand-file-name file)) |
| 4372 | (if (auto-save-file-name-p (file-name-nondirectory file)) |
| 4373 | (error "%s is an auto-save file" (abbreviate-file-name file))) |
| 4374 | (let ((file-name (let ((buffer-file-name file)) |
| 4375 | (make-auto-save-file-name)))) |
| 4376 | (cond ((if (file-exists-p file) |
| 4377 | (not (file-newer-than-file-p file-name file)) |
| 4378 | (not (file-exists-p file-name))) |
| 4379 | (error "Auto-save file %s not current" |
| 4380 | (abbreviate-file-name file-name))) |
| 4381 | ((save-window-excursion |
| 4382 | (with-output-to-temp-buffer "*Directory*" |
| 4383 | (buffer-disable-undo standard-output) |
| 4384 | (save-excursion |
| 4385 | (let ((switches dired-listing-switches)) |
| 4386 | (if (file-symlink-p file) |
| 4387 | (setq switches (concat switches "L"))) |
| 4388 | (set-buffer standard-output) |
| 4389 | ;; Use insert-directory-safely, not insert-directory, |
| 4390 | ;; because these files might not exist. In particular, |
| 4391 | ;; FILE might not exist if the auto-save file was for |
| 4392 | ;; a buffer that didn't visit a file, such as "*mail*". |
| 4393 | ;; The code in v20.x called `ls' directly, so we need |
| 4394 | ;; to emulate what `ls' did in that case. |
| 4395 | (insert-directory-safely file switches) |
| 4396 | (insert-directory-safely file-name switches)))) |
| 4397 | (yes-or-no-p (format "Recover auto save file %s? " file-name))) |
| 4398 | (switch-to-buffer (find-file-noselect file t)) |
| 4399 | (let ((inhibit-read-only t) |
| 4400 | ;; Keep the current buffer-file-coding-system. |
| 4401 | (coding-system buffer-file-coding-system) |
| 4402 | ;; Auto-saved file should be read with special coding. |
| 4403 | (coding-system-for-read 'auto-save-coding)) |
| 4404 | (erase-buffer) |
| 4405 | (insert-file-contents file-name nil) |
| 4406 | (set-buffer-file-coding-system coding-system)) |
| 4407 | (after-find-file nil nil t)) |
| 4408 | (t (error "Recover-file cancelled"))))) |
| 4409 | |
| 4410 | (defun recover-session () |
| 4411 | "Recover auto save files from a previous Emacs session. |
| 4412 | This command first displays a Dired buffer showing you the |
| 4413 | previous sessions that you could recover from. |
| 4414 | To choose one, move point to the proper line and then type C-c C-c. |
| 4415 | Then you'll be asked about a number of files to recover." |
| 4416 | (interactive) |
| 4417 | (if (null auto-save-list-file-prefix) |
| 4418 | (error "You set `auto-save-list-file-prefix' to disable making session files")) |
| 4419 | (let ((dir (file-name-directory auto-save-list-file-prefix))) |
| 4420 | (unless (file-directory-p dir) |
| 4421 | (make-directory dir t)) |
| 4422 | (unless (directory-files dir nil |
| 4423 | (concat "\\`" (regexp-quote |
| 4424 | (file-name-nondirectory |
| 4425 | auto-save-list-file-prefix))) |
| 4426 | t) |
| 4427 | (error "No previous sessions to recover"))) |
| 4428 | (let ((ls-lisp-support-shell-wildcards t)) |
| 4429 | (dired (concat auto-save-list-file-prefix "*") |
| 4430 | (concat dired-listing-switches "t"))) |
| 4431 | (save-excursion |
| 4432 | (goto-char (point-min)) |
| 4433 | (or (looking-at " Move to the session you want to recover,") |
| 4434 | (let ((inhibit-read-only t)) |
| 4435 | ;; Each line starts with a space |
| 4436 | ;; so that Font Lock mode won't highlight the first character. |
| 4437 | (insert " Move to the session you want to recover,\n" |
| 4438 | " then type C-c C-c to select it.\n\n" |
| 4439 | " You can also delete some of these files;\n" |
| 4440 | " type d on a line to mark that file for deletion.\n\n")))) |
| 4441 | (use-local-map (nconc (make-sparse-keymap) (current-local-map))) |
| 4442 | (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish)) |
| 4443 | |
| 4444 | (defun recover-session-finish () |
| 4445 | "Choose one saved session to recover auto-save files from. |
| 4446 | This command is used in the special Dired buffer created by |
| 4447 | \\[recover-session]." |
| 4448 | (interactive) |
| 4449 | ;; Get the name of the session file to recover from. |
| 4450 | (let ((file (dired-get-filename)) |
| 4451 | files |
| 4452 | (buffer (get-buffer-create " *recover*"))) |
| 4453 | (dired-unmark 1) |
| 4454 | (dired-do-flagged-delete t) |
| 4455 | (unwind-protect |
| 4456 | (save-excursion |
| 4457 | ;; Read in the auto-save-list file. |
| 4458 | (set-buffer buffer) |
| 4459 | (erase-buffer) |
| 4460 | (insert-file-contents file) |
| 4461 | ;; Loop thru the text of that file |
| 4462 | ;; and get out the names of the files to recover. |
| 4463 | (while (not (eobp)) |
| 4464 | (let (thisfile autofile) |
| 4465 | (if (eolp) |
| 4466 | ;; This is a pair of lines for a non-file-visiting buffer. |
| 4467 | ;; Get the auto-save file name and manufacture |
| 4468 | ;; a "visited file name" from that. |
| 4469 | (progn |
| 4470 | (forward-line 1) |
| 4471 | ;; If there is no auto-save file name, the |
| 4472 | ;; auto-save-list file is probably corrupted. |
| 4473 | (unless (eolp) |
| 4474 | (setq autofile |
| 4475 | (buffer-substring-no-properties |
| 4476 | (point) |
| 4477 | (line-end-position))) |
| 4478 | (setq thisfile |
| 4479 | (expand-file-name |
| 4480 | (substring |
| 4481 | (file-name-nondirectory autofile) |
| 4482 | 1 -1) |
| 4483 | (file-name-directory autofile)))) |
| 4484 | (forward-line 1)) |
| 4485 | ;; This pair of lines is a file-visiting |
| 4486 | ;; buffer. Use the visited file name. |
| 4487 | (progn |
| 4488 | (setq thisfile |
| 4489 | (buffer-substring-no-properties |
| 4490 | (point) (progn (end-of-line) (point)))) |
| 4491 | (forward-line 1) |
| 4492 | (setq autofile |
| 4493 | (buffer-substring-no-properties |
| 4494 | (point) (progn (end-of-line) (point)))) |
| 4495 | (forward-line 1))) |
| 4496 | ;; Ignore a file if its auto-save file does not exist now. |
| 4497 | (if (and autofile (file-exists-p autofile)) |
| 4498 | (setq files (cons thisfile files))))) |
| 4499 | (setq files (nreverse files)) |
| 4500 | ;; The file contains a pair of line for each auto-saved buffer. |
| 4501 | ;; The first line of the pair contains the visited file name |
| 4502 | ;; or is empty if the buffer was not visiting a file. |
| 4503 | ;; The second line is the auto-save file name. |
| 4504 | (if files |
| 4505 | (map-y-or-n-p "Recover %s? " |
| 4506 | (lambda (file) |
| 4507 | (condition-case nil |
| 4508 | (save-excursion (recover-file file)) |
| 4509 | (error |
| 4510 | "Failed to recover `%s'" file))) |
| 4511 | files |
| 4512 | '("file" "files" "recover")) |
| 4513 | (message "No files can be recovered from this session now"))) |
| 4514 | (kill-buffer buffer)))) |
| 4515 | |
| 4516 | (defun kill-buffer-ask (buffer) |
| 4517 | "Kill buffer if confirmed." |
| 4518 | (when (yes-or-no-p |
| 4519 | (format "Buffer %s %s. Kill? " (buffer-name buffer) |
| 4520 | (if (buffer-modified-p buffer) |
| 4521 | "HAS BEEN EDITED" "is unmodified"))) |
| 4522 | (kill-buffer buffer))) |
| 4523 | |
| 4524 | (defun kill-some-buffers (&optional list) |
| 4525 | "Kill some buffers. Asks the user whether to kill each one of them. |
| 4526 | Non-interactively, if optional argument LIST is non-nil, it |
| 4527 | specifies the list of buffers to kill, asking for approval for each one." |
| 4528 | (interactive) |
| 4529 | (if (null list) |
| 4530 | (setq list (buffer-list))) |
| 4531 | (while list |
| 4532 | (let* ((buffer (car list)) |
| 4533 | (name (buffer-name buffer))) |
| 4534 | (and name ; Can be nil for an indirect buffer |
| 4535 | ; if we killed the base buffer. |
| 4536 | (not (string-equal name "")) |
| 4537 | (/= (aref name 0) ?\s) |
| 4538 | (kill-buffer-ask buffer))) |
| 4539 | (setq list (cdr list)))) |
| 4540 | |
| 4541 | (defun kill-matching-buffers (regexp &optional internal-too) |
| 4542 | "Kill buffers whose name matches the specified regexp. |
| 4543 | The optional second argument indicates whether to kill internal buffers too." |
| 4544 | (interactive "sKill buffers matching this regular expression: \nP") |
| 4545 | (dolist (buffer (buffer-list)) |
| 4546 | (let ((name (buffer-name buffer))) |
| 4547 | (when (and name (not (string-equal name "")) |
| 4548 | (or internal-too (/= (aref name 0) ?\s)) |
| 4549 | (string-match regexp name)) |
| 4550 | (kill-buffer-ask buffer))))) |
| 4551 | |
| 4552 | \f |
| 4553 | (defun auto-save-mode (arg) |
| 4554 | "Toggle auto-saving of contents of current buffer. |
| 4555 | With prefix argument ARG, turn auto-saving on if positive, else off." |
| 4556 | (interactive "P") |
| 4557 | (setq buffer-auto-save-file-name |
| 4558 | (and (if (null arg) |
| 4559 | (or (not buffer-auto-save-file-name) |
| 4560 | ;; If auto-save is off because buffer has shrunk, |
| 4561 | ;; then toggling should turn it on. |
| 4562 | (< buffer-saved-size 0)) |
| 4563 | (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0)))) |
| 4564 | (if (and buffer-file-name auto-save-visited-file-name |
| 4565 | (not buffer-read-only)) |
| 4566 | buffer-file-name |
| 4567 | (make-auto-save-file-name)))) |
| 4568 | ;; If -1 was stored here, to temporarily turn off saving, |
| 4569 | ;; turn it back on. |
| 4570 | (and (< buffer-saved-size 0) |
| 4571 | (setq buffer-saved-size 0)) |
| 4572 | (if (interactive-p) |
| 4573 | (message "Auto-save %s (in this buffer)" |
| 4574 | (if buffer-auto-save-file-name "on" "off"))) |
| 4575 | buffer-auto-save-file-name) |
| 4576 | |
| 4577 | (defun rename-auto-save-file () |
| 4578 | "Adjust current buffer's auto save file name for current conditions. |
| 4579 | Also rename any existing auto save file, if it was made in this session." |
| 4580 | (let ((osave buffer-auto-save-file-name)) |
| 4581 | (setq buffer-auto-save-file-name |
| 4582 | (make-auto-save-file-name)) |
| 4583 | (if (and osave buffer-auto-save-file-name |
| 4584 | (not (string= buffer-auto-save-file-name buffer-file-name)) |
| 4585 | (not (string= buffer-auto-save-file-name osave)) |
| 4586 | (file-exists-p osave) |
| 4587 | (recent-auto-save-p)) |
| 4588 | (rename-file osave buffer-auto-save-file-name t)))) |
| 4589 | |
| 4590 | (defun make-auto-save-file-name () |
| 4591 | "Return file name to use for auto-saves of current buffer. |
| 4592 | Does not consider `auto-save-visited-file-name' as that variable is checked |
| 4593 | before calling this function. You can redefine this for customization. |
| 4594 | See also `auto-save-file-name-p'." |
| 4595 | (if buffer-file-name |
| 4596 | (let ((handler (find-file-name-handler buffer-file-name |
| 4597 | 'make-auto-save-file-name))) |
| 4598 | (if handler |
| 4599 | (funcall handler 'make-auto-save-file-name) |
| 4600 | (let ((list auto-save-file-name-transforms) |
| 4601 | (filename buffer-file-name) |
| 4602 | result uniq) |
| 4603 | ;; Apply user-specified translations |
| 4604 | ;; to the file name. |
| 4605 | (while (and list (not result)) |
| 4606 | (if (string-match (car (car list)) filename) |
| 4607 | (setq result (replace-match (cadr (car list)) t nil |
| 4608 | filename) |
| 4609 | uniq (car (cddr (car list))))) |
| 4610 | (setq list (cdr list))) |
| 4611 | (if result |
| 4612 | (if uniq |
| 4613 | (setq filename (concat |
| 4614 | (file-name-directory result) |
| 4615 | (subst-char-in-string |
| 4616 | ?/ ?! |
| 4617 | (replace-regexp-in-string "!" "!!" |
| 4618 | filename)))) |
| 4619 | (setq filename result))) |
| 4620 | (setq result |
| 4621 | (if (and (eq system-type 'ms-dos) |
| 4622 | (not (msdos-long-file-names))) |
| 4623 | ;; We truncate the file name to DOS 8+3 limits |
| 4624 | ;; before doing anything else, because the regexp |
| 4625 | ;; passed to string-match below cannot handle |
| 4626 | ;; extensions longer than 3 characters, multiple |
| 4627 | ;; dots, and other atrocities. |
| 4628 | (let ((fn (dos-8+3-filename |
| 4629 | (file-name-nondirectory buffer-file-name)))) |
| 4630 | (string-match |
| 4631 | "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" |
| 4632 | fn) |
| 4633 | (concat (file-name-directory buffer-file-name) |
| 4634 | "#" (match-string 1 fn) |
| 4635 | "." (match-string 3 fn) "#")) |
| 4636 | (concat (file-name-directory filename) |
| 4637 | "#" |
| 4638 | (file-name-nondirectory filename) |
| 4639 | "#"))) |
| 4640 | ;; Make sure auto-save file names don't contain characters |
| 4641 | ;; invalid for the underlying filesystem. |
| 4642 | (if (and (memq system-type '(ms-dos windows-nt cygwin)) |
| 4643 | ;; Don't modify remote (ange-ftp) filenames |
| 4644 | (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result))) |
| 4645 | (convert-standard-filename result) |
| 4646 | result)))) |
| 4647 | |
| 4648 | ;; Deal with buffers that don't have any associated files. (Mail |
| 4649 | ;; mode tends to create a good number of these.) |
| 4650 | |
| 4651 | (let ((buffer-name (buffer-name)) |
| 4652 | (limit 0) |
| 4653 | file-name) |
| 4654 | ;; Eliminate all slashes and backslashes by |
| 4655 | ;; replacing them with sequences that start with %. |
| 4656 | ;; Quote % also, to keep distinct names distinct. |
| 4657 | (while (string-match "[/\\%]" buffer-name limit) |
| 4658 | (let* ((character (aref buffer-name (match-beginning 0))) |
| 4659 | (replacement |
| 4660 | (cond ((eq character ?%) "%%") |
| 4661 | ((eq character ?/) "%+") |
| 4662 | ((eq character ?\\) "%-")))) |
| 4663 | (setq buffer-name (replace-match replacement t t buffer-name)) |
| 4664 | (setq limit (1+ (match-end 0))))) |
| 4665 | ;; Generate the file name. |
| 4666 | (setq file-name |
| 4667 | (make-temp-file |
| 4668 | (let ((fname |
| 4669 | (expand-file-name |
| 4670 | (format "#%s#" buffer-name) |
| 4671 | ;; Try a few alternative directories, to get one we can |
| 4672 | ;; write it. |
| 4673 | (cond |
| 4674 | ((file-writable-p default-directory) default-directory) |
| 4675 | ((file-writable-p "/var/tmp/") "/var/tmp/") |
| 4676 | ("~/"))))) |
| 4677 | (if (and (memq system-type '(ms-dos windows-nt cygwin)) |
| 4678 | ;; Don't modify remote (ange-ftp) filenames |
| 4679 | (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname))) |
| 4680 | ;; The call to convert-standard-filename is in case |
| 4681 | ;; buffer-name includes characters not allowed by the |
| 4682 | ;; DOS/Windows filesystems. make-temp-file writes to the |
| 4683 | ;; file it creates, so we must fix the file name _before_ |
| 4684 | ;; make-temp-file is called. |
| 4685 | (convert-standard-filename fname) |
| 4686 | fname)) |
| 4687 | nil "#")) |
| 4688 | ;; make-temp-file creates the file, |
| 4689 | ;; but we don't want it to exist until we do an auto-save. |
| 4690 | (condition-case () |
| 4691 | (delete-file file-name) |
| 4692 | (file-error nil)) |
| 4693 | file-name))) |
| 4694 | |
| 4695 | (defun auto-save-file-name-p (filename) |
| 4696 | "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'. |
| 4697 | FILENAME should lack slashes. You can redefine this for customization." |
| 4698 | (string-match "^#.*#$" filename)) |
| 4699 | \f |
| 4700 | (defun wildcard-to-regexp (wildcard) |
| 4701 | "Given a shell file name pattern WILDCARD, return an equivalent regexp. |
| 4702 | The generated regexp will match a filename only if the filename |
| 4703 | matches that wildcard according to shell rules. Only wildcards known |
| 4704 | by `sh' are supported." |
| 4705 | (let* ((i (string-match "[[.*+\\^$?]" wildcard)) |
| 4706 | ;; Copy the initial run of non-special characters. |
| 4707 | (result (substring wildcard 0 i)) |
| 4708 | (len (length wildcard))) |
| 4709 | ;; If no special characters, we're almost done. |
| 4710 | (if i |
| 4711 | (while (< i len) |
| 4712 | (let ((ch (aref wildcard i)) |
| 4713 | j) |
| 4714 | (setq |
| 4715 | result |
| 4716 | (concat result |
| 4717 | (cond |
| 4718 | ((and (eq ch ?\[) |
| 4719 | (< (1+ i) len) |
| 4720 | (eq (aref wildcard (1+ i)) ?\])) |
| 4721 | "\\[") |
| 4722 | ((eq ch ?\[) ; [...] maps to regexp char class |
| 4723 | (progn |
| 4724 | (setq i (1+ i)) |
| 4725 | (concat |
| 4726 | (cond |
| 4727 | ((eq (aref wildcard i) ?!) ; [!...] -> [^...] |
| 4728 | (progn |
| 4729 | (setq i (1+ i)) |
| 4730 | (if (eq (aref wildcard i) ?\]) |
| 4731 | (progn |
| 4732 | (setq i (1+ i)) |
| 4733 | "[^]") |
| 4734 | "[^"))) |
| 4735 | ((eq (aref wildcard i) ?^) |
| 4736 | ;; Found "[^". Insert a `\0' character |
| 4737 | ;; (which cannot happen in a filename) |
| 4738 | ;; into the character class, so that `^' |
| 4739 | ;; is not the first character after `[', |
| 4740 | ;; and thus non-special in a regexp. |
| 4741 | (progn |
| 4742 | (setq i (1+ i)) |
| 4743 | "[\000^")) |
| 4744 | ((eq (aref wildcard i) ?\]) |
| 4745 | ;; I don't think `]' can appear in a |
| 4746 | ;; character class in a wildcard, but |
| 4747 | ;; let's be general here. |
| 4748 | (progn |
| 4749 | (setq i (1+ i)) |
| 4750 | "[]")) |
| 4751 | (t "[")) |
| 4752 | (prog1 ; copy everything upto next `]'. |
| 4753 | (substring wildcard |
| 4754 | i |
| 4755 | (setq j (string-match |
| 4756 | "]" wildcard i))) |
| 4757 | (setq i (if j (1- j) (1- len))))))) |
| 4758 | ((eq ch ?.) "\\.") |
| 4759 | ((eq ch ?*) "[^\000]*") |
| 4760 | ((eq ch ?+) "\\+") |
| 4761 | ((eq ch ?^) "\\^") |
| 4762 | ((eq ch ?$) "\\$") |
| 4763 | ((eq ch ?\\) "\\\\") ; probably cannot happen... |
| 4764 | ((eq ch ??) "[^\000]") |
| 4765 | (t (char-to-string ch))))) |
| 4766 | (setq i (1+ i))))) |
| 4767 | ;; Shell wildcards should match the entire filename, |
| 4768 | ;; not its part. Make the regexp say so. |
| 4769 | (concat "\\`" result "\\'"))) |
| 4770 | \f |
| 4771 | (defcustom list-directory-brief-switches |
| 4772 | (if (eq system-type 'vax-vms) "" "-CF") |
| 4773 | "Switches for `list-directory' to pass to `ls' for brief listing." |
| 4774 | :type 'string |
| 4775 | :group 'dired) |
| 4776 | |
| 4777 | (defcustom list-directory-verbose-switches |
| 4778 | (if (eq system-type 'vax-vms) |
| 4779 | "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)" |
| 4780 | "-l") |
| 4781 | "Switches for `list-directory' to pass to `ls' for verbose listing." |
| 4782 | :type 'string |
| 4783 | :group 'dired) |
| 4784 | |
| 4785 | (defun file-expand-wildcards (pattern &optional full) |
| 4786 | "Expand wildcard pattern PATTERN. |
| 4787 | This returns a list of file names which match the pattern. |
| 4788 | |
| 4789 | If PATTERN is written as an absolute file name, |
| 4790 | the values are absolute also. |
| 4791 | |
| 4792 | If PATTERN is written as a relative file name, it is interpreted |
| 4793 | relative to the current default directory, `default-directory'. |
| 4794 | The file names returned are normally also relative to the current |
| 4795 | default directory. However, if FULL is non-nil, they are absolute." |
| 4796 | (save-match-data |
| 4797 | (let* ((nondir (file-name-nondirectory pattern)) |
| 4798 | (dirpart (file-name-directory pattern)) |
| 4799 | ;; A list of all dirs that DIRPART specifies. |
| 4800 | ;; This can be more than one dir |
| 4801 | ;; if DIRPART contains wildcards. |
| 4802 | (dirs (if (and dirpart (string-match "[[*?]" dirpart)) |
| 4803 | (mapcar 'file-name-as-directory |
| 4804 | (file-expand-wildcards (directory-file-name dirpart))) |
| 4805 | (list dirpart))) |
| 4806 | contents) |
| 4807 | (while dirs |
| 4808 | (when (or (null (car dirs)) ; Possible if DIRPART is not wild. |
| 4809 | (file-directory-p (directory-file-name (car dirs)))) |
| 4810 | (let ((this-dir-contents |
| 4811 | ;; Filter out "." and ".." |
| 4812 | (delq nil |
| 4813 | (mapcar #'(lambda (name) |
| 4814 | (unless (string-match "\\`\\.\\.?\\'" |
| 4815 | (file-name-nondirectory name)) |
| 4816 | name)) |
| 4817 | (directory-files (or (car dirs) ".") full |
| 4818 | (wildcard-to-regexp nondir)))))) |
| 4819 | (setq contents |
| 4820 | (nconc |
| 4821 | (if (and (car dirs) (not full)) |
| 4822 | (mapcar (function (lambda (name) (concat (car dirs) name))) |
| 4823 | this-dir-contents) |
| 4824 | this-dir-contents) |
| 4825 | contents)))) |
| 4826 | (setq dirs (cdr dirs))) |
| 4827 | contents))) |
| 4828 | |
| 4829 | (defun list-directory (dirname &optional verbose) |
| 4830 | "Display a list of files in or matching DIRNAME, a la `ls'. |
| 4831 | DIRNAME is globbed by the shell if necessary. |
| 4832 | Prefix arg (second arg if noninteractive) means supply -l switch to `ls'. |
| 4833 | Actions controlled by variables `list-directory-brief-switches' |
| 4834 | and `list-directory-verbose-switches'." |
| 4835 | (interactive (let ((pfx current-prefix-arg)) |
| 4836 | (list (read-file-name (if pfx "List directory (verbose): " |
| 4837 | "List directory (brief): ") |
| 4838 | nil default-directory nil) |
| 4839 | pfx))) |
| 4840 | (let ((switches (if verbose list-directory-verbose-switches |
| 4841 | list-directory-brief-switches)) |
| 4842 | buffer) |
| 4843 | (or dirname (setq dirname default-directory)) |
| 4844 | (setq dirname (expand-file-name dirname)) |
| 4845 | (with-output-to-temp-buffer "*Directory*" |
| 4846 | (setq buffer standard-output) |
| 4847 | (buffer-disable-undo standard-output) |
| 4848 | (princ "Directory ") |
| 4849 | (princ dirname) |
| 4850 | (terpri) |
| 4851 | (save-excursion |
| 4852 | (set-buffer "*Directory*") |
| 4853 | (let ((wildcard (not (file-directory-p dirname)))) |
| 4854 | (insert-directory dirname switches wildcard (not wildcard))))) |
| 4855 | ;; Finishing with-output-to-temp-buffer seems to clobber default-directory. |
| 4856 | (with-current-buffer buffer |
| 4857 | (setq default-directory |
| 4858 | (if (file-directory-p dirname) |
| 4859 | (file-name-as-directory dirname) |
| 4860 | (file-name-directory dirname)))))) |
| 4861 | |
| 4862 | (defun shell-quote-wildcard-pattern (pattern) |
| 4863 | "Quote characters special to the shell in PATTERN, leave wildcards alone. |
| 4864 | |
| 4865 | PATTERN is assumed to represent a file-name wildcard suitable for the |
| 4866 | underlying filesystem. For Unix and GNU/Linux, the characters from the |
| 4867 | set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all |
| 4868 | the parts of the pattern which don't include wildcard characters are |
| 4869 | quoted with double quotes. |
| 4870 | Existing quote characters in PATTERN are left alone, so you can pass |
| 4871 | PATTERN that already quotes some of the special characters." |
| 4872 | (save-match-data |
| 4873 | (cond |
| 4874 | ((memq system-type '(ms-dos windows-nt cygwin)) |
| 4875 | ;; DOS/Windows don't allow `"' in file names. So if the |
| 4876 | ;; argument has quotes, we can safely assume it is already |
| 4877 | ;; quoted by the caller. |
| 4878 | (if (or (string-match "[\"]" pattern) |
| 4879 | ;; We quote [&()#$'] in case their shell is a port of a |
| 4880 | ;; Unixy shell. We quote [,=+] because stock DOS and |
| 4881 | ;; Windows shells require that in some cases, such as |
| 4882 | ;; passing arguments to batch files that use positional |
| 4883 | ;; arguments like %1. |
| 4884 | (not (string-match "[ \t;&()#$',=+]" pattern))) |
| 4885 | pattern |
| 4886 | (let ((result "\"") |
| 4887 | (beg 0) |
| 4888 | end) |
| 4889 | (while (string-match "[*?]+" pattern beg) |
| 4890 | (setq end (match-beginning 0) |
| 4891 | result (concat result (substring pattern beg end) |
| 4892 | "\"" |
| 4893 | (substring pattern end (match-end 0)) |
| 4894 | "\"") |
| 4895 | beg (match-end 0))) |
| 4896 | (concat result (substring pattern beg) "\"")))) |
| 4897 | (t |
| 4898 | (let ((beg 0)) |
| 4899 | (while (string-match "[ \t\n;<>&|()#$]" pattern beg) |
| 4900 | (setq pattern |
| 4901 | (concat (substring pattern 0 (match-beginning 0)) |
| 4902 | "\\" |
| 4903 | (substring pattern (match-beginning 0))) |
| 4904 | beg (1+ (match-end 0))))) |
| 4905 | pattern)))) |
| 4906 | |
| 4907 | |
| 4908 | (defvar insert-directory-program "ls" |
| 4909 | "Absolute or relative name of the `ls' program used by `insert-directory'.") |
| 4910 | |
| 4911 | (defcustom directory-free-space-program "df" |
| 4912 | "Program to get the amount of free space on a file system. |
| 4913 | We assume the output has the format of `df'. |
| 4914 | The value of this variable must be just a command name or file name; |
| 4915 | if you want to specify options, use `directory-free-space-args'. |
| 4916 | |
| 4917 | A value of nil disables this feature. |
| 4918 | |
| 4919 | If the function `file-system-info' is defined, it is always used in |
| 4920 | preference to the program given by this variable." |
| 4921 | :type '(choice (string :tag "Program") (const :tag "None" nil)) |
| 4922 | :group 'dired) |
| 4923 | |
| 4924 | (defcustom directory-free-space-args |
| 4925 | (if (eq system-type 'darwin) "-k" "-Pk") |
| 4926 | "Options to use when running `directory-free-space-program'." |
| 4927 | :type 'string |
| 4928 | :group 'dired) |
| 4929 | |
| 4930 | (defun get-free-disk-space (dir) |
| 4931 | "Return the amount of free space on directory DIR's file system. |
| 4932 | The result is a string that gives the number of free 1KB blocks, |
| 4933 | or nil if the system call or the program which retrieve the information |
| 4934 | fail. It returns also nil when DIR is a remote directory. |
| 4935 | |
| 4936 | This function calls `file-system-info' if it is available, or invokes the |
| 4937 | program specified by `directory-free-space-program' if that is non-nil." |
| 4938 | (when (not (file-remote-p dir)) |
| 4939 | ;; Try to find the number of free blocks. Non-Posix systems don't |
| 4940 | ;; always have df, but might have an equivalent system call. |
| 4941 | (if (fboundp 'file-system-info) |
| 4942 | (let ((fsinfo (file-system-info dir))) |
| 4943 | (if fsinfo |
| 4944 | (format "%.0f" (/ (nth 2 fsinfo) 1024)))) |
| 4945 | (save-match-data |
| 4946 | (with-temp-buffer |
| 4947 | (when (and directory-free-space-program |
| 4948 | (eq 0 (call-process directory-free-space-program |
| 4949 | nil t nil |
| 4950 | directory-free-space-args |
| 4951 | dir))) |
| 4952 | ;; Usual format is a header line followed by a line of |
| 4953 | ;; numbers. |
| 4954 | (goto-char (point-min)) |
| 4955 | (forward-line 1) |
| 4956 | (if (not (eobp)) |
| 4957 | (progn |
| 4958 | ;; Move to the end of the "available blocks" number. |
| 4959 | (skip-chars-forward "^ \t") |
| 4960 | (forward-word 3) |
| 4961 | ;; Copy it into AVAILABLE. |
| 4962 | (let ((end (point))) |
| 4963 | (forward-word -1) |
| 4964 | (buffer-substring (point) end)))))))))) |
| 4965 | |
| 4966 | ;; The following expression replaces `dired-move-to-filename-regexp'. |
| 4967 | (defvar directory-listing-before-filename-regexp |
| 4968 | (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)") |
| 4969 | (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)") |
| 4970 | ;; In some locales, month abbreviations are as short as 2 letters, |
| 4971 | ;; and they can be followed by ".". |
| 4972 | ;; In Breton, a month name can include a quote character. |
| 4973 | (month (concat l-or-quote l-or-quote "+\\.?")) |
| 4974 | (s " ") |
| 4975 | (yyyy "[0-9][0-9][0-9][0-9]") |
| 4976 | (dd "[ 0-3][0-9]") |
| 4977 | (HH:MM "[ 0-2][0-9][:.][0-5][0-9]") |
| 4978 | (seconds "[0-6][0-9]\\([.,][0-9]+\\)?") |
| 4979 | (zone "[-+][0-2][0-9][0-5][0-9]") |
| 4980 | (iso-mm-dd "[01][0-9]-[0-3][0-9]") |
| 4981 | (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?")) |
| 4982 | (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time |
| 4983 | "\\|" yyyy "-" iso-mm-dd "\\)")) |
| 4984 | (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)" |
| 4985 | s "+" |
| 4986 | "\\(" HH:MM "\\|" yyyy "\\)")) |
| 4987 | (western-comma (concat month s "+" dd "," s "+" yyyy)) |
| 4988 | ;; Japanese MS-Windows ls-lisp has one-digit months, and |
| 4989 | ;; omits the Kanji characters after month and day-of-month. |
| 4990 | ;; On Mac OS X 10.3, the date format in East Asian locales is |
| 4991 | ;; day-of-month digits followed by month digits. |
| 4992 | (mm "[ 0-1]?[0-9]") |
| 4993 | (east-asian |
| 4994 | (concat "\\(" mm l "?" s dd l "?" s "+" |
| 4995 | "\\|" dd s mm s "+" "\\)" |
| 4996 | "\\(" HH:MM "\\|" yyyy l "?" "\\)"))) |
| 4997 | ;; The "[0-9]" below requires the previous column to end in a digit. |
| 4998 | ;; This avoids recognizing `1 may 1997' as a date in the line: |
| 4999 | ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README |
| 5000 | |
| 5001 | ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output. |
| 5002 | ;; The ".*" below finds the last match if there are multiple matches. |
| 5003 | ;; This avoids recognizing `jservice 10 1024' as a date in the line: |
| 5004 | ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host |
| 5005 | |
| 5006 | ;; vc dired listings provide the state or blanks between file |
| 5007 | ;; permissions and date. The state is always surrounded by |
| 5008 | ;; parantheses: |
| 5009 | ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el |
| 5010 | ;; This is not supported yet. |
| 5011 | (concat ".*[0-9][BkKMGTPEZY]?" s |
| 5012 | "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)" |
| 5013 | s "+")) |
| 5014 | "Regular expression to match up to the file name in a directory listing. |
| 5015 | The default value is designed to recognize dates and times |
| 5016 | regardless of the language.") |
| 5017 | |
| 5018 | (defvar insert-directory-ls-version 'unknown) |
| 5019 | |
| 5020 | ;; insert-directory |
| 5021 | ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and |
| 5022 | ;; FULL-DIRECTORY-P is nil. |
| 5023 | ;; The single line of output must display FILE's name as it was |
| 5024 | ;; given, namely, an absolute path name. |
| 5025 | ;; - must insert exactly one line for each file if WILDCARD or |
| 5026 | ;; FULL-DIRECTORY-P is t, plus one optional "total" line |
| 5027 | ;; before the file lines, plus optional text after the file lines. |
| 5028 | ;; Lines are delimited by "\n", so filenames containing "\n" are not |
| 5029 | ;; allowed. |
| 5030 | ;; File lines should display the basename. |
| 5031 | ;; - must be consistent with |
| 5032 | ;; - functions dired-move-to-filename, (these two define what a file line is) |
| 5033 | ;; dired-move-to-end-of-filename, |
| 5034 | ;; dired-between-files, (shortcut for (not (dired-move-to-filename))) |
| 5035 | ;; dired-insert-headerline |
| 5036 | ;; dired-after-subdir-garbage (defines what a "total" line is) |
| 5037 | ;; - variable dired-subdir-regexp |
| 5038 | ;; - may be passed "--dired" as the first argument in SWITCHES. |
| 5039 | ;; Filename handlers might have to remove this switch if their |
| 5040 | ;; "ls" command does not support it. |
| 5041 | (defun insert-directory (file switches &optional wildcard full-directory-p) |
| 5042 | "Insert directory listing for FILE, formatted according to SWITCHES. |
| 5043 | Leaves point after the inserted text. |
| 5044 | SWITCHES may be a string of options, or a list of strings |
| 5045 | representing individual options. |
| 5046 | Optional third arg WILDCARD means treat FILE as shell wildcard. |
| 5047 | Optional fourth arg FULL-DIRECTORY-P means file is a directory and |
| 5048 | switches do not contain `d', so that a full listing is expected. |
| 5049 | |
| 5050 | This works by running a directory listing program |
| 5051 | whose name is in the variable `insert-directory-program'. |
| 5052 | If WILDCARD, it also runs the shell specified by `shell-file-name'. |
| 5053 | |
| 5054 | When SWITCHES contains the long `--dired' option, this function |
| 5055 | treats it specially, for the sake of dired. However, the |
| 5056 | normally equivalent short `-D' option is just passed on to |
| 5057 | `insert-directory-program', as any other option." |
| 5058 | ;; We need the directory in order to find the right handler. |
| 5059 | (let ((handler (find-file-name-handler (expand-file-name file) |
| 5060 | 'insert-directory))) |
| 5061 | (if handler |
| 5062 | (funcall handler 'insert-directory file switches |
| 5063 | wildcard full-directory-p) |
| 5064 | (if (eq system-type 'vax-vms) |
| 5065 | (vms-read-directory file switches (current-buffer)) |
| 5066 | (let (result (beg (point))) |
| 5067 | |
| 5068 | ;; Read the actual directory using `insert-directory-program'. |
| 5069 | ;; RESULT gets the status code. |
| 5070 | (let* (;; We at first read by no-conversion, then after |
| 5071 | ;; putting text property `dired-filename, decode one |
| 5072 | ;; bunch by one to preserve that property. |
| 5073 | (coding-system-for-read 'no-conversion) |
| 5074 | ;; This is to control encoding the arguments in call-process. |
| 5075 | (coding-system-for-write |
| 5076 | (and enable-multibyte-characters |
| 5077 | (or file-name-coding-system |
| 5078 | default-file-name-coding-system)))) |
| 5079 | (setq result |
| 5080 | (if wildcard |
| 5081 | ;; Run ls in the directory part of the file pattern |
| 5082 | ;; using the last component as argument. |
| 5083 | (let ((default-directory |
| 5084 | (if (file-name-absolute-p file) |
| 5085 | (file-name-directory file) |
| 5086 | (file-name-directory (expand-file-name file)))) |
| 5087 | (pattern (file-name-nondirectory file))) |
| 5088 | (call-process |
| 5089 | shell-file-name nil t nil |
| 5090 | "-c" |
| 5091 | (concat (if (memq system-type '(ms-dos windows-nt)) |
| 5092 | "" |
| 5093 | "\\") ; Disregard Unix shell aliases! |
| 5094 | insert-directory-program |
| 5095 | " -d " |
| 5096 | (if (stringp switches) |
| 5097 | switches |
| 5098 | (mapconcat 'identity switches " ")) |
| 5099 | " -- " |
| 5100 | ;; Quote some characters that have |
| 5101 | ;; special meanings in shells; but |
| 5102 | ;; don't quote the wildcards--we want |
| 5103 | ;; them to be special. We also |
| 5104 | ;; currently don't quote the quoting |
| 5105 | ;; characters in case people want to |
| 5106 | ;; use them explicitly to quote |
| 5107 | ;; wildcard characters. |
| 5108 | (shell-quote-wildcard-pattern pattern)))) |
| 5109 | ;; SunOS 4.1.3, SVr4 and others need the "." to list the |
| 5110 | ;; directory if FILE is a symbolic link. |
| 5111 | (apply 'call-process |
| 5112 | insert-directory-program nil t nil |
| 5113 | (append |
| 5114 | (if (listp switches) switches |
| 5115 | (unless (equal switches "") |
| 5116 | ;; Split the switches at any spaces so we can |
| 5117 | ;; pass separate options as separate args. |
| 5118 | (split-string switches))) |
| 5119 | ;; Avoid lossage if FILE starts with `-'. |
| 5120 | '("--") |
| 5121 | (progn |
| 5122 | (if (string-match "\\`~" file) |
| 5123 | (setq file (expand-file-name file))) |
| 5124 | (list |
| 5125 | (if full-directory-p |
| 5126 | (concat (file-name-as-directory file) ".") |
| 5127 | file)))))))) |
| 5128 | |
| 5129 | ;; If we got "//DIRED//" in the output, it means we got a real |
| 5130 | ;; directory listing, even if `ls' returned nonzero. |
| 5131 | ;; So ignore any errors. |
| 5132 | (when (if (stringp switches) |
| 5133 | (string-match "--dired\\>" switches) |
| 5134 | (member "--dired" switches)) |
| 5135 | (save-excursion |
| 5136 | (forward-line -2) |
| 5137 | (when (looking-at "//SUBDIRED//") |
| 5138 | (forward-line -1)) |
| 5139 | (if (looking-at "//DIRED//") |
| 5140 | (setq result 0)))) |
| 5141 | |
| 5142 | (when (and (not (eq 0 result)) |
| 5143 | (eq insert-directory-ls-version 'unknown)) |
| 5144 | ;; The first time ls returns an error, |
| 5145 | ;; find the version numbers of ls, |
| 5146 | ;; and set insert-directory-ls-version |
| 5147 | ;; to > if it is more than 5.2.1, < if it is less, nil if it |
| 5148 | ;; is equal or if the info cannot be obtained. |
| 5149 | ;; (That can mean it isn't GNU ls.) |
| 5150 | (let ((version-out |
| 5151 | (with-temp-buffer |
| 5152 | (call-process "ls" nil t nil "--version") |
| 5153 | (buffer-string)))) |
| 5154 | (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out) |
| 5155 | (let* ((version (match-string 1 version-out)) |
| 5156 | (split (split-string version "[.]")) |
| 5157 | (numbers (mapcar 'string-to-number split)) |
| 5158 | (min '(5 2 1)) |
| 5159 | comparison) |
| 5160 | (while (and (not comparison) (or numbers min)) |
| 5161 | (cond ((null min) |
| 5162 | (setq comparison '>)) |
| 5163 | ((null numbers) |
| 5164 | (setq comparison '<)) |
| 5165 | ((> (car numbers) (car min)) |
| 5166 | (setq comparison '>)) |
| 5167 | ((< (car numbers) (car min)) |
| 5168 | (setq comparison '<)) |
| 5169 | (t |
| 5170 | (setq numbers (cdr numbers) |
| 5171 | min (cdr min))))) |
| 5172 | (setq insert-directory-ls-version (or comparison '=))) |
| 5173 | (setq insert-directory-ls-version nil)))) |
| 5174 | |
| 5175 | ;; For GNU ls versions 5.2.2 and up, ignore minor errors. |
| 5176 | (when (and (eq 1 result) (eq insert-directory-ls-version '>)) |
| 5177 | (setq result 0)) |
| 5178 | |
| 5179 | ;; If `insert-directory-program' failed, signal an error. |
| 5180 | (unless (eq 0 result) |
| 5181 | ;; Delete the error message it may have output. |
| 5182 | (delete-region beg (point)) |
| 5183 | ;; On non-Posix systems, we cannot open a directory, so |
| 5184 | ;; don't even try, because that will always result in |
| 5185 | ;; the ubiquitous "Access denied". Instead, show the |
| 5186 | ;; command line so the user can try to guess what went wrong. |
| 5187 | (if (and (file-directory-p file) |
| 5188 | (memq system-type '(ms-dos windows-nt))) |
| 5189 | (error |
| 5190 | "Reading directory: \"%s %s -- %s\" exited with status %s" |
| 5191 | insert-directory-program |
| 5192 | (if (listp switches) (concat switches) switches) |
| 5193 | file result) |
| 5194 | ;; Unix. Access the file to get a suitable error. |
| 5195 | (access-file file "Reading directory") |
| 5196 | (error "Listing directory failed but `access-file' worked"))) |
| 5197 | |
| 5198 | (when (if (stringp switches) |
| 5199 | (string-match "--dired\\>" switches) |
| 5200 | (member "--dired" switches)) |
| 5201 | ;; The following overshoots by one line for an empty |
| 5202 | ;; directory listed with "--dired", but without "-a" |
| 5203 | ;; switch, where the ls output contains a |
| 5204 | ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line. |
| 5205 | ;; We take care of that case later. |
| 5206 | (forward-line -2) |
| 5207 | (when (looking-at "//SUBDIRED//") |
| 5208 | (delete-region (point) (progn (forward-line 1) (point))) |
| 5209 | (forward-line -1)) |
| 5210 | (if (looking-at "//DIRED//") |
| 5211 | (let ((end (line-end-position)) |
| 5212 | (linebeg (point)) |
| 5213 | error-lines) |
| 5214 | ;; Find all the lines that are error messages, |
| 5215 | ;; and record the bounds of each one. |
| 5216 | (goto-char beg) |
| 5217 | (while (< (point) linebeg) |
| 5218 | (or (eql (following-char) ?\s) |
| 5219 | (push (list (point) (line-end-position)) error-lines)) |
| 5220 | (forward-line 1)) |
| 5221 | (setq error-lines (nreverse error-lines)) |
| 5222 | ;; Now read the numeric positions of file names. |
| 5223 | (goto-char linebeg) |
| 5224 | (forward-word 1) |
| 5225 | (forward-char 3) |
| 5226 | (while (< (point) end) |
| 5227 | (let ((start (insert-directory-adj-pos |
| 5228 | (+ beg (read (current-buffer))) |
| 5229 | error-lines)) |
| 5230 | (end (insert-directory-adj-pos |
| 5231 | (+ beg (read (current-buffer))) |
| 5232 | error-lines))) |
| 5233 | (if (memq (char-after end) '(?\n ?\s)) |
| 5234 | ;; End is followed by \n or by " -> ". |
| 5235 | (put-text-property start end 'dired-filename t) |
| 5236 | ;; It seems that we can't trust ls's output as to |
| 5237 | ;; byte positions of filenames. |
| 5238 | (put-text-property beg (point) 'dired-filename nil) |
| 5239 | (end-of-line)))) |
| 5240 | (goto-char end) |
| 5241 | (beginning-of-line) |
| 5242 | (delete-region (point) (progn (forward-line 1) (point)))) |
| 5243 | ;; Take care of the case where the ls output contains a |
| 5244 | ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line |
| 5245 | ;; and we went one line too far back (see above). |
| 5246 | (forward-line 1)) |
| 5247 | (if (looking-at "//DIRED-OPTIONS//") |
| 5248 | (delete-region (point) (progn (forward-line 1) (point))))) |
| 5249 | |
| 5250 | ;; Now decode what read if necessary. |
| 5251 | (let ((coding (or coding-system-for-read |
| 5252 | file-name-coding-system |
| 5253 | default-file-name-coding-system |
| 5254 | 'undecided)) |
| 5255 | coding-no-eol |
| 5256 | val pos) |
| 5257 | (when (and enable-multibyte-characters |
| 5258 | (not (memq (coding-system-base coding) |
| 5259 | '(raw-text no-conversion)))) |
| 5260 | ;; If no coding system is specified or detection is |
| 5261 | ;; requested, detect the coding. |
| 5262 | (if (eq (coding-system-base coding) 'undecided) |
| 5263 | (setq coding (detect-coding-region beg (point) t))) |
| 5264 | (if (not (eq (coding-system-base coding) 'undecided)) |
| 5265 | (save-restriction |
| 5266 | (setq coding-no-eol |
| 5267 | (coding-system-change-eol-conversion coding 'unix)) |
| 5268 | (narrow-to-region beg (point)) |
| 5269 | (goto-char (point-min)) |
| 5270 | (while (not (eobp)) |
| 5271 | (setq pos (point) |
| 5272 | val (get-text-property (point) 'dired-filename)) |
| 5273 | (goto-char (next-single-property-change |
| 5274 | (point) 'dired-filename nil (point-max))) |
| 5275 | ;; Force no eol conversion on a file name, so |
| 5276 | ;; that CR is preserved. |
| 5277 | (decode-coding-region pos (point) |
| 5278 | (if val coding-no-eol coding)) |
| 5279 | (if val |
| 5280 | (put-text-property pos (point) |
| 5281 | 'dired-filename t))))))) |
| 5282 | |
| 5283 | (if full-directory-p |
| 5284 | ;; Try to insert the amount of free space. |
| 5285 | (save-excursion |
| 5286 | (goto-char beg) |
| 5287 | ;; First find the line to put it on. |
| 5288 | (when (re-search-forward "^ *\\(total\\)" nil t) |
| 5289 | (let ((available (get-free-disk-space "."))) |
| 5290 | (when available |
| 5291 | ;; Replace "total" with "used", to avoid confusion. |
| 5292 | (replace-match "total used in directory" nil nil nil 1) |
| 5293 | (end-of-line) |
| 5294 | (insert " available " available))))))))))) |
| 5295 | |
| 5296 | (defun insert-directory-adj-pos (pos error-lines) |
| 5297 | "Convert `ls --dired' file name position value POS to a buffer position. |
| 5298 | File name position values returned in ls --dired output |
| 5299 | count only stdout; they don't count the error messages sent to stderr. |
| 5300 | So this function converts to them to real buffer positions. |
| 5301 | ERROR-LINES is a list of buffer positions of error message lines, |
| 5302 | of the form (START END)." |
| 5303 | (while (and error-lines (< (caar error-lines) pos)) |
| 5304 | (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines))))) |
| 5305 | (pop error-lines)) |
| 5306 | pos) |
| 5307 | |
| 5308 | (defun insert-directory-safely (file switches |
| 5309 | &optional wildcard full-directory-p) |
| 5310 | "Insert directory listing for FILE, formatted according to SWITCHES. |
| 5311 | |
| 5312 | Like `insert-directory', but if FILE does not exist, it inserts a |
| 5313 | message to that effect instead of signaling an error." |
| 5314 | (if (file-exists-p file) |
| 5315 | (insert-directory file switches wildcard full-directory-p) |
| 5316 | ;; Simulate the message printed by `ls'. |
| 5317 | (insert (format "%s: No such file or directory\n" file)))) |
| 5318 | |
| 5319 | (defvar kill-emacs-query-functions nil |
| 5320 | "Functions to call with no arguments to query about killing Emacs. |
| 5321 | If any of these functions returns nil, killing Emacs is cancelled. |
| 5322 | `save-buffers-kill-emacs' calls these functions, but `kill-emacs', |
| 5323 | the low level primitive, does not. See also `kill-emacs-hook'.") |
| 5324 | |
| 5325 | (defcustom confirm-kill-emacs nil |
| 5326 | "How to ask for confirmation when leaving Emacs. |
| 5327 | If nil, the default, don't ask at all. If the value is non-nil, it should |
| 5328 | be a predicate function such as `yes-or-no-p'." |
| 5329 | :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p) |
| 5330 | (const :tag "Ask with y-or-n-p" y-or-n-p) |
| 5331 | (const :tag "Don't confirm" nil)) |
| 5332 | :group 'convenience |
| 5333 | :version "21.1") |
| 5334 | |
| 5335 | (defun save-buffers-kill-emacs (&optional arg) |
| 5336 | "Offer to save each buffer, then kill this Emacs process. |
| 5337 | With prefix arg, silently save all file-visiting buffers, then kill." |
| 5338 | (interactive "P") |
| 5339 | (save-some-buffers arg t) |
| 5340 | (and (or (not (memq t (mapcar (function |
| 5341 | (lambda (buf) (and (buffer-file-name buf) |
| 5342 | (buffer-modified-p buf)))) |
| 5343 | (buffer-list)))) |
| 5344 | (yes-or-no-p "Modified buffers exist; exit anyway? ")) |
| 5345 | (or (not (fboundp 'process-list)) |
| 5346 | ;; process-list is not defined on VMS. |
| 5347 | (let ((processes (process-list)) |
| 5348 | active) |
| 5349 | (while processes |
| 5350 | (and (memq (process-status (car processes)) '(run stop open listen)) |
| 5351 | (process-query-on-exit-flag (car processes)) |
| 5352 | (setq active t)) |
| 5353 | (setq processes (cdr processes))) |
| 5354 | (or (not active) |
| 5355 | (list-processes t) |
| 5356 | (yes-or-no-p "Active processes exist; kill them and exit anyway? ")))) |
| 5357 | ;; Query the user for other things, perhaps. |
| 5358 | (run-hook-with-args-until-failure 'kill-emacs-query-functions) |
| 5359 | (or (null confirm-kill-emacs) |
| 5360 | (funcall confirm-kill-emacs "Really exit Emacs? ")) |
| 5361 | (kill-emacs))) |
| 5362 | |
| 5363 | (defun save-buffers-kill-terminal (&optional arg) |
| 5364 | "Offer to save each buffer, then kill the current connection. |
| 5365 | If the current frame has no client, kill Emacs itself. |
| 5366 | |
| 5367 | With prefix arg, silently save all file-visiting buffers, then kill. |
| 5368 | |
| 5369 | If emacsclient was started with a list of filenames to edit, then |
| 5370 | only these files will be asked to be saved." |
| 5371 | (interactive "P") |
| 5372 | (let ((proc (frame-parameter (selected-frame) 'client)) |
| 5373 | (frame (selected-frame))) |
| 5374 | (if (null proc) |
| 5375 | (save-buffers-kill-emacs) |
| 5376 | (server-save-buffers-kill-terminal proc arg)))) |
| 5377 | |
| 5378 | \f |
| 5379 | ;; We use /: as a prefix to "quote" a file name |
| 5380 | ;; so that magic file name handlers will not apply to it. |
| 5381 | |
| 5382 | (setq file-name-handler-alist |
| 5383 | (cons '("\\`/:" . file-name-non-special) |
| 5384 | file-name-handler-alist)) |
| 5385 | |
| 5386 | ;; We depend on being the last handler on the list, |
| 5387 | ;; so that anything else which does need handling |
| 5388 | ;; has been handled already. |
| 5389 | ;; So it is safe for us to inhibit *all* magic file name handlers. |
| 5390 | |
| 5391 | (defun file-name-non-special (operation &rest arguments) |
| 5392 | (let ((file-name-handler-alist nil) |
| 5393 | (default-directory |
| 5394 | (if (eq operation 'insert-directory) |
| 5395 | (directory-file-name |
| 5396 | (expand-file-name |
| 5397 | (unhandled-file-name-directory default-directory))) |
| 5398 | default-directory)) |
| 5399 | ;; Get a list of the indices of the args which are file names. |
| 5400 | (file-arg-indices |
| 5401 | (cdr (or (assq operation |
| 5402 | ;; The first six are special because they |
| 5403 | ;; return a file name. We want to include the /: |
| 5404 | ;; in the return value. |
| 5405 | ;; So just avoid stripping it in the first place. |
| 5406 | '((expand-file-name . nil) |
| 5407 | (file-name-directory . nil) |
| 5408 | (file-name-as-directory . nil) |
| 5409 | (directory-file-name . nil) |
| 5410 | (file-name-sans-versions . nil) |
| 5411 | (find-backup-file-name . nil) |
| 5412 | ;; `identity' means just return the first arg |
| 5413 | ;; not stripped of its quoting. |
| 5414 | (substitute-in-file-name identity) |
| 5415 | ;; `add' means add "/:" to the result. |
| 5416 | (file-truename add 0) |
| 5417 | ;; `quote' means add "/:" to buffer-file-name. |
| 5418 | (insert-file-contents quote 0) |
| 5419 | ;; `unquote-then-quote' means set buffer-file-name |
| 5420 | ;; temporarily to unquoted filename. |
| 5421 | (verify-visited-file-modtime unquote-then-quote) |
| 5422 | ;; List the arguments which are filenames. |
| 5423 | (file-name-completion 1) |
| 5424 | (file-name-all-completions 1) |
| 5425 | (write-region 2 5) |
| 5426 | (rename-file 0 1) |
| 5427 | (copy-file 0 1) |
| 5428 | (make-symbolic-link 0 1) |
| 5429 | (add-name-to-file 0 1))) |
| 5430 | ;; For all other operations, treat the first argument only |
| 5431 | ;; as the file name. |
| 5432 | '(nil 0)))) |
| 5433 | method |
| 5434 | ;; Copy ARGUMENTS so we can replace elements in it. |
| 5435 | (arguments (copy-sequence arguments))) |
| 5436 | (if (symbolp (car file-arg-indices)) |
| 5437 | (setq method (pop file-arg-indices))) |
| 5438 | ;; Strip off the /: from the file names that have it. |
| 5439 | (save-match-data |
| 5440 | (while (consp file-arg-indices) |
| 5441 | (let ((pair (nthcdr (car file-arg-indices) arguments))) |
| 5442 | (and (car pair) |
| 5443 | (string-match "\\`/:" (car pair)) |
| 5444 | (setcar pair |
| 5445 | (if (= (length (car pair)) 2) |
| 5446 | "/" |
| 5447 | (substring (car pair) 2))))) |
| 5448 | (setq file-arg-indices (cdr file-arg-indices)))) |
| 5449 | (cond ((eq method 'identity) |
| 5450 | (car arguments)) |
| 5451 | ((eq method 'add) |
| 5452 | (concat "/:" (apply operation arguments))) |
| 5453 | ((eq method 'quote) |
| 5454 | (unwind-protect |
| 5455 | (apply operation arguments) |
| 5456 | (setq buffer-file-name (concat "/:" buffer-file-name)))) |
| 5457 | ((eq method 'unquote-then-quote) |
| 5458 | (let (res) |
| 5459 | (setq buffer-file-name (substring buffer-file-name 2)) |
| 5460 | (setq res (apply operation arguments)) |
| 5461 | (setq buffer-file-name (concat "/:" buffer-file-name)) |
| 5462 | res)) |
| 5463 | (t |
| 5464 | (apply operation arguments))))) |
| 5465 | \f |
| 5466 | ;; Symbolic modes and read-file-modes. |
| 5467 | |
| 5468 | (defun file-modes-char-to-who (char) |
| 5469 | "Convert CHAR to a who-mask from a symbolic mode notation. |
| 5470 | CHAR is in [ugoa] and represents the users on which rights are applied." |
| 5471 | (cond ((= char ?u) #o4700) |
| 5472 | ((= char ?g) #o2070) |
| 5473 | ((= char ?o) #o1007) |
| 5474 | ((= char ?a) #o7777) |
| 5475 | (t (error "%c: bad `who' character" char)))) |
| 5476 | |
| 5477 | (defun file-modes-char-to-right (char &optional from) |
| 5478 | "Convert CHAR to a right-mask from a symbolic mode notation. |
| 5479 | CHAR is in [rwxXstugo] and represents a right. |
| 5480 | If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)." |
| 5481 | (or from (setq from 0)) |
| 5482 | (cond ((= char ?r) #o0444) |
| 5483 | ((= char ?w) #o0222) |
| 5484 | ((= char ?x) #o0111) |
| 5485 | ((= char ?s) #o1000) |
| 5486 | ((= char ?t) #o6000) |
| 5487 | ;; Rights relative to the previous file modes. |
| 5488 | ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111)) |
| 5489 | ((= char ?u) (let ((uright (logand #o4700 from))) |
| 5490 | (+ uright (/ uright #o10) (/ uright #o100)))) |
| 5491 | ((= char ?g) (let ((gright (logand #o2070 from))) |
| 5492 | (+ gright (/ gright #o10) (* gright #o10)))) |
| 5493 | ((= char ?o) (let ((oright (logand #o1007 from))) |
| 5494 | (+ oright (* oright #o10) (* oright #o100)))) |
| 5495 | (t (error "%c: bad right character" char)))) |
| 5496 | |
| 5497 | (defun file-modes-rights-to-number (rights who-mask &optional from) |
| 5498 | "Convert a right string to a right-mask from a symbolic modes notation. |
| 5499 | RIGHTS is the right string, it should match \"([+=-][rwxXstugo]+)+\". |
| 5500 | WHO-MASK is the mask number of the users on which the rights are to be applied. |
| 5501 | FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed." |
| 5502 | (let* ((num-rights (or from 0)) |
| 5503 | (list-rights (string-to-list rights)) |
| 5504 | (op (pop list-rights))) |
| 5505 | (while (memq op '(?+ ?- ?=)) |
| 5506 | (let ((num-right 0) |
| 5507 | char-right) |
| 5508 | (while (memq (setq char-right (pop list-rights)) |
| 5509 | '(?r ?w ?x ?X ?s ?t ?u ?g ?o)) |
| 5510 | (setq num-right |
| 5511 | (logior num-right |
| 5512 | (file-modes-char-to-right char-right num-rights)))) |
| 5513 | (setq num-right (logand who-mask num-right) |
| 5514 | num-rights |
| 5515 | (cond ((= op ?+) (logior num-rights num-right)) |
| 5516 | ((= op ?-) (logand num-rights (lognot num-right))) |
| 5517 | (t (logior (logand num-rights (lognot who-mask)) num-right))) |
| 5518 | op char-right))) |
| 5519 | num-rights)) |
| 5520 | |
| 5521 | (defun file-modes-symbolic-to-number (modes &optional from) |
| 5522 | "Convert symbolic file modes to numeric file modes. |
| 5523 | MODES is the string to convert, it should match |
| 5524 | \"[ugoa]*([+-=][rwxXstugo]+)+,...\". |
| 5525 | See (info \"(coreutils)File permissions\") for more information on this |
| 5526 | notation. |
| 5527 | FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed." |
| 5528 | (save-match-data |
| 5529 | (let ((case-fold-search nil) |
| 5530 | (num-modes (or from 0))) |
| 5531 | (while (/= (string-to-char modes) 0) |
| 5532 | (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes) |
| 5533 | (let ((num-who (apply 'logior 0 |
| 5534 | (mapcar 'file-modes-char-to-who |
| 5535 | (match-string 1 modes))))) |
| 5536 | (when (= num-who 0) |
| 5537 | (setq num-who (default-file-modes))) |
| 5538 | (setq num-modes |
| 5539 | (file-modes-rights-to-number (substring modes (match-end 1)) |
| 5540 | num-who num-modes) |
| 5541 | modes (substring modes (match-end 3)))) |
| 5542 | (error "Parse error in modes near `%s'" (substring modes 0)))) |
| 5543 | num-modes))) |
| 5544 | |
| 5545 | (defun read-file-modes (&optional prompt orig-file) |
| 5546 | "Read file modes in octal or symbolic notation. |
| 5547 | PROMPT is used as the prompt, default to `File modes (octal or symbolic): '. |
| 5548 | ORIG-FILE is the original file of which modes will be change." |
| 5549 | (let* ((modes (or (if orig-file (file-modes orig-file) 0) |
| 5550 | (error "File not found"))) |
| 5551 | (value (read-string (or prompt "File modes (octal or symbolic): ")))) |
| 5552 | (save-match-data |
| 5553 | (if (string-match "^[0-7]+" value) |
| 5554 | (string-to-number value 8) |
| 5555 | (file-modes-symbolic-to-number value modes))))) |
| 5556 | |
| 5557 | \f |
| 5558 | (define-key ctl-x-map "\C-f" 'find-file) |
| 5559 | (define-key ctl-x-map "\C-r" 'find-file-read-only) |
| 5560 | (define-key ctl-x-map "\C-v" 'find-alternate-file) |
| 5561 | (define-key ctl-x-map "\C-s" 'save-buffer) |
| 5562 | (define-key ctl-x-map "s" 'save-some-buffers) |
| 5563 | (define-key ctl-x-map "\C-w" 'write-file) |
| 5564 | (define-key ctl-x-map "i" 'insert-file) |
| 5565 | (define-key esc-map "~" 'not-modified) |
| 5566 | (define-key ctl-x-map "\C-d" 'list-directory) |
| 5567 | (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal) |
| 5568 | (define-key ctl-x-map "\C-q" 'toggle-read-only) |
| 5569 | |
| 5570 | (define-key ctl-x-4-map "f" 'find-file-other-window) |
| 5571 | (define-key ctl-x-4-map "r" 'find-file-read-only-other-window) |
| 5572 | (define-key ctl-x-4-map "\C-f" 'find-file-other-window) |
| 5573 | (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window) |
| 5574 | (define-key ctl-x-4-map "\C-o" 'display-buffer) |
| 5575 | |
| 5576 | (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame) |
| 5577 | (define-key ctl-x-5-map "f" 'find-file-other-frame) |
| 5578 | (define-key ctl-x-5-map "\C-f" 'find-file-other-frame) |
| 5579 | (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame) |
| 5580 | (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame) |
| 5581 | |
| 5582 | ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f |
| 5583 | ;;; files.el ends here |