Partially undo the dispatcher split, it needs to happen more gradually
[emacs.git] / src / fileio.c
bloba78388895b359603ee6fc0b6f26000445a0fee86
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #include <config.h>
24 #include <limits.h>
26 #ifdef HAVE_FCNTL_H
27 #include <fcntl.h>
28 #endif
30 #include <stdio.h>
31 #include <sys/types.h>
32 #include <sys/stat.h>
34 #ifdef HAVE_UNISTD_H
35 #include <unistd.h>
36 #endif
38 #if !defined (S_ISLNK) && defined (S_IFLNK)
39 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
40 #endif
42 #if !defined (S_ISFIFO) && defined (S_IFIFO)
43 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
44 #endif
46 #if !defined (S_ISREG) && defined (S_IFREG)
47 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
48 #endif
50 #ifdef HAVE_PWD_H
51 #include <pwd.h>
52 #endif
54 #include <ctype.h>
56 #ifdef VMS
57 #include "vmsdir.h"
58 #include <perror.h>
59 #include <stddef.h>
60 #include <string.h>
61 #endif
63 #include <errno.h>
65 #ifndef vax11c
66 #ifndef USE_CRT_DLL
67 extern int errno;
68 #endif
69 #endif
71 #include "lisp.h"
72 #include "intervals.h"
73 #include "buffer.h"
74 #include "character.h"
75 #include "coding.h"
76 #include "window.h"
77 #include "blockinput.h"
78 #include "frame.h"
79 #include "dispextern.h"
81 #ifdef WINDOWSNT
82 #define NOMINMAX 1
83 #include <windows.h>
84 #include <stdlib.h>
85 #include <fcntl.h>
86 #endif /* not WINDOWSNT */
88 #ifdef MSDOS
89 #include "msdos.h"
90 #include <sys/param.h>
91 #if __DJGPP__ >= 2
92 #include <fcntl.h>
93 #include <string.h>
94 #endif
95 #endif
97 #ifdef DOS_NT
98 #define CORRECT_DIR_SEPS(s) \
99 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
100 else unixtodos_filename (s); \
101 } while (0)
102 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
103 redirector allows the six letters between 'Z' and 'a' as well. */
104 #ifdef MSDOS
105 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
106 #endif
107 #ifdef WINDOWSNT
108 #define IS_DRIVE(x) isalpha (x)
109 #endif
110 /* Need to lower-case the drive letter, or else expanded
111 filenames will sometimes compare inequal, because
112 `expand-file-name' doesn't always down-case the drive letter. */
113 #define DRIVE_LETTER(x) (tolower (x))
114 #endif
116 #ifdef VMS
117 #include <file.h>
118 #include <rmsdef.h>
119 #include <fab.h>
120 #include <nam.h>
121 #endif
123 #include "systime.h"
125 #ifdef HPUX
126 #include <netio.h>
127 #ifndef HPUX8
128 #ifndef HPUX9
129 #include <errnet.h>
130 #endif
131 #endif
132 #endif
134 #include "commands.h"
135 extern int use_dialog_box;
136 extern int use_file_dialog;
138 #ifndef O_WRONLY
139 #define O_WRONLY 1
140 #endif
142 #ifndef O_RDONLY
143 #define O_RDONLY 0
144 #endif
146 #ifndef S_ISLNK
147 # define lstat stat
148 #endif
150 #ifndef FILE_SYSTEM_CASE
151 #define FILE_SYSTEM_CASE(filename) (filename)
152 #endif
154 /* Nonzero during writing of auto-save files */
155 int auto_saving;
157 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
158 a new file with the same mode as the original */
159 int auto_save_mode_bits;
161 /* Set by auto_save_1 if an error occurred during the last auto-save. */
162 int auto_save_error_occurred;
164 /* The symbol bound to coding-system-for-read when
165 insert-file-contents is called for recovering a file. This is not
166 an actual coding system name, but just an indicator to tell
167 insert-file-contents to use `emacs-mule' with a special flag for
168 auto saving and recovering a file. */
169 Lisp_Object Qauto_save_coding;
171 /* Coding system for file names, or nil if none. */
172 Lisp_Object Vfile_name_coding_system;
174 /* Coding system for file names used only when
175 Vfile_name_coding_system is nil. */
176 Lisp_Object Vdefault_file_name_coding_system;
178 /* Alist of elements (REGEXP . HANDLER) for file names
179 whose I/O is done with a special handler. */
180 Lisp_Object Vfile_name_handler_alist;
182 /* Property name of a file name handler,
183 which gives a list of operations it handles.. */
184 Lisp_Object Qoperations;
186 /* Lisp functions for translating file formats */
187 Lisp_Object Qformat_decode, Qformat_annotate_function;
189 /* Function to be called to decide a coding system of a reading file. */
190 Lisp_Object Vset_auto_coding_function;
192 /* Functions to be called to process text properties in inserted file. */
193 Lisp_Object Vafter_insert_file_functions;
195 /* Lisp function for setting buffer-file-coding-system and the
196 multibyteness of the current buffer after inserting a file. */
197 Lisp_Object Qafter_insert_file_set_coding;
199 /* Functions to be called to create text property annotations for file. */
200 Lisp_Object Vwrite_region_annotate_functions;
201 Lisp_Object Qwrite_region_annotate_functions;
203 /* During build_annotations, each time an annotation function is called,
204 this holds the annotations made by the previous functions. */
205 Lisp_Object Vwrite_region_annotations_so_far;
207 /* File name in which we write a list of all our auto save files. */
208 Lisp_Object Vauto_save_list_file_name;
210 /* On VMS, nonzero means write new files with record format stmlf.
211 Zero means use var format. */
212 int vms_stmlf_recfm;
214 /* On NT, specifies the directory separator character, used (eg.) when
215 expanding file names. This can be bound to / or \. */
216 Lisp_Object Vdirectory_sep_char;
218 #ifdef HAVE_FSYNC
219 /* Nonzero means skip the call to fsync in Fwrite-region. */
220 int write_region_inhibit_fsync;
221 #endif
223 extern Lisp_Object Vuser_login_name;
225 #ifdef WINDOWSNT
226 extern Lisp_Object Vw32_get_true_file_attributes;
227 #endif
229 extern int minibuf_level;
231 extern int minibuffer_auto_raise;
233 extern int history_delete_duplicates;
235 /* These variables describe handlers that have "already" had a chance
236 to handle the current operation.
238 Vinhibit_file_name_handlers is a list of file name handlers.
239 Vinhibit_file_name_operation is the operation being handled.
240 If we try to handle that operation, we ignore those handlers. */
242 static Lisp_Object Vinhibit_file_name_handlers;
243 static Lisp_Object Vinhibit_file_name_operation;
245 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
246 Lisp_Object Qexcl;
247 Lisp_Object Qfile_name_history;
249 Lisp_Object Qcar_less_than_car;
251 static int a_write P_ ((int, Lisp_Object, int, int,
252 Lisp_Object *, struct coding_system *));
253 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
256 void
257 report_file_error (string, data)
258 const char *string;
259 Lisp_Object data;
261 Lisp_Object errstring;
262 int errorno = errno;
263 char *str;
265 synchronize_system_messages_locale ();
266 str = strerror (errorno);
267 errstring = code_convert_string_norecord (make_unibyte_string (str,
268 strlen (str)),
269 Vlocale_coding_system, 0);
271 while (1)
272 switch (errorno)
274 case EEXIST:
275 xsignal (Qfile_already_exists, Fcons (errstring, data));
276 break;
277 default:
278 /* System error messages are capitalized. Downcase the initial
279 unless it is followed by a slash. */
280 if (SREF (errstring, 1) != '/')
281 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
283 xsignal (Qfile_error,
284 Fcons (build_string (string), Fcons (errstring, data)));
288 Lisp_Object
289 close_file_unwind (fd)
290 Lisp_Object fd;
292 emacs_close (XFASTINT (fd));
293 return Qnil;
296 /* Restore point, having saved it as a marker. */
298 static Lisp_Object
299 restore_point_unwind (location)
300 Lisp_Object location;
302 Fgoto_char (location);
303 Fset_marker (location, Qnil, Qnil);
304 return Qnil;
308 Lisp_Object Qexpand_file_name;
309 Lisp_Object Qsubstitute_in_file_name;
310 Lisp_Object Qdirectory_file_name;
311 Lisp_Object Qfile_name_directory;
312 Lisp_Object Qfile_name_nondirectory;
313 Lisp_Object Qunhandled_file_name_directory;
314 Lisp_Object Qfile_name_as_directory;
315 Lisp_Object Qcopy_file;
316 Lisp_Object Qmake_directory_internal;
317 Lisp_Object Qmake_directory;
318 Lisp_Object Qdelete_directory;
319 Lisp_Object Qdelete_file;
320 Lisp_Object Qrename_file;
321 Lisp_Object Qadd_name_to_file;
322 Lisp_Object Qmake_symbolic_link;
323 Lisp_Object Qfile_exists_p;
324 Lisp_Object Qfile_executable_p;
325 Lisp_Object Qfile_readable_p;
326 Lisp_Object Qfile_writable_p;
327 Lisp_Object Qfile_symlink_p;
328 Lisp_Object Qaccess_file;
329 Lisp_Object Qfile_directory_p;
330 Lisp_Object Qfile_regular_p;
331 Lisp_Object Qfile_accessible_directory_p;
332 Lisp_Object Qfile_modes;
333 Lisp_Object Qset_file_modes;
334 Lisp_Object Qset_file_times;
335 Lisp_Object Qfile_newer_than_file_p;
336 Lisp_Object Qinsert_file_contents;
337 Lisp_Object Qwrite_region;
338 Lisp_Object Qverify_visited_file_modtime;
339 Lisp_Object Qset_visited_file_modtime;
341 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
342 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
343 Otherwise, return nil.
344 A file name is handled if one of the regular expressions in
345 `file-name-handler-alist' matches it.
347 If OPERATION equals `inhibit-file-name-operation', then we ignore
348 any handlers that are members of `inhibit-file-name-handlers',
349 but we still do run any other handlers. This lets handlers
350 use the standard functions without calling themselves recursively. */)
351 (filename, operation)
352 Lisp_Object filename, operation;
354 /* This function must not munge the match data. */
355 Lisp_Object chain, inhibited_handlers, result;
356 int pos = -1;
358 result = Qnil;
359 CHECK_STRING (filename);
361 if (EQ (operation, Vinhibit_file_name_operation))
362 inhibited_handlers = Vinhibit_file_name_handlers;
363 else
364 inhibited_handlers = Qnil;
366 for (chain = Vfile_name_handler_alist; CONSP (chain);
367 chain = XCDR (chain))
369 Lisp_Object elt;
370 elt = XCAR (chain);
371 if (CONSP (elt))
373 Lisp_Object string = XCAR (elt);
374 int match_pos;
375 Lisp_Object handler = XCDR (elt);
376 Lisp_Object operations = Qnil;
378 if (SYMBOLP (handler))
379 operations = Fget (handler, Qoperations);
381 if (STRINGP (string)
382 && (match_pos = fast_string_match (string, filename)) > pos
383 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
385 Lisp_Object tem;
387 handler = XCDR (elt);
388 tem = Fmemq (handler, inhibited_handlers);
389 if (NILP (tem))
391 result = handler;
392 pos = match_pos;
397 QUIT;
399 return result;
402 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
403 1, 1, 0,
404 doc: /* Return the directory component in file name FILENAME.
405 Return nil if FILENAME does not include a directory.
406 Otherwise return a directory name.
407 Given a Unix syntax file name, returns a string ending in slash;
408 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
409 (filename)
410 Lisp_Object filename;
412 #ifndef DOS_NT
413 register const unsigned char *beg;
414 #else
415 register unsigned char *beg;
416 #endif
417 register const unsigned char *p;
418 Lisp_Object handler;
420 CHECK_STRING (filename);
422 /* If the file name has special constructs in it,
423 call the corresponding file handler. */
424 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
425 if (!NILP (handler))
426 return call2 (handler, Qfile_name_directory, filename);
428 filename = FILE_SYSTEM_CASE (filename);
429 beg = SDATA (filename);
430 #ifdef DOS_NT
431 beg = strcpy (alloca (strlen (beg) + 1), beg);
432 #endif
433 p = beg + SBYTES (filename);
435 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
436 #ifdef VMS
437 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
438 #endif /* VMS */
439 #ifdef DOS_NT
440 /* only recognise drive specifier at the beginning */
441 && !(p[-1] == ':'
442 /* handle the "/:d:foo" and "/:foo" cases correctly */
443 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
444 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
445 #endif
446 ) p--;
448 if (p == beg)
449 return Qnil;
450 #ifdef DOS_NT
451 /* Expansion of "c:" to drive and default directory. */
452 if (p[-1] == ':')
454 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
455 unsigned char *res = alloca (MAXPATHLEN + 1);
456 unsigned char *r = res;
458 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
460 strncpy (res, beg, 2);
461 beg += 2;
462 r += 2;
465 if (getdefdir (toupper (*beg) - 'A' + 1, r))
467 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
468 strcat (res, "/");
469 beg = res;
470 p = beg + strlen (beg);
473 CORRECT_DIR_SEPS (beg);
474 #endif /* DOS_NT */
476 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
479 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
480 Sfile_name_nondirectory, 1, 1, 0,
481 doc: /* Return file name FILENAME sans its directory.
482 For example, in a Unix-syntax file name,
483 this is everything after the last slash,
484 or the entire name if it contains no slash. */)
485 (filename)
486 Lisp_Object filename;
488 register const unsigned char *beg, *p, *end;
489 Lisp_Object handler;
491 CHECK_STRING (filename);
493 /* If the file name has special constructs in it,
494 call the corresponding file handler. */
495 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
496 if (!NILP (handler))
497 return call2 (handler, Qfile_name_nondirectory, filename);
499 beg = SDATA (filename);
500 end = p = beg + SBYTES (filename);
502 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
503 #ifdef VMS
504 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
505 #endif /* VMS */
506 #ifdef DOS_NT
507 /* only recognise drive specifier at beginning */
508 && !(p[-1] == ':'
509 /* handle the "/:d:foo" case correctly */
510 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
511 #endif
513 p--;
515 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
518 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
519 Sunhandled_file_name_directory, 1, 1, 0,
520 doc: /* Return a directly usable directory name somehow associated with FILENAME.
521 A `directly usable' directory name is one that may be used without the
522 intervention of any file handler.
523 If FILENAME is a directly usable file itself, return
524 \(file-name-directory FILENAME).
525 If FILENAME refers to a file which is not accessible from a local process,
526 then this should return nil.
527 The `call-process' and `start-process' functions use this function to
528 get a current directory to run processes in. */)
529 (filename)
530 Lisp_Object filename;
532 Lisp_Object handler;
534 /* If the file name has special constructs in it,
535 call the corresponding file handler. */
536 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
537 if (!NILP (handler))
538 return call2 (handler, Qunhandled_file_name_directory, filename);
540 return Ffile_name_directory (filename);
544 char *
545 file_name_as_directory (out, in)
546 char *out, *in;
548 int size = strlen (in) - 1;
550 strcpy (out, in);
552 if (size < 0)
554 out[0] = '.';
555 out[1] = '/';
556 out[2] = 0;
557 return out;
560 #ifdef VMS
561 /* Is it already a directory string? */
562 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
563 return out;
564 /* Is it a VMS directory file name? If so, hack VMS syntax. */
565 else if (! index (in, '/')
566 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
567 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
568 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
569 || ! strncmp (&in[size - 5], ".dir", 4))
570 && (in[size - 1] == '.' || in[size - 1] == ';')
571 && in[size] == '1')))
573 register char *p, *dot;
574 char brack;
576 /* x.dir -> [.x]
577 dir:x.dir --> dir:[x]
578 dir:[x]y.dir --> dir:[x.y] */
579 p = in + size;
580 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
581 if (p != in)
583 strncpy (out, in, p - in);
584 out[p - in] = '\0';
585 if (*p == ':')
587 brack = ']';
588 strcat (out, ":[");
590 else
592 brack = *p;
593 strcat (out, ".");
595 p++;
597 else
599 brack = ']';
600 strcpy (out, "[.");
602 dot = index (p, '.');
603 if (dot)
605 /* blindly remove any extension */
606 size = strlen (out) + (dot - p);
607 strncat (out, p, dot - p);
609 else
611 strcat (out, p);
612 size = strlen (out);
614 out[size++] = brack;
615 out[size] = '\0';
617 #else /* not VMS */
618 /* For Unix syntax, Append a slash if necessary */
619 if (!IS_DIRECTORY_SEP (out[size]))
621 /* Cannot use DIRECTORY_SEP, which could have any value */
622 out[size + 1] = '/';
623 out[size + 2] = '\0';
625 #ifdef DOS_NT
626 CORRECT_DIR_SEPS (out);
627 #endif
628 #endif /* not VMS */
629 return out;
632 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
633 Sfile_name_as_directory, 1, 1, 0,
634 doc: /* Return a string representing the file name FILE interpreted as a directory.
635 This operation exists because a directory is also a file, but its name as
636 a directory is different from its name as a file.
637 The result can be used as the value of `default-directory'
638 or passed as second argument to `expand-file-name'.
639 For a Unix-syntax file name, just appends a slash.
640 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
641 (file)
642 Lisp_Object file;
644 char *buf;
645 Lisp_Object handler;
647 CHECK_STRING (file);
648 if (NILP (file))
649 return Qnil;
651 /* If the file name has special constructs in it,
652 call the corresponding file handler. */
653 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
654 if (!NILP (handler))
655 return call2 (handler, Qfile_name_as_directory, file);
657 buf = (char *) alloca (SBYTES (file) + 10);
658 file_name_as_directory (buf, SDATA (file));
659 return make_specified_string (buf, -1, strlen (buf),
660 STRING_MULTIBYTE (file));
664 * Convert from directory name to filename.
665 * On VMS:
666 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
667 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
668 * On UNIX, it's simple: just make sure there isn't a terminating /
670 * Value is nonzero if the string output is different from the input.
674 directory_file_name (src, dst)
675 char *src, *dst;
677 long slen;
678 #ifdef VMS
679 long rlen;
680 char * ptr, * rptr;
681 char bracket;
682 struct FAB fab = cc$rms_fab;
683 struct NAM nam = cc$rms_nam;
684 char esa[NAM$C_MAXRSS];
685 #endif /* VMS */
687 slen = strlen (src);
688 #ifdef VMS
689 if (! index (src, '/')
690 && (src[slen - 1] == ']'
691 || src[slen - 1] == ':'
692 || src[slen - 1] == '>'))
694 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
695 fab.fab$l_fna = src;
696 fab.fab$b_fns = slen;
697 fab.fab$l_nam = &nam;
698 fab.fab$l_fop = FAB$M_NAM;
700 nam.nam$l_esa = esa;
701 nam.nam$b_ess = sizeof esa;
702 nam.nam$b_nop |= NAM$M_SYNCHK;
704 /* We call SYS$PARSE to handle such things as [--] for us. */
705 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
707 slen = nam.nam$b_esl;
708 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
709 slen -= 2;
710 esa[slen] = '\0';
711 src = esa;
713 if (src[slen - 1] != ']' && src[slen - 1] != '>')
715 /* what about when we have logical_name:???? */
716 if (src[slen - 1] == ':')
717 { /* Xlate logical name and see what we get */
718 ptr = strcpy (dst, src); /* upper case for getenv */
719 while (*ptr)
721 if ('a' <= *ptr && *ptr <= 'z')
722 *ptr -= 040;
723 ptr++;
725 dst[slen - 1] = 0; /* remove colon */
726 if (!(src = egetenv (dst)))
727 return 0;
728 /* should we jump to the beginning of this procedure?
729 Good points: allows us to use logical names that xlate
730 to Unix names,
731 Bad points: can be a problem if we just translated to a device
732 name...
733 For now, I'll punt and always expect VMS names, and hope for
734 the best! */
735 slen = strlen (src);
736 if (src[slen - 1] != ']' && src[slen - 1] != '>')
737 { /* no recursion here! */
738 strcpy (dst, src);
739 return 0;
742 else
743 { /* not a directory spec */
744 strcpy (dst, src);
745 return 0;
748 bracket = src[slen - 1];
750 /* If bracket is ']' or '>', bracket - 2 is the corresponding
751 opening bracket. */
752 ptr = index (src, bracket - 2);
753 if (ptr == 0)
754 { /* no opening bracket */
755 strcpy (dst, src);
756 return 0;
758 if (!(rptr = rindex (src, '.')))
759 rptr = ptr;
760 slen = rptr - src;
761 strncpy (dst, src, slen);
762 dst[slen] = '\0';
763 if (*rptr == '.')
765 dst[slen++] = bracket;
766 dst[slen] = '\0';
768 else
770 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
771 then translate the device and recurse. */
772 if (dst[slen - 1] == ':'
773 && dst[slen - 2] != ':' /* skip decnet nodes */
774 && strcmp (src + slen, "[000000]") == 0)
776 dst[slen - 1] = '\0';
777 if ((ptr = egetenv (dst))
778 && (rlen = strlen (ptr) - 1) > 0
779 && (ptr[rlen] == ']' || ptr[rlen] == '>')
780 && ptr[rlen - 1] == '.')
782 char * buf = (char *) alloca (strlen (ptr) + 1);
783 strcpy (buf, ptr);
784 buf[rlen - 1] = ']';
785 buf[rlen] = '\0';
786 return directory_file_name (buf, dst);
788 else
789 dst[slen - 1] = ':';
791 strcat (dst, "[000000]");
792 slen += 8;
794 rptr++;
795 rlen = strlen (rptr) - 1;
796 strncat (dst, rptr, rlen);
797 dst[slen + rlen] = '\0';
798 strcat (dst, ".DIR.1");
799 return 1;
801 #endif /* VMS */
802 /* Process as Unix format: just remove any final slash.
803 But leave "/" unchanged; do not change it to "". */
804 strcpy (dst, src);
805 if (slen > 1
806 && IS_DIRECTORY_SEP (dst[slen - 1])
807 #ifdef DOS_NT
808 && !IS_ANY_SEP (dst[slen - 2])
809 #endif
811 dst[slen - 1] = 0;
812 #ifdef DOS_NT
813 CORRECT_DIR_SEPS (dst);
814 #endif
815 return 1;
818 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
819 1, 1, 0,
820 doc: /* Returns the file name of the directory named DIRECTORY.
821 This is the name of the file that holds the data for the directory DIRECTORY.
822 This operation exists because a directory is also a file, but its name as
823 a directory is different from its name as a file.
824 In Unix-syntax, this function just removes the final slash.
825 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
826 it returns a file name such as \"[X]Y.DIR.1\". */)
827 (directory)
828 Lisp_Object directory;
830 char *buf;
831 Lisp_Object handler;
833 CHECK_STRING (directory);
835 if (NILP (directory))
836 return Qnil;
838 /* If the file name has special constructs in it,
839 call the corresponding file handler. */
840 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
841 if (!NILP (handler))
842 return call2 (handler, Qdirectory_file_name, directory);
844 #ifdef VMS
845 /* 20 extra chars is insufficient for VMS, since we might perform a
846 logical name translation. an equivalence string can be up to 255
847 chars long, so grab that much extra space... - sss */
848 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
849 #else
850 buf = (char *) alloca (SBYTES (directory) + 20);
851 #endif
852 directory_file_name (SDATA (directory), buf);
853 return make_specified_string (buf, -1, strlen (buf),
854 STRING_MULTIBYTE (directory));
857 static char make_temp_name_tbl[64] =
859 'A','B','C','D','E','F','G','H',
860 'I','J','K','L','M','N','O','P',
861 'Q','R','S','T','U','V','W','X',
862 'Y','Z','a','b','c','d','e','f',
863 'g','h','i','j','k','l','m','n',
864 'o','p','q','r','s','t','u','v',
865 'w','x','y','z','0','1','2','3',
866 '4','5','6','7','8','9','-','_'
869 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
871 /* Value is a temporary file name starting with PREFIX, a string.
873 The Emacs process number forms part of the result, so there is
874 no danger of generating a name being used by another process.
875 In addition, this function makes an attempt to choose a name
876 which has no existing file. To make this work, PREFIX should be
877 an absolute file name.
879 BASE64_P non-zero means add the pid as 3 characters in base64
880 encoding. In this case, 6 characters will be added to PREFIX to
881 form the file name. Otherwise, if Emacs is running on a system
882 with long file names, add the pid as a decimal number.
884 This function signals an error if no unique file name could be
885 generated. */
887 Lisp_Object
888 make_temp_name (prefix, base64_p)
889 Lisp_Object prefix;
890 int base64_p;
892 Lisp_Object val;
893 int len, clen;
894 int pid;
895 unsigned char *p, *data;
896 char pidbuf[20];
897 int pidlen;
899 CHECK_STRING (prefix);
901 /* VAL is created by adding 6 characters to PREFIX. The first
902 three are the PID of this process, in base 64, and the second
903 three are incremented if the file already exists. This ensures
904 262144 unique file names per PID per PREFIX. */
906 pid = (int) getpid ();
908 if (base64_p)
910 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
911 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
912 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
913 pidlen = 3;
915 else
917 #ifdef HAVE_LONG_FILE_NAMES
918 sprintf (pidbuf, "%d", pid);
919 pidlen = strlen (pidbuf);
920 #else
921 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
922 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
923 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
924 pidlen = 3;
925 #endif
928 len = SBYTES (prefix); clen = SCHARS (prefix);
929 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
930 if (!STRING_MULTIBYTE (prefix))
931 STRING_SET_UNIBYTE (val);
932 data = SDATA (val);
933 bcopy(SDATA (prefix), data, len);
934 p = data + len;
936 bcopy (pidbuf, p, pidlen);
937 p += pidlen;
939 /* Here we try to minimize useless stat'ing when this function is
940 invoked many times successively with the same PREFIX. We achieve
941 this by initializing count to a random value, and incrementing it
942 afterwards.
944 We don't want make-temp-name to be called while dumping,
945 because then make_temp_name_count_initialized_p would get set
946 and then make_temp_name_count would not be set when Emacs starts. */
948 if (!make_temp_name_count_initialized_p)
950 make_temp_name_count = (unsigned) time (NULL);
951 make_temp_name_count_initialized_p = 1;
954 while (1)
956 struct stat ignored;
957 unsigned num = make_temp_name_count;
959 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
960 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
961 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
963 /* Poor man's congruential RN generator. Replace with
964 ++make_temp_name_count for debugging. */
965 make_temp_name_count += 25229;
966 make_temp_name_count %= 225307;
968 if (stat (data, &ignored) < 0)
970 /* We want to return only if errno is ENOENT. */
971 if (errno == ENOENT)
972 return val;
973 else
974 /* The error here is dubious, but there is little else we
975 can do. The alternatives are to return nil, which is
976 as bad as (and in many cases worse than) throwing the
977 error, or to ignore the error, which will likely result
978 in looping through 225307 stat's, which is not only
979 dog-slow, but also useless since it will fallback to
980 the errow below, anyway. */
981 report_file_error ("Cannot create temporary name for prefix",
982 Fcons (prefix, Qnil));
983 /* not reached */
987 error ("Cannot create temporary name for prefix `%s'",
988 SDATA (prefix));
989 return Qnil;
993 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
994 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
995 The Emacs process number forms part of the result,
996 so there is no danger of generating a name being used by another process.
998 In addition, this function makes an attempt to choose a name
999 which has no existing file. To make this work,
1000 PREFIX should be an absolute file name.
1002 There is a race condition between calling `make-temp-name' and creating the
1003 file which opens all kinds of security holes. For that reason, you should
1004 probably use `make-temp-file' instead, except in three circumstances:
1006 * If you are creating the file in the user's home directory.
1007 * If you are creating a directory rather than an ordinary file.
1008 * If you are taking special precautions as `make-temp-file' does. */)
1009 (prefix)
1010 Lisp_Object prefix;
1012 return make_temp_name (prefix, 0);
1017 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1018 doc: /* Convert filename NAME to absolute, and canonicalize it.
1019 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1020 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
1021 the current buffer's value of `default-directory' is used.
1022 File name components that are `.' are removed, and
1023 so are file name components followed by `..', along with the `..' itself;
1024 note that these simplifications are done without checking the resulting
1025 file names in the file system.
1026 An initial `~/' expands to your home directory.
1027 An initial `~USER/' expands to USER's home directory.
1028 See also the function `substitute-in-file-name'. */)
1029 (name, default_directory)
1030 Lisp_Object name, default_directory;
1032 /* These point to SDATA and need to be careful with string-relocation
1033 during GC (via DECODE_FILE). */
1034 unsigned char *nm, *newdir;
1035 int nm_in_name;
1036 /* This should only point to alloca'd data. */
1037 unsigned char *target;
1039 int tlen;
1040 struct passwd *pw;
1041 #ifdef VMS
1042 unsigned char * colon = 0;
1043 unsigned char * close = 0;
1044 unsigned char * slash = 0;
1045 unsigned char * brack = 0;
1046 int lbrack = 0, rbrack = 0;
1047 int dots = 0;
1048 #endif /* VMS */
1049 #ifdef DOS_NT
1050 int drive = 0;
1051 int collapse_newdir = 1;
1052 int is_escaped = 0;
1053 #endif /* DOS_NT */
1054 int length;
1055 Lisp_Object handler, result;
1056 int multibyte;
1057 Lisp_Object hdir;
1059 CHECK_STRING (name);
1061 /* If the file name has special constructs in it,
1062 call the corresponding file handler. */
1063 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1064 if (!NILP (handler))
1065 return call3 (handler, Qexpand_file_name, name, default_directory);
1067 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1068 if (NILP (default_directory))
1069 default_directory = current_buffer->directory;
1070 if (! STRINGP (default_directory))
1072 #ifdef DOS_NT
1073 /* "/" is not considered a root directory on DOS_NT, so using "/"
1074 here causes an infinite recursion in, e.g., the following:
1076 (let (default-directory)
1077 (expand-file-name "a"))
1079 To avoid this, we set default_directory to the root of the
1080 current drive. */
1081 extern char *emacs_root_dir (void);
1083 default_directory = build_string (emacs_root_dir ());
1084 #else
1085 default_directory = build_string ("/");
1086 #endif
1089 if (!NILP (default_directory))
1091 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1092 if (!NILP (handler))
1093 return call3 (handler, Qexpand_file_name, name, default_directory);
1097 unsigned char *o = SDATA (default_directory);
1099 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1100 It would be better to do this down below where we actually use
1101 default_directory. Unfortunately, calling Fexpand_file_name recursively
1102 could invoke GC, and the strings might be relocated. This would
1103 be annoying because we have pointers into strings lying around
1104 that would need adjusting, and people would add new pointers to
1105 the code and forget to adjust them, resulting in intermittent bugs.
1106 Putting this call here avoids all that crud.
1108 The EQ test avoids infinite recursion. */
1109 if (! NILP (default_directory) && !EQ (default_directory, name)
1110 /* Save time in some common cases - as long as default_directory
1111 is not relative, it can be canonicalized with name below (if it
1112 is needed at all) without requiring it to be expanded now. */
1113 #ifdef DOS_NT
1114 /* Detect MSDOS file names with drive specifiers. */
1115 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
1116 && IS_DIRECTORY_SEP (o[2]))
1117 #ifdef WINDOWSNT
1118 /* Detect Windows file names in UNC format. */
1119 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1120 #endif
1121 #else /* not DOS_NT */
1122 /* Detect Unix absolute file names (/... alone is not absolute on
1123 DOS or Windows). */
1124 && ! (IS_DIRECTORY_SEP (o[0]))
1125 #endif /* not DOS_NT */
1128 struct gcpro gcpro1;
1130 GCPRO1 (name);
1131 default_directory = Fexpand_file_name (default_directory, Qnil);
1132 UNGCPRO;
1135 name = FILE_SYSTEM_CASE (name);
1136 multibyte = STRING_MULTIBYTE (name);
1137 if (multibyte != STRING_MULTIBYTE (default_directory))
1139 if (multibyte)
1140 default_directory = string_to_multibyte (default_directory);
1141 else
1143 name = string_to_multibyte (name);
1144 multibyte = 1;
1148 nm = SDATA (name);
1149 nm_in_name = 1;
1151 #ifdef DOS_NT
1152 /* We will force directory separators to be either all \ or /, so make
1153 a local copy to modify, even if there ends up being no change. */
1154 nm = strcpy (alloca (strlen (nm) + 1), nm);
1155 nm_in_name = 0;
1157 /* Note if special escape prefix is present, but remove for now. */
1158 if (nm[0] == '/' && nm[1] == ':')
1160 is_escaped = 1;
1161 nm += 2;
1164 /* Find and remove drive specifier if present; this makes nm absolute
1165 even if the rest of the name appears to be relative. Only look for
1166 drive specifier at the beginning. */
1167 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1169 drive = nm[0];
1170 nm += 2;
1173 #ifdef WINDOWSNT
1174 /* If we see "c://somedir", we want to strip the first slash after the
1175 colon when stripping the drive letter. Otherwise, this expands to
1176 "//somedir". */
1177 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1178 nm++;
1180 /* Discard any previous drive specifier if nm is now in UNC format. */
1181 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1183 drive = 0;
1185 #endif /* WINDOWSNT */
1186 #endif /* DOS_NT */
1188 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1189 none are found, we can probably return right away. We will avoid
1190 allocating a new string if name is already fully expanded. */
1191 if (
1192 IS_DIRECTORY_SEP (nm[0])
1193 #ifdef MSDOS
1194 && drive && !is_escaped
1195 #endif
1196 #ifdef WINDOWSNT
1197 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1198 #endif
1199 #ifdef VMS
1200 || index (nm, ':')
1201 #endif /* VMS */
1204 /* If it turns out that the filename we want to return is just a
1205 suffix of FILENAME, we don't need to go through and edit
1206 things; we just need to construct a new string using data
1207 starting at the middle of FILENAME. If we set lose to a
1208 non-zero value, that means we've discovered that we can't do
1209 that cool trick. */
1210 int lose = 0;
1211 unsigned char *p = nm;
1213 while (*p)
1215 /* Since we know the name is absolute, we can assume that each
1216 element starts with a "/". */
1218 /* "." and ".." are hairy. */
1219 if (IS_DIRECTORY_SEP (p[0])
1220 && p[1] == '.'
1221 && (IS_DIRECTORY_SEP (p[2])
1222 || p[2] == 0
1223 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1224 || p[3] == 0))))
1225 lose = 1;
1226 /* We want to replace multiple `/' in a row with a single
1227 slash. */
1228 else if (p > nm
1229 && IS_DIRECTORY_SEP (p[0])
1230 && IS_DIRECTORY_SEP (p[1]))
1231 lose = 1;
1233 #ifdef VMS
1234 if (p[0] == '\\')
1235 lose = 1;
1236 if (p[0] == '/') {
1237 /* if dev:[dir]/, move nm to / */
1238 if (!slash && p > nm && (brack || colon)) {
1239 nm = (brack ? brack + 1 : colon + 1);
1240 lbrack = rbrack = 0;
1241 brack = 0;
1242 colon = 0;
1244 slash = p;
1246 if (p[0] == '-')
1247 #ifdef NO_HYPHENS_IN_FILENAMES
1248 if (lbrack == rbrack)
1250 /* Avoid clobbering negative version numbers. */
1251 if (dots < 2)
1252 p[0] = '_';
1254 else
1255 #endif /* NO_HYPHENS_IN_FILENAMES */
1256 if (lbrack > rbrack
1257 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1258 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1259 lose = 1;
1260 #ifdef NO_HYPHENS_IN_FILENAMES
1261 else
1262 p[0] = '_';
1263 #endif /* NO_HYPHENS_IN_FILENAMES */
1264 /* count open brackets, reset close bracket pointer */
1265 if (p[0] == '[' || p[0] == '<')
1266 lbrack++, brack = 0;
1267 /* count close brackets, set close bracket pointer */
1268 if (p[0] == ']' || p[0] == '>')
1269 rbrack++, brack = p;
1270 /* detect ][ or >< */
1271 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1272 lose = 1;
1273 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1274 nm = p + 1, lose = 1;
1275 if (p[0] == ':' && (colon || slash))
1276 /* if dev1:[dir]dev2:, move nm to dev2: */
1277 if (brack)
1279 nm = brack + 1;
1280 brack = 0;
1282 /* if /name/dev:, move nm to dev: */
1283 else if (slash)
1284 nm = slash + 1;
1285 /* if node::dev:, move colon following dev */
1286 else if (colon && colon[-1] == ':')
1287 colon = p;
1288 /* if dev1:dev2:, move nm to dev2: */
1289 else if (colon && colon[-1] != ':')
1291 nm = colon + 1;
1292 colon = 0;
1294 if (p[0] == ':' && !colon)
1296 if (p[1] == ':')
1297 p++;
1298 colon = p;
1300 if (lbrack == rbrack)
1301 if (p[0] == ';')
1302 dots = 2;
1303 else if (p[0] == '.')
1304 dots++;
1305 #endif /* VMS */
1306 p++;
1308 if (!lose)
1310 #ifdef VMS
1311 if (index (nm, '/'))
1313 nm = sys_translate_unix (nm);
1314 nm_in_name = 0;
1315 return make_specified_string (nm, -1, strlen (nm), multibyte);
1317 #endif /* VMS */
1318 #ifdef DOS_NT
1319 /* Make sure directories are all separated with / or \ as
1320 desired, but avoid allocation of a new string when not
1321 required. */
1322 CORRECT_DIR_SEPS (nm);
1323 #ifdef WINDOWSNT
1324 if (IS_DIRECTORY_SEP (nm[1]))
1326 if (strcmp (nm, SDATA (name)) != 0)
1327 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1329 else
1330 #endif
1331 /* drive must be set, so this is okay */
1332 if (strcmp (nm - 2, SDATA (name)) != 0)
1334 char temp[] = " :";
1336 name = make_specified_string (nm, -1, p - nm, multibyte);
1337 temp[0] = DRIVE_LETTER (drive);
1338 name = concat2 (build_string (temp), name);
1340 return name;
1341 #else /* not DOS_NT */
1342 if (nm == SDATA (name))
1343 return name;
1344 return make_specified_string (nm, -1, strlen (nm), multibyte);
1345 #endif /* not DOS_NT */
1349 /* At this point, nm might or might not be an absolute file name. We
1350 need to expand ~ or ~user if present, otherwise prefix nm with
1351 default_directory if nm is not absolute, and finally collapse /./
1352 and /foo/../ sequences.
1354 We set newdir to be the appropriate prefix if one is needed:
1355 - the relevant user directory if nm starts with ~ or ~user
1356 - the specified drive's working dir (DOS/NT only) if nm does not
1357 start with /
1358 - the value of default_directory.
1360 Note that these prefixes are not guaranteed to be absolute (except
1361 for the working dir of a drive). Therefore, to ensure we always
1362 return an absolute name, if the final prefix is not absolute we
1363 append it to the current working directory. */
1365 newdir = 0;
1367 if (nm[0] == '~') /* prefix ~ */
1369 if (IS_DIRECTORY_SEP (nm[1])
1370 #ifdef VMS
1371 || nm[1] == ':'
1372 #endif /* VMS */
1373 || nm[1] == 0) /* ~ by itself */
1375 Lisp_Object tem;
1377 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1378 newdir = (unsigned char *) "";
1379 nm++;
1380 /* egetenv may return a unibyte string, which will bite us since
1381 we expect the directory to be multibyte. */
1382 tem = build_string (newdir);
1383 if (!STRING_MULTIBYTE (tem))
1385 /* FIXME: DECODE_FILE may GC, which may move SDATA(name),
1386 after which `nm' won't point to the right place any more. */
1387 int offset = nm - SDATA (name);
1388 hdir = DECODE_FILE (tem);
1389 newdir = SDATA (hdir);
1390 if (nm_in_name)
1391 nm = SDATA (name) + offset;
1393 #ifdef DOS_NT
1394 collapse_newdir = 0;
1395 #endif
1396 #ifdef VMS
1397 nm++; /* Don't leave the slash in nm. */
1398 #endif /* VMS */
1400 else /* ~user/filename */
1402 unsigned char *o, *p;
1403 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1404 #ifdef VMS
1405 && *p != ':'
1406 #endif /* VMS */
1407 ); p++);
1408 o = alloca (p - nm + 1);
1409 bcopy ((char *) nm, o, p - nm);
1410 o [p - nm] = 0;
1412 BLOCK_INPUT;
1413 pw = (struct passwd *) getpwnam (o + 1);
1414 UNBLOCK_INPUT;
1415 if (pw)
1417 newdir = (unsigned char *) pw -> pw_dir;
1418 #ifdef VMS
1419 nm = p + 1; /* skip the terminator */
1420 #else
1421 nm = p;
1422 #ifdef DOS_NT
1423 collapse_newdir = 0;
1424 #endif
1425 #endif /* VMS */
1428 /* If we don't find a user of that name, leave the name
1429 unchanged; don't move nm forward to p. */
1433 #ifdef DOS_NT
1434 /* On DOS and Windows, nm is absolute if a drive name was specified;
1435 use the drive's current directory as the prefix if needed. */
1436 if (!newdir && drive)
1438 /* Get default directory if needed to make nm absolute. */
1439 if (!IS_DIRECTORY_SEP (nm[0]))
1441 newdir = alloca (MAXPATHLEN + 1);
1442 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1443 newdir = NULL;
1445 if (!newdir)
1447 /* Either nm starts with /, or drive isn't mounted. */
1448 newdir = alloca (4);
1449 newdir[0] = DRIVE_LETTER (drive);
1450 newdir[1] = ':';
1451 newdir[2] = '/';
1452 newdir[3] = 0;
1455 #endif /* DOS_NT */
1457 /* Finally, if no prefix has been specified and nm is not absolute,
1458 then it must be expanded relative to default_directory. */
1460 if (1
1461 #ifndef DOS_NT
1462 /* /... alone is not absolute on DOS and Windows. */
1463 && !IS_DIRECTORY_SEP (nm[0])
1464 #endif
1465 #ifdef WINDOWSNT
1466 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1467 #endif
1468 #ifdef VMS
1469 && !index (nm, ':')
1470 #endif
1471 && !newdir)
1473 newdir = SDATA (default_directory);
1474 #ifdef DOS_NT
1475 /* Note if special escape prefix is present, but remove for now. */
1476 if (newdir[0] == '/' && newdir[1] == ':')
1478 is_escaped = 1;
1479 newdir += 2;
1481 #endif
1484 #ifdef DOS_NT
1485 if (newdir)
1487 /* First ensure newdir is an absolute name. */
1488 if (
1489 /* Detect MSDOS file names with drive specifiers. */
1490 ! (IS_DRIVE (newdir[0])
1491 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1492 #ifdef WINDOWSNT
1493 /* Detect Windows file names in UNC format. */
1494 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1495 #endif
1498 /* Effectively, let newdir be (expand-file-name newdir cwd).
1499 Because of the admonition against calling expand-file-name
1500 when we have pointers into lisp strings, we accomplish this
1501 indirectly by prepending newdir to nm if necessary, and using
1502 cwd (or the wd of newdir's drive) as the new newdir. */
1504 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1506 drive = newdir[0];
1507 newdir += 2;
1509 if (!IS_DIRECTORY_SEP (nm[0]))
1511 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1512 file_name_as_directory (tmp, newdir);
1513 strcat (tmp, nm);
1514 nm = tmp;
1516 newdir = alloca (MAXPATHLEN + 1);
1517 if (drive)
1519 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1520 newdir = "/";
1522 else
1523 getwd (newdir);
1526 /* Strip off drive name from prefix, if present. */
1527 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1529 drive = newdir[0];
1530 newdir += 2;
1533 /* Keep only a prefix from newdir if nm starts with slash
1534 (//server/share for UNC, nothing otherwise). */
1535 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1537 #ifdef WINDOWSNT
1538 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1540 unsigned char *p;
1541 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1542 p = newdir + 2;
1543 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1544 p++;
1545 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1546 *p = 0;
1548 else
1549 #endif
1550 newdir = "";
1553 #endif /* DOS_NT */
1555 if (newdir)
1557 /* Get rid of any slash at the end of newdir, unless newdir is
1558 just / or // (an incomplete UNC name). */
1559 length = strlen (newdir);
1560 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1561 #ifdef WINDOWSNT
1562 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1563 #endif
1566 unsigned char *temp = (unsigned char *) alloca (length);
1567 bcopy (newdir, temp, length - 1);
1568 temp[length - 1] = 0;
1569 newdir = temp;
1571 tlen = length + 1;
1573 else
1574 tlen = 0;
1576 /* Now concatenate the directory and name to new space in the stack frame */
1577 tlen += strlen (nm) + 1;
1578 #ifdef DOS_NT
1579 /* Reserve space for drive specifier and escape prefix, since either
1580 or both may need to be inserted. (The Microsoft x86 compiler
1581 produces incorrect code if the following two lines are combined.) */
1582 target = (unsigned char *) alloca (tlen + 4);
1583 target += 4;
1584 #else /* not DOS_NT */
1585 target = (unsigned char *) alloca (tlen);
1586 #endif /* not DOS_NT */
1587 *target = 0;
1589 if (newdir)
1591 #ifndef VMS
1592 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1594 #ifdef DOS_NT
1595 /* If newdir is effectively "C:/", then the drive letter will have
1596 been stripped and newdir will be "/". Concatenating with an
1597 absolute directory in nm produces "//", which will then be
1598 incorrectly treated as a network share. Ignore newdir in
1599 this case (keeping the drive letter). */
1600 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1601 && newdir[1] == '\0'))
1602 #endif
1603 strcpy (target, newdir);
1605 else
1606 #endif
1607 file_name_as_directory (target, newdir);
1610 strcat (target, nm);
1611 #ifdef VMS
1612 if (index (target, '/'))
1613 strcpy (target, sys_translate_unix (target));
1614 #endif /* VMS */
1616 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1618 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1619 appear. */
1622 unsigned char *p = target;
1623 unsigned char *o = target;
1625 while (*p)
1627 #ifdef VMS
1628 if (*p != ']' && *p != '>' && *p != '-')
1630 if (*p == '\\')
1631 p++;
1632 *o++ = *p++;
1634 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1635 /* brackets are offset from each other by 2 */
1637 p += 2;
1638 if (*p != '.' && *p != '-' && o[-1] != '.')
1639 /* convert [foo][bar] to [bar] */
1640 while (o[-1] != '[' && o[-1] != '<')
1641 o--;
1642 else if (*p == '-' && *o != '.')
1643 *--p = '.';
1645 else if (p[0] == '-' && o[-1] == '.'
1646 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1647 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1650 o--;
1651 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1652 if (p[1] == '.') /* foo.-.bar ==> bar. */
1653 p += 2;
1654 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1655 p++, o--;
1656 /* else [foo.-] ==> [-] */
1658 else
1660 #ifdef NO_HYPHENS_IN_FILENAMES
1661 if (*p == '-'
1662 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
1663 && p[1] != ']' && p[1] != '>' && p[1] != '.')
1664 *p = '_';
1665 #endif /* NO_HYPHENS_IN_FILENAMES */
1666 *o++ = *p++;
1668 #else /* not VMS */
1669 if (!IS_DIRECTORY_SEP (*p))
1671 *o++ = *p++;
1673 else if (p[1] == '.'
1674 && (IS_DIRECTORY_SEP (p[2])
1675 || p[2] == 0))
1677 /* If "/." is the entire filename, keep the "/". Otherwise,
1678 just delete the whole "/.". */
1679 if (o == target && p[2] == '\0')
1680 *o++ = *p;
1681 p += 2;
1683 else if (p[1] == '.' && p[2] == '.'
1684 /* `/../' is the "superroot" on certain file systems.
1685 Turned off on DOS_NT systems because they have no
1686 "superroot" and because this causes us to produce
1687 file names like "d:/../foo" which fail file-related
1688 functions of the underlying OS. (To reproduce, try a
1689 long series of "../../" in default_directory, longer
1690 than the number of levels from the root.) */
1691 #ifndef DOS_NT
1692 && o != target
1693 #endif
1694 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1696 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1698 /* Keep initial / only if this is the whole name. */
1699 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1700 ++o;
1701 p += 3;
1703 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1704 /* Collapse multiple `/' in a row. */
1705 p++;
1706 else
1708 *o++ = *p++;
1710 #endif /* not VMS */
1713 #ifdef DOS_NT
1714 /* At last, set drive name. */
1715 #ifdef WINDOWSNT
1716 /* Except for network file name. */
1717 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1718 #endif /* WINDOWSNT */
1720 if (!drive) abort ();
1721 target -= 2;
1722 target[0] = DRIVE_LETTER (drive);
1723 target[1] = ':';
1725 /* Reinsert the escape prefix if required. */
1726 if (is_escaped)
1728 target -= 2;
1729 target[0] = '/';
1730 target[1] = ':';
1732 CORRECT_DIR_SEPS (target);
1733 #endif /* DOS_NT */
1735 result = make_specified_string (target, -1, o - target, multibyte);
1738 /* Again look to see if the file name has special constructs in it
1739 and perhaps call the corresponding file handler. This is needed
1740 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1741 the ".." component gives us "/user@host:/bar/../baz" which needs
1742 to be expanded again. */
1743 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1744 if (!NILP (handler))
1745 return call3 (handler, Qexpand_file_name, result, default_directory);
1747 return result;
1750 #if 0
1751 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1752 This is the old version of expand-file-name, before it was thoroughly
1753 rewritten for Emacs 10.31. We leave this version here commented-out,
1754 because the code is very complex and likely to have subtle bugs. If
1755 bugs _are_ found, it might be of interest to look at the old code and
1756 see what did it do in the relevant situation.
1758 Don't remove this code: it's true that it will be accessible via CVS,
1759 but a few years from deletion, people will forget it is there. */
1761 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1762 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1763 "Convert FILENAME to absolute, and canonicalize it.\n\
1764 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1765 \(does not start with slash); if DEFAULT is nil or missing,\n\
1766 the current buffer's value of default-directory is used.\n\
1767 Filenames containing `.' or `..' as components are simplified;\n\
1768 initial `~/' expands to your home directory.\n\
1769 See also the function `substitute-in-file-name'.")
1770 (name, defalt)
1771 Lisp_Object name, defalt;
1773 unsigned char *nm;
1775 register unsigned char *newdir, *p, *o;
1776 int tlen;
1777 unsigned char *target;
1778 struct passwd *pw;
1779 int lose;
1780 #ifdef VMS
1781 unsigned char * colon = 0;
1782 unsigned char * close = 0;
1783 unsigned char * slash = 0;
1784 unsigned char * brack = 0;
1785 int lbrack = 0, rbrack = 0;
1786 int dots = 0;
1787 #endif /* VMS */
1789 CHECK_STRING (name);
1791 #ifdef VMS
1792 /* Filenames on VMS are always upper case. */
1793 name = Fupcase (name);
1794 #endif
1796 nm = SDATA (name);
1798 /* If nm is absolute, flush ...// and detect /./ and /../.
1799 If no /./ or /../ we can return right away. */
1800 if (
1801 nm[0] == '/'
1802 #ifdef VMS
1803 || index (nm, ':')
1804 #endif /* VMS */
1807 p = nm;
1808 lose = 0;
1809 while (*p)
1811 if (p[0] == '/' && p[1] == '/'
1813 nm = p + 1;
1814 if (p[0] == '/' && p[1] == '~')
1815 nm = p + 1, lose = 1;
1816 if (p[0] == '/' && p[1] == '.'
1817 && (p[2] == '/' || p[2] == 0
1818 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1819 lose = 1;
1820 #ifdef VMS
1821 if (p[0] == '\\')
1822 lose = 1;
1823 if (p[0] == '/') {
1824 /* if dev:[dir]/, move nm to / */
1825 if (!slash && p > nm && (brack || colon)) {
1826 nm = (brack ? brack + 1 : colon + 1);
1827 lbrack = rbrack = 0;
1828 brack = 0;
1829 colon = 0;
1831 slash = p;
1833 if (p[0] == '-')
1834 #ifndef VMS4_4
1835 /* VMS pre V4.4,convert '-'s in filenames. */
1836 if (lbrack == rbrack)
1838 if (dots < 2) /* this is to allow negative version numbers */
1839 p[0] = '_';
1841 else
1842 #endif /* VMS4_4 */
1843 if (lbrack > rbrack
1844 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1845 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1846 lose = 1;
1847 #ifndef VMS4_4
1848 else
1849 p[0] = '_';
1850 #endif /* VMS4_4 */
1851 /* count open brackets, reset close bracket pointer */
1852 if (p[0] == '[' || p[0] == '<')
1853 lbrack++, brack = 0;
1854 /* count close brackets, set close bracket pointer */
1855 if (p[0] == ']' || p[0] == '>')
1856 rbrack++, brack = p;
1857 /* detect ][ or >< */
1858 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1859 lose = 1;
1860 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1861 nm = p + 1, lose = 1;
1862 if (p[0] == ':' && (colon || slash))
1863 /* if dev1:[dir]dev2:, move nm to dev2: */
1864 if (brack)
1866 nm = brack + 1;
1867 brack = 0;
1869 /* If /name/dev:, move nm to dev: */
1870 else if (slash)
1871 nm = slash + 1;
1872 /* If node::dev:, move colon following dev */
1873 else if (colon && colon[-1] == ':')
1874 colon = p;
1875 /* If dev1:dev2:, move nm to dev2: */
1876 else if (colon && colon[-1] != ':')
1878 nm = colon + 1;
1879 colon = 0;
1881 if (p[0] == ':' && !colon)
1883 if (p[1] == ':')
1884 p++;
1885 colon = p;
1887 if (lbrack == rbrack)
1888 if (p[0] == ';')
1889 dots = 2;
1890 else if (p[0] == '.')
1891 dots++;
1892 #endif /* VMS */
1893 p++;
1895 if (!lose)
1897 #ifdef VMS
1898 if (index (nm, '/'))
1899 return build_string (sys_translate_unix (nm));
1900 #endif /* VMS */
1901 if (nm == SDATA (name))
1902 return name;
1903 return build_string (nm);
1907 /* Now determine directory to start with and put it in NEWDIR */
1909 newdir = 0;
1911 if (nm[0] == '~') /* prefix ~ */
1912 if (nm[1] == '/'
1913 #ifdef VMS
1914 || nm[1] == ':'
1915 #endif /* VMS */
1916 || nm[1] == 0)/* ~/filename */
1918 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1919 newdir = (unsigned char *) "";
1920 nm++;
1921 #ifdef VMS
1922 nm++; /* Don't leave the slash in nm. */
1923 #endif /* VMS */
1925 else /* ~user/filename */
1927 /* Get past ~ to user */
1928 unsigned char *user = nm + 1;
1929 /* Find end of name. */
1930 unsigned char *ptr = (unsigned char *) index (user, '/');
1931 int len = ptr ? ptr - user : strlen (user);
1932 #ifdef VMS
1933 unsigned char *ptr1 = index (user, ':');
1934 if (ptr1 != 0 && ptr1 - user < len)
1935 len = ptr1 - user;
1936 #endif /* VMS */
1937 /* Copy the user name into temp storage. */
1938 o = (unsigned char *) alloca (len + 1);
1939 bcopy ((char *) user, o, len);
1940 o[len] = 0;
1942 /* Look up the user name. */
1943 BLOCK_INPUT;
1944 pw = (struct passwd *) getpwnam (o + 1);
1945 UNBLOCK_INPUT;
1946 if (!pw)
1947 error ("\"%s\" isn't a registered user", o + 1);
1949 newdir = (unsigned char *) pw->pw_dir;
1951 /* Discard the user name from NM. */
1952 nm += len;
1955 if (nm[0] != '/'
1956 #ifdef VMS
1957 && !index (nm, ':')
1958 #endif /* not VMS */
1959 && !newdir)
1961 if (NILP (defalt))
1962 defalt = current_buffer->directory;
1963 CHECK_STRING (defalt);
1964 newdir = SDATA (defalt);
1967 /* Now concatenate the directory and name to new space in the stack frame */
1969 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1970 target = (unsigned char *) alloca (tlen);
1971 *target = 0;
1973 if (newdir)
1975 #ifndef VMS
1976 if (nm[0] == 0 || nm[0] == '/')
1977 strcpy (target, newdir);
1978 else
1979 #endif
1980 file_name_as_directory (target, newdir);
1983 strcat (target, nm);
1984 #ifdef VMS
1985 if (index (target, '/'))
1986 strcpy (target, sys_translate_unix (target));
1987 #endif /* VMS */
1989 /* Now canonicalize by removing /. and /foo/.. if they appear */
1991 p = target;
1992 o = target;
1994 while (*p)
1996 #ifdef VMS
1997 if (*p != ']' && *p != '>' && *p != '-')
1999 if (*p == '\\')
2000 p++;
2001 *o++ = *p++;
2003 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
2004 /* brackets are offset from each other by 2 */
2006 p += 2;
2007 if (*p != '.' && *p != '-' && o[-1] != '.')
2008 /* convert [foo][bar] to [bar] */
2009 while (o[-1] != '[' && o[-1] != '<')
2010 o--;
2011 else if (*p == '-' && *o != '.')
2012 *--p = '.';
2014 else if (p[0] == '-' && o[-1] == '.'
2015 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
2016 /* flush .foo.- ; leave - if stopped by '[' or '<' */
2019 o--;
2020 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
2021 if (p[1] == '.') /* foo.-.bar ==> bar. */
2022 p += 2;
2023 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2024 p++, o--;
2025 /* else [foo.-] ==> [-] */
2027 else
2029 #ifndef VMS4_4
2030 if (*p == '-'
2031 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
2032 && p[1] != ']' && p[1] != '>' && p[1] != '.')
2033 *p = '_';
2034 #endif /* VMS4_4 */
2035 *o++ = *p++;
2037 #else /* not VMS */
2038 if (*p != '/')
2040 *o++ = *p++;
2042 else if (!strncmp (p, "//", 2)
2045 o = target;
2046 p++;
2048 else if (p[0] == '/' && p[1] == '.'
2049 && (p[2] == '/' || p[2] == 0))
2050 p += 2;
2051 else if (!strncmp (p, "/..", 3)
2052 /* `/../' is the "superroot" on certain file systems. */
2053 && o != target
2054 && (p[3] == '/' || p[3] == 0))
2056 while (o != target && *--o != '/')
2058 if (o == target && *o == '/')
2059 ++o;
2060 p += 3;
2062 else
2064 *o++ = *p++;
2066 #endif /* not VMS */
2069 return make_string (target, o - target);
2071 #endif
2073 /* If /~ or // appears, discard everything through first slash. */
2074 static int
2075 file_name_absolute_p (filename)
2076 const unsigned char *filename;
2078 return
2079 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2080 #ifdef VMS
2081 /* ??? This criterion is probably wrong for '<'. */
2082 || index (filename, ':') || index (filename, '<')
2083 || (*filename == '[' && (filename[1] != '-'
2084 || (filename[2] != '.' && filename[2] != ']'))
2085 && filename[1] != '.')
2086 #endif /* VMS */
2087 #ifdef DOS_NT
2088 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2089 && IS_DIRECTORY_SEP (filename[2]))
2090 #endif
2094 static unsigned char *
2095 search_embedded_absfilename (nm, endp)
2096 unsigned char *nm, *endp;
2098 unsigned char *p, *s;
2100 for (p = nm + 1; p < endp; p++)
2102 if ((0
2103 #ifdef VMS
2104 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2105 #endif /* VMS */
2106 || IS_DIRECTORY_SEP (p[-1]))
2107 && file_name_absolute_p (p)
2108 #if defined (WINDOWSNT) || defined(CYGWIN)
2109 /* // at start of file name is meaningful in Apollo,
2110 WindowsNT and Cygwin systems. */
2111 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2112 #endif /* not (WINDOWSNT || CYGWIN) */
2115 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2116 #ifdef VMS
2117 && *s != ':'
2118 #endif /* VMS */
2119 ); s++);
2120 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2122 unsigned char *o = alloca (s - p + 1);
2123 struct passwd *pw;
2124 bcopy (p, o, s - p);
2125 o [s - p] = 0;
2127 /* If we have ~user and `user' exists, discard
2128 everything up to ~. But if `user' does not exist, leave
2129 ~user alone, it might be a literal file name. */
2130 BLOCK_INPUT;
2131 pw = getpwnam (o + 1);
2132 UNBLOCK_INPUT;
2133 if (pw)
2134 return p;
2136 else
2137 return p;
2140 return NULL;
2143 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2144 Ssubstitute_in_file_name, 1, 1, 0,
2145 doc: /* Substitute environment variables referred to in FILENAME.
2146 `$FOO' where FOO is an environment variable name means to substitute
2147 the value of that variable. The variable name should be terminated
2148 with a character not a letter, digit or underscore; otherwise, enclose
2149 the entire variable name in braces.
2150 If `/~' appears, all of FILENAME through that `/' is discarded.
2152 On VMS, `$' substitution is not done; this function does little and only
2153 duplicates what `expand-file-name' does. */)
2154 (filename)
2155 Lisp_Object filename;
2157 unsigned char *nm;
2159 register unsigned char *s, *p, *o, *x, *endp;
2160 unsigned char *target = NULL;
2161 int total = 0;
2162 int substituted = 0;
2163 unsigned char *xnm;
2164 Lisp_Object handler;
2166 CHECK_STRING (filename);
2168 /* If the file name has special constructs in it,
2169 call the corresponding file handler. */
2170 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2171 if (!NILP (handler))
2172 return call2 (handler, Qsubstitute_in_file_name, filename);
2174 nm = SDATA (filename);
2175 #ifdef DOS_NT
2176 nm = strcpy (alloca (strlen (nm) + 1), nm);
2177 CORRECT_DIR_SEPS (nm);
2178 substituted = (strcmp (nm, SDATA (filename)) != 0);
2179 #endif
2180 endp = nm + SBYTES (filename);
2182 /* If /~ or // appears, discard everything through first slash. */
2183 p = search_embedded_absfilename (nm, endp);
2184 if (p)
2185 /* Start over with the new string, so we check the file-name-handler
2186 again. Important with filenames like "/home/foo//:/hello///there"
2187 which whould substitute to "/:/hello///there" rather than "/there". */
2188 return Fsubstitute_in_file_name
2189 (make_specified_string (p, -1, endp - p,
2190 STRING_MULTIBYTE (filename)));
2192 #ifdef VMS
2193 return filename;
2194 #else
2196 /* See if any variables are substituted into the string
2197 and find the total length of their values in `total' */
2199 for (p = nm; p != endp;)
2200 if (*p != '$')
2201 p++;
2202 else
2204 p++;
2205 if (p == endp)
2206 goto badsubst;
2207 else if (*p == '$')
2209 /* "$$" means a single "$" */
2210 p++;
2211 total -= 1;
2212 substituted = 1;
2213 continue;
2215 else if (*p == '{')
2217 o = ++p;
2218 while (p != endp && *p != '}') p++;
2219 if (*p != '}') goto missingclose;
2220 s = p;
2222 else
2224 o = p;
2225 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2226 s = p;
2229 /* Copy out the variable name */
2230 target = (unsigned char *) alloca (s - o + 1);
2231 strncpy (target, o, s - o);
2232 target[s - o] = 0;
2233 #ifdef DOS_NT
2234 strupr (target); /* $home == $HOME etc. */
2235 #endif /* DOS_NT */
2237 /* Get variable value */
2238 o = (unsigned char *) egetenv (target);
2239 if (o)
2240 { /* Eight-bit chars occupy upto 2 bytes in multibyte. */
2241 total += strlen (o) * (STRING_MULTIBYTE (filename) ? 2 : 1);
2242 substituted = 1;
2244 else if (*p == '}')
2245 goto badvar;
2248 if (!substituted)
2249 return filename;
2251 /* If substitution required, recopy the string and do it */
2252 /* Make space in stack frame for the new copy */
2253 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2254 x = xnm;
2256 /* Copy the rest of the name through, replacing $ constructs with values */
2257 for (p = nm; *p;)
2258 if (*p != '$')
2259 *x++ = *p++;
2260 else
2262 p++;
2263 if (p == endp)
2264 goto badsubst;
2265 else if (*p == '$')
2267 *x++ = *p++;
2268 continue;
2270 else if (*p == '{')
2272 o = ++p;
2273 while (p != endp && *p != '}') p++;
2274 if (*p != '}') goto missingclose;
2275 s = p++;
2277 else
2279 o = p;
2280 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2281 s = p;
2284 /* Copy out the variable name */
2285 target = (unsigned char *) alloca (s - o + 1);
2286 strncpy (target, o, s - o);
2287 target[s - o] = 0;
2288 #ifdef DOS_NT
2289 strupr (target); /* $home == $HOME etc. */
2290 #endif /* DOS_NT */
2292 /* Get variable value */
2293 o = (unsigned char *) egetenv (target);
2294 if (!o)
2296 *x++ = '$';
2297 strcpy (x, target); x+= strlen (target);
2299 else if (STRING_MULTIBYTE (filename))
2301 /* If the original string is multibyte,
2302 convert what we substitute into multibyte. */
2303 while (*o)
2305 int c = *o++;
2306 c = unibyte_char_to_multibyte (c);
2307 x += CHAR_STRING (c, x);
2310 else
2312 strcpy (x, o);
2313 x += strlen (o);
2317 *x = 0;
2319 /* If /~ or // appears, discard everything through first slash. */
2320 while ((p = search_embedded_absfilename (xnm, x)))
2321 /* This time we do not start over because we've already expanded envvars
2322 and replaced $$ with $. Maybe we should start over as well, but we'd
2323 need to quote some $ to $$ first. */
2324 xnm = p;
2326 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2328 badsubst:
2329 error ("Bad format environment-variable substitution");
2330 missingclose:
2331 error ("Missing \"}\" in environment-variable substitution");
2332 badvar:
2333 error ("Substituting nonexistent environment variable \"%s\"", target);
2335 /* NOTREACHED */
2336 #endif /* not VMS */
2337 return Qnil;
2340 /* A slightly faster and more convenient way to get
2341 (directory-file-name (expand-file-name FOO)). */
2343 Lisp_Object
2344 expand_and_dir_to_file (filename, defdir)
2345 Lisp_Object filename, defdir;
2347 register Lisp_Object absname;
2349 absname = Fexpand_file_name (filename, defdir);
2350 #ifdef VMS
2352 register int c = SREF (absname, SBYTES (absname) - 1);
2353 if (c == ':' || c == ']' || c == '>')
2354 absname = Fdirectory_file_name (absname);
2356 #else
2357 /* Remove final slash, if any (unless this is the root dir).
2358 stat behaves differently depending! */
2359 if (SCHARS (absname) > 1
2360 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2361 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2362 /* We cannot take shortcuts; they might be wrong for magic file names. */
2363 absname = Fdirectory_file_name (absname);
2364 #endif
2365 return absname;
2368 /* Signal an error if the file ABSNAME already exists.
2369 If INTERACTIVE is nonzero, ask the user whether to proceed,
2370 and bypass the error if the user says to go ahead.
2371 QUERYSTRING is a name for the action that is being considered
2372 to alter the file.
2374 *STATPTR is used to store the stat information if the file exists.
2375 If the file does not exist, STATPTR->st_mode is set to 0.
2376 If STATPTR is null, we don't store into it.
2378 If QUICK is nonzero, we ask for y or n, not yes or no. */
2380 void
2381 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2382 Lisp_Object absname;
2383 unsigned char *querystring;
2384 int interactive;
2385 struct stat *statptr;
2386 int quick;
2388 register Lisp_Object tem, encoded_filename;
2389 struct stat statbuf;
2390 struct gcpro gcpro1;
2392 encoded_filename = ENCODE_FILE (absname);
2394 /* stat is a good way to tell whether the file exists,
2395 regardless of what access permissions it has. */
2396 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2398 if (! interactive)
2399 xsignal2 (Qfile_already_exists,
2400 build_string ("File already exists"), absname);
2401 GCPRO1 (absname);
2402 tem = format2 ("File %s already exists; %s anyway? ",
2403 absname, build_string (querystring));
2404 if (quick)
2405 tem = Fy_or_n_p (tem);
2406 else
2407 tem = do_yes_or_no_p (tem);
2408 UNGCPRO;
2409 if (NILP (tem))
2410 xsignal2 (Qfile_already_exists,
2411 build_string ("File already exists"), absname);
2412 if (statptr)
2413 *statptr = statbuf;
2415 else
2417 if (statptr)
2418 statptr->st_mode = 0;
2420 return;
2423 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
2424 "fCopy file: \nGCopy %s to file: \np\nP",
2425 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2426 If NEWNAME names a directory, copy FILE there.
2428 This function always sets the file modes of the output file to match
2429 the input file.
2431 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
2432 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
2433 signal a `file-already-exists' error without overwriting. If
2434 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
2435 about overwriting; this is what happens in interactive use with M-x.
2436 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
2437 existing file.
2439 Fourth arg KEEP-TIME non-nil means give the output file the same
2440 last-modified time as the old one. (This works on only some systems.)
2442 A prefix arg makes KEEP-TIME non-nil.
2444 If PRESERVE-UID-GID is non-nil, we try to transfer the
2445 uid and gid of FILE to NEWNAME. */)
2446 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid)
2447 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2448 Lisp_Object preserve_uid_gid;
2450 int ifd, ofd, n;
2451 char buf[16 * 1024];
2452 struct stat st, out_st;
2453 Lisp_Object handler;
2454 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2455 int count = SPECPDL_INDEX ();
2456 int input_file_statable_p;
2457 Lisp_Object encoded_file, encoded_newname;
2459 encoded_file = encoded_newname = Qnil;
2460 GCPRO4 (file, newname, encoded_file, encoded_newname);
2461 CHECK_STRING (file);
2462 CHECK_STRING (newname);
2464 if (!NILP (Ffile_directory_p (newname)))
2465 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2466 else
2467 newname = Fexpand_file_name (newname, Qnil);
2469 file = Fexpand_file_name (file, Qnil);
2471 /* If the input file name has special constructs in it,
2472 call the corresponding file handler. */
2473 handler = Ffind_file_name_handler (file, Qcopy_file);
2474 /* Likewise for output file name. */
2475 if (NILP (handler))
2476 handler = Ffind_file_name_handler (newname, Qcopy_file);
2477 if (!NILP (handler))
2478 RETURN_UNGCPRO (call6 (handler, Qcopy_file, file, newname,
2479 ok_if_already_exists, keep_time, preserve_uid_gid));
2481 encoded_file = ENCODE_FILE (file);
2482 encoded_newname = ENCODE_FILE (newname);
2484 if (NILP (ok_if_already_exists)
2485 || INTEGERP (ok_if_already_exists))
2486 barf_or_query_if_file_exists (newname, "copy to it",
2487 INTEGERP (ok_if_already_exists), &out_st, 0);
2488 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2489 out_st.st_mode = 0;
2491 #ifdef WINDOWSNT
2492 if (!CopyFile (SDATA (encoded_file),
2493 SDATA (encoded_newname),
2494 FALSE))
2495 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2496 /* CopyFile retains the timestamp by default. */
2497 else if (NILP (keep_time))
2499 EMACS_TIME now;
2500 DWORD attributes;
2501 char * filename;
2503 EMACS_GET_TIME (now);
2504 filename = SDATA (encoded_newname);
2506 /* Ensure file is writable while its modified time is set. */
2507 attributes = GetFileAttributes (filename);
2508 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2509 if (set_file_times (filename, now, now))
2511 /* Restore original attributes. */
2512 SetFileAttributes (filename, attributes);
2513 xsignal2 (Qfile_date_error,
2514 build_string ("Cannot set file date"), newname);
2516 /* Restore original attributes. */
2517 SetFileAttributes (filename, attributes);
2519 #else /* not WINDOWSNT */
2520 immediate_quit = 1;
2521 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2522 immediate_quit = 0;
2524 if (ifd < 0)
2525 report_file_error ("Opening input file", Fcons (file, Qnil));
2527 record_unwind_protect (close_file_unwind, make_number (ifd));
2529 /* We can only copy regular files and symbolic links. Other files are not
2530 copyable by us. */
2531 input_file_statable_p = (fstat (ifd, &st) >= 0);
2533 #if !defined (MSDOS) || __DJGPP__ > 1
2534 if (out_st.st_mode != 0
2535 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2537 errno = 0;
2538 report_file_error ("Input and output files are the same",
2539 Fcons (file, Fcons (newname, Qnil)));
2541 #endif
2543 #if defined (S_ISREG) && defined (S_ISLNK)
2544 if (input_file_statable_p)
2546 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2548 #if defined (EISDIR)
2549 /* Get a better looking error message. */
2550 errno = EISDIR;
2551 #endif /* EISDIR */
2552 report_file_error ("Non-regular file", Fcons (file, Qnil));
2555 #endif /* S_ISREG && S_ISLNK */
2557 #ifdef VMS
2558 /* Create the copy file with the same record format as the input file */
2559 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2560 #else
2561 #ifdef MSDOS
2562 /* System's default file type was set to binary by _fmode in emacs.c. */
2563 ofd = emacs_open (SDATA (encoded_newname),
2564 O_WRONLY | O_TRUNC | O_CREAT
2565 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2566 S_IREAD | S_IWRITE);
2567 #else /* not MSDOS */
2568 ofd = emacs_open (SDATA (encoded_newname),
2569 O_WRONLY | O_TRUNC | O_CREAT
2570 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2571 0666);
2572 #endif /* not MSDOS */
2573 #endif /* VMS */
2574 if (ofd < 0)
2575 report_file_error ("Opening output file", Fcons (newname, Qnil));
2577 record_unwind_protect (close_file_unwind, make_number (ofd));
2579 immediate_quit = 1;
2580 QUIT;
2581 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2582 if (emacs_write (ofd, buf, n) != n)
2583 report_file_error ("I/O error", Fcons (newname, Qnil));
2584 immediate_quit = 0;
2586 #ifndef MSDOS
2587 /* Preserve the original file modes, and if requested, also its
2588 owner and group. */
2589 if (input_file_statable_p)
2591 if (! NILP (preserve_uid_gid))
2592 fchown (ofd, st.st_uid, st.st_gid);
2593 fchmod (ofd, st.st_mode & 07777);
2595 #endif /* not MSDOS */
2597 /* Closing the output clobbers the file times on some systems. */
2598 if (emacs_close (ofd) < 0)
2599 report_file_error ("I/O error", Fcons (newname, Qnil));
2601 if (input_file_statable_p)
2603 if (!NILP (keep_time))
2605 EMACS_TIME atime, mtime;
2606 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2607 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2608 if (set_file_times (SDATA (encoded_newname),
2609 atime, mtime))
2610 xsignal2 (Qfile_date_error,
2611 build_string ("Cannot set file date"), newname);
2615 emacs_close (ifd);
2617 #if defined (__DJGPP__) && __DJGPP__ > 1
2618 if (input_file_statable_p)
2620 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2621 and if it can't, it tells so. Otherwise, under MSDOS we usually
2622 get only the READ bit, which will make the copied file read-only,
2623 so it's better not to chmod at all. */
2624 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2625 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2627 #endif /* DJGPP version 2 or newer */
2628 #endif /* not WINDOWSNT */
2630 /* Discard the unwind protects. */
2631 specpdl_ptr = specpdl + count;
2633 UNGCPRO;
2634 return Qnil;
2637 DEFUN ("make-directory-internal", Fmake_directory_internal,
2638 Smake_directory_internal, 1, 1, 0,
2639 doc: /* Create a new directory named DIRECTORY. */)
2640 (directory)
2641 Lisp_Object directory;
2643 const unsigned char *dir;
2644 Lisp_Object handler;
2645 Lisp_Object encoded_dir;
2647 CHECK_STRING (directory);
2648 directory = Fexpand_file_name (directory, Qnil);
2650 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2651 if (!NILP (handler))
2652 return call2 (handler, Qmake_directory_internal, directory);
2654 encoded_dir = ENCODE_FILE (directory);
2656 dir = SDATA (encoded_dir);
2658 #ifdef WINDOWSNT
2659 if (mkdir (dir) != 0)
2660 #else
2661 if (mkdir (dir, 0777) != 0)
2662 #endif
2663 report_file_error ("Creating directory", list1 (directory));
2665 return Qnil;
2668 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2669 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2670 (directory)
2671 Lisp_Object directory;
2673 const unsigned char *dir;
2674 Lisp_Object handler;
2675 Lisp_Object encoded_dir;
2677 CHECK_STRING (directory);
2678 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2680 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2681 if (!NILP (handler))
2682 return call2 (handler, Qdelete_directory, directory);
2684 encoded_dir = ENCODE_FILE (directory);
2686 dir = SDATA (encoded_dir);
2688 if (rmdir (dir) != 0)
2689 report_file_error ("Removing directory", list1 (directory));
2691 return Qnil;
2694 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2695 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2696 If file has multiple names, it continues to exist with the other names. */)
2697 (filename)
2698 Lisp_Object filename;
2700 Lisp_Object handler;
2701 Lisp_Object encoded_file;
2702 struct gcpro gcpro1;
2704 GCPRO1 (filename);
2705 if (!NILP (Ffile_directory_p (filename))
2706 && NILP (Ffile_symlink_p (filename)))
2707 xsignal2 (Qfile_error,
2708 build_string ("Removing old name: is a directory"),
2709 filename);
2710 UNGCPRO;
2711 filename = Fexpand_file_name (filename, Qnil);
2713 handler = Ffind_file_name_handler (filename, Qdelete_file);
2714 if (!NILP (handler))
2715 return call2 (handler, Qdelete_file, filename);
2717 encoded_file = ENCODE_FILE (filename);
2719 if (0 > unlink (SDATA (encoded_file)))
2720 report_file_error ("Removing old name", list1 (filename));
2721 return Qnil;
2724 static Lisp_Object
2725 internal_delete_file_1 (ignore)
2726 Lisp_Object ignore;
2728 return Qt;
2731 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2734 internal_delete_file (filename)
2735 Lisp_Object filename;
2737 Lisp_Object tem;
2738 tem = internal_condition_case_1 (Fdelete_file, filename,
2739 Qt, internal_delete_file_1);
2740 return NILP (tem);
2743 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2744 "fRename file: \nGRename %s to file: \np",
2745 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2746 If file has names other than FILE, it continues to have those names.
2747 Signals a `file-already-exists' error if a file NEWNAME already exists
2748 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2749 A number as third arg means request confirmation if NEWNAME already exists.
2750 This is what happens in interactive use with M-x. */)
2751 (file, newname, ok_if_already_exists)
2752 Lisp_Object file, newname, ok_if_already_exists;
2754 Lisp_Object handler;
2755 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2756 Lisp_Object encoded_file, encoded_newname, symlink_target;
2758 symlink_target = encoded_file = encoded_newname = Qnil;
2759 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2760 CHECK_STRING (file);
2761 CHECK_STRING (newname);
2762 file = Fexpand_file_name (file, Qnil);
2764 if ((!NILP (Ffile_directory_p (newname)))
2765 #ifdef DOS_NT
2766 /* If the file names are identical but for the case,
2767 don't attempt to move directory to itself. */
2768 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2769 #endif
2771 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2772 else
2773 newname = Fexpand_file_name (newname, Qnil);
2775 /* If the file name has special constructs in it,
2776 call the corresponding file handler. */
2777 handler = Ffind_file_name_handler (file, Qrename_file);
2778 if (NILP (handler))
2779 handler = Ffind_file_name_handler (newname, Qrename_file);
2780 if (!NILP (handler))
2781 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2782 file, newname, ok_if_already_exists));
2784 encoded_file = ENCODE_FILE (file);
2785 encoded_newname = ENCODE_FILE (newname);
2787 #ifdef DOS_NT
2788 /* If the file names are identical but for the case, don't ask for
2789 confirmation: they simply want to change the letter-case of the
2790 file name. */
2791 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2792 #endif
2793 if (NILP (ok_if_already_exists)
2794 || INTEGERP (ok_if_already_exists))
2795 barf_or_query_if_file_exists (newname, "rename to it",
2796 INTEGERP (ok_if_already_exists), 0, 0);
2797 #ifndef BSD4_1
2798 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2799 #else
2800 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2801 || 0 > unlink (SDATA (encoded_file)))
2802 #endif
2804 if (errno == EXDEV)
2806 #ifdef S_IFLNK
2807 symlink_target = Ffile_symlink_p (file);
2808 if (! NILP (symlink_target))
2809 Fmake_symbolic_link (symlink_target, newname,
2810 NILP (ok_if_already_exists) ? Qnil : Qt);
2811 else
2812 #endif
2813 Fcopy_file (file, newname,
2814 /* We have already prompted if it was an integer,
2815 so don't have copy-file prompt again. */
2816 NILP (ok_if_already_exists) ? Qnil : Qt,
2817 Qt, Qt);
2819 Fdelete_file (file);
2821 else
2822 report_file_error ("Renaming", list2 (file, newname));
2824 UNGCPRO;
2825 return Qnil;
2828 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2829 "fAdd name to file: \nGName to add to %s: \np",
2830 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2831 Signals a `file-already-exists' error if a file NEWNAME already exists
2832 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2833 A number as third arg means request confirmation if NEWNAME already exists.
2834 This is what happens in interactive use with M-x. */)
2835 (file, newname, ok_if_already_exists)
2836 Lisp_Object file, newname, ok_if_already_exists;
2838 Lisp_Object handler;
2839 Lisp_Object encoded_file, encoded_newname;
2840 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2842 GCPRO4 (file, newname, encoded_file, encoded_newname);
2843 encoded_file = encoded_newname = Qnil;
2844 CHECK_STRING (file);
2845 CHECK_STRING (newname);
2846 file = Fexpand_file_name (file, Qnil);
2848 if (!NILP (Ffile_directory_p (newname)))
2849 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2850 else
2851 newname = Fexpand_file_name (newname, Qnil);
2853 /* If the file name has special constructs in it,
2854 call the corresponding file handler. */
2855 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2856 if (!NILP (handler))
2857 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2858 newname, ok_if_already_exists));
2860 /* If the new name has special constructs in it,
2861 call the corresponding file handler. */
2862 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2863 if (!NILP (handler))
2864 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2865 newname, ok_if_already_exists));
2867 encoded_file = ENCODE_FILE (file);
2868 encoded_newname = ENCODE_FILE (newname);
2870 if (NILP (ok_if_already_exists)
2871 || INTEGERP (ok_if_already_exists))
2872 barf_or_query_if_file_exists (newname, "make it a new name",
2873 INTEGERP (ok_if_already_exists), 0, 0);
2875 unlink (SDATA (newname));
2876 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2877 report_file_error ("Adding new name", list2 (file, newname));
2879 UNGCPRO;
2880 return Qnil;
2883 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2884 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2885 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2886 Both args must be strings.
2887 Signals a `file-already-exists' error if a file LINKNAME already exists
2888 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2889 A number as third arg means request confirmation if LINKNAME already exists.
2890 This happens for interactive use with M-x. */)
2891 (filename, linkname, ok_if_already_exists)
2892 Lisp_Object filename, linkname, ok_if_already_exists;
2894 Lisp_Object handler;
2895 Lisp_Object encoded_filename, encoded_linkname;
2896 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2898 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2899 encoded_filename = encoded_linkname = Qnil;
2900 CHECK_STRING (filename);
2901 CHECK_STRING (linkname);
2902 /* If the link target has a ~, we must expand it to get
2903 a truly valid file name. Otherwise, do not expand;
2904 we want to permit links to relative file names. */
2905 if (SREF (filename, 0) == '~')
2906 filename = Fexpand_file_name (filename, Qnil);
2908 if (!NILP (Ffile_directory_p (linkname)))
2909 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2910 else
2911 linkname = Fexpand_file_name (linkname, Qnil);
2913 /* If the file name has special constructs in it,
2914 call the corresponding file handler. */
2915 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2916 if (!NILP (handler))
2917 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2918 linkname, ok_if_already_exists));
2920 /* If the new link name has special constructs in it,
2921 call the corresponding file handler. */
2922 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2923 if (!NILP (handler))
2924 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2925 linkname, ok_if_already_exists));
2927 #ifdef S_IFLNK
2928 encoded_filename = ENCODE_FILE (filename);
2929 encoded_linkname = ENCODE_FILE (linkname);
2931 if (NILP (ok_if_already_exists)
2932 || INTEGERP (ok_if_already_exists))
2933 barf_or_query_if_file_exists (linkname, "make it a link",
2934 INTEGERP (ok_if_already_exists), 0, 0);
2935 if (0 > symlink (SDATA (encoded_filename),
2936 SDATA (encoded_linkname)))
2938 /* If we didn't complain already, silently delete existing file. */
2939 if (errno == EEXIST)
2941 unlink (SDATA (encoded_linkname));
2942 if (0 <= symlink (SDATA (encoded_filename),
2943 SDATA (encoded_linkname)))
2945 UNGCPRO;
2946 return Qnil;
2950 report_file_error ("Making symbolic link", list2 (filename, linkname));
2952 UNGCPRO;
2953 return Qnil;
2955 #else
2956 UNGCPRO;
2957 xsignal1 (Qfile_error, build_string ("Symbolic links are not supported"));
2959 #endif /* S_IFLNK */
2962 #ifdef VMS
2964 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2965 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2966 doc: /* Define the job-wide logical name NAME to have the value STRING.
2967 If STRING is nil or a null string, the logical name NAME is deleted. */)
2968 (name, string)
2969 Lisp_Object name;
2970 Lisp_Object string;
2972 CHECK_STRING (name);
2973 if (NILP (string))
2974 delete_logical_name (SDATA (name));
2975 else
2977 CHECK_STRING (string);
2979 if (SCHARS (string) == 0)
2980 delete_logical_name (SDATA (name));
2981 else
2982 define_logical_name (SDATA (name), SDATA (string));
2985 return string;
2987 #endif /* VMS */
2989 #ifdef HPUX_NET
2991 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2992 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2993 (path, login)
2994 Lisp_Object path, login;
2996 int netresult;
2998 CHECK_STRING (path);
2999 CHECK_STRING (login);
3001 netresult = netunam (SDATA (path), SDATA (login));
3003 if (netresult == -1)
3004 return Qnil;
3005 else
3006 return Qt;
3008 #endif /* HPUX_NET */
3010 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
3011 1, 1, 0,
3012 doc: /* Return t if file FILENAME specifies an absolute file name.
3013 On Unix, this is a name starting with a `/' or a `~'. */)
3014 (filename)
3015 Lisp_Object filename;
3017 CHECK_STRING (filename);
3018 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3021 /* Return nonzero if file FILENAME exists and can be executed. */
3023 static int
3024 check_executable (filename)
3025 char *filename;
3027 #ifdef DOS_NT
3028 int len = strlen (filename);
3029 char *suffix;
3030 struct stat st;
3031 if (stat (filename, &st) < 0)
3032 return 0;
3033 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3034 return ((st.st_mode & S_IEXEC) != 0);
3035 #else
3036 return (S_ISREG (st.st_mode)
3037 && len >= 5
3038 && (stricmp ((suffix = filename + len-4), ".com") == 0
3039 || stricmp (suffix, ".exe") == 0
3040 || stricmp (suffix, ".bat") == 0)
3041 || (st.st_mode & S_IFMT) == S_IFDIR);
3042 #endif /* not WINDOWSNT */
3043 #else /* not DOS_NT */
3044 #ifdef HAVE_EUIDACCESS
3045 return (euidaccess (filename, 1) >= 0);
3046 #else
3047 /* Access isn't quite right because it uses the real uid
3048 and we really want to test with the effective uid.
3049 But Unix doesn't give us a right way to do it. */
3050 return (access (filename, 1) >= 0);
3051 #endif
3052 #endif /* not DOS_NT */
3055 /* Return nonzero if file FILENAME exists and can be written. */
3057 static int
3058 check_writable (filename)
3059 char *filename;
3061 #ifdef MSDOS
3062 struct stat st;
3063 if (stat (filename, &st) < 0)
3064 return 0;
3065 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3066 #else /* not MSDOS */
3067 #ifdef HAVE_EUIDACCESS
3068 return (euidaccess (filename, 2) >= 0);
3069 #else
3070 /* Access isn't quite right because it uses the real uid
3071 and we really want to test with the effective uid.
3072 But Unix doesn't give us a right way to do it.
3073 Opening with O_WRONLY could work for an ordinary file,
3074 but would lose for directories. */
3075 return (access (filename, 2) >= 0);
3076 #endif
3077 #endif /* not MSDOS */
3080 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3081 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3082 See also `file-readable-p' and `file-attributes'.
3083 This returns nil for a symlink to a nonexistent file.
3084 Use `file-symlink-p' to test for such links. */)
3085 (filename)
3086 Lisp_Object filename;
3088 Lisp_Object absname;
3089 Lisp_Object handler;
3090 struct stat statbuf;
3092 CHECK_STRING (filename);
3093 absname = Fexpand_file_name (filename, Qnil);
3095 /* If the file name has special constructs in it,
3096 call the corresponding file handler. */
3097 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3098 if (!NILP (handler))
3099 return call2 (handler, Qfile_exists_p, absname);
3101 absname = ENCODE_FILE (absname);
3103 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3106 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3107 doc: /* Return t if FILENAME can be executed by you.
3108 For a directory, this means you can access files in that directory. */)
3109 (filename)
3110 Lisp_Object filename;
3112 Lisp_Object absname;
3113 Lisp_Object handler;
3115 CHECK_STRING (filename);
3116 absname = Fexpand_file_name (filename, Qnil);
3118 /* If the file name has special constructs in it,
3119 call the corresponding file handler. */
3120 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3121 if (!NILP (handler))
3122 return call2 (handler, Qfile_executable_p, absname);
3124 absname = ENCODE_FILE (absname);
3126 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3129 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3130 doc: /* Return t if file FILENAME exists and you can read it.
3131 See also `file-exists-p' and `file-attributes'. */)
3132 (filename)
3133 Lisp_Object filename;
3135 Lisp_Object absname;
3136 Lisp_Object handler;
3137 int desc;
3138 int flags;
3139 struct stat statbuf;
3141 CHECK_STRING (filename);
3142 absname = Fexpand_file_name (filename, Qnil);
3144 /* If the file name has special constructs in it,
3145 call the corresponding file handler. */
3146 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3147 if (!NILP (handler))
3148 return call2 (handler, Qfile_readable_p, absname);
3150 absname = ENCODE_FILE (absname);
3152 #if defined(DOS_NT) || defined(macintosh)
3153 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3154 directories. */
3155 if (access (SDATA (absname), 0) == 0)
3156 return Qt;
3157 return Qnil;
3158 #else /* not DOS_NT and not macintosh */
3159 flags = O_RDONLY;
3160 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3161 /* Opening a fifo without O_NONBLOCK can wait.
3162 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3163 except in the case of a fifo, on a system which handles it. */
3164 desc = stat (SDATA (absname), &statbuf);
3165 if (desc < 0)
3166 return Qnil;
3167 if (S_ISFIFO (statbuf.st_mode))
3168 flags |= O_NONBLOCK;
3169 #endif
3170 desc = emacs_open (SDATA (absname), flags, 0);
3171 if (desc < 0)
3172 return Qnil;
3173 emacs_close (desc);
3174 return Qt;
3175 #endif /* not DOS_NT and not macintosh */
3178 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3179 on the RT/PC. */
3180 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3181 doc: /* Return t if file FILENAME can be written or created by you. */)
3182 (filename)
3183 Lisp_Object filename;
3185 Lisp_Object absname, dir, encoded;
3186 Lisp_Object handler;
3187 struct stat statbuf;
3189 CHECK_STRING (filename);
3190 absname = Fexpand_file_name (filename, Qnil);
3192 /* If the file name has special constructs in it,
3193 call the corresponding file handler. */
3194 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3195 if (!NILP (handler))
3196 return call2 (handler, Qfile_writable_p, absname);
3198 encoded = ENCODE_FILE (absname);
3199 if (stat (SDATA (encoded), &statbuf) >= 0)
3200 return (check_writable (SDATA (encoded))
3201 ? Qt : Qnil);
3203 dir = Ffile_name_directory (absname);
3204 #ifdef VMS
3205 if (!NILP (dir))
3206 dir = Fdirectory_file_name (dir);
3207 #endif /* VMS */
3208 #ifdef MSDOS
3209 if (!NILP (dir))
3210 dir = Fdirectory_file_name (dir);
3211 #endif /* MSDOS */
3213 dir = ENCODE_FILE (dir);
3214 #ifdef WINDOWSNT
3215 /* The read-only attribute of the parent directory doesn't affect
3216 whether a file or directory can be created within it. Some day we
3217 should check ACLs though, which do affect this. */
3218 if (stat (SDATA (dir), &statbuf) < 0)
3219 return Qnil;
3220 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3221 #else
3222 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3223 ? Qt : Qnil);
3224 #endif
3227 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3228 doc: /* Access file FILENAME, and get an error if that does not work.
3229 The second argument STRING is used in the error message.
3230 If there is no error, returns nil. */)
3231 (filename, string)
3232 Lisp_Object filename, string;
3234 Lisp_Object handler, encoded_filename, absname;
3235 int fd;
3237 CHECK_STRING (filename);
3238 absname = Fexpand_file_name (filename, Qnil);
3240 CHECK_STRING (string);
3242 /* If the file name has special constructs in it,
3243 call the corresponding file handler. */
3244 handler = Ffind_file_name_handler (absname, Qaccess_file);
3245 if (!NILP (handler))
3246 return call3 (handler, Qaccess_file, absname, string);
3248 encoded_filename = ENCODE_FILE (absname);
3250 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3251 if (fd < 0)
3252 report_file_error (SDATA (string), Fcons (filename, Qnil));
3253 emacs_close (fd);
3255 return Qnil;
3258 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3259 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3260 The value is the link target, as a string.
3261 Otherwise it returns nil.
3263 This function returns t when given the name of a symlink that
3264 points to a nonexistent file. */)
3265 (filename)
3266 Lisp_Object filename;
3268 Lisp_Object handler;
3270 CHECK_STRING (filename);
3271 filename = Fexpand_file_name (filename, Qnil);
3273 /* If the file name has special constructs in it,
3274 call the corresponding file handler. */
3275 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3276 if (!NILP (handler))
3277 return call2 (handler, Qfile_symlink_p, filename);
3279 #ifdef S_IFLNK
3281 char *buf;
3282 int bufsize;
3283 int valsize;
3284 Lisp_Object val;
3286 filename = ENCODE_FILE (filename);
3288 bufsize = 50;
3289 buf = NULL;
3292 bufsize *= 2;
3293 buf = (char *) xrealloc (buf, bufsize);
3294 bzero (buf, bufsize);
3296 errno = 0;
3297 valsize = readlink (SDATA (filename), buf, bufsize);
3298 if (valsize == -1)
3300 #ifdef ERANGE
3301 /* HP-UX reports ERANGE if buffer is too small. */
3302 if (errno == ERANGE)
3303 valsize = bufsize;
3304 else
3305 #endif
3307 xfree (buf);
3308 return Qnil;
3312 while (valsize >= bufsize);
3314 val = make_string (buf, valsize);
3315 if (buf[0] == '/' && index (buf, ':'))
3316 val = concat2 (build_string ("/:"), val);
3317 xfree (buf);
3318 val = DECODE_FILE (val);
3319 return val;
3321 #else /* not S_IFLNK */
3322 return Qnil;
3323 #endif /* not S_IFLNK */
3326 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3327 doc: /* Return t if FILENAME names an existing directory.
3328 Symbolic links to directories count as directories.
3329 See `file-symlink-p' to distinguish symlinks. */)
3330 (filename)
3331 Lisp_Object filename;
3333 register Lisp_Object absname;
3334 struct stat st;
3335 Lisp_Object handler;
3337 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3339 /* If the file name has special constructs in it,
3340 call the corresponding file handler. */
3341 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3342 if (!NILP (handler))
3343 return call2 (handler, Qfile_directory_p, absname);
3345 absname = ENCODE_FILE (absname);
3347 if (stat (SDATA (absname), &st) < 0)
3348 return Qnil;
3349 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3352 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3353 doc: /* Return t if file FILENAME names a directory you can open.
3354 For the value to be t, FILENAME must specify the name of a directory as a file,
3355 and the directory must allow you to open files in it. In order to use a
3356 directory as a buffer's current directory, this predicate must return true.
3357 A directory name spec may be given instead; then the value is t
3358 if the directory so specified exists and really is a readable and
3359 searchable directory. */)
3360 (filename)
3361 Lisp_Object filename;
3363 Lisp_Object handler;
3364 int tem;
3365 struct gcpro gcpro1;
3367 /* If the file name has special constructs in it,
3368 call the corresponding file handler. */
3369 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3370 if (!NILP (handler))
3371 return call2 (handler, Qfile_accessible_directory_p, filename);
3373 GCPRO1 (filename);
3374 tem = (NILP (Ffile_directory_p (filename))
3375 || NILP (Ffile_executable_p (filename)));
3376 UNGCPRO;
3377 return tem ? Qnil : Qt;
3380 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3381 doc: /* Return t if FILENAME names a regular file.
3382 This is the sort of file that holds an ordinary stream of data bytes.
3383 Symbolic links to regular files count as regular files.
3384 See `file-symlink-p' to distinguish symlinks. */)
3385 (filename)
3386 Lisp_Object filename;
3388 register Lisp_Object absname;
3389 struct stat st;
3390 Lisp_Object handler;
3392 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3394 /* If the file name has special constructs in it,
3395 call the corresponding file handler. */
3396 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3397 if (!NILP (handler))
3398 return call2 (handler, Qfile_regular_p, absname);
3400 absname = ENCODE_FILE (absname);
3402 #ifdef WINDOWSNT
3404 int result;
3405 Lisp_Object tem = Vw32_get_true_file_attributes;
3407 /* Tell stat to use expensive method to get accurate info. */
3408 Vw32_get_true_file_attributes = Qt;
3409 result = stat (SDATA (absname), &st);
3410 Vw32_get_true_file_attributes = tem;
3412 if (result < 0)
3413 return Qnil;
3414 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3416 #else
3417 if (stat (SDATA (absname), &st) < 0)
3418 return Qnil;
3419 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3420 #endif
3423 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3424 doc: /* Return mode bits of file named FILENAME, as an integer.
3425 Return nil, if file does not exist or is not accessible. */)
3426 (filename)
3427 Lisp_Object filename;
3429 Lisp_Object absname;
3430 struct stat st;
3431 Lisp_Object handler;
3433 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3435 /* If the file name has special constructs in it,
3436 call the corresponding file handler. */
3437 handler = Ffind_file_name_handler (absname, Qfile_modes);
3438 if (!NILP (handler))
3439 return call2 (handler, Qfile_modes, absname);
3441 absname = ENCODE_FILE (absname);
3443 if (stat (SDATA (absname), &st) < 0)
3444 return Qnil;
3445 #if defined (MSDOS) && __DJGPP__ < 2
3446 if (check_executable (SDATA (absname)))
3447 st.st_mode |= S_IEXEC;
3448 #endif /* MSDOS && __DJGPP__ < 2 */
3450 return make_number (st.st_mode & 07777);
3453 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2,
3454 "(let ((file (read-file-name \"File: \"))) \
3455 (list file (read-file-modes nil file)))",
3456 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3457 Only the 12 low bits of MODE are used. */)
3458 (filename, mode)
3459 Lisp_Object filename, mode;
3461 Lisp_Object absname, encoded_absname;
3462 Lisp_Object handler;
3464 absname = Fexpand_file_name (filename, current_buffer->directory);
3465 CHECK_NUMBER (mode);
3467 /* If the file name has special constructs in it,
3468 call the corresponding file handler. */
3469 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3470 if (!NILP (handler))
3471 return call3 (handler, Qset_file_modes, absname, mode);
3473 encoded_absname = ENCODE_FILE (absname);
3475 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3476 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3478 return Qnil;
3481 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3482 doc: /* Set the file permission bits for newly created files.
3483 The argument MODE should be an integer; only the low 9 bits are used.
3484 This setting is inherited by subprocesses. */)
3485 (mode)
3486 Lisp_Object mode;
3488 CHECK_NUMBER (mode);
3490 umask ((~ XINT (mode)) & 0777);
3492 return Qnil;
3495 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3496 doc: /* Return the default file protection for created files.
3497 The value is an integer. */)
3500 int realmask;
3501 Lisp_Object value;
3503 realmask = umask (0);
3504 umask (realmask);
3506 XSETINT (value, (~ realmask) & 0777);
3507 return value;
3510 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3512 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3513 doc: /* Set times of file FILENAME to TIME.
3514 Set both access and modification times.
3515 Return t on success, else nil.
3516 Use the current time if TIME is nil. TIME is in the format of
3517 `current-time'. */)
3518 (filename, time)
3519 Lisp_Object filename, time;
3521 Lisp_Object absname, encoded_absname;
3522 Lisp_Object handler;
3523 time_t sec;
3524 int usec;
3526 if (! lisp_time_argument (time, &sec, &usec))
3527 error ("Invalid time specification");
3529 absname = Fexpand_file_name (filename, current_buffer->directory);
3531 /* If the file name has special constructs in it,
3532 call the corresponding file handler. */
3533 handler = Ffind_file_name_handler (absname, Qset_file_times);
3534 if (!NILP (handler))
3535 return call3 (handler, Qset_file_times, absname, time);
3537 encoded_absname = ENCODE_FILE (absname);
3540 EMACS_TIME t;
3542 EMACS_SET_SECS (t, sec);
3543 EMACS_SET_USECS (t, usec);
3545 if (set_file_times (SDATA (encoded_absname), t, t))
3547 #ifdef DOS_NT
3548 struct stat st;
3550 /* Setting times on a directory always fails. */
3551 if (stat (SDATA (encoded_absname), &st) == 0
3552 && (st.st_mode & S_IFMT) == S_IFDIR)
3553 return Qnil;
3554 #endif
3555 report_file_error ("Setting file times", Fcons (absname, Qnil));
3556 return Qnil;
3560 return Qt;
3563 #ifdef HAVE_SYNC
3564 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3565 doc: /* Tell Unix to finish all pending disk updates. */)
3568 sync ();
3569 return Qnil;
3572 #endif /* HAVE_SYNC */
3574 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3575 doc: /* Return t if file FILE1 is newer than file FILE2.
3576 If FILE1 does not exist, the answer is nil;
3577 otherwise, if FILE2 does not exist, the answer is t. */)
3578 (file1, file2)
3579 Lisp_Object file1, file2;
3581 Lisp_Object absname1, absname2;
3582 struct stat st;
3583 int mtime1;
3584 Lisp_Object handler;
3585 struct gcpro gcpro1, gcpro2;
3587 CHECK_STRING (file1);
3588 CHECK_STRING (file2);
3590 absname1 = Qnil;
3591 GCPRO2 (absname1, file2);
3592 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3593 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3594 UNGCPRO;
3596 /* If the file name has special constructs in it,
3597 call the corresponding file handler. */
3598 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3599 if (NILP (handler))
3600 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3601 if (!NILP (handler))
3602 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3604 GCPRO2 (absname1, absname2);
3605 absname1 = ENCODE_FILE (absname1);
3606 absname2 = ENCODE_FILE (absname2);
3607 UNGCPRO;
3609 if (stat (SDATA (absname1), &st) < 0)
3610 return Qnil;
3612 mtime1 = st.st_mtime;
3614 if (stat (SDATA (absname2), &st) < 0)
3615 return Qt;
3617 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3620 #ifdef DOS_NT
3621 Lisp_Object Qfind_buffer_file_type;
3622 #endif /* DOS_NT */
3624 #ifndef READ_BUF_SIZE
3625 #define READ_BUF_SIZE (64 << 10)
3626 #endif
3628 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3630 /* This function is called after Lisp functions to decide a coding
3631 system are called, or when they cause an error. Before they are
3632 called, the current buffer is set unibyte and it contains only a
3633 newly inserted text (thus the buffer was empty before the
3634 insertion).
3636 The functions may set markers, overlays, text properties, or even
3637 alter the buffer contents, change the current buffer.
3639 Here, we reset all those changes by:
3640 o set back the current buffer.
3641 o move all markers and overlays to BEG.
3642 o remove all text properties.
3643 o set back the buffer multibyteness. */
3645 static Lisp_Object
3646 decide_coding_unwind (unwind_data)
3647 Lisp_Object unwind_data;
3649 Lisp_Object multibyte, undo_list, buffer;
3651 multibyte = XCAR (unwind_data);
3652 unwind_data = XCDR (unwind_data);
3653 undo_list = XCAR (unwind_data);
3654 buffer = XCDR (unwind_data);
3656 if (current_buffer != XBUFFER (buffer))
3657 set_buffer_internal (XBUFFER (buffer));
3658 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3659 adjust_overlays_for_delete (BEG, Z - BEG);
3660 BUF_INTERVALS (current_buffer) = 0;
3661 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3663 /* Now we are safe to change the buffer's multibyteness directly. */
3664 current_buffer->enable_multibyte_characters = multibyte;
3665 current_buffer->undo_list = undo_list;
3667 return Qnil;
3671 /* Used to pass values from insert-file-contents to read_non_regular. */
3673 static int non_regular_fd;
3674 static int non_regular_inserted;
3675 static int non_regular_nbytes;
3678 /* Read from a non-regular file.
3679 Read non_regular_trytry bytes max from non_regular_fd.
3680 Non_regular_inserted specifies where to put the read bytes.
3681 Value is the number of bytes read. */
3683 static Lisp_Object
3684 read_non_regular ()
3686 int nbytes;
3688 immediate_quit = 1;
3689 QUIT;
3690 nbytes = emacs_read (non_regular_fd,
3691 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3692 non_regular_nbytes);
3693 immediate_quit = 0;
3694 return make_number (nbytes);
3698 /* Condition-case handler used when reading from non-regular files
3699 in insert-file-contents. */
3701 static Lisp_Object
3702 read_non_regular_quit ()
3704 return Qnil;
3708 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3709 1, 5, 0,
3710 doc: /* Insert contents of file FILENAME after point.
3711 Returns list of absolute file name and number of characters inserted.
3712 If second argument VISIT is non-nil, the buffer's visited filename and
3713 last save file modtime are set, and it is marked unmodified. If
3714 visiting and the file does not exist, visiting is completed before the
3715 error is signaled.
3717 The optional third and fourth arguments BEG and END specify what portion
3718 of the file to insert. These arguments count bytes in the file, not
3719 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3721 If optional fifth argument REPLACE is non-nil, replace the current
3722 buffer contents (in the accessible portion) with the file contents.
3723 This is better than simply deleting and inserting the whole thing
3724 because (1) it preserves some marker positions and (2) it puts less data
3725 in the undo list. When REPLACE is non-nil, the second return value is
3726 the number of characters that replace previous buffer contents.
3728 This function does code conversion according to the value of
3729 `coding-system-for-read' or `file-coding-system-alist', and sets the
3730 variable `last-coding-system-used' to the coding system actually used. */)
3731 (filename, visit, beg, end, replace)
3732 Lisp_Object filename, visit, beg, end, replace;
3734 struct stat st;
3735 register int fd;
3736 int inserted = 0;
3737 int nochange = 0;
3738 register int how_much;
3739 register int unprocessed;
3740 int count = SPECPDL_INDEX ();
3741 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3742 Lisp_Object handler, val, insval, orig_filename, old_undo;
3743 Lisp_Object p;
3744 int total = 0;
3745 int not_regular = 0;
3746 unsigned char read_buf[READ_BUF_SIZE];
3747 struct coding_system coding;
3748 unsigned char buffer[1 << 14];
3749 int replace_handled = 0;
3750 int set_coding_system = 0;
3751 Lisp_Object coding_system;
3752 int read_quit = 0;
3753 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3754 int we_locked_file = 0;
3756 if (current_buffer->base_buffer && ! NILP (visit))
3757 error ("Cannot do file visiting in an indirect buffer");
3759 if (!NILP (current_buffer->read_only))
3760 Fbarf_if_buffer_read_only ();
3762 val = Qnil;
3763 p = Qnil;
3764 orig_filename = Qnil;
3765 old_undo = Qnil;
3767 GCPRO5 (filename, val, p, orig_filename, old_undo);
3769 CHECK_STRING (filename);
3770 filename = Fexpand_file_name (filename, Qnil);
3772 /* The value Qnil means that the coding system is not yet
3773 decided. */
3774 coding_system = Qnil;
3776 /* If the file name has special constructs in it,
3777 call the corresponding file handler. */
3778 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3779 if (!NILP (handler))
3781 val = call6 (handler, Qinsert_file_contents, filename,
3782 visit, beg, end, replace);
3783 if (CONSP (val) && CONSP (XCDR (val)))
3784 inserted = XINT (XCAR (XCDR (val)));
3785 goto handled;
3788 orig_filename = filename;
3789 filename = ENCODE_FILE (filename);
3791 fd = -1;
3793 #ifdef WINDOWSNT
3795 Lisp_Object tem = Vw32_get_true_file_attributes;
3797 /* Tell stat to use expensive method to get accurate info. */
3798 Vw32_get_true_file_attributes = Qt;
3799 total = stat (SDATA (filename), &st);
3800 Vw32_get_true_file_attributes = tem;
3802 if (total < 0)
3803 #else
3804 if (stat (SDATA (filename), &st) < 0)
3805 #endif /* WINDOWSNT */
3807 if (fd >= 0) emacs_close (fd);
3808 badopen:
3809 if (NILP (visit))
3810 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3811 st.st_mtime = -1;
3812 how_much = 0;
3813 if (!NILP (Vcoding_system_for_read))
3814 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3815 goto notfound;
3818 #ifdef S_IFREG
3819 /* This code will need to be changed in order to work on named
3820 pipes, and it's probably just not worth it. So we should at
3821 least signal an error. */
3822 if (!S_ISREG (st.st_mode))
3824 not_regular = 1;
3826 if (! NILP (visit))
3827 goto notfound;
3829 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3830 xsignal2 (Qfile_error,
3831 build_string ("not a regular file"), orig_filename);
3833 #endif
3835 if (fd < 0)
3836 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3837 goto badopen;
3839 /* Replacement should preserve point as it preserves markers. */
3840 if (!NILP (replace))
3841 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3843 record_unwind_protect (close_file_unwind, make_number (fd));
3845 /* Supposedly happens on VMS. */
3846 /* Can happen on any platform that uses long as type of off_t, but allows
3847 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3848 give a message suitable for the latter case. */
3849 if (! not_regular && st.st_size < 0)
3850 error ("Maximum buffer size exceeded");
3852 /* Prevent redisplay optimizations. */
3853 current_buffer->clip_changed = 1;
3855 if (!NILP (visit))
3857 if (!NILP (beg) || !NILP (end))
3858 error ("Attempt to visit less than an entire file");
3859 if (BEG < Z && NILP (replace))
3860 error ("Cannot do file visiting in a non-empty buffer");
3863 if (!NILP (beg))
3864 CHECK_NUMBER (beg);
3865 else
3866 XSETFASTINT (beg, 0);
3868 if (!NILP (end))
3869 CHECK_NUMBER (end);
3870 else
3872 if (! not_regular)
3874 XSETINT (end, st.st_size);
3876 /* Arithmetic overflow can occur if an Emacs integer cannot
3877 represent the file size, or if the calculations below
3878 overflow. The calculations below double the file size
3879 twice, so check that it can be multiplied by 4 safely. */
3880 if (XINT (end) != st.st_size
3881 || st.st_size > INT_MAX / 4)
3882 error ("Maximum buffer size exceeded");
3884 /* The file size returned from stat may be zero, but data
3885 may be readable nonetheless, for example when this is a
3886 file in the /proc filesystem. */
3887 if (st.st_size == 0)
3888 XSETINT (end, READ_BUF_SIZE);
3892 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3894 coding_system = coding_inherit_eol_type (Qutf_8_emacs, Qunix);
3895 setup_coding_system (coding_system, &coding);
3896 /* Ensure we set Vlast_coding_system_used. */
3897 set_coding_system = 1;
3899 else if (BEG < Z)
3901 /* Decide the coding system to use for reading the file now
3902 because we can't use an optimized method for handling
3903 `coding:' tag if the current buffer is not empty. */
3904 if (!NILP (Vcoding_system_for_read))
3905 coding_system = Vcoding_system_for_read;
3906 else
3908 /* Don't try looking inside a file for a coding system
3909 specification if it is not seekable. */
3910 if (! not_regular && ! NILP (Vset_auto_coding_function))
3912 /* Find a coding system specified in the heading two
3913 lines or in the tailing several lines of the file.
3914 We assume that the 1K-byte and 3K-byte for heading
3915 and tailing respectively are sufficient for this
3916 purpose. */
3917 int nread;
3919 if (st.st_size <= (1024 * 4))
3920 nread = emacs_read (fd, read_buf, 1024 * 4);
3921 else
3923 nread = emacs_read (fd, read_buf, 1024);
3924 if (nread >= 0)
3926 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3927 report_file_error ("Setting file position",
3928 Fcons (orig_filename, Qnil));
3929 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3933 if (nread < 0)
3934 error ("IO error reading %s: %s",
3935 SDATA (orig_filename), emacs_strerror (errno));
3936 else if (nread > 0)
3938 struct buffer *prev = current_buffer;
3939 Lisp_Object buffer;
3940 struct buffer *buf;
3942 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3944 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3945 buf = XBUFFER (buffer);
3947 delete_all_overlays (buf);
3948 buf->directory = current_buffer->directory;
3949 buf->read_only = Qnil;
3950 buf->filename = Qnil;
3951 buf->undo_list = Qt;
3952 eassert (buf->overlays_before == NULL);
3953 eassert (buf->overlays_after == NULL);
3955 set_buffer_internal (buf);
3956 Ferase_buffer ();
3957 buf->enable_multibyte_characters = Qnil;
3959 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3960 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3961 coding_system = call2 (Vset_auto_coding_function,
3962 filename, make_number (nread));
3963 set_buffer_internal (prev);
3965 /* Discard the unwind protect for recovering the
3966 current buffer. */
3967 specpdl_ptr--;
3969 /* Rewind the file for the actual read done later. */
3970 if (lseek (fd, 0, 0) < 0)
3971 report_file_error ("Setting file position",
3972 Fcons (orig_filename, Qnil));
3976 if (NILP (coding_system))
3978 /* If we have not yet decided a coding system, check
3979 file-coding-system-alist. */
3980 Lisp_Object args[6];
3982 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3983 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3984 coding_system = Ffind_operation_coding_system (6, args);
3985 if (CONSP (coding_system))
3986 coding_system = XCAR (coding_system);
3990 if (NILP (coding_system))
3991 coding_system = Qundecided;
3992 else
3993 CHECK_CODING_SYSTEM (coding_system);
3995 if (NILP (current_buffer->enable_multibyte_characters))
3996 /* We must suppress all character code conversion except for
3997 end-of-line conversion. */
3998 coding_system = raw_text_coding_system (coding_system);
4000 setup_coding_system (coding_system, &coding);
4001 /* Ensure we set Vlast_coding_system_used. */
4002 set_coding_system = 1;
4005 /* If requested, replace the accessible part of the buffer
4006 with the file contents. Avoid replacing text at the
4007 beginning or end of the buffer that matches the file contents;
4008 that preserves markers pointing to the unchanged parts.
4010 Here we implement this feature in an optimized way
4011 for the case where code conversion is NOT needed.
4012 The following if-statement handles the case of conversion
4013 in a less optimal way.
4015 If the code conversion is "automatic" then we try using this
4016 method and hope for the best.
4017 But if we discover the need for conversion, we give up on this method
4018 and let the following if-statement handle the replace job. */
4019 if (!NILP (replace)
4020 && BEGV < ZV
4021 && (NILP (coding_system)
4022 || ! CODING_REQUIRE_DECODING (&coding)))
4024 /* same_at_start and same_at_end count bytes,
4025 because file access counts bytes
4026 and BEG and END count bytes. */
4027 int same_at_start = BEGV_BYTE;
4028 int same_at_end = ZV_BYTE;
4029 int overlap;
4030 /* There is still a possibility we will find the need to do code
4031 conversion. If that happens, we set this variable to 1 to
4032 give up on handling REPLACE in the optimized way. */
4033 int giveup_match_end = 0;
4035 if (XINT (beg) != 0)
4037 if (lseek (fd, XINT (beg), 0) < 0)
4038 report_file_error ("Setting file position",
4039 Fcons (orig_filename, Qnil));
4042 immediate_quit = 1;
4043 QUIT;
4044 /* Count how many chars at the start of the file
4045 match the text at the beginning of the buffer. */
4046 while (1)
4048 int nread, bufpos;
4050 nread = emacs_read (fd, buffer, sizeof buffer);
4051 if (nread < 0)
4052 error ("IO error reading %s: %s",
4053 SDATA (orig_filename), emacs_strerror (errno));
4054 else if (nread == 0)
4055 break;
4057 if (CODING_REQUIRE_DETECTION (&coding))
4059 coding_system = detect_coding_system (buffer, nread, nread, 1, 0,
4060 coding_system);
4061 setup_coding_system (coding_system, &coding);
4064 if (CODING_REQUIRE_DECODING (&coding))
4065 /* We found that the file should be decoded somehow.
4066 Let's give up here. */
4068 giveup_match_end = 1;
4069 break;
4072 bufpos = 0;
4073 while (bufpos < nread && same_at_start < ZV_BYTE
4074 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4075 same_at_start++, bufpos++;
4076 /* If we found a discrepancy, stop the scan.
4077 Otherwise loop around and scan the next bufferful. */
4078 if (bufpos != nread)
4079 break;
4081 immediate_quit = 0;
4082 /* If the file matches the buffer completely,
4083 there's no need to replace anything. */
4084 if (same_at_start - BEGV_BYTE == XINT (end))
4086 emacs_close (fd);
4087 specpdl_ptr--;
4088 /* Truncate the buffer to the size of the file. */
4089 del_range_1 (same_at_start, same_at_end, 0, 0);
4090 goto handled;
4092 immediate_quit = 1;
4093 QUIT;
4094 /* Count how many chars at the end of the file
4095 match the text at the end of the buffer. But, if we have
4096 already found that decoding is necessary, don't waste time. */
4097 while (!giveup_match_end)
4099 int total_read, nread, bufpos, curpos, trial;
4101 /* At what file position are we now scanning? */
4102 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4103 /* If the entire file matches the buffer tail, stop the scan. */
4104 if (curpos == 0)
4105 break;
4106 /* How much can we scan in the next step? */
4107 trial = min (curpos, sizeof buffer);
4108 if (lseek (fd, curpos - trial, 0) < 0)
4109 report_file_error ("Setting file position",
4110 Fcons (orig_filename, Qnil));
4112 total_read = nread = 0;
4113 while (total_read < trial)
4115 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4116 if (nread < 0)
4117 error ("IO error reading %s: %s",
4118 SDATA (orig_filename), emacs_strerror (errno));
4119 else if (nread == 0)
4120 break;
4121 total_read += nread;
4124 /* Scan this bufferful from the end, comparing with
4125 the Emacs buffer. */
4126 bufpos = total_read;
4128 /* Compare with same_at_start to avoid counting some buffer text
4129 as matching both at the file's beginning and at the end. */
4130 while (bufpos > 0 && same_at_end > same_at_start
4131 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4132 same_at_end--, bufpos--;
4134 /* If we found a discrepancy, stop the scan.
4135 Otherwise loop around and scan the preceding bufferful. */
4136 if (bufpos != 0)
4138 /* If this discrepancy is because of code conversion,
4139 we cannot use this method; giveup and try the other. */
4140 if (same_at_end > same_at_start
4141 && FETCH_BYTE (same_at_end - 1) >= 0200
4142 && ! NILP (current_buffer->enable_multibyte_characters)
4143 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4144 giveup_match_end = 1;
4145 break;
4148 if (nread == 0)
4149 break;
4151 immediate_quit = 0;
4153 if (! giveup_match_end)
4155 int temp;
4157 /* We win! We can handle REPLACE the optimized way. */
4159 /* Extend the start of non-matching text area to multibyte
4160 character boundary. */
4161 if (! NILP (current_buffer->enable_multibyte_characters))
4162 while (same_at_start > BEGV_BYTE
4163 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4164 same_at_start--;
4166 /* Extend the end of non-matching text area to multibyte
4167 character boundary. */
4168 if (! NILP (current_buffer->enable_multibyte_characters))
4169 while (same_at_end < ZV_BYTE
4170 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4171 same_at_end++;
4173 /* Don't try to reuse the same piece of text twice. */
4174 overlap = (same_at_start - BEGV_BYTE
4175 - (same_at_end + st.st_size - ZV));
4176 if (overlap > 0)
4177 same_at_end += overlap;
4179 /* Arrange to read only the nonmatching middle part of the file. */
4180 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4181 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4183 del_range_byte (same_at_start, same_at_end, 0);
4184 /* Insert from the file at the proper position. */
4185 temp = BYTE_TO_CHAR (same_at_start);
4186 SET_PT_BOTH (temp, same_at_start);
4188 /* If display currently starts at beginning of line,
4189 keep it that way. */
4190 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4191 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4193 replace_handled = 1;
4197 /* If requested, replace the accessible part of the buffer
4198 with the file contents. Avoid replacing text at the
4199 beginning or end of the buffer that matches the file contents;
4200 that preserves markers pointing to the unchanged parts.
4202 Here we implement this feature for the case where code conversion
4203 is needed, in a simple way that needs a lot of memory.
4204 The preceding if-statement handles the case of no conversion
4205 in a more optimized way. */
4206 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4208 EMACS_INT same_at_start = BEGV_BYTE;
4209 EMACS_INT same_at_end = ZV_BYTE;
4210 EMACS_INT same_at_start_charpos;
4211 EMACS_INT inserted_chars;
4212 EMACS_INT overlap;
4213 EMACS_INT bufpos;
4214 unsigned char *decoded;
4215 int temp;
4216 int this_count = SPECPDL_INDEX ();
4217 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
4218 Lisp_Object conversion_buffer;
4220 conversion_buffer = code_conversion_save (1, multibyte);
4222 /* First read the whole file, performing code conversion into
4223 CONVERSION_BUFFER. */
4225 if (lseek (fd, XINT (beg), 0) < 0)
4226 report_file_error ("Setting file position",
4227 Fcons (orig_filename, Qnil));
4229 total = st.st_size; /* Total bytes in the file. */
4230 how_much = 0; /* Bytes read from file so far. */
4231 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4232 unprocessed = 0; /* Bytes not processed in previous loop. */
4234 GCPRO1 (conversion_buffer);
4235 while (how_much < total)
4237 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
4238 quitting while reading a huge while. */
4239 /* try is reserved in some compilers (Microsoft C) */
4240 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4241 int this;
4243 /* Allow quitting out of the actual I/O. */
4244 immediate_quit = 1;
4245 QUIT;
4246 this = emacs_read (fd, read_buf + unprocessed, trytry);
4247 immediate_quit = 0;
4249 if (this <= 0)
4251 if (this < 0)
4252 how_much = this;
4253 break;
4256 how_much += this;
4258 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer),
4259 BUF_Z (XBUFFER (conversion_buffer)));
4260 decode_coding_c_string (&coding, read_buf, unprocessed + this,
4261 conversion_buffer);
4262 unprocessed = coding.carryover_bytes;
4263 if (coding.carryover_bytes > 0)
4264 bcopy (coding.carryover, read_buf, unprocessed);
4266 UNGCPRO;
4267 emacs_close (fd);
4269 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
4270 if we couldn't read the file. */
4272 if (how_much < 0)
4273 error ("IO error reading %s: %s",
4274 SDATA (orig_filename), emacs_strerror (errno));
4276 if (unprocessed > 0)
4278 coding.mode |= CODING_MODE_LAST_BLOCK;
4279 decode_coding_c_string (&coding, read_buf, unprocessed,
4280 conversion_buffer);
4281 coding.mode &= ~CODING_MODE_LAST_BLOCK;
4284 decoded = BUF_BEG_ADDR (XBUFFER (conversion_buffer));
4285 inserted = (BUF_Z_BYTE (XBUFFER (conversion_buffer))
4286 - BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
4288 /* Compare the beginning of the converted string with the buffer
4289 text. */
4291 bufpos = 0;
4292 while (bufpos < inserted && same_at_start < same_at_end
4293 && FETCH_BYTE (same_at_start) == decoded[bufpos])
4294 same_at_start++, bufpos++;
4296 /* If the file matches the head of buffer completely,
4297 there's no need to replace anything. */
4299 if (bufpos == inserted)
4301 specpdl_ptr--;
4302 /* Truncate the buffer to the size of the file. */
4303 if (same_at_start == same_at_end)
4304 nochange = 1;
4305 else
4306 del_range_byte (same_at_start, same_at_end, 0);
4307 inserted = 0;
4309 unbind_to (this_count, Qnil);
4310 goto handled;
4313 /* Extend the start of non-matching text area to the previous
4314 multibyte character boundary. */
4315 if (! NILP (current_buffer->enable_multibyte_characters))
4316 while (same_at_start > BEGV_BYTE
4317 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4318 same_at_start--;
4320 /* Scan this bufferful from the end, comparing with
4321 the Emacs buffer. */
4322 bufpos = inserted;
4324 /* Compare with same_at_start to avoid counting some buffer text
4325 as matching both at the file's beginning and at the end. */
4326 while (bufpos > 0 && same_at_end > same_at_start
4327 && FETCH_BYTE (same_at_end - 1) == decoded[bufpos - 1])
4328 same_at_end--, bufpos--;
4330 /* Extend the end of non-matching text area to the next
4331 multibyte character boundary. */
4332 if (! NILP (current_buffer->enable_multibyte_characters))
4333 while (same_at_end < ZV_BYTE
4334 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4335 same_at_end++;
4337 /* Don't try to reuse the same piece of text twice. */
4338 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4339 if (overlap > 0)
4340 same_at_end += overlap;
4342 /* If display currently starts at beginning of line,
4343 keep it that way. */
4344 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4345 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4347 /* Replace the chars that we need to replace,
4348 and update INSERTED to equal the number of bytes
4349 we are taking from the decoded string. */
4350 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4352 if (same_at_end != same_at_start)
4354 del_range_byte (same_at_start, same_at_end, 0);
4355 temp = GPT;
4356 same_at_start = GPT_BYTE;
4358 else
4360 temp = BYTE_TO_CHAR (same_at_start);
4362 /* Insert from the file at the proper position. */
4363 SET_PT_BOTH (temp, same_at_start);
4364 same_at_start_charpos
4365 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
4366 same_at_start - BEGV_BYTE
4367 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
4368 inserted_chars
4369 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
4370 same_at_start + inserted - BEGV_BYTE
4371 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)))
4372 - same_at_start_charpos);
4373 /* This binding is to avoid ask-user-about-supersession-threat
4374 being called in insert_from_buffer (via in
4375 prepare_to_modify_buffer). */
4376 specbind (intern ("buffer-file-name"), Qnil);
4377 insert_from_buffer (XBUFFER (conversion_buffer),
4378 same_at_start_charpos, inserted_chars, 0);
4379 /* Set `inserted' to the number of inserted characters. */
4380 inserted = PT - temp;
4381 /* Set point before the inserted characters. */
4382 SET_PT_BOTH (temp, same_at_start);
4384 unbind_to (this_count, Qnil);
4386 goto handled;
4389 if (! not_regular)
4391 register Lisp_Object temp;
4393 total = XINT (end) - XINT (beg);
4395 /* Make sure point-max won't overflow after this insertion. */
4396 XSETINT (temp, total);
4397 if (total != XINT (temp))
4398 error ("Maximum buffer size exceeded");
4400 else
4401 /* For a special file, all we can do is guess. */
4402 total = READ_BUF_SIZE;
4404 if (NILP (visit) && inserted > 0)
4406 #ifdef CLASH_DETECTION
4407 if (!NILP (current_buffer->file_truename)
4408 /* Make binding buffer-file-name to nil effective. */
4409 && !NILP (current_buffer->filename)
4410 && SAVE_MODIFF >= MODIFF)
4411 we_locked_file = 1;
4412 #endif /* CLASH_DETECTION */
4413 prepare_to_modify_buffer (GPT, GPT, NULL);
4416 move_gap (PT);
4417 if (GAP_SIZE < total)
4418 make_gap (total - GAP_SIZE);
4420 if (XINT (beg) != 0 || !NILP (replace))
4422 if (lseek (fd, XINT (beg), 0) < 0)
4423 report_file_error ("Setting file position",
4424 Fcons (orig_filename, Qnil));
4427 /* In the following loop, HOW_MUCH contains the total bytes read so
4428 far for a regular file, and not changed for a special file. But,
4429 before exiting the loop, it is set to a negative value if I/O
4430 error occurs. */
4431 how_much = 0;
4433 /* Total bytes inserted. */
4434 inserted = 0;
4436 /* Here, we don't do code conversion in the loop. It is done by
4437 decode_coding_gap after all data are read into the buffer. */
4439 int gap_size = GAP_SIZE;
4441 while (how_much < total)
4443 /* try is reserved in some compilers (Microsoft C) */
4444 int trytry = min (total - how_much, READ_BUF_SIZE);
4445 int this;
4447 if (not_regular)
4449 Lisp_Object val;
4451 /* Maybe make more room. */
4452 if (gap_size < trytry)
4454 make_gap (total - gap_size);
4455 gap_size = GAP_SIZE;
4458 /* Read from the file, capturing `quit'. When an
4459 error occurs, end the loop, and arrange for a quit
4460 to be signaled after decoding the text we read. */
4461 non_regular_fd = fd;
4462 non_regular_inserted = inserted;
4463 non_regular_nbytes = trytry;
4464 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4465 read_non_regular_quit);
4466 if (NILP (val))
4468 read_quit = 1;
4469 break;
4472 this = XINT (val);
4474 else
4476 /* Allow quitting out of the actual I/O. We don't make text
4477 part of the buffer until all the reading is done, so a C-g
4478 here doesn't do any harm. */
4479 immediate_quit = 1;
4480 QUIT;
4481 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4482 immediate_quit = 0;
4485 if (this <= 0)
4487 how_much = this;
4488 break;
4491 gap_size -= this;
4493 /* For a regular file, where TOTAL is the real size,
4494 count HOW_MUCH to compare with it.
4495 For a special file, where TOTAL is just a buffer size,
4496 so don't bother counting in HOW_MUCH.
4497 (INSERTED is where we count the number of characters inserted.) */
4498 if (! not_regular)
4499 how_much += this;
4500 inserted += this;
4504 /* Now we have read all the file data into the gap.
4505 If it was empty, undo marking the buffer modified. */
4507 if (inserted == 0)
4509 #ifdef CLASH_DETECTION
4510 if (we_locked_file)
4511 unlock_file (current_buffer->file_truename);
4512 #endif
4513 Vdeactivate_mark = old_Vdeactivate_mark;
4515 else
4516 Vdeactivate_mark = Qt;
4518 /* Make the text read part of the buffer. */
4519 GAP_SIZE -= inserted;
4520 GPT += inserted;
4521 GPT_BYTE += inserted;
4522 ZV += inserted;
4523 ZV_BYTE += inserted;
4524 Z += inserted;
4525 Z_BYTE += inserted;
4527 if (GAP_SIZE > 0)
4528 /* Put an anchor to ensure multi-byte form ends at gap. */
4529 *GPT_ADDR = 0;
4531 emacs_close (fd);
4533 /* Discard the unwind protect for closing the file. */
4534 specpdl_ptr--;
4536 if (how_much < 0)
4537 error ("IO error reading %s: %s",
4538 SDATA (orig_filename), emacs_strerror (errno));
4540 notfound:
4542 if (NILP (coding_system))
4544 /* The coding system is not yet decided. Decide it by an
4545 optimized method for handling `coding:' tag.
4547 Note that we can get here only if the buffer was empty
4548 before the insertion. */
4550 if (!NILP (Vcoding_system_for_read))
4551 coding_system = Vcoding_system_for_read;
4552 else
4554 /* Since we are sure that the current buffer was empty
4555 before the insertion, we can toggle
4556 enable-multibyte-characters directly here without taking
4557 care of marker adjustment. By this way, we can run Lisp
4558 program safely before decoding the inserted text. */
4559 Lisp_Object unwind_data;
4560 int count = SPECPDL_INDEX ();
4562 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4563 Fcons (current_buffer->undo_list,
4564 Fcurrent_buffer ()));
4565 current_buffer->enable_multibyte_characters = Qnil;
4566 current_buffer->undo_list = Qt;
4567 record_unwind_protect (decide_coding_unwind, unwind_data);
4569 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4571 coding_system = call2 (Vset_auto_coding_function,
4572 filename, make_number (inserted));
4575 if (NILP (coding_system))
4577 /* If the coding system is not yet decided, check
4578 file-coding-system-alist. */
4579 Lisp_Object args[6];
4581 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4582 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4583 coding_system = Ffind_operation_coding_system (6, args);
4584 if (CONSP (coding_system))
4585 coding_system = XCAR (coding_system);
4587 unbind_to (count, Qnil);
4588 inserted = Z_BYTE - BEG_BYTE;
4591 if (NILP (coding_system))
4592 coding_system = Qundecided;
4593 else
4594 CHECK_CODING_SYSTEM (coding_system);
4596 if (NILP (current_buffer->enable_multibyte_characters))
4597 /* We must suppress all character code conversion except for
4598 end-of-line conversion. */
4599 coding_system = raw_text_coding_system (coding_system);
4600 setup_coding_system (coding_system, &coding);
4601 /* Ensure we set Vlast_coding_system_used. */
4602 set_coding_system = 1;
4605 if (!NILP (visit))
4607 /* When we visit a file by raw-text, we change the buffer to
4608 unibyte. */
4609 if (CODING_FOR_UNIBYTE (&coding)
4610 /* Can't do this if part of the buffer might be preserved. */
4611 && NILP (replace))
4612 /* Visiting a file with these coding system makes the buffer
4613 unibyte. */
4614 current_buffer->enable_multibyte_characters = Qnil;
4617 coding.dst_multibyte = ! NILP (current_buffer->enable_multibyte_characters);
4618 if (CODING_MAY_REQUIRE_DECODING (&coding)
4619 && (inserted > 0 || CODING_REQUIRE_FLUSHING (&coding)))
4621 move_gap_both (PT, PT_BYTE);
4622 GAP_SIZE += inserted;
4623 ZV_BYTE -= inserted;
4624 Z_BYTE -= inserted;
4625 ZV -= inserted;
4626 Z -= inserted;
4627 decode_coding_gap (&coding, inserted, inserted);
4628 inserted = coding.produced_char;
4629 coding_system = CODING_ID_NAME (coding.id);
4631 else if (inserted > 0)
4632 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4633 inserted);
4635 /* Now INSERTED is measured in characters. */
4637 #ifdef DOS_NT
4638 /* Use the conversion type to determine buffer-file-type
4639 (find-buffer-file-type is now used to help determine the
4640 conversion). */
4641 if ((VECTORP (CODING_ID_EOL_TYPE (coding.id))
4642 || EQ (CODING_ID_EOL_TYPE (coding.id), Qunix))
4643 && ! CODING_REQUIRE_DECODING (&coding))
4644 current_buffer->buffer_file_type = Qt;
4645 else
4646 current_buffer->buffer_file_type = Qnil;
4647 #endif
4649 handled:
4651 if (!NILP (visit))
4653 if (!EQ (current_buffer->undo_list, Qt) && !nochange)
4654 current_buffer->undo_list = Qnil;
4656 if (NILP (handler))
4658 current_buffer->modtime = st.st_mtime;
4659 current_buffer->filename = orig_filename;
4662 SAVE_MODIFF = MODIFF;
4663 current_buffer->auto_save_modified = MODIFF;
4664 XSETFASTINT (current_buffer->save_length, Z - BEG);
4665 #ifdef CLASH_DETECTION
4666 if (NILP (handler))
4668 if (!NILP (current_buffer->file_truename))
4669 unlock_file (current_buffer->file_truename);
4670 unlock_file (filename);
4672 #endif /* CLASH_DETECTION */
4673 if (not_regular)
4674 xsignal2 (Qfile_error,
4675 build_string ("not a regular file"), orig_filename);
4678 if (set_coding_system)
4679 Vlast_coding_system_used = coding_system;
4681 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4683 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4684 visit);
4685 if (! NILP (insval))
4687 CHECK_NUMBER (insval);
4688 inserted = XFASTINT (insval);
4692 /* Decode file format */
4693 if (inserted > 0)
4695 /* Don't run point motion or modification hooks when decoding. */
4696 int count = SPECPDL_INDEX ();
4697 specbind (Qinhibit_point_motion_hooks, Qt);
4698 specbind (Qinhibit_modification_hooks, Qt);
4700 /* Save old undo list and don't record undo for decoding. */
4701 old_undo = current_buffer->undo_list;
4702 current_buffer->undo_list = Qt;
4704 if (NILP (replace))
4706 insval = call3 (Qformat_decode,
4707 Qnil, make_number (inserted), visit);
4708 CHECK_NUMBER (insval);
4709 inserted = XFASTINT (insval);
4711 else
4713 /* If REPLACE is non-nil and we succeeded in not replacing the
4714 beginning or end of the buffer text with the file's contents,
4715 call format-decode with `point' positioned at the beginning of
4716 the buffer and `inserted' equalling the number of characters
4717 in the buffer. Otherwise, format-decode might fail to
4718 correctly analyze the beginning or end of the buffer. Hence
4719 we temporarily save `point' and `inserted' here and restore
4720 `point' iff format-decode did not insert or delete any text.
4721 Otherwise we leave `point' at point-min. */
4722 int opoint = PT;
4723 int opoint_byte = PT_BYTE;
4724 int oinserted = ZV - BEGV;
4725 int ochars_modiff = CHARS_MODIFF;
4727 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4728 insval = call3 (Qformat_decode,
4729 Qnil, make_number (oinserted), visit);
4730 CHECK_NUMBER (insval);
4731 if (ochars_modiff == CHARS_MODIFF)
4732 /* format_decode didn't modify buffer's characters => move
4733 point back to position before inserted text and leave
4734 value of inserted alone. */
4735 SET_PT_BOTH (opoint, opoint_byte);
4736 else
4737 /* format_decode modified buffer's characters => consider
4738 entire buffer changed and leave point at point-min. */
4739 inserted = XFASTINT (insval);
4742 /* For consistency with format-decode call these now iff inserted > 0
4743 (martin 2007-06-28) */
4744 p = Vafter_insert_file_functions;
4745 while (CONSP (p))
4747 if (NILP (replace))
4749 insval = call1 (XCAR (p), make_number (inserted));
4750 if (!NILP (insval))
4752 CHECK_NUMBER (insval);
4753 inserted = XFASTINT (insval);
4756 else
4758 /* For the rationale of this see the comment on format-decode above. */
4759 int opoint = PT;
4760 int opoint_byte = PT_BYTE;
4761 int oinserted = ZV - BEGV;
4762 int ochars_modiff = CHARS_MODIFF;
4764 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4765 insval = call1 (XCAR (p), make_number (oinserted));
4766 if (!NILP (insval))
4768 CHECK_NUMBER (insval);
4769 if (ochars_modiff == CHARS_MODIFF)
4770 /* after_insert_file_functions didn't modify
4771 buffer's characters => move point back to
4772 position before inserted text and leave value of
4773 inserted alone. */
4774 SET_PT_BOTH (opoint, opoint_byte);
4775 else
4776 /* after_insert_file_functions did modify buffer's
4777 characters => consider entire buffer changed and
4778 leave point at point-min. */
4779 inserted = XFASTINT (insval);
4783 QUIT;
4784 p = XCDR (p);
4787 if (NILP (visit))
4789 Lisp_Object lbeg, lend;
4790 XSETINT (lbeg, PT);
4791 XSETINT (lend, PT + inserted);
4792 if (CONSP (old_undo))
4794 Lisp_Object tem = XCAR (old_undo);
4795 if (CONSP (tem) && INTEGERP (XCAR (tem)) &&
4796 INTEGERP (XCDR (tem)) && EQ (XCAR (tem), lbeg))
4797 /* In the non-visiting case record only the final insertion. */
4798 current_buffer->undo_list =
4799 Fcons (Fcons (lbeg, lend), Fcdr (old_undo));
4802 else
4803 /* If undo_list was Qt before, keep it that way.
4804 Otherwise start with an empty undo_list. */
4805 current_buffer->undo_list = EQ (old_undo, Qt) ? Qt : Qnil;
4807 unbind_to (count, Qnil);
4810 /* Call after-change hooks for the inserted text, aside from the case
4811 of normal visiting (not with REPLACE), which is done in a new buffer
4812 "before" the buffer is changed. */
4813 if (inserted > 0 && total > 0
4814 && (NILP (visit) || !NILP (replace)))
4816 signal_after_change (PT, 0, inserted);
4817 update_compositions (PT, PT, CHECK_BORDER);
4820 if (!NILP (visit)
4821 && current_buffer->modtime == -1)
4823 /* If visiting nonexistent file, return nil. */
4824 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4827 if (read_quit)
4828 Fsignal (Qquit, Qnil);
4830 /* ??? Retval needs to be dealt with in all cases consistently. */
4831 if (NILP (val))
4832 val = Fcons (orig_filename,
4833 Fcons (make_number (inserted),
4834 Qnil));
4836 RETURN_UNGCPRO (unbind_to (count, val));
4839 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4841 /* If build_annotations switched buffers, switch back to BUF.
4842 Kill the temporary buffer that was selected in the meantime.
4844 Since this kill only the last temporary buffer, some buffers remain
4845 not killed if build_annotations switched buffers more than once.
4846 -- K.Handa */
4848 static Lisp_Object
4849 build_annotations_unwind (buf)
4850 Lisp_Object buf;
4852 Lisp_Object tembuf;
4854 if (XBUFFER (buf) == current_buffer)
4855 return Qnil;
4856 tembuf = Fcurrent_buffer ();
4857 Fset_buffer (buf);
4858 Fkill_buffer (tembuf);
4859 return Qnil;
4862 /* Decide the coding-system to encode the data with. */
4864 static Lisp_Object
4865 choose_write_coding_system (start, end, filename,
4866 append, visit, lockname, coding)
4867 Lisp_Object start, end, filename, append, visit, lockname;
4868 struct coding_system *coding;
4870 Lisp_Object val;
4871 Lisp_Object eol_parent = Qnil;
4873 if (auto_saving
4874 && NILP (Fstring_equal (current_buffer->filename,
4875 current_buffer->auto_save_file_name)))
4877 val = Qutf_8_emacs;
4878 eol_parent = Qunix;
4880 else if (!NILP (Vcoding_system_for_write))
4882 val = Vcoding_system_for_write;
4883 if (coding_system_require_warning
4884 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4885 /* Confirm that VAL can surely encode the current region. */
4886 val = call5 (Vselect_safe_coding_system_function,
4887 start, end, Fcons (Qt, Fcons (val, Qnil)),
4888 Qnil, filename);
4890 else
4892 /* If the variable `buffer-file-coding-system' is set locally,
4893 it means that the file was read with some kind of code
4894 conversion or the variable is explicitly set by users. We
4895 had better write it out with the same coding system even if
4896 `enable-multibyte-characters' is nil.
4898 If it is not set locally, we anyway have to convert EOL
4899 format if the default value of `buffer-file-coding-system'
4900 tells that it is not Unix-like (LF only) format. */
4901 int using_default_coding = 0;
4902 int force_raw_text = 0;
4904 val = current_buffer->buffer_file_coding_system;
4905 if (NILP (val)
4906 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4908 val = Qnil;
4909 if (NILP (current_buffer->enable_multibyte_characters))
4910 force_raw_text = 1;
4913 if (NILP (val))
4915 /* Check file-coding-system-alist. */
4916 Lisp_Object args[7], coding_systems;
4918 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4919 args[3] = filename; args[4] = append; args[5] = visit;
4920 args[6] = lockname;
4921 coding_systems = Ffind_operation_coding_system (7, args);
4922 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4923 val = XCDR (coding_systems);
4926 if (NILP (val))
4928 /* If we still have not decided a coding system, use the
4929 default value of buffer-file-coding-system. */
4930 val = current_buffer->buffer_file_coding_system;
4931 using_default_coding = 1;
4934 if (! NILP (val) && ! force_raw_text)
4936 Lisp_Object spec, attrs;
4938 CHECK_CODING_SYSTEM_GET_SPEC (val, spec);
4939 attrs = AREF (spec, 0);
4940 if (EQ (CODING_ATTR_TYPE (attrs), Qraw_text))
4941 force_raw_text = 1;
4944 if (!force_raw_text
4945 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4946 /* Confirm that VAL can surely encode the current region. */
4947 val = call5 (Vselect_safe_coding_system_function,
4948 start, end, val, Qnil, filename);
4950 /* If the decided coding-system doesn't specify end-of-line
4951 format, we use that of
4952 `default-buffer-file-coding-system'. */
4953 if (! using_default_coding
4954 && ! NILP (buffer_defaults.buffer_file_coding_system))
4955 val = (coding_inherit_eol_type
4956 (val, buffer_defaults.buffer_file_coding_system));
4958 /* If we decide not to encode text, use `raw-text' or one of its
4959 subsidiaries. */
4960 if (force_raw_text)
4961 val = raw_text_coding_system (val);
4964 val = coding_inherit_eol_type (val, eol_parent);
4965 setup_coding_system (val, coding);
4967 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4968 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4969 return val;
4972 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4973 "r\nFWrite region to file: \ni\ni\ni\np",
4974 doc: /* Write current region into specified file.
4975 When called from a program, requires three arguments:
4976 START, END and FILENAME. START and END are normally buffer positions
4977 specifying the part of the buffer to write.
4978 If START is nil, that means to use the entire buffer contents.
4979 If START is a string, then output that string to the file
4980 instead of any buffer contents; END is ignored.
4982 Optional fourth argument APPEND if non-nil means
4983 append to existing file contents (if any). If it is an integer,
4984 seek to that offset in the file before writing.
4985 Optional fifth argument VISIT, if t or a string, means
4986 set the last-save-file-modtime of buffer to this file's modtime
4987 and mark buffer not modified.
4988 If VISIT is a string, it is a second file name;
4989 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4990 VISIT is also the file name to lock and unlock for clash detection.
4991 If VISIT is neither t nor nil nor a string,
4992 that means do not display the \"Wrote file\" message.
4993 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4994 use for locking and unlocking, overriding FILENAME and VISIT.
4995 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4996 for an existing file with the same name. If MUSTBENEW is `excl',
4997 that means to get an error if the file already exists; never overwrite.
4998 If MUSTBENEW is neither nil nor `excl', that means ask for
4999 confirmation before overwriting, but do go ahead and overwrite the file
5000 if the user confirms.
5002 This does code conversion according to the value of
5003 `coding-system-for-write', `buffer-file-coding-system', or
5004 `file-coding-system-alist', and sets the variable
5005 `last-coding-system-used' to the coding system actually used. */)
5006 (start, end, filename, append, visit, lockname, mustbenew)
5007 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
5009 register int desc;
5010 int failure;
5011 int save_errno = 0;
5012 const unsigned char *fn;
5013 struct stat st;
5014 int count = SPECPDL_INDEX ();
5015 int count1;
5016 #ifdef VMS
5017 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
5018 #endif /* VMS */
5019 Lisp_Object handler;
5020 Lisp_Object visit_file;
5021 Lisp_Object annotations;
5022 Lisp_Object encoded_filename;
5023 int visiting = (EQ (visit, Qt) || STRINGP (visit));
5024 int quietly = !NILP (visit);
5025 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5026 struct buffer *given_buffer;
5027 #ifdef DOS_NT
5028 int buffer_file_type = O_BINARY;
5029 #endif /* DOS_NT */
5030 struct coding_system coding;
5032 if (current_buffer->base_buffer && visiting)
5033 error ("Cannot do file visiting in an indirect buffer");
5035 if (!NILP (start) && !STRINGP (start))
5036 validate_region (&start, &end);
5038 visit_file = Qnil;
5039 GCPRO5 (start, filename, visit, visit_file, lockname);
5041 filename = Fexpand_file_name (filename, Qnil);
5043 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
5044 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
5046 if (STRINGP (visit))
5047 visit_file = Fexpand_file_name (visit, Qnil);
5048 else
5049 visit_file = filename;
5051 if (NILP (lockname))
5052 lockname = visit_file;
5054 annotations = Qnil;
5056 /* If the file name has special constructs in it,
5057 call the corresponding file handler. */
5058 handler = Ffind_file_name_handler (filename, Qwrite_region);
5059 /* If FILENAME has no handler, see if VISIT has one. */
5060 if (NILP (handler) && STRINGP (visit))
5061 handler = Ffind_file_name_handler (visit, Qwrite_region);
5063 if (!NILP (handler))
5065 Lisp_Object val;
5066 val = call6 (handler, Qwrite_region, start, end,
5067 filename, append, visit);
5069 if (visiting)
5071 SAVE_MODIFF = MODIFF;
5072 XSETFASTINT (current_buffer->save_length, Z - BEG);
5073 current_buffer->filename = visit_file;
5075 UNGCPRO;
5076 return val;
5079 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5081 /* Special kludge to simplify auto-saving. */
5082 if (NILP (start))
5084 XSETFASTINT (start, BEG);
5085 XSETFASTINT (end, Z);
5086 Fwiden ();
5089 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5090 count1 = SPECPDL_INDEX ();
5092 given_buffer = current_buffer;
5094 if (!STRINGP (start))
5096 annotations = build_annotations (start, end);
5098 if (current_buffer != given_buffer)
5100 XSETFASTINT (start, BEGV);
5101 XSETFASTINT (end, ZV);
5105 UNGCPRO;
5107 GCPRO5 (start, filename, annotations, visit_file, lockname);
5109 /* Decide the coding-system to encode the data with.
5110 We used to make this choice before calling build_annotations, but that
5111 leads to problems when a write-annotate-function takes care of
5112 unsavable chars (as was the case with X-Symbol). */
5113 Vlast_coding_system_used
5114 = choose_write_coding_system (start, end, filename,
5115 append, visit, lockname, &coding);
5117 #ifdef CLASH_DETECTION
5118 if (!auto_saving)
5120 #if 0 /* This causes trouble for GNUS. */
5121 /* If we've locked this file for some other buffer,
5122 query before proceeding. */
5123 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5124 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5125 #endif
5127 lock_file (lockname);
5129 #endif /* CLASH_DETECTION */
5131 encoded_filename = ENCODE_FILE (filename);
5133 fn = SDATA (encoded_filename);
5134 desc = -1;
5135 if (!NILP (append))
5136 #ifdef DOS_NT
5137 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5138 #else /* not DOS_NT */
5139 desc = emacs_open (fn, O_WRONLY, 0);
5140 #endif /* not DOS_NT */
5142 if (desc < 0 && (NILP (append) || errno == ENOENT))
5143 #ifdef VMS
5144 if (auto_saving) /* Overwrite any previous version of autosave file */
5146 vms_truncate (fn); /* if fn exists, truncate to zero length */
5147 desc = emacs_open (fn, O_RDWR, 0);
5148 if (desc < 0)
5149 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5150 ? SDATA (current_buffer->filename) : 0,
5151 fn);
5153 else /* Write to temporary name and rename if no errors */
5155 Lisp_Object temp_name;
5156 temp_name = Ffile_name_directory (filename);
5158 if (!NILP (temp_name))
5160 temp_name = Fmake_temp_name (concat2 (temp_name,
5161 build_string ("$$SAVE$$")));
5162 fname = SDATA (filename);
5163 fn = SDATA (temp_name);
5164 desc = creat_copy_attrs (fname, fn);
5165 if (desc < 0)
5167 /* If we can't open the temporary file, try creating a new
5168 version of the original file. VMS "creat" creates a
5169 new version rather than truncating an existing file. */
5170 fn = fname;
5171 fname = 0;
5172 desc = creat (fn, 0666);
5173 #if 0 /* This can clobber an existing file and fail to replace it,
5174 if the user runs out of space. */
5175 if (desc < 0)
5177 /* We can't make a new version;
5178 try to truncate and rewrite existing version if any. */
5179 vms_truncate (fn);
5180 desc = emacs_open (fn, O_RDWR, 0);
5182 #endif
5185 else
5186 desc = creat (fn, 0666);
5188 #else /* not VMS */
5189 #ifdef DOS_NT
5190 desc = emacs_open (fn,
5191 O_WRONLY | O_CREAT | buffer_file_type
5192 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5193 S_IREAD | S_IWRITE);
5194 #else /* not DOS_NT */
5195 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5196 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5197 auto_saving ? auto_save_mode_bits : 0666);
5198 #endif /* not DOS_NT */
5199 #endif /* not VMS */
5201 if (desc < 0)
5203 #ifdef CLASH_DETECTION
5204 save_errno = errno;
5205 if (!auto_saving) unlock_file (lockname);
5206 errno = save_errno;
5207 #endif /* CLASH_DETECTION */
5208 UNGCPRO;
5209 report_file_error ("Opening output file", Fcons (filename, Qnil));
5212 record_unwind_protect (close_file_unwind, make_number (desc));
5214 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5216 long ret;
5218 if (NUMBERP (append))
5219 ret = lseek (desc, XINT (append), 1);
5220 else
5221 ret = lseek (desc, 0, 2);
5222 if (ret < 0)
5224 #ifdef CLASH_DETECTION
5225 if (!auto_saving) unlock_file (lockname);
5226 #endif /* CLASH_DETECTION */
5227 UNGCPRO;
5228 report_file_error ("Lseek error", Fcons (filename, Qnil));
5232 UNGCPRO;
5234 #ifdef VMS
5236 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5237 * if we do writes that don't end with a carriage return. Furthermore
5238 * it cannot handle writes of more then 16K. The modified
5239 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5240 * this EXCEPT for the last record (if it doesn't end with a carriage
5241 * return). This implies that if your buffer doesn't end with a carriage
5242 * return, you get one free... tough. However it also means that if
5243 * we make two calls to sys_write (a la the following code) you can
5244 * get one at the gap as well. The easiest way to fix this (honest)
5245 * is to move the gap to the next newline (or the end of the buffer).
5246 * Thus this change.
5248 * Yech!
5250 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5251 move_gap (find_next_newline (GPT, 1));
5252 #else
5253 #if 0
5254 /* The new encoding routine doesn't require the following. */
5256 /* Whether VMS or not, we must move the gap to the next of newline
5257 when we must put designation sequences at beginning of line. */
5258 if (INTEGERP (start)
5259 && coding.type == coding_type_iso2022
5260 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5261 && GPT > BEG && GPT_ADDR[-1] != '\n')
5263 int opoint = PT, opoint_byte = PT_BYTE;
5264 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5265 move_gap_both (PT, PT_BYTE);
5266 SET_PT_BOTH (opoint, opoint_byte);
5268 #endif
5269 #endif
5271 failure = 0;
5272 immediate_quit = 1;
5274 if (STRINGP (start))
5276 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5277 &annotations, &coding);
5278 save_errno = errno;
5280 else if (XINT (start) != XINT (end))
5282 failure = 0 > a_write (desc, Qnil,
5283 XINT (start), XINT (end) - XINT (start),
5284 &annotations, &coding);
5285 save_errno = errno;
5287 else
5289 /* If file was empty, still need to write the annotations */
5290 coding.mode |= CODING_MODE_LAST_BLOCK;
5291 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5292 save_errno = errno;
5295 if (CODING_REQUIRE_FLUSHING (&coding)
5296 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5297 && ! failure)
5299 /* We have to flush out a data. */
5300 coding.mode |= CODING_MODE_LAST_BLOCK;
5301 failure = 0 > e_write (desc, Qnil, 1, 1, &coding);
5302 save_errno = errno;
5305 immediate_quit = 0;
5307 #ifdef HAVE_FSYNC
5308 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5309 Disk full in NFS may be reported here. */
5310 /* mib says that closing the file will try to write as fast as NFS can do
5311 it, and that means the fsync here is not crucial for autosave files. */
5312 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
5314 /* If fsync fails with EINTR, don't treat that as serious. Also
5315 ignore EINVAL which happens when fsync is not supported on this
5316 file. */
5317 if (errno != EINTR && errno != EINVAL)
5318 failure = 1, save_errno = errno;
5320 #endif
5322 /* Spurious "file has changed on disk" warnings have been
5323 observed on Suns as well.
5324 It seems that `close' can change the modtime, under nfs.
5326 (This has supposedly been fixed in Sunos 4,
5327 but who knows about all the other machines with NFS?) */
5328 #if 0
5330 /* On VMS, must do the stat after the close
5331 since closing changes the modtime. */
5332 #ifndef VMS
5333 /* Recall that #if defined does not work on VMS. */
5334 #define FOO
5335 fstat (desc, &st);
5336 #endif
5337 #endif
5339 /* NFS can report a write failure now. */
5340 if (emacs_close (desc) < 0)
5341 failure = 1, save_errno = errno;
5343 #ifdef VMS
5344 /* If we wrote to a temporary name and had no errors, rename to real name. */
5345 if (fname)
5347 if (!failure)
5348 failure = (rename (fn, fname) != 0), save_errno = errno;
5349 fn = fname;
5351 #endif /* VMS */
5353 #ifndef FOO
5354 stat (fn, &st);
5355 #endif
5356 /* Discard the unwind protect for close_file_unwind. */
5357 specpdl_ptr = specpdl + count1;
5358 /* Restore the original current buffer. */
5359 visit_file = unbind_to (count, visit_file);
5361 #ifdef CLASH_DETECTION
5362 if (!auto_saving)
5363 unlock_file (lockname);
5364 #endif /* CLASH_DETECTION */
5366 /* Do this before reporting IO error
5367 to avoid a "file has changed on disk" warning on
5368 next attempt to save. */
5369 if (visiting)
5370 current_buffer->modtime = st.st_mtime;
5372 if (failure)
5373 error ("IO error writing %s: %s", SDATA (filename),
5374 emacs_strerror (save_errno));
5376 if (visiting)
5378 SAVE_MODIFF = MODIFF;
5379 XSETFASTINT (current_buffer->save_length, Z - BEG);
5380 current_buffer->filename = visit_file;
5381 update_mode_lines++;
5383 else if (quietly)
5385 if (auto_saving
5386 && ! NILP (Fstring_equal (current_buffer->filename,
5387 current_buffer->auto_save_file_name)))
5388 SAVE_MODIFF = MODIFF;
5390 return Qnil;
5393 if (!auto_saving)
5394 message_with_string ((INTEGERP (append)
5395 ? "Updated %s"
5396 : ! NILP (append)
5397 ? "Added to %s"
5398 : "Wrote %s"),
5399 visit_file, 1);
5401 return Qnil;
5404 Lisp_Object merge ();
5406 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5407 doc: /* Return t if (car A) is numerically less than (car B). */)
5408 (a, b)
5409 Lisp_Object a, b;
5411 return Flss (Fcar (a), Fcar (b));
5414 /* Build the complete list of annotations appropriate for writing out
5415 the text between START and END, by calling all the functions in
5416 write-region-annotate-functions and merging the lists they return.
5417 If one of these functions switches to a different buffer, we assume
5418 that buffer contains altered text. Therefore, the caller must
5419 make sure to restore the current buffer in all cases,
5420 as save-excursion would do. */
5422 static Lisp_Object
5423 build_annotations (start, end)
5424 Lisp_Object start, end;
5426 Lisp_Object annotations;
5427 Lisp_Object p, res;
5428 struct gcpro gcpro1, gcpro2;
5429 Lisp_Object original_buffer;
5430 int i, used_global = 0;
5432 XSETBUFFER (original_buffer, current_buffer);
5434 annotations = Qnil;
5435 p = Vwrite_region_annotate_functions;
5436 GCPRO2 (annotations, p);
5437 while (CONSP (p))
5439 struct buffer *given_buffer = current_buffer;
5440 if (EQ (Qt, XCAR (p)) && !used_global)
5441 { /* Use the global value of the hook. */
5442 Lisp_Object arg[2];
5443 used_global = 1;
5444 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5445 arg[1] = XCDR (p);
5446 p = Fappend (2, arg);
5447 continue;
5449 Vwrite_region_annotations_so_far = annotations;
5450 res = call2 (XCAR (p), start, end);
5451 /* If the function makes a different buffer current,
5452 assume that means this buffer contains altered text to be output.
5453 Reset START and END from the buffer bounds
5454 and discard all previous annotations because they should have
5455 been dealt with by this function. */
5456 if (current_buffer != given_buffer)
5458 XSETFASTINT (start, BEGV);
5459 XSETFASTINT (end, ZV);
5460 annotations = Qnil;
5462 Flength (res); /* Check basic validity of return value */
5463 annotations = merge (annotations, res, Qcar_less_than_car);
5464 p = XCDR (p);
5467 /* Now do the same for annotation functions implied by the file-format */
5468 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5469 p = current_buffer->auto_save_file_format;
5470 else
5471 p = current_buffer->file_format;
5472 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5474 struct buffer *given_buffer = current_buffer;
5476 Vwrite_region_annotations_so_far = annotations;
5478 /* Value is either a list of annotations or nil if the function
5479 has written annotations to a temporary buffer, which is now
5480 current. */
5481 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5482 original_buffer, make_number (i));
5483 if (current_buffer != given_buffer)
5485 XSETFASTINT (start, BEGV);
5486 XSETFASTINT (end, ZV);
5487 annotations = Qnil;
5490 if (CONSP (res))
5491 annotations = merge (annotations, res, Qcar_less_than_car);
5494 UNGCPRO;
5495 return annotations;
5499 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5500 If STRING is nil, POS is the character position in the current buffer.
5501 Intersperse with them the annotations from *ANNOT
5502 which fall within the range of POS to POS + NCHARS,
5503 each at its appropriate position.
5505 We modify *ANNOT by discarding elements as we use them up.
5507 The return value is negative in case of system call failure. */
5509 static int
5510 a_write (desc, string, pos, nchars, annot, coding)
5511 int desc;
5512 Lisp_Object string;
5513 register int nchars;
5514 int pos;
5515 Lisp_Object *annot;
5516 struct coding_system *coding;
5518 Lisp_Object tem;
5519 int nextpos;
5520 int lastpos = pos + nchars;
5522 while (NILP (*annot) || CONSP (*annot))
5524 tem = Fcar_safe (Fcar (*annot));
5525 nextpos = pos - 1;
5526 if (INTEGERP (tem))
5527 nextpos = XFASTINT (tem);
5529 /* If there are no more annotations in this range,
5530 output the rest of the range all at once. */
5531 if (! (nextpos >= pos && nextpos <= lastpos))
5532 return e_write (desc, string, pos, lastpos, coding);
5534 /* Output buffer text up to the next annotation's position. */
5535 if (nextpos > pos)
5537 if (0 > e_write (desc, string, pos, nextpos, coding))
5538 return -1;
5539 pos = nextpos;
5541 /* Output the annotation. */
5542 tem = Fcdr (Fcar (*annot));
5543 if (STRINGP (tem))
5545 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5546 return -1;
5548 *annot = Fcdr (*annot);
5550 return 0;
5554 /* Write text in the range START and END into descriptor DESC,
5555 encoding them with coding system CODING. If STRING is nil, START
5556 and END are character positions of the current buffer, else they
5557 are indexes to the string STRING. */
5559 static int
5560 e_write (desc, string, start, end, coding)
5561 int desc;
5562 Lisp_Object string;
5563 int start, end;
5564 struct coding_system *coding;
5566 if (STRINGP (string))
5568 start = 0;
5569 end = SCHARS (string);
5572 /* We used to have a code for handling selective display here. But,
5573 now it is handled within encode_coding. */
5575 while (start < end)
5577 if (STRINGP (string))
5579 coding->src_multibyte = SCHARS (string) < SBYTES (string);
5580 if (CODING_REQUIRE_ENCODING (coding))
5582 encode_coding_object (coding, string,
5583 start, string_char_to_byte (string, start),
5584 end, string_char_to_byte (string, end), Qt);
5586 else
5588 coding->dst_object = string;
5589 coding->consumed_char = SCHARS (string);
5590 coding->produced = SBYTES (string);
5593 else
5595 int start_byte = CHAR_TO_BYTE (start);
5596 int end_byte = CHAR_TO_BYTE (end);
5598 coding->src_multibyte = (end - start) < (end_byte - start_byte);
5599 if (CODING_REQUIRE_ENCODING (coding))
5601 encode_coding_object (coding, Fcurrent_buffer (),
5602 start, start_byte, end, end_byte, Qt);
5604 else
5606 coding->dst_object = Qnil;
5607 coding->dst_pos_byte = start_byte;
5608 if (start >= GPT || end <= GPT)
5610 coding->consumed_char = end - start;
5611 coding->produced = end_byte - start_byte;
5613 else
5615 coding->consumed_char = GPT - start;
5616 coding->produced = GPT_BYTE - start_byte;
5621 if (coding->produced > 0)
5623 coding->produced -=
5624 emacs_write (desc,
5625 STRINGP (coding->dst_object)
5626 ? SDATA (coding->dst_object)
5627 : BYTE_POS_ADDR (coding->dst_pos_byte),
5628 coding->produced);
5630 if (coding->produced)
5631 return -1;
5633 start += coding->consumed_char;
5636 return 0;
5639 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5640 Sverify_visited_file_modtime, 1, 1, 0,
5641 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5642 This means that the file has not been changed since it was visited or saved.
5643 See Info node `(elisp)Modification Time' for more details. */)
5644 (buf)
5645 Lisp_Object buf;
5647 struct buffer *b;
5648 struct stat st;
5649 Lisp_Object handler;
5650 Lisp_Object filename;
5652 CHECK_BUFFER (buf);
5653 b = XBUFFER (buf);
5655 if (!STRINGP (b->filename)) return Qt;
5656 if (b->modtime == 0) return Qt;
5658 /* If the file name has special constructs in it,
5659 call the corresponding file handler. */
5660 handler = Ffind_file_name_handler (b->filename,
5661 Qverify_visited_file_modtime);
5662 if (!NILP (handler))
5663 return call2 (handler, Qverify_visited_file_modtime, buf);
5665 filename = ENCODE_FILE (b->filename);
5667 if (stat (SDATA (filename), &st) < 0)
5669 /* If the file doesn't exist now and didn't exist before,
5670 we say that it isn't modified, provided the error is a tame one. */
5671 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5672 st.st_mtime = -1;
5673 else
5674 st.st_mtime = 0;
5676 if (st.st_mtime == b->modtime
5677 /* If both are positive, accept them if they are off by one second. */
5678 || (st.st_mtime > 0 && b->modtime > 0
5679 && (st.st_mtime == b->modtime + 1
5680 || st.st_mtime == b->modtime - 1)))
5681 return Qt;
5682 return Qnil;
5685 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5686 Sclear_visited_file_modtime, 0, 0, 0,
5687 doc: /* Clear out records of last mod time of visited file.
5688 Next attempt to save will certainly not complain of a discrepancy. */)
5691 current_buffer->modtime = 0;
5692 return Qnil;
5695 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5696 Svisited_file_modtime, 0, 0, 0,
5697 doc: /* Return the current buffer's recorded visited file modification time.
5698 The value is a list of the form (HIGH LOW), like the time values
5699 that `file-attributes' returns. If the current buffer has no recorded
5700 file modification time, this function returns 0.
5701 See Info node `(elisp)Modification Time' for more details. */)
5704 if (! current_buffer->modtime)
5705 return make_number (0);
5706 return make_time ((time_t) current_buffer->modtime);
5709 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5710 Sset_visited_file_modtime, 0, 1, 0,
5711 doc: /* Update buffer's recorded modification time from the visited file's time.
5712 Useful if the buffer was not read from the file normally
5713 or if the file itself has been changed for some known benign reason.
5714 An argument specifies the modification time value to use
5715 \(instead of that of the visited file), in the form of a list
5716 \(HIGH . LOW) or (HIGH LOW). */)
5717 (time_list)
5718 Lisp_Object time_list;
5720 if (!NILP (time_list))
5721 current_buffer->modtime = cons_to_long (time_list);
5722 else
5724 register Lisp_Object filename;
5725 struct stat st;
5726 Lisp_Object handler;
5728 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5730 /* If the file name has special constructs in it,
5731 call the corresponding file handler. */
5732 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5733 if (!NILP (handler))
5734 /* The handler can find the file name the same way we did. */
5735 return call2 (handler, Qset_visited_file_modtime, Qnil);
5737 filename = ENCODE_FILE (filename);
5739 if (stat (SDATA (filename), &st) >= 0)
5740 current_buffer->modtime = st.st_mtime;
5743 return Qnil;
5746 Lisp_Object
5747 auto_save_error (error)
5748 Lisp_Object error;
5750 Lisp_Object args[3], msg;
5751 int i, nbytes;
5752 struct gcpro gcpro1;
5753 char *msgbuf;
5754 USE_SAFE_ALLOCA;
5756 auto_save_error_occurred = 1;
5758 ring_bell (XFRAME (selected_frame));
5760 args[0] = build_string ("Auto-saving %s: %s");
5761 args[1] = current_buffer->name;
5762 args[2] = Ferror_message_string (error);
5763 msg = Fformat (3, args);
5764 GCPRO1 (msg);
5765 nbytes = SBYTES (msg);
5766 SAFE_ALLOCA (msgbuf, char *, nbytes);
5767 bcopy (SDATA (msg), msgbuf, nbytes);
5769 for (i = 0; i < 3; ++i)
5771 if (i == 0)
5772 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5773 else
5774 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5775 Fsleep_for (make_number (1), Qnil);
5778 SAFE_FREE ();
5779 UNGCPRO;
5780 return Qnil;
5783 Lisp_Object
5784 auto_save_1 ()
5786 struct stat st;
5787 Lisp_Object modes;
5789 auto_save_mode_bits = 0666;
5791 /* Get visited file's mode to become the auto save file's mode. */
5792 if (! NILP (current_buffer->filename))
5794 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5795 /* But make sure we can overwrite it later! */
5796 auto_save_mode_bits = st.st_mode | 0600;
5797 else if ((modes = Ffile_modes (current_buffer->filename),
5798 INTEGERP (modes)))
5799 /* Remote files don't cooperate with stat. */
5800 auto_save_mode_bits = XINT (modes) | 0600;
5803 return
5804 Fwrite_region (Qnil, Qnil,
5805 current_buffer->auto_save_file_name,
5806 Qnil, Qlambda, Qnil, Qnil);
5809 static Lisp_Object
5810 do_auto_save_unwind (arg) /* used as unwind-protect function */
5811 Lisp_Object arg;
5813 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5814 auto_saving = 0;
5815 if (stream != NULL)
5817 BLOCK_INPUT;
5818 fclose (stream);
5819 UNBLOCK_INPUT;
5821 return Qnil;
5824 static Lisp_Object
5825 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5826 Lisp_Object value;
5828 minibuffer_auto_raise = XINT (value);
5829 return Qnil;
5832 static Lisp_Object
5833 do_auto_save_make_dir (dir)
5834 Lisp_Object dir;
5836 Lisp_Object mode;
5838 call2 (Qmake_directory, dir, Qt);
5839 XSETFASTINT (mode, 0700);
5840 return Fset_file_modes (dir, mode);
5843 static Lisp_Object
5844 do_auto_save_eh (ignore)
5845 Lisp_Object ignore;
5847 return Qnil;
5850 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5851 doc: /* Auto-save all buffers that need it.
5852 This is all buffers that have auto-saving enabled
5853 and are changed since last auto-saved.
5854 Auto-saving writes the buffer into a file
5855 so that your editing is not lost if the system crashes.
5856 This file is not the file you visited; that changes only when you save.
5857 Normally we run the normal hook `auto-save-hook' before saving.
5859 A non-nil NO-MESSAGE argument means do not print any message if successful.
5860 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5861 (no_message, current_only)
5862 Lisp_Object no_message, current_only;
5864 struct buffer *old = current_buffer, *b;
5865 Lisp_Object tail, buf;
5866 int auto_saved = 0;
5867 int do_handled_files;
5868 Lisp_Object oquit;
5869 FILE *stream = NULL;
5870 int count = SPECPDL_INDEX ();
5871 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5872 int old_message_p = 0;
5873 struct gcpro gcpro1, gcpro2;
5875 if (max_specpdl_size < specpdl_size + 40)
5876 max_specpdl_size = specpdl_size + 40;
5878 if (minibuf_level)
5879 no_message = Qt;
5881 if (NILP (no_message))
5883 old_message_p = push_message ();
5884 record_unwind_protect (pop_message_unwind, Qnil);
5887 /* Ordinarily don't quit within this function,
5888 but don't make it impossible to quit (in case we get hung in I/O). */
5889 oquit = Vquit_flag;
5890 Vquit_flag = Qnil;
5892 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5893 point to non-strings reached from Vbuffer_alist. */
5895 if (!NILP (Vrun_hooks))
5896 call1 (Vrun_hooks, intern ("auto-save-hook"));
5898 if (STRINGP (Vauto_save_list_file_name))
5900 Lisp_Object listfile;
5902 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5904 /* Don't try to create the directory when shutting down Emacs,
5905 because creating the directory might signal an error, and
5906 that would leave Emacs in a strange state. */
5907 if (!NILP (Vrun_hooks))
5909 Lisp_Object dir;
5910 dir = Qnil;
5911 GCPRO2 (dir, listfile);
5912 dir = Ffile_name_directory (listfile);
5913 if (NILP (Ffile_directory_p (dir)))
5914 internal_condition_case_1 (do_auto_save_make_dir,
5915 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5916 do_auto_save_eh);
5917 UNGCPRO;
5920 stream = fopen (SDATA (listfile), "w");
5923 record_unwind_protect (do_auto_save_unwind,
5924 make_save_value (stream, 0));
5925 record_unwind_protect (do_auto_save_unwind_1,
5926 make_number (minibuffer_auto_raise));
5927 minibuffer_auto_raise = 0;
5928 auto_saving = 1;
5929 auto_save_error_occurred = 0;
5931 /* On first pass, save all files that don't have handlers.
5932 On second pass, save all files that do have handlers.
5934 If Emacs is crashing, the handlers may tweak what is causing
5935 Emacs to crash in the first place, and it would be a shame if
5936 Emacs failed to autosave perfectly ordinary files because it
5937 couldn't handle some ange-ftp'd file. */
5939 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5940 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
5942 buf = XCDR (XCAR (tail));
5943 b = XBUFFER (buf);
5945 /* Record all the buffers that have auto save mode
5946 in the special file that lists them. For each of these buffers,
5947 Record visited name (if any) and auto save name. */
5948 if (STRINGP (b->auto_save_file_name)
5949 && stream != NULL && do_handled_files == 0)
5951 BLOCK_INPUT;
5952 if (!NILP (b->filename))
5954 fwrite (SDATA (b->filename), 1,
5955 SBYTES (b->filename), stream);
5957 putc ('\n', stream);
5958 fwrite (SDATA (b->auto_save_file_name), 1,
5959 SBYTES (b->auto_save_file_name), stream);
5960 putc ('\n', stream);
5961 UNBLOCK_INPUT;
5964 if (!NILP (current_only)
5965 && b != current_buffer)
5966 continue;
5968 /* Don't auto-save indirect buffers.
5969 The base buffer takes care of it. */
5970 if (b->base_buffer)
5971 continue;
5973 /* Check for auto save enabled
5974 and file changed since last auto save
5975 and file changed since last real save. */
5976 if (STRINGP (b->auto_save_file_name)
5977 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5978 && b->auto_save_modified < BUF_MODIFF (b)
5979 /* -1 means we've turned off autosaving for a while--see below. */
5980 && XINT (b->save_length) >= 0
5981 && (do_handled_files
5982 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5983 Qwrite_region))))
5985 EMACS_TIME before_time, after_time;
5987 EMACS_GET_TIME (before_time);
5989 /* If we had a failure, don't try again for 20 minutes. */
5990 if (b->auto_save_failure_time >= 0
5991 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5992 continue;
5994 if ((XFASTINT (b->save_length) * 10
5995 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5996 /* A short file is likely to change a large fraction;
5997 spare the user annoying messages. */
5998 && XFASTINT (b->save_length) > 5000
5999 /* These messages are frequent and annoying for `*mail*'. */
6000 && !EQ (b->filename, Qnil)
6001 && NILP (no_message))
6003 /* It has shrunk too much; turn off auto-saving here. */
6004 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6005 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6006 b->name, 1);
6007 minibuffer_auto_raise = 0;
6008 /* Turn off auto-saving until there's a real save,
6009 and prevent any more warnings. */
6010 XSETINT (b->save_length, -1);
6011 Fsleep_for (make_number (1), Qnil);
6012 continue;
6014 set_buffer_internal (b);
6015 if (!auto_saved && NILP (no_message))
6016 message1 ("Auto-saving...");
6017 internal_condition_case (auto_save_1, Qt, auto_save_error);
6018 auto_saved++;
6019 b->auto_save_modified = BUF_MODIFF (b);
6020 XSETFASTINT (current_buffer->save_length, Z - BEG);
6021 set_buffer_internal (old);
6023 EMACS_GET_TIME (after_time);
6025 /* If auto-save took more than 60 seconds,
6026 assume it was an NFS failure that got a timeout. */
6027 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6028 b->auto_save_failure_time = EMACS_SECS (after_time);
6032 /* Prevent another auto save till enough input events come in. */
6033 record_auto_save ();
6035 if (auto_saved && NILP (no_message))
6037 if (old_message_p)
6039 /* If we are going to restore an old message,
6040 give time to read ours. */
6041 sit_for (make_number (1), 0, 0);
6042 restore_message ();
6044 else if (!auto_save_error_occurred)
6045 /* Don't overwrite the error message if an error occurred.
6046 If we displayed a message and then restored a state
6047 with no message, leave a "done" message on the screen. */
6048 message1 ("Auto-saving...done");
6051 Vquit_flag = oquit;
6053 /* This restores the message-stack status. */
6054 unbind_to (count, Qnil);
6055 return Qnil;
6058 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6059 Sset_buffer_auto_saved, 0, 0, 0,
6060 doc: /* Mark current buffer as auto-saved with its current text.
6061 No auto-save file will be written until the buffer changes again. */)
6064 current_buffer->auto_save_modified = MODIFF;
6065 XSETFASTINT (current_buffer->save_length, Z - BEG);
6066 current_buffer->auto_save_failure_time = -1;
6067 return Qnil;
6070 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6071 Sclear_buffer_auto_save_failure, 0, 0, 0,
6072 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6075 current_buffer->auto_save_failure_time = -1;
6076 return Qnil;
6079 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6080 0, 0, 0,
6081 doc: /* Return t if current buffer has been auto-saved recently.
6082 More precisely, if it has been auto-saved since last read from or saved
6083 in the visited file. If the buffer has no visited file,
6084 then any auto-save counts as "recent". */)
6087 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6090 /* Reading and completing file names */
6091 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6092 extern Lisp_Object Qcompletion_ignore_case;
6094 /* In the string VAL, change each $ to $$ and return the result. */
6096 static Lisp_Object
6097 double_dollars (val)
6098 Lisp_Object val;
6100 register const unsigned char *old;
6101 register unsigned char *new;
6102 register int n;
6103 int osize, count;
6105 osize = SBYTES (val);
6107 /* Count the number of $ characters. */
6108 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6109 if (*old++ == '$') count++;
6110 if (count > 0)
6112 old = SDATA (val);
6113 val = make_uninit_multibyte_string (SCHARS (val) + count,
6114 osize + count);
6115 new = SDATA (val);
6116 for (n = osize; n > 0; n--)
6117 if (*old != '$')
6118 *new++ = *old++;
6119 else
6121 *new++ = '$';
6122 *new++ = '$';
6123 old++;
6126 return val;
6129 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6130 Snext_read_file_uses_dialog_p, 0, 0, 0,
6131 doc: /* Return t if a call to `read-file-name' will use a dialog.
6132 The return value is only relevant for a call to `read-file-name' that happens
6133 before any other event (mouse or keypress) is handeled. */)
6136 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6137 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6138 && use_dialog_box
6139 && use_file_dialog
6140 && have_menus_p ())
6141 return Qt;
6142 #endif
6143 return Qnil;
6146 Lisp_Object
6147 Fread_file_name (prompt, dir, default_filename, mustmatch, initial, predicate)
6148 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6150 struct gcpro gcpro1, gcpro2;
6151 Lisp_Object args[7];
6153 GCPRO2 (insdef, default_filename);
6154 args[0] = intern ("read-file-name");
6155 args[1] = prompt;
6156 args[2] = dir;
6157 args[3] = default_filename;
6158 args[4] = mustmatch;
6159 args[5] = initial;
6160 args[6] = predicate;
6161 RETURN_UNGCPRO (Ffuncall (7, args));
6165 void
6166 init_fileio_once ()
6168 /* Must be set before any path manipulation is performed. */
6169 XSETFASTINT (Vdirectory_sep_char, '/');
6173 void
6174 syms_of_fileio ()
6176 Qoperations = intern ("operations");
6177 Qexpand_file_name = intern ("expand-file-name");
6178 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6179 Qdirectory_file_name = intern ("directory-file-name");
6180 Qfile_name_directory = intern ("file-name-directory");
6181 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6182 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6183 Qfile_name_as_directory = intern ("file-name-as-directory");
6184 Qcopy_file = intern ("copy-file");
6185 Qmake_directory_internal = intern ("make-directory-internal");
6186 Qmake_directory = intern ("make-directory");
6187 Qdelete_directory = intern ("delete-directory");
6188 Qdelete_file = intern ("delete-file");
6189 Qrename_file = intern ("rename-file");
6190 Qadd_name_to_file = intern ("add-name-to-file");
6191 Qmake_symbolic_link = intern ("make-symbolic-link");
6192 Qfile_exists_p = intern ("file-exists-p");
6193 Qfile_executable_p = intern ("file-executable-p");
6194 Qfile_readable_p = intern ("file-readable-p");
6195 Qfile_writable_p = intern ("file-writable-p");
6196 Qfile_symlink_p = intern ("file-symlink-p");
6197 Qaccess_file = intern ("access-file");
6198 Qfile_directory_p = intern ("file-directory-p");
6199 Qfile_regular_p = intern ("file-regular-p");
6200 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6201 Qfile_modes = intern ("file-modes");
6202 Qset_file_modes = intern ("set-file-modes");
6203 Qset_file_times = intern ("set-file-times");
6204 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6205 Qinsert_file_contents = intern ("insert-file-contents");
6206 Qwrite_region = intern ("write-region");
6207 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6208 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6209 Qauto_save_coding = intern ("auto-save-coding");
6211 staticpro (&Qoperations);
6212 staticpro (&Qexpand_file_name);
6213 staticpro (&Qsubstitute_in_file_name);
6214 staticpro (&Qdirectory_file_name);
6215 staticpro (&Qfile_name_directory);
6216 staticpro (&Qfile_name_nondirectory);
6217 staticpro (&Qunhandled_file_name_directory);
6218 staticpro (&Qfile_name_as_directory);
6219 staticpro (&Qcopy_file);
6220 staticpro (&Qmake_directory_internal);
6221 staticpro (&Qmake_directory);
6222 staticpro (&Qdelete_directory);
6223 staticpro (&Qdelete_file);
6224 staticpro (&Qrename_file);
6225 staticpro (&Qadd_name_to_file);
6226 staticpro (&Qmake_symbolic_link);
6227 staticpro (&Qfile_exists_p);
6228 staticpro (&Qfile_executable_p);
6229 staticpro (&Qfile_readable_p);
6230 staticpro (&Qfile_writable_p);
6231 staticpro (&Qaccess_file);
6232 staticpro (&Qfile_symlink_p);
6233 staticpro (&Qfile_directory_p);
6234 staticpro (&Qfile_regular_p);
6235 staticpro (&Qfile_accessible_directory_p);
6236 staticpro (&Qfile_modes);
6237 staticpro (&Qset_file_modes);
6238 staticpro (&Qset_file_times);
6239 staticpro (&Qfile_newer_than_file_p);
6240 staticpro (&Qinsert_file_contents);
6241 staticpro (&Qwrite_region);
6242 staticpro (&Qverify_visited_file_modtime);
6243 staticpro (&Qset_visited_file_modtime);
6244 staticpro (&Qauto_save_coding);
6246 Qfile_name_history = intern ("file-name-history");
6247 Fset (Qfile_name_history, Qnil);
6248 staticpro (&Qfile_name_history);
6250 Qfile_error = intern ("file-error");
6251 staticpro (&Qfile_error);
6252 Qfile_already_exists = intern ("file-already-exists");
6253 staticpro (&Qfile_already_exists);
6254 Qfile_date_error = intern ("file-date-error");
6255 staticpro (&Qfile_date_error);
6256 Qexcl = intern ("excl");
6257 staticpro (&Qexcl);
6259 #ifdef DOS_NT
6260 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6261 staticpro (&Qfind_buffer_file_type);
6262 #endif /* DOS_NT */
6264 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6265 doc: /* *Coding system for encoding file names.
6266 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6267 Vfile_name_coding_system = Qnil;
6269 DEFVAR_LISP ("default-file-name-coding-system",
6270 &Vdefault_file_name_coding_system,
6271 doc: /* Default coding system for encoding file names.
6272 This variable is used only when `file-name-coding-system' is nil.
6274 This variable is set/changed by the command `set-language-environment'.
6275 User should not set this variable manually,
6276 instead use `file-name-coding-system' to get a constant encoding
6277 of file names regardless of the current language environment. */);
6278 Vdefault_file_name_coding_system = Qnil;
6280 Qformat_decode = intern ("format-decode");
6281 staticpro (&Qformat_decode);
6282 Qformat_annotate_function = intern ("format-annotate-function");
6283 staticpro (&Qformat_annotate_function);
6284 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6285 staticpro (&Qafter_insert_file_set_coding);
6287 Qcar_less_than_car = intern ("car-less-than-car");
6288 staticpro (&Qcar_less_than_car);
6290 Fput (Qfile_error, Qerror_conditions,
6291 list2 (Qfile_error, Qerror));
6292 Fput (Qfile_error, Qerror_message,
6293 build_string ("File error"));
6295 Fput (Qfile_already_exists, Qerror_conditions,
6296 list3 (Qfile_already_exists, Qfile_error, Qerror));
6297 Fput (Qfile_already_exists, Qerror_message,
6298 build_string ("File already exists"));
6300 Fput (Qfile_date_error, Qerror_conditions,
6301 list3 (Qfile_date_error, Qfile_error, Qerror));
6302 Fput (Qfile_date_error, Qerror_message,
6303 build_string ("Cannot set file date"));
6305 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6306 doc: /* *Non-nil means write new files with record format `stmlf'.
6307 nil means use format `var'. This variable is meaningful only on VMS. */);
6308 vms_stmlf_recfm = 0;
6310 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6311 doc: /* Directory separator character for built-in functions that return file names.
6312 The value is always ?/. Don't use this variable, just use `/'. */);
6314 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6315 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6316 If a file name matches REGEXP, then all I/O on that file is done by calling
6317 HANDLER.
6319 The first argument given to HANDLER is the name of the I/O primitive
6320 to be handled; the remaining arguments are the arguments that were
6321 passed to that primitive. For example, if you do
6322 (file-exists-p FILENAME)
6323 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6324 (funcall HANDLER 'file-exists-p FILENAME)
6325 The function `find-file-name-handler' checks this list for a handler
6326 for its argument. */);
6327 Vfile_name_handler_alist = Qnil;
6329 DEFVAR_LISP ("set-auto-coding-function",
6330 &Vset_auto_coding_function,
6331 doc: /* If non-nil, a function to call to decide a coding system of file.
6332 Two arguments are passed to this function: the file name
6333 and the length of a file contents following the point.
6334 This function should return a coding system to decode the file contents.
6335 It should check the file name against `auto-coding-alist'.
6336 If no coding system is decided, it should check a coding system
6337 specified in the heading lines with the format:
6338 -*- ... coding: CODING-SYSTEM; ... -*-
6339 or local variable spec of the tailing lines with `coding:' tag. */);
6340 Vset_auto_coding_function = Qnil;
6342 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6343 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6344 Each is passed one argument, the number of characters inserted,
6345 with point at the start of the inserted text. Each function
6346 should leave point the same, and return the new character count.
6347 If `insert-file-contents' is intercepted by a handler from
6348 `file-name-handler-alist', that handler is responsible for calling the
6349 functions in `after-insert-file-functions' if appropriate. */);
6350 Vafter_insert_file_functions = Qnil;
6352 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6353 doc: /* A list of functions to be called at the start of `write-region'.
6354 Each is passed two arguments, START and END as for `write-region'.
6355 These are usually two numbers but not always; see the documentation
6356 for `write-region'. The function should return a list of pairs
6357 of the form (POSITION . STRING), consisting of strings to be effectively
6358 inserted at the specified positions of the file being written (1 means to
6359 insert before the first byte written). The POSITIONs must be sorted into
6360 increasing order. If there are several functions in the list, the several
6361 lists are merged destructively. Alternatively, the function can return
6362 with a different buffer current; in that case it should pay attention
6363 to the annotations returned by previous functions and listed in
6364 `write-region-annotations-so-far'.*/);
6365 Vwrite_region_annotate_functions = Qnil;
6366 staticpro (&Qwrite_region_annotate_functions);
6367 Qwrite_region_annotate_functions
6368 = intern ("write-region-annotate-functions");
6370 DEFVAR_LISP ("write-region-annotations-so-far",
6371 &Vwrite_region_annotations_so_far,
6372 doc: /* When an annotation function is called, this holds the previous annotations.
6373 These are the annotations made by other annotation functions
6374 that were already called. See also `write-region-annotate-functions'. */);
6375 Vwrite_region_annotations_so_far = Qnil;
6377 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6378 doc: /* A list of file name handlers that temporarily should not be used.
6379 This applies only to the operation `inhibit-file-name-operation'. */);
6380 Vinhibit_file_name_handlers = Qnil;
6382 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6383 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6384 Vinhibit_file_name_operation = Qnil;
6386 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6387 doc: /* File name in which we write a list of all auto save file names.
6388 This variable is initialized automatically from `auto-save-list-file-prefix'
6389 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6390 a non-nil value. */);
6391 Vauto_save_list_file_name = Qnil;
6393 #ifdef HAVE_FSYNC
6394 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
6395 doc: /* *Non-nil means don't call fsync in `write-region'.
6396 This variable affects calls to `write-region' as well as save commands.
6397 A non-nil value may result in data loss! */);
6398 write_region_inhibit_fsync = 0;
6399 #endif
6401 defsubr (&Sfind_file_name_handler);
6402 defsubr (&Sfile_name_directory);
6403 defsubr (&Sfile_name_nondirectory);
6404 defsubr (&Sunhandled_file_name_directory);
6405 defsubr (&Sfile_name_as_directory);
6406 defsubr (&Sdirectory_file_name);
6407 defsubr (&Smake_temp_name);
6408 defsubr (&Sexpand_file_name);
6409 defsubr (&Ssubstitute_in_file_name);
6410 defsubr (&Scopy_file);
6411 defsubr (&Smake_directory_internal);
6412 defsubr (&Sdelete_directory);
6413 defsubr (&Sdelete_file);
6414 defsubr (&Srename_file);
6415 defsubr (&Sadd_name_to_file);
6416 defsubr (&Smake_symbolic_link);
6417 #ifdef VMS
6418 defsubr (&Sdefine_logical_name);
6419 #endif /* VMS */
6420 #ifdef HPUX_NET
6421 defsubr (&Ssysnetunam);
6422 #endif /* HPUX_NET */
6423 defsubr (&Sfile_name_absolute_p);
6424 defsubr (&Sfile_exists_p);
6425 defsubr (&Sfile_executable_p);
6426 defsubr (&Sfile_readable_p);
6427 defsubr (&Sfile_writable_p);
6428 defsubr (&Saccess_file);
6429 defsubr (&Sfile_symlink_p);
6430 defsubr (&Sfile_directory_p);
6431 defsubr (&Sfile_accessible_directory_p);
6432 defsubr (&Sfile_regular_p);
6433 defsubr (&Sfile_modes);
6434 defsubr (&Sset_file_modes);
6435 defsubr (&Sset_file_times);
6436 defsubr (&Sset_default_file_modes);
6437 defsubr (&Sdefault_file_modes);
6438 defsubr (&Sfile_newer_than_file_p);
6439 defsubr (&Sinsert_file_contents);
6440 defsubr (&Swrite_region);
6441 defsubr (&Scar_less_than_car);
6442 defsubr (&Sverify_visited_file_modtime);
6443 defsubr (&Sclear_visited_file_modtime);
6444 defsubr (&Svisited_file_modtime);
6445 defsubr (&Sset_visited_file_modtime);
6446 defsubr (&Sdo_auto_save);
6447 defsubr (&Sset_buffer_auto_saved);
6448 defsubr (&Sclear_buffer_auto_save_failure);
6449 defsubr (&Srecent_auto_save_p);
6451 defsubr (&Snext_read_file_uses_dialog_p);
6453 #ifdef HAVE_SYNC
6454 defsubr (&Sunix_sync);
6455 #endif
6458 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6459 (do not change this comment) */