| blob | 1bde2be0ef05ab0daf64758c2577d5612359a3cb |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
30 ;;; Code:
37 "Backups of edited data files."
41 "Finding files."
46 "Non-nil means delete auto-save file when a buffer is saved or killed.
48 Note that the auto-save file will not be deleted if the buffer is killed
49 when it has unsaved changes."
54 nil
55 "Alist of abbreviations for file directories.
56 A list of elements of the form (FROM . TO), each meaning to replace
57 FROM with TO when it appears in a directory name. This replacement is
58 done when setting up the default directory of a newly visited file.
61 FROM and TO should be equivalent names, which refer to the
62 same directory. Do not use `~' in the TO strings;
63 they should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
128 "Non-nil means create backups by copying to preserve a privileged owner.
129 Renaming may still be used (subject to control of other variables)
130 when it would not result in changing the owner of the file or if the owner
131 has a user id greater than the value of this variable. This is useful
132 when low-numbered uid's are used for special system users (such as root)
133 that must maintain ownership of certain files.
134 This variable is relevant only if `backup-by-copying' and
135 `backup-by-copying-when-mismatch' are nil."
140 "Predicate that looks at a file name and decides whether to make backups.
144 "Non-nil in a buffer means always offer to save buffer on exit.
145 Do so even if the buffer is not visiting a file.
146 Automatically local in all buffers."
152 "Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
159 "Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
167 "Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
196 "The directory for writing temporary files."
203 "The directory for writing small temporary files.
204 If non-nil, this directory is used instead of `temporary-file-directory'
205 by programs that create small temporary files. This is for systems that
206 have fast storage with limited space, such as a RAM disk."
211 ;; The system null device. (Should reference NULL_DEVICE from C.)
239 "Non-nil means protect against I/O errors while saving files.
240 Some modes set this non-nil in particular buffers.
242 This feature works by writing the new contents into a temporary file
243 and then renaming the temporary file to replace the original.
244 In this way, any I/O error in writing leaves the original untouched,
245 and there is never any instant where the file is nonexistent.
247 Note that this feature forces backups to be made by copying.
248 Yet, at the same time, saving a precious file
249 breaks any hard links between it and other files.
251 This feature is advisory: for example, if the directory in which the
252 file is being saved is not writable, Emacs may ignore a non-nil value
253 of `file-precious-flag' and write directly into the file.
255 See also: `break-hardlink-on-save'."
260 "Non-nil means when saving a file that exists under several names
261 \(i.e., has multiple hardlinks), break the hardlink associated with
262 `buffer-file-name' and write to a new file, so that the other
263 instances of the file are not affected by the save.
265 If `buffer-file-name' refers to a symlink, do not break the symlink.
267 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
268 For example, if the directory in which a file is being saved is not
269 itself writable, then error instead of saving in some
270 hardlink-nonbreaking way.
272 See also `backup-by-copying' and `backup-by-copying-when-linked'."
278 "Control use of version numbers for backup files.
279 When t, make numeric backup versions unconditionally.
280 When nil, make them for files that have some already.
281 The value `never' means do not make them."
291 "When cleaning directory, number of versions to keep."
297 "If t, delete excess backup versions silently.
298 If nil, ask confirmation. Any other value prevents any trimming."
305 "Number of oldest versions to keep when a new numbered backup is made."
311 "Number of newest versions to keep when a new numbered backup is made.
312 Includes the new backup. Must be > 0"
318 "Whether to add a newline automatically at the end of the file.
320 A value of t means do this only when the file is about to be saved.
321 A value of `visit' means do this right after the file is visited.
322 A value of `visit-save' means do it at both of those times.
323 Any other non-nil value means ask user whether to add a newline, when saving.
324 A value of nil means don't add newlines.
326 Certain major modes set this locally to the value obtained
327 from `mode-require-final-newline'."
336 "Whether to add a newline at end of file, in certain major modes.
337 Those modes set `require-final-newline' to this value when you enable them.
338 They do so because they are often used for files that are supposed
339 to end in newlines, and the question is how to arrange that.
341 A value of t means do this only when the file is about to be saved.
342 A value of `visit' means do this right after the file is visited.
343 A value of `visit-save' means do it at both of those times.
344 Any other non-nil value means ask user whether to add a newline, when saving.
346 A value of nil means do not add newlines. That is a risky choice in this
347 variable since this value is used for modes for files that ought to have
348 final newlines. So if you set this to nil, you must explicitly check and
349 add a final newline, whenever you save a file that really needs one."
359 "Non-nil says by default do auto-saving of every file-visiting buffer."
365 ;; Don't put "\\2" inside expand-file-name, since it will be
366 ;; transformed to "/2" on DOS/Windows.
368 "Transforms to apply to buffer file name before making auto-save file name.
369 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
370 REGEXP is a regular expression to match against the file name.
371 If it matches, `replace-match' is used to replace the
372 matching part with REPLACEMENT.
373 If the optional element UNIQUIFY is non-nil, the auto-save file name is
374 constructed by taking the directory part of the replaced file-name,
375 concatenated with the buffer file name with all directory separators
376 changed to `!' to prevent clashes. This will not work
377 correctly if your filesystem truncates the resulting name.
379 All the transforms in the list are tried, in the order they are listed.
380 When one transform applies, its result is final;
381 no further transforms are tried.
383 The default value is set up to put the auto-save file into the
384 temporary directory (see the variable `temporary-file-directory') for
385 editing a remote file.
387 On MS-DOS filesystems without long names this variable is always
388 ignored."
396 "Non-nil means save word abbrevs too when files are saved.
397 If `silently', don't ask the user before saving."
402 "Non-nil means allow `find-file' to visit directories.
403 To visit the directory, `find-file' runs `find-directory-functions'."
408 "List of functions to try in sequence to visit a directory.
409 Each function is called with the directory name as the sole argument
410 and should return either a buffer or nil."
414 ;;;It is not useful to make this a local variable.
415 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
417 "List of functions to be called for `find-file' on nonexistent file.
418 These functions are called as soon as the error is detected.
419 Variable `buffer-file-name' is already set up.
424 ;;;It is not useful to make this a local variable.
425 ;;;(put 'find-file-hooks 'permanent-local t)
428 "List of functions to be called after a buffer is loaded from a file.
429 The buffer's local variables (if any) will have been processed before the
430 functions are called."
437 "List of functions to be called before writing out a buffer to a file.
438 If one of them returns non-nil, the file is considered already written
439 and the rest are not called.
440 These hooks are considered to pertain to the visited file.
441 So any buffer-local binding of this variable is discarded if you change
443 change the major mode.
445 This hook is not run if any of the functions in
446 `write-contents-functions' returns non-nil. Both hooks pertain
447 to how to save a buffer to file, for instance, choosing a suitable
448 coding system and setting mode bits. (See Info
449 node `(elisp)Saving Buffers'.) To perform various checks or
460 "List of functions to be called before writing out a buffer to a file.
461 If one of them returns non-nil, the file is considered already written
462 and the rest are not called and neither are the functions in
463 `write-file-functions'.
465 This variable is meant to be used for hooks that pertain to the
466 buffer's contents, not to the particular visited file; thus,
467 `set-visited-file-name' does not clear this variable; but changing the
468 major mode does clear it.
470 For hooks that _do_ pertain to the particular visited file, use
471 `write-file-functions'. Both this variable and
472 `write-file-functions' relate to how a buffer is saved to file.
473 To perform various checks or updates before the buffer is saved,
480 "Control use of local variables in files you visit.
481 The value can be t, nil, :safe, :all, or something else.
483 A value of t means file local variables specifications are obeyed
484 if all the specified variable values are safe; if any values are
485 not safe, Emacs queries you, once, whether to set them all.
486 \(When you say yes to certain values, they are remembered as safe.)
488 :safe means set the safe variables, and ignore the rest.
489 :all means set all variables, whether safe or not.
490 (Don't set it permanently to :all.)
491 A value of nil means always ignore the file local variables.
493 Any other value means always query you once whether to set them all.
494 \(When you say yes to certain values, they are remembered as safe, but
497 This variable also controls use of major modes specified in
498 a -*- line.
501 always obeys file local variable specifications and the -*- line,
502 and ignores this variable."
503 :risky t
512 "Like `enable-local-variables' but meant for buffer-local bindings.
513 The meaningful values are nil and non-nil. The default is non-nil.
514 If a major mode sets this to nil, buffer-locally, then any local
515 variables list in the file will be ignored.
517 This variable does not affect the use of major modes
522 The value can be t, nil or something else.
523 A value of t means obey `eval' variables.
524 A value of nil means ignore them; anything else means query."
525 :risky t
531 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
540 "Non-nil means buffers visiting files read-only do so in view mode.
541 In fact, this means that all read-only buffers normally have
542 View mode enabled, including buffers that are read-only because
543 you visit a file you cannot alter, and buffers you make read-only
549 "History list of file names entered in the minibuffer.
551 Maximum length of the history list is determined by the value
553 \f
556 "Provides support for ange-ftp host name completion.
557 Runs the usual ange-ftp hook, but only for completion operations."
558 ;; Having this here avoids the need to load ange-ftp when it's not
559 ;; really in use.
565 inhibit-file-name-handlers)))
570 "Convert a standard file's name to something suitable for the OS.
571 This means to guarantee valid names and perhaps to canonicalize
572 certain patterns.
574 FILENAME should be an absolute file name since the conversion rules
575 sometimes vary depending on the position in the file name. E.g. c:/foo
576 is a valid DOS file name, but c:/bar/c:/foo is not.
578 This function's standard definition is trivial; it just returns
579 the argument. However, on Windows and DOS, replace invalid
580 characters. On DOS, make sure to obey the 8.3 limitations.
581 In the native Windows build, turn Cygwin names into native names,
582 and also turn slashes into backslashes if the shell requires it (see
583 `w32-shell-dos-semantics').
585 See Info node `(elisp)Standard File Names' for more details."
589 ;; Replace invalid filename characters with !
593 name)
594 filename))
597 "Read directory name, prompting with PROMPT and completing in directory DIR.
598 Value is not expanded---you must call `expand-file-name' yourself.
599 Default name to DEFAULT-DIRNAME if user exits with the same
600 non-empty string that was inserted by this function.
601 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
602 or just DIR if INITIAL is nil.)
603 If the user exits with an empty minibuffer, this function returns
604 an empty string. (This can only happen if the user erased the
605 pre-inserted contents or if `insert-default-directory' is nil.)
606 Fourth arg MUSTMATCH non-nil means require existing directory's name.
607 Non-nil and non-t means also require confirmation after completion.
608 Fifth arg INITIAL specifies text to start with.
609 DIR should be an absolute directory name. It defaults to
610 the value of `default-directory'."
615 dir))
616 mustmatch initial
619 \f
621 "Show the current default directory."
626 "Value of the CDPATH environment variable, as a list.
630 "Explode a search path into a list of directory names.
631 Directories are separated by occurrences of `path-separator'
632 \(which is colon in GNU and GNU-like systems)."
633 ;; We could use split-string here.
641 nil
646 cd-list)))
649 "Change current directory to given absolute file name DIR."
650 ;; Put the name into directory syntax now,
651 ;; because otherwise expand-file-name may give some bad results.
653 ;; We used to additionally call abbreviate-file-name here, for an
654 ;; unknown reason. Problem is that most buffers are setup
655 ;; without going through cd-absolute and don't call
656 ;; abbreviate-file-name on their default-directory, so the few that
657 ;; do end up using a superficially different directory.
669 "Make DIR become the current buffer's default directory.
670 If your environment includes a `CDPATH' variable, try each one of
671 that list of directories (separated by occurrences of
672 `path-separator') when resolving a relative directory name.
673 The path separator is colon in GNU and GNU-like systems."
676 default-directory default-directory
692 cd-path)
693 nil))
697 "Load the Lisp file named FILE."
698 ;; This is a case where .elc makes a lot of sense.
705 "Search for FILENAME through PATH.
706 If found, return the absolute file name of FILENAME, with its suffixes;
707 otherwise return nil.
708 PATH should be a list of directories to look in, like the lists in
709 `exec-path' or `load-path'.
710 If SUFFIXES is non-nil, it should be a list of suffixes to append to
713 If non-nil, PREDICATE is used instead of `file-readable-p'.
714 PREDICATE can also be an integer to pass to the `access' system call,
715 in which case file-name handlers are ignored. This usage is deprecated.
717 For compatibility, PREDICATE can also be one of the symbols
718 `executable', `readable', `writable', or `exists', or a list of
719 one or more of those symbols."
730 "Do completion for file names passed to `locate-file'."
733 ;; FIXME: maybe we should use completion-file-name-table instead,
734 ;; tho at least for `load', the arg is passed through
735 ;; substitute-in-file-name for historical reasons.
754 string-file dir))
760 string-dir names string-file pred action)))))
763 "Do completion for file names passed to `locate-file'.
764 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
767 string nil action))
772 "Regexp of directory names which stop the search in `locate-dominating-file'.
773 Any directory whose name matches this regexp will be treated like
774 a kind of root directory by `locate-dominating-file' which will stop its search
775 when it bumps into it.
776 The default regexp prevents fruitless and time-consuming attempts to find
777 special files in directories in which filenames are interpreted as hostnames,
780 ;; (defun locate-dominating-files (file regexp)
781 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
782 ;; Stop at the first parent where a matching file is found and return the list
783 ;; of files that that match in this directory."
784 ;; (catch 'found
785 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
786 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
787 ;; (let ((user nil)
788 ;; ;; Abbreviate, so as to stop when we cross ~/.
789 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
790 ;; files)
791 ;; (while (and dir
792 ;; ;; As a heuristic, we stop looking up the hierarchy of
793 ;; ;; directories as soon as we find a directory belonging to
794 ;; ;; another user. This should save us from looking in
795 ;; ;; things like /net and /afs. This assumes that all the
796 ;; ;; files inside a project belong to the same user.
797 ;; (let ((prev-user user))
798 ;; (setq user (nth 2 (file-attributes dir)))
799 ;; (or (null prev-user) (equal user prev-user))))
800 ;; (if (setq files (condition-case nil
801 ;; (directory-files dir 'full regexp 'nosort)
802 ;; (error nil)))
803 ;; (throw 'found files)
804 ;; (if (equal dir
805 ;; (setq dir (file-name-directory
806 ;; (directory-file-name dir))))
807 ;; (setq dir nil))))
808 ;; nil)))
811 "Look up the directory hierarchy from FILE for a file named NAME.
812 Stop at the first parent directory containing a file NAME,
813 and return the directory. Return nil if not found."
814 ;; We used to use the above locate-dominating-files code, but the
815 ;; directory-files call is very costly, so we're much better off doing
816 ;; multiple calls using the code in here.
817 ;;
818 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
819 ;; `name' in /home or in /.
823 ;; `user' is not initialized outside the loop because
824 ;; `file' may not exist, so we may have to walk up part of the
825 ;; hierarchy before we find the "initial UID".
827 try)
830 ;; FIXME: Disabled this heuristic because it is sometimes
831 ;; inappropriate.
832 ;; As a heuristic, we stop looking up the hierarchy of
833 ;; directories as soon as we find a directory belonging
834 ;; to another user. This should save us from looking in
835 ;; things like /net and /afs. This assumes that all the
836 ;; files inside a project belong to the same user.
837 ;; (let ((prev-user user))
838 ;; (setq user (nth 2 (file-attributes file)))
839 ;; (and prev-user (not (equal user prev-user))))
847 root))
851 "Search for COMMAND in `exec-path' and return the absolute file name.
852 Return nil if COMMAND is not found anywhere in `exec-path'."
853 ;; Use 1 rather than file-executable-p to better match the behavior of
854 ;; call-process.
858 "Load the Emacs Lisp library named LIBRARY.
859 This is an interface to the function `load'. LIBRARY is searched
860 for in `load-path', both with and without `load-suffixes' (as
861 well as `load-file-rep-suffixes').
863 See Info node `(emacs)Lisp Libraries' for more details.
864 See `load-file' for a different interface to `load'."
868 load-path
873 "Test whether FILE specifies a location on a remote system.
874 Returns nil or a string identifying the remote connection (ideally
875 a prefix of FILE). For example, the remote identification for filename
878 less reliable than accessing local files.
879 Furthermore, relative file names do not work across remote connections.
881 IDENTIFICATION specifies which part of the identification shall
882 be returned as string. IDENTIFICATION can be the symbol
883 `method', `user', `host' or `localname'; any other value is
884 handled like nil and means to return the complete identification
885 string.
887 If CONNECTED is non-nil, the function returns an identification only
888 if FILE is located on a remote system, and a connection is established
889 to that remote system.
891 `file-remote-p' will never open a connection on its own."
895 nil)))
898 "Copy the file FILE into a temporary file on this machine.
899 Returns the name of the local copy, or nil, if FILE is directly
900 accessible."
901 ;; This formerly had an optional BUFFER argument that wasn't used by
902 ;; anything.
906 nil)))
909 "Return the truename of FILENAME, which should be absolute.
910 The truename of a file name is found by chasing symbolic links
911 both at the level of the file and at the level of the directories
912 containing it, until no links are left at any level.
915 ;; COUNTER and PREV-DIRS are only used in recursive calls.
916 ;; COUNTER can be a cons cell whose car is the count of how many
917 ;; more links to chase before getting an error.
918 ;; PREV-DIRS can be a cons cell whose car is an alist
919 ;; of truenames we've just recently computed.
933 ;; For speed, remove the ange-ftp completion handler from the list.
934 ;; We know it's not needed here.
935 ;; For even more speed, do this only on the outermost call.
942 ;; andrewi@harlequin.co.uk - none of the following code (except for
943 ;; invoking the file-name handler) currently applies on Windows
944 ;; (ie. there are no native symlinks), but there is an issue with
945 ;; case differences being ignored by the OS, and short "8.3 DOS"
946 ;; name aliases existing for all files. (The short names are not
947 ;; reported by directory-files, but can be used to refer to files.)
948 ;; It seems appropriate for file-truename to resolve these issues in
949 ;; the most natural way, which on Windows is to call the function
950 ;; `w32-long-file-name' - this returns the exact name of a file as
951 ;; it is stored on disk (expanding short name aliases with the full
952 ;; name in the process).
955 ;; For file name that has a special handler, call handler.
956 ;; This is so that ange-ftp can save time by doing a no-op.
959 ;; If filename contains a wildcard, newname will be the old name.
961 ;; If filename exists, use the long name. If it doesn't exist,
962 ;; drill down until we find a directory that exists, and use
963 ;; the long name of that, with the extra non-existent path
964 ;; components concatenated.
966 missing rest)
969 ;; Include the preceding directory separator in the missing
970 ;; part so subsequent recursion on the rest works.
975 ""
980 ;; If this file directly leads to a link, process that iteratively
981 ;; so that we don't use lots of stack.
987 ;; For file name that has a special handler, call handler.
988 ;; This is so that ange-ftp can save time by doing a no-op.
991 done t)
993 target dirfile)
994 ;; Get the truename of the directory.
996 ;; If these are equal, we have the (or a) root directory.
998 ;; If this is the same dir we last got the truename for,
999 ;; save time--don't recalculate.
1009 done t)
1012 done t)
1013 ;; Put it back on the file name.
1015 ;; Is the file name the name of a link?
1018 ;; Yes => chase that link, then start all over
1019 ;; since the link may point to a directory name that uses links.
1020 ;; We can't safely use expand-file-name here
1021 ;; since target might look like foo/../bar where foo
1022 ;; is itself a link. Instead, we handle . and .. above.
1025 target
1027 done nil)
1028 ;; No, we are done!
1030 filename))
1033 "Chase links in FILENAME until a name that is not a link.
1034 Unlike `file-truename', this does not check whether a parent
1035 directory name is a symbolic link.
1036 If the optional argument LIMIT is a number,
1037 it means chase no more than that many links and then stop."
1045 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1048 ;; Handle `..' by hand, since it needs to work in the
1049 ;; target of any directory symlink.
1050 ;; This code is not quite complete; it does not handle
1051 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1055 ;; Chase links in the default dir of the symlink.
1059 ;; Now find the parent of that dir.
1063 newname))
1066 "Create a temporary file.
1067 The returned file name (created by appending some random characters at the end
1068 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1069 is guaranteed to point to a newly created empty file.
1070 You can then use `write-region' to write new data into the file.
1072 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1074 If SUFFIX is non-nil, add that at the end of the file name."
1076 file)
1079 ;; Create temp files with strict access rights. It's easy to
1080 ;; loosen them later, whereas it's impossible to close the
1081 ;; time-window of loose permissions otherwise.
1089 temporary-file-directory)
1091 temporary-file-directory))))
1097 nil)
1099 ;; the file was somehow created by someone else between
1100 ;; `make-temp-name' and `write-region', let's try again.
1101 nil)
1102 file)
1103 ;; Reset the umask.
1107 "Change the encoding of FILE's name from CODING to NEW-CODING.
1108 The value is a new name of FILE.
1109 Signals a `file-already-exists' error if a file of the new name
1110 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1111 is non-nil. A number as fourth arg means request confirmation if
1112 the new name already exists. This is what happens in interactive
1113 use with M-x."
1116 default-file-name-coding-system))
1118 from-coding to-coding)
1120 ;; We provide the default coding only when it seems that
1121 ;; the filename is correctly decoded by the default
1122 ;; coding.
1128 filename default-coding)
1129 default-coding))
1133 ;; We provide the default coding only when a user is going to
1134 ;; change the encoding not from the default coding.
1138 filename from-coding)))
1141 filename from-coding default-coding)
1142 default-coding)))
1146 default-file-name-coding-system))
1147 ;; FILE should have been decoded by DEFAULT-CODING.
1151 ;; Suppress further encoding.
1156 newname))
1157 \f
1159 "Whether confirmation is requested before visiting a new file or buffer.
1160 If nil, confirmation is not requested.
1161 If the value is `after-completion', confirmation is only
1162 requested if the user called `minibuffer-complete' right before
1163 `minibuffer-complete-and-exit'.
1164 Any other non-nil value means to request confirmation.
1166 This affects commands like `switch-to-buffer' and `find-file'."
1174 "Whether to request confirmation before visiting a new file or buffer.
1175 The variable `confirm-nonexistent-file-or-buffer' determines the
1176 return value, which may be passed as the REQUIRE-MATCH arg to
1177 `read-buffer' or `find-file-read-args'."
1185 "Read the name of a buffer to switch to and return as a string.
1186 It is intended for `switch-to-buffer' family of commands since they
1187 need to omit the name of current buffer from the list of completions
1188 and default values."
1193 ;; Since rbts-completion-table is built dynamically, we
1194 ;; can't just add it to the default value of
1195 ;; icomplete-with-completion-tables, so we add it
1196 ;; here manually.
1201 icomplete-with-completion-tables))))
1206 "Select the buffer specified by BUFFER-OR-NAME in another window.
1207 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1208 nil. Return the buffer switched to.
1210 If called interactively, prompt for the buffer name using the
1211 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1212 determines whether to request confirmation before creating a new
1213 buffer.
1215 If BUFFER-OR-NAME is a string and does not identify an existing
1216 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1217 nil, switch to the buffer returned by `other-buffer'.
1219 Optional second argument NORECORD non-nil means do not put this
1220 buffer at the front of the list of recently selected ones.
1222 This uses the function `display-buffer' as a subroutine; see its
1223 documentation for additional customization information."
1227 same-window-buffer-names same-window-regexps)
1231 "Switch to buffer BUFFER-OR-NAME in another frame.
1232 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1233 nil. Return the buffer switched to.
1235 If called interactively, prompt for the buffer name using the
1236 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1237 determines whether to request confirmation before creating a new
1238 buffer.
1240 If BUFFER-OR-NAME is a string and does not identify an existing
1241 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1242 nil, switch to the buffer returned by `other-buffer'.
1244 Optional second arg NORECORD non-nil means do not put this
1245 buffer at the front of the list of recently selected ones.
1247 This uses the function `display-buffer' as a subroutine; see its
1248 documentation for additional customization information."
1252 same-window-buffer-names same-window-regexps)
1256 "Display buffer BUFFER in another frame.
1257 This uses the function `display-buffer' as a subroutine; see
1258 its documentation for additional customization information."
1261 same-window-buffer-names same-window-regexps
1263 new-window)
1265 ;; This may have been here in order to prevent the new frame from hiding
1266 ;; the old frame. But it does more harm than good.
1267 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1268 ;;(lower-frame (window-frame new-window))
1270 ;; This may have been here in order to make sure the old-frame gets the
1271 ;; focus. But not only can it cause an annoying flicker, with some
1272 ;; window-managers it just makes the window invisible, with no easy
1273 ;; way to recover it. --Stef
1274 ;;(make-frame-invisible (window-frame old-window))
1275 ;;(make-frame-visible (window-frame old-window))
1276 ))
1282 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1283 BODY should use the minibuffer at most once.
1284 Recursive uses of the minibuffer will not be affected."
1290 ;; Clear out this hook so it does not interfere
1291 ;; with any recursive minibuffer usage.
1307 t))
1310 "Edit file FILENAME.
1311 Switch to a buffer visiting file FILENAME,
1312 creating one if none already exists.
1313 Interactively, the default if you just type RET is the current directory,
1314 but the visited file name is available through the minibuffer history:
1315 type M-n to pull it into the minibuffer.
1317 You can visit files on remote machines by specifying something
1318 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1319 also visit local files as a different user by specifying
1320 /sudo::FILE for the file name.
1321 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1322 manual, for more about this.
1324 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1325 expand wildcards (if any) and visit multiple files. You can
1326 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1328 To visit a file without any kind of conversion and without
1339 "Edit file FILENAME, in another window.
1342 an existing one. See the function `display-buffer'.
1344 Interactively, the default if you just type RET is the current directory,
1345 but the visited file name is available through the minibuffer history:
1346 type M-n to pull it into the minibuffer.
1348 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1349 expand wildcards (if any) and visit multiple files."
1362 "Edit file FILENAME, in another frame.
1365 an existing one. See the function `display-buffer'.
1367 Interactively, the default if you just type RET is the current directory,
1368 but the visited file name is available through the minibuffer history:
1369 type M-n to pull it into the minibuffer.
1371 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1372 expand wildcards (if any) and visit multiple files."
1385 "Edit the existing file FILENAME.
1387 file names with wildcards."
1396 "Edit file FILENAME but don't allow changes.
1410 value))
1413 "Edit file FILENAME in another window but don't allow changes.
1427 value))
1430 "Edit file FILENAME in another frame but don't allow changes.
1444 value))
1447 "Find file FILENAME as a replacement for the file in the next window.
1448 This command does not select that window.
1452 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1453 expand wildcards (if any) and replace the file with multiple files."
1464 "Find alternate file: " file-dir nil
1466 t))))
1474 "Find file FILENAME, select its buffer, kill previous buffer.
1475 If the current buffer now contains an empty file that you just visited
1476 \(presumably by mistake), use this command to visit the file you really want.
1480 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1481 expand wildcards (if any) and replace the file with multiple files.
1483 If the current buffer is an indirect buffer, or the base buffer
1484 for one or more indirect buffers, the other buffer(s) are not
1485 killed."
1494 "Find alternate file: " file-dir nil
1496 t)))
1511 ;; Run `kill-buffer-hook' here. It needs to happen before
1512 ;; variables like `buffer-file-name' etc are set to nil below,
1513 ;; because some of the hooks that could be invoked
1514 ;; (e.g., `save-place-to-alist') depend on those variables.
1515 ;;
1516 ;; Note that `kill-buffer-hook' is not what queries whether to
1517 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1518 ;; asks that itself. Thus, there's no need to temporarily do
1519 ;; `(set-buffer-modified-p nil)' before running this hook.
1521 ;; Okay, now we can end-of-life the old buffer.
1528 ;; This prevents us from finding the same buffer
1529 ;; if we specified the same file again.
1533 ;; Likewise for dired buffers.
1537 ;; This executes if find-file gets an error
1538 ;; and does not really find anything.
1539 ;; We put things back as they were.
1540 ;; If find-file actually finds something, we kill obuf below.
1549 ;; We already ran these; don't run them again.
1552 \f
1554 "Create a suitably named buffer for visiting FILENAME, and return it.
1555 FILENAME (sans directory) is used unchanged if that name is free;
1556 otherwise a string <2> or <3> or ... is appended to get an unused name.
1557 Spaces at the start of FILENAME (sans directory) are removed."
1566 "Create and return a buffer with a name based on NAME.
1567 Choose the buffer's name using `generate-new-buffer-name'."
1571 "Regexp to match the automounter prefix in a directory name."
1579 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1581 home directory is a root directory) and removes automounter prefixes
1582 \(see the variable `automount-dir-prefix')."
1583 ;; Get rid of the prefixes added by the automounter.
1590 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1591 ;; To fix this right, we need a `file-name-case-sensitive-p'
1592 ;; function, but we don't have that yet, so just guess.
1595 ;; If any elt of directory-abbrev-alist matches this name,
1596 ;; abbreviate accordingly.
1602 ;; Compute and save the abbreviated homedir name.
1603 ;; We defer computing this until the first time it's needed, to
1604 ;; give time for directory-abbrev-alist to be set properly.
1605 ;; We include a slash at the end, to avoid spurious matches
1606 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1613 ;; If FILENAME starts with the abbreviated homedir,
1614 ;; make it start with `~' instead.
1616 ;; If the home dir is just /, don't change it.
1619 ;; MS-DOS root directories can come with a drive letter;
1620 ;; Novell Netware allows drive letters beyond `Z:'.
1628 filename)))
1631 "List of logical names for which visiting shouldn't save the true dirname."
1636 "Return the buffer visiting file FILENAME (a string).
1637 This is like `get-file-buffer', except that it checks for any buffer
1638 visiting the same file, possibly under a different name.
1639 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1640 and others are ignored.
1641 If there is no such live buffer, return nil."
1654 found)
1664 ;; Verify this buffer's file number
1665 ;; still belongs to its file.
1668 attributes)
1672 found))))
1673 \f
1675 "Non-nil means file-visiting commands should handle wildcards.
1676 For example, if you specify `*.c', that would visit all the files
1677 whose names match the pattern."
1683 "Non-nil means suppress warning messages for symlinked files.
1684 When nil, Emacs prints a warning when visiting a file that is already
1685 visited, but with a different name. Setting this option to t
1686 suppresses this warning."
1692 "Maximum size of file above which a confirmation is requested.
1693 When nil, never request confirmation."
1700 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1701 OP-TYPE specifies the file operation being performed (for message to user)."
1711 "Read file FILENAME into a buffer and return the buffer.
1712 If a buffer exists visiting FILENAME, return that one, but
1713 verify that the file has not changed since visited or saved.
1714 The buffer is not selected, just returned to the caller.
1715 Optional second arg NOWARN non-nil means suppress any warning messages.
1716 Optional third arg RAWFILE non-nil means the file is read literally.
1717 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1718 and visit all the matching files. When wildcards are actually
1719 used and expanded, return a list of buffers that are visiting
1720 the various files."
1727 'find-directory-functions
1730 filename)))
1733 find-file-wildcards
1747 ;; Find any buffer for a file which has same truename.
1749 ;; Let user know if there is a buffer with the same truename.
1753 find-file-suppress-same-file-warnings
1757 ;; Optionally also find that buffer.
1760 ;; Check to see if the file looks uncommonly large.
1764 ;; We are using an existing buffer.
1771 ;; Certain files should be reverted automatically
1772 ;; if they have changed on disk and not in the buffer.
1780 found))
1790 "File %s changed on disk. Discard your edits? "
1795 "File %s changed on disk. Discard your edits in %s? "
1803 ;; Check if a formerly read-only file has become
1804 ;; writable and vice versa, but if the buffer agrees
1805 ;; with the new state of the file, that is ok too.
1813 buffer-file-name
1822 ;; It is confusing to ask whether to visit
1823 ;; non-literally if they have the file in
1824 ;; hexl-mode.
1830 "The file %s is already visited normally,
1831 and you have edited the buffer. Now you have asked to visit it literally,
1832 meaning no coding system handling, format conversion, or local variables.
1833 Emacs can only visit a file in one way at a time.
1835 Do you want to save the file, and visit it literally instead? "
1836 "The file %s is already visited literally,
1837 meaning no coding system handling, format conversion, or local variables.
1838 You have edited the buffer. Now you have asked to visit the file normally,
1839 but Emacs can only visit a file in one way at a time.
1846 rawfile truename number))
1850 "\
1851 Do you want to discard your changes, and visit the file literally now? "
1852 "\
1855 rawfile truename number)
1861 "The file %s is already visited normally.
1862 You have asked to visit it literally,
1863 meaning no coding system decoding, format conversion, or local variables.
1864 But Emacs can only visit a file in one way at a time.
1866 Do you want to revisit the file literally now? "
1867 "The file %s is already visited literally,
1868 meaning no coding system decoding, format conversion, or local variables.
1869 You have asked to visit it normally,
1870 but Emacs can only visit a file in one way at a time.
1875 rawfile truename number)
1878 ;; Return the buffer we are using.
1879 buf)
1880 ;; Create a new buffer.
1882 ;; find-file-noselect-1 may use a different buffer.
1884 rawfile truename number))))))
1890 ;; Needed in case we are re-visiting the file with a different
1891 ;; text representation.
1908 filename)))
1909 ;; Unconditionally set error
1919 filename)))
1920 ;; Run find-file-not-found-functions until one returns non-nil.
1922 ;; If they fail too, set error.
1924 ;; Record the file's truename, and maybe use that as visited name.
1932 ;; Set buffer's default directory to that of the file.
1934 ;; Turn off backup files for certain file names. Since
1935 ;; this is a permanent local, the major mode won't eliminate it.
1950 \f
1952 "Like `insert-file-contents', but only reads in the file literally.
1953 A buffer may be modified in several ways after reading into the buffer,
1954 to Emacs features such as format decoding, character code
1955 conversion, `find-file-hook', automatic uncompression, etc.
1957 This function ensures that none of these modifications will take place."
1965 nil))
1968 inhibit-file-name-handlers))
1981 filename)))
1982 ;; Check whether the file is uncommonly large
1993 "Insert contents of file FILENAME into buffer after point with no conversion.
1995 This function is meant for the user to run interactively.
1996 Don't call it from programs! Use `insert-file-contents-literally' instead.
1997 \(Its calling sequence is different; see its documentation)."
2002 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2007 "Visit file FILENAME with no conversion of any kind.
2008 Format conversion and character code conversion are both disabled,
2009 and multibyte characters are disabled in the resulting buffer.
2010 The major mode used is Fundamental mode regardless of the file name,
2011 and local variable specifications in the file are ignored.
2012 Automatic uncompression and adding a newline at the end of the
2013 file due to `require-final-newline' is also disabled.
2015 You cannot absolutely rely on this function to result in
2016 visiting the file literally. If Emacs already has a buffer
2017 which is visiting the file, you get the existing buffer,
2018 regardless of whether it was created literally or not.
2020 In a Lisp program, if you want to be sure of accessing a file's
2021 contents literally, you should create a temporary buffer and then read
2022 the file contents into it using `insert-file-contents-literally'."
2025 \f
2029 after-find-file-from-revert-buffer
2030 nomodes)
2031 "Called after finding a file and by the default revert function.
2032 Sets buffer mode, parses local variables.
2033 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2034 error in reading the file. WARN non-nil means warn if there
2035 exists an auto-save file more recent than the visited file.
2036 NOAUTO means don't mess with auto-save mode.
2037 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2038 means this call was from `revert-buffer'.
2039 Fifth arg NOMODES non-nil means don't alter the file's modes.
2040 Finishes by calling the functions in `find-file-hook'
2041 unless NOMODES is non-nil."
2044 nil
2054 ;; No need to warn if buffer is auto-saved
2055 ;; under the name of the visited file.
2057 auto-save-visited-file-name))
2060 buffer-file-name))
2080 ;; Make people do a little extra work (C-x C-q)
2081 ;; before altering a backup file.
2084 ;; When a file is marked read-only,
2085 ;; make the buffer read-only even if root is looking at it.
2093 ;; If requested, add a newline at the end of the file.
2103 view-read-only
2109 "Eval BODY and turn any error into a FORMAT message.
2110 FORMAT can have a %s escape which will be replaced with the actual error.
2111 If `debug-on-error' is set, errors are not caught, so that you can
2112 debug them.
2113 Avoid using a large BODY since it is duplicated."
2122 "Choose the major mode for this buffer automatically.
2123 Also sets up any specified local variables of the file.
2124 Uses the visited file name, the -*- line, and the local variables spec.
2126 This function is called automatically from `find-file'. In that case,
2127 we may set up the file-specified mode and local variables,
2128 depending on the value of `enable-local-variables'.
2129 In addition, if `local-enable-local-variables' is nil, we do
2130 not set local variables (though we do notice a mode specified with -*-.)
2132 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2133 or from Lisp without specifying the optional argument FIND-FILE;
2134 in that case, this function acts as if `enable-local-variables' were t."
2142 ;; Turn font lock off and on, to make sure it takes account of
2143 ;; whatever file local variables are relevant to it.
2145 ;; Font-lock-mode (now in font-core.el) can be ON when
2146 ;; font-lock.el still hasn't been loaded.
2156 "Non-nil means to try second pass through `auto-mode-alist'.
2157 This means that if the first case-sensitive search through the alist fails
2158 to find a matching major mode, a second case-insensitive search is made.
2159 On systems with case-insensitive file names, this variable is ignored,
2160 since only a single case-insensitive search through the alist is made."
2166 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2167 ;; c++-mode, java-mode and more) are added through autoload
2168 ;; directives in that file. That way is discouraged since it
2169 ;; spreads out the definition of the initial value.
2204 ;; Less common extensions come here
2205 ;; so more common ones above are found faster.
2245 ;; The list of archive file extensions should be in sync with
2246 ;; `auto-coding-alist' with `no-conversion' coding system.
2252 ;; Mailer puts message to be edited in
2253 ;; /tmp/Re.... or Message
2257 ;; some news reader is reported to use this
2266 ;; .emacs or .gnus or .viper following a directory delimiter in
2267 ;; Unix, MSDOG or VMS syntax.
2270 ;; _emacs following a directory delimiter
2271 ;; in MsDos syntax
2275 ;; Common Lisp ASDF package system.
2294 ;; Windows candidates may be opened case sensitively on Unix
2300 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2302 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2303 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2304 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2305 ;; this has lower priority to avoid matching changelog.sgml etc.
2307 ;; either user's dot-files or under /etc or some such
2309 ;; alas not all ~/.*rc files are like this
2310 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2315 ;; this contains everything twice, with space and with colon :-(
2317 ;; Get rid of any trailing .n.m and try again.
2318 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2319 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2320 ;; Using mode nil rather than `ignore' would let the search continue
2321 ;; through this list (with the shortened name) rather than start over.
2323 ;; The following should come after the ChangeLog pattern
2324 ;; for the sake of ChangeLog.1, etc.
2325 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2328 "Alist of filename patterns vs corresponding major mode functions.
2329 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2330 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2331 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2332 mode function to use. FUNCTION will be called, unless it is nil.
2334 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2335 calling FUNCTION (if it's not nil), we delete the suffix that matched
2336 REGEXP and search the list again for another match.
2338 If the file name matches `inhibit-first-line-modes-regexps',
2339 then `auto-mode-alist' is not processed.
2341 The extensions whose FUNCTION is `archive-mode' should also
2342 appear in `auto-coding-alist' with `no-conversion' coding system.
2344 See also `interpreter-mode-alist', which detects executable script modes
2345 based on the interpreters they specify to run,
2350 "Select Conf mode or XML mode according to start of file."
2360 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2361 ;; and pike-mode) are added through autoload directives in that
2362 ;; file. That way is discouraged since it spreads out the
2363 ;; definition of the initial value.
2401 "Alist mapping interpreter names to major modes.
2402 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2403 Each element looks like (INTERPRETER . MODE).
2404 If INTERPRETER matches the name of the interpreter specified in the first line
2405 of a script, mode MODE is enabled.
2413 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2414 When checking `inhibit-first-line-modes-regexps', we first discard
2420 "Regexp matching interpreters, for file mode determination.
2421 This regular expression is matched against the first line of a file
2422 to determine the file's mode in `set-auto-mode'. If it matches, the file
2423 is assumed to be interpreted by the interpreter matched by the second group
2424 of the regular expression. The mode is then determined as the mode
2428 "Alist of buffer beginnings vs. corresponding major mode functions.
2429 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2430 After visiting a file, if REGEXP matches the text at the beginning of the
2431 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2432 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2433 major mode.
2435 If FUNCTION is nil, then it is not called. (That is a way of saying
2443 ;; The < comes before the groups (but the first) to reduce backtracking.
2444 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2445 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2449 comment-re "*"
2452 . html-mode)
2454 ;; These two must come after html, because they are more general:
2459 . sgml-mode)
2462 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2463 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2464 After visiting a file, if REGEXP matches the text at the beginning of the
2465 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2466 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2467 have not specified a mode for this file.
2473 "Upper limit on `magic-mode-alist' regexp matches.
2477 "Select major mode appropriate for current buffer.
2479 To find the right major mode, this function checks for a -*- mode tag,
2480 checks if it uses an interpreter listed in `interpreter-mode-alist',
2481 matches the buffer beginning against `magic-mode-alist',
2482 compares the filename against the entries in `auto-mode-alist',
2483 then matches the buffer beginning against `magic-fallback-mode-alist'.
2485 It does not check for the `mode:' local variable in the
2486 Local Variables section of the file; for that, use `hack-local-variables'.
2488 If `enable-local-variables' is nil, this function does not check for a
2489 -*- mode tag.
2491 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2492 set the major mode only if that would change it. In other words
2493 we don't actually set it to the same mode the buffer already has."
2494 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2496 ;; Find a -*- mode tag
2503 ;; Find all specifications for the `mode:' variable
2504 ;; and execute them left to right.
2516 modes)))
2517 ;; Simple -*-MODE-*- case.
2520 modes))))
2521 ;; If we found modes to use, invoke them now, outside the save-excursion.
2529 ;; continuing would call minor modes again, toggling them off
2531 ;; If we didn't, look for an interpreter specified in the first line.
2532 ;; As a special case, allow for things like "#!/bin/env perl", which
2533 ;; finds the interpreter anywhere in $PATH.
2540 ;; Map interpreter name to a mode, signalling we're done at the
2541 ;; same time.
2543 interpreter-mode-alist))
2544 ;; If we found an interpreter mode to use, invoke it now.
2547 ;; Next try matching the buffer beginning against magic-mode-alist.
2561 ;; Next compare the filename against the entries in auto-mode-alist.
2566 ;; Remove remote file name identification.
2570 ;; Remove backup-suffixes from file name.
2573 ;; Find first matching alist entry.
2576 ;; System is case-insensitive.
2580 ;; System is case-sensitive.
2582 ;; First match case-sensitively.
2586 ;; Fallback to case-insensitive match.
2600 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2615 ;; When `keep-mode-if-same' is set, we are working on behalf of
2616 ;; set-visited-file-name. In that case, if the major mode specified is the
2617 ;; same one we already have, don't actually reset it. We don't want to lose
2618 ;; minor modes such as Font Lock.
2620 "Apply MODE and return it.
2621 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2622 any aliases and compared to current major mode. If they are the
2623 same, do nothing and return nil."
2629 mode)))
2632 "Find the -*- spec in the buffer.
2633 Call with point at the place to start searching from.
2634 If one is found, set point to the beginning
2635 and return the position of the end.
2636 Otherwise, return nil; point may be changed."
2639 ;; Don't look for -*- if this file name matches any
2640 ;; of the regexps in inhibit-first-line-modes-regexps.
2648 sufs)
2656 ;; If the file begins with "#!"
2657 ;; (exec interpreter magic), look
2658 ;; for mode frobs in the first two
2659 ;; lines. You cannot necessarily
2660 ;; put them in the first line of
2661 ;; such a file without screwing up
2662 ;; the interpreter invocation.
2663 ;; The same holds for
2664 ;; '\"
2665 ;; in man pages (preprocessor
2666 ;; magic for the `man' program).
2677 end))))
2678 \f
2679 ;;; Handling file local variables
2683 file-local-variables-alist dir-local-variables-alist)
2688 "Normal hook run after processing a file's local variables specs.
2689 Major modes can use this to examine user-specified local variables
2693 "List variable-value pairs that are considered safe.
2694 Each element is a cons cell (VAR . VAL), where VAR is a variable
2695 symbol and VAL is a value that is considered safe."
2696 :risky t
2703 "Expressions that are considered safe in an `eval:' local variable.
2704 Add expressions to this list if you want Emacs to evaluate them, when
2705 they appear in an `eval' local variable specification, without first
2706 asking you for confirmation."
2707 :risky t
2712 ;; Risky local variables:
2715 buffer-auto-save-file-name
2716 buffer-file-name
2717 buffer-file-truename
2718 buffer-undo-list
2719 debugger
2720 default-text-properties
2721 eval
2722 exec-directory
2723 exec-path
2724 file-name-handler-alist
2725 frame-title-format
2726 global-mode-string
2727 header-line-format
2728 icon-title-format
2729 inhibit-quit
2730 load-path
2731 max-lisp-eval-depth
2732 max-specpdl-size
2733 minor-mode-map-alist
2734 minor-mode-overriding-map-alist
2735 mode-line-format
2736 mode-name
2737 overriding-local-map
2738 overriding-terminal-local-map
2739 process-environment
2740 standard-input
2741 standard-output
2742 unread-command-events))
2744 ;; Safe local variables:
2745 ;;
2746 ;; For variables defined by major modes, the safety declarations can go into
2747 ;; the major mode's file, since that will be loaded before file variables are
2748 ;; processed.
2749 ;;
2750 ;; For variables defined by minor modes, put the safety declarations in the
2751 ;; file defining the minor mode after the defcustom/defvar using an autoload
2752 ;; cookie, e.g.:
2753 ;;
2754 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2755 ;;
2756 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2757 ;; minor mode file may not be loaded yet.
2758 ;;
2759 ;; For variables defined in the C source code the declaration should go here:
2775 "Alist of file-local variable settings in the current buffer.
2776 Each element in this list has the form (VAR . VALUE), where VAR
2777 is a file-local variable (a symbol) and VALUE is the value
2778 specified. The actual value in the buffer may differ from VALUE,
2783 "Alist of directory-local variable settings in the current buffer.
2784 Each element in this list has the form (VAR . VALUE), where VAR
2785 is a directory-local variable (a symbol) and VALUE is the value
2786 specified in .dir-locals.el. The actual value in the buffer
2787 may differ from VALUE, if it is changed by the major or minor modes,
2792 "Normal hook run before setting file-local variables.
2793 It is called after checking for unsafe/risky variables and
2794 setting `file-local-variables-alist', and before applying the
2795 variables stored in `file-local-variables-alist'. A hook
2796 function is allowed to change the contents of this alist.
2798 This hook is called only if there is at least one file-local
2802 "Get confirmation before setting up local variable values.
2803 ALL-VARS is the list of all variables to be set up.
2804 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2805 RISKY-VARS is the list of those that are marked as risky.
2806 DIR-NAME is a directory name if these settings come from
2807 directory-local variables, or nil otherwise."
2809 nil
2815 prompt char)
2825 ", and variables that are risky (**)."
2832 y -- to apply the local variables list.
2836 ! -- to apply the local variables list, and permanently mark these
2848 ;; Make strings with embedded whitespace easier to read.
2856 ""
2863 done)
2872 ;; read-event returns -1 if we are in a kbd
2873 ;; macro and there are no more events in the
2874 ;; macro. In that case, attempt to get an
2875 ;; event interactively.
2883 ;; When this is called from desktop-restore-file-buffer,
2884 ;; coding-system-for-read may be non-nil. Reset it before
2885 ;; writing to .emacs.
2889 'safe-local-variable-values
2890 safe-local-variable-values))))
2897 "Return local variables specified in the -*- line.
2898 Ignore any specification for `mode:' and `coding:';
2899 `set-auto-mode' should already have handled `mode:',
2900 `set-auto-coding' should already have handled `coding:'.
2902 If MODE-ONLY is non-nil, all we do is check whether the major
2903 mode is specified, returning t if it is specified. Otherwise,
2904 return an alist of elements (VAR . VAL), where VAR is a variable
2905 and VAL is the specified value."
2909 result mode-specified)
2910 ;; Parse the -*- line into the RESULT alist.
2911 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2913 nil)
2915 ;; Simple form: "-*- MODENAME -*-". Already handled.
2917 nil)
2919 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2920 ;; (last ";" is optional).
2925 ;; There used to be a downcase here,
2926 ;; but the manual didn't say so,
2927 ;; and people want to set var names that aren't all lc.
2933 ;; It is traditional to ignore
2934 ;; case when checking for `mode' in set-auto-mode,
2935 ;; so we must do that here as well.
2936 ;; That is inconsistent, but we're stuck with it.
2937 ;; The same can be said for `coding' in set-auto-coding.
2943 'eval
2950 mode-specified
2951 result))))
2954 "Filter local variable settings, querying the user if necessary.
2955 VARIABLES is the alist of variable-value settings. This alist is
2956 filtered based on the values of `ignored-local-variables',
2957 `enable-local-eval', `enable-local-variables', and (if necessary)
2958 user interaction. The results are added to
2959 `file-local-variables-alist', without applying them.
2960 DIR-NAME is a directory name if these settings come from
2961 directory-local variables, or nil otherwise."
2962 ;; Find those variables that we may want to save to
2963 ;; `safe-local-variable-values'.
2969 ;; Ignore any variable in `ignored-local-variables'.
2970 nil)
2971 ;; Obey `enable-local-eval'.
2978 ;; Ignore duplicates in the present list.
2980 ;; Accept known-safe variables.
2984 ;; The variable is either risky or unsafe:
2991 ;; Query, unless all vars are safe or user wants no querying.
2997 risky-vars dir-name))
3008 "Parse and put into effect this buffer's local variables spec.
3009 If MODE-ONLY is non-nil, all we do is check whether the major mode
3010 is specified, returning t if it is specified."
3013 result)
3020 ;; Look for "Local variables:" line in last page.
3028 ;; suffix is what comes after "local variables:" in its line.
3029 ;; prefix is what comes before "local variables:" in its line.
3039 beg)
3043 endpos
3049 nil t))
3050 ;; This used to be an error, but really all it means is
3051 ;; that this may simply not be a local-variables section,
3052 ;; so just ignore it.
3062 ;; Discard the prefix.
3067 ;; Discard the suffix.
3075 ;; Find the variable name; strip whitespace.
3084 val)
3085 ;; Read the variable value.
3096 'eval
3101 ;; Now we've read all the local variables.
3102 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3104 ;; Otherwise, set the variables.
3108 ;; Any 'evals must run in the Right sequence.
3117 "Non-nil if SYM is safe as a file-local variable with value VAL.
3118 It is safe if any of these conditions are met:
3120 * There is a matching entry (SYM . VAL) in the
3121 `safe-local-variable-values' user option.
3123 * The `safe-local-variable' property of SYM is a function that
3124 evaluates to a non-nil value with VAL as an argument."
3130 "Non-nil if SYM could be dangerous as a file-local variable.
3131 It is dangerous if either of these conditions are met:
3133 * Its `risky-local-variable' property is non-nil.
3139 ;; If this is an alias, check the base name.
3159 "Return t if it is safe to eval EXP when it is found in a file."
3161 ;; Detect certain `put' expressions.
3168 lisp-indent-function
3169 scheme-indent-function))
3170 ;; Only allow safe values (not functions).
3175 ;; Only allow indirect form specs.
3176 ;; During bootstrapping, edebug-basic-spec might not be
3177 ;; defined yet.
3181 ;; Allow expressions that the user requested.
3183 ;; Certain functions can be allowed with safe arguments
3184 ;; or can specify verification functions to try.
3192 ok))
3200 ok)))))))
3203 "Set local variable VAR with value VAL.
3204 If VAR is `mode', call `VAL-mode' as a function unless it's
3205 already the major mode."
3212 ;; A minor mode must be passed an argument.
3213 ;; Otherwise, if the user enables the minor mode in a
3214 ;; major mode hook, this would toggle it off.
3220 ;; Make sure the string has no text properties.
3221 ;; Some text properties can get evaluated in various ways,
3222 ;; so it is risky to put them on with a local variable list.
3226 \f
3227 ;;; Handling directory-local variables, aka project settings.
3233 "List of cached directory roots for directory-local variable classes.
3234 Each element in this list has the form (DIR CLASS MTIME).
3235 DIR is the name of the directory.
3236 CLASS is the name of a variable class (a symbol).
3237 MTIME is the recorded modification time of the directory-local
3238 variables file associated with this entry. This time is a list
3239 of two integers (the same format as `file-attributes'), and is
3240 used to test whether the cache entry is still valid.
3241 Alternatively, MTIME can be nil, which means the entry is always
3245 "Return the variable list for CLASS."
3249 "Collect directory-local variables from MODE-VARIABLES.
3250 VARIABLES is the initial list of variables.
3251 Returns the new list."
3256 ;; If variables are specified more than once, only use the last. (Why?)
3257 ;; The pseudo-variables mode and eval are different (bug#3430).
3260 ;; Need a new cons in case we setcdr later.
3264 "Collect entries from CLASS-VARIABLES into VARIABLES.
3265 ROOT is the root directory of the project.
3266 Return the new variables list."
3274 ;; Don't include this in the previous condition, because we
3275 ;; want to filter all strings before the next condition.
3287 "Declare that the DIRECTORY root is an instance of CLASS.
3288 DIRECTORY is the name of a directory, a string.
3289 CLASS is the name of a project class, a symbol.
3290 MTIME is either the modification time of the directory-local
3291 variables file that defined this class, or nil.
3293 When a file beneath DIRECTORY is visited, the mode-specific
3294 variables from CLASS are applied to the buffer. The variables
3295 for a class are defined using `dir-locals-set-class-variables'."
3302 "Map the type CLASS to a list of variable settings.
3303 CLASS is the project class, a symbol. VARIABLES is a list
3304 that declares directory-local variables for the class.
3305 An element in VARIABLES is either of the form:
3306 (MAJOR-MODE . ALIST)
3307 or
3308 (DIRECTORY . LIST)
3310 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3311 whose elements are of the form (VARIABLE . VALUE).
3313 In the second form, DIRECTORY is a directory name (a string), and
3314 LIST is a list of the form accepted by the function.
3316 When a file is visited, the file's class is found. A directory
3317 may be assigned a class using `dir-locals-set-directory-class'.
3318 Then variables are set in the file's buffer according to the
3319 class' LIST. The list is processed in order.
3321 * If the element is of the form (MAJOR-MODE . ALIST), and the
3322 buffer's major mode is derived from MAJOR-MODE (as determined
3323 by `derived-mode-p'), then all the variables in ALIST are
3324 applied. A MAJOR-MODE of nil may be used to match any buffer.
3325 `make-local-variable' is called for each variable before it is
3326 set.
3328 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3329 is an initial substring of the file's directory, then LIST is
3330 applied by recursively following these rules."
3337 "File that contains directory-local variables.
3338 It has to be constant to enforce uniform values
3342 "Find the directory-local variables for FILE.
3343 This searches upward in the directory tree from FILE.
3344 If the directory root of FILE has been registered in
3345 `dir-locals-directory-cache' and the directory-local variables
3346 file has not been modified, return the matching entry in
3347 `dir-locals-directory-cache'.
3348 Otherwise, if a directory-local variables file is found, return
3349 the file name.
3350 Otherwise, return nil."
3355 dir-locals-file))
3358 ;; `locate-dominating-file' may have abbreviated the name.
3361 ;; Find the best cached value in `dir-locals-directory-cache'.
3374 ;; Check the validity of the cache.
3379 ;; This cache entry is OK.
3380 dir-elt
3381 ;; This cache entry is invalid; clear it.
3384 locals-file)
3385 locals-file))))
3388 "Load a variables FILE and register a new class and instance.
3389 FILE is the name of the file holding the variables to apply.
3390 The new class name is the same as the directory in which FILE
3391 is found. Returns the new class name."
3401 class-name)))
3404 "Read per-directory local variables for the current buffer.
3405 Store the directory-local variables in `dir-local-variables-alist'
3406 and `file-local-variables-alist', without applying them."
3410 ;; Find the variables file.
3433 \f
3436 However, the mode will not be changed if
3437 \(1) a local variables list or the `-*-' line specifies a major mode, or
3439 \ not suitable for ordinary files, or
3440 \(3) the new file name does not particularly specify any mode."
3445 "Change name of file visited in current buffer to FILENAME.
3446 This also renames the buffer to correspond to the new file.
3447 The next time the buffer is saved it will go in the newly specified file.
3448 FILENAME nil or an empty string means mark buffer as not visiting any file.
3449 Remember to delete the initial contents of the minibuffer
3450 if you wish to pass an empty string as the argument.
3452 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3453 confirmation in the case where another buffer is already visiting FILENAME.
3455 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3456 the old visited file has been renamed to the new name FILENAME."
3464 nil
3479 filename)))
3489 ;; If new-name == old-name, renaming would add a spurious <2>
3490 ;; and it's considered as a feature in rename-buffer.
3496 ;; Abbreviate the file names of the buffer.
3505 nil)))
3506 ;; write-file-functions is normally used for things like ftp-find-file
3507 ;; that visit things that are not local files as if they were files.
3508 ;; Changing to visit an ordinary local file instead should flush the hook.
3513 ;; If buffer was read-only because of version control,
3514 ;; that reason is gone now, so make it writable.
3518 ;; Turn off backup files for certain file names.
3519 ;; Since this is a permanent local, the major mode won't eliminate it.
3521 backup-enable-predicate
3527 ;; If auto-save was not already on, turn it on if appropriate.
3531 ;; If auto save is on, start using a new name.
3532 ;; We deliberately don't rename or delete the old auto save
3533 ;; for the old visited file name. This is because perhaps
3534 ;; the user wants to save the new state and then compare with the
3535 ;; previous state from the auto save file.
3538 ;; Rename the old auto save file if any.
3545 ;; Update the major mode, if the file name determines it.
3547 ;; Don't change the mode if it is special.
3550 ;; Don't change the mode if the local variable list specifies it.
3556 "Write current buffer into file FILENAME.
3557 This makes the buffer visit that file, and marks it as not modified.
3559 If you specify just a directory name as FILENAME, that means to use
3560 the default file name but in that directory. You can also yank
3561 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3563 If the buffer is not already visiting a file, the default file name
3564 for the output file is the buffer name.
3566 If optional second arg CONFIRM is non-nil, this function
3567 asks for confirmation before overwriting an existing file.
3568 Interactively, confirmation is required unless you supply a prefix argument."
3569 ;; (interactive "FWrite file: ")
3573 nil nil nil nil)
3577 default-directory)
3578 nil nil))
3582 ;; If arg is just a directory,
3583 ;; use the default file name, but in that directory.
3594 ;; Make buffer writable if file is writable.
3599 ;; It's likely that the VC status at the new location is different from
3600 ;; the one at the old location.
3602 \f
3604 "Make a backup of the disk file visited by the current buffer, if appropriate.
3605 This is normally done before saving the buffer the first time.
3607 A backup may be done by renaming or by copying; see documentation of
3608 variable `make-backup-files'. If it's done by renaming, then the file is
3609 no longer accessible under its old name.
3611 The value is non-nil after a backup was made by renaming.
3612 It has the form (MODES . BACKUPNAME).
3613 MODES is the result of `file-modes' on the original
3614 file; this means that the caller, after saving the buffer, should change
3615 the modes of the new file to agree with the old modes.
3616 BACKUPNAME is the backup file name, which is the old file renamed."
3623 backup-info backupname targets setmodes)
3624 ;; If specified name is a symbolic link, chase it to the target.
3625 ;; Thus we make the backups in the directory where the real file is.
3630 ;; (if (file-directory-p buffer-file-name)
3631 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3635 ;; If have old versions to maybe delete,
3636 ;; ask the user to confirm now, before doing anything.
3637 ;; But don't actually delete til later.
3642 real-file-name)))))
3644 ;; Actually write the back up file.
3647 ; (file-symlink-p buffer-file-name)
3648 backup-by-copying
3649 ;; Don't rename a suid or sgid file.
3664 ;; rename-file should delete old backup.
3668 ;; If trouble writing the backup, write it in ~.
3673 backupname)
3677 ;; Now delete the old versions, if desired.
3684 setmodes)
3691 ;; Create temp files with strict access rights. It's easy to
3692 ;; loosen them later, whereas it's impossible to close the
3693 ;; time-window of loose permissions otherwise.
3696 ;; Try to overwrite old backup first.
3704 nil)
3706 ;; The file was somehow created by someone else between
3707 ;; `delete-file' and `copy-file', so let's try again.
3708 ;; rms says "I think there is also a possible race
3709 ;; condition for making backup files" (emacs-devel 20070821).
3710 nil)))
3711 ;; Reset the umask.
3717 "Return file NAME sans backup versions or strings.
3718 This is a separate procedure so your site-init or startup file can
3719 redefine it.
3720 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3721 we do not remove backup version numbers, only true file version numbers."
3733 "Return t if deleting FILE and rewriting it would preserve the owner."
3738 ;; Return t if the file doesn't exist, since it's true that no
3739 ;; information would be lost by an (attempted) delete and create.
3745 The extension, in a file name, is the part that follows the last `.',
3746 except that a leading `.', if any, doesn't count."
3749 directory)
3753 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3754 ;; we don't want to expand it.
3757 filename))))
3761 The extension, in a file name, is the part that follows the last `.',
3762 excluding version numbers and backup suffixes,
3763 except that a leading `.', if any, doesn't count.
3764 Return nil for extensionless file names such as `foo'.
3765 Return the empty string for file names such as `foo.'.
3767 If PERIOD is non-nil, then the returned value includes the period
3768 that delimits the extension, and if FILENAME has no extension,
3779 "A function to use instead of the default `make-backup-file-name'.
3780 A value of nil gives the default `make-backup-file-name' behavior.
3782 This could be buffer-local to do something special for specific
3783 files. If you define it, you may need to change `backup-file-name-p'
3784 and `file-name-sans-versions' too.
3786 See also `backup-directory-alist'."
3792 "Alist of filename patterns and backup directory names.
3793 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3794 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3795 relative or absolute. If it is absolute, so that all matching files
3796 are backed up into the same directory, the file names in this
3797 directory will be the full name of the file backed up with all
3798 directory separators changed to `!' to prevent clashes. This will not
3799 work correctly if your filesystem truncates the resulting name.
3801 For the common case of all backups going into one directory, the alist
3803 directory name.
3805 If this variable is nil, or it fails to match a filename, the backup
3806 is made in the original file's directory.
3808 On MS-DOS filesystems without long names this variable is always
3809 ignored."
3815 "Default `backup-enable-predicate' function.
3816 Checks for files in `temporary-file-directory',
3817 `small-temporary-file-directory', and /tmp."
3820 ;; Directory is under temporary-file-directory.
3825 ;; Directory is under /tmp.
3830 0 nil
3832 ;; Directory is under small-temporary-file-directory.
3837 "Create the non-numeric backup file name for FILE.
3838 Normally this will just be the file's name with `~' appended.
3839 Customization hooks are provided as follows.
3841 If the variable `make-backup-file-name-function' is non-nil, its value
3842 should be a function which will be called with FILE as its argument;
3843 the resulting name is used.
3845 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3846 the documentation of that variable. If the directory for the backup
3847 doesn't exist, it is created."
3861 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3863 elt backup-directory abs-backup-directory)
3868 alist nil)))
3869 ;; If backup-directory is relative, it should be relative to the
3870 ;; file's directory. By expanding explicitly here, we avoid
3871 ;; depending on default-directory.
3880 abs-backup-directory nil))))
3882 file
3886 ;; Normalize DOSish file names: downcase the drive
3887 ;; letter, if any, and replace the leading "x:" with
3888 ;; "/drive_x".
3891 ;; Replace any invalid file-name characters (for the
3892 ;; case of backing up remote files).
3896 "drive_"
3899 ""
3902 ;; Make the name unique by substituting directory
3903 ;; separators. It may not really be worth bothering about
3904 ;; doubling `!'s in the original name...
3909 backup-directory))
3914 "Return non-nil if FILE is a backup file name (numeric or not).
3915 This is a separate function so you can redefine it for customization.
3916 You may need to redefine `file-name-sans-versions' as well."
3921 ;; This is used in various files.
3922 ;; The usage of backup-extract-version-start is not very clean,
3923 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3925 "Given the name of a numeric backup file, FN, return the backup number.
3926 Uses the free variable `backup-extract-version-start', whose value should be
3927 the index in the name where the version number begins."
3934 "Find a file name for a backup file FN, and suggestions for deletions.
3935 Value is a list whose car is the name for the backup file
3936 and whose cdr is a list of old versions to consider deleting now.
3937 If the value is nil, don't make a backup.
3938 Uses `backup-directory-alist' in the same way as does
3939 `make-backup-file-name'."
3941 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3945 ;; We don't support numbered backups on plain MS-DOS
3946 ;; when long file names are unavailable.
3956 possibilities deserve-versions-p versions)
3959 base-versions
3962 possibilities)
3963 #'<)
3968 kept-old-versions
3969 kept-new-versions
3976 ;; Delete nothing if there is overflow
3977 ;; in the number of versions to keep.
3983 v))))))))))
3986 "Return number of names file FILENAME has."
3989 ;; (defun file-relative-name (filename &optional directory)
3990 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3991 ;; This function returns a relative file name which is equivalent to FILENAME
3992 ;; when used with that default directory as the default.
3993 ;; If this is impossible (which can happen on MSDOS and Windows
3994 ;; when the file name and directory use different drive names)
3995 ;; then it returns FILENAME."
3996 ;; (save-match-data
3997 ;; (let ((fname (expand-file-name filename)))
3998 ;; (setq directory (file-name-as-directory
3999 ;; (expand-file-name (or directory default-directory))))
4000 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4001 ;; ;; drive names, they can't be relative, so return the absolute name.
4002 ;; (if (and (or (eq system-type 'ms-dos)
4003 ;; (eq system-type 'cygwin)
4004 ;; (eq system-type 'windows-nt))
4005 ;; (not (string-equal (substring fname 0 2)
4006 ;; (substring directory 0 2))))
4007 ;; filename
4008 ;; (let ((ancestor ".")
4009 ;; (fname-dir (file-name-as-directory fname)))
4010 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4011 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4012 ;; (setq directory (file-name-directory (substring directory 0 -1))
4013 ;; ancestor (if (equal ancestor ".")
4014 ;; ".."
4015 ;; (concat "../" ancestor))))
4016 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4017 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4018 ;; ;; We matched within FNAME's directory part.
4019 ;; ;; Add the rest of FNAME onto ANCESTOR.
4020 ;; (let ((rest (substring fname (match-end 0))))
4021 ;; (if (and (equal ancestor ".")
4022 ;; (not (equal rest "")))
4023 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4024 ;; rest
4025 ;; (concat (file-name-as-directory ancestor) rest)))
4026 ;; ;; We matched FNAME's directory equivalent.
4027 ;; ancestor))))))
4030 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4031 This function returns a relative file name which is equivalent to FILENAME
4032 when used with that default directory as the default.
4033 If FILENAME and DIRECTORY lie on different machines or on different drives
4034 on a DOS/Windows machine, it returns FILENAME in expanded form."
4038 default-directory))))
4044 ;; Test for different drives on DOS/Windows
4046 ;; Should `cygwin' really be included here? --stef
4049 ;; Test for different remote file system identification
4051 filename
4057 directory nil nil case-fold-search))
4059 directory nil nil case-fold-search))))
4062 ".."
4064 ;; Now ancestor is empty, or .., or ../.., etc.
4066 directory nil nil case-fold-search))
4067 ;; We matched within FILENAME's directory part.
4068 ;; Add the rest of FILENAME onto ANCESTOR.
4071 ;; But don't bother with ANCESTOR if it would give us `./'.
4072 rest
4074 ;; We matched FILENAME's directory equivalent.
4075 ancestor))))))
4076 \f
4078 "Save current buffer in visited file if modified.
4079 Variations are described below.
4081 By default, makes the previous version into a backup file
4082 if previously requested or if this is the first save.
4084 to become a backup when the next save is done.
4086 unconditionally makes the previous version into a backup file.
4088 to become a backup when the next save is done,
4089 and unconditionally makes the previous version into a backup file.
4091 With a numeric argument of 0, never make the previous version
4092 into a backup file.
4094 If a file's name is FOO, the names of its numbered backup versions are
4095 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4096 Numeric backups (rather than FOO~) will be made if value of
4097 `version-control' is not the atom `never' and either there are already
4098 numeric versions of the file being backed up, or `version-control' is
4099 non-nil.
4100 We don't want excessive versions piling up, so there are variables
4101 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4102 and `kept-new-versions', which tells how many newest versions to keep.
4103 Defaults are 2 old versions and 2 new.
4104 `dired-kept-versions' controls dired's clean-directory (.) command.
4105 If `delete-old-versions' is nil, system will query user
4106 before trimming versions. Otherwise it does it silently.
4108 If `vc-make-backup-files' is nil, which is the default,
4109 no backup files are made for files managed by version control.
4110 (This is because the version control system itself records previous versions.)
4112 See the subroutine `basic-save-buffer' for more information."
4118 ;; We used to display the message below only for files > 50KB, but
4119 ;; then Rmail-mbox never displays it due to buffer swapping. If
4120 ;; the test is ever re-introduced, be sure to handle saving of
4121 ;; Rmail files.
4128 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4129 Normally delete only if the file was written by this Emacs since
4130 the last real save, but optional arg FORCE non-nil means delete anyway."
4144 "Normal hook that is run before a buffer is saved to its file."
4150 "Normal hook that is run after a buffer is saved to its file."
4156 "If non-nil, use this coding system for saving the buffer.
4157 More precisely, use this coding system in place of the
4158 value of `buffer-file-coding-system', when saving the buffer.
4159 Calling `write-region' for any purpose other than saving the buffer
4160 will still use `buffer-file-coding-system'; this variable has no effect
4167 "Save the current buffer in its visited file, if it has been modified.
4168 The hooks `write-contents-functions' and `write-file-functions' get a chance
4169 to do the job of saving; if they do not, then the buffer is saved in
4170 the visited file in the usual way.
4171 Before and after saving the buffer, this function runs
4172 `before-save-hook' and `after-save-hook', respectively."
4175 ;; In an indirect buffer, save its base buffer instead.
4180 setmodes)
4181 ;; If buffer has no file name, ask user for one.
4188 ;; Signal an error if the user specified the name of an
4189 ;; existing directory.
4192 filename))
4194 ;; Signal an error if the specified name refers to a
4195 ;; non-existing directory.
4225 ;; Support VC version backups.
4231 ;; If a hook returned t, file is already "written".
4232 ;; Otherwise, write it the usual way now.
4234 ;; Now we have saved the current buffer. Let's make sure
4235 ;; that buffer-file-coding-system is fixed to what
4236 ;; actually used for saving by binding it locally.
4246 ;; If the auto-save file was recent before this command,
4247 ;; delete it now.
4249 ;; Support VC `implicit' locking.
4254 ;; This does the "real job" of writing a buffer into its visited file
4255 ;; and making a backup file. This is what is normally done
4256 ;; but inhibited if one of write-file-functions returns non-nil.
4257 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4269 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4283 buffer-file-name)))
4297 ;; Write temp name, then rename it.
4298 ;; This requires write access to the containing dir,
4299 ;; which is why we don't try it if we don't have that access.
4301 tempname succeed
4304 ;; Create temp files with strict access rights. It's easy to
4305 ;; loosen them later, whereas it's impossible to close the
4306 ;; time-window of loose permissions otherwise.
4311 ;; Try various temporary names.
4312 ;; This code follows the example of make-temp-file,
4313 ;; but it calls write-region in the appropriate way
4314 ;; for saving the buffer.
4320 ;; Pass in nil&nil rather than point-min&max
4321 ;; cause we're saving the whole buffer.
4322 ;; write-region-annotate-functions may use it.
4324 tempname nil realname
4326 nil)
4328 ;; The file was somehow created by someone else between
4329 ;; `make-temp-name' and `write-region', let's try again.
4330 nil)
4332 ;; Reset the umask.
4334 ;; If we failed, restore the buffer's modtime.
4337 ;; Since we have created an entirely new file,
4338 ;; make sure it gets the right permission bits set.
4342 buffer-file-name)))
4343 ;; We succeeded in writing the temp file,
4344 ;; so rename it.
4346 ;; If file not writable, see if we can make it writable
4347 ;; temporarily while we write it.
4348 ;; But no need to do so if we have just backed it up
4349 ;; (setmodes is set) because that says we're superseding.
4351 ;; Change the mode back, after writing.
4357 ;; Pass in nil&nil rather than point-min&max to indicate
4358 ;; we're saving the buffer rather than just a region.
4359 ;; write-region-annotate-functions may make us of it.
4361 buffer-file-name nil t buffer-file-truename)
4363 ;; If we get an error writing the new file, and we made
4364 ;; the backup by renaming, undo the backing-up.
4369 setmodes))
4372 "View the differences between BUFFER and its associated file.
4373 This requires the external program `diff' to be in your `exec-path'."
4387 ;; Display that message for 1 second so that user can read it
4388 ;; in the minibuffer.
4390 ;; return always nil, so that save-buffers-kill-emacs will not move
4391 ;; over to the next unsaved buffer when calling `d'.
4392 nil)
4395 `((?\C-r
4402 ;; Return nil to ask about BUF again.
4403 nil)
4415 ;; Return nil to ask about BUF again.
4416 nil)
4426 "Save some modified file-visiting buffers. Asks user about each one.
4427 You can answer `y' to save, `n' not to save, `C-r' to look at the
4428 buffer in question with `view-buffer' before deciding or `d' to
4429 view the differences using `diff-buffer-with-file'.
4431 Optional argument (the prefix) non-nil means save all with no questions.
4432 Optional second argument PRED determines which buffers are considered:
4433 If PRED is nil, all the file-visiting buffers are considered.
4434 If PRED is t, then certain non-file buffers will also be considered.
4435 If PRED is a zero-argument function, it indicates for each buffer whether
4436 to consider it or not when called with that buffer current.
4438 See `save-some-buffers-action-alist' if you want to
4439 change the additional actions you can take on files."
4443 files-done abbrevs-done)
4445 ;; First save any buffers that we're supposed to save unconditionally.
4446 ;; That way the following code won't ask about them.
4451 ;; Ask about those buffers that merit it,
4452 ;; and record the number thus saved.
4456 ;; Note that killing some buffers may kill others via
4457 ;; hooks (e.g. Rmail and its viewing buffer).
4470 t
4482 save-some-buffers-action-alist))
4483 ;; Maybe to save abbrevs, and record whether
4484 ;; we either saved them or asked to.
4490 abbrev-file-name)))
4492 ;; Don't keep bothering user if he says no.
4497 "(Some special files were saved without asking)"
4499 \f
4501 "Mark current buffer as unmodified, not needing to be saved.
4504 It is not a good idea to use this function in Lisp programs, because it
4505 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4512 "Change whether this buffer is read-only.
4513 With prefix argument ARG, make the buffer read-only if ARG is
4514 positive, otherwise make it writable. If buffer is read-only
4515 and `view-read-only' is non-nil, enter view mode."
4520 nil ; do nothing.
4521 ;; Toggle.
4528 ;; If view-mode is already active, `view-mode-enter' is a nop.
4540 "Insert contents of file FILENAME into buffer after point.
4541 Set mark after the inserted text.
4543 This function is meant for the user to run interactively.
4544 Don't call it from programs! Use `insert-file-contents' instead.
4545 \(Its calling sequence is different; see its documentation)."
4550 "Append the contents of the region to the end of file FILENAME.
4551 When called from a function, expects three arguments,
4552 START, END and FILENAME. START and END are normally buffer positions
4553 specifying the part of the buffer to write.
4554 If START is nil, that means to use the entire buffer contents.
4555 If START is a string, then output that string to the file
4556 instead of any buffer contents; END is ignored.
4558 This does character code conversion and applies annotations
4559 like `write-region' does."
4564 "Return most recent backup file for FILENAME or nil if no backups exist."
4565 ;; `make-backup-file-name' will get us the right directory for
4566 ;; ordinary or numeric backups. It might create a directory for
4567 ;; backups as a side-effect, according to `backup-directory-alist'.
4574 tem)
4583 newest))
4586 "Rename current buffer to a similar name not already taken.
4587 This function is useful for creating multiple shell process buffers
4588 or multiple mail buffers, etc."
4596 ;; If the existing buffer name has a <NNN>,
4597 ;; which isn't part of the file name (if any),
4598 ;; then get rid of that.
4604 "Create the directory DIR and any nonexistent parent dirs.
4605 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4607 Interactively, the default choice of directory to create
4608 is the current default directory for file names.
4609 That is useful when you have visited a file in a nonexistent directory.
4611 Noninteractively, the second (optional) argument PARENTS says whether
4612 to create parent directories if they don't exist. Interactively,
4613 this happens by default."
4616 nil nil)
4617 t))
4618 ;; If default-directory is a remote directory,
4619 ;; make sure we find its make-directory handler.
4627 create-list)
4629 ;; If directory is its own parent, then we can't
4630 ;; keep looping forever
4645 "Delete the directory named DIRECTORY. Does not follow symlinks.
4646 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well."
4650 "Delete directory: "
4651 default-directory default-directory nil nil))))
4656 nil))))
4657 ;; If default-directory is a remote directory, make sure we find its
4658 ;; delete-directory handler.
4666 ;; This test is equivalent to
4667 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4668 ;; but more efficient
4672 ;; We do not want to delete "." and "..".
4678 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4679 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4681 This function always sets the file modes of the output files to match
4682 the corresponding input file.
4684 The third arg KEEP-TIME non-nil means give the output files the same
4685 last-modified time as the old ones. (This works on only some systems.)
4687 A prefix arg makes KEEP-TIME non-nil.
4689 Noninteractively, the last argument PARENTS says whether to
4690 create parent directories if they don't exist. Interactively,
4691 this happens by default."
4698 default-directory default-directory nil nil)
4699 current-prefix-arg t)))
4700 ;; If default-directory is a remote directory, make sure we find its
4701 ;; copy-directory handler.
4707 ;; Compute target name.
4717 ;; Copy recursively.
4723 ;; We do not want to delete "." and "..".
4726 ;; Set directory attributes.
4730 \f
4733 "Function to use to revert this buffer, or nil to do the default.
4734 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4739 "Function to use to insert contents when reverting this buffer.
4740 Gets two args, first the nominal file name to use,
4741 and second, t if reading the auto-save file.
4746 "Function to check whether a non-file buffer needs reverting.
4747 This should be a function with one optional argument NOCONFIRM.
4748 Auto Revert Mode passes t for NOCONFIRM. The function should return
4749 non-nil if the buffer should be reverted. A return value of
4750 `fast' means that the need for reverting was not checked, but
4751 that reverting the buffer is fast. The buffer is current when
4752 this function is called.
4754 The idea behind the NOCONFIRM argument is that it should be
4755 non-nil if the buffer is going to be reverted without asking the
4756 user. In such situations, one has to be careful with potentially
4757 time consuming operations.
4759 For more information on how this variable is used by Auto Revert mode,
4763 "Normal hook for `revert-buffer' to run before reverting.
4764 If `revert-buffer-function' is used to override the normal revert
4768 "Normal hook for `revert-buffer' to run after reverting.
4769 Note that the hook value that it runs is the value that was in effect
4770 before reverting; that makes a difference if you have buffer-local
4771 hook functions.
4773 If `revert-buffer-function' is used to override the normal revert
4779 "Replace current buffer text with the text of the visited file on disk.
4780 This undoes all changes since the file was visited or saved.
4781 With a prefix argument, offer to revert from latest auto-save file, if
4782 that is more recent than the visited file.
4784 This command also implements an interface for special buffers
4785 that contain text which doesn't come from a file, but reflects
4786 some other data instead (e.g. Dired buffers, `buffer-list'
4787 buffers). This is done via the variable `revert-buffer-function'.
4788 In these cases, it should reconstruct the buffer contents from the
4789 appropriate data.
4791 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4792 to revert from the auto-save file when this is nil. Note that the
4793 sense of this argument is the reverse of the prefix argument, for the
4794 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4795 to nil.
4797 Optional second argument NOCONFIRM means don't ask for confirmation
4798 at all. \(The variable `revert-without-query' offers another way to
4799 revert buffers without querying for confirmation.)
4801 Optional third argument PRESERVE-MODES non-nil means don't alter
4802 the files modes. Normally we reinitialize them using `normal-mode'.
4804 If the value of `revert-buffer-function' is non-nil, it is called to
4805 do all the work for this command. Otherwise, the hooks
4806 `before-revert-hook' and `after-revert-hook' are run at the beginning
4807 and the end, and if `revert-buffer-insert-file-contents-function' is
4808 non-nil, it is called instead of rereading visited file contents."
4810 ;; I admit it's odd to reverse the sense of the prefix argument, but
4811 ;; there is a lot of code out there which assumes that the first
4812 ;; argument should be t to avoid consulting the auto-save file, and
4813 ;; there's no straightforward way to encourage authors to notice a
4814 ;; reversal of the argument sense. So I'm just changing the user
4815 ;; interface, but leaving the programmatic interface the same.
4823 buffer-auto-save-file-name
4828 buffer-auto-save-file-name
4829 buffer-file-name)))
4839 file-name)))
4841 ;; If file was backed up but has changed since,
4842 ;; we should make another backup.
4846 ;; Effectively copy the after-revert-hook status,
4847 ;; since after-find-file will clobber it.
4850 after-revert-hook))
4855 ;; Get rid of all undo records for this buffer.
4857 ;; Don't make undo records for the reversion.
4860 file-name auto-save-p)))
4863 "File %s no longer exists!"
4865 file-name))
4868 "File %s no longer readable!"
4870 file-name))
4872 ;; Bind buffer-file-name to nil
4873 ;; so that we don't try to lock the file.
4879 ;; Auto-saved file should be read by Emacs'
4880 ;; internal coding.
4884 buffer-file-coding-system-explicit
4887 coding-system-for-read
4889 coding-system-for-read)
4891 ;; As a coding system suitable for multibyte
4892 ;; buffer is specified, make the current
4893 ;; buffer multibyte.
4896 ;; This force after-insert-file-set-coding
4897 ;; (called from insert-file-contents) to set
4898 ;; buffer-file-coding-system to a proper value.
4901 ;; Note that this preserves point in an intelligent way.
4905 nil nil t))
4907 nil nil t)))))
4908 ;; Recompute the truename in case changes in symlinks
4909 ;; have changed the truename.
4913 ;; Run after-revert-hook as it was before we reverted.
4917 local-hook)
4920 t))))))
4923 "Recover the visited file--get contents from its last auto-save file."
4928 "Visit file FILE, but get contents from its last auto-save file."
4929 ;; Actually putting the file name in the minibuffer should be used
4930 ;; only rarely.
4931 ;; Not just because users often use the default.
4951 ;; Use insert-directory-safely, not insert-directory,
4952 ;; because these files might not exist. In particular,
4953 ;; FILE might not exist if the auto-save file was for
4954 ;; a buffer that didn't visit a file, such as "*mail*".
4955 ;; The code in v20.x called `ls' directly, so we need
4956 ;; to emulate what `ls' did in that case.
4962 ;; Keep the current buffer-file-coding-system.
4964 ;; Auto-saved file should be read with special coding.
4973 "Recover auto save files from a previous Emacs session.
4974 This command first displays a Dired buffer showing you the
4975 previous sessions that you could recover from.
4976 To choose one, move point to the proper line and then type C-c C-c.
4977 Then you'll be asked about a number of files to recover."
4987 auto-save-list-file-prefix)))
4988 t)
4997 ;; Each line starts with a space
4998 ;; so that Font Lock mode won't highlight the first character.
5007 "Choose one saved session to recover auto-save files from.
5008 This command is used in the special Dired buffer created by
5011 ;; Get the name of the session file to recover from.
5013 files
5019 ;; Read in the auto-save-list file.
5023 ;; Loop thru the text of that file
5024 ;; and get out the names of the files to recover.
5028 ;; This is a pair of lines for a non-file-visiting buffer.
5029 ;; Get the auto-save file name and manufacture
5030 ;; a "visited file name" from that.
5033 ;; If there is no auto-save file name, the
5034 ;; auto-save-list file is probably corrupted.
5047 ;; This pair of lines is a file-visiting
5048 ;; buffer. Use the visited file name.
5058 ;; Ignore a file if its auto-save file does not exist now.
5062 ;; The file contains a pair of line for each auto-saved buffer.
5063 ;; The first line of the pair contains the visited file name
5064 ;; or is empty if the buffer was not visiting a file.
5065 ;; The second line is the auto-save file name.
5073 files
5079 "Kill BUFFER if confirmed."
5087 "Kill some buffers. Asks the user whether to kill each one of them.
5088 Non-interactively, if optional argument LIST is non-nil, it
5089 specifies the list of buffers to kill, asking for approval for each one."
5097 ; if we killed the base buffer.
5104 "Kill buffers whose name matches the specified REGEXP.
5105 The optional second argument indicates whether to kill internal buffers too."
5114 \f
5116 "Toggle auto-saving of contents of current buffer.
5117 With prefix argument ARG, turn auto-saving on if positive, else off."
5122 ;; If auto-save is off because buffer has shrunk,
5123 ;; then toggling should turn it on.
5128 buffer-file-name
5130 ;; If -1 was stored here, to temporarily turn off saving,
5131 ;; turn it back on.
5137 buffer-auto-save-file-name)
5140 "Adjust current buffer's auto save file name for current conditions.
5141 Also rename any existing auto save file, if it was made in this session."
5153 "Return file name to use for auto-saves of current buffer.
5154 Does not consider `auto-save-visited-file-name' as that variable is checked
5155 before calling this function. You can redefine this for customization.
5156 See also `auto-save-file-name-p'."
5164 result uniq)
5165 ;; Apply user-specified translations
5166 ;; to the file name.
5170 filename)
5180 filename))))
5185 ;; We truncate the file name to DOS 8+3 limits
5186 ;; before doing anything else, because the regexp
5187 ;; passed to string-match below cannot handle
5188 ;; extensions longer than 3 characters, multiple
5189 ;; dots, and other atrocities.
5194 fn)
5199 "#"
5202 ;; Make sure auto-save file names don't contain characters
5203 ;; invalid for the underlying filesystem.
5205 ;; Don't modify remote (ange-ftp) filenames
5208 result))))
5210 ;; Deal with buffers that don't have any associated files. (Mail
5211 ;; mode tends to create a good number of these.)
5215 file-name)
5216 ;; Restrict the characters used in the file name to those which
5217 ;; are known to be safe on all filesystems, url-encoding the
5218 ;; rest.
5219 ;; We do this on all platforms, because even if we are not
5220 ;; running on DOS/Windows, the current directory may be on a
5221 ;; mounted VFAT filesystem, such as a USB memory stick.
5225 ;; For multibyte characters, this will produce more than
5226 ;; 2 hex digits, so is not true URL encoding.
5230 ;; Generate the file name.
5236 ;; Try a few alternative directories, to get one we can
5237 ;; write it.
5243 ;; Don't modify remote (ange-ftp) filenames
5245 ;; The call to convert-standard-filename is in case
5246 ;; buffer-name includes characters not allowed by the
5247 ;; DOS/Windows filesystems. make-temp-file writes to the
5248 ;; file it creates, so we must fix the file name _before_
5249 ;; make-temp-file is called.
5251 fname))
5253 ;; make-temp-file creates the file,
5254 ;; but we don't want it to exist until we do an auto-save.
5258 file-name)))
5261 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5262 FILENAME should lack slashes. You can redefine this for customization."
5264 \f
5266 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5267 The generated regexp will match a filename only if the filename
5268 matches that wildcard according to shell rules. Only wildcards known
5269 by `sh' are supported."
5271 ;; Copy the initial run of non-special characters.
5274 ;; If no special characters, we're almost done.
5278 j)
5280 result
5301 ;; Found "[^". Insert a `\0' character
5302 ;; (which cannot happen in a filename)
5303 ;; into the character class, so that `^'
5304 ;; is not the first character after `[',
5305 ;; and thus non-special in a regexp.
5310 ;; I don't think `]' can appear in a
5311 ;; character class in a wildcard, but
5312 ;; let's be general here.
5319 i
5332 ;; Shell wildcards should match the entire filename,
5333 ;; not its part. Make the regexp say so.
5335 \f
5338 "Switches for `list-directory' to pass to `ls' for brief listing."
5344 "Switches for `list-directory' to pass to `ls' for verbose listing."
5349 "Expand wildcard pattern PATTERN.
5350 This returns a list of file names which match the pattern.
5352 If PATTERN is written as an absolute file name,
5353 the values are absolute also.
5355 If PATTERN is written as a relative file name, it is interpreted
5356 relative to the current default directory, `default-directory'.
5357 The file names returned are normally also relative to the current
5358 default directory. However, if FULL is non-nil, they are absolute."
5362 ;; A list of all dirs that DIRPART specifies.
5363 ;; This can be more than one dir
5364 ;; if DIRPART contains wildcards.
5369 contents)
5374 ;; Filter out "." and ".."
5379 name))
5386 this-dir-contents)
5387 this-dir-contents)
5388 contents))))
5390 contents)))
5393 "Display a list of files in or matching DIRNAME, a la `ls'.
5394 DIRNAME is globbed by the shell if necessary.
5395 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5396 Actions controlled by variables `list-directory-brief-switches'
5397 and `list-directory-verbose-switches'."
5401 nil default-directory nil)
5402 pfx)))
5404 list-directory-brief-switches))
5405 buffer)
5417 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5425 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5427 PATTERN is assumed to represent a file-name wildcard suitable for the
5428 underlying filesystem. For Unix and GNU/Linux, each character from the
5430 the parts of the pattern which don't include wildcard characters are
5431 quoted with double quotes.
5434 on Windows), so PATTERN can use them to quote wildcard characters that
5435 need to be passed verbatim to shell commands."
5439 ;; DOS/Windows don't allow `"' in file names. So if the
5440 ;; argument has quotes, we can safely assume it is already
5441 ;; quoted by the caller.
5443 ;; We quote [&()#$'] in case their shell is a port of a
5444 ;; Unixy shell. We quote [,=+] because stock DOS and
5445 ;; Windows shells require that in some cases, such as
5446 ;; passing arguments to batch files that use positional
5447 ;; arguments like %1.
5449 pattern
5452 end)
5469 pattern))))
5476 "Program to get the amount of free space on a file system.
5477 We assume the output has the format of `df'.
5478 The value of this variable must be just a command name or file name;
5479 if you want to specify options, use `directory-free-space-args'.
5481 A value of nil disables this feature.
5483 If the function `file-system-info' is defined, it is always used in
5484 preference to the program given by this variable."
5490 "Options to use when running `directory-free-space-program'."
5495 "Return the amount of free space on directory DIR's file system.
5496 The result is a string that gives the number of free 1KB blocks,
5497 or nil if the system call or the program which retrieve the information
5498 fail. It returns also nil when DIR is a remote directory.
5500 This function calls `file-system-info' if it is available, or invokes the
5501 program specified by `directory-free-space-program' if that is non-nil."
5503 ;; Try to find the number of free blocks. Non-Posix systems don't
5504 ;; always have df, but might have an equivalent system call.
5513 ;; Avoid failure if the default directory does
5514 ;; not exist (Bug#2631, Bug#3911).
5517 nil t nil
5518 directory-free-space-args
5519 dir)
5521 ;; Usual format is a header line followed by a line of
5522 ;; numbers.
5527 ;; Move to the end of the "available blocks" number.
5530 ;; Copy it into AVAILABLE.
5535 ;; The following expression replaces `dired-move-to-filename-regexp'.
5539 ;; In some locales, month abbreviations are as short as 2 letters,
5540 ;; and they can be followed by ".".
5541 ;; In Breton, a month name can include a quote character.
5554 s "+"
5557 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5558 ;; omits the Kanji characters after month and day-of-month.
5559 ;; On Mac OS X 10.3, the date format in East Asian locales is
5560 ;; day-of-month digits followed by month digits.
5566 ;; The "[0-9]" below requires the previous column to end in a digit.
5567 ;; This avoids recognizing `1 may 1997' as a date in the line:
5568 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5570 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5571 ;; The ".*" below finds the last match if there are multiple matches.
5572 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5573 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5575 ;; vc dired listings provide the state or blanks between file
5576 ;; permissions and date. The state is always surrounded by
5577 ;; parantheses:
5578 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5579 ;; This is not supported yet.
5583 "Regular expression to match up to the file name in a directory listing.
5584 The default value is designed to recognize dates and times
5589 ;; insert-directory
5590 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5591 ;; FULL-DIRECTORY-P is nil.
5592 ;; The single line of output must display FILE's name as it was
5593 ;; given, namely, an absolute path name.
5594 ;; - must insert exactly one line for each file if WILDCARD or
5595 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5596 ;; before the file lines, plus optional text after the file lines.
5597 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5598 ;; allowed.
5599 ;; File lines should display the basename.
5600 ;; - must be consistent with
5601 ;; - functions dired-move-to-filename, (these two define what a file line is)
5602 ;; dired-move-to-end-of-filename,
5603 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5604 ;; dired-insert-headerline
5605 ;; dired-after-subdir-garbage (defines what a "total" line is)
5606 ;; - variable dired-subdir-regexp
5607 ;; - may be passed "--dired" as the first argument in SWITCHES.
5608 ;; Filename handlers might have to remove this switch if their
5609 ;; "ls" command does not support it.
5611 "Insert directory listing for FILE, formatted according to SWITCHES.
5612 Leaves point after the inserted text.
5613 SWITCHES may be a string of options, or a list of strings
5614 representing individual options.
5615 Optional third arg WILDCARD means treat FILE as shell wildcard.
5616 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5617 switches do not contain `d', so that a full listing is expected.
5619 This works by running a directory listing program
5620 whose name is in the variable `insert-directory-program'.
5621 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5623 When SWITCHES contains the long `--dired' option, this function
5624 treats it specially, for the sake of dired. However, the
5625 normally equivalent short `-D' option is just passed on to
5626 `insert-directory-program', as any other option."
5627 ;; We need the directory in order to find the right handler.
5632 wildcard full-directory-p)
5635 ;; Read the actual directory using `insert-directory-program'.
5636 ;; RESULT gets the status code.
5638 ;; putting text property `dired-filename, decode one
5639 ;; bunch by one to preserve that property.
5641 ;; This is to control encoding the arguments in call-process.
5645 default-file-name-coding-system))))
5648 ;; Run ls in the directory part of the file pattern
5649 ;; using the last component as argument.
5656 shell-file-name nil t nil
5657 "-c"
5659 ""
5661 insert-directory-program
5662 " -d "
5664 switches
5666 " -- "
5667 ;; Quote some characters that have
5668 ;; special meanings in shells; but
5669 ;; don't quote the wildcards--we want
5670 ;; them to be special. We also
5671 ;; currently don't quote the quoting
5672 ;; characters in case people want to
5673 ;; use them explicitly to quote
5674 ;; wildcard characters.
5676 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5677 ;; directory if FILE is a symbolic link.
5679 insert-directory-program nil t nil
5683 ;; Split the switches at any spaces so we can
5684 ;; pass separate options as separate args.
5686 ;; Avoid lossage if FILE starts with `-'.
5694 file))))))))
5696 ;; If we got "//DIRED//" in the output, it means we got a real
5697 ;; directory listing, even if `ls' returned nonzero.
5698 ;; So ignore any errors.
5711 ;; The first time ls returns an error,
5712 ;; find the version numbers of ls,
5713 ;; and set insert-directory-ls-version
5714 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5715 ;; is equal or if the info cannot be obtained.
5716 ;; (That can mean it isn't GNU ls.)
5726 comparison)
5742 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5746 ;; If `insert-directory-program' failed, signal an error.
5748 ;; Delete the error message it may have output.
5750 ;; On non-Posix systems, we cannot open a directory, so
5751 ;; don't even try, because that will always result in
5752 ;; the ubiquitous "Access denied". Instead, show the
5753 ;; command line so the user can try to guess what went wrong.
5758 insert-directory-program
5760 file result)
5761 ;; Unix. Access the file to get a suitable error.
5768 ;; The following overshoots by one line for an empty
5769 ;; directory listed with "--dired", but without "-a"
5770 ;; switch, where the ls output contains a
5771 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5772 ;; We take care of that case later.
5780 error-lines)
5781 ;; Find all the lines that are error messages,
5782 ;; and record the bounds of each one.
5789 ;; Now read the numeric positions of file names.
5796 error-lines))
5799 error-lines)))
5801 ;; End is followed by \n or by " -> ".
5803 ;; It seems that we can't trust ls's output as to
5804 ;; byte positions of filenames.
5810 ;; Take care of the case where the ls output contains a
5811 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5812 ;; and we went one line too far back (see above).
5817 ;; Now decode what read if necessary.
5819 file-name-coding-system
5820 default-file-name-coding-system
5822 coding-no-eol
5823 val pos)
5827 ;; If no coding system is specified or detection is
5828 ;; requested, detect the coding.
5842 ;; Force no eol conversion on a file name, so
5843 ;; that CR is preserved.
5851 ;; Try to insert the amount of free space.
5854 ;; First find the line to put it on.
5858 ;; Replace "total" with "used", to avoid confusion.
5864 "Convert `ls --dired' file name position value POS to a buffer position.
5865 File name position values returned in ls --dired output
5866 count only stdout; they don't count the error messages sent to stderr.
5867 So this function converts to them to real buffer positions.
5868 ERROR-LINES is a list of buffer positions of error message lines,
5869 of the form (START END)."
5873 pos)
5877 "Insert directory listing for FILE, formatted according to SWITCHES.
5879 Like `insert-directory', but if FILE does not exist, it inserts a
5880 message to that effect instead of signaling an error."
5883 ;; Simulate the message printed by `ls'.
5887 "Functions to call with no arguments to query about killing Emacs.
5888 If any of these functions returns nil, killing Emacs is cancelled.
5889 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5893 "How to ask for confirmation when leaving Emacs.
5894 If nil, the default, don't ask at all. If the value is non-nil, it should
5895 be a predicate function such as `yes-or-no-p'."
5903 "Offer to save each buffer, then kill this Emacs process.
5904 With prefix ARG, silently save all file-visiting buffers, then kill."
5913 ;; process-list is not defined on MSDOS.
5915 active)
5924 ;; Query the user for other things, perhaps.
5931 "Offer to save each buffer, then kill the current connection.
5932 If the current frame has no client, kill Emacs itself.
5934 With prefix ARG, silently save all file-visiting buffers, then kill.
5936 If emacsclient was started with a list of filenames to edit, then
5937 only these files will be asked to be saved."
5942 \f
5943 ;; We use /: as a prefix to "quote" a file name
5944 ;; so that magic file name handlers will not apply to it.
5948 file-name-handler-alist))
5950 ;; We depend on being the last handler on the list,
5951 ;; so that anything else which does need handling
5952 ;; has been handled already.
5953 ;; So it is safe for us to inhibit *all* magic file name handlers.
5962 default-directory))
5963 ;; Get a list of the indices of the args which are file names.
5966 ;; The first six are special because they
5967 ;; return a file name. We want to include the /:
5968 ;; in the return value.
5969 ;; So just avoid stripping it in the first place.
5976 ;; `identity' means just return the first arg
5977 ;; not stripped of its quoting.
5979 ;; `add' means add "/:" to the result.
5981 ;; `quote' means add "/:" to buffer-file-name.
5983 ;; `unquote-then-quote' means set buffer-file-name
5984 ;; temporarily to unquoted filename.
5986 ;; List the arguments which are filenames.
5994 ;; For all other operations, treat the first argument only
5995 ;; as the file name.
5997 method
5998 ;; Copy ARGUMENTS so we can replace elements in it.
6002 ;; Strip off the /: from the file names that have it.
6010 "/"
6026 res))
6029 \f
6030 ;; Symbolic modes and read-file-modes.
6033 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6034 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6035 Others, or All) for whom to produce the mask.
6036 The bit-mask that is returned extracts from mode bits the access rights
6037 for the specified category of users."
6045 "Convert CHAR to a numeric value of mode bits.
6046 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6047 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6054 ;; Rights relative to the previous file modes.
6065 "Convert a symbolic mode string specification to an equivalent number.
6067 WHO-MASK is the bit-mask specifying the category of users to which to
6068 apply the access permissions. See `file-modes-char-to-who'.
6069 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6070 RIGHTS request to add, remove, or set permissions based on existing ones,
6077 char-right)
6084 num-rights
6088 op char-right)))
6089 num-rights))
6092 "Convert symbolic file modes to numeric file modes.
6093 MODES is the string to convert, it should match
6096 notation.
6097 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6098 MODES request to add, remove, or set permissions based on existing ones,
6112 num-who num-modes)
6115 num-modes)))
6118 "Read file modes in octal or symbolic notation and return its numeric value.
6119 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6120 ORIG-FILE is the name of a file on whose mode bits to base returned
6121 permissions if what user types requests to add, remove, or set permissions
6137 nil nil default)))
6143 \f
6144 ;; Trashcan handling.
6146 "Directory for `move-file-to-trash' to move files and directories to.
6147 This directory is only used when the function `system-move-file-to-trash'
6148 is not defined.
6149 Relative paths are interpreted relative to `default-directory'.
6150 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6160 "Move the file (or directory) named FILENAME to the trash.
6161 When `delete-by-moving-to-trash' is non-nil, this function is
6162 called by `delete-file' and `delete-directory' instead of
6163 deleting files outright.
6165 If the function `system-move-file-to-trash' is defined, call it
6166 with FILENAME as an argument.
6167 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6168 directory.
6169 Otherwise, trash FILENAME using the freedesktop.org conventions,
6170 like the GNOME, KDE and XFCE desktop environments. Emacs only
6174 ;; If `trash-directory' is non-nil, move the file there.
6178 trash-dir)))
6179 ;; We can't trash a parent directory of trash-directory.
6182 trash-dir filename))
6185 ;; Ensure that the trashed file-name is unique.
6192 ;; If `system-move-file-to-trash' is defined, use it.
6195 ;; Otherwise, use the freedesktop.org method, as specified at
6196 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6207 ;; Check if we have permissions to delete.
6211 ;; The trashed file cannot be the trash dir or its parent.
6214 trash-files-dir filename))
6217 trash-info-dir filename))
6219 ;; Ensure that the trash directory exists; otherwise, create it.
6228 ;; Try to move to trash with .trashinfo undo information
6233 ;; Perform url-encoding on FN. For compatibility with
6234 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6235 ;; for path separators.
6240 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6241 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6254 fn))
6259 ;; Attempt to make .trashinfo file, trying up to 5
6260 ;; times. The .trashinfo file is opened with O_EXCL,
6261 ;; as per trash-spec 0.7, even if that can be a problem
6262 ;; on old NFS versions...
6266 trash-files-dir))
6268 success info-fn)
6273 trash-info-dir))
6281 ;; Uniqify new-fn. (Some file managers do not
6282 ;; like Emacs-style backup file names---e.g. bug
6283 ;; 170956 in Konqueror bug tracker.)
6288 ;; Finally, try to move the file to the trashcan.
6292 \f
6317 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6318 ;;; files.el ends here