| blob | 53b701dbcbe4efda0f933c6b922ff1b8846ed556 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992-2012 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'ss 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.)
231 "Non-nil means protect against I/O errors while saving files.
232 Some modes set this non-nil in particular buffers.
234 This feature works by writing the new contents into a temporary file
235 and then renaming the temporary file to replace the original.
236 In this way, any I/O error in writing leaves the original untouched,
237 and there is never any instant where the file is nonexistent.
239 Note that this feature forces backups to be made by copying.
240 Yet, at the same time, saving a precious file
241 breaks any hard links between it and other files.
243 This feature is advisory: for example, if the directory in which the
244 file is being saved is not writable, Emacs may ignore a non-nil value
245 of `file-precious-flag' and write directly into the file.
247 See also: `break-hardlink-on-save'."
252 "Non-nil means when saving a file that exists under several names
253 \(i.e., has multiple hardlinks), break the hardlink associated with
254 `buffer-file-name' and write to a new file, so that the other
255 instances of the file are not affected by the save.
257 If `buffer-file-name' refers to a symlink, do not break the symlink.
259 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
260 For example, if the directory in which a file is being saved is not
261 itself writable, then error instead of saving in some
262 hardlink-nonbreaking way.
264 See also `backup-by-copying' and `backup-by-copying-when-linked'."
270 "Control use of version numbers for backup files.
271 When t, make numeric backup versions unconditionally.
272 When nil, make them for files that have some already.
273 The value `never' means do not make them."
283 "When cleaning directory, number of versions to keep."
289 "If t, delete excess backup versions silently.
290 If nil, ask confirmation. Any other value prevents any trimming."
297 "Number of oldest versions to keep when a new numbered backup is made."
303 "Number of newest versions to keep when a new numbered backup is made.
304 Includes the new backup. Must be > 0"
310 "Whether to add a newline automatically at the end of the file.
312 A value of t means do this only when the file is about to be saved.
313 A value of `visit' means do this right after the file is visited.
314 A value of `visit-save' means do it at both of those times.
315 Any other non-nil value means ask user whether to add a newline, when saving.
316 A value of nil means don't add newlines.
318 Certain major modes set this locally to the value obtained
319 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
511 ;; This is an odd variable IMO.
512 ;; You might wonder why it is needed, when we could just do:
513 ;; (set (make-local-variable 'enable-local-variables) nil)
514 ;; These two are not precisely the same.
515 ;; Setting this variable does not cause -*- mode settings to be
516 ;; ignored, whereas setting enable-local-variables does.
517 ;; Only three places in Emacs use this variable: tar and arc modes,
518 ;; and rmail. The first two don't need it. They already use
519 ;; inhibit-local-variables-regexps, which is probably enough, and
520 ;; could also just set enable-local-variables locally to nil.
521 ;; Them setting it has the side-effect that dir-locals cannot apply to
522 ;; eg tar files (?). FIXME Is this appropriate?
523 ;; AFAICS, rmail is the only thing that needs this, and the only
524 ;; reason it uses it is for BABYL files (which are obsolete).
525 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
526 ;; to respect, so that find-file on a BABYL file will switch to
527 ;; rmail-mode automatically (this is nice, but hardly essential,
528 ;; since most people are used to explicitly running a command to
529 ;; access their mail; M-x gnus etc). Rmail files may happen to
530 ;; contain Local Variables sections in messages, which Rmail wants to
531 ;; ignore. So AFAICS the only reason this variable exists is for a
532 ;; minor convenience feature for handling of an obsolete Rmail file format.
534 "Like `enable-local-variables' but meant for buffer-local bindings.
535 The meaningful values are nil and non-nil. The default is non-nil.
536 If a major mode sets this to nil, buffer-locally, then any local
537 variables list in a file visited in that mode will be ignored.
539 This variable does not affect the use of major modes specified
544 The value can be t, nil or something else.
545 A value of t means obey `eval' variables.
546 A value of nil means ignore them; anything else means query."
547 :risky t
553 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
562 "Non-nil means buffers visiting files read-only do so in view mode.
563 In fact, this means that all read-only buffers normally have
564 View mode enabled, including buffers that are read-only because
565 you visit a file you cannot alter, and buffers you make read-only
571 "History list of file names entered in the minibuffer.
573 Maximum length of the history list is determined by the value
575 \f
578 "Provides support for ange-ftp host name completion.
579 Runs the usual ange-ftp hook, but only for completion operations."
580 ;; Having this here avoids the need to load ange-ftp when it's not
581 ;; really in use.
587 inhibit-file-name-handlers)))
595 "Convert a standard file's name to something suitable for the OS.
596 This means to guarantee valid names and perhaps to canonicalize
597 certain patterns.
599 FILENAME should be an absolute file name since the conversion rules
600 sometimes vary depending on the position in the file name. E.g. c:/foo
601 is a valid DOS file name, but c:/bar/c:/foo is not.
603 This function's standard definition is trivial; it just returns
604 the argument. However, on Windows and DOS, replace invalid
605 characters. On DOS, make sure to obey the 8.3 limitations.
606 In the native Windows build, turn Cygwin names into native names,
607 and also turn slashes into backslashes if the shell requires it (see
608 `w32-shell-dos-semantics').
610 See Info node `(elisp)Standard File Names' for more details."
615 ;; Replace invalid filename characters with !
619 name))
627 "Read directory name, prompting with PROMPT and completing in directory DIR.
628 Value is not expanded---you must call `expand-file-name' yourself.
629 Default name to DEFAULT-DIRNAME if user exits with the same
630 non-empty string that was inserted by this function.
631 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
632 or just DIR if INITIAL is nil.)
633 If the user exits with an empty minibuffer, this function returns
634 an empty string. (This can only happen if the user erased the
635 pre-inserted contents or if `insert-default-directory' is nil.)
636 Fourth arg MUSTMATCH non-nil means require existing directory's name.
637 Non-nil and non-t means also require confirmation after completion.
638 Fifth arg INITIAL specifies text to start with.
639 DIR should be an absolute directory name. It defaults to
640 the value of `default-directory'."
645 dir))
646 mustmatch initial
649 \f
651 "Show the current default directory."
656 "Value of the CDPATH environment variable, as a list.
660 "Explode a search path into a list of directory names.
661 Directories are separated by occurrences of `path-separator'
662 \(which is colon in GNU and GNU-like systems)."
663 ;; We could use split-string here.
671 nil
676 cd-list)))
679 "Change current directory to given absolute file name DIR."
680 ;; Put the name into directory syntax now,
681 ;; because otherwise expand-file-name may give some bad results.
683 ;; We used to additionally call abbreviate-file-name here, for an
684 ;; unknown reason. Problem is that most buffers are setup
685 ;; without going through cd-absolute and don't call
686 ;; abbreviate-file-name on their default-directory, so the few that
687 ;; do end up using a superficially different directory.
699 "Make DIR become the current buffer's default directory.
700 If your environment includes a `CDPATH' variable, try each one of
701 that list of directories (separated by occurrences of
702 `path-separator') when resolving a relative directory name.
703 The path separator is colon in GNU and GNU-like systems."
706 ;; FIXME: There's a subtle bug in the completion below. Seems linked
707 ;; to a fundamental difficulty of implementing `predicate' correctly.
708 ;; The manifestation is that TAB may list non-directories in the case where
709 ;; those files also correspond to valid directories (if your cd-path is (A/
710 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
711 ;; will be listed as valid completions).
712 ;; This is because `a' (listed because of A/a) is indeed a valid choice
713 ;; (which will lead to the use of B/a).
718 cd-path nil))
727 default-directory default-directory
728 t))))
738 "Load the Lisp file named FILE."
739 ;; This is a case where .elc makes a lot of sense.
746 "Search for FILENAME through PATH.
747 If found, return the absolute file name of FILENAME, with its suffixes;
748 otherwise return nil.
749 PATH should be a list of directories to look in, like the lists in
750 `exec-path' or `load-path'.
751 If SUFFIXES is non-nil, it should be a list of suffixes to append to
754 If non-nil, PREDICATE is used instead of `file-readable-p'.
756 This function will normally skip directories, so if you want it to find
757 directories, make sure the PREDICATE function returns `dir-ok' for them.
759 PREDICATE can also be an integer to pass to the `access' system call,
760 in which case file-name handlers are ignored. This usage is deprecated.
761 For compatibility, PREDICATE can also be one of the symbols
762 `executable', `readable', `writable', or `exists', or a list of
763 one or more of those symbols."
774 "Do completion for file names passed to `locate-file'."
777 ;; FIXME: maybe we should use completion-file-name-table instead,
778 ;; tho at least for `load', the arg is passed through
779 ;; substitute-in-file-name for historical reasons.
789 ;; If we have files like "foo.el" and "foo.elc", we could load one of
790 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
791 ;; preferred way. So if we list all 3, that gives a lot of redundant
792 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
793 ;; the user does want to pay attention to the extension. We try to
794 ;; diffuse this tension by stripping the suffix, except when the
795 ;; result is a single element (i.e. usually we only list "foo" unless
796 ;; it's the only remaining element in the list, in which case we do
797 ;; list "foo", "foo.elc" and "foo.el").
808 string-file dir))
813 ;; Switching from names to names+fullnames creates a non-monotonicity
814 ;; which can cause problems with things like partial-completion.
815 ;; To minimize the problem, filter out completion-regexp-list, so that
816 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
817 ;; from `names' which only matched `string' when they still had
818 ;; their suffix.
820 ;; Remove duplicates of the first element, so that we can easily check
821 ;; if `names' really only contains a single element.
824 ;; There's no more than one matching non-suffixed element, so expand
825 ;; the list by adding the suffixed elements as well.
828 string-dir names string-file pred action)))))
831 "Do completion for file names passed to `locate-file'.
832 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
835 string nil action))
840 "Regexp of directory names which stop the search in `locate-dominating-file'.
841 Any directory whose name matches this regexp will be treated like
842 a kind of root directory by `locate-dominating-file' which will stop its search
843 when it bumps into it.
844 The default regexp prevents fruitless and time-consuming attempts to find
845 special files in directories in which filenames are interpreted as hostnames,
848 ;; (defun locate-dominating-files (file regexp)
849 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
850 ;; Stop at the first parent where a matching file is found and return the list
851 ;; of files that that match in this directory."
852 ;; (catch 'found
853 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
854 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
855 ;; (let ((user nil)
856 ;; ;; Abbreviate, so as to stop when we cross ~/.
857 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
858 ;; files)
859 ;; (while (and dir
860 ;; ;; As a heuristic, we stop looking up the hierarchy of
861 ;; ;; directories as soon as we find a directory belonging to
862 ;; ;; another user. This should save us from looking in
863 ;; ;; things like /net and /afs. This assumes that all the
864 ;; ;; files inside a project belong to the same user.
865 ;; (let ((prev-user user))
866 ;; (setq user (nth 2 (file-attributes dir)))
867 ;; (or (null prev-user) (equal user prev-user))))
868 ;; (if (setq files (condition-case nil
869 ;; (directory-files dir 'full regexp 'nosort)
870 ;; (error nil)))
871 ;; (throw 'found files)
872 ;; (if (equal dir
873 ;; (setq dir (file-name-directory
874 ;; (directory-file-name dir))))
875 ;; (setq dir nil))))
876 ;; nil)))
879 "Look up the directory hierarchy from FILE for a directory containing NAME.
880 Stop at the first parent directory containing a file NAME,
881 and return the directory. Return nil if not found.
882 Instead of a string, NAME can also be a predicate taking one argument
883 \(a directory) and returning a non-nil value if that directory is the one for
884 which we're looking."
885 ;; We used to use the above locate-dominating-files code, but the
886 ;; directory-files call is very costly, so we're much better off doing
887 ;; multiple calls using the code in here.
888 ;;
889 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
890 ;; `name' in /home or in /.
893 ;; `user' is not initialized outside the loop because
894 ;; `file' may not exist, so we may have to walk up part of the
895 ;; hierarchy before we find the "initial UID". Note: currently unused
896 ;; (user nil)
897 try)
900 ;; FIXME: Disabled this heuristic because it is sometimes
901 ;; inappropriate.
902 ;; As a heuristic, we stop looking up the hierarchy of
903 ;; directories as soon as we find a directory belonging
904 ;; to another user. This should save us from looking in
905 ;; things like /net and /afs. This assumes that all the
906 ;; files inside a project belong to the same user.
907 ;; (let ((prev-user user))
908 ;; (setq user (nth 2 (file-attributes file)))
909 ;; (and prev-user (not (equal user prev-user))))
922 "Search for COMMAND in `exec-path' and return the absolute file name.
923 Return nil if COMMAND is not found anywhere in `exec-path'."
924 ;; Use 1 rather than file-executable-p to better match the behavior of
925 ;; call-process.
929 "Load the Emacs Lisp library named LIBRARY.
930 This is an interface to the function `load'. LIBRARY is searched
931 for in `load-path', both with and without `load-suffixes' (as
932 well as `load-file-rep-suffixes').
934 See Info node `(emacs)Lisp Libraries' for more details.
935 See `load-file' for a different interface to `load'."
939 load-path
944 "Test whether FILE specifies a location on a remote system.
945 A file is considered remote if accessing it is likely to
946 be slower or less reliable than accessing local files.
948 `file-remote-p' never opens a new remote connection. It can
949 only reuse a connection that is already open.
951 Return nil or a string identifying the remote connection
952 \(ideally a prefix of FILE). Return nil if FILE is a relative
953 file name.
955 When IDENTIFICATION is nil, the returned string is a complete
956 remote identifier: with components method, user, and host. The
957 components are those present in FILE, with defaults filled in for
958 any that are missing.
960 IDENTIFICATION can specify which part of the identification to
961 return. IDENTIFICATION can be the symbol `method', `user',
962 `host', or `localname'. Any other value is handled like nil and
963 means to return the complete identification. The string returned
964 for IDENTIFICATION `localname' can differ depending on whether
965 there is an existing connection.
967 If CONNECTED is non-nil, return an identification only if FILE is
968 located on a remote system and a connection is established to
969 that remote system.
971 Tip: You can use this expansion of remote identifier components
972 to derive a new remote file name from an existing one. For
978 same remote identifier as FILE but expanded; a name such as
983 nil)))
985 ;; Probably this entire variable should be obsolete now, in favor of
986 ;; something Tramp-related (?). It is not used in many places.
987 ;; It's not clear what the best file for this to be in is, but given
988 ;; it uses custom-initialize-delay, it is easier if it is preloaded
989 ;; rather than autoloaded.
991 ;; This used to try various hard-coded places for remsh, rsh, and
992 ;; rcmd, trying to guess based on location whether "rsh" was
993 ;; "restricted shell" or "remote shell", but I don't see the point
994 ;; in this day and age. Almost everyone will use ssh, and have
995 ;; whatever command they want to use in PATH.
1002 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1009 "Whether to use the remote file-name cache for read access.
1010 When `nil', never expire cached values (caution)
1011 When `t', never use the cache (safe, but may be slow)
1012 A number means use cached values for that amount of seconds since caching.
1014 The attributes of remote files are cached for better performance.
1015 If they are changed outside of Emacs's control, the cached values
1016 become invalid, and must be reread. If you are sure that nothing
1017 other than Emacs changes the files, you can set this variable to `nil'.
1019 If a remote file is checked regularly, it might be a good idea to
1020 let-bind this variable to a value less than the interval between
1021 consecutive checks. For example:
1023 (defun display-time-file-nonempty-p (file)
1024 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1025 (and (file-exists-p file)
1026 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1037 "Copy the file FILE into a temporary file on this machine.
1038 Returns the name of the local copy, or nil, if FILE is directly
1039 accessible."
1040 ;; This formerly had an optional BUFFER argument that wasn't used by
1041 ;; anything.
1045 nil)))
1048 "Return the truename of FILENAME.
1049 If FILENAME is not absolute, first expands it against `default-directory'.
1050 The truename of a file name is found by chasing symbolic links
1051 both at the level of the file and at the level of the directories
1052 containing it, until no links are left at any level.
1055 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1056 ;; COUNTER can be a cons cell whose car is the count of how many
1057 ;; more links to chase before getting an error.
1058 ;; PREV-DIRS can be a cons cell whose car is an alist
1059 ;; of truenames we've just recently computed.
1073 ;; For speed, remove the ange-ftp completion handler from the list.
1074 ;; We know it's not needed here.
1075 ;; For even more speed, do this only on the outermost call.
1082 ;; andrewi@harlequin.co.uk - none of the following code (except for
1083 ;; invoking the file-name handler) currently applies on Windows
1084 ;; (ie. there are no native symlinks), but there is an issue with
1085 ;; case differences being ignored by the OS, and short "8.3 DOS"
1086 ;; name aliases existing for all files. (The short names are not
1087 ;; reported by directory-files, but can be used to refer to files.)
1088 ;; It seems appropriate for file-truename to resolve these issues in
1089 ;; the most natural way, which on Windows is to call the function
1090 ;; `w32-long-file-name' - this returns the exact name of a file as
1091 ;; it is stored on disk (expanding short name aliases with the full
1092 ;; name in the process).
1095 ;; For file name that has a special handler, call handler.
1096 ;; This is so that ange-ftp can save time by doing a no-op.
1099 ;; If filename contains a wildcard, newname will be the old name.
1101 ;; If filename exists, use the long name. If it doesn't exist,
1102 ;; drill down until we find a directory that exists, and use
1103 ;; the long name of that, with the extra non-existent path
1104 ;; components concatenated.
1106 missing rest)
1109 ;; Include the preceding directory separator in the missing
1110 ;; part so subsequent recursion on the rest works.
1115 ""
1120 ;; If this file directly leads to a link, process that iteratively
1121 ;; so that we don't use lots of stack.
1127 ;; For file name that has a special handler, call handler.
1128 ;; This is so that ange-ftp can save time by doing a no-op.
1131 done t)
1133 target dirfile)
1134 ;; Get the truename of the directory.
1136 ;; If these are equal, we have the (or a) root directory.
1138 ;; If this is the same dir we last got the truename for,
1139 ;; save time--don't recalculate.
1149 done t)
1152 done t)
1153 ;; Put it back on the file name.
1155 ;; Is the file name the name of a link?
1158 ;; Yes => chase that link, then start all over
1159 ;; since the link may point to a directory name that uses links.
1160 ;; We can't safely use expand-file-name here
1161 ;; since target might look like foo/../bar where foo
1162 ;; is itself a link. Instead, we handle . and .. above.
1165 target
1167 done nil)
1168 ;; No, we are done!
1170 filename))
1173 "Chase links in FILENAME until a name that is not a link.
1174 Unlike `file-truename', this does not check whether a parent
1175 directory name is a symbolic link.
1176 If the optional argument LIMIT is a number,
1177 it means chase no more than that many links and then stop."
1185 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1188 ;; Handle `..' by hand, since it needs to work in the
1189 ;; target of any directory symlink.
1190 ;; This code is not quite complete; it does not handle
1191 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1195 ;; Chase links in the default dir of the symlink.
1199 ;; Now find the parent of that dir.
1203 newname))
1205 ;; A handy function to display file sizes in human-readable form.
1206 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1208 "Produce a string showing FILE-SIZE in human-readable form.
1210 Optional second argument FLAVOR controls the units and the display format:
1212 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1214 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1216 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1219 1024.0
1222 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1228 "%.1f%s%s"
1230 file-size
1232 "K"
1237 "Create a temporary file.
1238 The returned file name (created by appending some random characters at the end
1239 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1240 is guaranteed to point to a newly created empty file.
1241 You can then use `write-region' to write new data into the file.
1243 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1245 If SUFFIX is non-nil, add that at the end of the file name."
1247 file)
1250 ;; Create temp files with strict access rights. It's easy to
1251 ;; loosen them later, whereas it's impossible to close the
1252 ;; time-window of loose permissions otherwise.
1260 temporary-file-directory)
1262 temporary-file-directory))))
1268 nil)
1270 ;; the file was somehow created by someone else between
1271 ;; `make-temp-name' and `write-region', let's try again.
1272 nil)
1273 file)
1274 ;; Reset the umask.
1278 "Change the encoding of FILE's name from CODING to NEW-CODING.
1279 The value is a new name of FILE.
1280 Signals a `file-already-exists' error if a file of the new name
1281 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1282 is non-nil. A number as fourth arg means request confirmation if
1283 the new name already exists. This is what happens in interactive
1284 use with M-x."
1287 default-file-name-coding-system))
1289 from-coding to-coding)
1291 ;; We provide the default coding only when it seems that
1292 ;; the filename is correctly decoded by the default
1293 ;; coding.
1299 filename default-coding)
1300 default-coding))
1304 ;; We provide the default coding only when a user is going to
1305 ;; change the encoding not from the default coding.
1309 filename from-coding)))
1312 filename from-coding default-coding)
1313 default-coding)))
1317 default-file-name-coding-system))
1318 ;; FILE should have been decoded by DEFAULT-CODING.
1322 ;; Suppress further encoding.
1327 newname))
1328 \f
1330 "Whether confirmation is requested before visiting a new file or buffer.
1331 If nil, confirmation is not requested.
1332 If the value is `after-completion', confirmation is only
1333 requested if the user called `minibuffer-complete' right before
1334 `minibuffer-complete-and-exit'.
1335 Any other non-nil value means to request confirmation.
1337 This affects commands like `switch-to-buffer' and `find-file'."
1345 "Whether to request confirmation before visiting a new file or buffer.
1346 The variable `confirm-nonexistent-file-or-buffer' determines the
1347 return value, which may be passed as the REQUIRE-MATCH arg to
1348 `read-buffer' or `find-file-read-args'."
1356 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1357 BODY should use the minibuffer at most once.
1358 Recursive uses of the minibuffer are unaffected (FUN is not
1359 called additional times).
1361 This macro actually adds an auxiliary function that calls FUN,
1362 rather than FUN itself, to `minibuffer-setup-hook'."
1368 ;; Clear out this hook so it does not interfere
1369 ;; with any recursive minibuffer usage.
1380 t))
1383 "Edit file FILENAME.
1384 Switch to a buffer visiting file FILENAME,
1385 creating one if none already exists.
1386 Interactively, the default if you just type RET is the current directory,
1387 but the visited file name is available through the minibuffer history:
1388 type M-n to pull it into the minibuffer.
1390 You can visit files on remote machines by specifying something
1391 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1392 also visit local files as a different user by specifying
1393 /sudo::FILE for the file name.
1394 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1395 manual, for more about this.
1397 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1398 expand wildcards (if any) and visit multiple files. You can
1399 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1401 To visit a file without any kind of conversion and without
1412 "Edit file FILENAME, in another window.
1415 an existing one. See the function `display-buffer'.
1417 Interactively, the default if you just type RET is the current directory,
1418 but the visited file name is available through the minibuffer history:
1419 type M-n to pull it into the minibuffer.
1421 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1422 expand wildcards (if any) and visit multiple files."
1435 "Edit file FILENAME, in another frame.
1438 an existing one. See the function `display-buffer'.
1440 Interactively, the default if you just type RET is the current directory,
1441 but the visited file name is available through the minibuffer history:
1442 type M-n to pull it into the minibuffer.
1444 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1445 expand wildcards (if any) and visit multiple files."
1458 "Edit the existing file FILENAME.
1460 file names with wildcards."
1477 value))
1480 "Edit file FILENAME but don't allow changes.
1489 "Edit file FILENAME in another window but don't allow changes.
1498 "Edit file FILENAME in another frame but don't allow changes.
1507 "Find file FILENAME as a replacement for the file in the next window.
1508 This command does not select that window.
1512 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1513 expand wildcards (if any) and replace the file with multiple files."
1524 "Find alternate file: " file-dir nil
1526 t))))
1536 "Find file FILENAME, select its buffer, kill previous buffer.
1537 If the current buffer now contains an empty file that you just visited
1538 \(presumably by mistake), use this command to visit the file you really want.
1542 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1543 expand wildcards (if any) and replace the file with multiple files.
1545 If the current buffer is an indirect buffer, or the base buffer
1546 for one or more indirect buffers, the other buffer(s) are not
1547 killed."
1556 "Find alternate file: " file-dir nil
1558 t)))
1573 ;; Run `kill-buffer-hook' here. It needs to happen before
1574 ;; variables like `buffer-file-name' etc are set to nil below,
1575 ;; because some of the hooks that could be invoked
1576 ;; (e.g., `save-place-to-alist') depend on those variables.
1577 ;;
1578 ;; Note that `kill-buffer-hook' is not what queries whether to
1579 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1580 ;; asks that itself. Thus, there's no need to temporarily do
1581 ;; `(set-buffer-modified-p nil)' before running this hook.
1583 ;; Okay, now we can end-of-life the old buffer.
1590 ;; This prevents us from finding the same buffer
1591 ;; if we specified the same file again.
1595 ;; Likewise for dired buffers.
1599 ;; This executes if find-file gets an error
1600 ;; and does not really find anything.
1601 ;; We put things back as they were.
1602 ;; If find-file actually finds something, we kill obuf below.
1611 ;; We already ran these; don't run them again.
1614 \f
1616 "Create a suitably named buffer for visiting FILENAME, and return it.
1617 FILENAME (sans directory) is used unchanged if that name is free;
1618 otherwise a string <2> or <3> or ... is appended to get an unused name.
1619 Spaces at the start of FILENAME (sans directory) are removed."
1628 "Create and return a buffer with a name based on NAME.
1629 Choose the buffer's name using `generate-new-buffer-name'."
1633 "Regexp to match the automounter prefix in a directory name."
1642 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1644 home directory is a root directory) and removes automounter prefixes
1645 \(see the variable `automount-dir-prefix')."
1646 ;; Get rid of the prefixes added by the automounter.
1653 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1654 ;; To fix this right, we need a `file-name-case-sensitive-p'
1655 ;; function, but we don't have that yet, so just guess.
1658 ;; If any elt of directory-abbrev-alist matches this name,
1659 ;; abbreviate accordingly.
1665 ;; Compute and save the abbreviated homedir name.
1666 ;; We defer computing this until the first time it's needed, to
1667 ;; give time for directory-abbrev-alist to be set properly.
1668 ;; We include a slash at the end, to avoid spurious matches
1669 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1676 ;; If FILENAME starts with the abbreviated homedir,
1677 ;; make it start with `~' instead.
1679 ;; If the home dir is just /, don't change it.
1682 ;; MS-DOS root directories can come with a drive letter;
1683 ;; Novell Netware allows drive letters beyond `Z:'.
1691 filename)))
1694 "Return the buffer visiting file FILENAME (a string).
1695 This is like `get-file-buffer', except that it checks for any buffer
1696 visiting the same file, possibly under a different name.
1697 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1698 and others are ignored.
1699 If there is no such live buffer, return nil."
1712 found)
1722 ;; Verify this buffer's file number
1723 ;; still belongs to its file.
1726 attributes)
1730 found))))
1731 \f
1733 "Non-nil means file-visiting commands should handle wildcards.
1734 For example, if you specify `*.c', that would visit all the files
1735 whose names match the pattern."
1741 "Non-nil means suppress warning messages for symlinked files.
1742 When nil, Emacs prints a warning when visiting a file that is already
1743 visited, but with a different name. Setting this option to t
1744 suppresses this warning."
1750 "Maximum size of file above which a confirmation is requested.
1751 When nil, never request confirmation."
1758 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1759 OP-TYPE specifies the file operation being performed (for message to user)."
1768 "Read file FILENAME into a buffer and return the buffer.
1769 If a buffer exists visiting FILENAME, return that one, but
1770 verify that the file has not changed since visited or saved.
1771 The buffer is not selected, just returned to the caller.
1772 Optional second arg NOWARN non-nil means suppress any warning messages.
1773 Optional third arg RAWFILE non-nil means the file is read literally.
1774 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1775 and visit all the matching files. When wildcards are actually
1776 used and expanded, return a list of buffers that are visiting
1777 the various files."
1784 'find-directory-functions
1787 filename)))
1790 find-file-wildcards
1804 ;; Find any buffer for a file which has same truename.
1806 ;; Let user know if there is a buffer with the same truename.
1810 find-file-suppress-same-file-warnings
1814 ;; Optionally also find that buffer.
1817 ;; Check to see if the file looks uncommonly large.
1821 ;; We are using an existing buffer.
1828 ;; Certain files should be reverted automatically
1829 ;; if they have changed on disk and not in the buffer.
1837 found))
1847 "File %s changed on disk. Discard your edits? "
1852 "File %s changed on disk. Discard your edits in %s? "
1860 ;; Check if a formerly read-only file has become
1861 ;; writable and vice versa, but if the buffer agrees
1862 ;; with the new state of the file, that is ok too.
1870 buffer-file-name
1879 ;; It is confusing to ask whether to visit
1880 ;; non-literally if they have the file in
1881 ;; hexl-mode or image-mode.
1887 "The file %s is already visited normally,
1888 and you have edited the buffer. Now you have asked to visit it literally,
1889 meaning no coding system handling, format conversion, or local variables.
1890 Emacs can only visit a file in one way at a time.
1892 Do you want to save the file, and visit it literally instead? "
1893 "The file %s is already visited literally,
1894 meaning no coding system handling, format conversion, or local variables.
1895 You have edited the buffer. Now you have asked to visit the file normally,
1896 but Emacs can only visit a file in one way at a time.
1903 rawfile truename number))
1907 "\
1908 Do you want to discard your changes, and visit the file literally now? "
1909 "\
1912 rawfile truename number)
1918 "The file %s is already visited normally.
1919 You have asked to visit it literally,
1920 meaning no coding system decoding, format conversion, or local variables.
1921 But Emacs can only visit a file in one way at a time.
1923 Do you want to revisit the file literally now? "
1924 "The file %s is already visited literally,
1925 meaning no coding system decoding, format conversion, or local variables.
1926 You have asked to visit it normally,
1927 but Emacs can only visit a file in one way at a time.
1932 rawfile truename number)
1935 ;; Return the buffer we are using.
1936 buf)
1937 ;; Create a new buffer.
1939 ;; find-file-noselect-1 may use a different buffer.
1941 rawfile truename number))))))
1947 ;; Needed in case we are re-visiting the file with a different
1948 ;; text representation.
1965 filename)))
1966 ;; Unconditionally set error
1976 filename)))
1977 ;; Run find-file-not-found-functions until one returns non-nil.
1979 ;; If they fail too, set error.
1981 ;; Record the file's truename, and maybe use that as visited name.
1989 ;; Set buffer's default directory to that of the file.
1991 ;; Turn off backup files for certain file names. Since
1992 ;; this is a permanent local, the major mode won't eliminate it.
2007 \f
2011 "Like `insert-file-contents', but only reads in the file literally.
2012 A buffer may be modified in several ways after reading into the buffer,
2013 to Emacs features such as format decoding, character code
2014 conversion, `find-file-hook', automatic uncompression, etc.
2016 This function ensures that none of these modifications will take place."
2023 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2024 ;; into a file operation instead!
2026 inhibit-file-name-handlers))
2033 filename)))
2034 ;; Check whether the file is uncommonly large
2045 "Insert contents of file FILENAME into buffer after point with no conversion.
2047 This function is meant for the user to run interactively.
2048 Don't call it from programs! Use `insert-file-contents-literally' instead.
2049 \(Its calling sequence is different; see its documentation)."
2054 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2055 This has the `permanent-local' property, which takes effect if you
2060 "Visit file FILENAME with no conversion of any kind.
2061 Format conversion and character code conversion are both disabled,
2062 and multibyte characters are disabled in the resulting buffer.
2063 The major mode used is Fundamental mode regardless of the file name,
2064 and local variable specifications in the file are ignored.
2065 Automatic uncompression and adding a newline at the end of the
2066 file due to `require-final-newline' is also disabled.
2068 You cannot absolutely rely on this function to result in
2069 visiting the file literally. If Emacs already has a buffer
2070 which is visiting the file, you get the existing buffer,
2071 regardless of whether it was created literally or not.
2073 In a Lisp program, if you want to be sure of accessing a file's
2074 contents literally, you should create a temporary buffer and then read
2075 the file contents into it using `insert-file-contents-literally'."
2078 "Find file literally: " nil default-directory
2081 \f
2083 _after-find-file-from-revert-buffer
2084 nomodes)
2085 "Called after finding a file and by the default revert function.
2086 Sets buffer mode, parses local variables.
2087 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2088 error in reading the file. WARN non-nil means warn if there
2089 exists an auto-save file more recent than the visited file.
2090 NOAUTO means don't mess with auto-save mode.
2091 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2092 \(see `revert-buffer-in-progress-p' for similar functionality).
2093 Fifth arg NOMODES non-nil means don't alter the file's modes.
2094 Finishes by calling the functions in `find-file-hook'
2095 unless NOMODES is non-nil."
2098 nil
2108 "Symbolic link that points to nonexistent file"
2112 ;; No need to warn if buffer is auto-saved
2113 ;; under the name of the visited file.
2115 auto-save-visited-file-name))
2118 buffer-file-name))
2138 ;; Make people do a little extra work (C-x C-q)
2139 ;; before altering a backup file.
2142 ;; When a file is marked read-only,
2143 ;; make the buffer read-only even if root is looking at it.
2151 ;; If requested, add a newline at the end of the file.
2162 view-read-only
2168 "Eval BODY and turn any error into a FORMAT message.
2169 FORMAT can have a %s escape which will be replaced with the actual error.
2170 If `debug-on-error' is set, errors are not caught, so that you can
2171 debug them.
2172 Avoid using a large BODY since it is duplicated."
2181 "Choose the major mode for this buffer automatically.
2182 Also sets up any specified local variables of the file.
2183 Uses the visited file name, the -*- line, and the local variables spec.
2185 This function is called automatically from `find-file'. In that case,
2186 we may set up the file-specified mode and local variables,
2187 depending on the value of `enable-local-variables'.
2188 In addition, if `local-enable-local-variables' is nil, we do
2189 not set local variables (though we do notice a mode specified with -*-.)
2191 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2192 or from Lisp without specifying the optional argument FIND-FILE;
2193 in that case, this function acts as if `enable-local-variables' were t."
2197 ;; FIXME this is less efficient than it could be, since both
2198 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2203 ;; Turn font lock off and on, to make sure it takes account of
2204 ;; whatever file local variables are relevant to it.
2206 ;; Font-lock-mode (now in font-core.el) can be ON when
2207 ;; font-lock.el still hasn't been loaded.
2214 "Non-nil means to try second pass through `auto-mode-alist'.
2215 This means that if the first case-sensitive search through the alist fails
2216 to find a matching major mode, a second case-insensitive search is made.
2217 On systems with case-insensitive file names, this variable is ignored,
2218 since only a single case-insensitive search through the alist is made."
2224 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2225 ;; c++-mode, java-mode and more) are added through autoload
2226 ;; directives in that file. That way is discouraged since it
2227 ;; spreads out the definition of the initial value.
2273 ;; Less common extensions come here
2274 ;; so more common ones above are found faster.
2282 ;; Besides .gdbinit, gdb documents other names to be usable for init
2283 ;; files, cross-debuggers can use something like
2284 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2285 ;; don't interfere with each other.
2317 ;; The Fortran standard does not say anything about file extensions.
2318 ;; .f90 was widely used for F90, now we seem to be trapped into
2319 ;; using a different extension for each language revision.
2320 ;; Anyway, the following extensions are supported by gfortran.
2328 ;; The list of archive file extensions should be in sync with
2329 ;; `auto-coding-alist' with `no-conversion' coding system.
2335 ;; Mailer puts message to be edited in
2336 ;; /tmp/Re.... or Message
2339 ;; some news reader is reported to use this
2350 ;; .emacs or .gnus or .viper following a directory delimiter in
2351 ;; Unix, MSDOG or VMS syntax.
2354 ;; _emacs following a directory delimiter
2355 ;; in MsDos syntax
2359 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2360 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2361 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2364 ;; .xs is also used for ld scripts, but seems to be more commonly
2365 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2367 ;; Explained in binutils ld/genscripts.sh. Eg:
2368 ;; A .x script file is the default script.
2369 ;; A .xr script is for linking without relocation (-r flag). Etc.
2373 ;; Common Lisp ASDF package system.
2380 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2392 ;; Windows candidates may be opened case sensitively on Unix
2398 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2399 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2400 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2401 ;; this has lower priority to avoid matching changelog.sgml etc.
2403 ;; either user's dot-files or under /etc or some such
2405 ;; alas not all ~/.*rc files are like this
2406 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2411 ;; this contains everything twice, with space and with colon :-(
2413 ;; Get rid of any trailing .n.m and try again.
2414 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2415 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2416 ;; Using mode nil rather than `ignore' would let the search continue
2417 ;; through this list (with the shortened name) rather than start over.
2420 ;; This should come after "in" stripping (e.g. config.h.in).
2421 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2423 ;; The following should come after the ChangeLog pattern
2424 ;; for the sake of ChangeLog.1, etc.
2425 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2427 "Alist of filename patterns vs corresponding major mode functions.
2428 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2429 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2430 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2431 mode function to use. FUNCTION will be called, unless it is nil.
2433 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2434 calling FUNCTION (if it's not nil), we delete the suffix that matched
2435 REGEXP and search the list again for another match.
2437 The extensions whose FUNCTION is `archive-mode' should also
2438 appear in `auto-coding-alist' with `no-conversion' coding system.
2440 See also `interpreter-mode-alist', which detects executable script modes
2441 based on the interpreters they specify to run,
2446 "Select Conf mode or XML mode according to start of file."
2456 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2457 ;; and pike-mode) are added through autoload directives in that
2458 ;; file. That way is discouraged since it spreads out the
2459 ;; definition of the initial value.
2499 "Alist mapping interpreter names to major modes.
2500 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2501 Each element looks like (INTERPRETER . MODE).
2502 If INTERPRETER matches the name of the interpreter specified in the first line
2503 of a script, mode MODE is enabled.
2510 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2511 ;; because we are duplicating info from auto-mode-alist.
2512 ;; TODO many elements of this list are also in auto-coding-alist.
2520 "List of regexps matching file names in which to ignore local variables.
2522 Files matching this list are typically binary file formats.
2523 They may happen to contain sequences that look like local variable
2524 specifications, but are not really, or they may be containers for
2525 member files with their own local variable sections, which are
2526 not appropriate for the containing file.
2533 "List of regexps matching suffixes to remove from file names.
2534 When checking `inhibit-local-variables-regexps', we first discard
2537 ;; TODO explicitly add case-fold-search t?
2539 "Return non-nil if file local variables should be ignored.
2540 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2541 and `inhibit-local-variables-suffixes'."
2549 sufs)
2554 temp))
2559 "Regexp matching interpreters, for file mode determination.
2560 This regular expression is matched against the first line of a file
2561 to determine the file's mode in `set-auto-mode'. If it matches, the file
2562 is assumed to be interpreted by the interpreter matched by the second group
2563 of the regular expression. The mode is then determined as the mode
2567 "Alist of buffer beginnings vs. corresponding major mode functions.
2568 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2569 After visiting a file, if REGEXP matches the text at the beginning of the
2570 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2571 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2572 major mode.
2574 If FUNCTION is nil, then it is not called. (That is a way of saying
2582 ;; The < comes before the groups (but the first) to reduce backtracking.
2583 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2584 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2588 comment-re "*"
2591 . html-mode)
2593 ;; These two must come after html, because they are more general:
2598 . sgml-mode)
2601 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2602 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2603 After visiting a file, if REGEXP matches the text at the beginning of the
2604 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2605 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2606 have not specified a mode for this file.
2612 "Upper limit on `magic-mode-alist' regexp matches.
2616 "Select major mode appropriate for current buffer.
2618 To find the right major mode, this function checks for a -*- mode tag
2619 checks for a `mode:' entry in the Local Variables section of the file,
2620 checks if it uses an interpreter listed in `interpreter-mode-alist',
2621 matches the buffer beginning against `magic-mode-alist',
2622 compares the filename against the entries in `auto-mode-alist',
2623 then matches the buffer beginning against `magic-fallback-mode-alist'.
2625 If `enable-local-variables' is nil, or if the file name matches
2626 `inhibit-local-variables-regexps', this function does not check
2627 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2628 is nil, then the only mode: tag that can be relevant is a -*- one.
2630 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2631 set the major mode only if that would change it. In other words
2632 we don't actually set it to the same mode the buffer already has."
2633 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2635 end done mode modes)
2636 ;; Once we drop the deprecated feature where mode: is also allowed to
2637 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2638 ;; remove this section and just let (hack-local-variables t) handle it.
2639 ;; Find a -*- mode tag.
2643 ;; Note by design local-enable-local-variables does not matter here.
2645 try-locals
2648 ;; Find all specifications for the `mode:' variable
2649 ;; and execute them left to right.
2661 modes)))
2662 ;; Simple -*-MODE-*- case.
2665 modes))))
2666 ;; If we found modes to use, invoke them now, outside the save-excursion.
2674 ;; continuing would call minor modes again, toggling them off
2676 ;; hack-local-variables checks local-enable-local-variables etc, but
2677 ;; we might as well be explicit here for the sake of clarity.
2679 enable-local-variables
2680 local-enable-local-variables
2681 try-locals
2688 ;; If we didn't, look for an interpreter specified in the first line.
2689 ;; As a special case, allow for things like "#!/bin/env perl", which
2690 ;; finds the interpreter anywhere in $PATH.
2697 ;; Map interpreter name to a mode, signaling we're done at the
2698 ;; same time.
2700 interpreter-mode-alist))
2701 ;; If we found an interpreter mode to use, invoke it now.
2704 ;; Next try matching the buffer beginning against magic-mode-alist.
2718 ;; Next compare the filename against the entries in auto-mode-alist.
2723 ;; Remove backup-suffixes from file name.
2725 ;; Remove remote file name identification.
2730 ;; Find first matching alist entry.
2733 ;; System is case-insensitive.
2737 ;; System is case-sensitive.
2739 ;; First match case-sensitively.
2743 ;; Fallback to case-insensitive match.
2757 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2772 ;; When `keep-mode-if-same' is set, we are working on behalf of
2773 ;; set-visited-file-name. In that case, if the major mode specified is the
2774 ;; same one we already have, don't actually reset it. We don't want to lose
2775 ;; minor modes such as Font Lock.
2777 "Apply MODE and return it.
2778 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2779 any aliases and compared to current major mode. If they are the
2780 same, do nothing and return nil."
2786 mode)))
2789 "Regexp of lines to skip when looking for file-local settings.
2790 If the first line matches this regular expression, then the -*-...-*- file-
2794 "Find the -*- spec in the buffer.
2795 Call with point at the place to start searching from.
2796 If one is found, set point to the beginning and return the position
2797 of the end. Otherwise, return nil; may change point.
2798 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2799 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2800 have no effect."
2803 ;; Don't look for -*- if this file name matches any
2804 ;; of the regexps in inhibit-local-variables-regexps.
2807 ;; If the file begins with "#!" (exec
2808 ;; interpreter magic), look for mode frobs
2809 ;; in the first two lines. You cannot
2810 ;; necessarily put them in the first line
2811 ;; of such a file without screwing up the
2812 ;; interpreter invocation. The same holds
2813 ;; for '\" in man pages (preprocessor
2814 ;; magic for the `man' program).
2825 end))))
2826 \f
2827 ;;; Handling file local variables
2831 file-local-variables-alist dir-local-variables-alist)
2836 "Normal hook run after processing a file's local variables specs.
2837 Major modes can use this to examine user-specified local variables
2841 "List variable-value pairs that are considered safe.
2842 Each element is a cons cell (VAR . VAL), where VAR is a variable
2843 symbol and VAL is a value that is considered safe."
2844 :risky t
2849 ;; This should be here at least as long as Emacs supports write-file-hooks.
2853 "Expressions that are considered safe in an `eval:' local variable.
2854 Add expressions to this list if you want Emacs to evaluate them, when
2855 they appear in an `eval' local variable specification, without first
2856 asking you for confirmation."
2857 :risky t
2862 ;; Risky local variables:
2865 buffer-auto-save-file-name
2866 buffer-file-name
2867 buffer-file-truename
2868 buffer-undo-list
2869 debugger
2870 default-text-properties
2871 eval
2872 exec-directory
2873 exec-path
2874 file-name-handler-alist
2875 frame-title-format
2876 global-mode-string
2877 header-line-format
2878 icon-title-format
2879 inhibit-quit
2880 load-path
2881 max-lisp-eval-depth
2882 max-specpdl-size
2883 minor-mode-map-alist
2884 minor-mode-overriding-map-alist
2885 mode-line-format
2886 mode-name
2887 overriding-local-map
2888 overriding-terminal-local-map
2889 process-environment
2890 standard-input
2891 standard-output
2892 unread-command-events))
2894 ;; Safe local variables:
2895 ;;
2896 ;; For variables defined by major modes, the safety declarations can go into
2897 ;; the major mode's file, since that will be loaded before file variables are
2898 ;; processed.
2899 ;;
2900 ;; For variables defined by minor modes, put the safety declarations in the
2901 ;; file defining the minor mode after the defcustom/defvar using an autoload
2902 ;; cookie, e.g.:
2903 ;;
2904 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2905 ;;
2906 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2907 ;; minor mode file may not be loaded yet.
2908 ;;
2909 ;; For variables defined in the C source code the declaration should go here:
2931 "Alist of file-local variable settings in the current buffer.
2932 Each element in this list has the form (VAR . VALUE), where VAR
2933 is a file-local variable (a symbol) and VALUE is the value
2934 specified. The actual value in the buffer may differ from VALUE,
2940 "Alist of directory-local variable settings in the current buffer.
2941 Each element in this list has the form (VAR . VALUE), where VAR
2942 is a directory-local variable (a symbol) and VALUE is the value
2943 specified in .dir-locals.el. The actual value in the buffer
2944 may differ from VALUE, if it is changed by the major or minor modes,
2949 "Normal hook run before setting file-local variables.
2950 It is called after checking for unsafe/risky variables and
2951 setting `file-local-variables-alist', and before applying the
2952 variables stored in `file-local-variables-alist'. A hook
2953 function is allowed to change the contents of this alist.
2955 This hook is called only if there is at least one file-local
2959 "Get confirmation before setting up local variable values.
2960 ALL-VARS is the list of all variables to be set up.
2961 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2962 RISKY-VARS is the list of those that are marked as risky.
2963 If these settings come from directory-local variables, then
2964 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2966 nil
2973 unsafe-vars))
2977 prompt char)
2985 ", and variables that are risky (**)."
2993 y -- to apply the local variables list.
2997 ! -- to apply the local variables list, and permanently mark these
3009 ;; Make strings with embedded whitespace easier to read.
3017 ""
3034 "Return local variables specified in the -*- line.
3035 Returns an alist of elements (VAR . VAL), where VAR is a variable
3036 and VAL is the specified value. Ignores any specification for
3037 `mode:' and `coding:' (which should have already been handled
3038 by `set-auto-mode' and `set-auto-coding', respectively).
3039 Return nil if the -*- line is malformed.
3041 If MODE-ONLY is non-nil, just returns the symbol specifying the
3042 mode, if there is one, otherwise nil."
3047 result)
3049 nil)
3051 ;; Simple form: "-*- MODENAME -*-".
3055 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3056 ;; (last ";" is optional).
3057 ;; If MODE-ONLY, just check for `mode'.
3058 ;; Otherwise, parse the -*- line into the RESULT alist.
3066 ;; There used to be a downcase here,
3067 ;; but the manual didn't say so,
3068 ;; and people want to set var names that aren't all lc.
3074 ;; It is traditional to ignore
3075 ;; case when checking for `mode' in set-auto-mode,
3076 ;; so we must do that here as well.
3077 ;; That is inconsistent, but we're stuck with it.
3078 ;; The same can be said for `coding' in set-auto-coding.
3088 ;; Downcase "Mode:".
3094 result))))))
3097 "Filter local variable settings, querying the user if necessary.
3098 VARIABLES is the alist of variable-value settings. This alist is
3099 filtered based on the values of `ignored-local-variables',
3100 `enable-local-eval', `enable-local-variables', and (if necessary)
3101 user interaction. The results are added to
3102 `file-local-variables-alist', without applying them.
3103 If these settings come from directory-local variables, then
3104 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3105 ;; Find those variables that we may want to save to
3106 ;; `safe-local-variable-values'.
3112 ;; Ignore any variable in `ignored-local-variables'.
3113 nil)
3114 ;; Obey `enable-local-eval'.
3122 ;; Ignore duplicates (except `mode') in the present list.
3124 ;; Accept known-safe variables.
3128 ;; The variable is either risky or unsafe:
3135 ;; Query, unless all vars are safe or user wants no querying.
3141 risky-vars dir-name))
3152 "Parse and put into effect this buffer's local variables spec.
3153 Uses `hack-local-variables-apply' to apply the variables.
3156 is specified, and return the corresponding mode symbol, or nil.
3157 In this case, we try to ignore minor-modes, and only return a
3158 major-mode.
3160 If `enable-local-variables' or `local-enable-local-variables' is nil,
3161 this function does nothing. If `inhibit-local-variables-regexps'
3162 applies to the file in question, the file is not scanned for
3163 local variables, but directory-local variables may still be applied."
3164 ;; We don't let inhibit-local-variables-p influence the value of
3165 ;; enable-local-variables, because then it would affect dir-local
3166 ;; variables. We don't want to search eg tar files for file local
3167 ;; variable sections, but there is no reason dir-locals cannot apply
3168 ;; to them. The real meaning of inhibit-local-variables-p is "do
3169 ;; not scan this file for local variables".
3172 result)
3176 ;; Note this is a no-op if enable-local-variables is nil.
3178 ;; This entire function is basically a no-op if enable-local-variables
3179 ;; is nil. All it does is set file-local-variables-alist to nil.
3181 ;; This part used to ignore enable-local-variables when mode-only
3182 ;; was non-nil. That was inappropriate, eg consider the
3183 ;; (artificial) example of:
3184 ;; (setq local-enable-local-variables nil)
3185 ;; Open a file foo.txt that contains "mode: sh".
3186 ;; It correctly opens in text-mode.
3187 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3189 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3190 ;; mode, then we're done, and have no need to scan further.
3192 mode-only))
3193 ;; Look for "Local variables:" line in last page.
3201 ;; suffix is what comes after "local variables:" in its line.
3202 ;; prefix is what comes before "local variables:" in its line.
3212 beg)
3216 endpos
3222 nil t))
3223 ;; This used to be an error, but really all it means is
3224 ;; that this may simply not be a local-variables section,
3225 ;; so just ignore it.
3235 ;; Discard the prefix.
3240 ;; Discard the suffix.
3250 ;; Find the variable name; strip whitespace.
3259 val val2)
3262 ;; Read the variable value.
3269 ;; Specifying minor-modes via mode: is
3270 ;; deprecated, but try to reject them anyway.
3278 'eval
3283 ;; Now we've read all the local variables.
3284 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3286 ;; Otherwise, set the variables.
3291 "Apply the elements of `file-local-variables-alist'.
3292 If there are any elements, runs `before-hack-local-variables-hook',
3293 then calls `hack-one-local-variable' to apply the alist elements one by one.
3294 Finishes by running `hack-local-variables-hook', regardless of whether
3295 the alist is empty or not.
3297 Note that this function ignores a `mode' entry if it specifies the same
3298 major mode as the buffer already has."
3300 ;; Any 'evals must run in the Right sequence.
3309 "Non-nil if SYM is safe as a file-local variable with value VAL.
3310 It is safe if any of these conditions are met:
3312 * There is a matching entry (SYM . VAL) in the
3313 `safe-local-variable-values' user option.
3315 * The `safe-local-variable' property of SYM is a function that
3316 evaluates to a non-nil value with VAL as an argument."
3320 ;; If the function signals an error, that means it
3321 ;; can't assure us that the value is safe.
3325 "Non-nil if SYM could be dangerous as a file-local variable.
3326 It is dangerous if either of these conditions are met:
3328 * Its `risky-local-variable' property is non-nil.
3334 ;; If this is an alias, check the base name.
3354 "Return t if it is safe to eval EXP when it is found in a file."
3356 ;; Detect certain `put' expressions.
3363 lisp-indent-function
3364 scheme-indent-function))
3365 ;; Only allow safe values (not functions).
3370 ;; Only allow indirect form specs.
3371 ;; During bootstrapping, edebug-basic-spec might not be
3372 ;; defined yet.
3376 ;; Allow expressions that the user requested.
3378 ;; Certain functions can be allowed with safe arguments
3379 ;; or can specify verification functions to try.
3381 ;; Allow (minor)-modes calls with no arguments.
3382 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3391 ok))
3399 ok))))))))
3402 "Set local variable VAR with value VAL.
3403 If VAR is `mode', call `VAL-mode' as a function unless it's
3404 already the major mode."
3411 ;; A minor mode must be passed an argument.
3412 ;; Otherwise, if the user enables the minor mode in a
3413 ;; major mode hook, this would toggle it off.
3419 ;; Make sure the string has no text properties.
3420 ;; Some text properties can get evaluated in various ways,
3421 ;; so it is risky to put them on with a local variable list.
3425 \f
3426 ;;; Handling directory-local variables, aka project settings.
3432 "List of cached directory roots for directory-local variable classes.
3433 Each element in this list has the form (DIR CLASS MTIME).
3434 DIR is the name of the directory.
3435 CLASS is the name of a variable class (a symbol).
3436 MTIME is the recorded modification time of the directory-local
3437 variables file associated with this entry. This time is a list
3438 of two integers (the same format as `file-attributes'), and is
3439 used to test whether the cache entry is still valid.
3440 Alternatively, MTIME can be nil, which means the entry is always
3444 "Return the variable list for CLASS."
3448 "Collect directory-local variables from MODE-VARIABLES.
3449 VARIABLES is the initial list of variables.
3450 Returns the new list."
3455 ;; If variables are specified more than once, only use the last. (Why?)
3456 ;; The pseudo-variables mode and eval are different (bug#3430).
3459 ;; Need a new cons in case we setcdr later.
3463 "Collect entries from CLASS-VARIABLES into VARIABLES.
3464 ROOT is the root directory of the project.
3465 Return the new variables list."
3468 ;; FIXME: Why not use file-relative-name?
3475 ;; Don't include this in the previous condition, because we
3476 ;; want to filter all strings before the next condition.
3490 ;; TODO someone might want to extend this to allow
3491 ;; integer values for subdir, where N means
3492 ;; variables apply to this directory and N levels
3493 ;; below it (0 == nil).
3496 alist variables))))))))
3498 ;; The file's content might be invalid (e.g. have a merge conflict), but
3499 ;; that shouldn't prevent the user from opening the file.
3501 nil))))
3504 "Declare that the DIRECTORY root is an instance of CLASS.
3505 DIRECTORY is the name of a directory, a string.
3506 CLASS is the name of a project class, a symbol.
3507 MTIME is either the modification time of the directory-local
3508 variables file that defined this class, or nil.
3510 When a file beneath DIRECTORY is visited, the mode-specific
3511 variables from CLASS are applied to the buffer. The variables
3512 for a class are defined using `dir-locals-set-class-variables'."
3519 "Map the type CLASS to a list of variable settings.
3520 CLASS is the project class, a symbol. VARIABLES is a list
3521 that declares directory-local variables for the class.
3522 An element in VARIABLES is either of the form:
3523 (MAJOR-MODE . ALIST)
3524 or
3525 (DIRECTORY . LIST)
3527 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3528 whose elements are of the form (VARIABLE . VALUE).
3530 In the second form, DIRECTORY is a directory name (a string), and
3531 LIST is a list of the form accepted by the function.
3533 When a file is visited, the file's class is found. A directory
3534 may be assigned a class using `dir-locals-set-directory-class'.
3535 Then variables are set in the file's buffer according to the
3536 VARIABLES list of the class. The list is processed in order.
3538 * If the element is of the form (MAJOR-MODE . ALIST), and the
3539 buffer's major mode is derived from MAJOR-MODE (as determined
3540 by `derived-mode-p'), then all the variables in ALIST are
3541 applied. A MAJOR-MODE of nil may be used to match any buffer.
3542 `make-local-variable' is called for each variable before it is
3543 set.
3545 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3546 is an initial substring of the file's directory, then LIST is
3547 applied by recursively following these rules."
3554 "File that contains directory-local variables.
3555 It has to be constant to enforce uniform values
3559 "Find the directory-local variables for FILE.
3560 This searches upward in the directory tree from FILE.
3561 It stops at the first directory that has been registered in
3562 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3563 If it finds an entry in the cache, it checks that it is valid.
3564 A cache entry with no modification time element (normally, one that
3565 has been assigned directly using `dir-locals-set-directory-class', not
3566 set from a file) is always valid.
3567 A cache entry based on a `dir-locals-file' is valid if the modification
3568 time stored in the cache matches the current file modification time.
3569 If not, the cache entry is cleared so that the file will be re-read.
3571 This function returns either nil (no directory local variables found),
3572 or the matching entry from `dir-locals-directory-cache' (a list),
3573 or the full path to the `dir-locals-file' (a string) in the case
3574 of no valid cache entry."
3579 dir-locals-file))
3582 ;; `locate-dominating-file' may have abbreviated the name.
3585 ;; Let dir-locals-read-from-file inform us via demoted-errors
3586 ;; about unreadable files, etc.
3587 ;; Maybe we'd want to keep searching though - that is
3588 ;; a locate-dominating-file issue.
3589 ;;; (or (not (file-readable-p locals-file))
3590 ;;; (not (file-regular-p locals-file)))
3591 ;;; (setq locals-file nil))
3592 ;; Find the best cached value in `dir-locals-directory-cache'.
3604 ;; Found a potential cache entry. Check validity.
3605 ;; A cache entry with no MTIME is assumed to always be valid
3606 ;; (ie, set directly, not from a dir-locals file).
3607 ;; Note, we don't bother to check that there is a matching class
3608 ;; element in dir-locals-class-alist, since that's done by
3609 ;; dir-locals-set-directory-class.
3616 ;; This cache entry is OK.
3617 dir-elt
3618 ;; This cache entry is invalid; clear it.
3621 ;; Return the first existing dir-locals file. Might be the same
3622 ;; as dir-elt's, might not (eg latter might have been deleted).
3623 locals-file)
3624 ;; No cache entry.
3625 locals-file)))
3628 "Load a variables FILE and register a new class and instance.
3629 FILE is the name of the file holding the variables to apply.
3630 The new class name is the same as the directory in which FILE
3631 is found. Returns the new class name."
3633 ;; This is with-demoted-errors, but we want to mention dir-locals
3634 ;; in any error message.
3646 class-name))
3650 "Non-nil means dir-local variables will be applied to remote files."
3656 "Read per-directory local variables for the current buffer.
3657 Store the directory-local variables in `dir-local-variables-alist'
3658 and `file-local-variables-alist', without applying them."
3662 default-directory)))))
3663 ;; Find the variables file.
3688 "Apply directory-local variables to a non-file buffer.
3689 For non-file buffers, such as Dired buffers, directory-local
3690 variables are looked for in `default-directory' and its parent
3691 directories."
3695 \f
3698 However, the mode will not be changed if
3699 \(1) a local variables list or the `-*-' line specifies a major mode, or
3701 \ not suitable for ordinary files, or
3702 \(3) the new file name does not particularly specify any mode."
3707 "Change name of file visited in current buffer to FILENAME.
3708 This also renames the buffer to correspond to the new file.
3709 The next time the buffer is saved it will go in the newly specified file.
3710 FILENAME nil or an empty string means mark buffer as not visiting any file.
3711 Remember to delete the initial contents of the minibuffer
3712 if you wish to pass an empty string as the argument.
3714 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3715 confirmation in the case where another buffer is already visiting FILENAME.
3717 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3718 the old visited file has been renamed to the new name FILENAME."
3726 nil
3741 filename)))
3748 buffer-file-name filename)
3752 ;; If new-name == old-name, renaming would add a spurious <2>
3753 ;; and it's considered as a feature in rename-buffer.
3759 ;; Abbreviate the file names of the buffer.
3768 nil))
3769 ;; write-file-functions is normally used for things like ftp-find-file
3770 ;; that visit things that are not local files as if they were files.
3771 ;; Changing to visit an ordinary local file instead should flush the hook.
3776 ;; If buffer was read-only because of version control,
3777 ;; that reason is gone now, so make it writable.
3781 ;; Turn off backup files for certain file names.
3782 ;; Since this is a permanent local, the major mode won't eliminate it.
3784 backup-enable-predicate
3790 ;; If auto-save was not already on, turn it on if appropriate.
3794 ;; If auto save is on, start using a new name.
3795 ;; We deliberately don't rename or delete the old auto save
3796 ;; for the old visited file name. This is because perhaps
3797 ;; the user wants to save the new state and then compare with the
3798 ;; previous state from the auto save file.
3801 ;; Rename the old auto save file if any.
3808 ;; Update the major mode, if the file name determines it.
3810 ;; Don't change the mode if it is special.
3813 ;; Don't change the mode if the local variable list specifies it.
3814 ;; The file name can influence whether the local variables apply.
3816 ;; h-l-v also checks it, but might as well be explicit.
3819 ;; TODO consider making normal-mode handle this case.
3827 "Write current buffer into file FILENAME.
3828 This makes the buffer visit that file, and marks it as not modified.
3830 If you specify just a directory name as FILENAME, that means to use
3831 the default file name but in that directory. You can also yank
3832 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3834 If the buffer is not already visiting a file, the default file name
3835 for the output file is the buffer name.
3837 If optional second arg CONFIRM is non-nil, this function
3838 asks for confirmation before overwriting an existing file.
3839 Interactively, confirmation is required unless you supply a prefix argument."
3840 ;; (interactive "FWrite file: ")
3844 nil nil nil nil)
3848 default-directory)
3849 nil nil))
3853 ;; If arg is just a directory,
3854 ;; use the default file name, but in that directory.
3865 ;; Make buffer writable if file is writable.
3870 ;; It's likely that the VC status at the new location is different from
3871 ;; the one at the old location.
3873 \f
3875 "Make a backup of the disk file visited by the current buffer, if appropriate.
3876 This is normally done before saving the buffer the first time.
3878 A backup may be done by renaming or by copying; see documentation of
3879 variable `make-backup-files'. If it's done by renaming, then the file is
3880 no longer accessible under its old name.
3882 The value is non-nil after a backup was made by renaming.
3883 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3884 MODES is the result of `file-modes' on the original
3885 file; this means that the caller, after saving the buffer, should change
3886 the modes of the new file to agree with the old modes.
3887 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3888 file; this means that the caller, after saving the buffer, should change
3889 the SELinux context of the new file to agree with the old context.
3890 BACKUPNAME is the backup file name, which is the old file renamed."
3897 backup-info backupname targets setmodes)
3898 ;; If specified name is a symbolic link, chase it to the target.
3899 ;; Thus we make the backups in the directory where the real file is.
3904 ;; (if (file-directory-p buffer-file-name)
3905 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3909 ;; If have old versions to maybe delete,
3910 ;; ask the user to confirm now, before doing anything.
3911 ;; But don't actually delete til later.
3916 real-file-name)))))
3919 ;; Actually write the back up file.
3922 ; (file-symlink-p buffer-file-name)
3923 backup-by-copying
3924 ;; Don't rename a suid or sgid file.
3939 ;; rename-file should delete old backup.
3943 ;; If trouble writing the backup, write it in
3944 ;; .emacs.d/%backup%.
3947 backupname)
3951 ;; Now delete the old versions, if desired.
3958 setmodes)
3965 ;; Create temp files with strict access rights. It's easy to
3966 ;; loosen them later, whereas it's impossible to close the
3967 ;; time-window of loose permissions otherwise.
3970 ;; Try to overwrite old backup first.
3978 nil)
3980 ;; The file was somehow created by someone else between
3981 ;; `delete-file' and `copy-file', so let's try again.
3982 ;; rms says "I think there is also a possible race
3983 ;; condition for making backup files" (emacs-devel 20070821).
3984 nil)))
3985 ;; Reset the umask.
3994 ;; The last ~[[:digit]]+ matches relative versions in git,
3995 ;; e.g. `foo.js.~HEAD~1~'.
3996 "Regular expression matching the backup/version part of a file name.
4000 "Return file NAME sans backup versions or strings.
4001 This is a separate procedure so your site-init or startup file can
4002 redefine it.
4003 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4004 we do not remove backup version numbers, only true file version numbers.
4005 See also `file-name-version-regexp'."
4012 name))))))
4015 "Return t if deleting FILE and rewriting it would preserve the owner."
4020 ;; Return t if the file doesn't exist, since it's true that no
4021 ;; information would be lost by an (attempted) delete and create.
4024 ;; Files created on Windows by Administrator (RID=500)
4025 ;; have the Administrators group (RID=544) recorded as
4026 ;; their owner. Rewriting them will still preserve the
4027 ;; owner.
4033 The extension, in a file name, is the part that follows the last `.',
4034 except that a leading `.', if any, doesn't count."
4037 directory)
4041 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4042 ;; we don't want to expand it.
4045 filename))))
4049 The extension, in a file name, is the part that follows the last `.',
4050 excluding version numbers and backup suffixes,
4051 except that a leading `.', if any, doesn't count.
4052 Return nil for extensionless file names such as `foo'.
4053 Return the empty string for file names such as `foo.'.
4055 If PERIOD is non-nil, then the returned value includes the period
4056 that delimits the extension, and if FILENAME has no extension,
4067 "Return the base name of the FILENAME: no directory, no extension.
4068 FILENAME defaults to `buffer-file-name'."
4073 "A function to use instead of the default `make-backup-file-name'.
4074 A value of nil gives the default `make-backup-file-name' behavior.
4076 This could be buffer-local to do something special for specific
4077 files. If you define it, you may need to change `backup-file-name-p'
4078 and `file-name-sans-versions' too.
4080 See also `backup-directory-alist'."
4086 "Alist of filename patterns and backup directory names.
4087 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4088 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4089 relative or absolute. If it is absolute, so that all matching files
4090 are backed up into the same directory, the file names in this
4091 directory will be the full name of the file backed up with all
4092 directory separators changed to `!' to prevent clashes. This will not
4093 work correctly if your filesystem truncates the resulting name.
4095 For the common case of all backups going into one directory, the alist
4097 directory name.
4099 If this variable is nil, or it fails to match a filename, the backup
4100 is made in the original file's directory.
4102 On MS-DOS filesystems without long names this variable is always
4103 ignored."
4109 "Default `backup-enable-predicate' function.
4110 Checks for files in `temporary-file-directory',
4111 `small-temporary-file-directory', and /tmp."
4114 ;; Directory is under temporary-file-directory.
4119 ;; Directory is under /tmp.
4124 0 nil
4126 ;; Directory is under small-temporary-file-directory.
4131 "Create the non-numeric backup file name for FILE.
4132 Normally this will just be the file's name with `~' appended.
4133 Customization hooks are provided as follows.
4135 If the variable `make-backup-file-name-function' is non-nil, its value
4136 should be a function which will be called with FILE as its argument;
4137 the resulting name is used.
4139 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4140 the documentation of that variable. If the directory for the backup
4141 doesn't exist, it is created."
4155 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4157 elt backup-directory abs-backup-directory)
4162 alist nil)))
4163 ;; If backup-directory is relative, it should be relative to the
4164 ;; file's directory. By expanding explicitly here, we avoid
4165 ;; depending on default-directory.
4174 abs-backup-directory nil))))
4176 file
4180 ;; Normalize DOSish file names: downcase the drive
4181 ;; letter, if any, and replace the leading "x:" with
4182 ;; "/drive_x".
4185 ;; Replace any invalid file-name characters (for the
4186 ;; case of backing up remote files).
4190 "drive_"
4193 ""
4196 ;; Make the name unique by substituting directory
4197 ;; separators. It may not really be worth bothering about
4198 ;; doubling `!'s in the original name...
4203 backup-directory))
4208 "Return non-nil if FILE is a backup file name (numeric or not).
4209 This is a separate function so you can redefine it for customization.
4210 You may need to redefine `file-name-sans-versions' as well."
4215 ;; This is used in various files.
4216 ;; The usage of backup-extract-version-start is not very clean,
4217 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4219 "Given the name of a numeric backup file, FN, return the backup number.
4220 Uses the free variable `backup-extract-version-start', whose value should be
4221 the index in the name where the version number begins."
4228 "Find a file name for a backup file FN, and suggestions for deletions.
4229 Value is a list whose car is the name for the backup file
4230 and whose cdr is a list of old versions to consider deleting now.
4231 If the value is nil, don't make a backup.
4232 Uses `backup-directory-alist' in the same way as does
4233 `make-backup-file-name'."
4235 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4239 ;; We don't support numbered backups on plain MS-DOS
4240 ;; when long file names are unavailable.
4250 possibilities deserve-versions-p versions)
4253 base-versions
4256 possibilities)
4257 #'<)
4262 kept-old-versions
4263 kept-new-versions
4270 ;; Delete nothing if there is overflow
4271 ;; in the number of versions to keep.
4277 v))))))))))
4280 "Return number of names file FILENAME has."
4283 ;; (defun file-relative-name (filename &optional directory)
4284 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4285 ;; This function returns a relative file name which is equivalent to FILENAME
4286 ;; when used with that default directory as the default.
4287 ;; If this is impossible (which can happen on MSDOS and Windows
4288 ;; when the file name and directory use different drive names)
4289 ;; then it returns FILENAME."
4290 ;; (save-match-data
4291 ;; (let ((fname (expand-file-name filename)))
4292 ;; (setq directory (file-name-as-directory
4293 ;; (expand-file-name (or directory default-directory))))
4294 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4295 ;; ;; drive names, they can't be relative, so return the absolute name.
4296 ;; (if (and (or (eq system-type 'ms-dos)
4297 ;; (eq system-type 'cygwin)
4298 ;; (eq system-type 'windows-nt))
4299 ;; (not (string-equal (substring fname 0 2)
4300 ;; (substring directory 0 2))))
4301 ;; filename
4302 ;; (let ((ancestor ".")
4303 ;; (fname-dir (file-name-as-directory fname)))
4304 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4305 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4306 ;; (setq directory (file-name-directory (substring directory 0 -1))
4307 ;; ancestor (if (equal ancestor ".")
4308 ;; ".."
4309 ;; (concat "../" ancestor))))
4310 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4311 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4312 ;; ;; We matched within FNAME's directory part.
4313 ;; ;; Add the rest of FNAME onto ANCESTOR.
4314 ;; (let ((rest (substring fname (match-end 0))))
4315 ;; (if (and (equal ancestor ".")
4316 ;; (not (equal rest "")))
4317 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4318 ;; rest
4319 ;; (concat (file-name-as-directory ancestor) rest)))
4320 ;; ;; We matched FNAME's directory equivalent.
4321 ;; ancestor))))))
4324 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4325 This function returns a relative file name which is equivalent to FILENAME
4326 when used with that default directory as the default.
4327 If FILENAME and DIRECTORY lie on different machines or on different drives
4328 on a DOS/Windows machine, it returns FILENAME in expanded form."
4332 default-directory))))
4337 read-file-name-completion-ignore-case)))
4340 ;; Test for different filesystems on DOS/Windows
4342 ;; Should `cygwin' really be included here? --stef
4345 ;; Test for different drive letters
4347 ;; Test for UNCs on different servers
4352 ;; Windows file names cannot have ? in
4353 ;; them, so use that to detect when
4354 ;; neither FILENAME nor DIRECTORY is a
4355 ;; UNC.
4357 0 nil
4363 ;; Test for different remote file system identification
4365 filename
4371 directory nil nil fold-case))
4373 directory nil nil fold-case))))
4376 ".."
4378 ;; Now ancestor is empty, or .., or ../.., etc.
4380 directory nil nil fold-case))
4381 ;; We matched within FILENAME's directory part.
4382 ;; Add the rest of FILENAME onto ANCESTOR.
4385 ;; But don't bother with ANCESTOR if it would give us `./'.
4386 rest
4388 ;; We matched FILENAME's directory equivalent.
4389 ancestor))))))
4390 \f
4392 "Save current buffer in visited file if modified.
4393 Variations are described below.
4395 By default, makes the previous version into a backup file
4396 if previously requested or if this is the first save.
4398 to become a backup when the next save is done.
4400 unconditionally makes the previous version into a backup file.
4402 to become a backup when the next save is done,
4403 and unconditionally makes the previous version into a backup file.
4405 With a numeric argument of 0, never make the previous version
4406 into a backup file.
4408 If a file's name is FOO, the names of its numbered backup versions are
4409 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4410 Numeric backups (rather than FOO~) will be made if value of
4411 `version-control' is not the atom `never' and either there are already
4412 numeric versions of the file being backed up, or `version-control' is
4413 non-nil.
4414 We don't want excessive versions piling up, so there are variables
4415 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4416 and `kept-new-versions', which tells how many newest versions to keep.
4417 Defaults are 2 old versions and 2 new.
4418 `dired-kept-versions' controls dired's clean-directory (.) command.
4419 If `delete-old-versions' is nil, system will query user
4420 before trimming versions. Otherwise it does it silently.
4422 If `vc-make-backup-files' is nil, which is the default,
4423 no backup files are made for files managed by version control.
4424 (This is because the version control system itself records previous versions.)
4426 See the subroutine `basic-save-buffer' for more information."
4432 ;; We used to display the message below only for files > 50KB, but
4433 ;; then Rmail-mbox never displays it due to buffer swapping. If
4434 ;; the test is ever re-introduced, be sure to handle saving of
4435 ;; Rmail files.
4442 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4443 Normally delete only if the file was written by this Emacs since
4444 the last real save, but optional arg FORCE non-nil means delete anyway."
4458 "Normal hook that is run before a buffer is saved to its file."
4464 "Normal hook that is run after a buffer is saved to its file."
4470 "If non-nil, use this coding system for saving the buffer.
4471 More precisely, use this coding system in place of the
4472 value of `buffer-file-coding-system', when saving the buffer.
4473 Calling `write-region' for any purpose other than saving the buffer
4474 will still use `buffer-file-coding-system'; this variable has no effect
4481 "Save the current buffer in its visited file, if it has been modified.
4482 The hooks `write-contents-functions' and `write-file-functions' get a chance
4483 to do the job of saving; if they do not, then the buffer is saved in
4484 the visited file in the usual way.
4485 Before and after saving the buffer, this function runs
4486 `before-save-hook' and `after-save-hook', respectively."
4489 ;; In an indirect buffer, save its base buffer instead.
4493 ;; handle the case when no modification has been made but
4494 ;; the file disappeared since visited
4498 setmodes)
4499 ;; If buffer has no file name, ask user for one.
4506 ;; Signal an error if the user specified the name of an
4507 ;; existing directory.
4510 filename))
4512 ;; Signal an error if the specified name refers to a
4513 ;; non-existing directory.
4524 "%s has changed since visited or saved. Save anyway? "
4544 ;; Support VC version backups.
4550 ;; If a hook returned t, file is already "written".
4551 ;; Otherwise, write it the usual way now.
4553 ;; Now we have saved the current buffer. Let's make sure
4554 ;; that buffer-file-coding-system is fixed to what
4555 ;; actually used for saving by binding it locally.
4567 ;; If the auto-save file was recent before this command,
4568 ;; delete it now.
4570 ;; Support VC `implicit' locking.
4575 ;; This does the "real job" of writing a buffer into its visited file
4576 ;; and making a backup file. This is what is normally done
4577 ;; but inhibited if one of write-file-functions returns non-nil.
4578 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4590 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4603 "File %s is write-protected; try to save anyway? "
4605 buffer-file-name)))
4620 ;; Write temp name, then rename it.
4621 ;; This requires write access to the containing dir,
4622 ;; which is why we don't try it if we don't have that access.
4624 tempname succeed
4627 ;; Create temp files with strict access rights. It's easy to
4628 ;; loosen them later, whereas it's impossible to close the
4629 ;; time-window of loose permissions otherwise.
4634 ;; Try various temporary names.
4635 ;; This code follows the example of make-temp-file,
4636 ;; but it calls write-region in the appropriate way
4637 ;; for saving the buffer.
4643 ;; Pass in nil&nil rather than point-min&max
4644 ;; cause we're saving the whole buffer.
4645 ;; write-region-annotate-functions may use it.
4647 tempname nil realname
4649 nil)
4651 ;; The file was somehow created by someone else between
4652 ;; `make-temp-name' and `write-region', let's try again.
4653 nil)
4655 ;; Reset the umask.
4657 ;; If we failed, restore the buffer's modtime.
4660 ;; Since we have created an entirely new file,
4661 ;; make sure it gets the right permission bits set.
4666 buffer-file-name)))
4667 ;; We succeeded in writing the temp file,
4668 ;; so rename it.
4670 ;; If file not writable, see if we can make it writable
4671 ;; temporarily while we write it.
4672 ;; But no need to do so if we have just backed it up
4673 ;; (setmodes is set) because that says we're superseding.
4675 ;; Change the mode back, after writing.
4678 buffer-file-name))
4684 ;; Pass in nil&nil rather than point-min&max to indicate
4685 ;; we're saving the buffer rather than just a region.
4686 ;; write-region-annotate-functions may make us of it.
4688 buffer-file-name nil t buffer-file-truename)
4690 ;; If we get an error writing the new file, and we made
4691 ;; the backup by renaming, undo the backing-up.
4696 setmodes))
4702 `((?\C-r
4709 ;; Return nil to ask about BUF again.
4710 nil)
4723 ;; Return nil to ask about BUF again.
4724 nil)
4734 "Save some modified file-visiting buffers. Asks user about each one.
4735 You can answer `y' to save, `n' not to save, `C-r' to look at the
4736 buffer in question with `view-buffer' before deciding or `d' to
4737 view the differences using `diff-buffer-with-file'.
4739 This command first saves any buffers where `buffer-save-without-query' is
4740 non-nil, without asking.
4742 Optional argument (the prefix) non-nil means save all with no questions.
4743 Optional second argument PRED determines which buffers are considered:
4744 If PRED is nil, all the file-visiting buffers are considered.
4745 If PRED is t, then certain non-file buffers will also be considered.
4746 If PRED is a zero-argument function, it indicates for each buffer whether
4747 to consider it or not when called with that buffer current.
4749 See `save-some-buffers-action-alist' if you want to
4750 change the additional actions you can take on files."
4754 files-done abbrevs-done)
4756 ;; First save any buffers that we're supposed to save unconditionally.
4757 ;; That way the following code won't ask about them.
4762 ;; Ask about those buffers that merit it,
4763 ;; and record the number thus saved.
4767 ;; Note that killing some buffers may kill others via
4768 ;; hooks (e.g. Rmail and its viewing buffer).
4781 t
4793 save-some-buffers-action-alist))
4794 ;; Maybe to save abbrevs, and record whether
4795 ;; we either saved them or asked to.
4802 ;; Don't keep bothering user if he says no.
4815 \f
4817 "Mark current buffer as unmodified, not needing to be saved.
4820 It is not a good idea to use this function in Lisp programs, because it
4821 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4828 "Change whether this buffer is read-only.
4829 With prefix argument ARG, make the buffer read-only if ARG is
4830 positive, otherwise make it writable. If buffer is read-only
4831 and `view-read-only' is non-nil, enter view mode.
4833 This function is usually the wrong thing to use in a Lisp program.
4834 It can have side-effects beyond changing the read-only status of a buffer
4835 \(e.g., enabling view mode), and does not affect read-only regions that
4836 are caused by text properties. To make a buffer read-only in Lisp code,
4837 set `buffer-read-only'. To ignore read-only status (whether due to text
4838 properties or buffer state) and make changes, temporarily bind
4839 `inhibit-read-only'."
4844 nil ; do nothing.
4845 ;; Toggle.
4853 ;; If view-mode is already active, `view-mode-enter' is a nop.
4864 "Insert contents of file FILENAME into buffer after point.
4865 Set mark after the inserted text.
4867 This function is meant for the user to run interactively.
4868 Don't call it from programs! Use `insert-file-contents' instead.
4869 \(Its calling sequence is different; see its documentation)."
4874 "Append the contents of the region to the end of file FILENAME.
4875 When called from a function, expects three arguments,
4876 START, END and FILENAME. START and END are normally buffer positions
4877 specifying the part of the buffer to write.
4878 If START is nil, that means to use the entire buffer contents.
4879 If START is a string, then output that string to the file
4880 instead of any buffer contents; END is ignored.
4882 This does character code conversion and applies annotations
4883 like `write-region' does."
4888 "Return most recent backup file for FILENAME or nil if no backups exist."
4889 ;; `make-backup-file-name' will get us the right directory for
4890 ;; ordinary or numeric backups. It might create a directory for
4891 ;; backups as a side-effect, according to `backup-directory-alist'.
4898 tem)
4907 newest))
4910 "Rename current buffer to a similar name not already taken.
4911 This function is useful for creating multiple shell process buffers
4912 or multiple mail buffers, etc.
4914 Note that some commands, in particular those based on `compilation-mode'
4915 \(`compile', `grep', etc.) will reuse the current buffer if it has the
4916 appropriate mode even if it has been renamed. So as well as renaming
4917 the buffer, you also need to switch buffers before running another
4918 instance of such commands."
4926 ;; If the existing buffer name has a <NNN>,
4927 ;; which isn't part of the file name (if any),
4928 ;; then get rid of that.
4934 "Create the directory DIR and optionally any nonexistent parent dirs.
4935 If DIR already exists as a directory, signal an error, unless
4936 PARENTS is non-nil.
4938 Interactively, the default choice of directory to create is the
4939 current buffer's default directory. That is useful when you have
4940 visited a file in a nonexistent directory.
4942 Noninteractively, the second (optional) argument PARENTS, if
4943 non-nil, says whether to create parent directories that don't
4944 exist. Interactively, this happens by default.
4946 If creating the directory or directories fail, an error will be
4947 raised."
4950 nil nil)
4951 t))
4952 ;; If default-directory is a remote directory,
4953 ;; make sure we find its make-directory handler.
4961 create-list)
4963 ;; If directory is its own parent, then we can't
4964 ;; keep looping forever
4979 "Delete the directory named DIRECTORY. Does not follow symlinks.
4980 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4981 TRASH non-nil means to trash the directory instead, provided
4982 `delete-by-moving-to-trash' is non-nil.
4984 When called interactively, TRASH is t if no prefix argument is
4985 given. With a prefix argument, TRASH is nil."
4992 "Move directory to trash: "
4994 default-directory default-directory nil nil))))
5000 nil)
5002 ;; If default-directory is a remote directory, make sure we find its
5003 ;; delete-directory handler.
5010 ;; Only move non-empty dir to trash if recursive deletion was
5011 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5012 ;; case, where the operation fails in delete-directory-internal.
5013 ;; As `move-file-to-trash' trashes directories (empty or
5014 ;; otherwise) as a unit, we do not need to recurse here.
5016 ;; Check if directory is empty apart from "." and "..".
5021 ;; Otherwise, call ourselves recursively if needed.
5025 ;; This test is equivalent to
5026 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5027 ;; but more efficient
5031 ;; We do not want to delete "." and "..".
5037 "Return non-nil if files FILE1 and FILE2 name the same file.
5038 If FILE1 or FILE2 does not exist, the return value is unspecified."
5049 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5051 Return nil if DIR is not an existing directory."
5073 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5074 This function always sets the file modes of the output files to match
5075 the corresponding input file.
5077 The third arg KEEP-TIME non-nil means give the output files the same
5078 last-modified time as the old ones. (This works on only some systems.)
5080 A prefix arg makes KEEP-TIME non-nil.
5082 Noninteractively, the last argument PARENTS says whether to
5083 create parent directories if they don't exist. Interactively,
5084 this happens by default.
5086 If NEWNAME names an existing directory, copy DIRECTORY as a
5087 subdirectory there. However, if called from Lisp with a non-nil
5088 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5089 directly into NEWNAME instead."
5096 default-directory default-directory nil nil)
5097 current-prefix-arg t nil)))
5100 directory newname))
5101 ;; If default-directory is a remote directory, make sure we find its
5102 ;; copy-directory handler.
5107 newname keep-time parents copy-contents)
5109 ;; Compute target name.
5114 ;; If NEWNAME is not an existing directory, create it;
5115 ;; that is where we will copy the files of DIRECTORY.
5117 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5118 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5123 newname))
5127 newname))
5130 ;; Copy recursively.
5132 ;; We do not want to copy "." and "..".
5134 directory-files-no-dot-files-regexp))
5144 ;; Set directory attributes.
5150 \f
5151 ;; At time of writing, only info uses this.
5153 "Return a copy of DIRS with all non-existent directories removed.
5154 The optional argument KEEP is a list of directories to retain even if
5155 they don't exist, and REJECT is a list of directories to remove from
5156 DIRS, even if they exist; REJECT takes precedence over KEEP.
5158 Note that membership in REJECT and KEEP is checked using simple string
5159 comparison."
5165 dirs)))
5167 \f
5170 "Function to use to revert this buffer, or nil to do the default.
5171 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5176 "Function to use to insert contents when reverting this buffer.
5177 Gets two args, first the nominal file name to use,
5178 and second, t if reading the auto-save file.
5183 "Function to check whether a non-file buffer needs reverting.
5184 This should be a function with one optional argument NOCONFIRM.
5185 Auto Revert Mode passes t for NOCONFIRM. The function should return
5186 non-nil if the buffer should be reverted. A return value of
5187 `fast' means that the need for reverting was not checked, but
5188 that reverting the buffer is fast. The buffer is current when
5189 this function is called.
5191 The idea behind the NOCONFIRM argument is that it should be
5192 non-nil if the buffer is going to be reverted without asking the
5193 user. In such situations, one has to be careful with potentially
5194 time consuming operations.
5196 For more information on how this variable is used by Auto Revert mode,
5200 "Normal hook for `revert-buffer' to run before reverting.
5201 If `revert-buffer-function' is used to override the normal revert
5205 "Normal hook for `revert-buffer' to run after reverting.
5206 Note that the hook value that it runs is the value that was in effect
5207 before reverting; that makes a difference if you have buffer-local
5208 hook functions.
5210 If `revert-buffer-function' is used to override the normal revert
5214 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5220 "Replace current buffer text with the text of the visited file on disk.
5221 This undoes all changes since the file was visited or saved.
5222 With a prefix argument, offer to revert from latest auto-save file, if
5223 that is more recent than the visited file.
5225 This command also implements an interface for special buffers
5226 that contain text which doesn't come from a file, but reflects
5227 some other data instead (e.g. Dired buffers, `buffer-list'
5228 buffers). This is done via the variable `revert-buffer-function'.
5229 In these cases, it should reconstruct the buffer contents from the
5230 appropriate data.
5232 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5233 to revert from the auto-save file when this is nil. Note that the
5234 sense of this argument is the reverse of the prefix argument, for the
5235 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5236 to nil.
5238 Optional second argument NOCONFIRM means don't ask for confirmation
5239 at all. (The variable `revert-without-query' offers another way to
5240 revert buffers without querying for confirmation.)
5242 Optional third argument PRESERVE-MODES non-nil means don't alter
5243 the files modes. Normally we reinitialize them using `normal-mode'.
5245 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5247 If the value of `revert-buffer-function' is non-nil, it is called to
5248 do all the work for this command. Otherwise, the hooks
5249 `before-revert-hook' and `after-revert-hook' are run at the beginning
5250 and the end, and if `revert-buffer-insert-file-contents-function' is
5251 non-nil, it is called instead of rereading visited file contents."
5253 ;; I admit it's odd to reverse the sense of the prefix argument, but
5254 ;; there is a lot of code out there which assumes that the first
5255 ;; argument should be t to avoid consulting the auto-save file, and
5256 ;; there's no straightforward way to encourage authors to notice a
5257 ;; reversal of the argument sense. So I'm just changing the user
5258 ;; interface, but leaving the programmatic interface the same.
5268 buffer-auto-save-file-name
5273 buffer-auto-save-file-name
5274 buffer-file-name)))
5284 file-name)))
5286 ;; If file was backed up but has changed since,
5287 ;; we should make another backup.
5291 ;; Effectively copy the after-revert-hook status,
5292 ;; since after-find-file will clobber it.
5295 after-revert-hook))
5300 ;; Get rid of all undo records for this buffer.
5302 ;; Don't make undo records for the reversion.
5305 file-name auto-save-p)))
5308 "File %s no longer exists!"
5310 file-name))
5313 "File %s no longer readable!"
5315 file-name))
5317 ;; Bind buffer-file-name to nil
5318 ;; so that we don't try to lock the file.
5324 ;; Auto-saved file should be read by Emacs's
5325 ;; internal coding.
5329 buffer-file-coding-system-explicit
5332 coding-system-for-read
5334 coding-system-for-read)
5336 ;; As a coding system suitable for multibyte
5337 ;; buffer is specified, make the current
5338 ;; buffer multibyte.
5341 ;; This force after-insert-file-set-coding
5342 ;; (called from insert-file-contents) to set
5343 ;; buffer-file-coding-system to a proper value.
5346 ;; Note that this preserves point in an intelligent way.
5350 nil nil t))
5352 nil nil t)))))
5353 ;; Recompute the truename in case changes in symlinks
5354 ;; have changed the truename.
5358 ;; Run after-revert-hook as it was before we reverted.
5362 local-hook)
5365 t))))))
5368 "Recover the visited file--get contents from its last auto-save file."
5373 "Visit file FILE, but get contents from its last auto-save file."
5374 ;; Actually putting the file name in the minibuffer should be used
5375 ;; only rarely.
5376 ;; Not just because users often use the default.
5396 ;; Use insert-directory-safely, not insert-directory,
5397 ;; because these files might not exist. In particular,
5398 ;; FILE might not exist if the auto-save file was for
5399 ;; a buffer that didn't visit a file, such as "*mail*".
5400 ;; The code in v20.x called `ls' directly, so we need
5401 ;; to emulate what `ls' did in that case.
5407 ;; Keep the current buffer-file-coding-system.
5409 ;; Auto-saved file should be read with special coding.
5418 "Recover auto save files from a previous Emacs session.
5419 This command first displays a Dired buffer showing you the
5420 previous sessions that you could recover from.
5421 To choose one, move point to the proper line and then type C-c C-c.
5422 Then you'll be asked about a number of files to recover."
5432 auto-save-list-file-prefix)))
5433 t)
5442 ;; Each line starts with a space
5443 ;; so that Font Lock mode won't highlight the first character.
5452 "Choose one saved session to recover auto-save files from.
5453 This command is used in the special Dired buffer created by
5456 ;; Get the name of the session file to recover from.
5458 files
5464 ;; Read in the auto-save-list file.
5467 ;; Loop thru the text of that file
5468 ;; and get out the names of the files to recover.
5472 ;; This is a pair of lines for a non-file-visiting buffer.
5473 ;; Get the auto-save file name and manufacture
5474 ;; a "visited file name" from that.
5477 ;; If there is no auto-save file name, the
5478 ;; auto-save-list file is probably corrupted.
5491 ;; This pair of lines is a file-visiting
5492 ;; buffer. Use the visited file name.
5502 ;; Ignore a file if its auto-save file does not exist now.
5506 ;; The file contains a pair of line for each auto-saved buffer.
5507 ;; The first line of the pair contains the visited file name
5508 ;; or is empty if the buffer was not visiting a file.
5509 ;; The second line is the auto-save file name.
5517 files
5523 "Kill BUFFER if confirmed."
5531 "Kill some buffers. Asks the user whether to kill each one of them.
5532 Non-interactively, if optional argument LIST is non-nil, it
5533 specifies the list of buffers to kill, asking for approval for each one."
5541 ; if we killed the base buffer.
5548 "Kill buffers whose name matches the specified REGEXP.
5549 The optional second argument indicates whether to kill internal buffers too."
5558 \f
5560 "Adjust current buffer's auto save file name for current conditions.
5561 Also rename any existing auto save file, if it was made in this session."
5573 "Return file name to use for auto-saves of current buffer.
5574 Does not consider `auto-save-visited-file-name' as that variable is checked
5575 before calling this function. You can redefine this for customization.
5576 See also `auto-save-file-name-p'."
5584 result uniq)
5585 ;; Apply user-specified translations
5586 ;; to the file name.
5590 filename)
5600 filename))))
5605 ;; We truncate the file name to DOS 8+3 limits
5606 ;; before doing anything else, because the regexp
5607 ;; passed to string-match below cannot handle
5608 ;; extensions longer than 3 characters, multiple
5609 ;; dots, and other atrocities.
5614 fn)
5619 "#"
5622 ;; Make sure auto-save file names don't contain characters
5623 ;; invalid for the underlying filesystem.
5625 ;; Don't modify remote (ange-ftp) filenames
5628 result))))
5630 ;; Deal with buffers that don't have any associated files. (Mail
5631 ;; mode tends to create a good number of these.)
5635 file-name)
5636 ;; Restrict the characters used in the file name to those which
5637 ;; are known to be safe on all filesystems, url-encoding the
5638 ;; rest.
5639 ;; We do this on all platforms, because even if we are not
5640 ;; running on DOS/Windows, the current directory may be on a
5641 ;; mounted VFAT filesystem, such as a USB memory stick.
5645 ;; For multibyte characters, this will produce more than
5646 ;; 2 hex digits, so is not true URL encoding.
5650 ;; Generate the file name.
5656 ;; Try a few alternative directories, to get one we can
5657 ;; write it.
5663 ;; Don't modify remote (ange-ftp) filenames
5665 ;; The call to convert-standard-filename is in case
5666 ;; buffer-name includes characters not allowed by the
5667 ;; DOS/Windows filesystems. make-temp-file writes to the
5668 ;; file it creates, so we must fix the file name _before_
5669 ;; make-temp-file is called.
5671 fname))
5673 ;; make-temp-file creates the file,
5674 ;; but we don't want it to exist until we do an auto-save.
5678 file-name)))
5681 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5682 FILENAME should lack slashes. You can redefine this for customization."
5684 \f
5686 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5687 The generated regexp will match a filename only if the filename
5688 matches that wildcard according to shell rules. Only wildcards known
5689 by `sh' are supported."
5691 ;; Copy the initial run of non-special characters.
5694 ;; If no special characters, we're almost done.
5698 j)
5700 result
5721 ;; Found "[^". Insert a `\0' character
5722 ;; (which cannot happen in a filename)
5723 ;; into the character class, so that `^'
5724 ;; is not the first character after `[',
5725 ;; and thus non-special in a regexp.
5730 ;; I don't think `]' can appear in a
5731 ;; character class in a wildcard, but
5732 ;; let's be general here.
5739 i
5752 ;; Shell wildcards should match the entire filename,
5753 ;; not its part. Make the regexp say so.
5755 \f
5758 "Switches for `list-directory' to pass to `ls' for brief listing."
5764 "Switches for `list-directory' to pass to `ls' for verbose listing."
5769 "Expand wildcard pattern PATTERN.
5770 This returns a list of file names which match the pattern.
5772 If PATTERN is written as an absolute file name,
5773 the values are absolute also.
5775 If PATTERN is written as a relative file name, it is interpreted
5776 relative to the current default directory, `default-directory'.
5777 The file names returned are normally also relative to the current
5778 default directory. However, if FULL is non-nil, they are absolute."
5782 ;; A list of all dirs that DIRPART specifies.
5783 ;; This can be more than one dir
5784 ;; if DIRPART contains wildcards.
5788 dirpart)))
5792 contents)
5798 ;; Filter out "." and ".."
5803 name))
5810 this-dir-contents)
5811 this-dir-contents)
5812 contents))))
5814 contents)))
5816 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5820 "Display a list of files in or matching DIRNAME, a la `ls'.
5821 DIRNAME is globbed by the shell if necessary.
5822 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5823 Actions controlled by variables `list-directory-brief-switches'
5824 and `list-directory-verbose-switches'."
5828 nil default-directory nil)
5829 pfx)))
5831 list-directory-brief-switches))
5832 buffer)
5844 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5852 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5854 PATTERN is assumed to represent a file-name wildcard suitable for the
5855 underlying filesystem. For Unix and GNU/Linux, each character from the
5857 the parts of the pattern which don't include wildcard characters are
5858 quoted with double quotes.
5861 on Windows), so PATTERN can use them to quote wildcard characters that
5862 need to be passed verbatim to shell commands."
5866 ;; DOS/Windows don't allow `"' in file names. So if the
5867 ;; argument has quotes, we can safely assume it is already
5868 ;; quoted by the caller.
5870 ;; We quote [&()#$'] in case their shell is a port of a
5871 ;; Unixy shell. We quote [,=+] because stock DOS and
5872 ;; Windows shells require that in some cases, such as
5873 ;; passing arguments to batch files that use positional
5874 ;; arguments like %1.
5876 pattern
5879 end)
5896 pattern))))
5903 "Program to get the amount of free space on a file system.
5904 We assume the output has the format of `df'.
5905 The value of this variable must be just a command name or file name;
5906 if you want to specify options, use `directory-free-space-args'.
5908 A value of nil disables this feature.
5910 If the function `file-system-info' is defined, it is always used in
5911 preference to the program given by this variable."
5917 "Options to use when running `directory-free-space-program'."
5922 "Return the amount of free space on directory DIR's file system.
5923 The return value is a string describing the amount of free
5924 space (normally, the number of free 1KB blocks).
5926 This function calls `file-system-info' if it is available, or
5927 invokes the program specified by `directory-free-space-program'
5928 and `directory-free-space-args'. If the system call or program
5929 is unsuccessful, or if DIR is a remote directory, this function
5930 returns nil."
5932 ;; Try to find the number of free blocks. Non-Posix systems don't
5933 ;; always have df, but might have an equivalent system call.
5942 ;; Avoid failure if the default directory does
5943 ;; not exist (Bug#2631, Bug#3911).
5947 nil t nil
5948 directory-free-space-args
5951 ;; Assume that the "available" column is before the
5952 ;; "capacity" column. Find the "%" and scan backward.
5956 "[[:space:]]+[^[:space:]]+%[^%]*$"
5963 ;; The following expression replaces `dired-move-to-filename-regexp'.
5967 ;; In some locales, month abbreviations are as short as 2 letters,
5968 ;; and they can be followed by ".".
5969 ;; In Breton, a month name can include a quote character.
5982 s "+"
5985 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5986 ;; omits the Kanji characters after month and day-of-month.
5987 ;; On Mac OS X 10.3, the date format in East Asian locales is
5988 ;; day-of-month digits followed by month digits.
5994 ;; The "[0-9]" below requires the previous column to end in a digit.
5995 ;; This avoids recognizing `1 may 1997' as a date in the line:
5996 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5998 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6000 ;; For non-iso date formats, we add the ".*" in order to find
6001 ;; the last possible match. This avoids recognizing
6002 ;; `jservice 10 1024' as a date in the line:
6003 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6005 ;; vc dired listings provide the state or blanks between file
6006 ;; permissions and date. The state is always surrounded by
6007 ;; parentheses:
6008 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6009 ;; This is not supported yet.
6014 "Regular expression to match up to the file name in a directory listing.
6015 The default value is designed to recognize dates and times
6020 ;; insert-directory
6021 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6022 ;; FULL-DIRECTORY-P is nil.
6023 ;; The single line of output must display FILE's name as it was
6024 ;; given, namely, an absolute path name.
6025 ;; - must insert exactly one line for each file if WILDCARD or
6026 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6027 ;; before the file lines, plus optional text after the file lines.
6028 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6029 ;; allowed.
6030 ;; File lines should display the basename.
6031 ;; - must be consistent with
6032 ;; - functions dired-move-to-filename, (these two define what a file line is)
6033 ;; dired-move-to-end-of-filename,
6034 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6035 ;; dired-insert-headerline
6036 ;; dired-after-subdir-garbage (defines what a "total" line is)
6037 ;; - variable dired-subdir-regexp
6038 ;; - may be passed "--dired" as the first argument in SWITCHES.
6039 ;; Filename handlers might have to remove this switch if their
6040 ;; "ls" command does not support it.
6042 "Insert directory listing for FILE, formatted according to SWITCHES.
6043 Leaves point after the inserted text.
6044 SWITCHES may be a string of options, or a list of strings
6045 representing individual options.
6046 Optional third arg WILDCARD means treat FILE as shell wildcard.
6047 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6048 switches do not contain `d', so that a full listing is expected.
6050 This works by running a directory listing program
6051 whose name is in the variable `insert-directory-program'.
6052 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6054 When SWITCHES contains the long `--dired' option, this function
6055 treats it specially, for the sake of dired. However, the
6056 normally equivalent short `-D' option is just passed on to
6057 `insert-directory-program', as any other option."
6058 ;; We need the directory in order to find the right handler.
6063 wildcard full-directory-p)
6066 ;; Read the actual directory using `insert-directory-program'.
6067 ;; RESULT gets the status code.
6069 ;; putting text property `dired-filename, decode one
6070 ;; bunch by one to preserve that property.
6072 ;; This is to control encoding the arguments in call-process.
6076 default-file-name-coding-system))))
6079 ;; Run ls in the directory part of the file pattern
6080 ;; using the last component as argument.
6086 ;; NB since switches is passed to the shell, be
6087 ;; careful of malicious values, eg "-l;reboot".
6088 ;; See eg dired-safe-switches-p.
6090 shell-file-name nil t nil
6091 "-c"
6093 ""
6095 insert-directory-program
6096 " -d "
6098 switches
6100 " -- "
6101 ;; Quote some characters that have
6102 ;; special meanings in shells; but
6103 ;; don't quote the wildcards--we want
6104 ;; them to be special. We also
6105 ;; currently don't quote the quoting
6106 ;; characters in case people want to
6107 ;; use them explicitly to quote
6108 ;; wildcard characters.
6110 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6111 ;; directory if FILE is a symbolic link.
6118 insert-directory-program nil t nil
6122 ;; Split the switches at any spaces so we can
6123 ;; pass separate options as separate args.
6125 ;; Avoid lossage if FILE starts with `-'.
6133 file))))))))
6135 ;; If we got "//DIRED//" in the output, it means we got a real
6136 ;; directory listing, even if `ls' returned nonzero.
6137 ;; So ignore any errors.
6150 ;; The first time ls returns an error,
6151 ;; find the version numbers of ls,
6152 ;; and set insert-directory-ls-version
6153 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6154 ;; is equal or if the info cannot be obtained.
6155 ;; (That can mean it isn't GNU ls.)
6165 comparison)
6181 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6185 ;; If `insert-directory-program' failed, signal an error.
6187 ;; Delete the error message it may have output.
6189 ;; On non-Posix systems, we cannot open a directory, so
6190 ;; don't even try, because that will always result in
6191 ;; the ubiquitous "Access denied". Instead, show the
6192 ;; command line so the user can try to guess what went wrong.
6197 insert-directory-program
6199 file result)
6200 ;; Unix. Access the file to get a suitable error.
6207 ;; The following overshoots by one line for an empty
6208 ;; directory listed with "--dired", but without "-a"
6209 ;; switch, where the ls output contains a
6210 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6211 ;; We take care of that case later.
6219 error-lines)
6220 ;; Find all the lines that are error messages,
6221 ;; and record the bounds of each one.
6228 ;; Now read the numeric positions of file names.
6235 error-lines))
6238 error-lines)))
6240 ;; End is followed by \n or by " -> ".
6242 ;; It seems that we can't trust ls's output as to
6243 ;; byte positions of filenames.
6249 ;; Take care of the case where the ls output contains a
6250 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6251 ;; and we went one line too far back (see above).
6256 ;; Now decode what read if necessary.
6258 file-name-coding-system
6259 default-file-name-coding-system
6261 coding-no-eol
6262 val pos)
6266 ;; If no coding system is specified or detection is
6267 ;; requested, detect the coding.
6281 ;; Force no eol conversion on a file name, so
6282 ;; that CR is preserved.
6290 ;; Try to insert the amount of free space.
6293 ;; First find the line to put it on.
6297 ;; Replace "total" with "used", to avoid confusion.
6303 "Convert `ls --dired' file name position value POS to a buffer position.
6304 File name position values returned in ls --dired output
6305 count only stdout; they don't count the error messages sent to stderr.
6306 So this function converts to them to real buffer positions.
6307 ERROR-LINES is a list of buffer positions of error message lines,
6308 of the form (START END)."
6312 pos)
6316 "Insert directory listing for FILE, formatted according to SWITCHES.
6318 Like `insert-directory', but if FILE does not exist, it inserts a
6319 message to that effect instead of signaling an error."
6322 ;; Simulate the message printed by `ls'.
6326 "Functions to call with no arguments to query about killing Emacs.
6327 If any of these functions returns nil, killing Emacs is canceled.
6328 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6332 "How to ask for confirmation when leaving Emacs.
6333 If nil, the default, don't ask at all. If the value is non-nil, it should
6334 be a predicate function such as `yes-or-no-p'."
6342 "Offer to save each buffer, then kill this Emacs process.
6343 With prefix ARG, silently save all file-visiting buffers without asking.
6344 If there are active processes where `process-query-on-exit-flag'
6345 returns non-nil, asks whether processes should be killed.
6346 Runs the members of `kill-emacs-query-functions' in turn and stops
6347 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6356 ;; process-list is not defined on MSDOS.
6358 active)
6367 ;; Query the user for other things, perhaps.
6374 "Offer to save each buffer, then kill the current connection.
6375 If the current frame has no client, kill Emacs itself.
6377 With prefix ARG, silently save all file-visiting buffers, then kill.
6379 If emacsclient was started with a list of filenames to edit, then
6380 only these files will be asked to be saved."
6385 \f
6386 ;; We use /: as a prefix to "quote" a file name
6387 ;; so that magic file name handlers will not apply to it.
6391 file-name-handler-alist))
6393 ;; We depend on being the last handler on the list,
6394 ;; so that anything else which does need handling
6395 ;; has been handled already.
6396 ;; So it is safe for us to inhibit *all* magic file name handlers.
6405 default-directory))
6406 ;; Get a list of the indices of the args which are file names.
6409 ;; The first six are special because they
6410 ;; return a file name. We want to include the /:
6411 ;; in the return value.
6412 ;; So just avoid stripping it in the first place.
6419 ;; `identity' means just return the first arg
6420 ;; not stripped of its quoting.
6422 ;; `add' means add "/:" to the result.
6425 ;; `unquote-then-quote' means set buffer-file-name
6426 ;; temporarily to unquoted filename.
6428 ;; List the arguments which are filenames.
6436 ;; For all other operations, treat the first argument only
6437 ;; as the file name.
6439 method
6440 ;; Copy ARGUMENTS so we can replace elements in it.
6444 ;; Strip off the /: from the file names that have it.
6452 "/"
6458 (`insert-file-contents
6464 (`unquote-then-quote
6469 \f
6470 ;; Symbolic modes and read-file-modes.
6473 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6474 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6475 Others, or All) for whom to produce the mask.
6476 The bit-mask that is returned extracts from mode bits the access rights
6477 for the specified category of users."
6485 "Convert CHAR to a numeric value of mode bits.
6486 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6487 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6494 ;; Rights relative to the previous file modes.
6505 "Convert a symbolic mode string specification to an equivalent number.
6507 WHO-MASK is the bit-mask specifying the category of users to which to
6508 apply the access permissions. See `file-modes-char-to-who'.
6509 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6510 RIGHTS request to add, remove, or set permissions based on existing ones,
6517 char-right)
6524 num-rights
6528 op char-right)))
6529 num-rights))
6532 "Convert symbolic file modes to numeric file modes.
6533 MODES is the string to convert, it should match
6535 See Info node `(coreutils)File permissions' for more information on this
6536 notation.
6537 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6538 MODES request to add, remove, or set permissions based on existing ones,
6552 num-who num-modes)
6555 num-modes)))
6558 "Read file modes in octal or symbolic notation and return its numeric value.
6559 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6560 ORIG-FILE is the name of a file on whose mode bits to base returned
6561 permissions if what user types requests to add, remove, or set permissions
6577 nil nil default)))
6583 \f
6584 ;; Trashcan handling.
6586 "Directory for `move-file-to-trash' to move files and directories to.
6587 This directory is only used when the function `system-move-file-to-trash'
6588 is not defined.
6589 Relative paths are interpreted relative to `default-directory'.
6590 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6600 "Move the file (or directory) named FILENAME to the trash.
6601 When `delete-by-moving-to-trash' is non-nil, this function is
6602 called by `delete-file' and `delete-directory' instead of
6603 deleting files outright.
6605 If the function `system-move-file-to-trash' is defined, call it
6606 with FILENAME as an argument.
6607 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6608 directory.
6609 Otherwise, trash FILENAME using the freedesktop.org conventions,
6610 like the GNOME, KDE and XFCE desktop environments. Emacs only
6614 ;; If `trash-directory' is non-nil, move the file there.
6618 trash-dir)))
6619 ;; We can't trash a parent directory of trash-directory.
6622 trash-dir filename))
6625 ;; Ensure that the trashed file-name is unique.
6632 ;; If `system-move-file-to-trash' is defined, use it.
6635 ;; Otherwise, use the freedesktop.org method, as specified at
6636 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6647 ;; Check if we have permissions to delete.
6651 ;; The trashed file cannot be the trash dir or its parent.
6654 trash-files-dir filename))
6657 trash-info-dir filename))
6659 ;; Ensure that the trash directory exists; otherwise, create it.
6670 ;; Try to move to trash with .trashinfo undo information
6675 ;; Perform url-encoding on FN. For compatibility with
6676 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6677 ;; for path separators.
6682 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6683 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6696 fn))
6701 ;; Attempt to make .trashinfo file, trying up to 5
6702 ;; times. The .trashinfo file is opened with O_EXCL,
6703 ;; as per trash-spec 0.7, even if that can be a problem
6704 ;; on old NFS versions...
6708 trash-files-dir))
6710 success info-fn)
6715 trash-info-dir))
6723 ;; Uniquify new-fn. (Some file managers do not
6724 ;; like Emacs-style backup file names---e.g. bug
6725 ;; 170956 in Konqueror bug tracker.)
6730 ;; Finally, try to move the file to the trashcan.
6734 \f
6759 ;;; files.el ends here