| blob | b1f6fe6e4c680654f50605597bce94809aa55603 |
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:
36 "Backups of edited data files."
40 "Finding files."
45 "Non-nil means delete auto-save file when a buffer is saved or killed.
47 Note that the auto-save file will not be deleted if the buffer is killed
48 when it has unsaved changes."
53 nil
54 "Alist of abbreviations for file directories.
55 A list of elements of the form (FROM . TO), each meaning to replace
56 FROM with TO when it appears in a directory name. This replacement is
57 done when setting up the default directory of a newly visited file.
59 FROM is matched against directory names anchored at the first
63 FROM and TO should be equivalent names, which refer to the
64 same directory. Do not use `~' in the TO strings;
65 they should be ordinary absolute directory names.
67 Use this feature when you have directories which you normally refer to
68 via absolute symbolic links. Make TO the name of the link, and FROM
69 the name it is linked to."
78 "Non-nil means make a backup of a file the first time it is saved.
79 This can be done by renaming the file or by copying.
81 Renaming means that Emacs renames the existing file so that it is a
82 backup file, then writes the buffer into a new file. Any other names
83 that the old file had will now refer to the backup file. The new file
84 is owned by you and its group is defaulted.
86 Copying means that Emacs copies the existing file into the backup
87 file, then writes the buffer on top of the existing file. Any other
88 names that the old file had will now refer to the new (edited) file.
89 The file's owner and group are unchanged.
91 The choice of renaming or copying is controlled by the variables
92 `backup-by-copying', `backup-by-copying-when-linked',
93 `backup-by-copying-when-mismatch' and
94 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
98 ;; Do this so that local variables based on the file name
99 ;; are not overridden by the major mode.
101 "Non-nil means don't make a backup, regardless of the other parameters.
102 This variable is intended for use by making it local to a buffer.
107 "Non-nil means always use copying to create backup files.
108 See documentation of variable `make-backup-files'."
113 "Non-nil means use copying to create backups for files with multiple names.
114 This causes the alternate names to refer to the latest version as edited.
115 This variable is relevant only if `backup-by-copying' is nil."
120 "Non-nil means create backups by copying if this preserves owner or group.
121 Renaming may still be used (subject to control of other variables)
122 when it would not result in changing the owner or group of the file;
123 that is, for files which are owned by you and whose group matches
124 the default for a new file created there by you.
125 This variable is relevant only if `backup-by-copying' is nil."
132 "Non-nil means create backups by copying to preserve a privileged owner.
133 Renaming may still be used (subject to control of other variables)
134 when it would not result in changing the owner of the file or if the owner
135 has a user id greater than the value of this variable. This is useful
136 when low-numbered uid's are used for special system users (such as root)
137 that must maintain ownership of certain files.
138 This variable is relevant only if `backup-by-copying' and
139 `backup-by-copying-when-mismatch' are nil."
144 "Predicate that looks at a file name and decides whether to make backups.
148 "Non-nil in a buffer means always offer to save buffer on exit.
149 Do so even if the buffer is not visiting a file.
150 Automatically local in all buffers."
157 "Non-nil means find a file under alternative names, in existing buffers.
158 This means if any existing buffer is visiting the file you want
159 under another name, you get the existing buffer instead of a new buffer."
164 "Non-nil means visit a file under its truename.
165 The truename of a file is found by chasing all links
166 both at the file level and at the levels of the containing directories."
172 "Specify which files should be reverted without query.
173 The value is a list of regular expressions.
174 If the file name matches one of these regular expressions,
175 then `revert-buffer' reverts the file without querying
176 if the file has changed on disk and you have not edited the buffer."
181 "The device number and file number of the file visited in the current buffer.
182 The value is a list of the form (FILENUM DEVNUM).
183 This pair of numbers uniquely identifies the file.
197 "The directory for writing small temporary files.
198 If non-nil, this directory is used instead of `temporary-file-directory'
199 by programs that create small temporary files. This is for systems that
200 have fast storage with limited space, such as a RAM disk."
205 ;; The system null device. (Should reference NULL_DEVICE from C.)
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
254 "Non-nil means when saving a file that exists under several names
255 \(i.e., has multiple hardlinks), break the hardlink associated with
256 `buffer-file-name' and write to a new file, so that the other
257 instances of the file are not affected by the save.
259 If `buffer-file-name' refers to a symlink, do not break the symlink.
261 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262 For example, if the directory in which a file is being saved is not
263 itself writable, then error instead of saving in some
264 hardlink-nonbreaking way.
266 See also `backup-by-copying' and `backup-by-copying-when-linked'."
272 "Control use of version numbers for backup files.
273 When t, make numeric backup versions unconditionally.
274 When nil, make them for files that have some already.
275 The value `never' means do not make them."
285 "When cleaning directory, number of versions to keep."
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
299 "Number of oldest versions to keep when a new numbered backup is made."
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
312 "Whether to add a newline automatically at the end of the file.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
330 "Whether to add a newline at end of file, in certain major modes.
331 Those modes set `require-final-newline' to this value when you enable them.
332 They do so because they are often used for files that are supposed
333 to end in newlines, and the question is how to arrange that.
335 A value of t means do this only when the file is about to be saved.
336 A value of `visit' means do this right after the file is visited.
337 A value of `visit-save' means do it at both of those times.
338 Any other non-nil value means ask user whether to add a newline, when saving.
340 A value of nil means do not add newlines. That is a risky choice in this
341 variable since this value is used for modes for files that ought to have
342 final newlines. So if you set this to nil, you must explicitly check and
343 add a final newline, whenever you save a file that really needs one."
353 "Non-nil says by default do auto-saving of every file-visiting buffer."
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
362 "Transforms to apply to buffer file name before making auto-save file name.
363 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
364 REGEXP is a regular expression to match against the file name.
365 If it matches, `replace-match' is used to replace the
366 matching part with REPLACEMENT.
367 If the optional element UNIQUIFY is non-nil, the auto-save file name is
368 constructed by taking the directory part of the replaced file-name,
369 concatenated with the buffer file name with all directory separators
370 changed to `!' to prevent clashes. This will not work
371 correctly if your filesystem truncates the resulting name.
373 All the transforms in the list are tried, in the order they are listed.
374 When one transform applies, its result is final;
375 no further transforms are tried.
377 The default value is set up to put the auto-save file into the
378 temporary directory (see the variable `temporary-file-directory') for
379 editing a remote file.
381 On MS-DOS filesystems without long names this variable is always
382 ignored."
390 "Non-nil means save word abbrevs too when files are saved.
391 If `silently', don't ask the user before saving."
396 "Non-nil means allow `find-file' to visit directories.
397 To visit the directory, `find-file' runs `find-directory-functions'."
402 "List of functions to try in sequence to visit a directory.
403 Each function is called with the directory name as the sole argument
404 and should return either a buffer or nil."
408 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
410 "List of functions to try in sequence to get a file name at point.
411 Each function should return either nil or a file name found at the
412 location of point in the current buffer."
416 ;;;It is not useful to make this a local variable.
417 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
421 "List of functions to be called for `find-file' on nonexistent file.
422 These functions are called as soon as the error is detected.
423 Variable `buffer-file-name' is already set up.
426 ;;;It is not useful to make this a local variable.
427 ;;;(put 'find-file-hooks 'permanent-local t)
430 "List of functions to be called after a buffer is loaded from a file.
431 The buffer's local variables (if any) will have been processed before the
432 functions are called."
440 "List of functions to be called before writing out a buffer to a file.
441 If one of them returns non-nil, the file is considered already written
442 and the rest are not called.
443 These hooks are considered to pertain to the visited file.
444 So any buffer-local binding of this variable is discarded if you change
446 change the major mode.
448 This hook is not run if any of the functions in
449 `write-contents-functions' returns non-nil. Both hooks pertain
450 to how to save a buffer to file, for instance, choosing a suitable
451 coding system and setting mode bits. (See Info
452 node `(elisp)Saving Buffers'.) To perform various checks or
464 "List of functions to be called before writing out a buffer to a file.
465 If one of them returns non-nil, the file is considered already written
466 and the rest are not called and neither are the functions in
467 `write-file-functions'.
469 This variable is meant to be used for hooks that pertain to the
470 buffer's contents, not to the particular visited file; thus,
471 `set-visited-file-name' does not clear this variable; but changing the
472 major mode does clear it.
474 For hooks that _do_ pertain to the particular visited file, use
475 `write-file-functions'. Both this variable and
476 `write-file-functions' relate to how a buffer is saved to file.
477 To perform various checks or updates before the buffer is saved,
482 "Control use of local variables in files you visit.
483 The value can be t, nil, :safe, :all, or something else.
485 A value of t means file local variables specifications are obeyed
486 if all the specified variable values are safe; if any values are
487 not safe, Emacs queries you, once, whether to set them all.
488 \(When you say yes to certain values, they are remembered as safe.)
490 :safe means set the safe variables, and ignore the rest.
491 :all means set all variables, whether safe or not.
492 (Don't set it permanently to :all.)
493 A value of nil means always ignore the file local variables.
495 Any other value means always query you once whether to set them all.
496 \(When you say yes to certain values, they are remembered as safe, but
499 This variable also controls use of major modes specified in
500 a -*- line.
503 always obeys file local variable specifications and the -*- line,
504 and ignores this variable."
505 :risky t
513 ;; This is an odd variable IMO.
514 ;; You might wonder why it is needed, when we could just do:
515 ;; (set (make-local-variable 'enable-local-variables) nil)
516 ;; These two are not precisely the same.
517 ;; Setting this variable does not cause -*- mode settings to be
518 ;; ignored, whereas setting enable-local-variables does.
519 ;; Only three places in Emacs use this variable: tar and arc modes,
520 ;; and rmail. The first two don't need it. They already use
521 ;; inhibit-local-variables-regexps, which is probably enough, and
522 ;; could also just set enable-local-variables locally to nil.
523 ;; Them setting it has the side-effect that dir-locals cannot apply to
524 ;; eg tar files (?). FIXME Is this appropriate?
525 ;; AFAICS, rmail is the only thing that needs this, and the only
526 ;; reason it uses it is for BABYL files (which are obsolete).
527 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
528 ;; to respect, so that find-file on a BABYL file will switch to
529 ;; rmail-mode automatically (this is nice, but hardly essential,
530 ;; since most people are used to explicitly running a command to
531 ;; access their mail; M-x gnus etc). Rmail files may happen to
532 ;; contain Local Variables sections in messages, which Rmail wants to
533 ;; ignore. So AFAICS the only reason this variable exists is for a
534 ;; minor convenience feature for handling of an obsolete Rmail file format.
536 "Like `enable-local-variables' but meant for buffer-local bindings.
537 The meaningful values are nil and non-nil. The default is non-nil.
538 If a major mode sets this to nil, buffer-locally, then any local
539 variables list in a file visited in that mode will be ignored.
541 This variable does not affect the use of major modes specified
546 The value can be t, nil or something else.
547 A value of t means obey `eval' variables.
548 A value of nil means ignore them; anything else means query."
549 :risky t
555 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
564 "Non-nil means buffers visiting files read-only do so in view mode.
565 In fact, this means that all read-only buffers normally have
566 View mode enabled, including buffers that are read-only because
567 you visit a file you cannot alter, and buffers you make read-only
573 "History list of file names entered in the minibuffer.
575 Maximum length of the history list is determined by the value
577 \f
580 "Provides support for ange-ftp host name completion.
581 Runs the usual ange-ftp hook, but only for completion operations."
582 ;; Having this here avoids the need to load ange-ftp when it's not
583 ;; really in use.
589 inhibit-file-name-handlers)))
597 "Convert a standard file's name to something suitable for the OS.
598 This means to guarantee valid names and perhaps to canonicalize
599 certain patterns.
601 FILENAME should be an absolute file name since the conversion rules
602 sometimes vary depending on the position in the file name. E.g. c:/foo
603 is a valid DOS file name, but c:/bar/c:/foo is not.
605 This function's standard definition is trivial; it just returns
606 the argument. However, on Windows and DOS, replace invalid
607 characters. On DOS, make sure to obey the 8.3 limitations.
608 In the native Windows build, turn Cygwin names into native names,
609 and also turn slashes into backslashes if the shell requires it (see
610 `w32-shell-dos-semantics').
612 See Info node `(elisp)Standard File Names' for more details."
617 ;; Replace invalid filename characters with !
621 name))
629 "Read directory name, prompting with PROMPT and completing in directory DIR.
630 Value is not expanded---you must call `expand-file-name' yourself.
631 Default name to DEFAULT-DIRNAME if user exits with the same
632 non-empty string that was inserted by this function.
633 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
634 or just DIR if INITIAL is nil.)
635 If the user exits with an empty minibuffer, this function returns
636 an empty string. (This can only happen if the user erased the
637 pre-inserted contents or if `insert-default-directory' is nil.)
638 Fourth arg MUSTMATCH non-nil means require existing directory's name.
639 Non-nil and non-t means also require confirmation after completion.
640 Fifth arg INITIAL specifies text to start with.
641 DIR should be an absolute directory name. It defaults to
642 the value of `default-directory'."
647 dir))
648 mustmatch initial
651 \f
653 "Show the current default directory."
658 "Value of the CDPATH environment variable, as a list.
662 "Explode a search path into a list of directory names.
663 Directories are separated by occurrences of `path-separator'
664 \(which is colon in GNU and GNU-like systems)."
665 ;; We could use split-string here.
673 nil
678 cd-list)))
681 "Change current directory to given absolute file name DIR."
682 ;; Put the name into directory syntax now,
683 ;; because otherwise expand-file-name may give some bad results.
685 ;; We used to additionally call abbreviate-file-name here, for an
686 ;; unknown reason. Problem is that most buffers are setup
687 ;; without going through cd-absolute and don't call
688 ;; abbreviate-file-name on their default-directory, so the few that
689 ;; do end up using a superficially different directory.
701 "Make DIR become the current buffer's default directory.
702 If your environment includes a `CDPATH' variable, try each one of
703 that list of directories (separated by occurrences of
704 `path-separator') when resolving a relative directory name.
705 The path separator is colon in GNU and GNU-like systems."
708 ;; FIXME: There's a subtle bug in the completion below. Seems linked
709 ;; to a fundamental difficulty of implementing `predicate' correctly.
710 ;; The manifestation is that TAB may list non-directories in the case where
711 ;; those files also correspond to valid directories (if your cd-path is (A/
712 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
713 ;; will be listed as valid completions).
714 ;; This is because `a' (listed because of A/a) is indeed a valid choice
715 ;; (which will lead to the use of B/a).
720 cd-path nil))
729 default-directory default-directory
730 t))))
740 "Load the Lisp file named FILE."
741 ;; This is a case where .elc makes a lot of sense.
748 "Search for FILENAME through PATH.
749 If found, return the absolute file name of FILENAME, with its suffixes;
750 otherwise return nil.
751 PATH should be a list of directories to look in, like the lists in
752 `exec-path' or `load-path'.
753 If SUFFIXES is non-nil, it should be a list of suffixes to append to
756 If non-nil, PREDICATE is used instead of `file-readable-p'.
758 This function will normally skip directories, so if you want it to find
759 directories, make sure the PREDICATE function returns `dir-ok' for them.
761 PREDICATE can also be an integer to pass to the `access' system call,
762 in which case file-name handlers are ignored. This usage is deprecated.
763 For compatibility, PREDICATE can also be one of the symbols
764 `executable', `readable', `writable', or `exists', or a list of
765 one or more of those symbols."
776 "Do completion for file names passed to `locate-file'."
779 ;; FIXME: maybe we should use completion-file-name-table instead,
780 ;; tho at least for `load', the arg is passed through
781 ;; substitute-in-file-name for historical reasons.
791 ;; If we have files like "foo.el" and "foo.elc", we could load one of
792 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
793 ;; preferred way. So if we list all 3, that gives a lot of redundant
794 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
795 ;; the user does want to pay attention to the extension. We try to
796 ;; diffuse this tension by stripping the suffix, except when the
797 ;; result is a single element (i.e. usually we only list "foo" unless
798 ;; it's the only remaining element in the list, in which case we do
799 ;; list "foo", "foo.elc" and "foo.el").
810 string-file dir))
815 ;; Switching from names to names+fullnames creates a non-monotonicity
816 ;; which can cause problems with things like partial-completion.
817 ;; To minimize the problem, filter out completion-regexp-list, so that
818 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
819 ;; from `names' which only matched `string' when they still had
820 ;; their suffix.
822 ;; Remove duplicates of the first element, so that we can easily check
823 ;; if `names' really only contains a single element.
826 ;; There's no more than one matching non-suffixed element, so expand
827 ;; the list by adding the suffixed elements as well.
830 string-dir names string-file pred action)))))
833 "Do completion for file names passed to `locate-file'.
834 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
837 string nil action))
842 "Regexp of directory names which stop the search in `locate-dominating-file'.
843 Any directory whose name matches this regexp will be treated like
844 a kind of root directory by `locate-dominating-file' which will stop its search
845 when it bumps into it.
846 The default regexp prevents fruitless and time-consuming attempts to find
847 special files in directories in which filenames are interpreted as hostnames,
850 ;; (defun locate-dominating-files (file regexp)
851 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
852 ;; Stop at the first parent where a matching file is found and return the list
853 ;; of files that that match in this directory."
854 ;; (catch 'found
855 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
856 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
857 ;; (let ((user nil)
858 ;; ;; Abbreviate, so as to stop when we cross ~/.
859 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
860 ;; files)
861 ;; (while (and dir
862 ;; ;; As a heuristic, we stop looking up the hierarchy of
863 ;; ;; directories as soon as we find a directory belonging to
864 ;; ;; another user. This should save us from looking in
865 ;; ;; things like /net and /afs. This assumes that all the
866 ;; ;; files inside a project belong to the same user.
867 ;; (let ((prev-user user))
868 ;; (setq user (nth 2 (file-attributes dir)))
869 ;; (or (null prev-user) (equal user prev-user))))
870 ;; (if (setq files (condition-case nil
871 ;; (directory-files dir 'full regexp 'nosort)
872 ;; (error nil)))
873 ;; (throw 'found files)
874 ;; (if (equal dir
875 ;; (setq dir (file-name-directory
876 ;; (directory-file-name dir))))
877 ;; (setq dir nil))))
878 ;; nil)))
881 "Look up the directory hierarchy from FILE for a file named NAME.
882 Stop at the first parent directory containing a file NAME,
883 and return the directory. Return nil if not found.
885 This function only tests if FILE exists. If you care about whether
886 it is readable, regular, etc., you should test the result."
887 ;; We used to use the above locate-dominating-files code, but the
888 ;; directory-files call is very costly, so we're much better off doing
889 ;; multiple calls using the code in here.
890 ;;
891 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
892 ;; `name' in /home or in /.
895 ;; `user' is not initialized outside the loop because
896 ;; `file' may not exist, so we may have to walk up part of the
897 ;; hierarchy before we find the "initial UID". Note: currently unused
898 ;; (user nil)
899 try)
902 ;; FIXME: Disabled this heuristic because it is sometimes
903 ;; inappropriate.
904 ;; As a heuristic, we stop looking up the hierarchy of
905 ;; directories as soon as we find a directory belonging
906 ;; to another user. This should save us from looking in
907 ;; things like /net and /afs. This assumes that all the
908 ;; files inside a project belong to the same user.
909 ;; (let ((prev-user user))
910 ;; (setq user (nth 2 (file-attributes file)))
911 ;; (and prev-user (not (equal user prev-user))))
913 ;; FIXME? maybe this function should (optionally?)
914 ;; use file-readable-p instead. In many cases, an unreadable
915 ;; FILE is no better than a non-existent one.
916 ;; See eg dir-locals-find-file.
922 root))
926 "Search for COMMAND in `exec-path' and return the absolute file name.
927 Return nil if COMMAND is not found anywhere in `exec-path'."
928 ;; Use 1 rather than file-executable-p to better match the behavior of
929 ;; call-process.
933 "Load the Emacs Lisp library named LIBRARY.
934 This is an interface to the function `load'. LIBRARY is searched
935 for in `load-path', both with and without `load-suffixes' (as
936 well as `load-file-rep-suffixes').
938 See Info node `(emacs)Lisp Libraries' for more details.
939 See `load-file' for a different interface to `load'."
943 load-path
948 "Test whether FILE specifies a location on a remote system.
949 A file is considered remote if accessing it is likely to
950 be slower or less reliable than accessing local files.
952 `file-remote-p' never opens a new remote connection. It can
953 only reuse a connection that is already open.
955 Return nil or a string identifying the remote connection
956 \(ideally a prefix of FILE). Return nil if FILE is a relative
957 file name.
959 When IDENTIFICATION is nil, the returned string is a complete
960 remote identifier: with components method, user, and host. The
961 components are those present in FILE, with defaults filled in for
962 any that are missing.
964 IDENTIFICATION can specify which part of the identification to
965 return. IDENTIFICATION can be the symbol `method', `user',
966 `host', or `localname'. Any other value is handled like nil and
967 means to return the complete identification. The string returned
968 for IDENTIFICATION `localname' can differ depending on whether
969 there is an existing connection.
971 If CONNECTED is non-nil, return an identification only if FILE is
972 located on a remote system and a connection is established to
973 that remote system.
975 Tip: You can use this expansion of remote identifier components
976 to derive a new remote file name from an existing one. For
982 same remote identifier as FILE but expanded; a name such as
987 nil)))
989 ;; Probably this entire variable should be obsolete now, in favor of
990 ;; something Tramp-related (?). It is not used in many places.
991 ;; It's not clear what the best file for this to be in is, but given
992 ;; it uses custom-initialize-delay, it is easier if it is preloaded
993 ;; rather than autoloaded.
995 ;; This used to try various hard-coded places for remsh, rsh, and
996 ;; rcmd, trying to guess based on location whether "rsh" was
997 ;; "restricted shell" or "remote shell", but I don't see the point
998 ;; in this day and age. Almost everyone will use ssh, and have
999 ;; whatever command they want to use in PATH.
1006 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1013 "Whether to use the remote file-name cache for read access.
1014 When `nil', never expire cached values (caution)
1015 When `t', never use the cache (safe, but may be slow)
1016 A number means use cached values for that amount of seconds since caching.
1018 The attributes of remote files are cached for better performance.
1019 If they are changed outside of Emacs's control, the cached values
1020 become invalid, and must be reread. If you are sure that nothing
1021 other than Emacs changes the files, you can set this variable to `nil'.
1023 If a remote file is checked regularly, it might be a good idea to
1024 let-bind this variable to a value less than the interval between
1025 consecutive checks. For example:
1027 (defun display-time-file-nonempty-p (file)
1028 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1029 (and (file-exists-p file)
1030 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1041 "Copy the file FILE into a temporary file on this machine.
1042 Returns the name of the local copy, or nil, if FILE is directly
1043 accessible."
1044 ;; This formerly had an optional BUFFER argument that wasn't used by
1045 ;; anything.
1049 nil)))
1052 "Return the truename of FILENAME.
1053 If FILENAME is not absolute, first expands it against `default-directory'.
1054 The truename of a file name is found by chasing symbolic links
1055 both at the level of the file and at the level of the directories
1056 containing it, until no links are left at any level.
1059 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1060 ;; COUNTER can be a cons cell whose car is the count of how many
1061 ;; more links to chase before getting an error.
1062 ;; PREV-DIRS can be a cons cell whose car is an alist
1063 ;; of truenames we've just recently computed.
1077 ;; For speed, remove the ange-ftp completion handler from the list.
1078 ;; We know it's not needed here.
1079 ;; For even more speed, do this only on the outermost call.
1086 ;; andrewi@harlequin.co.uk - none of the following code (except for
1087 ;; invoking the file-name handler) currently applies on Windows
1088 ;; (ie. there are no native symlinks), but there is an issue with
1089 ;; case differences being ignored by the OS, and short "8.3 DOS"
1090 ;; name aliases existing for all files. (The short names are not
1091 ;; reported by directory-files, but can be used to refer to files.)
1092 ;; It seems appropriate for file-truename to resolve these issues in
1093 ;; the most natural way, which on Windows is to call the function
1094 ;; `w32-long-file-name' - this returns the exact name of a file as
1095 ;; it is stored on disk (expanding short name aliases with the full
1096 ;; name in the process).
1099 ;; For file name that has a special handler, call handler.
1100 ;; This is so that ange-ftp can save time by doing a no-op.
1103 ;; If filename contains a wildcard, newname will be the old name.
1105 ;; If filename exists, use the long name. If it doesn't exist,
1106 ;; drill down until we find a directory that exists, and use
1107 ;; the long name of that, with the extra non-existent path
1108 ;; components concatenated.
1110 missing rest)
1113 ;; Include the preceding directory separator in the missing
1114 ;; part so subsequent recursion on the rest works.
1119 ""
1124 ;; If this file directly leads to a link, process that iteratively
1125 ;; so that we don't use lots of stack.
1131 ;; For file name that has a special handler, call handler.
1132 ;; This is so that ange-ftp can save time by doing a no-op.
1135 done t)
1137 target dirfile)
1138 ;; Get the truename of the directory.
1140 ;; If these are equal, we have the (or a) root directory.
1142 ;; If this is the same dir we last got the truename for,
1143 ;; save time--don't recalculate.
1153 done t)
1156 done t)
1157 ;; Put it back on the file name.
1159 ;; Is the file name the name of a link?
1162 ;; Yes => chase that link, then start all over
1163 ;; since the link may point to a directory name that uses links.
1164 ;; We can't safely use expand-file-name here
1165 ;; since target might look like foo/../bar where foo
1166 ;; is itself a link. Instead, we handle . and .. above.
1169 target
1171 done nil)
1172 ;; No, we are done!
1174 filename))
1177 "Chase links in FILENAME until a name that is not a link.
1178 Unlike `file-truename', this does not check whether a parent
1179 directory name is a symbolic link.
1180 If the optional argument LIMIT is a number,
1181 it means chase no more than that many links and then stop."
1189 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1192 ;; Handle `..' by hand, since it needs to work in the
1193 ;; target of any directory symlink.
1194 ;; This code is not quite complete; it does not handle
1195 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1199 ;; Chase links in the default dir of the symlink.
1203 ;; Now find the parent of that dir.
1207 newname))
1209 ;; A handy function to display file sizes in human-readable form.
1210 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1212 "Produce a string showing FILE-SIZE in human-readable form.
1214 Optional second argument FLAVOR controls the units and the display format:
1216 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1218 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1220 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1223 1024.0
1226 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1232 "%.1f%s%s"
1234 file-size
1236 "K"
1241 "Create a temporary file.
1242 The returned file name (created by appending some random characters at the end
1243 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1244 is guaranteed to point to a newly created empty file.
1245 You can then use `write-region' to write new data into the file.
1247 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1249 If SUFFIX is non-nil, add that at the end of the file name."
1251 file)
1254 ;; Create temp files with strict access rights. It's easy to
1255 ;; loosen them later, whereas it's impossible to close the
1256 ;; time-window of loose permissions otherwise.
1264 temporary-file-directory)
1266 temporary-file-directory))))
1272 nil)
1274 ;; the file was somehow created by someone else between
1275 ;; `make-temp-name' and `write-region', let's try again.
1276 nil)
1277 file)
1278 ;; Reset the umask.
1282 "Change the encoding of FILE's name from CODING to NEW-CODING.
1283 The value is a new name of FILE.
1284 Signals a `file-already-exists' error if a file of the new name
1285 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1286 is non-nil. A number as fourth arg means request confirmation if
1287 the new name already exists. This is what happens in interactive
1288 use with M-x."
1291 default-file-name-coding-system))
1293 from-coding to-coding)
1295 ;; We provide the default coding only when it seems that
1296 ;; the filename is correctly decoded by the default
1297 ;; coding.
1303 filename default-coding)
1304 default-coding))
1308 ;; We provide the default coding only when a user is going to
1309 ;; change the encoding not from the default coding.
1313 filename from-coding)))
1316 filename from-coding default-coding)
1317 default-coding)))
1321 default-file-name-coding-system))
1322 ;; FILE should have been decoded by DEFAULT-CODING.
1326 ;; Suppress further encoding.
1331 newname))
1332 \f
1334 "Whether confirmation is requested before visiting a new file or buffer.
1335 If nil, confirmation is not requested.
1336 If the value is `after-completion', confirmation is only
1337 requested if the user called `minibuffer-complete' right before
1338 `minibuffer-complete-and-exit'.
1339 Any other non-nil value means to request confirmation.
1341 This affects commands like `switch-to-buffer' and `find-file'."
1349 "Whether to request confirmation before visiting a new file or buffer.
1350 The variable `confirm-nonexistent-file-or-buffer' determines the
1351 return value, which may be passed as the REQUIRE-MATCH arg to
1352 `read-buffer' or `find-file-read-args'."
1360 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1361 BODY should use the minibuffer at most once.
1362 Recursive uses of the minibuffer are unaffected (FUN is not
1363 called additional times).
1365 This macro actually adds an auxiliary function that calls FUN,
1366 rather than FUN itself, to `minibuffer-setup-hook'."
1372 ;; Clear out this hook so it does not interfere
1373 ;; with any recursive minibuffer usage.
1384 t))
1387 "Edit file FILENAME.
1388 Switch to a buffer visiting file FILENAME,
1389 creating one if none already exists.
1390 Interactively, the default if you just type RET is the current directory,
1391 but the visited file name is available through the minibuffer history:
1392 type M-n to pull it into the minibuffer.
1394 You can visit files on remote machines by specifying something
1395 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1396 also visit local files as a different user by specifying
1397 /sudo::FILE for the file name.
1398 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1399 manual, for more about this.
1401 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1402 expand wildcards (if any) and visit multiple files. You can
1403 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1405 To visit a file without any kind of conversion and without
1416 "Edit file FILENAME, in another window.
1419 an existing one. See the function `display-buffer'.
1421 Interactively, the default if you just type RET is the current directory,
1422 but the visited file name is available through the minibuffer history:
1423 type M-n to pull it into the minibuffer.
1425 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1426 expand wildcards (if any) and visit multiple files."
1439 "Edit file FILENAME, in another frame.
1442 an existing one. See the function `display-buffer'.
1444 Interactively, the default if you just type RET is the current directory,
1445 but the visited file name is available through the minibuffer history:
1446 type M-n to pull it into the minibuffer.
1448 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1449 expand wildcards (if any) and visit multiple files."
1462 "Edit the existing file FILENAME.
1464 file names with wildcards."
1473 "Edit file FILENAME but don't allow changes.
1487 value))
1490 "Edit file FILENAME in another window but don't allow changes.
1504 value))
1507 "Edit file FILENAME in another frame but don't allow changes.
1521 value))
1524 "Find file FILENAME as a replacement for the file in the next window.
1525 This command does not select that window.
1529 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1530 expand wildcards (if any) and replace the file with multiple files."
1541 "Find alternate file: " file-dir nil
1543 t))))
1553 "Find file FILENAME, select its buffer, kill previous buffer.
1554 If the current buffer now contains an empty file that you just visited
1555 \(presumably by mistake), use this command to visit the file you really want.
1559 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1560 expand wildcards (if any) and replace the file with multiple files.
1562 If the current buffer is an indirect buffer, or the base buffer
1563 for one or more indirect buffers, the other buffer(s) are not
1564 killed."
1573 "Find alternate file: " file-dir nil
1575 t)))
1590 ;; Run `kill-buffer-hook' here. It needs to happen before
1591 ;; variables like `buffer-file-name' etc are set to nil below,
1592 ;; because some of the hooks that could be invoked
1593 ;; (e.g., `save-place-to-alist') depend on those variables.
1594 ;;
1595 ;; Note that `kill-buffer-hook' is not what queries whether to
1596 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1597 ;; asks that itself. Thus, there's no need to temporarily do
1598 ;; `(set-buffer-modified-p nil)' before running this hook.
1600 ;; Okay, now we can end-of-life the old buffer.
1607 ;; This prevents us from finding the same buffer
1608 ;; if we specified the same file again.
1612 ;; Likewise for dired buffers.
1616 ;; This executes if find-file gets an error
1617 ;; and does not really find anything.
1618 ;; We put things back as they were.
1619 ;; If find-file actually finds something, we kill obuf below.
1628 ;; We already ran these; don't run them again.
1631 \f
1633 "Create a suitably named buffer for visiting FILENAME, and return it.
1634 FILENAME (sans directory) is used unchanged if that name is free;
1635 otherwise a string <2> or <3> or ... is appended to get an unused name.
1636 Spaces at the start of FILENAME (sans directory) are removed."
1645 "Create and return a buffer with a name based on NAME.
1646 Choose the buffer's name using `generate-new-buffer-name'."
1650 "Regexp to match the automounter prefix in a directory name."
1659 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1661 home directory is a root directory) and removes automounter prefixes
1662 \(see the variable `automount-dir-prefix')."
1663 ;; Get rid of the prefixes added by the automounter.
1670 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1671 ;; To fix this right, we need a `file-name-case-sensitive-p'
1672 ;; function, but we don't have that yet, so just guess.
1675 ;; If any elt of directory-abbrev-alist matches this name,
1676 ;; abbreviate accordingly.
1682 ;; Compute and save the abbreviated homedir name.
1683 ;; We defer computing this until the first time it's needed, to
1684 ;; give time for directory-abbrev-alist to be set properly.
1685 ;; We include a slash at the end, to avoid spurious matches
1686 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1693 ;; If FILENAME starts with the abbreviated homedir,
1694 ;; make it start with `~' instead.
1696 ;; If the home dir is just /, don't change it.
1699 ;; MS-DOS root directories can come with a drive letter;
1700 ;; Novell Netware allows drive letters beyond `Z:'.
1708 filename)))
1711 "Return the buffer visiting file FILENAME (a string).
1712 This is like `get-file-buffer', except that it checks for any buffer
1713 visiting the same file, possibly under a different name.
1714 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1715 and others are ignored.
1716 If there is no such live buffer, return nil."
1729 found)
1739 ;; Verify this buffer's file number
1740 ;; still belongs to its file.
1743 attributes)
1747 found))))
1748 \f
1750 "Non-nil means file-visiting commands should handle wildcards.
1751 For example, if you specify `*.c', that would visit all the files
1752 whose names match the pattern."
1758 "Non-nil means suppress warning messages for symlinked files.
1759 When nil, Emacs prints a warning when visiting a file that is already
1760 visited, but with a different name. Setting this option to t
1761 suppresses this warning."
1767 "Maximum size of file above which a confirmation is requested.
1768 When nil, never request confirmation."
1775 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1776 OP-TYPE specifies the file operation being performed (for message to user)."
1785 "Read file FILENAME into a buffer and return the buffer.
1786 If a buffer exists visiting FILENAME, return that one, but
1787 verify that the file has not changed since visited or saved.
1788 The buffer is not selected, just returned to the caller.
1789 Optional second arg NOWARN non-nil means suppress any warning messages.
1790 Optional third arg RAWFILE non-nil means the file is read literally.
1791 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1792 and visit all the matching files. When wildcards are actually
1793 used and expanded, return a list of buffers that are visiting
1794 the various files."
1801 'find-directory-functions
1804 filename)))
1807 find-file-wildcards
1821 ;; Find any buffer for a file which has same truename.
1823 ;; Let user know if there is a buffer with the same truename.
1827 find-file-suppress-same-file-warnings
1831 ;; Optionally also find that buffer.
1834 ;; Check to see if the file looks uncommonly large.
1838 ;; We are using an existing buffer.
1845 ;; Certain files should be reverted automatically
1846 ;; if they have changed on disk and not in the buffer.
1854 found))
1864 "File %s changed on disk. Discard your edits? "
1869 "File %s changed on disk. Discard your edits in %s? "
1877 ;; Check if a formerly read-only file has become
1878 ;; writable and vice versa, but if the buffer agrees
1879 ;; with the new state of the file, that is ok too.
1887 buffer-file-name
1896 ;; It is confusing to ask whether to visit
1897 ;; non-literally if they have the file in
1898 ;; hexl-mode or image-mode.
1904 "The file %s is already visited normally,
1905 and you have edited the buffer. Now you have asked to visit it literally,
1906 meaning no coding system handling, format conversion, or local variables.
1907 Emacs can only visit a file in one way at a time.
1909 Do you want to save the file, and visit it literally instead? "
1910 "The file %s is already visited literally,
1911 meaning no coding system handling, format conversion, or local variables.
1912 You have edited the buffer. Now you have asked to visit the file normally,
1913 but Emacs can only visit a file in one way at a time.
1920 rawfile truename number))
1924 "\
1925 Do you want to discard your changes, and visit the file literally now? "
1926 "\
1929 rawfile truename number)
1935 "The file %s is already visited normally.
1936 You have asked to visit it literally,
1937 meaning no coding system decoding, format conversion, or local variables.
1938 But Emacs can only visit a file in one way at a time.
1940 Do you want to revisit the file literally now? "
1941 "The file %s is already visited literally,
1942 meaning no coding system decoding, format conversion, or local variables.
1943 You have asked to visit it normally,
1944 but Emacs can only visit a file in one way at a time.
1949 rawfile truename number)
1952 ;; Return the buffer we are using.
1953 buf)
1954 ;; Create a new buffer.
1956 ;; find-file-noselect-1 may use a different buffer.
1958 rawfile truename number))))))
1964 ;; Needed in case we are re-visiting the file with a different
1965 ;; text representation.
1982 filename)))
1983 ;; Unconditionally set error
1993 filename)))
1994 ;; Run find-file-not-found-functions until one returns non-nil.
1996 ;; If they fail too, set error.
1998 ;; Record the file's truename, and maybe use that as visited name.
2006 ;; Set buffer's default directory to that of the file.
2008 ;; Turn off backup files for certain file names. Since
2009 ;; this is a permanent local, the major mode won't eliminate it.
2024 \f
2026 "Like `insert-file-contents', but only reads in the file literally.
2027 A buffer may be modified in several ways after reading into the buffer,
2028 to Emacs features such as format decoding, character code
2029 conversion, `find-file-hook', automatic uncompression, etc.
2031 This function ensures that none of these modifications will take place."
2039 nil))
2042 inhibit-file-name-handlers))
2055 filename)))
2056 ;; Check whether the file is uncommonly large
2067 "Insert contents of file FILENAME into buffer after point with no conversion.
2069 This function is meant for the user to run interactively.
2070 Don't call it from programs! Use `insert-file-contents-literally' instead.
2071 \(Its calling sequence is different; see its documentation)."
2076 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2077 This has the `permanent-local' property, which takes effect if you
2082 "Visit file FILENAME with no conversion of any kind.
2083 Format conversion and character code conversion are both disabled,
2084 and multibyte characters are disabled in the resulting buffer.
2085 The major mode used is Fundamental mode regardless of the file name,
2086 and local variable specifications in the file are ignored.
2087 Automatic uncompression and adding a newline at the end of the
2088 file due to `require-final-newline' is also disabled.
2090 You cannot absolutely rely on this function to result in
2091 visiting the file literally. If Emacs already has a buffer
2092 which is visiting the file, you get the existing buffer,
2093 regardless of whether it was created literally or not.
2095 In a Lisp program, if you want to be sure of accessing a file's
2096 contents literally, you should create a temporary buffer and then read
2097 the file contents into it using `insert-file-contents-literally'."
2100 "Find file literally: " nil default-directory
2103 \f
2105 _after-find-file-from-revert-buffer
2106 nomodes)
2107 "Called after finding a file and by the default revert function.
2108 Sets buffer mode, parses local variables.
2109 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2110 error in reading the file. WARN non-nil means warn if there
2111 exists an auto-save file more recent than the visited file.
2112 NOAUTO means don't mess with auto-save mode.
2113 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2114 \(see `revert-buffer-in-progress-p' for similar functionality).
2115 Fifth arg NOMODES non-nil means don't alter the file's modes.
2116 Finishes by calling the functions in `find-file-hook'
2117 unless NOMODES is non-nil."
2120 nil
2130 "Symbolic link that points to nonexistent file"
2134 ;; No need to warn if buffer is auto-saved
2135 ;; under the name of the visited file.
2137 auto-save-visited-file-name))
2140 buffer-file-name))
2160 ;; Make people do a little extra work (C-x C-q)
2161 ;; before altering a backup file.
2164 ;; When a file is marked read-only,
2165 ;; make the buffer read-only even if root is looking at it.
2173 ;; If requested, add a newline at the end of the file.
2184 view-read-only
2190 "Eval BODY and turn any error into a FORMAT message.
2191 FORMAT can have a %s escape which will be replaced with the actual error.
2192 If `debug-on-error' is set, errors are not caught, so that you can
2193 debug them.
2194 Avoid using a large BODY since it is duplicated."
2203 "Choose the major mode for this buffer automatically.
2204 Also sets up any specified local variables of the file.
2205 Uses the visited file name, the -*- line, and the local variables spec.
2207 This function is called automatically from `find-file'. In that case,
2208 we may set up the file-specified mode and local variables,
2209 depending on the value of `enable-local-variables'.
2210 In addition, if `local-enable-local-variables' is nil, we do
2211 not set local variables (though we do notice a mode specified with -*-.)
2213 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2214 or from Lisp without specifying the optional argument FIND-FILE;
2215 in that case, this function acts as if `enable-local-variables' were t."
2219 ;; FIXME this is less efficient than it could be, since both
2220 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2225 ;; Turn font lock off and on, to make sure it takes account of
2226 ;; whatever file local variables are relevant to it.
2228 ;; Font-lock-mode (now in font-core.el) can be ON when
2229 ;; font-lock.el still hasn't been loaded.
2236 "Non-nil means to try second pass through `auto-mode-alist'.
2237 This means that if the first case-sensitive search through the alist fails
2238 to find a matching major mode, a second case-insensitive search is made.
2239 On systems with case-insensitive file names, this variable is ignored,
2240 since only a single case-insensitive search through the alist is made."
2246 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2247 ;; c++-mode, java-mode and more) are added through autoload
2248 ;; directives in that file. That way is discouraged since it
2249 ;; spreads out the definition of the initial value.
2295 ;; Less common extensions come here
2296 ;; so more common ones above are found faster.
2304 ;; Besides .gdbinit, gdb documents other names to be usable for init
2305 ;; files, cross-debuggers can use something like
2306 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2307 ;; don't interfere with each other.
2339 ;; The Fortran standard does not say anything about file extensions.
2340 ;; .f90 was widely used for F90, now we seem to be trapped into
2341 ;; using a different extension for each language revision.
2342 ;; Anyway, the following extensions are supported by gfortran.
2350 ;; The list of archive file extensions should be in sync with
2351 ;; `auto-coding-alist' with `no-conversion' coding system.
2357 ;; Mailer puts message to be edited in
2358 ;; /tmp/Re.... or Message
2361 ;; some news reader is reported to use this
2372 ;; .emacs or .gnus or .viper following a directory delimiter in
2373 ;; Unix, MSDOG or VMS syntax.
2376 ;; _emacs following a directory delimiter
2377 ;; in MsDos syntax
2381 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2382 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2383 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2386 ;; .xs is also used for ld scripts, but seems to be more commonly
2387 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2389 ;; Explained in binutils ld/genscripts.sh. Eg:
2390 ;; A .x script file is the default script.
2391 ;; A .xr script is for linking without relocation (-r flag). Etc.
2395 ;; Common Lisp ASDF package system.
2402 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2414 ;; Windows candidates may be opened case sensitively on Unix
2420 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2421 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2422 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2423 ;; this has lower priority to avoid matching changelog.sgml etc.
2425 ;; either user's dot-files or under /etc or some such
2427 ;; alas not all ~/.*rc files are like this
2428 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2433 ;; this contains everything twice, with space and with colon :-(
2435 ;; Get rid of any trailing .n.m and try again.
2436 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2437 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2438 ;; Using mode nil rather than `ignore' would let the search continue
2439 ;; through this list (with the shortened name) rather than start over.
2442 ;; This should come after "in" stripping (e.g. config.h.in).
2443 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2445 ;; The following should come after the ChangeLog pattern
2446 ;; for the sake of ChangeLog.1, etc.
2447 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2449 "Alist of filename patterns vs corresponding major mode functions.
2450 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2451 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2452 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2453 mode function to use. FUNCTION will be called, unless it is nil.
2455 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2456 calling FUNCTION (if it's not nil), we delete the suffix that matched
2457 REGEXP and search the list again for another match.
2459 The extensions whose FUNCTION is `archive-mode' should also
2460 appear in `auto-coding-alist' with `no-conversion' coding system.
2462 See also `interpreter-mode-alist', which detects executable script modes
2463 based on the interpreters they specify to run,
2468 "Select Conf mode or XML mode according to start of file."
2478 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2479 ;; and pike-mode) are added through autoload directives in that
2480 ;; file. That way is discouraged since it spreads out the
2481 ;; definition of the initial value.
2521 "Alist mapping interpreter names to major modes.
2522 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2523 Each element looks like (INTERPRETER . MODE).
2524 If INTERPRETER matches the name of the interpreter specified in the first line
2525 of a script, mode MODE is enabled.
2532 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2533 ;; because we are duplicating info from auto-mode-alist.
2534 ;; TODO many elements of this list are also in auto-coding-alist.
2542 "List of regexps matching file names in which to ignore local variables.
2544 Files matching this list are typically binary file formats.
2545 They may happen to contain sequences that look like local variable
2546 specifications, but are not really, or they may be containers for
2547 member files with their own local variable sections, which are
2548 not appropriate for the containing file.
2555 "List of regexps matching suffixes to remove from file names.
2556 When checking `inhibit-local-variables-regexps', we first discard
2559 ;; TODO explicitly add case-fold-search t?
2561 "Return non-nil if file local variables should be ignored.
2562 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2563 and `inhibit-local-variables-suffixes'."
2571 sufs)
2576 temp))
2581 "Regexp matching interpreters, for file mode determination.
2582 This regular expression is matched against the first line of a file
2583 to determine the file's mode in `set-auto-mode'. If it matches, the file
2584 is assumed to be interpreted by the interpreter matched by the second group
2585 of the regular expression. The mode is then determined as the mode
2589 "Alist of buffer beginnings vs. corresponding major mode functions.
2590 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2591 After visiting a file, if REGEXP matches the text at the beginning of the
2592 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2593 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2594 major mode.
2596 If FUNCTION is nil, then it is not called. (That is a way of saying
2604 ;; The < comes before the groups (but the first) to reduce backtracking.
2605 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2606 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2610 comment-re "*"
2613 . html-mode)
2615 ;; These two must come after html, because they are more general:
2620 . sgml-mode)
2623 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2624 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2625 After visiting a file, if REGEXP matches the text at the beginning of the
2626 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2627 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2628 have not specified a mode for this file.
2634 "Upper limit on `magic-mode-alist' regexp matches.
2638 "Select major mode appropriate for current buffer.
2640 To find the right major mode, this function checks for a -*- mode tag
2641 checks for a `mode:' entry in the Local Variables section of the file,
2642 checks if it uses an interpreter listed in `interpreter-mode-alist',
2643 matches the buffer beginning against `magic-mode-alist',
2644 compares the filename against the entries in `auto-mode-alist',
2645 then matches the buffer beginning against `magic-fallback-mode-alist'.
2647 If `enable-local-variables' is nil, or if the file name matches
2648 `inhibit-local-variables-regexps', this function does not check
2649 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2650 is nil, then the only mode: tag that can be relevant is a -*- one.
2652 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2653 set the major mode only if that would change it. In other words
2654 we don't actually set it to the same mode the buffer already has."
2655 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2657 end done mode modes)
2658 ;; Once we drop the deprecated feature where mode: is also allowed to
2659 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2660 ;; remove this section and just let (hack-local-variables t) handle it.
2661 ;; Find a -*- mode tag.
2665 ;; Note by design local-enable-local-variables does not matter here.
2667 try-locals
2670 ;; Find all specifications for the `mode:' variable
2671 ;; and execute them left to right.
2683 modes)))
2684 ;; Simple -*-MODE-*- case.
2687 modes))))
2688 ;; If we found modes to use, invoke them now, outside the save-excursion.
2696 ;; continuing would call minor modes again, toggling them off
2698 ;; hack-local-variables checks local-enable-local-variables etc, but
2699 ;; we might as well be explicit here for the sake of clarity.
2701 enable-local-variables
2702 local-enable-local-variables
2703 try-locals
2710 ;; If we didn't, look for an interpreter specified in the first line.
2711 ;; As a special case, allow for things like "#!/bin/env perl", which
2712 ;; finds the interpreter anywhere in $PATH.
2719 ;; Map interpreter name to a mode, signaling we're done at the
2720 ;; same time.
2722 interpreter-mode-alist))
2723 ;; If we found an interpreter mode to use, invoke it now.
2726 ;; Next try matching the buffer beginning against magic-mode-alist.
2740 ;; Next compare the filename against the entries in auto-mode-alist.
2745 ;; Remove backup-suffixes from file name.
2747 ;; Remove remote file name identification.
2752 ;; Find first matching alist entry.
2755 ;; System is case-insensitive.
2759 ;; System is case-sensitive.
2761 ;; First match case-sensitively.
2765 ;; Fallback to case-insensitive match.
2779 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2794 ;; When `keep-mode-if-same' is set, we are working on behalf of
2795 ;; set-visited-file-name. In that case, if the major mode specified is the
2796 ;; same one we already have, don't actually reset it. We don't want to lose
2797 ;; minor modes such as Font Lock.
2799 "Apply MODE and return it.
2800 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2801 any aliases and compared to current major mode. If they are the
2802 same, do nothing and return nil."
2808 mode)))
2811 "Regexp of lines to skip when looking for file-local settings.
2812 If the first line matches this regular expression, then the -*-...-*- file-
2816 "Find the -*- spec in the buffer.
2817 Call with point at the place to start searching from.
2818 If one is found, set point to the beginning and return the position
2819 of the end. Otherwise, return nil; may change point.
2820 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2821 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2822 have no effect."
2825 ;; Don't look for -*- if this file name matches any
2826 ;; of the regexps in inhibit-local-variables-regexps.
2829 ;; If the file begins with "#!" (exec
2830 ;; interpreter magic), look for mode frobs
2831 ;; in the first two lines. You cannot
2832 ;; necessarily put them in the first line
2833 ;; of such a file without screwing up the
2834 ;; interpreter invocation. The same holds
2835 ;; for '\" in man pages (preprocessor
2836 ;; magic for the `man' program).
2847 end))))
2848 \f
2849 ;;; Handling file local variables
2853 file-local-variables-alist dir-local-variables-alist)
2858 "Normal hook run after processing a file's local variables specs.
2859 Major modes can use this to examine user-specified local variables
2863 "List variable-value pairs that are considered safe.
2864 Each element is a cons cell (VAR . VAL), where VAR is a variable
2865 symbol and VAL is a value that is considered safe."
2866 :risky t
2871 ;; This should be here at least as long as Emacs supports write-file-hooks.
2875 "Expressions that are considered safe in an `eval:' local variable.
2876 Add expressions to this list if you want Emacs to evaluate them, when
2877 they appear in an `eval' local variable specification, without first
2878 asking you for confirmation."
2879 :risky t
2884 ;; Risky local variables:
2887 buffer-auto-save-file-name
2888 buffer-file-name
2889 buffer-file-truename
2890 buffer-undo-list
2891 debugger
2892 default-text-properties
2893 eval
2894 exec-directory
2895 exec-path
2896 file-name-handler-alist
2897 frame-title-format
2898 global-mode-string
2899 header-line-format
2900 icon-title-format
2901 inhibit-quit
2902 load-path
2903 max-lisp-eval-depth
2904 max-specpdl-size
2905 minor-mode-map-alist
2906 minor-mode-overriding-map-alist
2907 mode-line-format
2908 mode-name
2909 overriding-local-map
2910 overriding-terminal-local-map
2911 process-environment
2912 standard-input
2913 standard-output
2914 unread-command-events))
2916 ;; Safe local variables:
2917 ;;
2918 ;; For variables defined by major modes, the safety declarations can go into
2919 ;; the major mode's file, since that will be loaded before file variables are
2920 ;; processed.
2921 ;;
2922 ;; For variables defined by minor modes, put the safety declarations in the
2923 ;; file defining the minor mode after the defcustom/defvar using an autoload
2924 ;; cookie, e.g.:
2925 ;;
2926 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2927 ;;
2928 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2929 ;; minor mode file may not be loaded yet.
2930 ;;
2931 ;; For variables defined in the C source code the declaration should go here:
2953 "Alist of file-local variable settings in the current buffer.
2954 Each element in this list has the form (VAR . VALUE), where VAR
2955 is a file-local variable (a symbol) and VALUE is the value
2956 specified. The actual value in the buffer may differ from VALUE,
2962 "Alist of directory-local variable settings in the current buffer.
2963 Each element in this list has the form (VAR . VALUE), where VAR
2964 is a directory-local variable (a symbol) and VALUE is the value
2965 specified in .dir-locals.el. The actual value in the buffer
2966 may differ from VALUE, if it is changed by the major or minor modes,
2971 "Normal hook run before setting file-local variables.
2972 It is called after checking for unsafe/risky variables and
2973 setting `file-local-variables-alist', and before applying the
2974 variables stored in `file-local-variables-alist'. A hook
2975 function is allowed to change the contents of this alist.
2977 This hook is called only if there is at least one file-local
2981 "Get confirmation before setting up local variable values.
2982 ALL-VARS is the list of all variables to be set up.
2983 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2984 RISKY-VARS is the list of those that are marked as risky.
2985 If these settings come from directory-local variables, then
2986 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2988 nil
2995 unsafe-vars))
2999 prompt char)
3007 ", and variables that are risky (**)."
3015 y -- to apply the local variables list.
3019 ! -- to apply the local variables list, and permanently mark these
3031 ;; Make strings with embedded whitespace easier to read.
3039 ""
3056 "Return local variables specified in the -*- line.
3057 Returns an alist of elements (VAR . VAL), where VAR is a variable
3058 and VAL is the specified value. Ignores any specification for
3059 `mode:' and `coding:' (which should have already been handled
3060 by `set-auto-mode' and `set-auto-coding', respectively).
3061 Return nil if the -*- line is malformed.
3063 If MODE-ONLY is non-nil, just returns the symbol specifying the
3064 mode, if there is one, otherwise nil."
3069 result)
3071 nil)
3073 ;; Simple form: "-*- MODENAME -*-".
3077 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3078 ;; (last ";" is optional).
3079 ;; If MODE-ONLY, just check for `mode'.
3080 ;; Otherwise, parse the -*- line into the RESULT alist.
3088 ;; There used to be a downcase here,
3089 ;; but the manual didn't say so,
3090 ;; and people want to set var names that aren't all lc.
3096 ;; It is traditional to ignore
3097 ;; case when checking for `mode' in set-auto-mode,
3098 ;; so we must do that here as well.
3099 ;; That is inconsistent, but we're stuck with it.
3100 ;; The same can be said for `coding' in set-auto-coding.
3110 ;; Downcase "Mode:".
3116 result))))))
3119 "Filter local variable settings, querying the user if necessary.
3120 VARIABLES is the alist of variable-value settings. This alist is
3121 filtered based on the values of `ignored-local-variables',
3122 `enable-local-eval', `enable-local-variables', and (if necessary)
3123 user interaction. The results are added to
3124 `file-local-variables-alist', without applying them.
3125 If these settings come from directory-local variables, then
3126 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3127 ;; Find those variables that we may want to save to
3128 ;; `safe-local-variable-values'.
3134 ;; Ignore any variable in `ignored-local-variables'.
3135 nil)
3136 ;; Obey `enable-local-eval'.
3144 ;; Ignore duplicates (except `mode') in the present list.
3146 ;; Accept known-safe variables.
3150 ;; The variable is either risky or unsafe:
3157 ;; Query, unless all vars are safe or user wants no querying.
3163 risky-vars dir-name))
3174 "Parse and put into effect this buffer's local variables spec.
3175 Uses `hack-local-variables-apply' to apply the variables.
3178 is specified, and return the corresponding mode symbol, or nil.
3179 In this case, we try to ignore minor-modes, and only return a
3180 major-mode.
3182 If `enable-local-variables' or `local-enable-local-variables' is nil,
3183 this function does nothing. If `inhibit-local-variables-regexps'
3184 applies to the file in question, the file is not scanned for
3185 local variables, but directory-local variables may still be applied."
3186 ;; We don't let inhibit-local-variables-p influence the value of
3187 ;; enable-local-variables, because then it would affect dir-local
3188 ;; variables. We don't want to search eg tar files for file local
3189 ;; variable sections, but there is no reason dir-locals cannot apply
3190 ;; to them. The real meaning of inhibit-local-variables-p is "do
3191 ;; not scan this file for local variables".
3194 result)
3198 ;; Note this is a no-op if enable-local-variables is nil.
3200 ;; This entire function is basically a no-op if enable-local-variables
3201 ;; is nil. All it does is set file-local-variables-alist to nil.
3203 ;; This part used to ignore enable-local-variables when mode-only
3204 ;; was non-nil. That was inappropriate, eg consider the
3205 ;; (artificial) example of:
3206 ;; (setq local-enable-local-variables nil)
3207 ;; Open a file foo.txt that contains "mode: sh".
3208 ;; It correctly opens in text-mode.
3209 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3211 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3212 ;; mode, then we're done, and have no need to scan further.
3214 mode-only))
3215 ;; Look for "Local variables:" line in last page.
3223 ;; suffix is what comes after "local variables:" in its line.
3224 ;; prefix is what comes before "local variables:" in its line.
3234 beg)
3238 endpos
3244 nil t))
3245 ;; This used to be an error, but really all it means is
3246 ;; that this may simply not be a local-variables section,
3247 ;; so just ignore it.
3257 ;; Discard the prefix.
3262 ;; Discard the suffix.
3272 ;; Find the variable name; strip whitespace.
3281 val val2)
3284 ;; Read the variable value.
3291 ;; Specifying minor-modes via mode: is
3292 ;; deprecated, but try to reject them anyway.
3300 'eval
3305 ;; Now we've read all the local variables.
3306 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3308 ;; Otherwise, set the variables.
3313 "Apply the elements of `file-local-variables-alist'.
3314 If there are any elements, runs `before-hack-local-variables-hook',
3315 then calls `hack-one-local-variable' to apply the alist elements one by one.
3316 Finishes by running `hack-local-variables-hook', regardless of whether
3317 the alist is empty or not.
3319 Note that this function ignores a `mode' entry if it specifies the same
3320 major mode as the buffer already has."
3322 ;; Any 'evals must run in the Right sequence.
3331 "Non-nil if SYM is safe as a file-local variable with value VAL.
3332 It is safe if any of these conditions are met:
3334 * There is a matching entry (SYM . VAL) in the
3335 `safe-local-variable-values' user option.
3337 * The `safe-local-variable' property of SYM is a function that
3338 evaluates to a non-nil value with VAL as an argument."
3342 ;; If the function signals an error, that means it
3343 ;; can't assure us that the value is safe.
3347 "Non-nil if SYM could be dangerous as a file-local variable.
3348 It is dangerous if either of these conditions are met:
3350 * Its `risky-local-variable' property is non-nil.
3356 ;; If this is an alias, check the base name.
3376 "Return t if it is safe to eval EXP when it is found in a file."
3378 ;; Detect certain `put' expressions.
3385 lisp-indent-function
3386 scheme-indent-function))
3387 ;; Only allow safe values (not functions).
3392 ;; Only allow indirect form specs.
3393 ;; During bootstrapping, edebug-basic-spec might not be
3394 ;; defined yet.
3398 ;; Allow expressions that the user requested.
3400 ;; Certain functions can be allowed with safe arguments
3401 ;; or can specify verification functions to try.
3403 ;; Allow (minor)-modes calls with no arguments.
3404 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3413 ok))
3421 ok))))))))
3424 "Set local variable VAR with value VAL.
3425 If VAR is `mode', call `VAL-mode' as a function unless it's
3426 already the major mode."
3433 ;; A minor mode must be passed an argument.
3434 ;; Otherwise, if the user enables the minor mode in a
3435 ;; major mode hook, this would toggle it off.
3441 ;; Make sure the string has no text properties.
3442 ;; Some text properties can get evaluated in various ways,
3443 ;; so it is risky to put them on with a local variable list.
3447 \f
3448 ;;; Handling directory-local variables, aka project settings.
3454 "List of cached directory roots for directory-local variable classes.
3455 Each element in this list has the form (DIR CLASS MTIME).
3456 DIR is the name of the directory.
3457 CLASS is the name of a variable class (a symbol).
3458 MTIME is the recorded modification time of the directory-local
3459 variables file associated with this entry. This time is a list
3460 of two integers (the same format as `file-attributes'), and is
3461 used to test whether the cache entry is still valid.
3462 Alternatively, MTIME can be nil, which means the entry is always
3466 "Return the variable list for CLASS."
3470 "Collect directory-local variables from MODE-VARIABLES.
3471 VARIABLES is the initial list of variables.
3472 Returns the new list."
3477 ;; If variables are specified more than once, only use the last. (Why?)
3478 ;; The pseudo-variables mode and eval are different (bug#3430).
3481 ;; Need a new cons in case we setcdr later.
3485 "Collect entries from CLASS-VARIABLES into VARIABLES.
3486 ROOT is the root directory of the project.
3487 Return the new variables list."
3490 ;; FIXME: Why not use file-relative-name?
3497 ;; Don't include this in the previous condition, because we
3498 ;; want to filter all strings before the next condition.
3512 ;; TODO someone might want to extend this to allow
3513 ;; integer values for subdir, where N means
3514 ;; variables apply to this directory and N levels
3515 ;; below it (0 == nil).
3518 alist variables))))))))
3520 ;; The file's content might be invalid (e.g. have a merge conflict), but
3521 ;; that shouldn't prevent the user from opening the file.
3523 nil))))
3526 "Declare that the DIRECTORY root is an instance of CLASS.
3527 DIRECTORY is the name of a directory, a string.
3528 CLASS is the name of a project class, a symbol.
3529 MTIME is either the modification time of the directory-local
3530 variables file that defined this class, or nil.
3532 When a file beneath DIRECTORY is visited, the mode-specific
3533 variables from CLASS are applied to the buffer. The variables
3534 for a class are defined using `dir-locals-set-class-variables'."
3541 "Map the type CLASS to a list of variable settings.
3542 CLASS is the project class, a symbol. VARIABLES is a list
3543 that declares directory-local variables for the class.
3544 An element in VARIABLES is either of the form:
3545 (MAJOR-MODE . ALIST)
3546 or
3547 (DIRECTORY . LIST)
3549 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3550 whose elements are of the form (VARIABLE . VALUE).
3552 In the second form, DIRECTORY is a directory name (a string), and
3553 LIST is a list of the form accepted by the function.
3555 When a file is visited, the file's class is found. A directory
3556 may be assigned a class using `dir-locals-set-directory-class'.
3557 Then variables are set in the file's buffer according to the
3558 VARIABLES list of the class. The list is processed in order.
3560 * If the element is of the form (MAJOR-MODE . ALIST), and the
3561 buffer's major mode is derived from MAJOR-MODE (as determined
3562 by `derived-mode-p'), then all the variables in ALIST are
3563 applied. A MAJOR-MODE of nil may be used to match any buffer.
3564 `make-local-variable' is called for each variable before it is
3565 set.
3567 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3568 is an initial substring of the file's directory, then LIST is
3569 applied by recursively following these rules."
3576 "File that contains directory-local variables.
3577 It has to be constant to enforce uniform values
3581 "Find the directory-local variables for FILE.
3582 This searches upward in the directory tree from FILE.
3583 It stops at the first directory that has been registered in
3584 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3585 If it finds an entry in the cache, it checks that it is valid.
3586 A cache entry with no modification time element (normally, one that
3587 has been assigned directly using `dir-locals-set-directory-class', not
3588 set from a file) is always valid.
3589 A cache entry based on a `dir-locals-file' is valid if the modification
3590 time stored in the cache matches the current file modification time.
3591 If not, the cache entry is cleared so that the file will be re-read.
3593 This function returns either nil (no directory local variables found),
3594 or the matching entry from `dir-locals-directory-cache' (a list),
3595 or the full path to the `dir-locals-file' (a string) in the case
3596 of no valid cache entry."
3601 dir-locals-file))
3604 ;; `locate-dominating-file' may have abbreviated the name.
3607 ;; Let dir-locals-read-from-file inform us via demoted-errors
3608 ;; about unreadable files, etc.
3609 ;; Maybe we'd want to keep searching though - that is
3610 ;; a locate-dominating-file issue.
3611 ;;; (or (not (file-readable-p locals-file))
3612 ;;; (not (file-regular-p locals-file)))
3613 ;;; (setq locals-file nil))
3614 ;; Find the best cached value in `dir-locals-directory-cache'.
3626 ;; Found a potential cache entry. Check validity.
3627 ;; A cache entry with no MTIME is assumed to always be valid
3628 ;; (ie, set directly, not from a dir-locals file).
3629 ;; Note, we don't bother to check that there is a matching class
3630 ;; element in dir-locals-class-alist, since that's done by
3631 ;; dir-locals-set-directory-class.
3638 ;; This cache entry is OK.
3639 dir-elt
3640 ;; This cache entry is invalid; clear it.
3643 ;; Return the first existing dir-locals file. Might be the same
3644 ;; as dir-elt's, might not (eg latter might have been deleted).
3645 locals-file)
3646 ;; No cache entry.
3647 locals-file)))
3650 "Load a variables FILE and register a new class and instance.
3651 FILE is the name of the file holding the variables to apply.
3652 The new class name is the same as the directory in which FILE
3653 is found. Returns the new class name."
3655 ;; This is with-demoted-errors, but we want to mention dir-locals
3656 ;; in any error message.
3668 class-name))
3672 "Non-nil means dir-local variables will be applied to remote files."
3678 "Read per-directory local variables for the current buffer.
3679 Store the directory-local variables in `dir-local-variables-alist'
3680 and `file-local-variables-alist', without applying them."
3684 default-directory)))))
3685 ;; Find the variables file.
3710 "Apply directory-local variables to a non-file buffer.
3711 For non-file buffers, such as Dired buffers, directory-local
3712 variables are looked for in `default-directory' and its parent
3713 directories."
3717 \f
3720 However, the mode will not be changed if
3721 \(1) a local variables list or the `-*-' line specifies a major mode, or
3723 \ not suitable for ordinary files, or
3724 \(3) the new file name does not particularly specify any mode."
3729 "Change name of file visited in current buffer to FILENAME.
3730 This also renames the buffer to correspond to the new file.
3731 The next time the buffer is saved it will go in the newly specified file.
3732 FILENAME nil or an empty string means mark buffer as not visiting any file.
3733 Remember to delete the initial contents of the minibuffer
3734 if you wish to pass an empty string as the argument.
3736 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3737 confirmation in the case where another buffer is already visiting FILENAME.
3739 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3740 the old visited file has been renamed to the new name FILENAME."
3748 nil
3763 filename)))
3770 buffer-file-name filename)
3774 ;; If new-name == old-name, renaming would add a spurious <2>
3775 ;; and it's considered as a feature in rename-buffer.
3781 ;; Abbreviate the file names of the buffer.
3790 nil))
3791 ;; write-file-functions is normally used for things like ftp-find-file
3792 ;; that visit things that are not local files as if they were files.
3793 ;; Changing to visit an ordinary local file instead should flush the hook.
3798 ;; If buffer was read-only because of version control,
3799 ;; that reason is gone now, so make it writable.
3803 ;; Turn off backup files for certain file names.
3804 ;; Since this is a permanent local, the major mode won't eliminate it.
3806 backup-enable-predicate
3812 ;; If auto-save was not already on, turn it on if appropriate.
3816 ;; If auto save is on, start using a new name.
3817 ;; We deliberately don't rename or delete the old auto save
3818 ;; for the old visited file name. This is because perhaps
3819 ;; the user wants to save the new state and then compare with the
3820 ;; previous state from the auto save file.
3823 ;; Rename the old auto save file if any.
3830 ;; Update the major mode, if the file name determines it.
3832 ;; Don't change the mode if it is special.
3835 ;; Don't change the mode if the local variable list specifies it.
3836 ;; The file name can influence whether the local variables apply.
3838 ;; h-l-v also checks it, but might as well be explicit.
3841 ;; TODO consider making normal-mode handle this case.
3849 "Write current buffer into file FILENAME.
3850 This makes the buffer visit that file, and marks it as not modified.
3852 If you specify just a directory name as FILENAME, that means to use
3853 the default file name but in that directory. You can also yank
3854 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3856 If the buffer is not already visiting a file, the default file name
3857 for the output file is the buffer name.
3859 If optional second arg CONFIRM is non-nil, this function
3860 asks for confirmation before overwriting an existing file.
3861 Interactively, confirmation is required unless you supply a prefix argument."
3862 ;; (interactive "FWrite file: ")
3866 nil nil nil nil)
3870 default-directory)
3871 nil nil))
3875 ;; If arg is just a directory,
3876 ;; use the default file name, but in that directory.
3887 ;; Make buffer writable if file is writable.
3892 ;; It's likely that the VC status at the new location is different from
3893 ;; the one at the old location.
3895 \f
3897 "Make a backup of the disk file visited by the current buffer, if appropriate.
3898 This is normally done before saving the buffer the first time.
3900 A backup may be done by renaming or by copying; see documentation of
3901 variable `make-backup-files'. If it's done by renaming, then the file is
3902 no longer accessible under its old name.
3904 The value is non-nil after a backup was made by renaming.
3905 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3906 MODES is the result of `file-modes' on the original
3907 file; this means that the caller, after saving the buffer, should change
3908 the modes of the new file to agree with the old modes.
3909 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3910 file; this means that the caller, after saving the buffer, should change
3911 the SELinux context of the new file to agree with the old context.
3912 BACKUPNAME is the backup file name, which is the old file renamed."
3919 backup-info backupname targets setmodes)
3920 ;; If specified name is a symbolic link, chase it to the target.
3921 ;; Thus we make the backups in the directory where the real file is.
3926 ;; (if (file-directory-p buffer-file-name)
3927 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3931 ;; If have old versions to maybe delete,
3932 ;; ask the user to confirm now, before doing anything.
3933 ;; But don't actually delete til later.
3938 real-file-name)))))
3941 ;; Actually write the back up file.
3944 ; (file-symlink-p buffer-file-name)
3945 backup-by-copying
3946 ;; Don't rename a suid or sgid file.
3961 ;; rename-file should delete old backup.
3965 ;; If trouble writing the backup, write it in
3966 ;; .emacs.d/%backup%.
3969 backupname)
3973 ;; Now delete the old versions, if desired.
3980 setmodes)
3987 ;; Create temp files with strict access rights. It's easy to
3988 ;; loosen them later, whereas it's impossible to close the
3989 ;; time-window of loose permissions otherwise.
3992 ;; Try to overwrite old backup first.
4000 nil)
4002 ;; The file was somehow created by someone else between
4003 ;; `delete-file' and `copy-file', so let's try again.
4004 ;; rms says "I think there is also a possible race
4005 ;; condition for making backup files" (emacs-devel 20070821).
4006 nil)))
4007 ;; Reset the umask.
4016 ;; The last ~[[:digit]]+ matches relative versions in git,
4017 ;; e.g. `foo.js.~HEAD~1~'.
4018 "Regular expression matching the backup/version part of a file name.
4022 "Return file NAME sans backup versions or strings.
4023 This is a separate procedure so your site-init or startup file can
4024 redefine it.
4025 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4026 we do not remove backup version numbers, only true file version numbers.
4027 See also `file-name-version-regexp'."
4034 name))))))
4037 "Return t if deleting FILE and rewriting it would preserve the owner."
4042 ;; Return t if the file doesn't exist, since it's true that no
4043 ;; information would be lost by an (attempted) delete and create.
4046 ;; Files created on Windows by Administrator (RID=500)
4047 ;; have the Administrators group (RID=544) recorded as
4048 ;; their owner. Rewriting them will still preserve the
4049 ;; owner.
4055 The extension, in a file name, is the part that follows the last `.',
4056 except that a leading `.', if any, doesn't count."
4059 directory)
4063 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4064 ;; we don't want to expand it.
4067 filename))))
4071 The extension, in a file name, is the part that follows the last `.',
4072 excluding version numbers and backup suffixes,
4073 except that a leading `.', if any, doesn't count.
4074 Return nil for extensionless file names such as `foo'.
4075 Return the empty string for file names such as `foo.'.
4077 If PERIOD is non-nil, then the returned value includes the period
4078 that delimits the extension, and if FILENAME has no extension,
4089 "A function to use instead of the default `make-backup-file-name'.
4090 A value of nil gives the default `make-backup-file-name' behavior.
4092 This could be buffer-local to do something special for specific
4093 files. If you define it, you may need to change `backup-file-name-p'
4094 and `file-name-sans-versions' too.
4096 See also `backup-directory-alist'."
4102 "Alist of filename patterns and backup directory names.
4103 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4104 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4105 relative or absolute. If it is absolute, so that all matching files
4106 are backed up into the same directory, the file names in this
4107 directory will be the full name of the file backed up with all
4108 directory separators changed to `!' to prevent clashes. This will not
4109 work correctly if your filesystem truncates the resulting name.
4111 For the common case of all backups going into one directory, the alist
4113 directory name.
4115 If this variable is nil, or it fails to match a filename, the backup
4116 is made in the original file's directory.
4118 On MS-DOS filesystems without long names this variable is always
4119 ignored."
4125 "Default `backup-enable-predicate' function.
4126 Checks for files in `temporary-file-directory',
4127 `small-temporary-file-directory', and /tmp."
4130 ;; Directory is under temporary-file-directory.
4135 ;; Directory is under /tmp.
4140 0 nil
4142 ;; Directory is under small-temporary-file-directory.
4147 "Create the non-numeric backup file name for FILE.
4148 Normally this will just be the file's name with `~' appended.
4149 Customization hooks are provided as follows.
4151 If the variable `make-backup-file-name-function' is non-nil, its value
4152 should be a function which will be called with FILE as its argument;
4153 the resulting name is used.
4155 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4156 the documentation of that variable. If the directory for the backup
4157 doesn't exist, it is created."
4171 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4173 elt backup-directory abs-backup-directory)
4178 alist nil)))
4179 ;; If backup-directory is relative, it should be relative to the
4180 ;; file's directory. By expanding explicitly here, we avoid
4181 ;; depending on default-directory.
4190 abs-backup-directory nil))))
4192 file
4196 ;; Normalize DOSish file names: downcase the drive
4197 ;; letter, if any, and replace the leading "x:" with
4198 ;; "/drive_x".
4201 ;; Replace any invalid file-name characters (for the
4202 ;; case of backing up remote files).
4206 "drive_"
4209 ""
4212 ;; Make the name unique by substituting directory
4213 ;; separators. It may not really be worth bothering about
4214 ;; doubling `!'s in the original name...
4219 backup-directory))
4224 "Return non-nil if FILE is a backup file name (numeric or not).
4225 This is a separate function so you can redefine it for customization.
4226 You may need to redefine `file-name-sans-versions' as well."
4231 ;; This is used in various files.
4232 ;; The usage of backup-extract-version-start is not very clean,
4233 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4235 "Given the name of a numeric backup file, FN, return the backup number.
4236 Uses the free variable `backup-extract-version-start', whose value should be
4237 the index in the name where the version number begins."
4244 "Find a file name for a backup file FN, and suggestions for deletions.
4245 Value is a list whose car is the name for the backup file
4246 and whose cdr is a list of old versions to consider deleting now.
4247 If the value is nil, don't make a backup.
4248 Uses `backup-directory-alist' in the same way as does
4249 `make-backup-file-name'."
4251 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4255 ;; We don't support numbered backups on plain MS-DOS
4256 ;; when long file names are unavailable.
4266 possibilities deserve-versions-p versions)
4269 base-versions
4272 possibilities)
4273 #'<)
4278 kept-old-versions
4279 kept-new-versions
4286 ;; Delete nothing if there is overflow
4287 ;; in the number of versions to keep.
4293 v))))))))))
4296 "Return number of names file FILENAME has."
4299 ;; (defun file-relative-name (filename &optional directory)
4300 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4301 ;; This function returns a relative file name which is equivalent to FILENAME
4302 ;; when used with that default directory as the default.
4303 ;; If this is impossible (which can happen on MSDOS and Windows
4304 ;; when the file name and directory use different drive names)
4305 ;; then it returns FILENAME."
4306 ;; (save-match-data
4307 ;; (let ((fname (expand-file-name filename)))
4308 ;; (setq directory (file-name-as-directory
4309 ;; (expand-file-name (or directory default-directory))))
4310 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4311 ;; ;; drive names, they can't be relative, so return the absolute name.
4312 ;; (if (and (or (eq system-type 'ms-dos)
4313 ;; (eq system-type 'cygwin)
4314 ;; (eq system-type 'windows-nt))
4315 ;; (not (string-equal (substring fname 0 2)
4316 ;; (substring directory 0 2))))
4317 ;; filename
4318 ;; (let ((ancestor ".")
4319 ;; (fname-dir (file-name-as-directory fname)))
4320 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4321 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4322 ;; (setq directory (file-name-directory (substring directory 0 -1))
4323 ;; ancestor (if (equal ancestor ".")
4324 ;; ".."
4325 ;; (concat "../" ancestor))))
4326 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4327 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4328 ;; ;; We matched within FNAME's directory part.
4329 ;; ;; Add the rest of FNAME onto ANCESTOR.
4330 ;; (let ((rest (substring fname (match-end 0))))
4331 ;; (if (and (equal ancestor ".")
4332 ;; (not (equal rest "")))
4333 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4334 ;; rest
4335 ;; (concat (file-name-as-directory ancestor) rest)))
4336 ;; ;; We matched FNAME's directory equivalent.
4337 ;; ancestor))))))
4340 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4341 This function returns a relative file name which is equivalent to FILENAME
4342 when used with that default directory as the default.
4343 If FILENAME and DIRECTORY lie on different machines or on different drives
4344 on a DOS/Windows machine, it returns FILENAME in expanded form."
4348 default-directory))))
4354 ;; Test for different filesystems on DOS/Windows
4356 ;; Should `cygwin' really be included here? --stef
4359 ;; Test for different drive letters
4361 ;; Test for UNCs on different servers
4366 ;; Windows file names cannot have ? in
4367 ;; them, so use that to detect when
4368 ;; neither FILENAME nor DIRECTORY is a
4369 ;; UNC.
4371 0 nil
4377 ;; Test for different remote file system identification
4379 filename
4385 directory nil nil case-fold-search))
4387 directory nil nil case-fold-search))))
4390 ".."
4392 ;; Now ancestor is empty, or .., or ../.., etc.
4394 directory nil nil case-fold-search))
4395 ;; We matched within FILENAME's directory part.
4396 ;; Add the rest of FILENAME onto ANCESTOR.
4399 ;; But don't bother with ANCESTOR if it would give us `./'.
4400 rest
4402 ;; We matched FILENAME's directory equivalent.
4403 ancestor))))))
4404 \f
4406 "Save current buffer in visited file if modified.
4407 Variations are described below.
4409 By default, makes the previous version into a backup file
4410 if previously requested or if this is the first save.
4412 to become a backup when the next save is done.
4414 unconditionally makes the previous version into a backup file.
4416 to become a backup when the next save is done,
4417 and unconditionally makes the previous version into a backup file.
4419 With a numeric argument of 0, never make the previous version
4420 into a backup file.
4422 If a file's name is FOO, the names of its numbered backup versions are
4423 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4424 Numeric backups (rather than FOO~) will be made if value of
4425 `version-control' is not the atom `never' and either there are already
4426 numeric versions of the file being backed up, or `version-control' is
4427 non-nil.
4428 We don't want excessive versions piling up, so there are variables
4429 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4430 and `kept-new-versions', which tells how many newest versions to keep.
4431 Defaults are 2 old versions and 2 new.
4432 `dired-kept-versions' controls dired's clean-directory (.) command.
4433 If `delete-old-versions' is nil, system will query user
4434 before trimming versions. Otherwise it does it silently.
4436 If `vc-make-backup-files' is nil, which is the default,
4437 no backup files are made for files managed by version control.
4438 (This is because the version control system itself records previous versions.)
4440 See the subroutine `basic-save-buffer' for more information."
4446 ;; We used to display the message below only for files > 50KB, but
4447 ;; then Rmail-mbox never displays it due to buffer swapping. If
4448 ;; the test is ever re-introduced, be sure to handle saving of
4449 ;; Rmail files.
4456 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4457 Normally delete only if the file was written by this Emacs since
4458 the last real save, but optional arg FORCE non-nil means delete anyway."
4472 "Normal hook that is run before a buffer is saved to its file."
4478 "Normal hook that is run after a buffer is saved to its file."
4484 "If non-nil, use this coding system for saving the buffer.
4485 More precisely, use this coding system in place of the
4486 value of `buffer-file-coding-system', when saving the buffer.
4487 Calling `write-region' for any purpose other than saving the buffer
4488 will still use `buffer-file-coding-system'; this variable has no effect
4495 "Save the current buffer in its visited file, if it has been modified.
4496 The hooks `write-contents-functions' and `write-file-functions' get a chance
4497 to do the job of saving; if they do not, then the buffer is saved in
4498 the visited file in the usual way.
4499 Before and after saving the buffer, this function runs
4500 `before-save-hook' and `after-save-hook', respectively."
4503 ;; In an indirect buffer, save its base buffer instead.
4507 ;; handle the case when no modification has been made but
4508 ;; the file disappeared since visited
4512 setmodes)
4513 ;; If buffer has no file name, ask user for one.
4520 ;; Signal an error if the user specified the name of an
4521 ;; existing directory.
4524 filename))
4526 ;; Signal an error if the specified name refers to a
4527 ;; non-existing directory.
4538 "%s has changed since visited or saved. Save anyway? "
4558 ;; Support VC version backups.
4564 ;; If a hook returned t, file is already "written".
4565 ;; Otherwise, write it the usual way now.
4567 ;; Now we have saved the current buffer. Let's make sure
4568 ;; that buffer-file-coding-system is fixed to what
4569 ;; actually used for saving by binding it locally.
4581 ;; If the auto-save file was recent before this command,
4582 ;; delete it now.
4584 ;; Support VC `implicit' locking.
4589 ;; This does the "real job" of writing a buffer into its visited file
4590 ;; and making a backup file. This is what is normally done
4591 ;; but inhibited if one of write-file-functions returns non-nil.
4592 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4604 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4617 "File %s is write-protected; try to save anyway? "
4619 buffer-file-name)))
4634 ;; Write temp name, then rename it.
4635 ;; This requires write access to the containing dir,
4636 ;; which is why we don't try it if we don't have that access.
4638 tempname succeed
4641 ;; Create temp files with strict access rights. It's easy to
4642 ;; loosen them later, whereas it's impossible to close the
4643 ;; time-window of loose permissions otherwise.
4648 ;; Try various temporary names.
4649 ;; This code follows the example of make-temp-file,
4650 ;; but it calls write-region in the appropriate way
4651 ;; for saving the buffer.
4657 ;; Pass in nil&nil rather than point-min&max
4658 ;; cause we're saving the whole buffer.
4659 ;; write-region-annotate-functions may use it.
4661 tempname nil realname
4663 nil)
4665 ;; The file was somehow created by someone else between
4666 ;; `make-temp-name' and `write-region', let's try again.
4667 nil)
4669 ;; Reset the umask.
4671 ;; If we failed, restore the buffer's modtime.
4674 ;; Since we have created an entirely new file,
4675 ;; make sure it gets the right permission bits set.
4680 buffer-file-name)))
4681 ;; We succeeded in writing the temp file,
4682 ;; so rename it.
4684 ;; If file not writable, see if we can make it writable
4685 ;; temporarily while we write it.
4686 ;; But no need to do so if we have just backed it up
4687 ;; (setmodes is set) because that says we're superseding.
4689 ;; Change the mode back, after writing.
4692 buffer-file-name))
4698 ;; Pass in nil&nil rather than point-min&max to indicate
4699 ;; we're saving the buffer rather than just a region.
4700 ;; write-region-annotate-functions may make us of it.
4702 buffer-file-name nil t buffer-file-truename)
4704 ;; If we get an error writing the new file, and we made
4705 ;; the backup by renaming, undo the backing-up.
4710 setmodes))
4716 `((?\C-r
4723 ;; Return nil to ask about BUF again.
4724 nil)
4737 ;; Return nil to ask about BUF again.
4738 nil)
4748 "Save some modified file-visiting buffers. Asks user about each one.
4749 You can answer `y' to save, `n' not to save, `C-r' to look at the
4750 buffer in question with `view-buffer' before deciding or `d' to
4751 view the differences using `diff-buffer-with-file'.
4753 This command first saves any buffers where `buffer-save-without-query' is
4754 non-nil, without asking.
4756 Optional argument (the prefix) non-nil means save all with no questions.
4757 Optional second argument PRED determines which buffers are considered:
4758 If PRED is nil, all the file-visiting buffers are considered.
4759 If PRED is t, then certain non-file buffers will also be considered.
4760 If PRED is a zero-argument function, it indicates for each buffer whether
4761 to consider it or not when called with that buffer current.
4763 See `save-some-buffers-action-alist' if you want to
4764 change the additional actions you can take on files."
4768 files-done abbrevs-done)
4770 ;; First save any buffers that we're supposed to save unconditionally.
4771 ;; That way the following code won't ask about them.
4776 ;; Ask about those buffers that merit it,
4777 ;; and record the number thus saved.
4781 ;; Note that killing some buffers may kill others via
4782 ;; hooks (e.g. Rmail and its viewing buffer).
4795 t
4807 save-some-buffers-action-alist))
4808 ;; Maybe to save abbrevs, and record whether
4809 ;; we either saved them or asked to.
4816 ;; Don't keep bothering user if he says no.
4829 \f
4831 "Mark current buffer as unmodified, not needing to be saved.
4834 It is not a good idea to use this function in Lisp programs, because it
4835 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4842 "Change whether this buffer is read-only.
4843 With prefix argument ARG, make the buffer read-only if ARG is
4844 positive, otherwise make it writable. If buffer is read-only
4845 and `view-read-only' is non-nil, enter view mode.
4847 This function is usually the wrong thing to use in a Lisp program.
4848 It can have side-effects beyond changing the read-only status of a buffer
4849 \(e.g., enabling view mode), and does not affect read-only regions that
4850 are caused by text properties. To make a buffer read-only in Lisp code,
4851 set `buffer-read-only'. To ignore read-only status (whether due to text
4852 properties or buffer state) and make changes, temporarily bind
4853 `inhibit-read-only'."
4858 nil ; do nothing.
4859 ;; Toggle.
4866 ;; If view-mode is already active, `view-mode-enter' is a nop.
4874 "Insert contents of file FILENAME into buffer after point.
4875 Set mark after the inserted text.
4877 This function is meant for the user to run interactively.
4878 Don't call it from programs! Use `insert-file-contents' instead.
4879 \(Its calling sequence is different; see its documentation)."
4884 "Append the contents of the region to the end of file FILENAME.
4885 When called from a function, expects three arguments,
4886 START, END and FILENAME. START and END are normally buffer positions
4887 specifying the part of the buffer to write.
4888 If START is nil, that means to use the entire buffer contents.
4889 If START is a string, then output that string to the file
4890 instead of any buffer contents; END is ignored.
4892 This does character code conversion and applies annotations
4893 like `write-region' does."
4898 "Return most recent backup file for FILENAME or nil if no backups exist."
4899 ;; `make-backup-file-name' will get us the right directory for
4900 ;; ordinary or numeric backups. It might create a directory for
4901 ;; backups as a side-effect, according to `backup-directory-alist'.
4908 tem)
4917 newest))
4920 "Rename current buffer to a similar name not already taken.
4921 This function is useful for creating multiple shell process buffers
4922 or multiple mail buffers, etc.
4924 Note that some commands, in particular those based on `compilation-mode'
4925 \(`compile', `grep', etc.) will reuse the current buffer if it has the
4926 appropriate mode even if it has been renamed. So as well as renaming
4927 the buffer, you also need to switch buffers before running another
4928 instance of such commands."
4936 ;; If the existing buffer name has a <NNN>,
4937 ;; which isn't part of the file name (if any),
4938 ;; then get rid of that.
4944 "Create the directory DIR and optionally any nonexistent parent dirs.
4945 If DIR already exists as a directory, signal an error, unless
4946 PARENTS is non-nil.
4948 Interactively, the default choice of directory to create is the
4949 current buffer's default directory. That is useful when you have
4950 visited a file in a nonexistent directory.
4952 Noninteractively, the second (optional) argument PARENTS, if
4953 non-nil, says whether to create parent directories that don't
4954 exist. Interactively, this happens by default.
4956 If creating the directory or directories fail, an error will be
4957 raised."
4960 nil nil)
4961 t))
4962 ;; If default-directory is a remote directory,
4963 ;; make sure we find its make-directory handler.
4971 create-list)
4973 ;; If directory is its own parent, then we can't
4974 ;; keep looping forever
4989 "Delete the directory named DIRECTORY. Does not follow symlinks.
4990 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4991 TRASH non-nil means to trash the directory instead, provided
4992 `delete-by-moving-to-trash' is non-nil.
4994 When called interactively, TRASH is t if no prefix argument is
4995 given. With a prefix argument, TRASH is nil."
5002 "Move directory to trash: "
5004 default-directory default-directory nil nil))))
5010 nil)
5012 ;; If default-directory is a remote directory, make sure we find its
5013 ;; delete-directory handler.
5020 ;; Only move non-empty dir to trash if recursive deletion was
5021 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5022 ;; case, where the operation fails in delete-directory-internal.
5023 ;; As `move-file-to-trash' trashes directories (empty or
5024 ;; otherwise) as a unit, we do not need to recurse here.
5026 ;; Check if directory is empty apart from "." and "..".
5031 ;; Otherwise, call ourselves recursively if needed.
5035 ;; This test is equivalent to
5036 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5037 ;; but more efficient
5041 ;; We do not want to delete "." and "..".
5047 "Return non-nil if files FILE1 and FILE2 name the same file.
5048 If FILE1 or FILE2 does not exist, the return value is unspecified."
5059 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5061 Return nil if DIR is not an existing directory."
5083 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5084 This function always sets the file modes of the output files to match
5085 the corresponding input file.
5087 The third arg KEEP-TIME non-nil means give the output files the same
5088 last-modified time as the old ones. (This works on only some systems.)
5090 A prefix arg makes KEEP-TIME non-nil.
5092 Noninteractively, the last argument PARENTS says whether to
5093 create parent directories if they don't exist. Interactively,
5094 this happens by default.
5096 If NEWNAME names an existing directory, copy DIRECTORY as a
5097 subdirectory there. However, if called from Lisp with a non-nil
5098 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5099 directly into NEWNAME instead."
5106 default-directory default-directory nil nil)
5107 current-prefix-arg t nil)))
5110 directory newname))
5111 ;; If default-directory is a remote directory, make sure we find its
5112 ;; copy-directory handler.
5117 newname keep-time parents copy-contents)
5119 ;; Compute target name.
5124 ;; If NEWNAME is not an existing directory, create it;
5125 ;; that is where we will copy the files of DIRECTORY.
5127 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5128 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5133 newname))
5137 newname))
5140 ;; Copy recursively.
5142 ;; We do not want to copy "." and "..".
5144 directory-files-no-dot-files-regexp))
5154 ;; Set directory attributes.
5160 \f
5161 ;; At time of writing, only info uses this.
5163 "Return a copy of DIRS with all non-existent directories removed.
5164 The optional argument KEEP is a list of directories to retain even if
5165 they don't exist, and REJECT is a list of directories to remove from
5166 DIRS, even if they exist; REJECT takes precedence over KEEP.
5168 Note that membership in REJECT and KEEP is checked using simple string
5169 comparison."
5175 dirs)))
5177 \f
5180 "Function to use to revert this buffer, or nil to do the default.
5181 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5186 "Function to use to insert contents when reverting this buffer.
5187 Gets two args, first the nominal file name to use,
5188 and second, t if reading the auto-save file.
5193 "Function to check whether a non-file buffer needs reverting.
5194 This should be a function with one optional argument NOCONFIRM.
5195 Auto Revert Mode passes t for NOCONFIRM. The function should return
5196 non-nil if the buffer should be reverted. A return value of
5197 `fast' means that the need for reverting was not checked, but
5198 that reverting the buffer is fast. The buffer is current when
5199 this function is called.
5201 The idea behind the NOCONFIRM argument is that it should be
5202 non-nil if the buffer is going to be reverted without asking the
5203 user. In such situations, one has to be careful with potentially
5204 time consuming operations.
5206 For more information on how this variable is used by Auto Revert mode,
5210 "Normal hook for `revert-buffer' to run before reverting.
5211 If `revert-buffer-function' is used to override the normal revert
5215 "Normal hook for `revert-buffer' to run after reverting.
5216 Note that the hook value that it runs is the value that was in effect
5217 before reverting; that makes a difference if you have buffer-local
5218 hook functions.
5220 If `revert-buffer-function' is used to override the normal revert
5224 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5230 "Replace current buffer text with the text of the visited file on disk.
5231 This undoes all changes since the file was visited or saved.
5232 With a prefix argument, offer to revert from latest auto-save file, if
5233 that is more recent than the visited file.
5235 This command also implements an interface for special buffers
5236 that contain text which doesn't come from a file, but reflects
5237 some other data instead (e.g. Dired buffers, `buffer-list'
5238 buffers). This is done via the variable `revert-buffer-function'.
5239 In these cases, it should reconstruct the buffer contents from the
5240 appropriate data.
5242 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5243 to revert from the auto-save file when this is nil. Note that the
5244 sense of this argument is the reverse of the prefix argument, for the
5245 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5246 to nil.
5248 Optional second argument NOCONFIRM means don't ask for confirmation
5249 at all. (The variable `revert-without-query' offers another way to
5250 revert buffers without querying for confirmation.)
5252 Optional third argument PRESERVE-MODES non-nil means don't alter
5253 the files modes. Normally we reinitialize them using `normal-mode'.
5255 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5257 If the value of `revert-buffer-function' is non-nil, it is called to
5258 do all the work for this command. Otherwise, the hooks
5259 `before-revert-hook' and `after-revert-hook' are run at the beginning
5260 and the end, and if `revert-buffer-insert-file-contents-function' is
5261 non-nil, it is called instead of rereading visited file contents."
5263 ;; I admit it's odd to reverse the sense of the prefix argument, but
5264 ;; there is a lot of code out there which assumes that the first
5265 ;; argument should be t to avoid consulting the auto-save file, and
5266 ;; there's no straightforward way to encourage authors to notice a
5267 ;; reversal of the argument sense. So I'm just changing the user
5268 ;; interface, but leaving the programmatic interface the same.
5278 buffer-auto-save-file-name
5283 buffer-auto-save-file-name
5284 buffer-file-name)))
5294 file-name)))
5296 ;; If file was backed up but has changed since,
5297 ;; we should make another backup.
5301 ;; Effectively copy the after-revert-hook status,
5302 ;; since after-find-file will clobber it.
5305 after-revert-hook))
5310 ;; Get rid of all undo records for this buffer.
5312 ;; Don't make undo records for the reversion.
5315 file-name auto-save-p)))
5318 "File %s no longer exists!"
5320 file-name))
5323 "File %s no longer readable!"
5325 file-name))
5327 ;; Bind buffer-file-name to nil
5328 ;; so that we don't try to lock the file.
5334 ;; Auto-saved file should be read by Emacs's
5335 ;; internal coding.
5339 buffer-file-coding-system-explicit
5342 coding-system-for-read
5344 coding-system-for-read)
5346 ;; As a coding system suitable for multibyte
5347 ;; buffer is specified, make the current
5348 ;; buffer multibyte.
5351 ;; This force after-insert-file-set-coding
5352 ;; (called from insert-file-contents) to set
5353 ;; buffer-file-coding-system to a proper value.
5356 ;; Note that this preserves point in an intelligent way.
5360 nil nil t))
5362 nil nil t)))))
5363 ;; Recompute the truename in case changes in symlinks
5364 ;; have changed the truename.
5368 ;; Run after-revert-hook as it was before we reverted.
5372 local-hook)
5375 t))))))
5378 "Recover the visited file--get contents from its last auto-save file."
5383 "Visit file FILE, but get contents from its last auto-save file."
5384 ;; Actually putting the file name in the minibuffer should be used
5385 ;; only rarely.
5386 ;; Not just because users often use the default.
5406 ;; Use insert-directory-safely, not insert-directory,
5407 ;; because these files might not exist. In particular,
5408 ;; FILE might not exist if the auto-save file was for
5409 ;; a buffer that didn't visit a file, such as "*mail*".
5410 ;; The code in v20.x called `ls' directly, so we need
5411 ;; to emulate what `ls' did in that case.
5417 ;; Keep the current buffer-file-coding-system.
5419 ;; Auto-saved file should be read with special coding.
5428 "Recover auto save files from a previous Emacs session.
5429 This command first displays a Dired buffer showing you the
5430 previous sessions that you could recover from.
5431 To choose one, move point to the proper line and then type C-c C-c.
5432 Then you'll be asked about a number of files to recover."
5442 auto-save-list-file-prefix)))
5443 t)
5452 ;; Each line starts with a space
5453 ;; so that Font Lock mode won't highlight the first character.
5462 "Choose one saved session to recover auto-save files from.
5463 This command is used in the special Dired buffer created by
5466 ;; Get the name of the session file to recover from.
5468 files
5474 ;; Read in the auto-save-list file.
5477 ;; Loop thru the text of that file
5478 ;; and get out the names of the files to recover.
5482 ;; This is a pair of lines for a non-file-visiting buffer.
5483 ;; Get the auto-save file name and manufacture
5484 ;; a "visited file name" from that.
5487 ;; If there is no auto-save file name, the
5488 ;; auto-save-list file is probably corrupted.
5501 ;; This pair of lines is a file-visiting
5502 ;; buffer. Use the visited file name.
5512 ;; Ignore a file if its auto-save file does not exist now.
5516 ;; The file contains a pair of line for each auto-saved buffer.
5517 ;; The first line of the pair contains the visited file name
5518 ;; or is empty if the buffer was not visiting a file.
5519 ;; The second line is the auto-save file name.
5527 files
5533 "Kill BUFFER if confirmed."
5541 "Kill some buffers. Asks the user whether to kill each one of them.
5542 Non-interactively, if optional argument LIST is non-nil, it
5543 specifies the list of buffers to kill, asking for approval for each one."
5551 ; if we killed the base buffer.
5558 "Kill buffers whose name matches the specified REGEXP.
5559 The optional second argument indicates whether to kill internal buffers too."
5568 \f
5570 "Adjust current buffer's auto save file name for current conditions.
5571 Also rename any existing auto save file, if it was made in this session."
5583 "Return file name to use for auto-saves of current buffer.
5584 Does not consider `auto-save-visited-file-name' as that variable is checked
5585 before calling this function. You can redefine this for customization.
5586 See also `auto-save-file-name-p'."
5594 result uniq)
5595 ;; Apply user-specified translations
5596 ;; to the file name.
5600 filename)
5610 filename))))
5615 ;; We truncate the file name to DOS 8+3 limits
5616 ;; before doing anything else, because the regexp
5617 ;; passed to string-match below cannot handle
5618 ;; extensions longer than 3 characters, multiple
5619 ;; dots, and other atrocities.
5624 fn)
5629 "#"
5632 ;; Make sure auto-save file names don't contain characters
5633 ;; invalid for the underlying filesystem.
5635 ;; Don't modify remote (ange-ftp) filenames
5638 result))))
5640 ;; Deal with buffers that don't have any associated files. (Mail
5641 ;; mode tends to create a good number of these.)
5645 file-name)
5646 ;; Restrict the characters used in the file name to those which
5647 ;; are known to be safe on all filesystems, url-encoding the
5648 ;; rest.
5649 ;; We do this on all platforms, because even if we are not
5650 ;; running on DOS/Windows, the current directory may be on a
5651 ;; mounted VFAT filesystem, such as a USB memory stick.
5655 ;; For multibyte characters, this will produce more than
5656 ;; 2 hex digits, so is not true URL encoding.
5660 ;; Generate the file name.
5666 ;; Try a few alternative directories, to get one we can
5667 ;; write it.
5673 ;; Don't modify remote (ange-ftp) filenames
5675 ;; The call to convert-standard-filename is in case
5676 ;; buffer-name includes characters not allowed by the
5677 ;; DOS/Windows filesystems. make-temp-file writes to the
5678 ;; file it creates, so we must fix the file name _before_
5679 ;; make-temp-file is called.
5681 fname))
5683 ;; make-temp-file creates the file,
5684 ;; but we don't want it to exist until we do an auto-save.
5688 file-name)))
5691 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5692 FILENAME should lack slashes. You can redefine this for customization."
5694 \f
5696 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5697 The generated regexp will match a filename only if the filename
5698 matches that wildcard according to shell rules. Only wildcards known
5699 by `sh' are supported."
5701 ;; Copy the initial run of non-special characters.
5704 ;; If no special characters, we're almost done.
5708 j)
5710 result
5731 ;; Found "[^". Insert a `\0' character
5732 ;; (which cannot happen in a filename)
5733 ;; into the character class, so that `^'
5734 ;; is not the first character after `[',
5735 ;; and thus non-special in a regexp.
5740 ;; I don't think `]' can appear in a
5741 ;; character class in a wildcard, but
5742 ;; let's be general here.
5749 i
5762 ;; Shell wildcards should match the entire filename,
5763 ;; not its part. Make the regexp say so.
5765 \f
5768 "Switches for `list-directory' to pass to `ls' for brief listing."
5774 "Switches for `list-directory' to pass to `ls' for verbose listing."
5779 "Expand wildcard pattern PATTERN.
5780 This returns a list of file names which match the pattern.
5782 If PATTERN is written as an absolute file name,
5783 the values are absolute also.
5785 If PATTERN is written as a relative file name, it is interpreted
5786 relative to the current default directory, `default-directory'.
5787 The file names returned are normally also relative to the current
5788 default directory. However, if FULL is non-nil, they are absolute."
5792 ;; A list of all dirs that DIRPART specifies.
5793 ;; This can be more than one dir
5794 ;; if DIRPART contains wildcards.
5798 dirpart)))
5802 contents)
5808 ;; Filter out "." and ".."
5813 name))
5820 this-dir-contents)
5821 this-dir-contents)
5822 contents))))
5824 contents)))
5826 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5830 "Display a list of files in or matching DIRNAME, a la `ls'.
5831 DIRNAME is globbed by the shell if necessary.
5832 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5833 Actions controlled by variables `list-directory-brief-switches'
5834 and `list-directory-verbose-switches'."
5838 nil default-directory nil)
5839 pfx)))
5841 list-directory-brief-switches))
5842 buffer)
5854 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5862 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5864 PATTERN is assumed to represent a file-name wildcard suitable for the
5865 underlying filesystem. For Unix and GNU/Linux, each character from the
5867 the parts of the pattern which don't include wildcard characters are
5868 quoted with double quotes.
5871 on Windows), so PATTERN can use them to quote wildcard characters that
5872 need to be passed verbatim to shell commands."
5876 ;; DOS/Windows don't allow `"' in file names. So if the
5877 ;; argument has quotes, we can safely assume it is already
5878 ;; quoted by the caller.
5880 ;; We quote [&()#$'] in case their shell is a port of a
5881 ;; Unixy shell. We quote [,=+] because stock DOS and
5882 ;; Windows shells require that in some cases, such as
5883 ;; passing arguments to batch files that use positional
5884 ;; arguments like %1.
5886 pattern
5889 end)
5906 pattern))))
5913 "Program to get the amount of free space on a file system.
5914 We assume the output has the format of `df'.
5915 The value of this variable must be just a command name or file name;
5916 if you want to specify options, use `directory-free-space-args'.
5918 A value of nil disables this feature.
5920 If the function `file-system-info' is defined, it is always used in
5921 preference to the program given by this variable."
5927 "Options to use when running `directory-free-space-program'."
5932 "Return the amount of free space on directory DIR's file system.
5933 The return value is a string describing the amount of free
5934 space (normally, the number of free 1KB blocks).
5936 This function calls `file-system-info' if it is available, or
5937 invokes the program specified by `directory-free-space-program'
5938 and `directory-free-space-args'. If the system call or program
5939 is unsuccessful, or if DIR is a remote directory, this function
5940 returns nil."
5942 ;; Try to find the number of free blocks. Non-Posix systems don't
5943 ;; always have df, but might have an equivalent system call.
5952 ;; Avoid failure if the default directory does
5953 ;; not exist (Bug#2631, Bug#3911).
5956 nil t nil
5957 directory-free-space-args
5958 dir)
5960 ;; Assume that the "available" column is before the
5961 ;; "capacity" column. Find the "%" and scan backward.
5965 "[[:space:]]+[^[:space:]]+%[^%]*$"
5972 ;; The following expression replaces `dired-move-to-filename-regexp'.
5976 ;; In some locales, month abbreviations are as short as 2 letters,
5977 ;; and they can be followed by ".".
5978 ;; In Breton, a month name can include a quote character.
5991 s "+"
5994 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5995 ;; omits the Kanji characters after month and day-of-month.
5996 ;; On Mac OS X 10.3, the date format in East Asian locales is
5997 ;; day-of-month digits followed by month digits.
6003 ;; The "[0-9]" below requires the previous column to end in a digit.
6004 ;; This avoids recognizing `1 may 1997' as a date in the line:
6005 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6007 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6009 ;; For non-iso date formats, we add the ".*" in order to find
6010 ;; the last possible match. This avoids recognizing
6011 ;; `jservice 10 1024' as a date in the line:
6012 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6014 ;; vc dired listings provide the state or blanks between file
6015 ;; permissions and date. The state is always surrounded by
6016 ;; parentheses:
6017 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6018 ;; This is not supported yet.
6023 "Regular expression to match up to the file name in a directory listing.
6024 The default value is designed to recognize dates and times
6029 ;; insert-directory
6030 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6031 ;; FULL-DIRECTORY-P is nil.
6032 ;; The single line of output must display FILE's name as it was
6033 ;; given, namely, an absolute path name.
6034 ;; - must insert exactly one line for each file if WILDCARD or
6035 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6036 ;; before the file lines, plus optional text after the file lines.
6037 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6038 ;; allowed.
6039 ;; File lines should display the basename.
6040 ;; - must be consistent with
6041 ;; - functions dired-move-to-filename, (these two define what a file line is)
6042 ;; dired-move-to-end-of-filename,
6043 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6044 ;; dired-insert-headerline
6045 ;; dired-after-subdir-garbage (defines what a "total" line is)
6046 ;; - variable dired-subdir-regexp
6047 ;; - may be passed "--dired" as the first argument in SWITCHES.
6048 ;; Filename handlers might have to remove this switch if their
6049 ;; "ls" command does not support it.
6051 "Insert directory listing for FILE, formatted according to SWITCHES.
6052 Leaves point after the inserted text.
6053 SWITCHES may be a string of options, or a list of strings
6054 representing individual options.
6055 Optional third arg WILDCARD means treat FILE as shell wildcard.
6056 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6057 switches do not contain `d', so that a full listing is expected.
6059 This works by running a directory listing program
6060 whose name is in the variable `insert-directory-program'.
6061 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6063 When SWITCHES contains the long `--dired' option, this function
6064 treats it specially, for the sake of dired. However, the
6065 normally equivalent short `-D' option is just passed on to
6066 `insert-directory-program', as any other option."
6067 ;; We need the directory in order to find the right handler.
6072 wildcard full-directory-p)
6075 ;; Read the actual directory using `insert-directory-program'.
6076 ;; RESULT gets the status code.
6078 ;; putting text property `dired-filename, decode one
6079 ;; bunch by one to preserve that property.
6081 ;; This is to control encoding the arguments in call-process.
6085 default-file-name-coding-system))))
6088 ;; Run ls in the directory part of the file pattern
6089 ;; using the last component as argument.
6095 ;; NB since switches is passed to the shell, be
6096 ;; careful of malicious values, eg "-l;reboot".
6097 ;; See eg dired-safe-switches-p.
6099 shell-file-name nil t nil
6100 "-c"
6102 ""
6104 insert-directory-program
6105 " -d "
6107 switches
6109 " -- "
6110 ;; Quote some characters that have
6111 ;; special meanings in shells; but
6112 ;; don't quote the wildcards--we want
6113 ;; them to be special. We also
6114 ;; currently don't quote the quoting
6115 ;; characters in case people want to
6116 ;; use them explicitly to quote
6117 ;; wildcard characters.
6119 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6120 ;; directory if FILE is a symbolic link.
6127 insert-directory-program nil t nil
6131 ;; Split the switches at any spaces so we can
6132 ;; pass separate options as separate args.
6134 ;; Avoid lossage if FILE starts with `-'.
6142 file))))))))
6144 ;; If we got "//DIRED//" in the output, it means we got a real
6145 ;; directory listing, even if `ls' returned nonzero.
6146 ;; So ignore any errors.
6159 ;; The first time ls returns an error,
6160 ;; find the version numbers of ls,
6161 ;; and set insert-directory-ls-version
6162 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6163 ;; is equal or if the info cannot be obtained.
6164 ;; (That can mean it isn't GNU ls.)
6174 comparison)
6190 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6194 ;; If `insert-directory-program' failed, signal an error.
6196 ;; Delete the error message it may have output.
6198 ;; On non-Posix systems, we cannot open a directory, so
6199 ;; don't even try, because that will always result in
6200 ;; the ubiquitous "Access denied". Instead, show the
6201 ;; command line so the user can try to guess what went wrong.
6206 insert-directory-program
6208 file result)
6209 ;; Unix. Access the file to get a suitable error.
6216 ;; The following overshoots by one line for an empty
6217 ;; directory listed with "--dired", but without "-a"
6218 ;; switch, where the ls output contains a
6219 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6220 ;; We take care of that case later.
6228 error-lines)
6229 ;; Find all the lines that are error messages,
6230 ;; and record the bounds of each one.
6237 ;; Now read the numeric positions of file names.
6244 error-lines))
6247 error-lines)))
6249 ;; End is followed by \n or by " -> ".
6251 ;; It seems that we can't trust ls's output as to
6252 ;; byte positions of filenames.
6258 ;; Take care of the case where the ls output contains a
6259 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6260 ;; and we went one line too far back (see above).
6265 ;; Now decode what read if necessary.
6267 file-name-coding-system
6268 default-file-name-coding-system
6270 coding-no-eol
6271 val pos)
6275 ;; If no coding system is specified or detection is
6276 ;; requested, detect the coding.
6290 ;; Force no eol conversion on a file name, so
6291 ;; that CR is preserved.
6299 ;; Try to insert the amount of free space.
6302 ;; First find the line to put it on.
6306 ;; Replace "total" with "used", to avoid confusion.
6312 "Convert `ls --dired' file name position value POS to a buffer position.
6313 File name position values returned in ls --dired output
6314 count only stdout; they don't count the error messages sent to stderr.
6315 So this function converts to them to real buffer positions.
6316 ERROR-LINES is a list of buffer positions of error message lines,
6317 of the form (START END)."
6321 pos)
6325 "Insert directory listing for FILE, formatted according to SWITCHES.
6327 Like `insert-directory', but if FILE does not exist, it inserts a
6328 message to that effect instead of signaling an error."
6331 ;; Simulate the message printed by `ls'.
6335 "Functions to call with no arguments to query about killing Emacs.
6336 If any of these functions returns nil, killing Emacs is canceled.
6337 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6341 "How to ask for confirmation when leaving Emacs.
6342 If nil, the default, don't ask at all. If the value is non-nil, it should
6343 be a predicate function such as `yes-or-no-p'."
6351 "Offer to save each buffer, then kill this Emacs process.
6352 With prefix ARG, silently save all file-visiting buffers without asking.
6353 If there are active processes where `process-query-on-exit-flag'
6354 returns non-nil, asks whether processes should be killed.
6355 Runs the members of `kill-emacs-query-functions' in turn and stops
6356 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6365 ;; process-list is not defined on MSDOS.
6367 active)
6376 ;; Query the user for other things, perhaps.
6383 "Offer to save each buffer, then kill the current connection.
6384 If the current frame has no client, kill Emacs itself.
6386 With prefix ARG, silently save all file-visiting buffers, then kill.
6388 If emacsclient was started with a list of filenames to edit, then
6389 only these files will be asked to be saved."
6394 \f
6395 ;; We use /: as a prefix to "quote" a file name
6396 ;; so that magic file name handlers will not apply to it.
6400 file-name-handler-alist))
6402 ;; We depend on being the last handler on the list,
6403 ;; so that anything else which does need handling
6404 ;; has been handled already.
6405 ;; So it is safe for us to inhibit *all* magic file name handlers.
6414 default-directory))
6415 ;; Get a list of the indices of the args which are file names.
6418 ;; The first six are special because they
6419 ;; return a file name. We want to include the /:
6420 ;; in the return value.
6421 ;; So just avoid stripping it in the first place.
6428 ;; `identity' means just return the first arg
6429 ;; not stripped of its quoting.
6431 ;; `add' means add "/:" to the result.
6434 ;; `unquote-then-quote' means set buffer-file-name
6435 ;; temporarily to unquoted filename.
6437 ;; List the arguments which are filenames.
6445 ;; For all other operations, treat the first argument only
6446 ;; as the file name.
6448 method
6449 ;; Copy ARGUMENTS so we can replace elements in it.
6453 ;; Strip off the /: from the file names that have it.
6461 "/"
6478 \f
6479 ;; Symbolic modes and read-file-modes.
6482 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6483 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6484 Others, or All) for whom to produce the mask.
6485 The bit-mask that is returned extracts from mode bits the access rights
6486 for the specified category of users."
6494 "Convert CHAR to a numeric value of mode bits.
6495 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6496 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6503 ;; Rights relative to the previous file modes.
6514 "Convert a symbolic mode string specification to an equivalent number.
6516 WHO-MASK is the bit-mask specifying the category of users to which to
6517 apply the access permissions. See `file-modes-char-to-who'.
6518 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6519 RIGHTS request to add, remove, or set permissions based on existing ones,
6526 char-right)
6533 num-rights
6537 op char-right)))
6538 num-rights))
6541 "Convert symbolic file modes to numeric file modes.
6542 MODES is the string to convert, it should match
6544 See Info node `(coreutils)File permissions' for more information on this
6545 notation.
6546 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6547 MODES request to add, remove, or set permissions based on existing ones,
6561 num-who num-modes)
6564 num-modes)))
6567 "Read file modes in octal or symbolic notation and return its numeric value.
6568 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6569 ORIG-FILE is the name of a file on whose mode bits to base returned
6570 permissions if what user types requests to add, remove, or set permissions
6586 nil nil default)))
6592 \f
6593 ;; Trashcan handling.
6595 "Directory for `move-file-to-trash' to move files and directories to.
6596 This directory is only used when the function `system-move-file-to-trash'
6597 is not defined.
6598 Relative paths are interpreted relative to `default-directory'.
6599 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6609 "Move the file (or directory) named FILENAME to the trash.
6610 When `delete-by-moving-to-trash' is non-nil, this function is
6611 called by `delete-file' and `delete-directory' instead of
6612 deleting files outright.
6614 If the function `system-move-file-to-trash' is defined, call it
6615 with FILENAME as an argument.
6616 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6617 directory.
6618 Otherwise, trash FILENAME using the freedesktop.org conventions,
6619 like the GNOME, KDE and XFCE desktop environments. Emacs only
6623 ;; If `trash-directory' is non-nil, move the file there.
6627 trash-dir)))
6628 ;; We can't trash a parent directory of trash-directory.
6631 trash-dir filename))
6634 ;; Ensure that the trashed file-name is unique.
6641 ;; If `system-move-file-to-trash' is defined, use it.
6644 ;; Otherwise, use the freedesktop.org method, as specified at
6645 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6656 ;; Check if we have permissions to delete.
6660 ;; The trashed file cannot be the trash dir or its parent.
6663 trash-files-dir filename))
6666 trash-info-dir filename))
6668 ;; Ensure that the trash directory exists; otherwise, create it.
6679 ;; Try to move to trash with .trashinfo undo information
6684 ;; Perform url-encoding on FN. For compatibility with
6685 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6686 ;; for path separators.
6691 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6692 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6705 fn))
6710 ;; Attempt to make .trashinfo file, trying up to 5
6711 ;; times. The .trashinfo file is opened with O_EXCL,
6712 ;; as per trash-spec 0.7, even if that can be a problem
6713 ;; on old NFS versions...
6717 trash-files-dir))
6719 success info-fn)
6724 trash-info-dir))
6732 ;; Uniquify new-fn. (Some file managers do not
6733 ;; like Emacs-style backup file names---e.g. bug
6734 ;; 170956 in Konqueror bug tracker.)
6739 ;; Finally, try to move the file to the trashcan.
6743 \f
6768 ;;; files.el ends here