| blob | 8873fadb2fc2b555d45e3a0328db4fd5ba1e0d13 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93,
4 ;; 94, 95, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
34 "Backups of edited data files."
38 "Finding files."
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
71 ;;; Turn off backup files on VMS since it has version numbers.
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `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."
166 nil
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.
200 "*Non-nil means protect against I/O errors while saving files.
201 Some modes set this non-nil in particular buffers.
203 This feature works by writing the new contents into a temporary file
204 and then renaming the temporary file to replace the original.
205 In this way, any I/O error in writing leaves the original untouched,
206 and there is never any instant where the file is nonexistent.
208 Note that this feature forces backups to be made by copying.
209 Yet, at the same time, saving a precious file
210 breaks any hard links between it and other files."
215 "*Control use of version numbers for backup files.
216 t means make numeric backup versions unconditionally.
217 nil means make them for files that have some already.
218 `never' means do not make them."
226 "*When cleaning directory, number of versions to keep."
232 "*If t, delete excess backup versions silently.
233 If nil, ask confirmation. Any other value prevents any trimming."
240 "*Number of oldest versions to keep when a new numbered backup is made."
245 "*Number of newest versions to keep when a new numbered backup is made.
246 Includes the new backup. Must be > 0"
251 "*Value of t says silently ensure a file ends in a newline when it is saved.
252 Non-nil but not t says ask user whether to add a newline when there isn't one.
253 nil means don't add newlines."
260 "*Non-nil says by default do auto-saving of every file-visiting buffer."
265 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
266 Normally auto-save files are written under other names."
271 "*Non-nil means save word abbrevs too when files are saved.
272 Loading an abbrev file sets this to t."
277 "*Non-nil means allow `find-file' to visit directories.
278 To visit the directory, `find-file' runs `find-directory-functions'."
283 "*List of functions to try in sequence to visit a directory.
284 Each function is called with the directory name as the sole argument
285 and should return either a buffer or nil."
289 ;;;It is not useful to make this a local variable.
290 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
292 "List of functions to be called for `find-file' on nonexistent file.
293 These functions are called as soon as the error is detected.
294 Variable `buffer-file-name' is already set up.
297 ;;;It is not useful to make this a local variable.
298 ;;;(put 'find-file-hooks 'permanent-local t)
300 "List of functions to be called after a buffer is loaded from a file.
301 The buffer's local variables (if any) will have been processed before the
305 "List of functions to be called before writing out a buffer to a file.
306 If one of them returns non-nil, the file is considered already written
307 and the rest are not called.
308 These hooks are considered to pertain to the visited file.
309 So any buffer-local binding of `write-file-hooks' is
312 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
314 ;;; However, in case someone does make it local...
318 "Just like `write-file-hooks', except intended for per-buffer use.
319 The functions in this list are called before the ones in
320 `write-file-hooks'.
322 This variable is meant to be used for hooks that have to do with a
323 particular visited file. Therefore, it is a permanent local, so that
324 changing the major mode does not clear it. However, calling
330 "List of functions to be called before writing out a buffer to a file.
331 If one of them returns non-nil, the file is considered already written
332 and the rest are not called.
334 This variable is meant to be used for hooks that pertain to the
335 buffer's contents, not to the particular visited file; thus,
336 `set-visited-file-name' does not clear this variable; but changing the
337 major mode does clear it.
339 This variable automatically becomes buffer-local whenever it is set.
340 If you use `add-hook' to add elements to the list, use nil for the
341 LOCAL argument.
347 "*Control use of local variables in files you visit.
348 The value can be t, nil or something else.
349 A value of t means file local variables specifications are obeyed;
350 nil means they are ignored; anything else means query.
351 This variable also controls use of major modes specified in
352 a -*- line.
355 always obeys file local variable specifications and the -*- line,
356 and ignores this variable."
363 "Like `enable-local-variables' but meant for buffer-local bindings.
364 The meaningful values are nil and non-nil. The default is non-nil.
365 If a major mode sets this to nil, buffer-locally, then any local
366 variables list in the file will be ignored.
368 This variable does not affect the use of major modes
373 The value can be t, nil or something else.
374 A value of t means obey `eval' variables;
375 nil means ignore them; anything else means query.
378 and ignores this variable."
384 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
407 "The directory for writing small temporary files.
408 If non-nil, this directory is used instead of `temporary-file-directory'
409 by programs that create small temporary files. This is for systems that
412 ;; The system null device. (Should reference NULL_DEVICE from C.)
416 "Provides support for ange-ftp host name completion.
417 Runs the usual ange-ftp hook, but only for completion operations."
418 ;; Having this here avoids the need to load ange-ftp when it's not
419 ;; really in use.
425 inhibit-file-name-handlers)))
430 "Convert a standard file's name to something suitable for the current OS.
431 This function's standard definition is trivial; it just returns the argument.
432 However, on some systems, the function is redefined
433 with a definition that really does change some file names."
434 filename)
435 \f
437 "Show the current default directory."
442 "Value of the CDPATH environment variable, as a list.
446 "Explode a colon-separated search path into a list of directory names."
454 nil
459 cd-list)))
462 "Change current directory to given absolute file name DIR."
463 ;; Put the name into directory syntax now,
464 ;; because otherwise expand-file-name may give some bad results.
477 "Make DIR become the current buffer's default directory.
478 If your environment includes a `CDPATH' variable, try each one of that
479 colon-separated list of directories when resolving a relative directory name."
482 default-directory default-directory
498 cd-path)
499 nil))
503 "Load the Lisp file named FILE."
510 "Load the library named LIBRARY.
511 This is an interface to the function `load'."
516 "Copy the file FILE into a temporary file on this machine.
517 Returns the name of the local copy, or nil, if FILE is directly
518 accessible."
519 ;; This formerly had an optional BUFFER argument that wasn't used by
520 ;; anything.
524 nil)))
527 "Return the truename of FILENAME, which should be absolute.
528 The truename of a file name is found by chasing symbolic links
529 both at the level of the file and at the level of the directories
530 containing it, until no links are left at any level.
532 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
533 Do not specify them in other calls."
534 ;; COUNTER can be a cons cell whose car is the count of how many more links
535 ;; to chase before getting an error.
536 ;; PREV-DIRS can be a cons cell whose car is an alist
537 ;; of truenames we've just recently computed.
539 ;; The last test looks dubious, maybe `+' is meant here? --simon.
549 ;; For speed, remove the ange-ftp completion handler from the list.
550 ;; We know it's not needed here.
551 ;; For even more speed, do this only on the outermost call.
558 ;; andrewi@harlequin.co.uk - none of the following code (except for
559 ;; invoking the file-name handler) currently applies on Windows
560 ;; (ie. there are no native symlinks), but there is an issue with
561 ;; case differences being ignored by the OS, and short "8.3 DOS"
562 ;; name aliases existing for all files. (The short names are not
563 ;; reported by directory-files, but can be used to refer to files.)
564 ;; It seems appropriate for file-truename to resolve these issues in
565 ;; the most natural way, which on Windows is to call the function
566 ;; `w32-long-file-name' - this returns the exact name of a file as
567 ;; it is stored on disk (expanding short name aliases with the full
568 ;; name in the process).
571 newname)
572 ;; For file name that has a special handler, call handler.
573 ;; This is so that ange-ftp can save time by doing a no-op.
576 ;; If filename contains a wildcard, newname will be the old name.
579 ;; If filename doesn't exist, newname will be nil.
584 ;; If this file directly leads to a link, process that iteratively
585 ;; so that we don't use lots of stack.
591 ;; For file name that has a special handler, call handler.
592 ;; This is so that ange-ftp can save time by doing a no-op.
595 done t)
597 target dirfile)
598 ;; Get the truename of the directory.
600 ;; If these are equal, we have the (or a) root directory.
602 ;; If this is the same dir we last got the truename for,
603 ;; save time--don't recalculate.
613 done t)
616 done t)
617 ;; Put it back on the file name.
619 ;; Is the file name the name of a link?
622 ;; Yes => chase that link, then start all over
623 ;; since the link may point to a directory name that uses links.
624 ;; We can't safely use expand-file-name here
625 ;; since target might look like foo/../bar where foo
626 ;; is itself a link. Instead, we handle . and .. above.
629 target
631 done nil)
632 ;; No, we are done!
634 filename))
637 "Chase links in FILENAME until a name that is not a link.
638 Does not examine containing directories for links,
639 unlike `file-truename'."
645 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
648 ;; Handle `..' by hand, since it needs to work in the
649 ;; target of any directory symlink.
650 ;; This code is not quite complete; it does not handle
651 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
655 ;; Chase links in the default dir of the symlink.
659 ;; Now find the parent of that dir.
663 newname))
664 \f
666 "Select buffer BUFFER in another window.
667 Optional second arg NORECORD non-nil means
668 do not put this buffer at the front of the list of recently selected ones."
674 "Switch to buffer BUFFER in another frame.
675 Optional second arg NORECORD non-nil means
676 do not put this buffer at the front of the list of recently selected ones."
683 "Edit file FILENAME.
684 Switch to a buffer visiting file FILENAME,
685 creating one if none already exists.
686 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
687 expand wildcards (if any) and visit multiple files. Wildcard expansion
688 can be suppressed by setting `find-file-wildcards'."
696 "Edit file FILENAME, in another window.
697 May create a new window, or reuse an existing one.
698 See the function `display-buffer'.
699 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
700 expand wildcards (if any) and visit multiple files."
711 "Edit file FILENAME, in another frame.
712 May create a new frame, or reuse an existing one.
713 See the function `display-buffer'.
714 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
715 expand wildcards (if any) and visit multiple files."
726 "Edit file FILENAME but don't allow changes.
735 "Edit file FILENAME in another window but don't allow changes.
744 "Edit file FILENAME in another frame but don't allow changes.
753 "Find file FILENAME as a replacement for the file in the next window.
754 This command does not select that window."
773 "Find file FILENAME, select its buffer, kill previous buffer.
774 If the current buffer now contains an empty file that you just visited
775 \(presumably by mistake), use this command to visit the file you really want."
786 ;; (not buffer-read-only)
813 \f
815 "Create a suitably named buffer for visiting FILENAME, and return it.
816 FILENAME (sans directory) is used unchanged if that name is free;
817 otherwise a string <2> or <3> or ... is appended to get an unused name."
824 "Create and return a buffer with a name based on NAME.
825 Choose the buffer's name using `generate-new-buffer-name'."
829 "Regexp to match the automounter prefix in a directory name."
837 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
840 ;; Get rid of the prefixes added by the automounter.
847 ;; If any elt of directory-abbrev-alist matches this name,
848 ;; abbreviate accordingly.
854 ;; Compute and save the abbreviated homedir name.
855 ;; We defer computing this until the first time it's needed, to
856 ;; give time for directory-abbrev-alist to be set properly.
857 ;; We include a slash at the end, to avoid spurious matches
858 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
865 ;; If FILENAME starts with the abbreviated homedir,
866 ;; make it start with `~' instead.
868 ;; If the home dir is just /, don't change it.
871 ;; MS-DOS root directories can come with a drive letter;
872 ;; Novell Netware allows drive letters beyond `Z:'.
881 filename))
884 "*List of logical names for which visiting shouldn't save the true dirname.
885 On VMS, when you visit a file using a logical name that searches a path,
886 you may or may not want the visited file name to record the specific
887 directory where the file was found. If you *do not* want that, add the logical
888 name to this list as a string."
893 "Return the buffer visiting file FILENAME (a string).
894 This is like `get-file-buffer', except that it checks for any buffer
895 visiting the same file, possibly under a different name.
896 If there is no such live buffer, return nil."
908 found)
912 number
918 ;; Verify this buffer's file number
919 ;; still belongs to its file.
922 number))
925 found))))
926 \f
928 "*Non-nil means file-visiting commands should handle wildcards.
929 For example, if you specify `*.c', that would visit all the files
930 whose names match the pattern."
936 "Read file FILENAME into a buffer and return the buffer.
937 If a buffer exists visiting FILENAME, return that one, but
938 verify that the file has not changed since visited or saved.
939 The buffer is not selected, just returned to the caller.
940 Optional first arg NOWARN non-nil means suppress any warning messages.
941 Optional second arg RAWFILE non-nil means the file is read literally.
942 Optional third arg WILDCARDS non-nil means do wildcard processing
943 and visit all the matching files. When wildcards are actually
944 used and expanded, the value is a list of buffers
945 that are visiting the various files."
952 'find-directory-functions
955 filename)))
958 find-file-wildcards
971 ;; Find any buffer for a file which has same truename.
973 ;; Let user know if there is a buffer with the same truename.
980 ;; Optionally also find that buffer.
984 ;; We are using an existing buffer.
990 ;; Certain files should be reverted automatically
991 ;; if they have changed on disk and not in the buffer.
999 found))
1009 "File %s changed on disk. Discard your edits? "
1014 "File %s changed on disk. Discard your edits in %s? "
1025 "Save file and revisit literally? "
1030 rawfile truename number))
1032 "Discard your edits and revisit file literally? "
1035 rawfile truename number)
1039 "Revisit file literally? "
1042 rawfile truename number)
1045 ;; Return the buffer we are using.
1046 buf)
1047 ;; Create a new buffer.
1050 ;; find-file-noselect-1 may use a different buffer.
1052 rawfile truename number))))))
1056 error)
1059 ;; Needed in case we are re-visiting the file with a different
1060 ;; text representation.
1074 filename)))
1075 ;; Unconditionally set error
1084 filename)))
1085 ;; Run find-file-not-found-hooks until one returns non-nil.
1087 ;; If they fail too, set error.
1089 ;; Record the file's truename, and maybe use that as visited name.
1095 ;; On VMS, we may want to remember which directory in a search list
1096 ;; the file was found in.
1108 ;; Set buffer's default directory to that of the file.
1110 ;; Turn off backup files for certain file names. Since
1111 ;; this is a permanent local, the major mode won't eliminate it.
1124 \f
1126 "Like `insert-file-contents', but only reads in the file literally.
1127 A buffer may be modified in several ways after reading into the buffer,
1128 to Emacs features such as format decoding, character code
1129 conversion, find-file-hooks, automatic uncompression, etc.
1131 This function ensures that none of these modifications will take place."
1140 nil)))
1150 "Insert contents of file FILENAME into buffer after point with no conversion.
1152 This function is meant for the user to run interactively.
1153 Don't call it from programs! Use `insert-file-contents-literally' instead.
1154 \(Its calling sequence is different; see its documentation)."
1158 filename)))
1163 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1168 "Visit file FILENAME with no conversion of any kind.
1169 Format conversion and character code conversion are both disabled,
1170 and multibyte characters are disabled in the resulting buffer.
1171 The major mode used is Fundamental mode regardless of the file name,
1172 and local variable specifications in the file are ignored.
1173 Automatic uncompression is also disabled.
1175 You cannot absolutely rely on this function to result in
1176 visiting the file literally. If Emacs already has a buffer
1177 which is visiting the file, you get the existing buffer,
1178 regardless of whether it was created literally or not.
1180 In a Lisp program, if you want to be sure of accessing a file's
1181 contents literally, you should create a temporary buffer and then read
1182 the file contents into it using `insert-file-contents-literally'."
1185 \f
1189 after-find-file-from-revert-buffer
1190 nomodes)
1191 "Called after finding a file and by the default revert function.
1192 Sets buffer mode, parses local variables.
1193 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1194 error in reading the file. WARN non-nil means warn if there
1195 exists an auto-save file more recent than the visited file.
1196 NOAUTO means don't mess with auto-save mode.
1197 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1198 means this call was from `revert-buffer'.
1199 Fifth arg NOMODES non-nil means don't alter the file's modes.
1200 Finishes by calling the functions in `find-file-hooks'
1201 unless NOMODES is non-nil."
1204 nil
1212 ;; No need to warn if buffer is auto-saved
1213 ;; under the name of the visited file.
1215 auto-save-visited-file-name))
1218 buffer-file-name))
1232 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1233 "Use M-x make-directory RET RET to create the directory"
1241 ;; Make people do a little extra work (C-x C-q)
1242 ;; before altering a backup file.
1246 nil
1256 "Choose the major mode for this buffer automatically.
1257 Also sets up any specified local variables of the file.
1258 Uses the visited file name, the -*- line, and the local variables spec.
1260 This function is called automatically from `find-file'. In that case,
1261 we may set up the file-specified mode and local variables,
1262 depending on the value of `enable-local-variables': if it is t, we do;
1263 if it is nil, we don't; otherwise, we query.
1264 In addition, if `local-enable-local-variables' is nil, we do
1265 not set local variables (though we do notice a mode specified with -*-.)
1267 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1268 or from Lisp without specifying the optional argument FIND-FILE;
1269 in that case, this function acts as if `enable-local-variables' were t."
1278 enable-local-variables)))
1316 ;;; Less common extensions come here
1317 ;;; so more common ones above are found faster.
1327 ;; for MSDOS and MS-Windows (which are case-insensitive)
1342 ;;; The following should come after the ChangeLog pattern
1343 ;;; for the sake of ChangeLog.1, etc.
1344 ;;; and after the .scm.[0-9] pattern too.
1375 ;; Mailer puts message to be edited in
1376 ;; /tmp/Re.... or Message
1381 ;; some news reader is reported to use this
1391 ;; .emacs following a directory delimiter
1392 ;; in Unix, MSDOG or VMS syntax.
1395 ;; _emacs following a directory delimiter
1396 ;; in MsDos syntax
1409 "\
1410 Alist of filename patterns vs corresponding major mode functions.
1411 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1412 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1413 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1414 mode function to use. FUNCTION will be called, unless it is nil.
1416 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1417 calling FUNCTION (if it's not nil), we delete the suffix that matched
1459 "Alist mapping interpreter names to major modes.
1460 This alist applies to files whose first line starts with `#!'.
1461 Each element looks like (INTERPRETER . MODE).
1462 The car of each element is compared with
1463 the name of the interpreter specified in the first line.
1470 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1471 When checking `inhibit-first-line-modes-regexps', we first discard
1475 "Select major mode appropriate for current buffer.
1476 This checks for a -*- mode tag in the buffer's text,
1477 compares the filename against the entries in `auto-mode-alist',
1478 or checks the interpreter that runs this file against
1479 `interpreter-mode-alist'.
1481 It does not check for the `mode:' local variable in the
1482 Local Variables section of the file; for that, use `hack-local-variables'.
1484 If `enable-local-variables' is nil, this function does not check for a
1485 -*- mode tag.
1487 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1488 then we do not set anything but the major mode,
1489 and we don't even do that unless it would come from the file name."
1490 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1496 ;; Don't look for -*- if this file name matches any
1497 ;; of the regexps in inhibit-first-line-modes-regexps.
1505 sufs)
1512 ;; If the file begins with "#!"
1513 ;; (exec interpreter magic), look
1514 ;; for mode frobs in the first two
1515 ;; lines. You cannot necessarily
1516 ;; put them in the first line of
1517 ;; such a file without screwing up
1518 ;; the interpreter invocation.
1526 t))
1533 ;; Find all specifications for the `mode:' variable
1534 ;; and execute them left to right.
1546 modes)))
1547 ;; Simple -*-MODE-*- case.
1550 modes))))))
1551 ;; If we found modes to use, invoke them now,
1552 ;; outside the save-excursion.
1557 ;; If we didn't find a mode from a -*- line, try using the file name.
1561 ;; Remove backup-suffixes from file name.
1567 ;; Find first matching alist entry.
1577 keep-going t))
1579 keep-going nil)))
1582 ;; When JUST-FROM-FILE-NAME is set,
1583 ;; we are working on behalf of set-visited-file-name.
1584 ;; In that case, if the major mode specified is the
1585 ;; same one we already have, don't actually reset it.
1586 ;; We don't want to lose minor modes such as Font Lock.
1589 ;; If we can't deduce a mode from the file name,
1590 ;; look for an interpreter specified in the first line.
1591 ;; As a special case, allow for things like "#!/bin/env perl",
1592 ;; which finds the interpreter anywhere in $PATH.
1600 elt)
1601 ;; Map interpreter name to a mode.
1603 interpreter-mode-alist))
1609 "Set local variables specified in the -*- line.
1610 Ignore any specification for `mode:' and `coding:';
1611 `set-auto-mode' should already have handled `mode:',
1612 `set-auto-coding' should already have handled `coding:'."
1619 ;; Parse the -*- line into the `result' alist.
1621 ;; doesn't have one.
1622 nil)
1624 ;; Simple form: "-*- MODENAME -*-". Already handled.
1625 nil)
1627 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1628 ;; (last ";" is optional).
1637 ;; There used to be a downcase here,
1638 ;; but the manual didn't say so,
1639 ;; and people want to set var names that aren't all lc.
1646 ;; It is traditional to ignore
1647 ;; case when checking for `mode' in set-auto-mode,
1648 ;; so we must do that here as well.
1649 ;; That is inconsistent, but we're stuck with it.
1650 ;; The same can be said for `coding' in set-auto-coding.
1664 ;; If we fail to switch in the selected window,
1665 ;; it is probably a minibuffer.
1666 ;; So try another window.
1679 "Normal hook run after processing a file's local variables specs.
1680 Major modes can use this to examine user-specified local variables
1684 "Parse and put into effect this buffer's local variables spec.
1685 If MODE-ONLY is non-nil, all we do is check whether the major mode
1686 is specified, returning t if it is specified."
1689 ;; Look for "Local variables:" line in last page.
1699 mode-only
1709 buffer-file-name)
1713 prefix prefixlen suffix beg
1714 mode-specified
1716 ;; The prefix is what comes before "local variables:" in its line.
1717 ;; The suffix is what comes after "local variables:" in its line.
1732 ;; Look at next local variable spec.
1735 ;; Skip the prefix, if any.
1740 ;; Find the variable name; strip whitespace.
1748 val)
1749 ;; Setting variable named "end" means end of list.
1752 ;; Otherwise read the variable value.
1763 ;; Set the variable. "Variables" mode and eval are funny.
1767 mode-specified))
1773 ;; Get confirmation before setting these variables as locals in a file.
1790 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1794 ;; This one is safe because the user gets to check it before it is used.
1802 A few variable names are treated specially."
1807 ;; We have already handled coding: tag in set-auto-coding.
1808 nil)
1810 nil)
1811 ;; "Setting" eval means either eval it or do nothing.
1812 ;; Likewise for setting hook variables.
1818 ;; Permit evalling a put of a harmless property.
1819 ;; if the args do nothing tricky.
1825 ;; Only allow safe values of lisp-indent-hook;
1826 ;; not functions.
1831 ;; Permit eval if not root and user says ok.
1850 ;; Ordinary variable, really set it.
1854 \f
1857 However, the mode will not be changed if
1858 \(1) a local variables list or the `-*-' line specifies a major mode, or
1860 \ not suitable for ordinary files, or
1861 \(3) the new file name does not particularly specify any mode."
1866 "Change name of file visited in current buffer to FILENAME.
1867 The next time the buffer is saved it will go in the newly specified file.
1868 nil or empty string as argument means make buffer not be visiting any file.
1869 Remember to delete the initial contents of the minibuffer
1870 if you wish to pass an empty string as the argument.
1872 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1873 confirmation in the case where another buffer is already visiting FILENAME.
1875 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1876 the old visited file has been renamed to the new name FILENAME."
1884 nil
1895 filename)))
1914 ;; Abbreviate the file names of the buffer.
1923 nil)))
1924 ;; write-file-hooks is normally used for things like ftp-find-file
1925 ;; that visit things that are not local files as if they were files.
1926 ;; Changing to visit an ordinary local file instead should flush the hook.
1931 ;; If buffer was read-only because of version control,
1932 ;; that reason is gone now, so make it writable.
1936 ;; Turn off backup files for certain file names.
1937 ;; Since this is a permanent local, the major mode won't eliminate it.
1944 ;; If auto-save was not already on, turn it on if appropriate.
1948 ;; If auto save is on, start using a new name.
1949 ;; We deliberately don't rename or delete the old auto save
1950 ;; for the old visited file name. This is because perhaps
1951 ;; the user wants to save the new state and then compare with the
1952 ;; previous state from the auto save file.
1955 ;; Rename the old auto save file if any.
1962 ;; Update the major mode, if the file name determines it.
1964 ;; Don't change the mode if it is special.
1967 ;; Don't change the mode if the local variable list specifies it.
1973 "Write current buffer into file FILENAME.
1974 This makes the buffer visit that file, and marks it as not modified.
1976 If you specify just a directory name as FILENAME, that means to use
1977 the default file name but in that directory. You can also yank
1978 the default file name into the minibuffer to edit it, using M-n.
1980 If the buffer is not already visiting a file, the default file name
1981 for the output file is the buffer name.
1983 If optional second arg CONFIRM is non-nil, this function
1984 asks for confirmation before overwriting an existing file.
1985 Interactively, confirmation is required unless you supply a prefix argument."
1986 ;; (interactive "FWrite file: ")
1990 nil nil nil nil)
1994 default-directory)
1995 nil nil))
1999 ;; If arg is just a directory,
2000 ;; use the default file name, but in that directory.
2011 ;; Make buffer writable if file is writable.
2016 \f
2018 "Make a backup of the disk file visited by the current buffer, if appropriate.
2019 This is normally done before saving the buffer the first time.
2020 If the value is non-nil, it is the result of `file-modes' on the original
2021 file; this means that the caller, after saving the buffer, should change
2022 the modes of the new file to agree with the old modes.
2024 A backup may be done by renaming or by copying; see documentation of
2025 variable `make-backup-files'. If it's done by renaming, then the file is
2026 no longer accessible under its old name."
2033 backup-info backupname targets setmodes)
2034 ;; If specified name is a symbolic link, chase it to the target.
2035 ;; Thus we make the backups in the directory where the real file is.
2040 ;;; (if (file-directory-p buffer-file-name)
2041 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
2045 ;; If have old versions to maybe delete,
2046 ;; ask the user to confirm now, before doing anything.
2047 ;; But don't actually delete til later.
2052 real-file-name))))))
2053 ;; Actually write the back up file.
2056 ; (file-symlink-p buffer-file-name)
2057 backup-by-copying
2072 ;; If copying fails because file BACKUPNAME
2073 ;; is not writable, delete that file and try again.
2078 ;; rename-file should delete old backup.
2082 ;; If trouble writing the backup, write it in ~.
2092 ;; If copying fails because file BACKUPNAME
2093 ;; is not writable, delete that file and try again.
2099 ;; Now delete the old versions, if desired.
2106 setmodes)
2110 "Return file NAME sans backup versions or strings.
2111 This is a separate procedure so your site-init or startup file can
2112 redefine it.
2113 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2114 we do not remove backup version numbers, only true file version numbers."
2120 ;; VMS version number is (a) semicolon, optional
2121 ;; sign, zero or more digits or (b) period, option
2122 ;; sign, zero or more digits, provided this is the
2123 ;; second period encountered outside of the
2124 ;; device/directory part of the file name.
2127 name)
2137 "Return t if deleting FILE and rewriting it would preserve the owner."
2142 ;; Return t if the file doesn't exist, since it's true that no
2143 ;; information would be lost by an (attempted) delete and create.
2149 The extension, in a file name, is the part that follows the last `.'."
2152 directory)
2156 directory)
2158 filename))))
2162 The extension, in a file name, is the part that follows the last `.'.
2163 Return nil for extensionless file names such as `foo'.
2164 Return the empty string for file names such as `foo.'.
2166 If PERIOD is non-nil, then the returned value includes the period
2167 that delimits the extension, and if FILENAME has no extension,
2177 "Create the non-numeric backup file name for FILE.
2178 This is a separate function so you can redefine it for customization."
2191 "Return non-nil if FILE is a backup file name (numeric or not).
2192 This is a separate function so you can redefine it for customization.
2193 You may need to redefine `file-name-sans-versions' as well."
2198 ;; This is used in various files.
2199 ;; The usage of backup-extract-version-start is not very clean,
2200 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2202 "Given the name of a numeric backup file, FN, return the backup number.
2203 Uses the free variable `backup-extract-version-start', whose value should be
2204 the index in the name where the version number begins."
2210 ;; I believe there is no need to alter this behavior for VMS;
2211 ;; since backup files are not made on VMS, it should not get called.
2213 "Find a file name for a backup file FN, and suggestions for deletions.
2214 Value is a list whose car is the name for the backup file
2215 and whose cdr is a list of old versions to consider deleting now.
2216 If the value is nil, don't make a backup."
2218 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2225 possibilities
2232 base-versions
2236 possibilities)
2237 '<)
2249 ;; Delete nothing if there is overflow
2250 ;; in the number of versions to keep.
2256 v))))))))))
2259 "Return number of names file FILENAME has."
2263 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2264 This function returns a relative file name which is equivalent to FILENAME
2265 when used with that default directory as the default.
2266 If this is impossible (which can happen on MSDOS and Windows
2267 when the file name and directory use different drive names)
2268 then it returns FILENAME."
2273 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2274 ;; drive names, they can't be relative, so return the absolute name.
2279 filename
2286 ".."
2288 ;; Now ancestor is empty, or .., or ../.., etc.
2290 ;; We matched within FNAME's directory part.
2291 ;; Add the rest of FNAME onto ANCESTOR.
2295 ;; But don't bother with ANCESTOR if it would give us `./'.
2296 rest
2298 ;; We matched FNAME's directory equivalent.
2299 ancestor))))))
2300 \f
2302 "Save current buffer in visited file if modified. Versions described below.
2303 By default, makes the previous version into a backup file
2304 if previously requested or if this is the first save.
2306 to become a backup when the next save is done.
2308 unconditionally makes the previous version into a backup file.
2310 to become a backup when the next save is done,
2311 and unconditionally makes the previous version into a backup file.
2313 With argument of 0, never make the previous version into a backup file.
2315 If a file's name is FOO, the names of its numbered backup versions are
2316 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2317 Numeric backups (rather than FOO~) will be made if value of
2318 `version-control' is not the atom `never' and either there are already
2319 numeric versions of the file being backed up, or `version-control' is
2320 non-nil.
2321 We don't want excessive versions piling up, so there are variables
2322 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2323 and `kept-new-versions', which tells how many newest versions to keep.
2324 Defaults are 2 old versions and 2 new.
2325 `dired-kept-versions' controls dired's clean-directory (.) command.
2326 If `delete-old-versions' is nil, system will query user
2327 before trimming versions. Otherwise it does it silently.
2329 If `vc-make-backup-files' is nil, which is the default,
2330 no backup files are made for files managed by version control.
2331 (This is because the version control system itself records previous versions.)
2333 See the subroutine `basic-save-buffer' for more information."
2345 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2346 Normally delete only if the file was written by this Emacs since
2347 the last real save, but optional arg FORCE non-nil means delete anyway."
2364 "If non-nil, use this coding system for saving the buffer.
2365 More precisely, use this coding system in place of the
2366 value of `buffer-file-coding-system', when saving the buffer.
2367 Calling `write-region' for any purpose other than saving the buffer
2368 will still use `buffer-file-coding-system'; this variable has no effect
2375 "Save the current buffer in its visited file, if it has been modified.
2376 The hooks `write-contents-hooks', `local-write-file-hooks' and
2377 `write-file-hooks' get a chance to do the job of saving; if they do not,
2378 then the buffer is saved in the visited file file in the usual way.
2379 After saving the buffer, this function runs `after-save-hook'."
2382 ;; In an indirect buffer, save its base buffer instead.
2387 setmodes tempsetmodes)
2388 ;; On VMS, rename file and buffer to get rid of version number.
2393 ;; Strip VMS version number before save.
2396 ;; Construct a (unique) buffer name to correspond.
2401 ;; If buffer has no file name, ask user for one.
2408 filename))
2435 ;; If a hook returned t, file is already "written".
2436 ;; Otherwise, write it the usual way now.
2438 ;; Now we have saved the current buffer. Let's make sure
2439 ;; that buffer-file-coding-system is fixed to what
2440 ;; actually used for saving by binding it locally.
2450 ;; If the auto-save file was recent before this command,
2451 ;; delete it now.
2453 ;; Support VC `implicit' locking.
2458 ;; This does the "real job" of writing a buffer into its visited file
2459 ;; and making a backup file. This is what is normally done
2460 ;; but inhibited if one of write-file-hooks returns non-nil.
2461 ;; It returns a value to store in setmodes.
2481 buffer-file-name)))
2489 ;; If file is precious, write temp name, then rename it.
2490 ;; This requires write access to the containing dir,
2491 ;; which is why we don't try it if we don't have that access.
2493 tempname temp nogood i succeed
2497 ;; Find the temporary name to write under.
2504 dir i))
2510 tempname nil realname
2511 buffer-file-truename)
2513 ;; If writing the temp file fails,
2514 ;; delete the temp file.
2519 ;; Since we have created an entirely new file
2520 ;; and renamed it, make sure it gets the
2521 ;; right permission bits set.
2523 ;; We succeeded in writing the temp file,
2524 ;; so rename it.
2526 ;; If file not writable, see if we can make it writable
2527 ;; temporarily while we write it.
2528 ;; But no need to do so if we have just backed it up
2529 ;; (setmodes is set) because that says we're superseding.
2531 ;; Change the mode back, after writing.
2535 buffer-file-name nil t buffer-file-truename)))
2536 setmodes))
2539 "Save some modified file-visiting buffers. Asks user about each one.
2540 Optional argument (the prefix) non-nil means save all with no questions.
2541 Optional second argument PRED determines which buffers are considered:
2542 If PRED is nil, all the file-visiting buffers are considered.
2543 If PRED is t, then certain non-file buffers will also be considered.
2544 If PRED is a zero-argument function, it indicates for each buffer whether
2545 to consider it or not when called with that buffer current."
2564 t
2583 ;; Return nil to ask about BUF again.
2584 nil)
2591 abbrev-file-name)))
2593 ;; Don't keep bothering user if he says no.
2595 t))))
2598 \f
2600 "Mark current buffer as unmodified, not needing to be saved.
2603 It is not a good idea to use this function in Lisp programs, because it
2604 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2611 "Change whether this buffer is visiting its file read-only.
2612 With arg, set read-only iff arg is positive.
2613 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2619 ;; Toggle.
2631 "Insert contents of file FILENAME into buffer after point.
2632 Set mark after the inserted text.
2634 This function is meant for the user to run interactively.
2635 Don't call it from programs! Use `insert-file-contents' instead.
2636 \(Its calling sequence is different; see its documentation)."
2640 filename)))
2645 "Append the contents of the region to the end of file FILENAME.
2646 When called from a function, expects three arguments,
2647 START, END and FILENAME. START and END are buffer positions
2648 saying what text to write."
2653 "Return most recent backup file for FILENAME or nil if no backups exist."
2659 tem)
2669 newest))
2672 "Rename current buffer to a similar name not already taken.
2673 This function is useful for creating multiple shell process buffers
2674 or multiple mail buffers, etc."
2682 ;; If the existing buffer name has a <NNN>,
2683 ;; which isn't part of the file name (if any),
2684 ;; then get rid of that.
2690 "Create the directory DIR and any nonexistent parent dirs.
2691 Interactively, the default choice of directory to create
2692 is the current default directory for file names.
2693 That is useful when you have visited a file in a nonexistent directory.
2695 Noninteractively, the second (optional) argument PARENTS says whether
2696 to create parent directories if they don't exist."
2699 nil nil)
2700 t))
2707 create-list)
2714 \f
2717 "Function to use to revert this buffer, or nil to do the default.
2718 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2723 "Function to use to insert contents when reverting this buffer.
2724 Gets two args, first the nominal file name to use,
2725 and second, t if reading the auto-save file.
2730 "Normal hook for `revert-buffer' to run before reverting.
2731 If `revert-buffer-function' is used to override the normal revert
2735 "Normal hook for `revert-buffer' to run after reverting.
2736 Note that the hook value that it runs is the value that was in effect
2737 before reverting; that makes a difference if you have buffer-local
2738 hook functions.
2740 If `revert-buffer-function' is used to override the normal revert
2746 "Replace current buffer text with the text of the visited file on disk.
2747 This undoes all changes since the file was visited or saved.
2748 With a prefix argument, offer to revert from latest auto-save file, if
2749 that is more recent than the visited file.
2751 This command also works for special buffers that contain text which
2752 doesn't come from a file, but reflects some other data base instead:
2753 for example, Dired buffers and buffer-list buffers. In these cases,
2754 it reconstructs the buffer contents from the appropriate data base.
2756 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2757 to revert from the auto-save file when this is nil. Note that the
2758 sense of this argument is the reverse of the prefix argument, for the
2759 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2760 to nil.
2762 Optional second argument NOCONFIRM means don't ask for confirmation at
2763 all. (The local variable `revert-without-query', if non-nil, prevents
2764 confirmation.)
2766 Optional third argument PRESERVE-MODES non-nil means don't alter
2767 the files modes. Normally we reinitialize them using `normal-mode'.
2769 If the value of `revert-buffer-function' is non-nil, it is called to
2770 do all the work for this command. Otherwise, the hooks
2771 `before-revert-hook' and `after-revert-hook' are run at the beginning
2772 and the end, and if `revert-buffer-insert-file-contents-function' is
2773 non-nil, it is called instead of rereading visited file contents."
2775 ;; I admit it's odd to reverse the sense of the prefix argument, but
2776 ;; there is a lot of code out there which assumes that the first
2777 ;; argument should be t to avoid consulting the auto-save file, and
2778 ;; there's no straightforward way to encourage authors to notice a
2779 ;; reversal of the argument sense. So I'm just changing the user
2780 ;; interface, but leaving the programmatic interface the same.
2786 buffer-auto-save-file-name
2791 buffer-auto-save-file-name
2792 buffer-file-name)))
2803 found))
2805 file-name)))
2807 ;; If file was backed up but has changed since,
2808 ;; we shd make another backup.
2812 ;; Get rid of all undo records for this buffer.
2815 ;; Effectively copy the after-revert-hook status,
2816 ;; since after-find-file will clobber it.
2820 after-revert-hook)))
2822 ;; Don't make undo records for the reversion.
2826 file-name auto-save-p)
2829 ;; Bind buffer-file-name to nil
2830 ;; so that we don't try to lock the file.
2836 ;; Auto-saved file shoule be read without
2837 ;; any code conversion.
2839 coding-system-for-read)))
2840 ;; Note that this preserves point in an intelligent way.
2842 nil nil t))))
2843 ;; Recompute the truename in case changes in symlinks
2844 ;; have changed the truename.
2848 ;; Run after-revert-hook as it was before we reverted.
2856 t)))))
2859 "Visit file FILE, but get contents from its last auto-save file."
2860 ;; Actually putting the file name in the minibuffer should be used
2861 ;; only rarely.
2862 ;; Not just because users often use the default.
2879 file file-name)))
2883 ;; Keep the current buffer-file-coding-system.
2885 ;; Auto-saved file shoule be read without any code conversion.
2894 "Recover auto save files from a previous Emacs session.
2895 This command first displays a Dired buffer showing you the
2896 previous sessions that you could recover from.
2897 To choose one, move point to the proper line and then type C-c C-c.
2898 Then you'll be asked about a number of files to recover."
2909 ;; Each line starts with a space
2910 ;; so that Font Lock mode won't highlight the first character.
2919 "Choose one saved session to recover auto-save files from.
2920 This command is used in the special Dired buffer created by
2923 ;; Get the name of the session file to recover from.
2925 files
2931 ;; Read in the auto-save-list file.
2935 ;; Loop thru the text of that file
2936 ;; and get out the names of the files to recover.
2940 ;; This is a pair of lines for a non-file-visiting buffer.
2941 ;; Get the auto-save file name and manufacture
2942 ;; a "visited file name" from that.
2958 ;; This pair of lines is a file-visiting
2959 ;; buffer. Use the visited file name.
2969 ;; Ignore a file if its auto-save file does not exist now.
2973 ;; The file contains a pair of line for each auto-saved buffer.
2974 ;; The first line of the pair contains the visited file name
2975 ;; or is empty if the buffer was not visiting a file.
2976 ;; The second line is the auto-save file name.
2984 files
2990 "For each buffer in LIST, ask whether to kill it.
2991 LIST defaults to all existing live buffers."
3002 name
3007 \f
3009 "Toggle auto-saving of contents of current buffer.
3010 With prefix argument ARG, turn auto-saving on if positive, else off."
3015 ;; If auto-save is off because buffer has shrunk,
3016 ;; then toggling should turn it on.
3021 buffer-file-name
3023 ;; If -1 was stored here, to temporarily turn off saving,
3024 ;; turn it back on.
3030 buffer-auto-save-file-name)
3033 "Adjust current buffer's auto save file name for current conditions.
3034 Also rename any existing auto save file, if it was made in this session."
3046 "Return file name to use for auto-saves of current buffer.
3047 Does not consider `auto-save-visited-file-name' as that variable is checked
3048 before calling this function. You can redefine this for customization.
3049 See also `auto-save-file-name-p'."
3059 "#"
3063 ;; Deal with buffers that don't have any associated files. (Mail
3064 ;; mode tends to create a good number of these.)
3068 ;; Eliminate all slashes and backslashes by
3069 ;; replacing them with sequences that start with %.
3070 ;; Quote % also, to keep distinct names distinct.
3079 ;; Generate the file name.
3082 ;; Try a few alternative directories, to get one we can write it.
3089 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3090 FILENAME should lack slashes. You can redefine this for customization."
3092 \f
3094 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3095 The generated regexp will match a filename iff the filename
3096 matches that wildcard according to shell rules. Only wildcards known
3097 by `sh' are supported."
3099 ;; Copy the initial run of non-special characters.
3102 ;; If no special characters, we're almost done.
3106 j)
3108 result
3129 ;; Found "[^". Insert a `\0' character
3130 ;; (which cannot happen in a filename)
3131 ;; into the character class, so that `^'
3132 ;; is not the first character after `[',
3133 ;; and thus non-special in a regexp.
3138 ;; I don't think `]' can appear in a
3139 ;; character class in a wildcard, but
3140 ;; let's be general here.
3147 i
3160 ;; Shell wildcards should match the entire filename,
3161 ;; not its part. Make the regexp say so.
3163 \f
3166 "*Switches for `list-directory' to pass to `ls' for brief listing."
3172 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3174 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3179 "Expand wildcard pattern PATTERN.
3180 This returns a list of file names which match the pattern.
3182 If PATTERN is written as an absolute relative file name,
3183 the values are absolute also.
3185 If PATTERN is written as a relative file name, it is interpreted
3186 relative to the current default directory, `default-directory'.
3187 The file names returned are normally also relative to the current
3188 default directory. However, if FULL is non-nil, they are absolute."
3191 ;; A list of all dirs that DIRPART specifies.
3192 ;; This can be more than one dir
3193 ;; if DIRPART contains wildcards.
3198 contents)
3203 ;; Filter out "." and ".."
3208 name))
3215 this-dir-contents)
3216 this-dir-contents)
3217 contents))))
3219 contents))
3222 "Display a list of files in or matching DIRNAME, a la `ls'.
3223 DIRNAME is globbed by the shell if necessary.
3224 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3225 Actions controlled by variables `list-directory-brief-switches'
3226 and `list-directory-verbose-switches'."
3230 nil default-directory nil)
3231 pfx)))
3233 list-directory-brief-switches)))
3253 ;; insert-directory
3254 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3255 ;; FULL-DIRECTORY-P is nil.
3256 ;; The single line of output must display FILE's name as it was
3257 ;; given, namely, an absolute path name.
3258 ;; - must insert exactly one line for each file if WILDCARD or
3259 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3260 ;; before the file lines, plus optional text after the file lines.
3261 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3262 ;; allowed.
3263 ;; File lines should display the basename.
3264 ;; - must be consistent with
3265 ;; - functions dired-move-to-filename, (these two define what a file line is)
3266 ;; dired-move-to-end-of-filename,
3267 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3268 ;; dired-insert-headerline
3269 ;; dired-after-subdir-garbage (defines what a "total" line is)
3270 ;; - variable dired-subdir-regexp
3272 "Insert directory listing for FILE, formatted according to SWITCHES.
3273 Leaves point after the inserted text.
3274 SWITCHES may be a string of options, or a list of strings.
3275 Optional third arg WILDCARD means treat FILE as shell wildcard.
3276 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3277 switches do not contain `d', so that a full listing is expected.
3279 This works by running a directory listing program
3280 whose name is in the variable `insert-directory-program'.
3281 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3282 ;; We need the directory in order to find the right handler.
3287 wildcard full-directory-p)
3293 default-file-name-coding-system)))
3294 ;; This is to control encoding the arguments in call-process.
3298 ;; Run ls in the directory of the file pattern we asked for.
3305 ;; Quote some characters that have special meanings in shells;
3306 ;; but don't quote the wildcards--we want them to be special.
3307 ;; We also currently don't quote the quoting characters
3308 ;; in case people want to use them explicitly to quote
3309 ;; wildcard characters.
3318 insert-directory-program
3319 " -d "
3321 switches
3323 " -- "
3324 pattern)))
3325 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3326 ;; directory if FILE is a symbolic link.
3328 insert-directory-program nil t nil
3334 ;; Split the switches at any spaces
3335 ;; so we can pass separate options as separate args.
3338 list)
3342 ;; Avoid lossage if FILE starts with `-'.
3350 file)))))))))
3352 ;; We get here if ls failed.
3353 ;; Access the file to get a suitable error.
3357 "Functions to call with no arguments to query about killing Emacs.
3358 If any of these functions returns nil, killing Emacs is cancelled.
3360 but `kill-emacs', the low level primitive, does not.
3364 "Offer to save each buffer, then kill this Emacs process.
3365 With prefix arg, silently save all file-visiting buffers, then kill."
3374 ;; process-list is not defined on VMS.
3376 active)
3381 val)
3387 ;; Query the user for other things, perhaps.
3390 \f
3391 ;; We use /: as a prefix to "quote" a file name
3392 ;; so that magic file name handlers will not apply to it.
3396 file-name-handler-alist))
3398 ;; We depend on being the last handler on the list,
3399 ;; so that anything else which does need handling
3400 ;; has been handled already.
3401 ;; So it is safe for us to inhibit *all* magic file name handlers.
3410 default-directory))
3411 ;; Get a list of the indices of the args which are file names.
3414 ;; The first four are special because they
3415 ;; return a file name. We want to include the /:
3416 ;; in the return value.
3417 ;; So just avoid stripping it in the first place.
3419 ;; `identity' means just return the first arg
3420 ;; as stripped of its quoting.
3431 ;; For all other operations, treat the first argument only
3432 ;; as the file name.
3434 ;; Copy ARGUMENTS so we can replace elements in it.
3436 ;; Strip off the /: from the file names that have this handler.
3444 "/"
3450 \f
3473 ;;; files.el ends here