| blob | cf3356014a17e0f3c4cdb21fb98f325685eb70b8 |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2013 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
34 "Backups of edited data files."
38 "Finding files."
43 "Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that the auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
57 FROM is matched against directory names anchored at the first
61 FROM and TO should be equivalent names, which refer to the
62 same directory. Do not use `~' in the TO strings;
63 they should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
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."
142 "Predicate that looks at a file name and decides whether to make backups.
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."
155 "Non-nil means find a file under alternative names, in existing buffers.
156 This means if any existing buffer is visiting the file you want
157 under another name, you get the existing buffer instead of a new buffer."
162 "Non-nil means visit a file under its truename.
163 The truename of a file is found by chasing all links
164 both at the file level and at the levels of the containing directories."
170 "Specify which files should be reverted without query.
171 The value is a list of regular expressions.
172 If the file name matches one of these regular expressions,
173 then `revert-buffer' reverts the file without querying
174 if the file has changed on disk and you have not edited the buffer."
179 "The device number and file number of the file visited in the current buffer.
180 The value is a list of the form (FILENUM DEVNUM).
181 This pair of numbers uniquely identifies the file.
195 "The directory for writing small temporary files.
196 If non-nil, this directory is used instead of `temporary-file-directory'
197 by programs that create small temporary files. This is for systems that
198 have fast storage with limited space, such as a RAM disk."
203 ;; The system null device. (Should reference NULL_DEVICE from C.)
230 "Non-nil means protect against I/O errors while saving files.
231 Some modes set this non-nil in particular buffers.
233 This feature works by writing the new contents into a temporary file
234 and then renaming the temporary file to replace the original.
235 In this way, any I/O error in writing leaves the original untouched,
236 and there is never any instant where the file is nonexistent.
238 Note that this feature forces backups to be made by copying.
239 Yet, at the same time, saving a precious file
240 breaks any hard links between it and other files.
242 This feature is advisory: for example, if the directory in which the
243 file is being saved is not writable, Emacs may ignore a non-nil value
244 of `file-precious-flag' and write directly into the file.
246 See also: `break-hardlink-on-save'."
251 "Non-nil means when saving a file that exists under several names
252 \(i.e., has multiple hardlinks), break the hardlink associated with
253 `buffer-file-name' and write to a new file, so that the other
254 instances of the file are not affected by the save.
256 If `buffer-file-name' refers to a symlink, do not break the symlink.
258 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
259 For example, if the directory in which a file is being saved is not
260 itself writable, then error instead of saving in some
261 hardlink-nonbreaking way.
263 See also `backup-by-copying' and `backup-by-copying-when-linked'."
269 "Control use of version numbers for backup files.
270 When t, make numeric backup versions unconditionally.
271 When nil, make them for files that have some already.
272 The value `never' means do not make them."
282 "When cleaning directory, number of versions to keep."
288 "If t, delete excess backup versions silently.
289 If nil, ask confirmation. Any other value prevents any trimming."
296 "Number of oldest versions to keep when a new numbered backup is made."
302 "Number of newest versions to keep when a new numbered backup is made.
303 Includes the new backup. Must be > 0"
309 "Whether to add a newline automatically at the end of the file.
311 A value of t means do this only when the file is about to be saved.
312 A value of `visit' means do this right after the file is visited.
313 A value of `visit-save' means do it at both of those times.
314 Any other non-nil value means ask user whether to add a newline, when saving.
315 A value of nil means don't add newlines.
317 Certain major modes set this locally to the value obtained
318 from `mode-require-final-newline'."
328 "Whether to add a newline at end of file, in certain major modes.
329 Those modes set `require-final-newline' to this value when you enable them.
330 They do so because they are often used for files that are supposed
331 to end in newlines, and the question is how to arrange that.
333 A value of t means do this only when the file is about to be saved.
334 A value of `visit' means do this right after the file is visited.
335 A value of `visit-save' means do it at both of those times.
336 Any other non-nil value means ask user whether to add a newline, when saving.
338 A value of nil means do not add newlines. That is a risky choice in this
339 variable since this value is used for modes for files that ought to have
340 final newlines. So if you set this to nil, you must explicitly check and
341 add a final newline, whenever you save a file that really needs one."
351 "Non-nil says by default do auto-saving of every file-visiting buffer."
357 ;; Don't put "\\2" inside expand-file-name, since it will be
358 ;; transformed to "/2" on DOS/Windows.
360 "Transforms to apply to buffer file name before making auto-save file name.
361 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
362 REGEXP is a regular expression to match against the file name.
363 If it matches, `replace-match' is used to replace the
364 matching part with REPLACEMENT.
365 If the optional element UNIQUIFY is non-nil, the auto-save file name is
366 constructed by taking the directory part of the replaced file-name,
367 concatenated with the buffer file name with all directory separators
368 changed to `!' to prevent clashes. This will not work
369 correctly if your filesystem truncates the resulting name.
371 All the transforms in the list are tried, in the order they are listed.
372 When one transform applies, its result is final;
373 no further transforms are tried.
375 The default value is set up to put the auto-save file into the
376 temporary directory (see the variable `temporary-file-directory') for
377 editing a remote file.
379 On MS-DOS filesystems without long names this variable is always
380 ignored."
388 "Non-nil means save word abbrevs too when files are saved.
389 If `silently', don't ask the user before saving."
394 "Non-nil means allow `find-file' to visit directories.
395 To visit the directory, `find-file' runs `find-directory-functions'."
400 "List of functions to try in sequence to visit a directory.
401 Each function is called with the directory name as the sole argument
402 and should return either a buffer or nil."
406 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
408 "List of functions to try in sequence to get a file name at point.
409 Each function should return either nil or a file name found at the
410 location of point in the current buffer."
414 ;;;It is not useful to make this a local variable.
415 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
419 "List of functions to be called for `find-file' on nonexistent file.
420 These functions are called as soon as the error is detected.
421 Variable `buffer-file-name' is already set up.
424 ;;;It is not useful to make this a local variable.
425 ;;;(put 'find-file-hooks 'permanent-local t)
428 "List of functions to be called after a buffer is loaded from a file.
429 The buffer's local variables (if any) will have been processed before the
430 functions are called."
438 "List of functions to be called before writing out a buffer to a file.
439 If one of them returns non-nil, the file is considered already written
440 and the rest are not called.
441 These hooks are considered to pertain to the visited file.
442 So any buffer-local binding of this variable is discarded if you change
444 change the major mode.
446 This hook is not run if any of the functions in
447 `write-contents-functions' returns non-nil. Both hooks pertain
448 to how to save a buffer to file, for instance, choosing a suitable
449 coding system and setting mode bits. (See Info
450 node `(elisp)Saving Buffers'.) To perform various checks or
462 "List of functions to be called before writing out a buffer to a file.
463 If one of them returns non-nil, the file is considered already written
464 and the rest are not called and neither are the functions in
465 `write-file-functions'.
467 This variable is meant to be used for hooks that pertain to the
468 buffer's contents, not to the particular visited file; thus,
469 `set-visited-file-name' does not clear this variable; but changing the
470 major mode does clear it.
472 For hooks that _do_ pertain to the particular visited file, use
473 `write-file-functions'. Both this variable and
474 `write-file-functions' relate to how a buffer is saved to file.
475 To perform various checks or updates before the buffer is saved,
480 "Control use of local variables in files you visit.
481 The value can be t, nil, :safe, :all, or something else.
483 A value of t means file local variables specifications are obeyed
484 if all the specified variable values are safe; if any values are
485 not safe, Emacs queries you, once, whether to set them all.
486 \(When you say yes to certain values, they are remembered as safe.)
488 :safe means set the safe variables, and ignore the rest.
489 :all means set all variables, whether safe or not.
490 (Don't set it permanently to :all.)
491 A value of nil means always ignore the file local variables.
493 Any other value means always query you once whether to set them all.
494 \(When you say yes to certain values, they are remembered as safe, but
497 This variable also controls use of major modes specified in
498 a -*- line.
501 always obeys file local variable specifications and the -*- line,
502 and ignores this variable."
503 :risky t
512 "Non-nil means enable use of directory-local variables.
513 Some modes may wish to set this to nil to prevent directory-local
516 ;; This is an odd variable IMO.
517 ;; You might wonder why it is needed, when we could just do:
518 ;; (set (make-local-variable 'enable-local-variables) nil)
519 ;; These two are not precisely the same.
520 ;; Setting this variable does not cause -*- mode settings to be
521 ;; ignored, whereas setting enable-local-variables does.
522 ;; Only three places in Emacs use this variable: tar and arc modes,
523 ;; and rmail. The first two don't need it. They already use
524 ;; inhibit-local-variables-regexps, which is probably enough, and
525 ;; could also just set enable-local-variables locally to nil.
526 ;; Them setting it has the side-effect that dir-locals cannot apply to
527 ;; eg tar files (?). FIXME Is this appropriate?
528 ;; AFAICS, rmail is the only thing that needs this, and the only
529 ;; reason it uses it is for BABYL files (which are obsolete).
530 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
531 ;; to respect, so that find-file on a BABYL file will switch to
532 ;; rmail-mode automatically (this is nice, but hardly essential,
533 ;; since most people are used to explicitly running a command to
534 ;; access their mail; M-x gnus etc). Rmail files may happen to
535 ;; contain Local Variables sections in messages, which Rmail wants to
536 ;; ignore. So AFAICS the only reason this variable exists is for a
537 ;; minor convenience feature for handling of an obsolete Rmail file format.
539 "Like `enable-local-variables' but meant for buffer-local bindings.
540 The meaningful values are nil and non-nil. The default is non-nil.
541 If a major mode sets this to nil, buffer-locally, then any local
542 variables list in a file visited in that mode will be ignored.
544 This variable does not affect the use of major modes specified
549 The value can be t, nil or something else.
550 A value of t means obey `eval' variables.
551 A value of nil means ignore them; anything else means query."
552 :risky t
558 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
567 "Non-nil means buffers visiting files read-only do so in view mode.
568 In fact, this means that all read-only buffers normally have
569 View mode enabled, including buffers that are read-only because
570 you visit a file you cannot alter, and buffers you make read-only
576 "History list of file names entered in the minibuffer.
578 Maximum length of the history list is determined by the value
580 \f
583 "Provides support for ange-ftp host name completion.
584 Runs the usual ange-ftp hook, but only for completion operations."
585 ;; Having this here avoids the need to load ange-ftp when it's not
586 ;; really in use.
592 inhibit-file-name-handlers)))
600 "Convert a standard file's name to something suitable for the OS.
601 This means to guarantee valid names and perhaps to canonicalize
602 certain patterns.
604 FILENAME should be an absolute file name since the conversion rules
605 sometimes vary depending on the position in the file name. E.g. c:/foo
606 is a valid DOS file name, but c:/bar/c:/foo is not.
608 This function's standard definition is trivial; it just returns
609 the argument. However, on Windows and DOS, replace invalid
610 characters. On DOS, make sure to obey the 8.3 limitations.
611 In the native Windows build, turn Cygwin names into native names,
612 and also turn slashes into backslashes if the shell requires it (see
613 `w32-shell-dos-semantics').
615 See Info node `(elisp)Standard File Names' for more details."
620 ;; Replace invalid filename characters with !
624 name))
632 "Read directory name, prompting with PROMPT and completing in directory DIR.
633 Value is not expanded---you must call `expand-file-name' yourself.
634 Default name to DEFAULT-DIRNAME if user exits with the same
635 non-empty string that was inserted by this function.
636 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
637 or just DIR if INITIAL is nil.)
638 If the user exits with an empty minibuffer, this function returns
639 an empty string. (This can only happen if the user erased the
640 pre-inserted contents or if `insert-default-directory' is nil.)
641 Fourth arg MUSTMATCH non-nil means require existing directory's name.
642 Non-nil and non-t means also require confirmation after completion.
643 Fifth arg INITIAL specifies text to start with.
644 DIR should be an absolute directory name. It defaults to
645 the value of `default-directory'."
650 dir))
651 mustmatch initial
654 \f
656 "Show the current default directory."
661 "Value of the CDPATH environment variable, as a list.
665 "Explode a search path into a list of directory names.
666 Directories are separated by `path-separator' (which is colon in
667 GNU and Unix systems). Substitute environment variables into the
668 resulting list of directory names. For an empty path element (i.e.,
669 a leading or trailing separator, or two adjacent separators), return
670 nil (meaning `default-directory') as the associated list element."
678 "Change current directory to given absolute file name DIR."
679 ;; Put the name into directory syntax now,
680 ;; because otherwise expand-file-name may give some bad results.
682 ;; We used to additionally call abbreviate-file-name here, for an
683 ;; unknown reason. Problem is that most buffers are setup
684 ;; without going through cd-absolute and don't call
685 ;; abbreviate-file-name on their default-directory, so the few that
686 ;; do end up using a superficially different directory.
698 "Make DIR become the current buffer's default directory.
699 If your environment includes a `CDPATH' variable, try each one of
700 that list of directories (separated by occurrences of
701 `path-separator') when resolving a relative directory name.
702 The path separator is colon in GNU and GNU-like systems."
705 ;; FIXME: There's a subtle bug in the completion below. Seems linked
706 ;; to a fundamental difficulty of implementing `predicate' correctly.
707 ;; The manifestation is that TAB may list non-directories in the case where
708 ;; those files also correspond to valid directories (if your cd-path is (A/
709 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
710 ;; will be listed as valid completions).
711 ;; This is because `a' (listed because of A/a) is indeed a valid choice
712 ;; (which will lead to the use of B/a).
717 cd-path nil))
726 default-directory default-directory
727 t))))
737 "Load the Lisp file named FILE."
738 ;; This is a case where .elc makes a lot of sense.
745 "Search for FILENAME through PATH.
746 If found, return the absolute file name of FILENAME, with its suffixes;
747 otherwise return nil.
748 PATH should be a list of directories to look in, like the lists in
749 `exec-path' or `load-path'.
750 If SUFFIXES is non-nil, it should be a list of suffixes to append to
753 If non-nil, PREDICATE is used instead of `file-readable-p'.
755 This function will normally skip directories, so if you want it to find
756 directories, make sure the PREDICATE function returns `dir-ok' for them.
758 PREDICATE can also be an integer to pass to the `access' system call,
759 in which case file-name handlers are ignored. This usage is deprecated.
760 For compatibility, PREDICATE can also be one of the symbols
761 `executable', `readable', `writable', or `exists', or a list of
762 one or more of those symbols."
773 "Do completion for file names passed to `locate-file'."
776 ;; FIXME: maybe we should use completion-file-name-table instead,
777 ;; tho at least for `load', the arg is passed through
778 ;; substitute-in-file-name for historical reasons.
788 ;; If we have files like "foo.el" and "foo.elc", we could load one of
789 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
790 ;; preferred way. So if we list all 3, that gives a lot of redundant
791 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
792 ;; the user does want to pay attention to the extension. We try to
793 ;; diffuse this tension by stripping the suffix, except when the
794 ;; result is a single element (i.e. usually we only list "foo" unless
795 ;; it's the only remaining element in the list, in which case we do
796 ;; list "foo", "foo.elc" and "foo.el").
807 string-file dir))
812 ;; Switching from names to names+fullnames creates a non-monotonicity
813 ;; which can cause problems with things like partial-completion.
814 ;; To minimize the problem, filter out completion-regexp-list, so that
815 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
816 ;; from `names' which only matched `string' when they still had
817 ;; their suffix.
819 ;; Remove duplicates of the first element, so that we can easily check
820 ;; if `names' really only contains a single element.
823 ;; There's no more than one matching non-suffixed element, so expand
824 ;; the list by adding the suffixed elements as well.
827 string-dir names string-file pred action)))))
830 "Do completion for file names passed to `locate-file'.
831 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
835 string nil action))
839 "Regexp of directory names which stop the search in `locate-dominating-file'.
840 Any directory whose name matches this regexp will be treated like
841 a kind of root directory by `locate-dominating-file' which will stop its search
842 when it bumps into it.
843 The default regexp prevents fruitless and time-consuming attempts to find
844 special files in directories in which filenames are interpreted as hostnames,
847 ;; (defun locate-dominating-files (file regexp)
848 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
849 ;; Stop at the first parent where a matching file is found and return the list
850 ;; of files that that match in this directory."
851 ;; (catch 'found
852 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
853 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
854 ;; (let ((user nil)
855 ;; ;; Abbreviate, so as to stop when we cross ~/.
856 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
857 ;; files)
858 ;; (while (and dir
859 ;; ;; As a heuristic, we stop looking up the hierarchy of
860 ;; ;; directories as soon as we find a directory belonging to
861 ;; ;; another user. This should save us from looking in
862 ;; ;; things like /net and /afs. This assumes that all the
863 ;; ;; files inside a project belong to the same user.
864 ;; (let ((prev-user user))
865 ;; (setq user (nth 2 (file-attributes dir)))
866 ;; (or (null prev-user) (equal user prev-user))))
867 ;; (if (setq files (condition-case nil
868 ;; (directory-files dir 'full regexp 'nosort)
869 ;; (error nil)))
870 ;; (throw 'found files)
871 ;; (if (equal dir
872 ;; (setq dir (file-name-directory
873 ;; (directory-file-name dir))))
874 ;; (setq dir nil))))
875 ;; nil)))
878 "Look up the directory hierarchy from FILE for a directory containing NAME.
879 Stop at the first parent directory containing a file NAME,
880 and return the directory. Return nil if not found.
881 Instead of a string, NAME can also be a predicate taking one argument
882 \(a directory) and returning a non-nil value if that directory is the one for
883 which we're looking."
884 ;; We used to use the above locate-dominating-files code, but the
885 ;; directory-files call is very costly, so we're much better off doing
886 ;; multiple calls using the code in here.
887 ;;
888 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
889 ;; `name' in /home or in /.
892 ;; `user' is not initialized outside the loop because
893 ;; `file' may not exist, so we may have to walk up part of the
894 ;; hierarchy before we find the "initial UID". Note: currently unused
895 ;; (user nil)
896 try)
899 ;; FIXME: Disabled this heuristic because it is sometimes
900 ;; inappropriate.
901 ;; As a heuristic, we stop looking up the hierarchy of
902 ;; directories as soon as we find a directory belonging
903 ;; to another user. This should save us from looking in
904 ;; things like /net and /afs. This assumes that all the
905 ;; files inside a project belong to the same user.
906 ;; (let ((prev-user user))
907 ;; (setq user (nth 2 (file-attributes file)))
908 ;; (and prev-user (not (equal user prev-user))))
921 "Search for COMMAND in `exec-path' and return the absolute file name.
922 Return nil if COMMAND is not found anywhere in `exec-path'."
923 ;; Use 1 rather than file-executable-p to better match the behavior of
924 ;; call-process.
928 "Load the Emacs Lisp library named LIBRARY.
929 This is an interface to the function `load'. LIBRARY is searched
930 for in `load-path', both with and without `load-suffixes' (as
931 well as `load-file-rep-suffixes').
933 See Info node `(emacs)Lisp Libraries' for more details.
934 See `load-file' for a different interface to `load'."
938 load-path
943 "Test whether FILE specifies a location on a remote system.
944 A file is considered remote if accessing it is likely to
945 be slower or less reliable than accessing local files.
947 `file-remote-p' never opens a new remote connection. It can
948 only reuse a connection that is already open.
950 Return nil or a string identifying the remote connection
951 \(ideally a prefix of FILE). Return nil if FILE is a relative
952 file name.
954 When IDENTIFICATION is nil, the returned string is a complete
955 remote identifier: with components method, user, and host. The
956 components are those present in FILE, with defaults filled in for
957 any that are missing.
959 IDENTIFICATION can specify which part of the identification to
960 return. IDENTIFICATION can be the symbol `method', `user',
961 `host', or `localname'. Any other value is handled like nil and
962 means to return the complete identification. The string returned
963 for IDENTIFICATION `localname' can differ depending on whether
964 there is an existing connection.
966 If CONNECTED is non-nil, return an identification only if FILE is
967 located on a remote system and a connection is established to
968 that remote system.
970 Tip: You can use this expansion of remote identifier components
971 to derive a new remote file name from an existing one. For
977 same remote identifier as FILE but expanded; a name such as
982 nil)))
984 ;; Probably this entire variable should be obsolete now, in favor of
985 ;; something Tramp-related (?). It is not used in many places.
986 ;; It's not clear what the best file for this to be in is, but given
987 ;; it uses custom-initialize-delay, it is easier if it is preloaded
988 ;; rather than autoloaded.
990 ;; This used to try various hard-coded places for remsh, rsh, and
991 ;; rcmd, trying to guess based on location whether "rsh" was
992 ;; "restricted shell" or "remote shell", but I don't see the point
993 ;; in this day and age. Almost everyone will use ssh, and have
994 ;; whatever command they want to use in PATH.
1001 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1008 "Whether to use the remote file-name cache for read access.
1009 When `nil', never expire cached values (caution)
1010 When `t', never use the cache (safe, but may be slow)
1011 A number means use cached values for that amount of seconds since caching.
1013 The attributes of remote files are cached for better performance.
1014 If they are changed outside of Emacs's control, the cached values
1015 become invalid, and must be reread. If you are sure that nothing
1016 other than Emacs changes the files, you can set this variable to `nil'.
1018 If a remote file is checked regularly, it might be a good idea to
1019 let-bind this variable to a value less than the interval between
1020 consecutive checks. For example:
1022 (defun display-time-file-nonempty-p (file)
1023 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1024 (and (file-exists-p file)
1025 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1036 "Copy the file FILE into a temporary file on this machine.
1037 Returns the name of the local copy, or nil, if FILE is directly
1038 accessible."
1039 ;; This formerly had an optional BUFFER argument that wasn't used by
1040 ;; anything.
1044 nil)))
1047 "Return the truename of FILENAME.
1048 If FILENAME is not absolute, first expands it against `default-directory'.
1049 The truename of a file name is found by chasing symbolic links
1050 both at the level of the file and at the level of the directories
1051 containing it, until no links are left at any level.
1054 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1055 ;; COUNTER can be a cons cell whose car is the count of how many
1056 ;; more links to chase before getting an error.
1057 ;; PREV-DIRS can be a cons cell whose car is an alist
1058 ;; of truenames we've just recently computed.
1072 ;; For speed, remove the ange-ftp completion handler from the list.
1073 ;; We know it's not needed here.
1074 ;; For even more speed, do this only on the outermost call.
1081 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1082 ;; case differences being ignored by the OS, and short "8.3 DOS"
1083 ;; name aliases existing for all files. (The short names are not
1084 ;; reported by directory-files, but can be used to refer to files.)
1085 ;; It seems appropriate for file-truename to resolve these issues in
1086 ;; the most natural way, which on Windows is to call the function
1087 ;; `w32-long-file-name' - this returns the exact name of a file as
1088 ;; it is stored on disk (expanding short name aliases with the full
1089 ;; name in the process).
1092 ;; If filename exists, use its long name. If it doesn't
1093 ;; exist, the recursion below on the directory of filename
1094 ;; will drill down until we find a directory that exists,
1095 ;; and use the long name of that, with the extra
1096 ;; non-existent path components concatenated.
1101 ;; If this file directly leads to a link, process that iteratively
1102 ;; so that we don't use lots of stack.
1108 ;; For file name that has a special handler, call handler.
1109 ;; This is so that ange-ftp can save time by doing a no-op.
1112 done t)
1114 target dirfile)
1115 ;; Get the truename of the directory.
1117 ;; If these are equal, we have the (or a) root directory.
1121 ;; If this is the same dir we last got the truename for,
1122 ;; save time--don't recalculate.
1132 done t)
1135 done t)
1136 ;; Put it back on the file name.
1138 ;; Is the file name the name of a link?
1141 ;; Yes => chase that link, then start all over
1142 ;; since the link may point to a directory name that uses links.
1143 ;; We can't safely use expand-file-name here
1144 ;; since target might look like foo/../bar where foo
1145 ;; is itself a link. Instead, we handle . and .. above.
1148 target
1150 done nil)
1151 ;; No, we are done!
1153 filename))
1156 "Chase links in FILENAME until a name that is not a link.
1157 Unlike `file-truename', this does not check whether a parent
1158 directory name is a symbolic link.
1159 If the optional argument LIMIT is a number,
1160 it means chase no more than that many links and then stop."
1168 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1171 ;; Handle `..' by hand, since it needs to work in the
1172 ;; target of any directory symlink.
1173 ;; This code is not quite complete; it does not handle
1174 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1178 ;; Chase links in the default dir of the symlink.
1182 ;; Now find the parent of that dir.
1186 newname))
1188 ;; A handy function to display file sizes in human-readable form.
1189 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1191 "Produce a string showing FILE-SIZE in human-readable form.
1193 Optional second argument FLAVOR controls the units and the display format:
1195 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1197 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1199 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1202 1024.0
1205 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1211 "%.1f%s%s"
1213 file-size
1215 "K"
1220 "Create a temporary file.
1221 The returned file name (created by appending some random characters at the end
1222 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1223 is guaranteed to point to a newly created empty file.
1224 You can then use `write-region' to write new data into the file.
1226 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1228 If SUFFIX is non-nil, add that at the end of the file name."
1230 file)
1233 ;; Create temp files with strict access rights. It's easy to
1234 ;; loosen them later, whereas it's impossible to close the
1235 ;; time-window of loose permissions otherwise.
1243 temporary-file-directory)
1245 temporary-file-directory))))
1251 nil)
1253 ;; the file was somehow created by someone else between
1254 ;; `make-temp-name' and `write-region', let's try again.
1255 nil)
1256 file)
1257 ;; Reset the umask.
1261 "Change the encoding of FILE's name from CODING to NEW-CODING.
1262 The value is a new name of FILE.
1263 Signals a `file-already-exists' error if a file of the new name
1264 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1265 is non-nil. A number as fourth arg means request confirmation if
1266 the new name already exists. This is what happens in interactive
1267 use with M-x."
1270 default-file-name-coding-system))
1272 from-coding to-coding)
1274 ;; We provide the default coding only when it seems that
1275 ;; the filename is correctly decoded by the default
1276 ;; coding.
1282 filename default-coding)
1283 default-coding))
1287 ;; We provide the default coding only when a user is going to
1288 ;; change the encoding not from the default coding.
1292 filename from-coding)))
1295 filename from-coding default-coding)
1296 default-coding)))
1300 default-file-name-coding-system))
1301 ;; FILE should have been decoded by DEFAULT-CODING.
1305 ;; Suppress further encoding.
1310 newname))
1311 \f
1313 "Whether confirmation is requested before visiting a new file or buffer.
1314 If nil, confirmation is not requested.
1315 If the value is `after-completion', confirmation is only
1316 requested if the user called `minibuffer-complete' right before
1317 `minibuffer-complete-and-exit'.
1318 Any other non-nil value means to request confirmation.
1320 This affects commands like `switch-to-buffer' and `find-file'."
1328 "Whether to request confirmation before visiting a new file or buffer.
1329 The variable `confirm-nonexistent-file-or-buffer' determines the
1330 return value, which may be passed as the REQUIRE-MATCH arg to
1331 `read-buffer' or `find-file-read-args'."
1339 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1340 BODY should use the minibuffer at most once.
1341 Recursive uses of the minibuffer are unaffected (FUN is not
1342 called additional times).
1344 This macro actually adds an auxiliary function that calls FUN,
1345 rather than FUN itself, to `minibuffer-setup-hook'."
1351 ;; Clear out this hook so it does not interfere
1352 ;; with any recursive minibuffer usage.
1363 t))
1366 "Edit file FILENAME.
1367 Switch to a buffer visiting file FILENAME,
1368 creating one if none already exists.
1369 Interactively, the default if you just type RET is the current directory,
1370 but the visited file name is available through the minibuffer history:
1371 type M-n to pull it into the minibuffer.
1373 You can visit files on remote machines by specifying something
1374 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1375 also visit local files as a different user by specifying
1376 /sudo::FILE for the file name.
1377 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1378 manual, for more about this.
1380 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1381 expand wildcards (if any) and visit multiple files. You can
1382 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1384 To visit a file without any kind of conversion and without
1395 "Edit file FILENAME, in another window.
1398 an existing one. See the function `display-buffer'.
1400 Interactively, the default if you just type RET is the current directory,
1401 but the visited file name is available through the minibuffer history:
1402 type M-n to pull it into the minibuffer.
1404 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1405 expand wildcards (if any) and visit multiple files."
1418 "Edit file FILENAME, in another frame.
1421 an existing one. See the function `display-buffer'.
1423 Interactively, the default if you just type RET is the current directory,
1424 but the visited file name is available through the minibuffer history:
1425 type M-n to pull it into the minibuffer.
1427 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1428 expand wildcards (if any) and visit multiple files."
1441 "Edit the existing file FILENAME.
1443 file names with wildcards."
1460 value))
1463 "Edit file FILENAME but don't allow changes.
1472 "Edit file FILENAME in another window but don't allow changes.
1481 "Edit file FILENAME in another frame but don't allow changes.
1490 "Find file FILENAME as a replacement for the file in the next window.
1491 This command does not select that window.
1495 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1496 expand wildcards (if any) and replace the file with multiple files."
1507 "Find alternate file: " file-dir nil
1509 t))))
1516 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1518 "Hook run when a buffer is killed.
1519 The buffer being killed is current while the hook is running.
1520 See `kill-buffer'.
1522 Note: Be careful with let-binding this hook considering it is
1526 "Find file FILENAME, select its buffer, kill previous buffer.
1527 If the current buffer now contains an empty file that you just visited
1528 \(presumably by mistake), use this command to visit the file you really want.
1532 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1533 expand wildcards (if any) and replace the file with multiple files.
1535 If the current buffer is an indirect buffer, or the base buffer
1536 for one or more indirect buffers, the other buffer(s) are not
1537 killed."
1546 "Find alternate file: " file-dir nil
1548 t)))
1560 ;; Run `kill-buffer-hook' here. It needs to happen before
1561 ;; variables like `buffer-file-name' etc are set to nil below,
1562 ;; because some of the hooks that could be invoked
1563 ;; (e.g., `save-place-to-alist') depend on those variables.
1564 ;;
1565 ;; Note that `kill-buffer-hook' is not what queries whether to
1566 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1567 ;; asks that itself. Thus, there's no need to temporarily do
1568 ;; `(set-buffer-modified-p nil)' before running this hook.
1570 ;; Okay, now we can end-of-life the old buffer.
1577 ;; This prevents us from finding the same buffer
1578 ;; if we specified the same file again.
1582 ;; Likewise for dired buffers.
1586 ;; This executes if find-file gets an error
1587 ;; and does not really find anything.
1588 ;; We put things back as they were.
1589 ;; If find-file actually finds something, we kill obuf below.
1598 ;; We already ran these; don't run them again.
1601 \f
1603 "Create a suitably named buffer for visiting FILENAME, and return it.
1604 FILENAME (sans directory) is used unchanged if that name is free;
1605 otherwise a string <2> or <3> or ... is appended to get an unused name.
1607 Emacs treats buffers whose names begin with a space as internal buffers.
1608 To avoid confusion when visiting a file whose name begins with a space,
1615 lastname))))
1618 "Create and return a buffer with a name based on NAME.
1619 Choose the buffer's name using `generate-new-buffer-name'."
1623 "Regexp to match the automounter prefix in a directory name."
1632 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1634 home directory is a root directory) and removes automounter prefixes
1635 \(see the variable `automount-dir-prefix')."
1636 ;; Get rid of the prefixes added by the automounter.
1643 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1644 ;; To fix this right, we need a `file-name-case-sensitive-p'
1645 ;; function, but we don't have that yet, so just guess.
1648 ;; If any elt of directory-abbrev-alist matches this name,
1649 ;; abbreviate accordingly.
1655 ;; Compute and save the abbreviated homedir name.
1656 ;; We defer computing this until the first time it's needed, to
1657 ;; give time for directory-abbrev-alist to be set properly.
1658 ;; We include a slash at the end, to avoid spurious matches
1659 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1666 ;; If FILENAME starts with the abbreviated homedir,
1667 ;; make it start with `~' instead.
1669 ;; If the home dir is just /, don't change it.
1672 ;; MS-DOS root directories can come with a drive letter;
1673 ;; Novell Netware allows drive letters beyond `Z:'.
1681 filename)))
1684 "Return the buffer visiting file FILENAME (a string).
1685 This is like `get-file-buffer', except that it checks for any buffer
1686 visiting the same file, possibly under a different name.
1687 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1688 and others are ignored.
1689 If there is no such live buffer, return nil."
1702 found)
1712 ;; Verify this buffer's file number
1713 ;; still belongs to its file.
1716 attributes)
1720 found))))
1721 \f
1723 "Non-nil means file-visiting commands should handle wildcards.
1724 For example, if you specify `*.c', that would visit all the files
1725 whose names match the pattern."
1731 "Non-nil means suppress warning messages for symlinked files.
1732 When nil, Emacs prints a warning when visiting a file that is already
1733 visited, but with a different name. Setting this option to t
1734 suppresses this warning."
1740 "Maximum size of file above which a confirmation is requested.
1741 When nil, never request confirmation."
1748 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1749 OP-TYPE specifies the file operation being performed (for message to user)."
1758 "Read file FILENAME into a buffer and return the buffer.
1759 If a buffer exists visiting FILENAME, return that one, but
1760 verify that the file has not changed since visited or saved.
1761 The buffer is not selected, just returned to the caller.
1762 Optional second arg NOWARN non-nil means suppress any warning messages.
1763 Optional third arg RAWFILE non-nil means the file is read literally.
1764 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1765 and visit all the matching files. When wildcards are actually
1766 used and expanded, return a list of buffers that are visiting
1767 the various files."
1774 'find-directory-functions
1777 filename)))
1780 find-file-wildcards
1794 ;; Find any buffer for a file which has same truename.
1796 ;; Let user know if there is a buffer with the same truename.
1800 find-file-suppress-same-file-warnings
1804 ;; Optionally also find that buffer.
1807 ;; Check to see if the file looks uncommonly large.
1811 ;; We are using an existing buffer.
1818 ;; Certain files should be reverted automatically
1819 ;; if they have changed on disk and not in the buffer.
1827 found))
1837 "File %s changed on disk. Discard your edits? "
1842 "File %s changed on disk. Discard your edits in %s? "
1850 ;; Check if a formerly read-only file has become
1851 ;; writable and vice versa, but if the buffer agrees
1852 ;; with the new state of the file, that is ok too.
1860 buffer-file-name
1867 nonexistent
1868 ;; It is confusing to ask whether to visit
1869 ;; non-literally if they have the file in
1870 ;; hexl-mode or image-mode.
1876 "The file %s is already visited normally,
1877 and you have edited the buffer. Now you have asked to visit it literally,
1878 meaning no coding system handling, format conversion, or local variables.
1879 Emacs can only visit a file in one way at a time.
1881 Do you want to save the file, and visit it literally instead? "
1882 "The file %s is already visited literally,
1883 meaning no coding system handling, format conversion, or local variables.
1884 You have edited the buffer. Now you have asked to visit the file normally,
1885 but Emacs can only visit a file in one way at a time.
1892 rawfile truename number))
1896 "\
1897 Do you want to discard your changes, and visit the file literally now? "
1898 "\
1901 rawfile truename number)
1907 "The file %s is already visited normally.
1908 You have asked to visit it literally,
1909 meaning no coding system decoding, format conversion, or local variables.
1910 But Emacs can only visit a file in one way at a time.
1912 Do you want to revisit the file literally now? "
1913 "The file %s is already visited literally,
1914 meaning no coding system decoding, format conversion, or local variables.
1915 You have asked to visit it normally,
1916 but Emacs can only visit a file in one way at a time.
1921 rawfile truename number)
1924 ;; Return the buffer we are using.
1925 buf)
1926 ;; Create a new buffer.
1928 ;; find-file-noselect-1 may use a different buffer.
1930 rawfile truename number))))))
1936 ;; Needed in case we are re-visiting the file with a different
1937 ;; text representation.
1954 filename)))
1955 ;; Unconditionally set error
1965 filename)))
1966 ;; Run find-file-not-found-functions until one returns non-nil.
1968 ;; If they fail too, set error.
1970 ;; Record the file's truename, and maybe use that as visited name.
1978 ;; Set buffer's default directory to that of the file.
1980 ;; Turn off backup files for certain file names. Since
1981 ;; this is a permanent local, the major mode won't eliminate it.
1995 \f
1997 "Like `insert-file-contents', but only reads in the file literally.
1998 A buffer may be modified in several ways after reading into the buffer,
1999 to Emacs features such as format decoding, character code
2000 conversion, `find-file-hook', automatic uncompression, etc.
2002 This function ensures that none of these modifications will take place."
2008 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2009 ;; into a file operation instead!
2011 inhibit-file-name-handlers))
2018 filename)))
2019 ;; Check whether the file is uncommonly large
2030 "Insert contents of file FILENAME into buffer after point with no conversion.
2032 This function is meant for the user to run interactively.
2033 Don't call it from programs! Use `insert-file-contents-literally' instead.
2034 \(Its calling sequence is different; see its documentation)."
2039 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2040 This has the `permanent-local' property, which takes effect if you
2045 "Visit file FILENAME with no conversion of any kind.
2046 Format conversion and character code conversion are both disabled,
2047 and multibyte characters are disabled in the resulting buffer.
2048 The major mode used is Fundamental mode regardless of the file name,
2049 and local variable specifications in the file are ignored.
2050 Automatic uncompression and adding a newline at the end of the
2051 file due to `require-final-newline' is also disabled.
2053 You cannot absolutely rely on this function to result in
2054 visiting the file literally. If Emacs already has a buffer
2055 which is visiting the file, you get the existing buffer,
2056 regardless of whether it was created literally or not.
2058 In a Lisp program, if you want to be sure of accessing a file's
2059 contents literally, you should create a temporary buffer and then read
2060 the file contents into it using `insert-file-contents-literally'."
2063 "Find file literally: " nil default-directory
2066 \f
2068 _after-find-file-from-revert-buffer
2069 nomodes)
2070 "Called after finding a file and by the default revert function.
2071 Sets buffer mode, parses local variables.
2072 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2073 error in reading the file. WARN non-nil means warn if there
2074 exists an auto-save file more recent than the visited file.
2075 NOAUTO means don't mess with auto-save mode.
2076 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2077 \(see `revert-buffer-in-progress-p' for similar functionality).
2078 Fifth arg NOMODES non-nil means don't alter the file's modes.
2079 Finishes by calling the functions in `find-file-hook'
2080 unless NOMODES is non-nil."
2083 nil
2093 "Symbolic link that points to nonexistent file"
2097 ;; No need to warn if buffer is auto-saved
2098 ;; under the name of the visited file.
2100 auto-save-visited-file-name))
2103 buffer-file-name))
2123 ;; Make people do a little extra work (C-x C-q)
2124 ;; before altering a backup file.
2127 ;; When a file is marked read-only,
2128 ;; make the buffer read-only even if root is looking at it.
2136 ;; If requested, add a newline at the end of the file.
2147 view-read-only
2153 "Eval BODY and turn any error into a FORMAT message.
2154 FORMAT can have a %s escape which will be replaced with the actual error.
2155 If `debug-on-error' is set, errors are not caught, so that you can
2156 debug them.
2157 Avoid using a large BODY since it is duplicated."
2166 "Choose the major mode for this buffer automatically.
2167 Also sets up any specified local variables of the file.
2168 Uses the visited file name, the -*- line, and the local variables spec.
2170 This function is called automatically from `find-file'. In that case,
2171 we may set up the file-specified mode and local variables,
2172 depending on the value of `enable-local-variables'.
2173 In addition, if `local-enable-local-variables' is nil, we do
2174 not set local variables (though we do notice a mode specified with -*-.)
2176 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2177 or from Lisp without specifying the optional argument FIND-FILE;
2178 in that case, this function acts as if `enable-local-variables' were t."
2182 ;; FIXME this is less efficient than it could be, since both
2183 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2188 ;; Turn font lock off and on, to make sure it takes account of
2189 ;; whatever file local variables are relevant to it.
2191 ;; Font-lock-mode (now in font-core.el) can be ON when
2192 ;; font-lock.el still hasn't been loaded.
2199 "Non-nil means to try second pass through `auto-mode-alist'.
2200 This means that if the first case-sensitive search through the alist fails
2201 to find a matching major mode, a second case-insensitive search is made.
2202 On systems with case-insensitive file names, this variable is ignored,
2203 since only a single case-insensitive search through the alist is made."
2209 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2210 ;; c++-mode, java-mode and more) are added through autoload
2211 ;; directives in that file. That way is discouraged since it
2212 ;; spreads out the definition of the initial value.
2258 ;; Less common extensions come here
2259 ;; so more common ones above are found faster.
2267 ;; Besides .gdbinit, gdb documents other names to be usable for init
2268 ;; files, cross-debuggers can use something like
2269 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2270 ;; don't interfere with each other.
2272 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2273 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2274 ;; loaded when GDB reads an objfile called 'emacs'.
2282 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2306 ;; The Fortran standard does not say anything about file extensions.
2307 ;; .f90 was widely used for F90, now we seem to be trapped into
2308 ;; using a different extension for each language revision.
2309 ;; Anyway, the following extensions are supported by gfortran.
2317 ;; The list of archive file extensions should be in sync with
2318 ;; `auto-coding-alist' with `no-conversion' coding system.
2324 ;; Mailer puts message to be edited in
2325 ;; /tmp/Re.... or Message
2328 ;; some news reader is reported to use this
2341 ;; .emacs or .gnus or .viper following a directory delimiter in
2342 ;; Unix, MSDOG or VMS syntax.
2345 ;; _emacs following a directory delimiter
2346 ;; in MsDos syntax
2350 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2351 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2352 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2355 ;; .xs is also used for ld scripts, but seems to be more commonly
2356 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2358 ;; Explained in binutils ld/genscripts.sh. Eg:
2359 ;; A .x script file is the default script.
2360 ;; A .xr script is for linking without relocation (-r flag). Etc.
2364 ;; Common Lisp ASDF package system.
2371 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2383 ;; Windows candidates may be opened case sensitively on Unix
2389 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2390 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2391 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2392 ;; this has lower priority to avoid matching changelog.sgml etc.
2394 ;; either user's dot-files or under /etc or some such
2396 ;; alas not all ~/.*rc files are like this
2397 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2402 ;; this contains everything twice, with space and with colon :-(
2404 ;; Get rid of any trailing .n.m and try again.
2405 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2406 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2407 ;; Using mode nil rather than `ignore' would let the search continue
2408 ;; through this list (with the shortened name) rather than start over.
2411 ;; This should come after "in" stripping (e.g. config.h.in).
2412 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2414 ;; The following should come after the ChangeLog pattern
2415 ;; for the sake of ChangeLog.1, etc.
2416 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2418 "Alist of filename patterns vs corresponding major mode functions.
2419 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2420 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2421 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2422 mode function to use. FUNCTION will be called, unless it is nil.
2424 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2425 calling FUNCTION (if it's not nil), we delete the suffix that matched
2426 REGEXP and search the list again for another match.
2428 The extensions whose FUNCTION is `archive-mode' should also
2429 appear in `auto-coding-alist' with `no-conversion' coding system.
2431 See also `interpreter-mode-alist', which detects executable script modes
2432 based on the interpreters they specify to run,
2437 "Select Conf mode or XML mode according to start of file."
2447 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2448 ;; and pike-mode) are added through autoload directives in that
2449 ;; file. That way is discouraged since it spreads out the
2450 ;; definition of the initial value.
2477 "Alist mapping interpreter names to major modes.
2478 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2479 Each element looks like (REGEXP . MODE).
2481 the interpreter specified in the first line of a script, enable
2482 major mode MODE.
2489 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2490 ;; because we are duplicating info from auto-mode-alist.
2491 ;; TODO many elements of this list are also in auto-coding-alist.
2500 "List of regexps matching file names in which to ignore local variables.
2502 Files matching this list are typically binary file formats.
2503 They may happen to contain sequences that look like local variable
2504 specifications, but are not really, or they may be containers for
2505 member files with their own local variable sections, which are
2506 not appropriate for the containing file.
2513 "List of regexps matching suffixes to remove from file names.
2514 The function `inhibit-local-variables-p' uses this: when checking
2515 a file name, it first discards from the end of the name anything that
2518 ;; Can't think of any situation in which you'd want this to be nil...
2523 "Return non-nil if file local variables should be ignored.
2524 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2525 and `inhibit-local-variables-suffixes'. If
2526 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2535 sufs)
2540 temp))
2545 "Regexp matching interpreters, for file mode determination.
2546 This regular expression is matched against the first line of a file
2547 to determine the file's mode in `set-auto-mode'. If it matches, the file
2548 is assumed to be interpreted by the interpreter matched by the second group
2549 of the regular expression. The mode is then determined as the mode
2553 "Alist of buffer beginnings vs. corresponding major mode functions.
2554 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2555 After visiting a file, if REGEXP matches the text at the beginning of the
2556 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2557 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2558 major mode.
2560 If FUNCTION is nil, then it is not called. (That is a way of saying
2568 ;; The < comes before the groups (but the first) to reduce backtracking.
2569 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2570 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2574 comment-re "*"
2577 . html-mode)
2579 ;; These two must come after html, because they are more general:
2584 . sgml-mode)
2587 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2588 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2589 After visiting a file, if REGEXP matches the text at the beginning of the
2590 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2591 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2592 have not specified a mode for this file.
2598 "Upper limit on `magic-mode-alist' regexp matches.
2602 "Select major mode appropriate for current buffer.
2604 To find the right major mode, this function checks for a -*- mode tag
2605 checks for a `mode:' entry in the Local Variables section of the file,
2606 checks if it uses an interpreter listed in `interpreter-mode-alist',
2607 matches the buffer beginning against `magic-mode-alist',
2608 compares the filename against the entries in `auto-mode-alist',
2609 then matches the buffer beginning against `magic-fallback-mode-alist'.
2611 If `enable-local-variables' is nil, or if the file name matches
2612 `inhibit-local-variables-regexps', this function does not check
2613 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2614 is nil, then the only mode: tag that can be relevant is a -*- one.
2616 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2617 set the major mode only if that would change it. In other words
2618 we don't actually set it to the same mode the buffer already has."
2619 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2621 end done mode modes)
2622 ;; Once we drop the deprecated feature where mode: is also allowed to
2623 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2624 ;; remove this section and just let (hack-local-variables t) handle it.
2625 ;; Find a -*- mode tag.
2629 ;; Note by design local-enable-local-variables does not matter here.
2631 try-locals
2634 ;; Find all specifications for the `mode:' variable
2635 ;; and execute them left to right.
2647 modes)))
2648 ;; Simple -*-MODE-*- case.
2651 modes))))
2652 ;; If we found modes to use, invoke them now, outside the save-excursion.
2660 ;; continuing would call minor modes again, toggling them off
2662 ;; hack-local-variables checks local-enable-local-variables etc, but
2663 ;; we might as well be explicit here for the sake of clarity.
2665 enable-local-variables
2666 local-enable-local-variables
2667 try-locals
2674 ;; If we didn't, look for an interpreter specified in the first line.
2675 ;; As a special case, allow for things like "#!/bin/env perl", which
2676 ;; finds the interpreter anywhere in $PATH.
2682 ;; Map interpreter name to a mode, signaling we're done at the
2683 ;; same time.
2690 interpreter-mode-alist)
2692 ;; If we found an interpreter mode to use, invoke it now.
2694 ;; Next try matching the buffer beginning against magic-mode-alist.
2708 ;; Next compare the filename against the entries in auto-mode-alist.
2713 ;; Remove backup-suffixes from file name.
2715 ;; Remove remote file name identification.
2720 ;; Find first matching alist entry.
2723 ;; System is case-insensitive.
2727 ;; System is case-sensitive.
2729 ;; First match case-sensitively.
2733 ;; Fallback to case-insensitive match.
2747 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2764 ;; When `keep-mode-if-same' is set, we are working on behalf of
2765 ;; set-visited-file-name. In that case, if the major mode specified is the
2766 ;; same one we already have, don't actually reset it. We don't want to lose
2767 ;; minor modes such as Font Lock.
2769 "Apply MODE and return it.
2770 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2771 any aliases and compared to current major mode. If they are the
2772 same, do nothing and return nil."
2778 mode)))
2781 "Regexp of lines to skip when looking for file-local settings.
2782 If the first line matches this regular expression, then the -*-...-*- file-
2786 "Find the -*- spec in the buffer.
2787 Call with point at the place to start searching from.
2788 If one is found, set point to the beginning and return the position
2789 of the end. Otherwise, return nil; may change point.
2790 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2791 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2792 have no effect."
2795 ;; Don't look for -*- if this file name matches any
2796 ;; of the regexps in inhibit-local-variables-regexps.
2799 ;; If the file begins with "#!" (exec
2800 ;; interpreter magic), look for mode frobs
2801 ;; in the first two lines. You cannot
2802 ;; necessarily put them in the first line
2803 ;; of such a file without screwing up the
2804 ;; interpreter invocation. The same holds
2805 ;; for '\" in man pages (preprocessor
2806 ;; magic for the `man' program).
2817 end))))
2818 \f
2819 ;;; Handling file local variables
2823 file-local-variables-alist dir-local-variables-alist)
2828 "Normal hook run after processing a file's local variables specs.
2829 Major modes can use this to examine user-specified local variables
2833 "List variable-value pairs that are considered safe.
2834 Each element is a cons cell (VAR . VAL), where VAR is a variable
2835 symbol and VAL is a value that is considered safe."
2836 :risky t
2841 ;; This should be here at least as long as Emacs supports write-file-hooks.
2846 "Expressions that are considered safe in an `eval:' local variable.
2847 Add expressions to this list if you want Emacs to evaluate them, when
2848 they appear in an `eval' local variable specification, without first
2849 asking you for confirmation."
2850 :risky t
2855 ;; Risky local variables:
2858 buffer-auto-save-file-name
2859 buffer-file-name
2860 buffer-file-truename
2861 buffer-undo-list
2862 debugger
2863 default-text-properties
2864 eval
2865 exec-directory
2866 exec-path
2867 file-name-handler-alist
2868 frame-title-format
2869 global-mode-string
2870 header-line-format
2871 icon-title-format
2872 inhibit-quit
2873 load-path
2874 max-lisp-eval-depth
2875 max-specpdl-size
2876 minor-mode-map-alist
2877 minor-mode-overriding-map-alist
2878 mode-line-format
2879 mode-name
2880 overriding-local-map
2881 overriding-terminal-local-map
2882 process-environment
2883 standard-input
2884 standard-output
2885 unread-command-events))
2887 ;; Safe local variables:
2888 ;;
2889 ;; For variables defined by major modes, the safety declarations can go into
2890 ;; the major mode's file, since that will be loaded before file variables are
2891 ;; processed.
2892 ;;
2893 ;; For variables defined by minor modes, put the safety declarations in the
2894 ;; file defining the minor mode after the defcustom/defvar using an autoload
2895 ;; cookie, e.g.:
2896 ;;
2897 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2898 ;;
2899 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2900 ;; minor mode file may not be loaded yet.
2901 ;;
2902 ;; For variables defined in the C source code the declaration should go here:
2924 "Alist of file-local variable settings in the current buffer.
2925 Each element in this list has the form (VAR . VALUE), where VAR
2926 is a file-local variable (a symbol) and VALUE is the value
2927 specified. The actual value in the buffer may differ from VALUE,
2933 "Alist of directory-local variable settings in the current buffer.
2934 Each element in this list has the form (VAR . VALUE), where VAR
2935 is a directory-local variable (a symbol) and VALUE is the value
2936 specified in .dir-locals.el. The actual value in the buffer
2937 may differ from VALUE, if it is changed by the major or minor modes,
2942 "Normal hook run before setting file-local variables.
2943 It is called after checking for unsafe/risky variables and
2944 setting `file-local-variables-alist', and before applying the
2945 variables stored in `file-local-variables-alist'. A hook
2946 function is allowed to change the contents of this alist.
2948 This hook is called only if there is at least one file-local
2952 "Get confirmation before setting up local variable values.
2953 ALL-VARS is the list of all variables to be set up.
2954 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2955 RISKY-VARS is the list of those that are marked as risky.
2956 If these settings come from directory-local variables, then
2957 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2964 unsafe-vars))
2966 ;; Set up the contents of the *Local Variables* buffer.
2974 ", and variables that are risky (**)."
2982 y -- to apply the local variables list.
2986 ! -- to apply the local variables list, and permanently mark these
2998 ;; Make strings with embedded whitespace easier to read.
3006 ;; Display the buffer and read a choice.
3014 ""
3017 char)
3036 "Return local variables specified in the -*- line.
3037 Returns an alist of elements (VAR . VAL), where VAR is a variable
3038 and VAL is the specified value. Ignores any specification for
3039 `mode:' and `coding:' (which should have already been handled
3040 by `set-auto-mode' and `set-auto-coding', respectively).
3041 Return nil if the -*- line is malformed.
3043 If MODE-ONLY is non-nil, just returns the symbol specifying the
3044 mode, if there is one, otherwise nil."
3049 result)
3051 nil)
3053 ;; Simple form: "-*- MODENAME -*-".
3057 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3058 ;; (last ";" is optional).
3059 ;; If MODE-ONLY, just check for `mode'.
3060 ;; Otherwise, parse the -*- line into the RESULT alist.
3068 ;; There used to be a downcase here,
3069 ;; but the manual didn't say so,
3070 ;; and people want to set var names that aren't all lc.
3076 ;; It is traditional to ignore
3077 ;; case when checking for `mode' in set-auto-mode,
3078 ;; so we must do that here as well.
3079 ;; That is inconsistent, but we're stuck with it.
3080 ;; The same can be said for `coding' in set-auto-coding.
3090 ;; Downcase "Mode:".
3096 result))))))
3099 "Filter local variable settings, querying the user if necessary.
3100 VARIABLES is the alist of variable-value settings. This alist is
3101 filtered based on the values of `ignored-local-variables',
3102 `enable-local-eval', `enable-local-variables', and (if necessary)
3103 user interaction. The results are added to
3104 `file-local-variables-alist', without applying them.
3105 If these settings come from directory-local variables, then
3106 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3107 ;; Find those variables that we may want to save to
3108 ;; `safe-local-variable-values'.
3114 ;; Ignore any variable in `ignored-local-variables'.
3115 nil)
3116 ;; Obey `enable-local-eval'.
3120 ;; In case previously marked safe (bug#5636).
3122 ;; If not safe and e-l-v = :safe, ignore totally.
3126 safe
3128 ;; Ignore duplicates (except `mode') in the present list.
3130 ;; Accept known-safe variables.
3134 ;; The variable is either risky or unsafe:
3141 ;; Query, unless all vars are safe or user wants no querying.
3147 risky-vars dir-name))
3157 ;; TODO? Warn once per file rather than once per session?
3161 "Parse and put into effect this buffer's local variables spec.
3162 Uses `hack-local-variables-apply' to apply the variables.
3165 is specified, and return the corresponding mode symbol, or nil.
3166 In this case, we try to ignore minor-modes, and only return a
3167 major-mode.
3169 If `enable-local-variables' or `local-enable-local-variables' is nil,
3170 this function does nothing. If `inhibit-local-variables-regexps'
3171 applies to the file in question, the file is not scanned for
3172 local variables, but directory-local variables may still be applied."
3173 ;; We don't let inhibit-local-variables-p influence the value of
3174 ;; enable-local-variables, because then it would affect dir-local
3175 ;; variables. We don't want to search eg tar files for file local
3176 ;; variable sections, but there is no reason dir-locals cannot apply
3177 ;; to them. The real meaning of inhibit-local-variables-p is "do
3178 ;; not scan this file for local variables".
3181 result)
3185 ;; Note this is a no-op if enable-local-variables is nil.
3187 ;; This entire function is basically a no-op if enable-local-variables
3188 ;; is nil. All it does is set file-local-variables-alist to nil.
3190 ;; This part used to ignore enable-local-variables when mode-only
3191 ;; was non-nil. That was inappropriate, eg consider the
3192 ;; (artificial) example of:
3193 ;; (setq local-enable-local-variables nil)
3194 ;; Open a file foo.txt that contains "mode: sh".
3195 ;; It correctly opens in text-mode.
3196 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3198 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3199 ;; mode, then we're done, and have no need to scan further.
3201 mode-only))
3202 ;; Look for "Local variables:" line in last page.
3210 ;; suffix is what comes after "local variables:" in its line.
3211 ;; prefix is what comes before "local variables:" in its line.
3224 endpos
3230 nil t))
3231 ;; This used to be an error, but really all it means is
3232 ;; that this may simply not be a local-variables section,
3233 ;; so just ignore it.
3243 ;; Discard the prefix.
3248 ;; Discard the suffix.
3257 ;; Find the variable name;
3265 val val2)
3268 ;; Read the variable value.
3275 ;; Specifying minor-modes via mode: is
3276 ;; deprecated, but try to reject them anyway.
3290 'eval
3294 ;; Now we've read all the local variables.
3295 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3297 ;; Otherwise, set the variables.
3302 "Apply the elements of `file-local-variables-alist'.
3303 If there are any elements, runs `before-hack-local-variables-hook',
3304 then calls `hack-one-local-variable' to apply the alist elements one by one.
3305 Finishes by running `hack-local-variables-hook', regardless of whether
3306 the alist is empty or not.
3308 Note that this function ignores a `mode' entry if it specifies the same
3309 major mode as the buffer already has."
3311 ;; Any 'evals must run in the Right sequence.
3320 "Non-nil if SYM is safe as a file-local variable with value VAL.
3321 It is safe if any of these conditions are met:
3323 * There is a matching entry (SYM . VAL) in the
3324 `safe-local-variable-values' user option.
3326 * The `safe-local-variable' property of SYM is a function that
3327 evaluates to a non-nil value with VAL as an argument."
3331 ;; If the function signals an error, that means it
3332 ;; can't assure us that the value is safe.
3336 "Non-nil if SYM could be dangerous as a file-local variable.
3337 It is dangerous if either of these conditions are met:
3339 * Its `risky-local-variable' property is non-nil.
3345 ;; If this is an alias, check the base name.
3365 "Return t if it is safe to eval EXP when it is found in a file."
3367 ;; Detect certain `put' expressions.
3374 lisp-indent-function
3375 scheme-indent-function))
3376 ;; Only allow safe values (not functions).
3381 ;; Only allow indirect form specs.
3382 ;; During bootstrapping, edebug-basic-spec might not be
3383 ;; defined yet.
3387 ;; Allow expressions that the user requested.
3389 ;; Certain functions can be allowed with safe arguments
3390 ;; or can specify verification functions to try.
3392 ;; Allow (minor)-modes calls with no arguments.
3393 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3402 ok))
3410 ok))))))))
3423 "Set local variable VAR with value VAL.
3424 If VAR is `mode', call `VAL-mode' as a function unless it's
3425 already the major mode."
3427 (`mode
3433 (`eval
3439 ;; Make sure the string has no text properties.
3440 ;; Some text properties can get evaluated in various ways,
3441 ;; so it is risky to put them on with a local variable list.
3445 \f
3446 ;;; Handling directory-local variables, aka project settings.
3452 "List of cached directory roots for directory-local variable classes.
3453 Each element in this list has the form (DIR CLASS MTIME).
3454 DIR is the name of the directory.
3455 CLASS is the name of a variable class (a symbol).
3456 MTIME is the recorded modification time of the directory-local
3457 variables file associated with this entry. This time is a list
3458 of integers (the same format as `file-attributes'), and is
3459 used to test whether the cache entry is still valid.
3460 Alternatively, MTIME can be nil, which means the entry is always
3464 "Return the variable list for CLASS."
3468 "Collect directory-local variables from MODE-VARIABLES.
3469 VARIABLES is the initial list of variables.
3470 Returns the new list."
3475 ;; If variables are specified more than once, only use the last. (Why?)
3476 ;; The pseudo-variables mode and eval are different (bug#3430).
3479 ;; Need a new cons in case we setcdr later.
3483 "Collect entries from CLASS-VARIABLES into VARIABLES.
3484 ROOT is the root directory of the project.
3485 Return the new variables list."
3488 ;; FIXME: Why not use file-relative-name?
3495 ;; Don't include this in the previous condition, because we
3496 ;; want to filter all strings before the next condition.
3510 ;; TODO someone might want to extend this to allow
3511 ;; integer values for subdir, where N means
3512 ;; variables apply to this directory and N levels
3513 ;; below it (0 == nil).
3516 alist variables))))))))
3518 ;; The file's content might be invalid (e.g. have a merge conflict), but
3519 ;; that shouldn't prevent the user from opening the file.
3521 nil))))
3524 "Declare that the DIRECTORY root is an instance of CLASS.
3525 DIRECTORY is the name of a directory, a string.
3526 CLASS is the name of a project class, a symbol.
3527 MTIME is either the modification time of the directory-local
3528 variables file that defined this class, or nil.
3530 When a file beneath DIRECTORY is visited, the mode-specific
3531 variables from CLASS are applied to the buffer. The variables
3532 for a class are defined using `dir-locals-set-class-variables'."
3539 "Map the type CLASS to a list of variable settings.
3540 CLASS is the project class, a symbol. VARIABLES is a list
3541 that declares directory-local variables for the class.
3542 An element in VARIABLES is either of the form:
3543 (MAJOR-MODE . ALIST)
3544 or
3545 (DIRECTORY . LIST)
3547 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3548 whose elements are of the form (VARIABLE . VALUE).
3550 In the second form, DIRECTORY is a directory name (a string), and
3551 LIST is a list of the form accepted by the function.
3553 When a file is visited, the file's class is found. A directory
3554 may be assigned a class using `dir-locals-set-directory-class'.
3555 Then variables are set in the file's buffer according to the
3556 VARIABLES list of the class. The list is processed in order.
3558 * If the element is of the form (MAJOR-MODE . ALIST), and the
3559 buffer's major mode is derived from MAJOR-MODE (as determined
3560 by `derived-mode-p'), then all the variables in ALIST are
3561 applied. A MAJOR-MODE of nil may be used to match any buffer.
3562 `make-local-variable' is called for each variable before it is
3563 set.
3565 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3566 is an initial substring of the file's directory, then LIST is
3567 applied by recursively following these rules."
3574 "File that contains directory-local variables.
3575 It has to be constant to enforce uniform values
3579 "Find the directory-local variables for FILE.
3580 This searches upward in the directory tree from FILE.
3581 It stops at the first directory that has been registered in
3582 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3583 If it finds an entry in the cache, it checks that it is valid.
3584 A cache entry with no modification time element (normally, one that
3585 has been assigned directly using `dir-locals-set-directory-class', not
3586 set from a file) is always valid.
3587 A cache entry based on a `dir-locals-file' is valid if the modification
3588 time stored in the cache matches the current file modification time.
3589 If not, the cache entry is cleared so that the file will be re-read.
3591 This function returns either nil (no directory local variables found),
3592 or the matching entry from `dir-locals-directory-cache' (a list),
3593 or the full path to the `dir-locals-file' (a string) in the case
3594 of no valid cache entry."
3599 dir-locals-file))
3602 ;; `locate-dominating-file' may have abbreviated the name.
3605 ;; Let dir-locals-read-from-file inform us via demoted-errors
3606 ;; about unreadable files, etc.
3607 ;; Maybe we'd want to keep searching though - that is
3608 ;; a locate-dominating-file issue.
3609 ;;; (or (not (file-readable-p locals-file))
3610 ;;; (not (file-regular-p locals-file)))
3611 ;;; (setq locals-file nil))
3612 ;; Find the best cached value in `dir-locals-directory-cache'.
3624 ;; Found a potential cache entry. Check validity.
3625 ;; A cache entry with no MTIME is assumed to always be valid
3626 ;; (ie, set directly, not from a dir-locals file).
3627 ;; Note, we don't bother to check that there is a matching class
3628 ;; element in dir-locals-class-alist, since that's done by
3629 ;; dir-locals-set-directory-class.
3636 ;; This cache entry is OK.
3637 dir-elt
3638 ;; This cache entry is invalid; clear it.
3641 ;; Return the first existing dir-locals file. Might be the same
3642 ;; as dir-elt's, might not (eg latter might have been deleted).
3643 locals-file)
3644 ;; No cache entry.
3645 locals-file)))
3648 "Load a variables FILE and register a new class and instance.
3649 FILE is the name of the file holding the variables to apply.
3650 The new class name is the same as the directory in which FILE
3651 is found. Returns the new class name."
3663 class-name)))))
3666 "Non-nil means dir-local variables will be applied to remote files."
3674 "Read per-directory local variables for the current buffer.
3675 Store the directory-local variables in `dir-local-variables-alist'
3676 and `file-local-variables-alist', without applying them.
3678 This does nothing if either `enable-local-variables' or
3679 `enable-dir-local-variables' are nil."
3681 enable-dir-local-variables
3684 default-directory)))))
3685 ;; Find the variables file.
3715 "Apply directory-local variables to a non-file buffer.
3716 For non-file buffers, such as Dired buffers, directory-local
3717 variables are looked for in `default-directory' and its parent
3718 directories."
3722 \f
3725 However, the mode will not be changed if
3726 \(1) a local variables list or the `-*-' line specifies a major mode, or
3728 \ not suitable for ordinary files, or
3729 \(3) the new file name does not particularly specify any mode."
3734 "Change name of file visited in current buffer to FILENAME.
3735 This also renames the buffer to correspond to the new file.
3736 The next time the buffer is saved it will go in the newly specified file.
3737 FILENAME nil or an empty string means mark buffer as not visiting any file.
3738 Remember to delete the initial contents of the minibuffer
3739 if you wish to pass an empty string as the argument.
3741 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3742 confirmation in the case where another buffer is already visiting FILENAME.
3744 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3745 the old visited file has been renamed to the new name FILENAME."
3753 nil
3768 filename)))
3775 buffer-file-name filename)
3779 ;; If new-name == old-name, renaming would add a spurious <2>
3780 ;; and it's considered as a feature in rename-buffer.
3786 ;; Abbreviate the file names of the buffer.
3795 nil))
3796 ;; write-file-functions is normally used for things like ftp-find-file
3797 ;; that visit things that are not local files as if they were files.
3798 ;; Changing to visit an ordinary local file instead should flush the hook.
3803 ;; If buffer was read-only because of version control,
3804 ;; that reason is gone now, so make it writable.
3808 ;; Turn off backup files for certain file names.
3809 ;; Since this is a permanent local, the major mode won't eliminate it.
3811 backup-enable-predicate
3817 ;; If auto-save was not already on, turn it on if appropriate.
3821 ;; If auto save is on, start using a new name.
3822 ;; We deliberately don't rename or delete the old auto save
3823 ;; for the old visited file name. This is because perhaps
3824 ;; the user wants to save the new state and then compare with the
3825 ;; previous state from the auto save file.
3828 ;; Rename the old auto save file if any.
3835 ;; Update the major mode, if the file name determines it.
3837 ;; Don't change the mode if it is special.
3840 ;; Don't change the mode if the local variable list specifies it.
3841 ;; The file name can influence whether the local variables apply.
3843 ;; h-l-v also checks it, but might as well be explicit.
3846 ;; TODO consider making normal-mode handle this case.
3854 "Write current buffer into file FILENAME.
3855 This makes the buffer visit that file, and marks it as not modified.
3857 If you specify just a directory name as FILENAME, that means to use
3858 the default file name but in that directory. You can also yank
3859 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3861 If the buffer is not already visiting a file, the default file name
3862 for the output file is the buffer name.
3864 If optional second arg CONFIRM is non-nil, this function
3865 asks for confirmation before overwriting an existing file.
3866 Interactively, confirmation is required unless you supply a prefix argument."
3867 ;; (interactive "FWrite file: ")
3871 nil nil nil nil)
3875 default-directory)
3876 nil nil))
3880 ;; If arg is just a directory,
3881 ;; use the default file name, but in that directory.
3888 ;; NS does its own confirm dialog.
3891 use-dialog-box))
3896 ;; Make buffer writable if file is writable.
3901 ;; It's likely that the VC status at the new location is different from
3902 ;; the one at the old location.
3904 \f
3906 "Return an alist of extended attributes of file FILENAME.
3908 Extended attributes are platform-specific metadata about the file,
3909 such as SELinux context, list of ACL entries, etc."
3914 "Set extended attributes of file FILENAME to ATTRIBUTES.
3916 ATTRIBUTES must be an alist of file attributes as returned by
3917 `file-extended-attributes'."
3925 \f
3927 "Make a backup of the disk file visited by the current buffer, if appropriate.
3928 This is normally done before saving the buffer the first time.
3930 A backup may be done by renaming or by copying; see documentation of
3931 variable `make-backup-files'. If it's done by renaming, then the file is
3932 no longer accessible under its old name.
3934 The value is non-nil after a backup was made by renaming.
3935 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
3936 MODES is the result of `file-modes' on the original
3937 file; this means that the caller, after saving the buffer, should change
3938 the modes of the new file to agree with the old modes.
3939 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
3940 on the original file; this means that the caller, after saving
3941 the buffer, should change the extended attributes of the new file
3942 to agree with the old attributes.
3943 BACKUPNAME is the backup file name, which is the old file renamed."
3950 backup-info backupname targets setmodes)
3951 ;; If specified name is a symbolic link, chase it to the target.
3952 ;; Thus we make the backups in the directory where the real file is.
3957 ;; (if (file-directory-p buffer-file-name)
3958 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3962 ;; If have old versions to maybe delete,
3963 ;; ask the user to confirm now, before doing anything.
3964 ;; But don't actually delete til later.
3969 real-file-name)))))
3973 ;; Actually write the back up file.
3976 ; (file-symlink-p buffer-file-name)
3977 backup-by-copying
3978 ;; Don't rename a suid or sgid file.
3991 real-file-name t))))))
3993 backupname modes
3994 extended-attributes)
3995 ;; rename-file should delete old backup.
3998 backupname)))
4000 ;; If trouble writing the backup, write it in
4001 ;; .emacs.d/%backup%.
4004 backupname)
4007 modes extended-attributes)))
4009 ;; Now delete the old versions, if desired.
4016 setmodes)
4023 ;; Create temp files with strict access rights. It's easy to
4024 ;; loosen them later, whereas it's impossible to close the
4025 ;; time-window of loose permissions otherwise.
4028 ;; Try to overwrite old backup first.
4036 nil)
4038 ;; The file was somehow created by someone else between
4039 ;; `delete-file' and `copy-file', so let's try again.
4040 ;; rms says "I think there is also a possible race
4041 ;; condition for making backup files" (emacs-devel 20070821).
4042 nil)))
4043 ;; Reset the umask.
4045 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4054 ;; The last ~[[:digit]]+ matches relative versions in git,
4055 ;; e.g. `foo.js.~HEAD~1~'.
4056 "Regular expression matching the backup/version part of a file name.
4060 "Return file NAME sans backup versions or strings.
4061 This is a separate procedure so your site-init or startup file can
4062 redefine it.
4063 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4064 we do not remove backup version numbers, only true file version numbers.
4065 See also `file-name-version-regexp'."
4072 name))))))
4075 "Return t if deleting FILE and rewriting it would preserve the owner.
4076 Return nil if FILE does not exist, or if deleting and recreating it
4077 might not preserve the owner. If GROUP is non-nil, check whether
4078 the group would be preserved too."
4083 ;; Return t if the file doesn't exist, since it's true that no
4084 ;; information would be lost by an (attempted) delete and create.
4087 ;; Files created on Windows by Administrator (RID=500)
4088 ;; have the Administrators group (RID=544) recorded as
4089 ;; their owner. Rewriting them will still preserve the
4090 ;; owner.
4094 ;; On BSD-derived systems files always inherit the parent
4095 ;; directory's group, so skip the group-gid test.
4101 ;; On some systems, a file created in a setuid directory
4102 ;; inherits that directory's owner.
4106 ;; On many systems, a file created in a setgid directory
4107 ;; inherits that directory's group. On some systems
4108 ;; this happens even if the setgid bit is not set.
4115 The extension, in a file name, is the part that follows the last `.',
4116 except that a leading `.', if any, doesn't count."
4119 directory)
4123 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4124 ;; we don't want to expand it.
4127 filename))))
4131 The extension, in a file name, is the part that follows the last `.',
4132 excluding version numbers and backup suffixes,
4133 except that a leading `.', if any, doesn't count.
4134 Return nil for extensionless file names such as `foo'.
4135 Return the empty string for file names such as `foo.'.
4137 If PERIOD is non-nil, then the returned value includes the period
4138 that delimits the extension, and if FILENAME has no extension,
4149 "Return the base name of the FILENAME: no directory, no extension.
4150 FILENAME defaults to `buffer-file-name'."
4155 #'make-backup-file-name--default-function
4156 "A function to use instead of the default `make-backup-file-name'.
4158 This could be buffer-local to do something special for specific
4159 files. If you define it, you may need to change `backup-file-name-p'
4160 and `file-name-sans-versions' too.
4162 See also `backup-directory-alist'."
4167 "Alist of filename patterns and backup directory names.
4168 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4169 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4170 relative or absolute. If it is absolute, so that all matching files
4171 are backed up into the same directory, the file names in this
4172 directory will be the full name of the file backed up with all
4173 directory separators changed to `!' to prevent clashes. This will not
4174 work correctly if your filesystem truncates the resulting name.
4176 For the common case of all backups going into one directory, the alist
4178 directory name.
4180 If this variable is nil, or it fails to match a filename, the backup
4181 is made in the original file's directory.
4183 On MS-DOS filesystems without long names this variable is always
4184 ignored."
4190 "Default `backup-enable-predicate' function.
4191 Checks for files in `temporary-file-directory',
4192 `small-temporary-file-directory', and /tmp."
4194 caseless)
4195 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4196 ;; their long file-name equivalents, so compare-strings does TRT.
4200 caseless t))
4203 ;; Directory is under temporary-file-directory.
4208 ;; Directory is under /tmp.
4213 0 nil
4215 ;; Directory is under small-temporary-file-directory.
4220 "Create the non-numeric backup file name for FILE.
4221 Normally this will just be the file's name with `~' appended.
4222 Customization hooks are provided as follows.
4224 The value of `make-backup-file-name-function' should be a function which
4225 will be called with FILE as its argument; the resulting name is used.
4227 By default, a match for FILE is sought in `backup-directory-alist'; see
4228 the documentation of that variable. If the directory for the backup
4229 doesn't exist, it is created."
4232 file))
4246 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4248 elt backup-directory abs-backup-directory)
4253 alist nil)))
4254 ;; If backup-directory is relative, it should be relative to the
4255 ;; file's directory. By expanding explicitly here, we avoid
4256 ;; depending on default-directory.
4265 abs-backup-directory nil))))
4267 file
4271 ;; Normalize DOSish file names: downcase the drive
4272 ;; letter, if any, and replace the leading "x:" with
4273 ;; "/drive_x".
4276 ;; Replace any invalid file-name characters (for the
4277 ;; case of backing up remote files).
4281 "drive_"
4284 ""
4287 ;; Make the name unique by substituting directory
4288 ;; separators. It may not really be worth bothering about
4289 ;; doubling `!'s in the original name...
4294 backup-directory))
4299 "Return non-nil if FILE is a backup file name (numeric or not).
4300 This is a separate function so you can redefine it for customization.
4301 You may need to redefine `file-name-sans-versions' as well."
4306 ;; This is used in various files.
4307 ;; The usage of backup-extract-version-start is not very clean,
4308 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4310 "Given the name of a numeric backup file, FN, return the backup number.
4311 Uses the free variable `backup-extract-version-start', whose value should be
4312 the index in the name where the version number begins."
4319 "Find a file name for a backup file FN, and suggestions for deletions.
4320 Value is a list whose car is the name for the backup file
4321 and whose cdr is a list of old versions to consider deleting now.
4322 If the value is nil, don't make a backup.
4323 Uses `backup-directory-alist' in the same way as does
4324 `make-backup-file-name'."
4326 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4330 ;; We don't support numbered backups on plain MS-DOS
4331 ;; when long file names are unavailable.
4341 possibilities deserve-versions-p versions)
4344 base-versions
4347 possibilities)
4348 #'<)
4353 kept-old-versions
4354 kept-new-versions
4361 ;; Delete nothing if there is overflow
4362 ;; in the number of versions to keep.
4368 v))))))))))
4371 "Return number of names file FILENAME has."
4374 ;; (defun file-relative-name (filename &optional directory)
4375 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4376 ;; This function returns a relative file name which is equivalent to FILENAME
4377 ;; when used with that default directory as the default.
4378 ;; If this is impossible (which can happen on MSDOS and Windows
4379 ;; when the file name and directory use different drive names)
4380 ;; then it returns FILENAME."
4381 ;; (save-match-data
4382 ;; (let ((fname (expand-file-name filename)))
4383 ;; (setq directory (file-name-as-directory
4384 ;; (expand-file-name (or directory default-directory))))
4385 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4386 ;; ;; drive names, they can't be relative, so return the absolute name.
4387 ;; (if (and (or (eq system-type 'ms-dos)
4388 ;; (eq system-type 'cygwin)
4389 ;; (eq system-type 'windows-nt))
4390 ;; (not (string-equal (substring fname 0 2)
4391 ;; (substring directory 0 2))))
4392 ;; filename
4393 ;; (let ((ancestor ".")
4394 ;; (fname-dir (file-name-as-directory fname)))
4395 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4396 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4397 ;; (setq directory (file-name-directory (substring directory 0 -1))
4398 ;; ancestor (if (equal ancestor ".")
4399 ;; ".."
4400 ;; (concat "../" ancestor))))
4401 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4402 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4403 ;; ;; We matched within FNAME's directory part.
4404 ;; ;; Add the rest of FNAME onto ANCESTOR.
4405 ;; (let ((rest (substring fname (match-end 0))))
4406 ;; (if (and (equal ancestor ".")
4407 ;; (not (equal rest "")))
4408 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4409 ;; rest
4410 ;; (concat (file-name-as-directory ancestor) rest)))
4411 ;; ;; We matched FNAME's directory equivalent.
4412 ;; ancestor))))))
4415 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4416 This function returns a relative file name which is equivalent to FILENAME
4417 when used with that default directory as the default.
4418 If FILENAME and DIRECTORY lie on different machines or on different drives
4419 on a DOS/Windows machine, it returns FILENAME in expanded form."
4423 default-directory))))
4428 read-file-name-completion-ignore-case)))
4431 ;; Test for different filesystems on DOS/Windows
4433 ;; Should `cygwin' really be included here? --stef
4436 ;; Test for different drive letters
4438 ;; Test for UNCs on different servers
4443 ;; Windows file names cannot have ? in
4444 ;; them, so use that to detect when
4445 ;; neither FILENAME nor DIRECTORY is a
4446 ;; UNC.
4448 0 nil
4454 ;; Test for different remote file system identification
4456 filename
4462 directory nil nil fold-case))
4464 directory nil nil fold-case))))
4467 ".."
4469 ;; Now ancestor is empty, or .., or ../.., etc.
4471 directory nil nil fold-case))
4472 ;; We matched within FILENAME's directory part.
4473 ;; Add the rest of FILENAME onto ANCESTOR.
4476 ;; But don't bother with ANCESTOR if it would give us `./'.
4477 rest
4479 ;; We matched FILENAME's directory equivalent.
4480 ancestor))))))
4481 \f
4483 "Save current buffer in visited file if modified.
4484 Variations are described below.
4486 By default, makes the previous version into a backup file
4487 if previously requested or if this is the first save.
4489 to become a backup when the next save is done.
4491 unconditionally makes the previous version into a backup file.
4493 to become a backup when the next save is done,
4494 and unconditionally makes the previous version into a backup file.
4496 With a numeric argument of 0, never make the previous version
4497 into a backup file.
4499 If a file's name is FOO, the names of its numbered backup versions are
4500 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4501 Numeric backups (rather than FOO~) will be made if value of
4502 `version-control' is not the atom `never' and either there are already
4503 numeric versions of the file being backed up, or `version-control' is
4504 non-nil.
4505 We don't want excessive versions piling up, so there are variables
4506 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4507 and `kept-new-versions', which tells how many newest versions to keep.
4508 Defaults are 2 old versions and 2 new.
4509 `dired-kept-versions' controls dired's clean-directory (.) command.
4510 If `delete-old-versions' is nil, system will query user
4511 before trimming versions. Otherwise it does it silently.
4513 If `vc-make-backup-files' is nil, which is the default,
4514 no backup files are made for files managed by version control.
4515 (This is because the version control system itself records previous versions.)
4517 See the subroutine `basic-save-buffer' for more information."
4523 ;; We used to display the message below only for files > 50KB, but
4524 ;; then Rmail-mbox never displays it due to buffer swapping. If
4525 ;; the test is ever re-introduced, be sure to handle saving of
4526 ;; Rmail files.
4533 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4534 Normally delete only if the file was written by this Emacs since
4535 the last real save, but optional arg FORCE non-nil means delete anyway."
4549 "Normal hook that is run before a buffer is saved to its file."
4555 "Normal hook that is run after a buffer is saved to its file."
4561 "If non-nil, use this coding system for saving the buffer.
4562 More precisely, use this coding system in place of the
4563 value of `buffer-file-coding-system', when saving the buffer.
4564 Calling `write-region' for any purpose other than saving the buffer
4565 will still use `buffer-file-coding-system'; this variable has no effect
4572 "Save the current buffer in its visited file, if it has been modified.
4573 The hooks `write-contents-functions' and `write-file-functions' get a chance
4574 to do the job of saving; if they do not, then the buffer is saved in
4575 the visited file in the usual way.
4576 Before and after saving the buffer, this function runs
4577 `before-save-hook' and `after-save-hook', respectively."
4580 ;; In an indirect buffer, save its base buffer instead.
4584 ;; handle the case when no modification has been made but
4585 ;; the file disappeared since visited
4589 setmodes)
4590 ;; If buffer has no file name, ask user for one.
4598 ;; Signal an error if the user specified the name of an
4599 ;; existing directory.
4602 filename))
4609 "%s has changed since visited or saved. Save anyway? "
4629 ;; Support VC version backups.
4631 ;; Don't let errors prevent saving the buffer.
4636 ;; If a hook returned t, file is already "written".
4637 ;; Otherwise, write it the usual way now.
4646 ;; Now we have saved the current buffer. Let's make sure
4647 ;; that buffer-file-coding-system is fixed to what
4648 ;; actually used for saving by binding it locally.
4663 ;; If the auto-save file was recent before this command,
4664 ;; delete it now.
4666 ;; Support VC `implicit' locking.
4671 ;; This does the "real job" of writing a buffer into its visited file
4672 ;; and making a backup file. This is what is normally done
4673 ;; but inhibited if one of write-file-functions returns non-nil.
4674 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4675 ;; backup-buffer.
4685 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4686 ;; backup-buffer.
4699 "File %s is write-protected; try to save anyway? "
4701 buffer-file-name)))
4704 ;; This may involve prompting, so do it now before backing up the file.
4705 ;; Otherwise there can be a delay while the user answers the
4706 ;; prompt during which the original file has been renamed. (Bug#13522)
4708 ;; Args here should match write-region call below around
4709 ;; which we use writecoding.
4711 buffer-file-truename))
4724 ;; Write temp name, then rename it.
4725 ;; This requires write access to the containing dir,
4726 ;; which is why we don't try it if we don't have that access.
4728 tempname succeed
4731 ;; Create temp files with strict access rights. It's easy to
4732 ;; loosen them later, whereas it's impossible to close the
4733 ;; time-window of loose permissions otherwise.
4738 ;; Try various temporary names.
4739 ;; This code follows the example of make-temp-file,
4740 ;; but it calls write-region in the appropriate way
4741 ;; for saving the buffer.
4747 ;; Pass in nil&nil rather than point-min&max
4748 ;; cause we're saving the whole buffer.
4749 ;; write-region-annotate-functions may use it.
4751 tempname nil realname
4753 nil)
4755 ;; The file was somehow created by someone else between
4756 ;; `make-temp-name' and `write-region', let's try again.
4757 nil)
4759 ;; Reset the umask.
4761 ;; If we failed, restore the buffer's modtime.
4764 ;; Since we have created an entirely new file,
4765 ;; make sure it gets the right permission bits set.
4770 buffer-file-name)))
4771 ;; We succeeded in writing the temp file,
4772 ;; so rename it.
4774 ;; If file not writable, see if we can make it writable
4775 ;; temporarily while we write it.
4776 ;; But no need to do so if we have just backed it up
4777 ;; (setmodes is set) because that says we're superseding.
4779 ;; Change the mode back, after writing.
4782 buffer-file-name))
4783 ;; If set-file-extended-attributes fails, fall back on
4784 ;; set-file-modes.
4793 ;; Pass in nil&nil rather than point-min&max to indicate
4794 ;; we're saving the buffer rather than just a region.
4795 ;; write-region-annotate-functions may make us of it.
4799 buffer-file-name nil t buffer-file-truename)
4801 ;; If we get an error writing the new file, and we made
4802 ;; the backup by renaming, undo the backing-up.
4807 setmodes))
4813 `((?\C-r
4820 ;; Return nil to ask about BUF again.
4821 nil)
4834 ;; Return nil to ask about BUF again.
4835 nil)
4845 "Save some modified file-visiting buffers. Asks user about each one.
4846 You can answer `y' to save, `n' not to save, `C-r' to look at the
4847 buffer in question with `view-buffer' before deciding or `d' to
4848 view the differences using `diff-buffer-with-file'.
4850 This command first saves any buffers where `buffer-save-without-query' is
4851 non-nil, without asking.
4853 Optional argument (the prefix) non-nil means save all with no questions.
4854 Optional second argument PRED determines which buffers are considered:
4855 If PRED is nil, all the file-visiting buffers are considered.
4856 If PRED is t, then certain non-file buffers will also be considered.
4857 If PRED is a zero-argument function, it indicates for each buffer whether
4858 to consider it or not when called with that buffer current.
4860 See `save-some-buffers-action-alist' if you want to
4861 change the additional actions you can take on files."
4865 files-done abbrevs-done)
4867 ;; First save any buffers that we're supposed to save unconditionally.
4868 ;; That way the following code won't ask about them.
4873 ;; Ask about those buffers that merit it,
4874 ;; and record the number thus saved.
4878 ;; Note that killing some buffers may kill others via
4879 ;; hooks (e.g. Rmail and its viewing buffer).
4892 t
4904 save-some-buffers-action-alist))
4905 ;; Maybe to save abbrevs, and record whether
4906 ;; we either saved them or asked to.
4913 ;; Don't keep bothering user if he says no.
4926 \f
4928 "Clear out records of last mod time of visited file.
4929 Next attempt to save will certainly not complain of a discrepancy."
4933 "Mark current buffer as unmodified, not needing to be saved.
4936 It is not a good idea to use this function in Lisp programs, because it
4937 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4951 "Insert contents of file FILENAME into buffer after point.
4952 Set mark after the inserted text.
4954 This function is meant for the user to run interactively.
4955 Don't call it from programs! Use `insert-file-contents' instead.
4956 \(Its calling sequence is different; see its documentation)."
4961 "Append the contents of the region to the end of file FILENAME.
4962 When called from a function, expects three arguments,
4963 START, END and FILENAME. START and END are normally buffer positions
4964 specifying the part of the buffer to write.
4965 If START is nil, that means to use the entire buffer contents.
4966 If START is a string, then output that string to the file
4967 instead of any buffer contents; END is ignored.
4969 This does character code conversion and applies annotations
4970 like `write-region' does."
4975 "Return most recent backup file for FILENAME or nil if no backups exist."
4976 ;; `make-backup-file-name' will get us the right directory for
4977 ;; ordinary or numeric backups. It might create a directory for
4978 ;; backups as a side-effect, according to `backup-directory-alist'.
4985 tem)
4994 newest))
4997 "Rename current buffer to a similar name not already taken.
4998 This function is useful for creating multiple shell process buffers
4999 or multiple mail buffers, etc.
5001 Note that some commands, in particular those based on `compilation-mode'
5002 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5003 appropriate mode even if it has been renamed. So as well as renaming
5004 the buffer, you also need to switch buffers before running another
5005 instance of such commands."
5013 ;; If the existing buffer name has a <NNN>,
5014 ;; which isn't part of the file name (if any),
5015 ;; then get rid of that.
5021 "Create the directory DIR and optionally any nonexistent parent dirs.
5022 If DIR already exists as a directory, signal an error, unless
5023 PARENTS is non-nil.
5025 Interactively, the default choice of directory to create is the
5026 current buffer's default directory. That is useful when you have
5027 visited a file in a nonexistent directory.
5029 Noninteractively, the second (optional) argument PARENTS, if
5030 non-nil, says whether to create parent directories that don't
5031 exist. Interactively, this happens by default.
5033 If creating the directory or directories fail, an error will be
5034 raised."
5037 nil nil)
5038 t))
5039 ;; If default-directory is a remote directory,
5040 ;; make sure we find its make-directory handler.
5048 create-list)
5050 ;; If directory is its own parent, then we can't
5051 ;; keep looping forever
5066 "Delete the directory named DIRECTORY. Does not follow symlinks.
5067 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5068 TRASH non-nil means to trash the directory instead, provided
5069 `delete-by-moving-to-trash' is non-nil.
5071 When called interactively, TRASH is t if no prefix argument is
5072 given. With a prefix argument, TRASH is nil."
5079 "Move directory to trash: "
5081 default-directory default-directory nil nil))))
5087 nil)
5089 ;; If default-directory is a remote directory, make sure we find its
5090 ;; delete-directory handler.
5097 ;; Only move non-empty dir to trash if recursive deletion was
5098 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5099 ;; case, where the operation fails in delete-directory-internal.
5100 ;; As `move-file-to-trash' trashes directories (empty or
5101 ;; otherwise) as a unit, we do not need to recurse here.
5103 ;; Check if directory is empty apart from "." and "..".
5108 ;; Otherwise, call ourselves recursively if needed.
5112 ;; This test is equivalent to
5113 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5114 ;; but more efficient
5118 ;; We do not want to delete "." and "..".
5124 "Return non-nil if files FILE1 and FILE2 name the same file.
5125 If FILE1 or FILE2 does not exist, the return value is unspecified."
5136 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5138 Return nil if DIR is not an existing directory."
5160 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5161 This function always sets the file modes of the output files to match
5162 the corresponding input file.
5164 The third arg KEEP-TIME non-nil means give the output files the same
5165 last-modified time as the old ones. (This works on only some systems.)
5167 A prefix arg makes KEEP-TIME non-nil.
5169 Noninteractively, the last argument PARENTS says whether to
5170 create parent directories if they don't exist. Interactively,
5171 this happens by default.
5173 If NEWNAME names an existing directory, copy DIRECTORY as a
5174 subdirectory there. However, if called from Lisp with a non-nil
5175 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5176 directly into NEWNAME instead."
5183 default-directory default-directory nil nil)
5184 current-prefix-arg t nil)))
5187 directory newname))
5188 ;; If default-directory is a remote directory, make sure we find its
5189 ;; copy-directory handler.
5194 newname keep-time parents copy-contents)
5196 ;; Compute target name.
5201 ;; If NEWNAME is not an existing directory, create it;
5202 ;; that is where we will copy the files of DIRECTORY.
5204 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5205 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5210 newname))
5214 newname))
5217 ;; Copy recursively.
5219 ;; We do not want to copy "." and "..".
5221 directory-files-no-dot-files-regexp))
5231 ;; Set directory attributes.
5237 \f
5238 ;; At time of writing, only info uses this.
5240 "Return a copy of DIRS with all non-existent directories removed.
5241 The optional argument KEEP is a list of directories to retain even if
5242 they don't exist, and REJECT is a list of directories to remove from
5243 DIRS, even if they exist; REJECT takes precedence over KEEP.
5245 Note that membership in REJECT and KEEP is checked using simple string
5246 comparison."
5252 dirs)))
5254 \f
5257 "Function to use to revert this buffer, or nil to do the default.
5258 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5259 which are the arguments that `revert-buffer' received.
5260 It also has access to the `preserve-modes' argument of `revert-buffer'
5265 #'revert-buffer-insert-file-contents--default-function
5266 "Function to use to insert contents when reverting this buffer.
5267 Gets two args, first the nominal file name to use,
5268 and second, t if reading the auto-save file.
5278 "Function to check whether a non-file buffer needs reverting.
5279 This should be a function with one optional argument NOCONFIRM.
5280 Auto Revert Mode passes t for NOCONFIRM. The function should return
5281 non-nil if the buffer should be reverted. A return value of
5282 `fast' means that the need for reverting was not checked, but
5283 that reverting the buffer is fast. The buffer is current when
5284 this function is called.
5286 The idea behind the NOCONFIRM argument is that it should be
5287 non-nil if the buffer is going to be reverted without asking the
5288 user. In such situations, one has to be careful with potentially
5289 time consuming operations.
5291 For more information on how this variable is used by Auto Revert mode,
5295 "Normal hook for `revert-buffer' to run before reverting.
5296 If `revert-buffer-function' is used to override the normal revert
5300 "Normal hook for `revert-buffer' to run after reverting.
5301 Note that the hook value that it runs is the value that was in effect
5302 before reverting; that makes a difference if you have buffer-local
5303 hook functions.
5305 If `revert-buffer-function' is used to override the normal revert
5309 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5314 ;; `revert-buffer-function' was defined long ago to be a function of only
5315 ;; 2 arguments, so we have to use a dynbind variable to pass the
5316 ;; `preserve-modes' argument of `revert-buffer'.
5320 "Replace current buffer text with the text of the visited file on disk.
5321 This undoes all changes since the file was visited or saved.
5322 With a prefix argument, offer to revert from latest auto-save file, if
5323 that is more recent than the visited file.
5325 This command also implements an interface for special buffers
5326 that contain text which doesn't come from a file, but reflects
5327 some other data instead (e.g. Dired buffers, `buffer-list'
5328 buffers). This is done via the variable `revert-buffer-function'.
5329 In these cases, it should reconstruct the buffer contents from the
5330 appropriate data.
5332 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5333 to revert from the auto-save file when this is nil. Note that the
5334 sense of this argument is the reverse of the prefix argument, for the
5335 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5336 to nil.
5338 Optional second argument NOCONFIRM means don't ask for confirmation
5339 at all. (The variable `revert-without-query' offers another way to
5340 revert buffers without querying for confirmation.)
5342 Optional third argument PRESERVE-MODES non-nil means don't alter
5343 the files modes. Normally we reinitialize them using `normal-mode'.
5345 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5347 If the value of `revert-buffer-function' is non-nil, it is called to
5348 do all the work for this command. Otherwise, the hooks
5349 `before-revert-hook' and `after-revert-hook' are run at the beginning
5350 and the end, and if `revert-buffer-insert-file-contents-function' is
5351 non-nil, it is called instead of rereading visited file contents."
5353 ;; I admit it's odd to reverse the sense of the prefix argument, but
5354 ;; there is a lot of code out there which assumes that the first
5355 ;; argument should be t to avoid consulting the auto-save file, and
5356 ;; there's no straightforward way to encourage authors to notice a
5357 ;; reversal of the argument sense. So I'm just changing the user
5358 ;; interface, but leaving the programmatic interface the same.
5363 ignore-auto noconfirm)))
5369 buffer-auto-save-file-name
5374 buffer-auto-save-file-name
5375 buffer-file-name)))
5385 file-name)))
5387 ;; If file was backed up but has changed since,
5388 ;; we should make another backup.
5392 ;; Effectively copy the after-revert-hook status,
5393 ;; since after-find-file will clobber it.
5396 after-revert-hook))
5398 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5402 file-name auto-save-p)
5403 ;; Recompute the truename in case changes in symlinks
5404 ;; have changed the truename.
5408 ;; Run after-revert-hook as it was before we reverted.
5412 local-hook)
5415 t)))))
5421 "File %s no longer exists!"
5423 file-name))
5426 "File %s no longer readable!"
5428 file-name))
5430 ;; Bind buffer-file-name to nil
5431 ;; so that we don't try to lock the file.
5437 ;; Auto-saved file should be read by Emacs's
5438 ;; internal coding.
5442 buffer-file-coding-system-explicit
5445 coding-system-for-read
5447 coding-system-for-read)
5449 ;; As a coding system suitable for multibyte
5450 ;; buffer is specified, make the current
5451 ;; buffer multibyte.
5454 ;; This force after-insert-file-set-coding
5455 ;; (called from insert-file-contents) to set
5456 ;; buffer-file-coding-system to a proper value.
5459 ;; Note that this preserves point in an intelligent way.
5463 nil nil t))
5465 nil nil t))))))
5468 "Recover the visited file--get contents from its last auto-save file."
5473 "Visit file FILE, but get contents from its last auto-save file."
5474 ;; Actually putting the file name in the minibuffer should be used
5475 ;; only rarely.
5476 ;; Not just because users often use the default.
5489 "*Directory*" nil
5500 ;; Use insert-directory-safely, not insert-directory,
5501 ;; because these files might not exist. In particular,
5502 ;; FILE might not exist if the auto-save file was for
5503 ;; a buffer that didn't visit a file, such as "*mail*".
5504 ;; The code in v20.x called `ls' directly, so we need
5505 ;; to emulate what `ls' did in that case.
5510 ;; Keep the current buffer-file-coding-system.
5512 ;; Auto-saved file should be read with special coding.
5521 "Recover auto save files from a previous Emacs session.
5522 This command first displays a Dired buffer showing you the
5523 previous sessions that you could recover from.
5524 To choose one, move point to the proper line and then type C-c C-c.
5525 Then you'll be asked about a number of files to recover."
5535 auto-save-list-file-prefix)))
5536 t)
5547 ;; Each line starts with a space
5548 ;; so that Font Lock mode won't highlight the first character.
5551 " To delete a session file, type \
5557 "Choose one saved session to recover auto-save files from.
5558 This command is used in the special Dired buffer created by
5561 ;; Get the name of the session file to recover from.
5563 files
5569 ;; Read in the auto-save-list file.
5572 ;; Loop thru the text of that file
5573 ;; and get out the names of the files to recover.
5577 ;; This is a pair of lines for a non-file-visiting buffer.
5578 ;; Get the auto-save file name and manufacture
5579 ;; a "visited file name" from that.
5582 ;; If there is no auto-save file name, the
5583 ;; auto-save-list file is probably corrupted.
5596 ;; This pair of lines is a file-visiting
5597 ;; buffer. Use the visited file name.
5607 ;; Ignore a file if its auto-save file does not exist now.
5611 ;; The file contains a pair of line for each auto-saved buffer.
5612 ;; The first line of the pair contains the visited file name
5613 ;; or is empty if the buffer was not visiting a file.
5614 ;; The second line is the auto-save file name.
5622 files
5628 "Kill BUFFER if confirmed."
5636 "Kill some buffers. Asks the user whether to kill each one of them.
5637 Non-interactively, if optional argument LIST is non-nil, it
5638 specifies the list of buffers to kill, asking for approval for each one."
5646 ; if we killed the base buffer.
5653 "Kill buffers whose name matches the specified REGEXP.
5654 The optional second argument indicates whether to kill internal buffers too."
5663 \f
5665 "Adjust current buffer's auto save file name for current conditions.
5666 Also rename any existing auto save file, if it was made in this session."
5678 "Return file name to use for auto-saves of current buffer.
5679 Does not consider `auto-save-visited-file-name' as that variable is checked
5680 before calling this function. You can redefine this for customization.
5681 See also `auto-save-file-name-p'."
5689 result uniq)
5690 ;; Apply user-specified translations
5691 ;; to the file name.
5695 filename)
5705 filename))))
5710 ;; We truncate the file name to DOS 8+3 limits
5711 ;; before doing anything else, because the regexp
5712 ;; passed to string-match below cannot handle
5713 ;; extensions longer than 3 characters, multiple
5714 ;; dots, and other atrocities.
5719 fn)
5724 "#"
5727 ;; Make sure auto-save file names don't contain characters
5728 ;; invalid for the underlying filesystem.
5730 ;; Don't modify remote (ange-ftp) filenames
5733 result))))
5735 ;; Deal with buffers that don't have any associated files. (Mail
5736 ;; mode tends to create a good number of these.)
5740 file-name)
5741 ;; Restrict the characters used in the file name to those which
5742 ;; are known to be safe on all filesystems, url-encoding the
5743 ;; rest.
5744 ;; We do this on all platforms, because even if we are not
5745 ;; running on DOS/Windows, the current directory may be on a
5746 ;; mounted VFAT filesystem, such as a USB memory stick.
5750 ;; For multibyte characters, this will produce more than
5751 ;; 2 hex digits, so is not true URL encoding.
5755 ;; Generate the file name.
5761 ;; Try a few alternative directories, to get one we can
5762 ;; write it.
5768 ;; Don't modify remote (ange-ftp) filenames
5770 ;; The call to convert-standard-filename is in case
5771 ;; buffer-name includes characters not allowed by the
5772 ;; DOS/Windows filesystems. make-temp-file writes to the
5773 ;; file it creates, so we must fix the file name _before_
5774 ;; make-temp-file is called.
5776 fname))
5778 ;; make-temp-file creates the file,
5779 ;; but we don't want it to exist until we do an auto-save.
5783 file-name)))
5786 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5787 FILENAME should lack slashes. You can redefine this for customization."
5789 \f
5791 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5792 The generated regexp will match a filename only if the filename
5793 matches that wildcard according to shell rules. Only wildcards known
5794 by `sh' are supported."
5796 ;; Copy the initial run of non-special characters.
5799 ;; If no special characters, we're almost done.
5803 j)
5805 result
5826 ;; Found "[^". Insert a `\0' character
5827 ;; (which cannot happen in a filename)
5828 ;; into the character class, so that `^'
5829 ;; is not the first character after `[',
5830 ;; and thus non-special in a regexp.
5835 ;; I don't think `]' can appear in a
5836 ;; character class in a wildcard, but
5837 ;; let's be general here.
5844 i
5857 ;; Shell wildcards should match the entire filename,
5858 ;; not its part. Make the regexp say so.
5860 \f
5863 "Switches for `list-directory' to pass to `ls' for brief listing."
5869 "Switches for `list-directory' to pass to `ls' for verbose listing."
5874 "Expand wildcard pattern PATTERN.
5875 This returns a list of file names which match the pattern.
5877 If PATTERN is written as an absolute file name,
5878 the values are absolute also.
5880 If PATTERN is written as a relative file name, it is interpreted
5881 relative to the current default directory, `default-directory'.
5882 The file names returned are normally also relative to the current
5883 default directory. However, if FULL is non-nil, they are absolute."
5887 ;; A list of all dirs that DIRPART specifies.
5888 ;; This can be more than one dir
5889 ;; if DIRPART contains wildcards.
5893 dirpart)))
5897 contents)
5903 ;; Filter out "." and ".."
5908 name))
5915 this-dir-contents)
5916 this-dir-contents)
5917 contents))))
5919 contents)))
5921 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5925 "Display a list of files in or matching DIRNAME, a la `ls'.
5926 DIRNAME is globbed by the shell if necessary.
5927 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5928 Actions controlled by variables `list-directory-brief-switches'
5929 and `list-directory-verbose-switches'."
5933 nil default-directory nil)
5934 pfx)))
5936 list-directory-brief-switches))
5937 buffer)
5949 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5957 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5959 PATTERN is assumed to represent a file-name wildcard suitable for the
5960 underlying filesystem. For Unix and GNU/Linux, each character from the
5962 the parts of the pattern which don't include wildcard characters are
5963 quoted with double quotes.
5966 on Windows), so PATTERN can use them to quote wildcard characters that
5967 need to be passed verbatim to shell commands."
5971 ;; DOS/Windows don't allow `"' in file names. So if the
5972 ;; argument has quotes, we can safely assume it is already
5973 ;; quoted by the caller.
5975 ;; We quote [&()#$'] in case their shell is a port of a
5976 ;; Unixy shell. We quote [,=+] because stock DOS and
5977 ;; Windows shells require that in some cases, such as
5978 ;; passing arguments to batch files that use positional
5979 ;; arguments like %1.
5981 pattern
5984 end)
6001 pattern))))
6008 "Program to get the amount of free space on a file system.
6009 We assume the output has the format of `df'.
6010 The value of this variable must be just a command name or file name;
6011 if you want to specify options, use `directory-free-space-args'.
6013 A value of nil disables this feature.
6015 If the function `file-system-info' is defined, it is always used in
6016 preference to the program given by this variable."
6022 "Options to use when running `directory-free-space-program'."
6027 "Return the amount of free space on directory DIR's file system.
6028 The return value is a string describing the amount of free
6029 space (normally, the number of free 1KB blocks).
6031 This function calls `file-system-info' if it is available, or
6032 invokes the program specified by `directory-free-space-program'
6033 and `directory-free-space-args'. If the system call or program
6034 is unsuccessful, or if DIR is a remote directory, this function
6035 returns nil."
6037 ;; Try to find the number of free blocks. Non-Posix systems don't
6038 ;; always have df, but might have an equivalent system call.
6047 ;; Avoid failure if the default directory does
6048 ;; not exist (Bug#2631, Bug#3911).
6052 nil t nil
6053 directory-free-space-args
6056 ;; Assume that the "available" column is before the
6057 ;; "capacity" column. Find the "%" and scan backward.
6061 "[[:space:]]+[^[:space:]]+%[^%]*$"
6068 ;; The following expression replaces `dired-move-to-filename-regexp'.
6072 ;; In some locales, month abbreviations are as short as 2 letters,
6073 ;; and they can be followed by ".".
6074 ;; In Breton, a month name can include a quote character.
6087 s "+"
6090 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6091 ;; omits the Kanji characters after month and day-of-month.
6092 ;; On Mac OS X 10.3, the date format in East Asian locales is
6093 ;; day-of-month digits followed by month digits.
6099 ;; The "[0-9]" below requires the previous column to end in a digit.
6100 ;; This avoids recognizing `1 may 1997' as a date in the line:
6101 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6103 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6105 ;; For non-iso date formats, we add the ".*" in order to find
6106 ;; the last possible match. This avoids recognizing
6107 ;; `jservice 10 1024' as a date in the line:
6108 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6110 ;; vc dired listings provide the state or blanks between file
6111 ;; permissions and date. The state is always surrounded by
6112 ;; parentheses:
6113 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6114 ;; This is not supported yet.
6119 "Regular expression to match up to the file name in a directory listing.
6120 The default value is designed to recognize dates and times
6125 ;; insert-directory
6126 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6127 ;; FULL-DIRECTORY-P is nil.
6128 ;; The single line of output must display FILE's name as it was
6129 ;; given, namely, an absolute path name.
6130 ;; - must insert exactly one line for each file if WILDCARD or
6131 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6132 ;; before the file lines, plus optional text after the file lines.
6133 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6134 ;; allowed.
6135 ;; File lines should display the basename.
6136 ;; - must be consistent with
6137 ;; - functions dired-move-to-filename, (these two define what a file line is)
6138 ;; dired-move-to-end-of-filename,
6139 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6140 ;; dired-insert-headerline
6141 ;; dired-after-subdir-garbage (defines what a "total" line is)
6142 ;; - variable dired-subdir-regexp
6143 ;; - may be passed "--dired" as the first argument in SWITCHES.
6144 ;; Filename handlers might have to remove this switch if their
6145 ;; "ls" command does not support it.
6147 "Insert directory listing for FILE, formatted according to SWITCHES.
6148 Leaves point after the inserted text.
6149 SWITCHES may be a string of options, or a list of strings
6150 representing individual options.
6151 Optional third arg WILDCARD means treat FILE as shell wildcard.
6152 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6153 switches do not contain `d', so that a full listing is expected.
6155 This works by running a directory listing program
6156 whose name is in the variable `insert-directory-program'.
6157 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6159 When SWITCHES contains the long `--dired' option, this function
6160 treats it specially, for the sake of dired. However, the
6161 normally equivalent short `-D' option is just passed on to
6162 `insert-directory-program', as any other option."
6163 ;; We need the directory in order to find the right handler.
6168 wildcard full-directory-p)
6171 ;; Read the actual directory using `insert-directory-program'.
6172 ;; RESULT gets the status code.
6174 ;; putting text property `dired-filename, decode one
6175 ;; bunch by one to preserve that property.
6177 ;; This is to control encoding the arguments in call-process.
6181 default-file-name-coding-system))))
6184 ;; Run ls in the directory part of the file pattern
6185 ;; using the last component as argument.
6191 ;; NB since switches is passed to the shell, be
6192 ;; careful of malicious values, eg "-l;reboot".
6193 ;; See eg dired-safe-switches-p.
6195 shell-file-name nil t nil
6196 "-c"
6198 ""
6200 insert-directory-program
6201 " -d "
6203 switches
6205 " -- "
6206 ;; Quote some characters that have
6207 ;; special meanings in shells; but
6208 ;; don't quote the wildcards--we want
6209 ;; them to be special. We also
6210 ;; currently don't quote the quoting
6211 ;; characters in case people want to
6212 ;; use them explicitly to quote
6213 ;; wildcard characters.
6215 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6216 ;; directory if FILE is a symbolic link.
6224 insert-directory-program nil t nil
6228 ;; Split the switches at any spaces so we can
6229 ;; pass separate options as separate args.
6231 ;; Avoid lossage if FILE starts with `-'.
6239 file))))))))
6241 ;; If we got "//DIRED//" in the output, it means we got a real
6242 ;; directory listing, even if `ls' returned nonzero.
6243 ;; So ignore any errors.
6256 ;; The first time ls returns an error,
6257 ;; find the version numbers of ls,
6258 ;; and set insert-directory-ls-version
6259 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6260 ;; is equal or if the info cannot be obtained.
6261 ;; (That can mean it isn't GNU ls.)
6271 comparison)
6287 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6291 ;; If `insert-directory-program' failed, signal an error.
6293 ;; Delete the error message it may have output.
6295 ;; On non-Posix systems, we cannot open a directory, so
6296 ;; don't even try, because that will always result in
6297 ;; the ubiquitous "Access denied". Instead, show the
6298 ;; command line so the user can try to guess what went wrong.
6303 insert-directory-program
6305 file result)
6306 ;; Unix. Access the file to get a suitable error.
6313 ;; The following overshoots by one line for an empty
6314 ;; directory listed with "--dired", but without "-a"
6315 ;; switch, where the ls output contains a
6316 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6317 ;; We take care of that case later.
6325 error-lines)
6326 ;; Find all the lines that are error messages,
6327 ;; and record the bounds of each one.
6334 ;; Now read the numeric positions of file names.
6341 error-lines))
6344 error-lines)))
6346 ;; End is followed by \n or by " -> ".
6348 ;; It seems that we can't trust ls's output as to
6349 ;; byte positions of filenames.
6355 ;; Take care of the case where the ls output contains a
6356 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6357 ;; and we went one line too far back (see above).
6362 ;; Now decode what read if necessary.
6364 file-name-coding-system
6365 default-file-name-coding-system
6367 coding-no-eol
6368 val pos)
6372 ;; If no coding system is specified or detection is
6373 ;; requested, detect the coding.
6387 ;; Force no eol conversion on a file name, so
6388 ;; that CR is preserved.
6396 ;; Try to insert the amount of free space.
6399 ;; First find the line to put it on.
6403 ;; Replace "total" with "used", to avoid confusion.
6409 "Convert `ls --dired' file name position value POS to a buffer position.
6410 File name position values returned in ls --dired output
6411 count only stdout; they don't count the error messages sent to stderr.
6412 So this function converts to them to real buffer positions.
6413 ERROR-LINES is a list of buffer positions of error message lines,
6414 of the form (START END)."
6418 pos)
6422 "Insert directory listing for FILE, formatted according to SWITCHES.
6424 Like `insert-directory', but if FILE does not exist, it inserts a
6425 message to that effect instead of signaling an error."
6428 ;; Simulate the message printed by `ls'.
6432 "Functions to call with no arguments to query about killing Emacs.
6433 If any of these functions returns nil, killing Emacs is canceled.
6434 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6438 "How to ask for confirmation when leaving Emacs.
6439 If nil, the default, don't ask at all. If the value is non-nil, it should
6440 be a predicate function such as `yes-or-no-p'."
6448 "Offer to save each buffer, then kill this Emacs process.
6449 With prefix ARG, silently save all file-visiting buffers without asking.
6450 If there are active processes where `process-query-on-exit-flag'
6451 returns non-nil, asks whether processes should be killed.
6452 Runs the members of `kill-emacs-query-functions' in turn and stops
6453 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6462 ;; process-list is not defined on MSDOS.
6464 active)
6480 ;; Query the user for other things, perhaps.
6487 "Offer to save each buffer, then kill the current connection.
6488 If the current frame has no client, kill Emacs itself.
6490 With prefix ARG, silently save all file-visiting buffers, then kill.
6492 If emacsclient was started with a list of filenames to edit, then
6493 only these files will be asked to be saved."
6498 \f
6499 ;; We use /: as a prefix to "quote" a file name
6500 ;; so that magic file name handlers will not apply to it.
6504 file-name-handler-alist))
6506 ;; We depend on being the last handler on the list,
6507 ;; so that anything else which does need handling
6508 ;; has been handled already.
6509 ;; So it is safe for us to inhibit *all* magic file name handlers.
6518 default-directory))
6519 ;; Get a list of the indices of the args which are file names.
6522 ;; The first six are special because they
6523 ;; return a file name. We want to include the /:
6524 ;; in the return value.
6525 ;; So just avoid stripping it in the first place.
6532 ;; `identity' means just return the first arg
6533 ;; not stripped of its quoting.
6535 ;; `add' means add "/:" to the result.
6538 ;; `unquote-then-quote' means set buffer-file-name
6539 ;; temporarily to unquoted filename.
6541 ;; List the arguments which are filenames.
6549 ;; For all other operations, treat the first argument only
6550 ;; as the file name.
6552 method
6553 ;; Copy ARGUMENTS so we can replace elements in it.
6557 ;; Strip off the /: from the file names that have it.
6565 "/"
6571 (`insert-file-contents
6577 (`unquote-then-quote
6582 \f
6583 ;; Symbolic modes and read-file-modes.
6586 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6587 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6588 Others, or All) for whom to produce the mask.
6589 The bit-mask that is returned extracts from mode bits the access rights
6590 for the specified category of users."
6598 "Convert CHAR to a numeric value of mode bits.
6599 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6600 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6607 ;; Rights relative to the previous file modes.
6618 "Convert a symbolic mode string specification to an equivalent number.
6620 WHO-MASK is the bit-mask specifying the category of users to which to
6621 apply the access permissions. See `file-modes-char-to-who'.
6622 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6623 RIGHTS request to add, remove, or set permissions based on existing ones,
6630 char-right)
6637 num-rights
6641 op char-right)))
6642 num-rights))
6645 "Convert symbolic file modes to numeric file modes.
6646 MODES is the string to convert, it should match
6648 See Info node `(coreutils)File permissions' for more information on this
6649 notation.
6650 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6651 MODES request to add, remove, or set permissions based on existing ones,
6665 num-who num-modes)
6668 num-modes)))
6671 "Read file modes in octal or symbolic notation and return its numeric value.
6672 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6673 ORIG-FILE is the name of a file on whose mode bits to base returned
6674 permissions if what user types requests to add, remove, or set permissions
6690 nil nil default)))
6699 ;; Trashcan handling.
6701 "Directory for `move-file-to-trash' to move files and directories to.
6702 This directory is only used when the function `system-move-file-to-trash'
6703 is not defined.
6704 Relative paths are interpreted relative to `default-directory'.
6705 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6715 "Move the file (or directory) named FILENAME to the trash.
6716 When `delete-by-moving-to-trash' is non-nil, this function is
6717 called by `delete-file' and `delete-directory' instead of
6718 deleting files outright.
6720 If the function `system-move-file-to-trash' is defined, call it
6721 with FILENAME as an argument.
6722 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6723 directory.
6724 Otherwise, trash FILENAME using the freedesktop.org conventions,
6725 like the GNOME, KDE and XFCE desktop environments. Emacs only
6729 ;; If `trash-directory' is non-nil, move the file there.
6733 trash-dir)))
6734 ;; We can't trash a parent directory of trash-directory.
6737 trash-dir filename))
6740 ;; Ensure that the trashed file-name is unique.
6747 ;; If `system-move-file-to-trash' is defined, use it.
6750 ;; Otherwise, use the freedesktop.org method, as specified at
6751 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6762 ;; Check if we have permissions to delete.
6766 ;; The trashed file cannot be the trash dir or its parent.
6769 trash-files-dir filename))
6772 trash-info-dir filename))
6774 ;; Ensure that the trash directory exists; otherwise, create it.
6785 ;; Try to move to trash with .trashinfo undo information
6790 ;; Perform url-encoding on FN. For compatibility with
6791 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6792 ;; for path separators.
6797 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6798 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6811 fn))
6816 ;; Attempt to make .trashinfo file, trying up to 5
6817 ;; times. The .trashinfo file is opened with O_EXCL,
6818 ;; as per trash-spec 0.7, even if that can be a problem
6819 ;; on old NFS versions...
6823 trash-files-dir))
6825 success info-fn)
6830 trash-info-dir))
6838 ;; Uniquify new-fn. (Some file managers do not
6839 ;; like Emacs-style backup file names---e.g. bug
6840 ;; 170956 in Konqueror bug tracker.)
6845 ;; Finally, try to move the file to the trashcan.
6849 \f
6874 ;;; files.el ends here