*** empty log message ***
[emacs.git] / src / fileio.c
blob511cca59fdb7818593f9af2196dfe2a721acef04
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>
25 #ifdef HAVE_FCNTL_H
26 #include <fcntl.h>
27 #endif
29 #include <stdio.h>
30 #include <sys/types.h>
31 #include <sys/stat.h>
33 #ifdef HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
37 #if !defined (S_ISLNK) && defined (S_IFLNK)
38 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
39 #endif
41 #if !defined (S_ISFIFO) && defined (S_IFIFO)
42 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
43 #endif
45 #if !defined (S_ISREG) && defined (S_IFREG)
46 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
47 #endif
49 #ifdef HAVE_PWD_H
50 #include <pwd.h>
51 #endif
53 #include <ctype.h>
55 #ifdef VMS
56 #include "vmsdir.h"
57 #include <perror.h>
58 #include <stddef.h>
59 #include <string.h>
60 #endif
62 #include <errno.h>
64 #ifndef vax11c
65 #ifndef USE_CRT_DLL
66 extern int errno;
67 #endif
68 #endif
70 #ifdef APOLLO
71 #include <sys/time.h>
72 #endif
74 #include "lisp.h"
75 #include "intervals.h"
76 #include "buffer.h"
77 #include "charset.h"
78 #include "coding.h"
79 #include "window.h"
80 #include "blockinput.h"
82 #ifdef WINDOWSNT
83 #define NOMINMAX 1
84 #include <windows.h>
85 #include <stdlib.h>
86 #include <fcntl.h>
87 #endif /* not WINDOWSNT */
89 #ifdef MSDOS
90 #include "msdos.h"
91 #include <sys/param.h>
92 #if __DJGPP__ >= 2
93 #include <fcntl.h>
94 #include <string.h>
95 #endif
96 #endif
98 #ifdef DOS_NT
99 #define CORRECT_DIR_SEPS(s) \
100 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
101 else unixtodos_filename (s); \
102 } while (0)
103 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
104 redirector allows the six letters between 'Z' and 'a' as well. */
105 #ifdef MSDOS
106 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
107 #endif
108 #ifdef WINDOWSNT
109 #define IS_DRIVE(x) isalpha (x)
110 #endif
111 /* Need to lower-case the drive letter, or else expanded
112 filenames will sometimes compare inequal, because
113 `expand-file-name' doesn't always down-case the drive letter. */
114 #define DRIVE_LETTER(x) (tolower (x))
115 #endif
117 #ifdef VMS
118 #include <file.h>
119 #include <rmsdef.h>
120 #include <fab.h>
121 #include <nam.h>
122 #endif
124 #include "systime.h"
126 #ifdef HPUX
127 #include <netio.h>
128 #ifndef HPUX8
129 #ifndef HPUX9
130 #include <errnet.h>
131 #endif
132 #endif
133 #endif
135 #include "commands.h"
136 extern int use_dialog_box;
137 extern int use_file_dialog;
139 #ifndef O_WRONLY
140 #define O_WRONLY 1
141 #endif
143 #ifndef O_RDONLY
144 #define O_RDONLY 0
145 #endif
147 #ifndef S_ISLNK
148 # define lstat stat
149 #endif
151 #ifndef FILE_SYSTEM_CASE
152 #define FILE_SYSTEM_CASE(filename) (filename)
153 #endif
155 /* Nonzero during writing of auto-save files */
156 int auto_saving;
158 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
159 a new file with the same mode as the original */
160 int auto_save_mode_bits;
162 /* Set by auto_save_1 if an error occurred during the last auto-save. */
163 int auto_save_error_occurred;
165 /* The symbol bound to coding-system-for-read when
166 insert-file-contents is called for recovering a file. This is not
167 an actual coding system name, but just an indicator to tell
168 insert-file-contents to use `emacs-mule' with a special flag for
169 auto saving and recovering a file. */
170 Lisp_Object Qauto_save_coding;
172 /* Coding system for file names, or nil if none. */
173 Lisp_Object Vfile_name_coding_system;
175 /* Coding system for file names used only when
176 Vfile_name_coding_system is nil. */
177 Lisp_Object Vdefault_file_name_coding_system;
179 /* Alist of elements (REGEXP . HANDLER) for file names
180 whose I/O is done with a special handler. */
181 Lisp_Object Vfile_name_handler_alist;
183 /* Property name of a file name handler,
184 which gives a list of operations it handles.. */
185 Lisp_Object Qoperations;
187 /* Lisp functions for translating file formats */
188 Lisp_Object Qformat_decode, Qformat_annotate_function;
190 /* Function to be called to decide a coding system of a reading file. */
191 Lisp_Object Vset_auto_coding_function;
193 /* Functions to be called to process text properties in inserted file. */
194 Lisp_Object Vafter_insert_file_functions;
196 /* Lisp function for setting buffer-file-coding-system and the
197 multibyteness of the current buffer after inserting a file. */
198 Lisp_Object Qafter_insert_file_set_coding;
200 /* Functions to be called to create text property annotations for file. */
201 Lisp_Object Vwrite_region_annotate_functions;
202 Lisp_Object Qwrite_region_annotate_functions;
204 /* During build_annotations, each time an annotation function is called,
205 this holds the annotations made by the previous functions. */
206 Lisp_Object Vwrite_region_annotations_so_far;
208 /* File name in which we write a list of all our auto save files. */
209 Lisp_Object Vauto_save_list_file_name;
211 /* Function to call to read a file name. */
212 Lisp_Object Vread_file_name_function;
214 /* Current predicate used by read_file_name_internal. */
215 Lisp_Object Vread_file_name_predicate;
217 /* Nonzero means completion ignores case when reading file name. */
218 int read_file_name_completion_ignore_case;
220 /* Nonzero means, when reading a filename in the minibuffer,
221 start out by inserting the default directory into the minibuffer. */
222 int insert_default_directory;
224 /* On VMS, nonzero means write new files with record format stmlf.
225 Zero means use var format. */
226 int vms_stmlf_recfm;
228 /* On NT, specifies the directory separator character, used (eg.) when
229 expanding file names. This can be bound to / or \. */
230 Lisp_Object Vdirectory_sep_char;
232 #ifdef HAVE_FSYNC
233 /* Nonzero means skip the call to fsync in Fwrite-region. */
234 int write_region_inhibit_fsync;
235 #endif
237 extern Lisp_Object Vuser_login_name;
239 #ifdef WINDOWSNT
240 extern Lisp_Object Vw32_get_true_file_attributes;
241 #endif
243 extern int minibuf_level;
245 extern int minibuffer_auto_raise;
247 extern int history_delete_duplicates;
249 /* These variables describe handlers that have "already" had a chance
250 to handle the current operation.
252 Vinhibit_file_name_handlers is a list of file name handlers.
253 Vinhibit_file_name_operation is the operation being handled.
254 If we try to handle that operation, we ignore those handlers. */
256 static Lisp_Object Vinhibit_file_name_handlers;
257 static Lisp_Object Vinhibit_file_name_operation;
259 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
260 Lisp_Object Qexcl;
261 Lisp_Object Qfile_name_history;
263 Lisp_Object Qcar_less_than_car;
265 static int a_write P_ ((int, Lisp_Object, int, int,
266 Lisp_Object *, struct coding_system *));
267 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
270 void
271 report_file_error (string, data)
272 const char *string;
273 Lisp_Object data;
275 Lisp_Object errstring;
276 int errorno = errno;
278 synchronize_system_messages_locale ();
279 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
280 Vlocale_coding_system, 0);
282 while (1)
283 switch (errorno)
285 case EEXIST:
286 xsignal (Qfile_already_exists, Fcons (errstring, data));
287 break;
288 default:
289 /* System error messages are capitalized. Downcase the initial
290 unless it is followed by a slash. */
291 if (SREF (errstring, 1) != '/')
292 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
294 xsignal (Qfile_error,
295 Fcons (build_string (string), Fcons (errstring, data)));
299 Lisp_Object
300 close_file_unwind (fd)
301 Lisp_Object fd;
303 emacs_close (XFASTINT (fd));
304 return Qnil;
307 /* Restore point, having saved it as a marker. */
309 static Lisp_Object
310 restore_point_unwind (location)
311 Lisp_Object location;
313 Fgoto_char (location);
314 Fset_marker (location, Qnil, Qnil);
315 return Qnil;
318 Lisp_Object Qexpand_file_name;
319 Lisp_Object Qsubstitute_in_file_name;
320 Lisp_Object Qdirectory_file_name;
321 Lisp_Object Qfile_name_directory;
322 Lisp_Object Qfile_name_nondirectory;
323 Lisp_Object Qunhandled_file_name_directory;
324 Lisp_Object Qfile_name_as_directory;
325 Lisp_Object Qcopy_file;
326 Lisp_Object Qmake_directory_internal;
327 Lisp_Object Qmake_directory;
328 Lisp_Object Qdelete_directory;
329 Lisp_Object Qdelete_file;
330 Lisp_Object Qrename_file;
331 Lisp_Object Qadd_name_to_file;
332 Lisp_Object Qmake_symbolic_link;
333 Lisp_Object Qfile_exists_p;
334 Lisp_Object Qfile_executable_p;
335 Lisp_Object Qfile_readable_p;
336 Lisp_Object Qfile_writable_p;
337 Lisp_Object Qfile_symlink_p;
338 Lisp_Object Qaccess_file;
339 Lisp_Object Qfile_directory_p;
340 Lisp_Object Qfile_regular_p;
341 Lisp_Object Qfile_accessible_directory_p;
342 Lisp_Object Qfile_modes;
343 Lisp_Object Qset_file_modes;
344 Lisp_Object Qset_file_times;
345 Lisp_Object Qfile_newer_than_file_p;
346 Lisp_Object Qinsert_file_contents;
347 Lisp_Object Qwrite_region;
348 Lisp_Object Qverify_visited_file_modtime;
349 Lisp_Object Qset_visited_file_modtime;
351 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
352 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
353 Otherwise, return nil.
354 A file name is handled if one of the regular expressions in
355 `file-name-handler-alist' matches it.
357 If OPERATION equals `inhibit-file-name-operation', then we ignore
358 any handlers that are members of `inhibit-file-name-handlers',
359 but we still do run any other handlers. This lets handlers
360 use the standard functions without calling themselves recursively. */)
361 (filename, operation)
362 Lisp_Object filename, operation;
364 /* This function must not munge the match data. */
365 Lisp_Object chain, inhibited_handlers, result;
366 int pos = -1;
368 result = Qnil;
369 CHECK_STRING (filename);
371 if (EQ (operation, Vinhibit_file_name_operation))
372 inhibited_handlers = Vinhibit_file_name_handlers;
373 else
374 inhibited_handlers = Qnil;
376 for (chain = Vfile_name_handler_alist; CONSP (chain);
377 chain = XCDR (chain))
379 Lisp_Object elt;
380 elt = XCAR (chain);
381 if (CONSP (elt))
383 Lisp_Object string = XCAR (elt);
384 int match_pos;
385 Lisp_Object handler = XCDR (elt);
386 Lisp_Object operations = Qnil;
388 if (SYMBOLP (handler))
389 operations = Fget (handler, Qoperations);
391 if (STRINGP (string)
392 && (match_pos = fast_string_match (string, filename)) > pos
393 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
395 Lisp_Object tem;
397 handler = XCDR (elt);
398 tem = Fmemq (handler, inhibited_handlers);
399 if (NILP (tem))
401 result = handler;
402 pos = match_pos;
407 QUIT;
409 return result;
412 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
413 1, 1, 0,
414 doc: /* Return the directory component in file name FILENAME.
415 Return nil if FILENAME does not include a directory.
416 Otherwise return a directory name.
417 Given a Unix syntax file name, returns a string ending in slash;
418 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
419 (filename)
420 Lisp_Object filename;
422 #ifndef DOS_NT
423 register const unsigned char *beg;
424 #else
425 register unsigned char *beg;
426 #endif
427 register const unsigned char *p;
428 Lisp_Object handler;
430 CHECK_STRING (filename);
432 /* If the file name has special constructs in it,
433 call the corresponding file handler. */
434 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
435 if (!NILP (handler))
436 return call2 (handler, Qfile_name_directory, filename);
438 filename = FILE_SYSTEM_CASE (filename);
439 beg = SDATA (filename);
440 #ifdef DOS_NT
441 beg = strcpy (alloca (strlen (beg) + 1), beg);
442 #endif
443 p = beg + SBYTES (filename);
445 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
446 #ifdef VMS
447 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
448 #endif /* VMS */
449 #ifdef DOS_NT
450 /* only recognise drive specifier at the beginning */
451 && !(p[-1] == ':'
452 /* handle the "/:d:foo" and "/:foo" cases correctly */
453 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
454 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
455 #endif
456 ) p--;
458 if (p == beg)
459 return Qnil;
460 #ifdef DOS_NT
461 /* Expansion of "c:" to drive and default directory. */
462 if (p[-1] == ':')
464 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
465 unsigned char *res = alloca (MAXPATHLEN + 1);
466 unsigned char *r = res;
468 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
470 strncpy (res, beg, 2);
471 beg += 2;
472 r += 2;
475 if (getdefdir (toupper (*beg) - 'A' + 1, r))
477 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
478 strcat (res, "/");
479 beg = res;
480 p = beg + strlen (beg);
483 CORRECT_DIR_SEPS (beg);
484 #endif /* DOS_NT */
486 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
489 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
490 Sfile_name_nondirectory, 1, 1, 0,
491 doc: /* Return file name FILENAME sans its directory.
492 For example, in a Unix-syntax file name,
493 this is everything after the last slash,
494 or the entire name if it contains no slash. */)
495 (filename)
496 Lisp_Object filename;
498 register const unsigned char *beg, *p, *end;
499 Lisp_Object handler;
501 CHECK_STRING (filename);
503 /* If the file name has special constructs in it,
504 call the corresponding file handler. */
505 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
506 if (!NILP (handler))
507 return call2 (handler, Qfile_name_nondirectory, filename);
509 beg = SDATA (filename);
510 end = p = beg + SBYTES (filename);
512 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
513 #ifdef VMS
514 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
515 #endif /* VMS */
516 #ifdef DOS_NT
517 /* only recognise drive specifier at beginning */
518 && !(p[-1] == ':'
519 /* handle the "/:d:foo" case correctly */
520 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
521 #endif
523 p--;
525 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
528 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
529 Sunhandled_file_name_directory, 1, 1, 0,
530 doc: /* Return a directly usable directory name somehow associated with FILENAME.
531 A `directly usable' directory name is one that may be used without the
532 intervention of any file handler.
533 If FILENAME is a directly usable file itself, return
534 \(file-name-directory FILENAME).
535 The `call-process' and `start-process' functions use this function to
536 get a current directory to run processes in. */)
537 (filename)
538 Lisp_Object filename;
540 Lisp_Object handler;
542 /* If the file name has special constructs in it,
543 call the corresponding file handler. */
544 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
545 if (!NILP (handler))
546 return call2 (handler, Qunhandled_file_name_directory, filename);
548 return Ffile_name_directory (filename);
552 char *
553 file_name_as_directory (out, in)
554 char *out, *in;
556 int size = strlen (in) - 1;
558 strcpy (out, in);
560 if (size < 0)
562 out[0] = '.';
563 out[1] = '/';
564 out[2] = 0;
565 return out;
568 #ifdef VMS
569 /* Is it already a directory string? */
570 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
571 return out;
572 /* Is it a VMS directory file name? If so, hack VMS syntax. */
573 else if (! index (in, '/')
574 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
575 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
576 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
577 || ! strncmp (&in[size - 5], ".dir", 4))
578 && (in[size - 1] == '.' || in[size - 1] == ';')
579 && in[size] == '1')))
581 register char *p, *dot;
582 char brack;
584 /* x.dir -> [.x]
585 dir:x.dir --> dir:[x]
586 dir:[x]y.dir --> dir:[x.y] */
587 p = in + size;
588 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
589 if (p != in)
591 strncpy (out, in, p - in);
592 out[p - in] = '\0';
593 if (*p == ':')
595 brack = ']';
596 strcat (out, ":[");
598 else
600 brack = *p;
601 strcat (out, ".");
603 p++;
605 else
607 brack = ']';
608 strcpy (out, "[.");
610 dot = index (p, '.');
611 if (dot)
613 /* blindly remove any extension */
614 size = strlen (out) + (dot - p);
615 strncat (out, p, dot - p);
617 else
619 strcat (out, p);
620 size = strlen (out);
622 out[size++] = brack;
623 out[size] = '\0';
625 #else /* not VMS */
626 /* For Unix syntax, Append a slash if necessary */
627 if (!IS_DIRECTORY_SEP (out[size]))
629 /* Cannot use DIRECTORY_SEP, which could have any value */
630 out[size + 1] = '/';
631 out[size + 2] = '\0';
633 #ifdef DOS_NT
634 CORRECT_DIR_SEPS (out);
635 #endif
636 #endif /* not VMS */
637 return out;
640 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
641 Sfile_name_as_directory, 1, 1, 0,
642 doc: /* Return a string representing the file name FILE interpreted as a directory.
643 This operation exists because a directory is also a file, but its name as
644 a directory is different from its name as a file.
645 The result can be used as the value of `default-directory'
646 or passed as second argument to `expand-file-name'.
647 For a Unix-syntax file name, just appends a slash.
648 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
649 (file)
650 Lisp_Object file;
652 char *buf;
653 Lisp_Object handler;
655 CHECK_STRING (file);
656 if (NILP (file))
657 return Qnil;
659 /* If the file name has special constructs in it,
660 call the corresponding file handler. */
661 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
662 if (!NILP (handler))
663 return call2 (handler, Qfile_name_as_directory, file);
665 buf = (char *) alloca (SBYTES (file) + 10);
666 file_name_as_directory (buf, SDATA (file));
667 return make_specified_string (buf, -1, strlen (buf),
668 STRING_MULTIBYTE (file));
672 * Convert from directory name to filename.
673 * On VMS:
674 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
675 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
676 * On UNIX, it's simple: just make sure there isn't a terminating /
678 * Value is nonzero if the string output is different from the input.
682 directory_file_name (src, dst)
683 char *src, *dst;
685 long slen;
686 #ifdef VMS
687 long rlen;
688 char * ptr, * rptr;
689 char bracket;
690 struct FAB fab = cc$rms_fab;
691 struct NAM nam = cc$rms_nam;
692 char esa[NAM$C_MAXRSS];
693 #endif /* VMS */
695 slen = strlen (src);
696 #ifdef VMS
697 if (! index (src, '/')
698 && (src[slen - 1] == ']'
699 || src[slen - 1] == ':'
700 || src[slen - 1] == '>'))
702 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
703 fab.fab$l_fna = src;
704 fab.fab$b_fns = slen;
705 fab.fab$l_nam = &nam;
706 fab.fab$l_fop = FAB$M_NAM;
708 nam.nam$l_esa = esa;
709 nam.nam$b_ess = sizeof esa;
710 nam.nam$b_nop |= NAM$M_SYNCHK;
712 /* We call SYS$PARSE to handle such things as [--] for us. */
713 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
715 slen = nam.nam$b_esl;
716 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
717 slen -= 2;
718 esa[slen] = '\0';
719 src = esa;
721 if (src[slen - 1] != ']' && src[slen - 1] != '>')
723 /* what about when we have logical_name:???? */
724 if (src[slen - 1] == ':')
725 { /* Xlate logical name and see what we get */
726 ptr = strcpy (dst, src); /* upper case for getenv */
727 while (*ptr)
729 if ('a' <= *ptr && *ptr <= 'z')
730 *ptr -= 040;
731 ptr++;
733 dst[slen - 1] = 0; /* remove colon */
734 if (!(src = egetenv (dst)))
735 return 0;
736 /* should we jump to the beginning of this procedure?
737 Good points: allows us to use logical names that xlate
738 to Unix names,
739 Bad points: can be a problem if we just translated to a device
740 name...
741 For now, I'll punt and always expect VMS names, and hope for
742 the best! */
743 slen = strlen (src);
744 if (src[slen - 1] != ']' && src[slen - 1] != '>')
745 { /* no recursion here! */
746 strcpy (dst, src);
747 return 0;
750 else
751 { /* not a directory spec */
752 strcpy (dst, src);
753 return 0;
756 bracket = src[slen - 1];
758 /* If bracket is ']' or '>', bracket - 2 is the corresponding
759 opening bracket. */
760 ptr = index (src, bracket - 2);
761 if (ptr == 0)
762 { /* no opening bracket */
763 strcpy (dst, src);
764 return 0;
766 if (!(rptr = rindex (src, '.')))
767 rptr = ptr;
768 slen = rptr - src;
769 strncpy (dst, src, slen);
770 dst[slen] = '\0';
771 if (*rptr == '.')
773 dst[slen++] = bracket;
774 dst[slen] = '\0';
776 else
778 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
779 then translate the device and recurse. */
780 if (dst[slen - 1] == ':'
781 && dst[slen - 2] != ':' /* skip decnet nodes */
782 && strcmp (src + slen, "[000000]") == 0)
784 dst[slen - 1] = '\0';
785 if ((ptr = egetenv (dst))
786 && (rlen = strlen (ptr) - 1) > 0
787 && (ptr[rlen] == ']' || ptr[rlen] == '>')
788 && ptr[rlen - 1] == '.')
790 char * buf = (char *) alloca (strlen (ptr) + 1);
791 strcpy (buf, ptr);
792 buf[rlen - 1] = ']';
793 buf[rlen] = '\0';
794 return directory_file_name (buf, dst);
796 else
797 dst[slen - 1] = ':';
799 strcat (dst, "[000000]");
800 slen += 8;
802 rptr++;
803 rlen = strlen (rptr) - 1;
804 strncat (dst, rptr, rlen);
805 dst[slen + rlen] = '\0';
806 strcat (dst, ".DIR.1");
807 return 1;
809 #endif /* VMS */
810 /* Process as Unix format: just remove any final slash.
811 But leave "/" unchanged; do not change it to "". */
812 strcpy (dst, src);
813 #ifdef APOLLO
814 /* Handle // as root for apollo's. */
815 if ((slen > 2 && dst[slen - 1] == '/')
816 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
817 dst[slen - 1] = 0;
818 #else
819 if (slen > 1
820 && IS_DIRECTORY_SEP (dst[slen - 1])
821 #ifdef DOS_NT
822 && !IS_ANY_SEP (dst[slen - 2])
823 #endif
825 dst[slen - 1] = 0;
826 #endif
827 #ifdef DOS_NT
828 CORRECT_DIR_SEPS (dst);
829 #endif
830 return 1;
833 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
834 1, 1, 0,
835 doc: /* Returns the file name of the directory named DIRECTORY.
836 This is the name of the file that holds the data for the directory DIRECTORY.
837 This operation exists because a directory is also a file, but its name as
838 a directory is different from its name as a file.
839 In Unix-syntax, this function just removes the final slash.
840 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
841 it returns a file name such as \"[X]Y.DIR.1\". */)
842 (directory)
843 Lisp_Object directory;
845 char *buf;
846 Lisp_Object handler;
848 CHECK_STRING (directory);
850 if (NILP (directory))
851 return Qnil;
853 /* If the file name has special constructs in it,
854 call the corresponding file handler. */
855 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
856 if (!NILP (handler))
857 return call2 (handler, Qdirectory_file_name, directory);
859 #ifdef VMS
860 /* 20 extra chars is insufficient for VMS, since we might perform a
861 logical name translation. an equivalence string can be up to 255
862 chars long, so grab that much extra space... - sss */
863 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
864 #else
865 buf = (char *) alloca (SBYTES (directory) + 20);
866 #endif
867 directory_file_name (SDATA (directory), buf);
868 return make_specified_string (buf, -1, strlen (buf),
869 STRING_MULTIBYTE (directory));
872 static char make_temp_name_tbl[64] =
874 'A','B','C','D','E','F','G','H',
875 'I','J','K','L','M','N','O','P',
876 'Q','R','S','T','U','V','W','X',
877 'Y','Z','a','b','c','d','e','f',
878 'g','h','i','j','k','l','m','n',
879 'o','p','q','r','s','t','u','v',
880 'w','x','y','z','0','1','2','3',
881 '4','5','6','7','8','9','-','_'
884 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
886 /* Value is a temporary file name starting with PREFIX, a string.
888 The Emacs process number forms part of the result, so there is
889 no danger of generating a name being used by another process.
890 In addition, this function makes an attempt to choose a name
891 which has no existing file. To make this work, PREFIX should be
892 an absolute file name.
894 BASE64_P non-zero means add the pid as 3 characters in base64
895 encoding. In this case, 6 characters will be added to PREFIX to
896 form the file name. Otherwise, if Emacs is running on a system
897 with long file names, add the pid as a decimal number.
899 This function signals an error if no unique file name could be
900 generated. */
902 Lisp_Object
903 make_temp_name (prefix, base64_p)
904 Lisp_Object prefix;
905 int base64_p;
907 Lisp_Object val;
908 int len, clen;
909 int pid;
910 unsigned char *p, *data;
911 char pidbuf[20];
912 int pidlen;
914 CHECK_STRING (prefix);
916 /* VAL is created by adding 6 characters to PREFIX. The first
917 three are the PID of this process, in base 64, and the second
918 three are incremented if the file already exists. This ensures
919 262144 unique file names per PID per PREFIX. */
921 pid = (int) getpid ();
923 if (base64_p)
925 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
926 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
927 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
928 pidlen = 3;
930 else
932 #ifdef HAVE_LONG_FILE_NAMES
933 sprintf (pidbuf, "%d", pid);
934 pidlen = strlen (pidbuf);
935 #else
936 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
937 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
938 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
939 pidlen = 3;
940 #endif
943 len = SBYTES (prefix); clen = SCHARS (prefix);
944 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
945 if (!STRING_MULTIBYTE (prefix))
946 STRING_SET_UNIBYTE (val);
947 data = SDATA (val);
948 bcopy(SDATA (prefix), data, len);
949 p = data + len;
951 bcopy (pidbuf, p, pidlen);
952 p += pidlen;
954 /* Here we try to minimize useless stat'ing when this function is
955 invoked many times successively with the same PREFIX. We achieve
956 this by initializing count to a random value, and incrementing it
957 afterwards.
959 We don't want make-temp-name to be called while dumping,
960 because then make_temp_name_count_initialized_p would get set
961 and then make_temp_name_count would not be set when Emacs starts. */
963 if (!make_temp_name_count_initialized_p)
965 make_temp_name_count = (unsigned) time (NULL);
966 make_temp_name_count_initialized_p = 1;
969 while (1)
971 struct stat ignored;
972 unsigned num = make_temp_name_count;
974 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
975 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
976 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
978 /* Poor man's congruential RN generator. Replace with
979 ++make_temp_name_count for debugging. */
980 make_temp_name_count += 25229;
981 make_temp_name_count %= 225307;
983 if (stat (data, &ignored) < 0)
985 /* We want to return only if errno is ENOENT. */
986 if (errno == ENOENT)
987 return val;
988 else
989 /* The error here is dubious, but there is little else we
990 can do. The alternatives are to return nil, which is
991 as bad as (and in many cases worse than) throwing the
992 error, or to ignore the error, which will likely result
993 in looping through 225307 stat's, which is not only
994 dog-slow, but also useless since it will fallback to
995 the errow below, anyway. */
996 report_file_error ("Cannot create temporary name for prefix",
997 Fcons (prefix, Qnil));
998 /* not reached */
1002 error ("Cannot create temporary name for prefix `%s'",
1003 SDATA (prefix));
1004 return Qnil;
1008 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1009 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
1010 The Emacs process number forms part of the result,
1011 so there is no danger of generating a name being used by another process.
1013 In addition, this function makes an attempt to choose a name
1014 which has no existing file. To make this work,
1015 PREFIX should be an absolute file name.
1017 There is a race condition between calling `make-temp-name' and creating the
1018 file which opens all kinds of security holes. For that reason, you should
1019 probably use `make-temp-file' instead, except in three circumstances:
1021 * If you are creating the file in the user's home directory.
1022 * If you are creating a directory rather than an ordinary file.
1023 * If you are taking special precautions as `make-temp-file' does. */)
1024 (prefix)
1025 Lisp_Object prefix;
1027 return make_temp_name (prefix, 0);
1032 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1033 doc: /* Convert filename NAME to absolute, and canonicalize it.
1034 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1035 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
1036 the current buffer's value of `default-directory' is used.
1037 File name components that are `.' are removed, and
1038 so are file name components followed by `..', along with the `..' itself;
1039 note that these simplifications are done without checking the resulting
1040 file names in the file system.
1041 An initial `~/' expands to your home directory.
1042 An initial `~USER/' expands to USER's home directory.
1043 See also the function `substitute-in-file-name'. */)
1044 (name, default_directory)
1045 Lisp_Object name, default_directory;
1047 unsigned char *nm;
1049 register unsigned char *newdir, *p, *o;
1050 int tlen;
1051 unsigned char *target;
1052 struct passwd *pw;
1053 #ifdef VMS
1054 unsigned char * colon = 0;
1055 unsigned char * close = 0;
1056 unsigned char * slash = 0;
1057 unsigned char * brack = 0;
1058 int lbrack = 0, rbrack = 0;
1059 int dots = 0;
1060 #endif /* VMS */
1061 #ifdef DOS_NT
1062 int drive = 0;
1063 int collapse_newdir = 1;
1064 int is_escaped = 0;
1065 #endif /* DOS_NT */
1066 int length;
1067 Lisp_Object handler, result;
1068 int multibyte;
1070 CHECK_STRING (name);
1072 /* If the file name has special constructs in it,
1073 call the corresponding file handler. */
1074 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1075 if (!NILP (handler))
1076 return call3 (handler, Qexpand_file_name, name, default_directory);
1078 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1079 if (NILP (default_directory))
1080 default_directory = current_buffer->directory;
1081 if (! STRINGP (default_directory))
1083 #ifdef DOS_NT
1084 /* "/" is not considered a root directory on DOS_NT, so using "/"
1085 here causes an infinite recursion in, e.g., the following:
1087 (let (default-directory)
1088 (expand-file-name "a"))
1090 To avoid this, we set default_directory to the root of the
1091 current drive. */
1092 extern char *emacs_root_dir (void);
1094 default_directory = build_string (emacs_root_dir ());
1095 #else
1096 default_directory = build_string ("/");
1097 #endif
1100 if (!NILP (default_directory))
1102 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1103 if (!NILP (handler))
1104 return call3 (handler, Qexpand_file_name, name, default_directory);
1107 o = SDATA (default_directory);
1109 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1110 It would be better to do this down below where we actually use
1111 default_directory. Unfortunately, calling Fexpand_file_name recursively
1112 could invoke GC, and the strings might be relocated. This would
1113 be annoying because we have pointers into strings lying around
1114 that would need adjusting, and people would add new pointers to
1115 the code and forget to adjust them, resulting in intermittent bugs.
1116 Putting this call here avoids all that crud.
1118 The EQ test avoids infinite recursion. */
1119 if (! NILP (default_directory) && !EQ (default_directory, name)
1120 /* Save time in some common cases - as long as default_directory
1121 is not relative, it can be canonicalized with name below (if it
1122 is needed at all) without requiring it to be expanded now. */
1123 #ifdef DOS_NT
1124 /* Detect MSDOS file names with drive specifiers. */
1125 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1126 #ifdef WINDOWSNT
1127 /* Detect Windows file names in UNC format. */
1128 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1129 #endif
1130 #else /* not DOS_NT */
1131 /* Detect Unix absolute file names (/... alone is not absolute on
1132 DOS or Windows). */
1133 && ! (IS_DIRECTORY_SEP (o[0]))
1134 #endif /* not DOS_NT */
1137 struct gcpro gcpro1;
1139 GCPRO1 (name);
1140 default_directory = Fexpand_file_name (default_directory, Qnil);
1141 UNGCPRO;
1144 name = FILE_SYSTEM_CASE (name);
1145 nm = SDATA (name);
1146 multibyte = STRING_MULTIBYTE (name);
1148 #ifdef DOS_NT
1149 /* We will force directory separators to be either all \ or /, so make
1150 a local copy to modify, even if there ends up being no change. */
1151 nm = strcpy (alloca (strlen (nm) + 1), nm);
1153 /* Note if special escape prefix is present, but remove for now. */
1154 if (nm[0] == '/' && nm[1] == ':')
1156 is_escaped = 1;
1157 nm += 2;
1160 /* Find and remove drive specifier if present; this makes nm absolute
1161 even if the rest of the name appears to be relative. Only look for
1162 drive specifier at the beginning. */
1163 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1165 drive = nm[0];
1166 nm += 2;
1169 #ifdef WINDOWSNT
1170 /* If we see "c://somedir", we want to strip the first slash after the
1171 colon when stripping the drive letter. Otherwise, this expands to
1172 "//somedir". */
1173 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1174 nm++;
1175 #endif /* WINDOWSNT */
1176 #endif /* DOS_NT */
1178 #ifdef WINDOWSNT
1179 /* Discard any previous drive specifier if nm is now in UNC format. */
1180 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1182 drive = 0;
1184 #endif
1186 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1187 none are found, we can probably return right away. We will avoid
1188 allocating a new string if name is already fully expanded. */
1189 if (
1190 IS_DIRECTORY_SEP (nm[0])
1191 #ifdef MSDOS
1192 && drive && !is_escaped
1193 #endif
1194 #ifdef WINDOWSNT
1195 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1196 #endif
1197 #ifdef VMS
1198 || index (nm, ':')
1199 #endif /* VMS */
1202 /* If it turns out that the filename we want to return is just a
1203 suffix of FILENAME, we don't need to go through and edit
1204 things; we just need to construct a new string using data
1205 starting at the middle of FILENAME. If we set lose to a
1206 non-zero value, that means we've discovered that we can't do
1207 that cool trick. */
1208 int lose = 0;
1210 p = nm;
1211 while (*p)
1213 /* Since we know the name is absolute, we can assume that each
1214 element starts with a "/". */
1216 /* "." and ".." are hairy. */
1217 if (IS_DIRECTORY_SEP (p[0])
1218 && p[1] == '.'
1219 && (IS_DIRECTORY_SEP (p[2])
1220 || p[2] == 0
1221 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1222 || p[3] == 0))))
1223 lose = 1;
1224 /* We want to replace multiple `/' in a row with a single
1225 slash. */
1226 else if (p > nm
1227 && IS_DIRECTORY_SEP (p[0])
1228 && IS_DIRECTORY_SEP (p[1]))
1229 lose = 1;
1231 #ifdef VMS
1232 if (p[0] == '\\')
1233 lose = 1;
1234 if (p[0] == '/') {
1235 /* if dev:[dir]/, move nm to / */
1236 if (!slash && p > nm && (brack || colon)) {
1237 nm = (brack ? brack + 1 : colon + 1);
1238 lbrack = rbrack = 0;
1239 brack = 0;
1240 colon = 0;
1242 slash = p;
1244 if (p[0] == '-')
1245 #ifdef NO_HYPHENS_IN_FILENAMES
1246 if (lbrack == rbrack)
1248 /* Avoid clobbering negative version numbers. */
1249 if (dots < 2)
1250 p[0] = '_';
1252 else
1253 #endif /* NO_HYPHENS_IN_FILENAMES */
1254 if (lbrack > rbrack
1255 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1256 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1257 lose = 1;
1258 #ifdef NO_HYPHENS_IN_FILENAMES
1259 else
1260 p[0] = '_';
1261 #endif /* NO_HYPHENS_IN_FILENAMES */
1262 /* count open brackets, reset close bracket pointer */
1263 if (p[0] == '[' || p[0] == '<')
1264 lbrack++, brack = 0;
1265 /* count close brackets, set close bracket pointer */
1266 if (p[0] == ']' || p[0] == '>')
1267 rbrack++, brack = p;
1268 /* detect ][ or >< */
1269 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1270 lose = 1;
1271 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1272 nm = p + 1, lose = 1;
1273 if (p[0] == ':' && (colon || slash))
1274 /* if dev1:[dir]dev2:, move nm to dev2: */
1275 if (brack)
1277 nm = brack + 1;
1278 brack = 0;
1280 /* if /name/dev:, move nm to dev: */
1281 else if (slash)
1282 nm = slash + 1;
1283 /* if node::dev:, move colon following dev */
1284 else if (colon && colon[-1] == ':')
1285 colon = p;
1286 /* if dev1:dev2:, move nm to dev2: */
1287 else if (colon && colon[-1] != ':')
1289 nm = colon + 1;
1290 colon = 0;
1292 if (p[0] == ':' && !colon)
1294 if (p[1] == ':')
1295 p++;
1296 colon = p;
1298 if (lbrack == rbrack)
1299 if (p[0] == ';')
1300 dots = 2;
1301 else if (p[0] == '.')
1302 dots++;
1303 #endif /* VMS */
1304 p++;
1306 if (!lose)
1308 #ifdef VMS
1309 if (index (nm, '/'))
1311 nm = sys_translate_unix (nm);
1312 return make_specified_string (nm, -1, strlen (nm), multibyte);
1314 #endif /* VMS */
1315 #ifdef DOS_NT
1316 /* Make sure directories are all separated with / or \ as
1317 desired, but avoid allocation of a new string when not
1318 required. */
1319 CORRECT_DIR_SEPS (nm);
1320 #ifdef WINDOWSNT
1321 if (IS_DIRECTORY_SEP (nm[1]))
1323 if (strcmp (nm, SDATA (name)) != 0)
1324 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1326 else
1327 #endif
1328 /* drive must be set, so this is okay */
1329 if (strcmp (nm - 2, SDATA (name)) != 0)
1331 char temp[] = " :";
1333 name = make_specified_string (nm, -1, p - nm, multibyte);
1334 temp[0] = DRIVE_LETTER (drive);
1335 name = concat2 (build_string (temp), name);
1337 return name;
1338 #else /* not DOS_NT */
1339 if (nm == SDATA (name))
1340 return name;
1341 return make_specified_string (nm, -1, strlen (nm), multibyte);
1342 #endif /* not DOS_NT */
1346 /* At this point, nm might or might not be an absolute file name. We
1347 need to expand ~ or ~user if present, otherwise prefix nm with
1348 default_directory if nm is not absolute, and finally collapse /./
1349 and /foo/../ sequences.
1351 We set newdir to be the appropriate prefix if one is needed:
1352 - the relevant user directory if nm starts with ~ or ~user
1353 - the specified drive's working dir (DOS/NT only) if nm does not
1354 start with /
1355 - the value of default_directory.
1357 Note that these prefixes are not guaranteed to be absolute (except
1358 for the working dir of a drive). Therefore, to ensure we always
1359 return an absolute name, if the final prefix is not absolute we
1360 append it to the current working directory. */
1362 newdir = 0;
1364 if (nm[0] == '~') /* prefix ~ */
1366 if (IS_DIRECTORY_SEP (nm[1])
1367 #ifdef VMS
1368 || nm[1] == ':'
1369 #endif /* VMS */
1370 || nm[1] == 0) /* ~ by itself */
1372 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1373 newdir = (unsigned char *) "";
1374 nm++;
1375 #ifdef DOS_NT
1376 collapse_newdir = 0;
1377 #endif
1378 #ifdef VMS
1379 nm++; /* Don't leave the slash in nm. */
1380 #endif /* VMS */
1382 else /* ~user/filename */
1384 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1385 #ifdef VMS
1386 && *p != ':'
1387 #endif /* VMS */
1388 ); p++);
1389 o = (unsigned char *) alloca (p - nm + 1);
1390 bcopy ((char *) nm, o, p - nm);
1391 o [p - nm] = 0;
1393 BLOCK_INPUT;
1394 pw = (struct passwd *) getpwnam (o + 1);
1395 UNBLOCK_INPUT;
1396 if (pw)
1398 newdir = (unsigned char *) pw -> pw_dir;
1399 #ifdef VMS
1400 nm = p + 1; /* skip the terminator */
1401 #else
1402 nm = p;
1403 #ifdef DOS_NT
1404 collapse_newdir = 0;
1405 #endif
1406 #endif /* VMS */
1409 /* If we don't find a user of that name, leave the name
1410 unchanged; don't move nm forward to p. */
1414 #ifdef DOS_NT
1415 /* On DOS and Windows, nm is absolute if a drive name was specified;
1416 use the drive's current directory as the prefix if needed. */
1417 if (!newdir && drive)
1419 /* Get default directory if needed to make nm absolute. */
1420 if (!IS_DIRECTORY_SEP (nm[0]))
1422 newdir = alloca (MAXPATHLEN + 1);
1423 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1424 newdir = NULL;
1426 if (!newdir)
1428 /* Either nm starts with /, or drive isn't mounted. */
1429 newdir = alloca (4);
1430 newdir[0] = DRIVE_LETTER (drive);
1431 newdir[1] = ':';
1432 newdir[2] = '/';
1433 newdir[3] = 0;
1436 #endif /* DOS_NT */
1438 /* Finally, if no prefix has been specified and nm is not absolute,
1439 then it must be expanded relative to default_directory. */
1441 if (1
1442 #ifndef DOS_NT
1443 /* /... alone is not absolute on DOS and Windows. */
1444 && !IS_DIRECTORY_SEP (nm[0])
1445 #endif
1446 #ifdef WINDOWSNT
1447 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1448 #endif
1449 #ifdef VMS
1450 && !index (nm, ':')
1451 #endif
1452 && !newdir)
1454 newdir = SDATA (default_directory);
1455 multibyte |= STRING_MULTIBYTE (default_directory);
1456 #ifdef DOS_NT
1457 /* Note if special escape prefix is present, but remove for now. */
1458 if (newdir[0] == '/' && newdir[1] == ':')
1460 is_escaped = 1;
1461 newdir += 2;
1463 #endif
1466 #ifdef DOS_NT
1467 if (newdir)
1469 /* First ensure newdir is an absolute name. */
1470 if (
1471 /* Detect MSDOS file names with drive specifiers. */
1472 ! (IS_DRIVE (newdir[0])
1473 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1474 #ifdef WINDOWSNT
1475 /* Detect Windows file names in UNC format. */
1476 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1477 #endif
1480 /* Effectively, let newdir be (expand-file-name newdir cwd).
1481 Because of the admonition against calling expand-file-name
1482 when we have pointers into lisp strings, we accomplish this
1483 indirectly by prepending newdir to nm if necessary, and using
1484 cwd (or the wd of newdir's drive) as the new newdir. */
1486 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1488 drive = newdir[0];
1489 newdir += 2;
1491 if (!IS_DIRECTORY_SEP (nm[0]))
1493 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1494 file_name_as_directory (tmp, newdir);
1495 strcat (tmp, nm);
1496 nm = tmp;
1498 newdir = alloca (MAXPATHLEN + 1);
1499 if (drive)
1501 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1502 newdir = "/";
1504 else
1505 getwd (newdir);
1508 /* Strip off drive name from prefix, if present. */
1509 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1511 drive = newdir[0];
1512 newdir += 2;
1515 /* Keep only a prefix from newdir if nm starts with slash
1516 (//server/share for UNC, nothing otherwise). */
1517 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1519 #ifdef WINDOWSNT
1520 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1522 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1523 p = newdir + 2;
1524 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1525 p++;
1526 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1527 *p = 0;
1529 else
1530 #endif
1531 newdir = "";
1534 #endif /* DOS_NT */
1536 if (newdir)
1538 /* Get rid of any slash at the end of newdir, unless newdir is
1539 just / or // (an incomplete UNC name). */
1540 length = strlen (newdir);
1541 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1542 #ifdef WINDOWSNT
1543 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1544 #endif
1547 unsigned char *temp = (unsigned char *) alloca (length);
1548 bcopy (newdir, temp, length - 1);
1549 temp[length - 1] = 0;
1550 newdir = temp;
1552 tlen = length + 1;
1554 else
1555 tlen = 0;
1557 /* Now concatenate the directory and name to new space in the stack frame */
1558 tlen += strlen (nm) + 1;
1559 #ifdef DOS_NT
1560 /* Reserve space for drive specifier and escape prefix, since either
1561 or both may need to be inserted. (The Microsoft x86 compiler
1562 produces incorrect code if the following two lines are combined.) */
1563 target = (unsigned char *) alloca (tlen + 4);
1564 target += 4;
1565 #else /* not DOS_NT */
1566 target = (unsigned char *) alloca (tlen);
1567 #endif /* not DOS_NT */
1568 *target = 0;
1570 if (newdir)
1572 #ifndef VMS
1573 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1575 #ifdef DOS_NT
1576 /* If newdir is effectively "C:/", then the drive letter will have
1577 been stripped and newdir will be "/". Concatenating with an
1578 absolute directory in nm produces "//", which will then be
1579 incorrectly treated as a network share. Ignore newdir in
1580 this case (keeping the drive letter). */
1581 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1582 && newdir[1] == '\0'))
1583 #endif
1584 strcpy (target, newdir);
1586 else
1587 #endif
1588 file_name_as_directory (target, newdir);
1591 strcat (target, nm);
1592 #ifdef VMS
1593 if (index (target, '/'))
1594 strcpy (target, sys_translate_unix (target));
1595 #endif /* VMS */
1597 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1599 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1600 appear. */
1602 p = target;
1603 o = target;
1605 while (*p)
1607 #ifdef VMS
1608 if (*p != ']' && *p != '>' && *p != '-')
1610 if (*p == '\\')
1611 p++;
1612 *o++ = *p++;
1614 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1615 /* brackets are offset from each other by 2 */
1617 p += 2;
1618 if (*p != '.' && *p != '-' && o[-1] != '.')
1619 /* convert [foo][bar] to [bar] */
1620 while (o[-1] != '[' && o[-1] != '<')
1621 o--;
1622 else if (*p == '-' && *o != '.')
1623 *--p = '.';
1625 else if (p[0] == '-' && o[-1] == '.'
1626 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1627 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1630 o--;
1631 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1632 if (p[1] == '.') /* foo.-.bar ==> bar. */
1633 p += 2;
1634 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1635 p++, o--;
1636 /* else [foo.-] ==> [-] */
1638 else
1640 #ifdef NO_HYPHENS_IN_FILENAMES
1641 if (*p == '-'
1642 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
1643 && p[1] != ']' && p[1] != '>' && p[1] != '.')
1644 *p = '_';
1645 #endif /* NO_HYPHENS_IN_FILENAMES */
1646 *o++ = *p++;
1648 #else /* not VMS */
1649 if (!IS_DIRECTORY_SEP (*p))
1651 *o++ = *p++;
1653 else if (p[1] == '.'
1654 && (IS_DIRECTORY_SEP (p[2])
1655 || p[2] == 0))
1657 /* If "/." is the entire filename, keep the "/". Otherwise,
1658 just delete the whole "/.". */
1659 if (o == target && p[2] == '\0')
1660 *o++ = *p;
1661 p += 2;
1663 else if (p[1] == '.' && p[2] == '.'
1664 /* `/../' is the "superroot" on certain file systems.
1665 Turned off on DOS_NT systems because they have no
1666 "superroot" and because this causes us to produce
1667 file names like "d:/../foo" which fail file-related
1668 functions of the underlying OS. (To reproduce, try a
1669 long series of "../../" in default_directory, longer
1670 than the number of levels from the root.) */
1671 #ifndef DOS_NT
1672 && o != target
1673 #endif
1674 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1676 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1678 /* Keep initial / only if this is the whole name. */
1679 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1680 ++o;
1681 p += 3;
1683 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1684 /* Collapse multiple `/' in a row. */
1685 p++;
1686 else
1688 *o++ = *p++;
1690 #endif /* not VMS */
1693 #ifdef DOS_NT
1694 /* At last, set drive name. */
1695 #ifdef WINDOWSNT
1696 /* Except for network file name. */
1697 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1698 #endif /* WINDOWSNT */
1700 if (!drive) abort ();
1701 target -= 2;
1702 target[0] = DRIVE_LETTER (drive);
1703 target[1] = ':';
1705 /* Reinsert the escape prefix if required. */
1706 if (is_escaped)
1708 target -= 2;
1709 target[0] = '/';
1710 target[1] = ':';
1712 CORRECT_DIR_SEPS (target);
1713 #endif /* DOS_NT */
1715 result = make_specified_string (target, -1, o - target, multibyte);
1717 /* Again look to see if the file name has special constructs in it
1718 and perhaps call the corresponding file handler. This is needed
1719 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1720 the ".." component gives us "/user@host:/bar/../baz" which needs
1721 to be expanded again. */
1722 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1723 if (!NILP (handler))
1724 return call3 (handler, Qexpand_file_name, result, default_directory);
1726 return result;
1729 #if 0
1730 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1731 This is the old version of expand-file-name, before it was thoroughly
1732 rewritten for Emacs 10.31. We leave this version here commented-out,
1733 because the code is very complex and likely to have subtle bugs. If
1734 bugs _are_ found, it might be of interest to look at the old code and
1735 see what did it do in the relevant situation.
1737 Don't remove this code: it's true that it will be accessible via CVS,
1738 but a few years from deletion, people will forget it is there. */
1740 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1741 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1742 "Convert FILENAME to absolute, and canonicalize it.\n\
1743 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1744 \(does not start with slash); if DEFAULT is nil or missing,\n\
1745 the current buffer's value of default-directory is used.\n\
1746 Filenames containing `.' or `..' as components are simplified;\n\
1747 initial `~/' expands to your home directory.\n\
1748 See also the function `substitute-in-file-name'.")
1749 (name, defalt)
1750 Lisp_Object name, defalt;
1752 unsigned char *nm;
1754 register unsigned char *newdir, *p, *o;
1755 int tlen;
1756 unsigned char *target;
1757 struct passwd *pw;
1758 int lose;
1759 #ifdef VMS
1760 unsigned char * colon = 0;
1761 unsigned char * close = 0;
1762 unsigned char * slash = 0;
1763 unsigned char * brack = 0;
1764 int lbrack = 0, rbrack = 0;
1765 int dots = 0;
1766 #endif /* VMS */
1768 CHECK_STRING (name);
1770 #ifdef VMS
1771 /* Filenames on VMS are always upper case. */
1772 name = Fupcase (name);
1773 #endif
1775 nm = SDATA (name);
1777 /* If nm is absolute, flush ...// and detect /./ and /../.
1778 If no /./ or /../ we can return right away. */
1779 if (
1780 nm[0] == '/'
1781 #ifdef VMS
1782 || index (nm, ':')
1783 #endif /* VMS */
1786 p = nm;
1787 lose = 0;
1788 while (*p)
1790 if (p[0] == '/' && p[1] == '/'
1791 #ifdef APOLLO
1792 /* // at start of filename is meaningful on Apollo system. */
1793 && nm != p
1794 #endif /* APOLLO */
1796 nm = p + 1;
1797 if (p[0] == '/' && p[1] == '~')
1798 nm = p + 1, lose = 1;
1799 if (p[0] == '/' && p[1] == '.'
1800 && (p[2] == '/' || p[2] == 0
1801 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1802 lose = 1;
1803 #ifdef VMS
1804 if (p[0] == '\\')
1805 lose = 1;
1806 if (p[0] == '/') {
1807 /* if dev:[dir]/, move nm to / */
1808 if (!slash && p > nm && (brack || colon)) {
1809 nm = (brack ? brack + 1 : colon + 1);
1810 lbrack = rbrack = 0;
1811 brack = 0;
1812 colon = 0;
1814 slash = p;
1816 if (p[0] == '-')
1817 #ifndef VMS4_4
1818 /* VMS pre V4.4,convert '-'s in filenames. */
1819 if (lbrack == rbrack)
1821 if (dots < 2) /* this is to allow negative version numbers */
1822 p[0] = '_';
1824 else
1825 #endif /* VMS4_4 */
1826 if (lbrack > rbrack
1827 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1828 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1829 lose = 1;
1830 #ifndef VMS4_4
1831 else
1832 p[0] = '_';
1833 #endif /* VMS4_4 */
1834 /* count open brackets, reset close bracket pointer */
1835 if (p[0] == '[' || p[0] == '<')
1836 lbrack++, brack = 0;
1837 /* count close brackets, set close bracket pointer */
1838 if (p[0] == ']' || p[0] == '>')
1839 rbrack++, brack = p;
1840 /* detect ][ or >< */
1841 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1842 lose = 1;
1843 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1844 nm = p + 1, lose = 1;
1845 if (p[0] == ':' && (colon || slash))
1846 /* if dev1:[dir]dev2:, move nm to dev2: */
1847 if (brack)
1849 nm = brack + 1;
1850 brack = 0;
1852 /* If /name/dev:, move nm to dev: */
1853 else if (slash)
1854 nm = slash + 1;
1855 /* If node::dev:, move colon following dev */
1856 else if (colon && colon[-1] == ':')
1857 colon = p;
1858 /* If dev1:dev2:, move nm to dev2: */
1859 else if (colon && colon[-1] != ':')
1861 nm = colon + 1;
1862 colon = 0;
1864 if (p[0] == ':' && !colon)
1866 if (p[1] == ':')
1867 p++;
1868 colon = p;
1870 if (lbrack == rbrack)
1871 if (p[0] == ';')
1872 dots = 2;
1873 else if (p[0] == '.')
1874 dots++;
1875 #endif /* VMS */
1876 p++;
1878 if (!lose)
1880 #ifdef VMS
1881 if (index (nm, '/'))
1882 return build_string (sys_translate_unix (nm));
1883 #endif /* VMS */
1884 if (nm == SDATA (name))
1885 return name;
1886 return build_string (nm);
1890 /* Now determine directory to start with and put it in NEWDIR */
1892 newdir = 0;
1894 if (nm[0] == '~') /* prefix ~ */
1895 if (nm[1] == '/'
1896 #ifdef VMS
1897 || nm[1] == ':'
1898 #endif /* VMS */
1899 || nm[1] == 0)/* ~/filename */
1901 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1902 newdir = (unsigned char *) "";
1903 nm++;
1904 #ifdef VMS
1905 nm++; /* Don't leave the slash in nm. */
1906 #endif /* VMS */
1908 else /* ~user/filename */
1910 /* Get past ~ to user */
1911 unsigned char *user = nm + 1;
1912 /* Find end of name. */
1913 unsigned char *ptr = (unsigned char *) index (user, '/');
1914 int len = ptr ? ptr - user : strlen (user);
1915 #ifdef VMS
1916 unsigned char *ptr1 = index (user, ':');
1917 if (ptr1 != 0 && ptr1 - user < len)
1918 len = ptr1 - user;
1919 #endif /* VMS */
1920 /* Copy the user name into temp storage. */
1921 o = (unsigned char *) alloca (len + 1);
1922 bcopy ((char *) user, o, len);
1923 o[len] = 0;
1925 /* Look up the user name. */
1926 BLOCK_INPUT;
1927 pw = (struct passwd *) getpwnam (o + 1);
1928 UNBLOCK_INPUT;
1929 if (!pw)
1930 error ("\"%s\" isn't a registered user", o + 1);
1932 newdir = (unsigned char *) pw->pw_dir;
1934 /* Discard the user name from NM. */
1935 nm += len;
1938 if (nm[0] != '/'
1939 #ifdef VMS
1940 && !index (nm, ':')
1941 #endif /* not VMS */
1942 && !newdir)
1944 if (NILP (defalt))
1945 defalt = current_buffer->directory;
1946 CHECK_STRING (defalt);
1947 newdir = SDATA (defalt);
1950 /* Now concatenate the directory and name to new space in the stack frame */
1952 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1953 target = (unsigned char *) alloca (tlen);
1954 *target = 0;
1956 if (newdir)
1958 #ifndef VMS
1959 if (nm[0] == 0 || nm[0] == '/')
1960 strcpy (target, newdir);
1961 else
1962 #endif
1963 file_name_as_directory (target, newdir);
1966 strcat (target, nm);
1967 #ifdef VMS
1968 if (index (target, '/'))
1969 strcpy (target, sys_translate_unix (target));
1970 #endif /* VMS */
1972 /* Now canonicalize by removing /. and /foo/.. if they appear */
1974 p = target;
1975 o = target;
1977 while (*p)
1979 #ifdef VMS
1980 if (*p != ']' && *p != '>' && *p != '-')
1982 if (*p == '\\')
1983 p++;
1984 *o++ = *p++;
1986 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1987 /* brackets are offset from each other by 2 */
1989 p += 2;
1990 if (*p != '.' && *p != '-' && o[-1] != '.')
1991 /* convert [foo][bar] to [bar] */
1992 while (o[-1] != '[' && o[-1] != '<')
1993 o--;
1994 else if (*p == '-' && *o != '.')
1995 *--p = '.';
1997 else if (p[0] == '-' && o[-1] == '.'
1998 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1999 /* flush .foo.- ; leave - if stopped by '[' or '<' */
2002 o--;
2003 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
2004 if (p[1] == '.') /* foo.-.bar ==> bar. */
2005 p += 2;
2006 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2007 p++, o--;
2008 /* else [foo.-] ==> [-] */
2010 else
2012 #ifndef VMS4_4
2013 if (*p == '-'
2014 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
2015 && p[1] != ']' && p[1] != '>' && p[1] != '.')
2016 *p = '_';
2017 #endif /* VMS4_4 */
2018 *o++ = *p++;
2020 #else /* not VMS */
2021 if (*p != '/')
2023 *o++ = *p++;
2025 else if (!strncmp (p, "//", 2)
2026 #ifdef APOLLO
2027 /* // at start of filename is meaningful in Apollo system. */
2028 && o != target
2029 #endif /* APOLLO */
2032 o = target;
2033 p++;
2035 else if (p[0] == '/' && p[1] == '.'
2036 && (p[2] == '/' || p[2] == 0))
2037 p += 2;
2038 else if (!strncmp (p, "/..", 3)
2039 /* `/../' is the "superroot" on certain file systems. */
2040 && o != target
2041 && (p[3] == '/' || p[3] == 0))
2043 while (o != target && *--o != '/')
2045 #ifdef APOLLO
2046 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
2047 ++o;
2048 else
2049 #endif /* APOLLO */
2050 if (o == target && *o == '/')
2051 ++o;
2052 p += 3;
2054 else
2056 *o++ = *p++;
2058 #endif /* not VMS */
2061 return make_string (target, o - target);
2063 #endif
2065 /* If /~ or // appears, discard everything through first slash. */
2066 static int
2067 file_name_absolute_p (filename)
2068 const unsigned char *filename;
2070 return
2071 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2072 #ifdef VMS
2073 /* ??? This criterion is probably wrong for '<'. */
2074 || index (filename, ':') || index (filename, '<')
2075 || (*filename == '[' && (filename[1] != '-'
2076 || (filename[2] != '.' && filename[2] != ']'))
2077 && filename[1] != '.')
2078 #endif /* VMS */
2079 #ifdef DOS_NT
2080 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2081 && IS_DIRECTORY_SEP (filename[2]))
2082 #endif
2086 static unsigned char *
2087 search_embedded_absfilename (nm, endp)
2088 unsigned char *nm, *endp;
2090 unsigned char *p, *s;
2092 for (p = nm + 1; p < endp; p++)
2094 if ((0
2095 #ifdef VMS
2096 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2097 #endif /* VMS */
2098 || IS_DIRECTORY_SEP (p[-1]))
2099 && file_name_absolute_p (p)
2100 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2101 /* // at start of file name is meaningful in Apollo,
2102 WindowsNT and Cygwin systems. */
2103 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2104 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2107 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2108 #ifdef VMS
2109 && *s != ':'
2110 #endif /* VMS */
2111 ); s++);
2112 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2114 unsigned char *o = alloca (s - p + 1);
2115 struct passwd *pw;
2116 bcopy (p, o, s - p);
2117 o [s - p] = 0;
2119 /* If we have ~user and `user' exists, discard
2120 everything up to ~. But if `user' does not exist, leave
2121 ~user alone, it might be a literal file name. */
2122 BLOCK_INPUT;
2123 pw = getpwnam (o + 1);
2124 UNBLOCK_INPUT;
2125 if (pw)
2126 return p;
2128 else
2129 return p;
2132 return NULL;
2135 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2136 Ssubstitute_in_file_name, 1, 1, 0,
2137 doc: /* Substitute environment variables referred to in FILENAME.
2138 `$FOO' where FOO is an environment variable name means to substitute
2139 the value of that variable. The variable name should be terminated
2140 with a character not a letter, digit or underscore; otherwise, enclose
2141 the entire variable name in braces.
2142 If `/~' appears, all of FILENAME through that `/' is discarded.
2144 On VMS, `$' substitution is not done; this function does little and only
2145 duplicates what `expand-file-name' does. */)
2146 (filename)
2147 Lisp_Object filename;
2149 unsigned char *nm;
2151 register unsigned char *s, *p, *o, *x, *endp;
2152 unsigned char *target = NULL;
2153 int total = 0;
2154 int substituted = 0;
2155 unsigned char *xnm;
2156 Lisp_Object handler;
2158 CHECK_STRING (filename);
2160 /* If the file name has special constructs in it,
2161 call the corresponding file handler. */
2162 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2163 if (!NILP (handler))
2164 return call2 (handler, Qsubstitute_in_file_name, filename);
2166 nm = SDATA (filename);
2167 #ifdef DOS_NT
2168 nm = strcpy (alloca (strlen (nm) + 1), nm);
2169 CORRECT_DIR_SEPS (nm);
2170 substituted = (strcmp (nm, SDATA (filename)) != 0);
2171 #endif
2172 endp = nm + SBYTES (filename);
2174 /* If /~ or // appears, discard everything through first slash. */
2175 p = search_embedded_absfilename (nm, endp);
2176 if (p)
2177 /* Start over with the new string, so we check the file-name-handler
2178 again. Important with filenames like "/home/foo//:/hello///there"
2179 which whould substitute to "/:/hello///there" rather than "/there". */
2180 return Fsubstitute_in_file_name
2181 (make_specified_string (p, -1, endp - p,
2182 STRING_MULTIBYTE (filename)));
2184 #ifdef VMS
2185 return filename;
2186 #else
2188 /* See if any variables are substituted into the string
2189 and find the total length of their values in `total' */
2191 for (p = nm; p != endp;)
2192 if (*p != '$')
2193 p++;
2194 else
2196 p++;
2197 if (p == endp)
2198 goto badsubst;
2199 else if (*p == '$')
2201 /* "$$" means a single "$" */
2202 p++;
2203 total -= 1;
2204 substituted = 1;
2205 continue;
2207 else if (*p == '{')
2209 o = ++p;
2210 while (p != endp && *p != '}') p++;
2211 if (*p != '}') goto missingclose;
2212 s = p;
2214 else
2216 o = p;
2217 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2218 s = p;
2221 /* Copy out the variable name */
2222 target = (unsigned char *) alloca (s - o + 1);
2223 strncpy (target, o, s - o);
2224 target[s - o] = 0;
2225 #ifdef DOS_NT
2226 strupr (target); /* $home == $HOME etc. */
2227 #endif /* DOS_NT */
2229 /* Get variable value */
2230 o = (unsigned char *) egetenv (target);
2231 if (o)
2232 { /* Eight-bit chars occupy upto 2 bytes in multibyte. */
2233 total += strlen (o) * (STRING_MULTIBYTE (filename) ? 2 : 1);
2234 substituted = 1;
2236 else if (*p == '}')
2237 goto badvar;
2240 if (!substituted)
2241 return filename;
2243 /* If substitution required, recopy the string and do it */
2244 /* Make space in stack frame for the new copy */
2245 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2246 x = xnm;
2248 /* Copy the rest of the name through, replacing $ constructs with values */
2249 for (p = nm; *p;)
2250 if (*p != '$')
2251 *x++ = *p++;
2252 else
2254 p++;
2255 if (p == endp)
2256 goto badsubst;
2257 else if (*p == '$')
2259 *x++ = *p++;
2260 continue;
2262 else if (*p == '{')
2264 o = ++p;
2265 while (p != endp && *p != '}') p++;
2266 if (*p != '}') goto missingclose;
2267 s = p++;
2269 else
2271 o = p;
2272 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2273 s = p;
2276 /* Copy out the variable name */
2277 target = (unsigned char *) alloca (s - o + 1);
2278 strncpy (target, o, s - o);
2279 target[s - o] = 0;
2280 #ifdef DOS_NT
2281 strupr (target); /* $home == $HOME etc. */
2282 #endif /* DOS_NT */
2284 /* Get variable value */
2285 o = (unsigned char *) egetenv (target);
2286 if (!o)
2288 *x++ = '$';
2289 strcpy (x, target); x+= strlen (target);
2291 else if (STRING_MULTIBYTE (filename))
2293 /* If the original string is multibyte,
2294 convert what we substitute into multibyte. */
2295 while (*o)
2297 int c = unibyte_char_to_multibyte (*o++);
2298 x += CHAR_STRING (c, x);
2301 else
2303 strcpy (x, o);
2304 x += strlen (o);
2308 *x = 0;
2310 /* If /~ or // appears, discard everything through first slash. */
2311 while ((p = search_embedded_absfilename (xnm, x)))
2312 /* This time we do not start over because we've already expanded envvars
2313 and replaced $$ with $. Maybe we should start over as well, but we'd
2314 need to quote some $ to $$ first. */
2315 xnm = p;
2317 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2319 badsubst:
2320 error ("Bad format environment-variable substitution");
2321 missingclose:
2322 error ("Missing \"}\" in environment-variable substitution");
2323 badvar:
2324 error ("Substituting nonexistent environment variable \"%s\"", target);
2326 /* NOTREACHED */
2327 #endif /* not VMS */
2328 return Qnil;
2331 /* A slightly faster and more convenient way to get
2332 (directory-file-name (expand-file-name FOO)). */
2334 Lisp_Object
2335 expand_and_dir_to_file (filename, defdir)
2336 Lisp_Object filename, defdir;
2338 register Lisp_Object absname;
2340 absname = Fexpand_file_name (filename, defdir);
2341 #ifdef VMS
2343 register int c = SREF (absname, SBYTES (absname) - 1);
2344 if (c == ':' || c == ']' || c == '>')
2345 absname = Fdirectory_file_name (absname);
2347 #else
2348 /* Remove final slash, if any (unless this is the root dir).
2349 stat behaves differently depending! */
2350 if (SCHARS (absname) > 1
2351 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2352 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2353 /* We cannot take shortcuts; they might be wrong for magic file names. */
2354 absname = Fdirectory_file_name (absname);
2355 #endif
2356 return absname;
2359 /* Signal an error if the file ABSNAME already exists.
2360 If INTERACTIVE is nonzero, ask the user whether to proceed,
2361 and bypass the error if the user says to go ahead.
2362 QUERYSTRING is a name for the action that is being considered
2363 to alter the file.
2365 *STATPTR is used to store the stat information if the file exists.
2366 If the file does not exist, STATPTR->st_mode is set to 0.
2367 If STATPTR is null, we don't store into it.
2369 If QUICK is nonzero, we ask for y or n, not yes or no. */
2371 void
2372 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2373 Lisp_Object absname;
2374 unsigned char *querystring;
2375 int interactive;
2376 struct stat *statptr;
2377 int quick;
2379 register Lisp_Object tem, encoded_filename;
2380 struct stat statbuf;
2381 struct gcpro gcpro1;
2383 encoded_filename = ENCODE_FILE (absname);
2385 /* stat is a good way to tell whether the file exists,
2386 regardless of what access permissions it has. */
2387 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2389 if (! interactive)
2390 xsignal2 (Qfile_already_exists,
2391 build_string ("File already exists"), absname);
2392 GCPRO1 (absname);
2393 tem = format2 ("File %s already exists; %s anyway? ",
2394 absname, build_string (querystring));
2395 if (quick)
2396 tem = Fy_or_n_p (tem);
2397 else
2398 tem = do_yes_or_no_p (tem);
2399 UNGCPRO;
2400 if (NILP (tem))
2401 xsignal2 (Qfile_already_exists,
2402 build_string ("File already exists"), absname);
2403 if (statptr)
2404 *statptr = statbuf;
2406 else
2408 if (statptr)
2409 statptr->st_mode = 0;
2411 return;
2414 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
2415 "fCopy file: \nGCopy %s to file: \np\nP",
2416 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2417 If NEWNAME names a directory, copy FILE there.
2419 This function always sets the file modes of the output file to match
2420 the input file.
2422 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
2423 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
2424 signal a `file-already-exists' error without overwriting. If
2425 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
2426 about overwriting; this is what happens in interactive use with M-x.
2427 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
2428 existing file.
2430 Fourth arg KEEP-TIME non-nil means give the output file the same
2431 last-modified time as the old one. (This works on only some systems.)
2433 A prefix arg makes KEEP-TIME non-nil.
2435 If PRESERVE-UID-GID is non-nil, we try to transfer the
2436 uid and gid of FILE to NEWNAME. */)
2437 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid)
2438 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2439 Lisp_Object preserve_uid_gid;
2441 int ifd, ofd, n;
2442 char buf[16 * 1024];
2443 struct stat st, out_st;
2444 Lisp_Object handler;
2445 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2446 int count = SPECPDL_INDEX ();
2447 int input_file_statable_p;
2448 Lisp_Object encoded_file, encoded_newname;
2450 encoded_file = encoded_newname = Qnil;
2451 GCPRO4 (file, newname, encoded_file, encoded_newname);
2452 CHECK_STRING (file);
2453 CHECK_STRING (newname);
2455 if (!NILP (Ffile_directory_p (newname)))
2456 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2457 else
2458 newname = Fexpand_file_name (newname, Qnil);
2460 file = Fexpand_file_name (file, Qnil);
2462 /* If the input file name has special constructs in it,
2463 call the corresponding file handler. */
2464 handler = Ffind_file_name_handler (file, Qcopy_file);
2465 /* Likewise for output file name. */
2466 if (NILP (handler))
2467 handler = Ffind_file_name_handler (newname, Qcopy_file);
2468 if (!NILP (handler))
2469 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2470 ok_if_already_exists, keep_time));
2472 encoded_file = ENCODE_FILE (file);
2473 encoded_newname = ENCODE_FILE (newname);
2475 if (NILP (ok_if_already_exists)
2476 || INTEGERP (ok_if_already_exists))
2477 barf_or_query_if_file_exists (newname, "copy to it",
2478 INTEGERP (ok_if_already_exists), &out_st, 0);
2479 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2480 out_st.st_mode = 0;
2482 #ifdef WINDOWSNT
2483 if (!CopyFile (SDATA (encoded_file),
2484 SDATA (encoded_newname),
2485 FALSE))
2486 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2487 /* CopyFile retains the timestamp by default. */
2488 else if (NILP (keep_time))
2490 EMACS_TIME now;
2491 DWORD attributes;
2492 char * filename;
2494 EMACS_GET_TIME (now);
2495 filename = SDATA (encoded_newname);
2497 /* Ensure file is writable while its modified time is set. */
2498 attributes = GetFileAttributes (filename);
2499 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2500 if (set_file_times (filename, now, now))
2502 /* Restore original attributes. */
2503 SetFileAttributes (filename, attributes);
2504 xsignal2 (Qfile_date_error,
2505 build_string ("Cannot set file date"), newname);
2507 /* Restore original attributes. */
2508 SetFileAttributes (filename, attributes);
2510 #else /* not WINDOWSNT */
2511 immediate_quit = 1;
2512 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2513 immediate_quit = 0;
2515 if (ifd < 0)
2516 report_file_error ("Opening input file", Fcons (file, Qnil));
2518 record_unwind_protect (close_file_unwind, make_number (ifd));
2520 /* We can only copy regular files and symbolic links. Other files are not
2521 copyable by us. */
2522 input_file_statable_p = (fstat (ifd, &st) >= 0);
2524 #if !defined (MSDOS) || __DJGPP__ > 1
2525 if (out_st.st_mode != 0
2526 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2528 errno = 0;
2529 report_file_error ("Input and output files are the same",
2530 Fcons (file, Fcons (newname, Qnil)));
2532 #endif
2534 #if defined (S_ISREG) && defined (S_ISLNK)
2535 if (input_file_statable_p)
2537 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2539 #if defined (EISDIR)
2540 /* Get a better looking error message. */
2541 errno = EISDIR;
2542 #endif /* EISDIR */
2543 report_file_error ("Non-regular file", Fcons (file, Qnil));
2546 #endif /* S_ISREG && S_ISLNK */
2548 #ifdef VMS
2549 /* Create the copy file with the same record format as the input file */
2550 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2551 #else
2552 #ifdef MSDOS
2553 /* System's default file type was set to binary by _fmode in emacs.c. */
2554 ofd = emacs_open (SDATA (encoded_newname),
2555 O_WRONLY | O_TRUNC | O_CREAT
2556 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2557 S_IREAD | S_IWRITE);
2558 #else /* not MSDOS */
2559 ofd = emacs_open (SDATA (encoded_newname),
2560 O_WRONLY | O_TRUNC | O_CREAT
2561 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2562 0666);
2563 #endif /* not MSDOS */
2564 #endif /* VMS */
2565 if (ofd < 0)
2566 report_file_error ("Opening output file", Fcons (newname, Qnil));
2568 record_unwind_protect (close_file_unwind, make_number (ofd));
2570 immediate_quit = 1;
2571 QUIT;
2572 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2573 if (emacs_write (ofd, buf, n) != n)
2574 report_file_error ("I/O error", Fcons (newname, Qnil));
2575 immediate_quit = 0;
2577 #ifndef MSDOS
2578 /* Preserve the original file modes, and if requested, also its
2579 owner and group. */
2580 if (input_file_statable_p)
2582 if (! NILP (preserve_uid_gid))
2583 fchown (ofd, st.st_uid, st.st_gid);
2584 fchmod (ofd, st.st_mode & 07777);
2586 #endif /* not MSDOS */
2588 /* Closing the output clobbers the file times on some systems. */
2589 if (emacs_close (ofd) < 0)
2590 report_file_error ("I/O error", Fcons (newname, Qnil));
2592 if (input_file_statable_p)
2594 if (!NILP (keep_time))
2596 EMACS_TIME atime, mtime;
2597 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2598 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2599 if (set_file_times (SDATA (encoded_newname),
2600 atime, mtime))
2601 xsignal2 (Qfile_date_error,
2602 build_string ("Cannot set file date"), newname);
2606 emacs_close (ifd);
2608 #if defined (__DJGPP__) && __DJGPP__ > 1
2609 if (input_file_statable_p)
2611 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2612 and if it can't, it tells so. Otherwise, under MSDOS we usually
2613 get only the READ bit, which will make the copied file read-only,
2614 so it's better not to chmod at all. */
2615 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2616 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2618 #endif /* DJGPP version 2 or newer */
2619 #endif /* not WINDOWSNT */
2621 /* Discard the unwind protects. */
2622 specpdl_ptr = specpdl + count;
2624 UNGCPRO;
2625 return Qnil;
2628 DEFUN ("make-directory-internal", Fmake_directory_internal,
2629 Smake_directory_internal, 1, 1, 0,
2630 doc: /* Create a new directory named DIRECTORY. */)
2631 (directory)
2632 Lisp_Object directory;
2634 const unsigned char *dir;
2635 Lisp_Object handler;
2636 Lisp_Object encoded_dir;
2638 CHECK_STRING (directory);
2639 directory = Fexpand_file_name (directory, Qnil);
2641 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2642 if (!NILP (handler))
2643 return call2 (handler, Qmake_directory_internal, directory);
2645 encoded_dir = ENCODE_FILE (directory);
2647 dir = SDATA (encoded_dir);
2649 #ifdef WINDOWSNT
2650 if (mkdir (dir) != 0)
2651 #else
2652 if (mkdir (dir, 0777) != 0)
2653 #endif
2654 report_file_error ("Creating directory", list1 (directory));
2656 return Qnil;
2659 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2660 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2661 (directory)
2662 Lisp_Object directory;
2664 const unsigned char *dir;
2665 Lisp_Object handler;
2666 Lisp_Object encoded_dir;
2668 CHECK_STRING (directory);
2669 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2671 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2672 if (!NILP (handler))
2673 return call2 (handler, Qdelete_directory, directory);
2675 encoded_dir = ENCODE_FILE (directory);
2677 dir = SDATA (encoded_dir);
2679 if (rmdir (dir) != 0)
2680 report_file_error ("Removing directory", list1 (directory));
2682 return Qnil;
2685 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2686 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2687 If file has multiple names, it continues to exist with the other names. */)
2688 (filename)
2689 Lisp_Object filename;
2691 Lisp_Object handler;
2692 Lisp_Object encoded_file;
2693 struct gcpro gcpro1;
2695 GCPRO1 (filename);
2696 if (!NILP (Ffile_directory_p (filename))
2697 && NILP (Ffile_symlink_p (filename)))
2698 xsignal2 (Qfile_error,
2699 build_string ("Removing old name: is a directory"),
2700 filename);
2701 UNGCPRO;
2702 filename = Fexpand_file_name (filename, Qnil);
2704 handler = Ffind_file_name_handler (filename, Qdelete_file);
2705 if (!NILP (handler))
2706 return call2 (handler, Qdelete_file, filename);
2708 encoded_file = ENCODE_FILE (filename);
2710 if (0 > unlink (SDATA (encoded_file)))
2711 report_file_error ("Removing old name", list1 (filename));
2712 return Qnil;
2715 static Lisp_Object
2716 internal_delete_file_1 (ignore)
2717 Lisp_Object ignore;
2719 return Qt;
2722 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2725 internal_delete_file (filename)
2726 Lisp_Object filename;
2728 Lisp_Object tem;
2729 tem = internal_condition_case_1 (Fdelete_file, filename,
2730 Qt, internal_delete_file_1);
2731 return NILP (tem);
2734 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2735 "fRename file: \nGRename %s to file: \np",
2736 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2737 If file has names other than FILE, it continues to have those names.
2738 Signals a `file-already-exists' error if a file NEWNAME already exists
2739 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2740 A number as third arg means request confirmation if NEWNAME already exists.
2741 This is what happens in interactive use with M-x. */)
2742 (file, newname, ok_if_already_exists)
2743 Lisp_Object file, newname, ok_if_already_exists;
2745 Lisp_Object handler;
2746 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2747 Lisp_Object encoded_file, encoded_newname, symlink_target;
2749 symlink_target = encoded_file = encoded_newname = Qnil;
2750 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2751 CHECK_STRING (file);
2752 CHECK_STRING (newname);
2753 file = Fexpand_file_name (file, Qnil);
2755 if ((!NILP (Ffile_directory_p (newname)))
2756 #ifdef DOS_NT
2757 /* If the file names are identical but for the case,
2758 don't attempt to move directory to itself. */
2759 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2760 #endif
2762 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2763 else
2764 newname = Fexpand_file_name (newname, Qnil);
2766 /* If the file name has special constructs in it,
2767 call the corresponding file handler. */
2768 handler = Ffind_file_name_handler (file, Qrename_file);
2769 if (NILP (handler))
2770 handler = Ffind_file_name_handler (newname, Qrename_file);
2771 if (!NILP (handler))
2772 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2773 file, newname, ok_if_already_exists));
2775 encoded_file = ENCODE_FILE (file);
2776 encoded_newname = ENCODE_FILE (newname);
2778 #ifdef DOS_NT
2779 /* If the file names are identical but for the case, don't ask for
2780 confirmation: they simply want to change the letter-case of the
2781 file name. */
2782 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2783 #endif
2784 if (NILP (ok_if_already_exists)
2785 || INTEGERP (ok_if_already_exists))
2786 barf_or_query_if_file_exists (newname, "rename to it",
2787 INTEGERP (ok_if_already_exists), 0, 0);
2788 #ifndef BSD4_1
2789 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2790 #else
2791 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2792 || 0 > unlink (SDATA (encoded_file)))
2793 #endif
2795 if (errno == EXDEV)
2797 #ifdef S_IFLNK
2798 symlink_target = Ffile_symlink_p (file);
2799 if (! NILP (symlink_target))
2800 Fmake_symbolic_link (symlink_target, newname,
2801 NILP (ok_if_already_exists) ? Qnil : Qt);
2802 else
2803 #endif
2804 Fcopy_file (file, newname,
2805 /* We have already prompted if it was an integer,
2806 so don't have copy-file prompt again. */
2807 NILP (ok_if_already_exists) ? Qnil : Qt,
2808 Qt, Qt);
2810 Fdelete_file (file);
2812 else
2813 report_file_error ("Renaming", list2 (file, newname));
2815 UNGCPRO;
2816 return Qnil;
2819 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2820 "fAdd name to file: \nGName to add to %s: \np",
2821 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2822 Signals a `file-already-exists' error if a file NEWNAME already exists
2823 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2824 A number as third arg means request confirmation if NEWNAME already exists.
2825 This is what happens in interactive use with M-x. */)
2826 (file, newname, ok_if_already_exists)
2827 Lisp_Object file, newname, ok_if_already_exists;
2829 Lisp_Object handler;
2830 Lisp_Object encoded_file, encoded_newname;
2831 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2833 GCPRO4 (file, newname, encoded_file, encoded_newname);
2834 encoded_file = encoded_newname = Qnil;
2835 CHECK_STRING (file);
2836 CHECK_STRING (newname);
2837 file = Fexpand_file_name (file, Qnil);
2839 if (!NILP (Ffile_directory_p (newname)))
2840 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2841 else
2842 newname = Fexpand_file_name (newname, Qnil);
2844 /* If the file name has special constructs in it,
2845 call the corresponding file handler. */
2846 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2847 if (!NILP (handler))
2848 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2849 newname, ok_if_already_exists));
2851 /* If the new name has special constructs in it,
2852 call the corresponding file handler. */
2853 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2854 if (!NILP (handler))
2855 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2856 newname, ok_if_already_exists));
2858 encoded_file = ENCODE_FILE (file);
2859 encoded_newname = ENCODE_FILE (newname);
2861 if (NILP (ok_if_already_exists)
2862 || INTEGERP (ok_if_already_exists))
2863 barf_or_query_if_file_exists (newname, "make it a new name",
2864 INTEGERP (ok_if_already_exists), 0, 0);
2866 unlink (SDATA (newname));
2867 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2868 report_file_error ("Adding new name", list2 (file, newname));
2870 UNGCPRO;
2871 return Qnil;
2874 #ifdef S_IFLNK
2875 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2876 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2877 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2878 Both args must be strings.
2879 Signals a `file-already-exists' error if a file LINKNAME already exists
2880 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2881 A number as third arg means request confirmation if LINKNAME already exists.
2882 This happens for interactive use with M-x. */)
2883 (filename, linkname, ok_if_already_exists)
2884 Lisp_Object filename, linkname, ok_if_already_exists;
2886 Lisp_Object handler;
2887 Lisp_Object encoded_filename, encoded_linkname;
2888 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2890 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2891 encoded_filename = encoded_linkname = Qnil;
2892 CHECK_STRING (filename);
2893 CHECK_STRING (linkname);
2894 /* If the link target has a ~, we must expand it to get
2895 a truly valid file name. Otherwise, do not expand;
2896 we want to permit links to relative file names. */
2897 if (SREF (filename, 0) == '~')
2898 filename = Fexpand_file_name (filename, Qnil);
2900 if (!NILP (Ffile_directory_p (linkname)))
2901 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2902 else
2903 linkname = Fexpand_file_name (linkname, Qnil);
2905 /* If the file name has special constructs in it,
2906 call the corresponding file handler. */
2907 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2908 if (!NILP (handler))
2909 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2910 linkname, ok_if_already_exists));
2912 /* If the new link name has special constructs in it,
2913 call the corresponding file handler. */
2914 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2915 if (!NILP (handler))
2916 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2917 linkname, ok_if_already_exists));
2919 encoded_filename = ENCODE_FILE (filename);
2920 encoded_linkname = ENCODE_FILE (linkname);
2922 if (NILP (ok_if_already_exists)
2923 || INTEGERP (ok_if_already_exists))
2924 barf_or_query_if_file_exists (linkname, "make it a link",
2925 INTEGERP (ok_if_already_exists), 0, 0);
2926 if (0 > symlink (SDATA (encoded_filename),
2927 SDATA (encoded_linkname)))
2929 /* If we didn't complain already, silently delete existing file. */
2930 if (errno == EEXIST)
2932 unlink (SDATA (encoded_linkname));
2933 if (0 <= symlink (SDATA (encoded_filename),
2934 SDATA (encoded_linkname)))
2936 UNGCPRO;
2937 return Qnil;
2941 report_file_error ("Making symbolic link", list2 (filename, linkname));
2943 UNGCPRO;
2944 return Qnil;
2946 #endif /* S_IFLNK */
2948 #ifdef VMS
2950 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2951 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2952 doc: /* Define the job-wide logical name NAME to have the value STRING.
2953 If STRING is nil or a null string, the logical name NAME is deleted. */)
2954 (name, string)
2955 Lisp_Object name;
2956 Lisp_Object string;
2958 CHECK_STRING (name);
2959 if (NILP (string))
2960 delete_logical_name (SDATA (name));
2961 else
2963 CHECK_STRING (string);
2965 if (SCHARS (string) == 0)
2966 delete_logical_name (SDATA (name));
2967 else
2968 define_logical_name (SDATA (name), SDATA (string));
2971 return string;
2973 #endif /* VMS */
2975 #ifdef HPUX_NET
2977 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2978 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2979 (path, login)
2980 Lisp_Object path, login;
2982 int netresult;
2984 CHECK_STRING (path);
2985 CHECK_STRING (login);
2987 netresult = netunam (SDATA (path), SDATA (login));
2989 if (netresult == -1)
2990 return Qnil;
2991 else
2992 return Qt;
2994 #endif /* HPUX_NET */
2996 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2997 1, 1, 0,
2998 doc: /* Return t if file FILENAME specifies an absolute file name.
2999 On Unix, this is a name starting with a `/' or a `~'. */)
3000 (filename)
3001 Lisp_Object filename;
3003 CHECK_STRING (filename);
3004 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3007 /* Return nonzero if file FILENAME exists and can be executed. */
3009 static int
3010 check_executable (filename)
3011 char *filename;
3013 #ifdef DOS_NT
3014 int len = strlen (filename);
3015 char *suffix;
3016 struct stat st;
3017 if (stat (filename, &st) < 0)
3018 return 0;
3019 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3020 return ((st.st_mode & S_IEXEC) != 0);
3021 #else
3022 return (S_ISREG (st.st_mode)
3023 && len >= 5
3024 && (stricmp ((suffix = filename + len-4), ".com") == 0
3025 || stricmp (suffix, ".exe") == 0
3026 || stricmp (suffix, ".bat") == 0)
3027 || (st.st_mode & S_IFMT) == S_IFDIR);
3028 #endif /* not WINDOWSNT */
3029 #else /* not DOS_NT */
3030 #ifdef HAVE_EUIDACCESS
3031 return (euidaccess (filename, 1) >= 0);
3032 #else
3033 /* Access isn't quite right because it uses the real uid
3034 and we really want to test with the effective uid.
3035 But Unix doesn't give us a right way to do it. */
3036 return (access (filename, 1) >= 0);
3037 #endif
3038 #endif /* not DOS_NT */
3041 /* Return nonzero if file FILENAME exists and can be written. */
3043 static int
3044 check_writable (filename)
3045 char *filename;
3047 #ifdef MSDOS
3048 struct stat st;
3049 if (stat (filename, &st) < 0)
3050 return 0;
3051 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3052 #else /* not MSDOS */
3053 #ifdef HAVE_EUIDACCESS
3054 return (euidaccess (filename, 2) >= 0);
3055 #else
3056 /* Access isn't quite right because it uses the real uid
3057 and we really want to test with the effective uid.
3058 But Unix doesn't give us a right way to do it.
3059 Opening with O_WRONLY could work for an ordinary file,
3060 but would lose for directories. */
3061 return (access (filename, 2) >= 0);
3062 #endif
3063 #endif /* not MSDOS */
3066 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3067 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3068 See also `file-readable-p' and `file-attributes'.
3069 This returns nil for a symlink to a nonexistent file.
3070 Use `file-symlink-p' to test for such links. */)
3071 (filename)
3072 Lisp_Object filename;
3074 Lisp_Object absname;
3075 Lisp_Object handler;
3076 struct stat statbuf;
3078 CHECK_STRING (filename);
3079 absname = Fexpand_file_name (filename, Qnil);
3081 /* If the file name has special constructs in it,
3082 call the corresponding file handler. */
3083 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3084 if (!NILP (handler))
3085 return call2 (handler, Qfile_exists_p, absname);
3087 absname = ENCODE_FILE (absname);
3089 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3092 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3093 doc: /* Return t if FILENAME can be executed by you.
3094 For a directory, this means you can access files in that directory. */)
3095 (filename)
3096 Lisp_Object filename;
3098 Lisp_Object absname;
3099 Lisp_Object handler;
3101 CHECK_STRING (filename);
3102 absname = Fexpand_file_name (filename, Qnil);
3104 /* If the file name has special constructs in it,
3105 call the corresponding file handler. */
3106 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3107 if (!NILP (handler))
3108 return call2 (handler, Qfile_executable_p, absname);
3110 absname = ENCODE_FILE (absname);
3112 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3115 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3116 doc: /* Return t if file FILENAME exists and you can read it.
3117 See also `file-exists-p' and `file-attributes'. */)
3118 (filename)
3119 Lisp_Object filename;
3121 Lisp_Object absname;
3122 Lisp_Object handler;
3123 int desc;
3124 int flags;
3125 struct stat statbuf;
3127 CHECK_STRING (filename);
3128 absname = Fexpand_file_name (filename, Qnil);
3130 /* If the file name has special constructs in it,
3131 call the corresponding file handler. */
3132 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3133 if (!NILP (handler))
3134 return call2 (handler, Qfile_readable_p, absname);
3136 absname = ENCODE_FILE (absname);
3138 #if defined(DOS_NT) || defined(macintosh)
3139 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3140 directories. */
3141 if (access (SDATA (absname), 0) == 0)
3142 return Qt;
3143 return Qnil;
3144 #else /* not DOS_NT and not macintosh */
3145 flags = O_RDONLY;
3146 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3147 /* Opening a fifo without O_NONBLOCK can wait.
3148 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3149 except in the case of a fifo, on a system which handles it. */
3150 desc = stat (SDATA (absname), &statbuf);
3151 if (desc < 0)
3152 return Qnil;
3153 if (S_ISFIFO (statbuf.st_mode))
3154 flags |= O_NONBLOCK;
3155 #endif
3156 desc = emacs_open (SDATA (absname), flags, 0);
3157 if (desc < 0)
3158 return Qnil;
3159 emacs_close (desc);
3160 return Qt;
3161 #endif /* not DOS_NT and not macintosh */
3164 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3165 on the RT/PC. */
3166 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3167 doc: /* Return t if file FILENAME can be written or created by you. */)
3168 (filename)
3169 Lisp_Object filename;
3171 Lisp_Object absname, dir, encoded;
3172 Lisp_Object handler;
3173 struct stat statbuf;
3175 CHECK_STRING (filename);
3176 absname = Fexpand_file_name (filename, Qnil);
3178 /* If the file name has special constructs in it,
3179 call the corresponding file handler. */
3180 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3181 if (!NILP (handler))
3182 return call2 (handler, Qfile_writable_p, absname);
3184 encoded = ENCODE_FILE (absname);
3185 if (stat (SDATA (encoded), &statbuf) >= 0)
3186 return (check_writable (SDATA (encoded))
3187 ? Qt : Qnil);
3189 dir = Ffile_name_directory (absname);
3190 #ifdef VMS
3191 if (!NILP (dir))
3192 dir = Fdirectory_file_name (dir);
3193 #endif /* VMS */
3194 #ifdef MSDOS
3195 if (!NILP (dir))
3196 dir = Fdirectory_file_name (dir);
3197 #endif /* MSDOS */
3199 dir = ENCODE_FILE (dir);
3200 #ifdef WINDOWSNT
3201 /* The read-only attribute of the parent directory doesn't affect
3202 whether a file or directory can be created within it. Some day we
3203 should check ACLs though, which do affect this. */
3204 if (stat (SDATA (dir), &statbuf) < 0)
3205 return Qnil;
3206 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3207 #else
3208 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3209 ? Qt : Qnil);
3210 #endif
3213 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3214 doc: /* Access file FILENAME, and get an error if that does not work.
3215 The second argument STRING is used in the error message.
3216 If there is no error, returns nil. */)
3217 (filename, string)
3218 Lisp_Object filename, string;
3220 Lisp_Object handler, encoded_filename, absname;
3221 int fd;
3223 CHECK_STRING (filename);
3224 absname = Fexpand_file_name (filename, Qnil);
3226 CHECK_STRING (string);
3228 /* If the file name has special constructs in it,
3229 call the corresponding file handler. */
3230 handler = Ffind_file_name_handler (absname, Qaccess_file);
3231 if (!NILP (handler))
3232 return call3 (handler, Qaccess_file, absname, string);
3234 encoded_filename = ENCODE_FILE (absname);
3236 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3237 if (fd < 0)
3238 report_file_error (SDATA (string), Fcons (filename, Qnil));
3239 emacs_close (fd);
3241 return Qnil;
3244 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3245 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3246 The value is the link target, as a string.
3247 Otherwise it returns nil.
3249 This function returns t when given the name of a symlink that
3250 points to a nonexistent file. */)
3251 (filename)
3252 Lisp_Object filename;
3254 Lisp_Object handler;
3256 CHECK_STRING (filename);
3257 filename = Fexpand_file_name (filename, Qnil);
3259 /* If the file name has special constructs in it,
3260 call the corresponding file handler. */
3261 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3262 if (!NILP (handler))
3263 return call2 (handler, Qfile_symlink_p, filename);
3265 #ifdef S_IFLNK
3267 char *buf;
3268 int bufsize;
3269 int valsize;
3270 Lisp_Object val;
3272 filename = ENCODE_FILE (filename);
3274 bufsize = 50;
3275 buf = NULL;
3278 bufsize *= 2;
3279 buf = (char *) xrealloc (buf, bufsize);
3280 bzero (buf, bufsize);
3282 errno = 0;
3283 valsize = readlink (SDATA (filename), buf, bufsize);
3284 if (valsize == -1)
3286 #ifdef ERANGE
3287 /* HP-UX reports ERANGE if buffer is too small. */
3288 if (errno == ERANGE)
3289 valsize = bufsize;
3290 else
3291 #endif
3293 xfree (buf);
3294 return Qnil;
3298 while (valsize >= bufsize);
3300 val = make_string (buf, valsize);
3301 if (buf[0] == '/' && index (buf, ':'))
3302 val = concat2 (build_string ("/:"), val);
3303 xfree (buf);
3304 val = DECODE_FILE (val);
3305 return val;
3307 #else /* not S_IFLNK */
3308 return Qnil;
3309 #endif /* not S_IFLNK */
3312 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3313 doc: /* Return t if FILENAME names an existing directory.
3314 Symbolic links to directories count as directories.
3315 See `file-symlink-p' to distinguish symlinks. */)
3316 (filename)
3317 Lisp_Object filename;
3319 register Lisp_Object absname;
3320 struct stat st;
3321 Lisp_Object handler;
3323 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3325 /* If the file name has special constructs in it,
3326 call the corresponding file handler. */
3327 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3328 if (!NILP (handler))
3329 return call2 (handler, Qfile_directory_p, absname);
3331 absname = ENCODE_FILE (absname);
3333 if (stat (SDATA (absname), &st) < 0)
3334 return Qnil;
3335 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3338 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3339 doc: /* Return t if file FILENAME names a directory you can open.
3340 For the value to be t, FILENAME must specify the name of a directory as a file,
3341 and the directory must allow you to open files in it. In order to use a
3342 directory as a buffer's current directory, this predicate must return true.
3343 A directory name spec may be given instead; then the value is t
3344 if the directory so specified exists and really is a readable and
3345 searchable directory. */)
3346 (filename)
3347 Lisp_Object filename;
3349 Lisp_Object handler;
3350 int tem;
3351 struct gcpro gcpro1;
3353 /* If the file name has special constructs in it,
3354 call the corresponding file handler. */
3355 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3356 if (!NILP (handler))
3357 return call2 (handler, Qfile_accessible_directory_p, filename);
3359 GCPRO1 (filename);
3360 tem = (NILP (Ffile_directory_p (filename))
3361 || NILP (Ffile_executable_p (filename)));
3362 UNGCPRO;
3363 return tem ? Qnil : Qt;
3366 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3367 doc: /* Return t if FILENAME names a regular file.
3368 This is the sort of file that holds an ordinary stream of data bytes.
3369 Symbolic links to regular files count as regular files.
3370 See `file-symlink-p' to distinguish symlinks. */)
3371 (filename)
3372 Lisp_Object filename;
3374 register Lisp_Object absname;
3375 struct stat st;
3376 Lisp_Object handler;
3378 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3380 /* If the file name has special constructs in it,
3381 call the corresponding file handler. */
3382 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3383 if (!NILP (handler))
3384 return call2 (handler, Qfile_regular_p, absname);
3386 absname = ENCODE_FILE (absname);
3388 #ifdef WINDOWSNT
3390 int result;
3391 Lisp_Object tem = Vw32_get_true_file_attributes;
3393 /* Tell stat to use expensive method to get accurate info. */
3394 Vw32_get_true_file_attributes = Qt;
3395 result = stat (SDATA (absname), &st);
3396 Vw32_get_true_file_attributes = tem;
3398 if (result < 0)
3399 return Qnil;
3400 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3402 #else
3403 if (stat (SDATA (absname), &st) < 0)
3404 return Qnil;
3405 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3406 #endif
3409 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3410 doc: /* Return mode bits of file named FILENAME, as an integer.
3411 Return nil, if file does not exist or is not accessible. */)
3412 (filename)
3413 Lisp_Object filename;
3415 Lisp_Object absname;
3416 struct stat st;
3417 Lisp_Object handler;
3419 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3421 /* If the file name has special constructs in it,
3422 call the corresponding file handler. */
3423 handler = Ffind_file_name_handler (absname, Qfile_modes);
3424 if (!NILP (handler))
3425 return call2 (handler, Qfile_modes, absname);
3427 absname = ENCODE_FILE (absname);
3429 if (stat (SDATA (absname), &st) < 0)
3430 return Qnil;
3431 #if defined (MSDOS) && __DJGPP__ < 2
3432 if (check_executable (SDATA (absname)))
3433 st.st_mode |= S_IEXEC;
3434 #endif /* MSDOS && __DJGPP__ < 2 */
3436 return make_number (st.st_mode & 07777);
3439 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3440 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3441 Only the 12 low bits of MODE are used. */)
3442 (filename, mode)
3443 Lisp_Object filename, mode;
3445 Lisp_Object absname, encoded_absname;
3446 Lisp_Object handler;
3448 absname = Fexpand_file_name (filename, current_buffer->directory);
3449 CHECK_NUMBER (mode);
3451 /* If the file name has special constructs in it,
3452 call the corresponding file handler. */
3453 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3454 if (!NILP (handler))
3455 return call3 (handler, Qset_file_modes, absname, mode);
3457 encoded_absname = ENCODE_FILE (absname);
3459 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3460 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3462 return Qnil;
3465 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3466 doc: /* Set the file permission bits for newly created files.
3467 The argument MODE should be an integer; only the low 9 bits are used.
3468 This setting is inherited by subprocesses. */)
3469 (mode)
3470 Lisp_Object mode;
3472 CHECK_NUMBER (mode);
3474 umask ((~ XINT (mode)) & 0777);
3476 return Qnil;
3479 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3480 doc: /* Return the default file protection for created files.
3481 The value is an integer. */)
3484 int realmask;
3485 Lisp_Object value;
3487 realmask = umask (0);
3488 umask (realmask);
3490 XSETINT (value, (~ realmask) & 0777);
3491 return value;
3494 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3496 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3497 doc: /* Set times of file FILENAME to TIME.
3498 Set both access and modification times.
3499 Return t on success, else nil.
3500 Use the current time if TIME is nil. TIME is in the format of
3501 `current-time'. */)
3502 (filename, time)
3503 Lisp_Object filename, time;
3505 Lisp_Object absname, encoded_absname;
3506 Lisp_Object handler;
3507 time_t sec;
3508 int usec;
3510 if (! lisp_time_argument (time, &sec, &usec))
3511 error ("Invalid time specification");
3513 absname = Fexpand_file_name (filename, current_buffer->directory);
3515 /* If the file name has special constructs in it,
3516 call the corresponding file handler. */
3517 handler = Ffind_file_name_handler (absname, Qset_file_times);
3518 if (!NILP (handler))
3519 return call3 (handler, Qset_file_times, absname, time);
3521 encoded_absname = ENCODE_FILE (absname);
3524 EMACS_TIME t;
3526 EMACS_SET_SECS (t, sec);
3527 EMACS_SET_USECS (t, usec);
3529 if (set_file_times (SDATA (encoded_absname), t, t))
3531 #ifdef DOS_NT
3532 struct stat st;
3534 /* Setting times on a directory always fails. */
3535 if (stat (SDATA (encoded_absname), &st) == 0
3536 && (st.st_mode & S_IFMT) == S_IFDIR)
3537 return Qnil;
3538 #endif
3539 report_file_error ("Setting file times", Fcons (absname, Qnil));
3540 return Qnil;
3544 return Qt;
3547 #ifdef HAVE_SYNC
3548 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3549 doc: /* Tell Unix to finish all pending disk updates. */)
3552 sync ();
3553 return Qnil;
3556 #endif /* HAVE_SYNC */
3558 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3559 doc: /* Return t if file FILE1 is newer than file FILE2.
3560 If FILE1 does not exist, the answer is nil;
3561 otherwise, if FILE2 does not exist, the answer is t. */)
3562 (file1, file2)
3563 Lisp_Object file1, file2;
3565 Lisp_Object absname1, absname2;
3566 struct stat st;
3567 int mtime1;
3568 Lisp_Object handler;
3569 struct gcpro gcpro1, gcpro2;
3571 CHECK_STRING (file1);
3572 CHECK_STRING (file2);
3574 absname1 = Qnil;
3575 GCPRO2 (absname1, file2);
3576 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3577 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3578 UNGCPRO;
3580 /* If the file name has special constructs in it,
3581 call the corresponding file handler. */
3582 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3583 if (NILP (handler))
3584 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3585 if (!NILP (handler))
3586 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3588 GCPRO2 (absname1, absname2);
3589 absname1 = ENCODE_FILE (absname1);
3590 absname2 = ENCODE_FILE (absname2);
3591 UNGCPRO;
3593 if (stat (SDATA (absname1), &st) < 0)
3594 return Qnil;
3596 mtime1 = st.st_mtime;
3598 if (stat (SDATA (absname2), &st) < 0)
3599 return Qt;
3601 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3604 #ifdef DOS_NT
3605 Lisp_Object Qfind_buffer_file_type;
3606 #endif /* DOS_NT */
3608 #ifndef READ_BUF_SIZE
3609 #define READ_BUF_SIZE (64 << 10)
3610 #endif
3612 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3614 /* This function is called after Lisp functions to decide a coding
3615 system are called, or when they cause an error. Before they are
3616 called, the current buffer is set unibyte and it contains only a
3617 newly inserted text (thus the buffer was empty before the
3618 insertion).
3620 The functions may set markers, overlays, text properties, or even
3621 alter the buffer contents, change the current buffer.
3623 Here, we reset all those changes by:
3624 o set back the current buffer.
3625 o move all markers and overlays to BEG.
3626 o remove all text properties.
3627 o set back the buffer multibyteness. */
3629 static Lisp_Object
3630 decide_coding_unwind (unwind_data)
3631 Lisp_Object unwind_data;
3633 Lisp_Object multibyte, undo_list, buffer;
3635 multibyte = XCAR (unwind_data);
3636 unwind_data = XCDR (unwind_data);
3637 undo_list = XCAR (unwind_data);
3638 buffer = XCDR (unwind_data);
3640 if (current_buffer != XBUFFER (buffer))
3641 set_buffer_internal (XBUFFER (buffer));
3642 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3643 adjust_overlays_for_delete (BEG, Z - BEG);
3644 BUF_INTERVALS (current_buffer) = 0;
3645 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3647 /* Now we are safe to change the buffer's multibyteness directly. */
3648 current_buffer->enable_multibyte_characters = multibyte;
3649 current_buffer->undo_list = undo_list;
3651 return Qnil;
3655 /* Used to pass values from insert-file-contents to read_non_regular. */
3657 static int non_regular_fd;
3658 static int non_regular_inserted;
3659 static int non_regular_nbytes;
3662 /* Read from a non-regular file.
3663 Read non_regular_trytry bytes max from non_regular_fd.
3664 Non_regular_inserted specifies where to put the read bytes.
3665 Value is the number of bytes read. */
3667 static Lisp_Object
3668 read_non_regular ()
3670 int nbytes;
3672 immediate_quit = 1;
3673 QUIT;
3674 nbytes = emacs_read (non_regular_fd,
3675 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3676 non_regular_nbytes);
3677 immediate_quit = 0;
3678 return make_number (nbytes);
3682 /* Condition-case handler used when reading from non-regular files
3683 in insert-file-contents. */
3685 static Lisp_Object
3686 read_non_regular_quit ()
3688 return Qnil;
3692 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3693 1, 5, 0,
3694 doc: /* Insert contents of file FILENAME after point.
3695 Returns list of absolute file name and number of characters inserted.
3696 If second argument VISIT is non-nil, the buffer's visited filename
3697 and last save file modtime are set, and it is marked unmodified.
3698 If visiting and the file does not exist, visiting is completed
3699 before the error is signaled.
3700 The optional third and fourth arguments BEG and END
3701 specify what portion of the file to insert.
3702 These arguments count bytes in the file, not characters in the buffer.
3703 If VISIT is non-nil, BEG and END must be nil.
3705 If optional fifth argument REPLACE is non-nil,
3706 it means replace the current buffer contents (in the accessible portion)
3707 with the file contents. This is better than simply deleting and inserting
3708 the whole thing because (1) it preserves some marker positions
3709 and (2) it puts less data in the undo list.
3710 When REPLACE is non-nil, the value is the number of characters actually read,
3711 which is often less than the number of characters to be read.
3713 This does code conversion according to the value of
3714 `coding-system-for-read' or `file-coding-system-alist',
3715 and sets the variable `last-coding-system-used' to the coding system
3716 actually used. */)
3717 (filename, visit, beg, end, replace)
3718 Lisp_Object filename, visit, beg, end, replace;
3720 struct stat st;
3721 register int fd;
3722 int inserted = 0;
3723 register int how_much;
3724 register int unprocessed;
3725 int count = SPECPDL_INDEX ();
3726 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3727 Lisp_Object handler, val, insval, orig_filename;
3728 Lisp_Object p;
3729 int total = 0;
3730 int not_regular = 0;
3731 unsigned char read_buf[READ_BUF_SIZE];
3732 struct coding_system coding;
3733 unsigned char buffer[1 << 14];
3734 int replace_handled = 0;
3735 int set_coding_system = 0;
3736 int coding_system_decided = 0;
3737 int read_quit = 0;
3738 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3739 int we_locked_file = 0;
3741 if (current_buffer->base_buffer && ! NILP (visit))
3742 error ("Cannot do file visiting in an indirect buffer");
3744 if (!NILP (current_buffer->read_only))
3745 Fbarf_if_buffer_read_only ();
3747 val = Qnil;
3748 p = Qnil;
3749 orig_filename = Qnil;
3751 GCPRO4 (filename, val, p, orig_filename);
3753 CHECK_STRING (filename);
3754 filename = Fexpand_file_name (filename, Qnil);
3756 /* If the file name has special constructs in it,
3757 call the corresponding file handler. */
3758 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3759 if (!NILP (handler))
3761 val = call6 (handler, Qinsert_file_contents, filename,
3762 visit, beg, end, replace);
3763 if (CONSP (val) && CONSP (XCDR (val)))
3764 inserted = XINT (XCAR (XCDR (val)));
3765 goto handled;
3768 orig_filename = filename;
3769 filename = ENCODE_FILE (filename);
3771 fd = -1;
3773 #ifdef WINDOWSNT
3775 Lisp_Object tem = Vw32_get_true_file_attributes;
3777 /* Tell stat to use expensive method to get accurate info. */
3778 Vw32_get_true_file_attributes = Qt;
3779 total = stat (SDATA (filename), &st);
3780 Vw32_get_true_file_attributes = tem;
3782 if (total < 0)
3783 #else
3784 #ifndef APOLLO
3785 if (stat (SDATA (filename), &st) < 0)
3786 #else
3787 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3788 || fstat (fd, &st) < 0)
3789 #endif /* not APOLLO */
3790 #endif /* WINDOWSNT */
3792 if (fd >= 0) emacs_close (fd);
3793 badopen:
3794 if (NILP (visit))
3795 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3796 st.st_mtime = -1;
3797 how_much = 0;
3798 if (!NILP (Vcoding_system_for_read))
3799 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3800 goto notfound;
3803 #ifdef S_IFREG
3804 /* This code will need to be changed in order to work on named
3805 pipes, and it's probably just not worth it. So we should at
3806 least signal an error. */
3807 if (!S_ISREG (st.st_mode))
3809 not_regular = 1;
3811 if (! NILP (visit))
3812 goto notfound;
3814 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3815 xsignal2 (Qfile_error,
3816 build_string ("not a regular file"), orig_filename);
3818 #endif
3820 if (fd < 0)
3821 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3822 goto badopen;
3824 /* Replacement should preserve point as it preserves markers. */
3825 if (!NILP (replace))
3826 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3828 record_unwind_protect (close_file_unwind, make_number (fd));
3830 /* Supposedly happens on VMS. */
3831 /* Can happen on any platform that uses long as type of off_t, but allows
3832 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3833 give a message suitable for the latter case. */
3834 if (! not_regular && st.st_size < 0)
3835 error ("Maximum buffer size exceeded");
3837 /* Prevent redisplay optimizations. */
3838 current_buffer->clip_changed = 1;
3840 if (!NILP (visit))
3842 if (!NILP (beg) || !NILP (end))
3843 error ("Attempt to visit less than an entire file");
3844 if (BEG < Z && NILP (replace))
3845 error ("Cannot do file visiting in a non-empty buffer");
3848 if (!NILP (beg))
3849 CHECK_NUMBER (beg);
3850 else
3851 XSETFASTINT (beg, 0);
3853 if (!NILP (end))
3854 CHECK_NUMBER (end);
3855 else
3857 if (! not_regular)
3859 XSETINT (end, st.st_size);
3861 /* Arithmetic overflow can occur if an Emacs integer cannot
3862 represent the file size, or if the calculations below
3863 overflow. The calculations below double the file size
3864 twice, so check that it can be multiplied by 4 safely. */
3865 if (XINT (end) != st.st_size
3866 || ((int) st.st_size * 4) / 4 != st.st_size)
3867 error ("Maximum buffer size exceeded");
3869 /* The file size returned from stat may be zero, but data
3870 may be readable nonetheless, for example when this is a
3871 file in the /proc filesystem. */
3872 if (st.st_size == 0)
3873 XSETINT (end, READ_BUF_SIZE);
3877 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3879 /* We use emacs-mule for auto saving... */
3880 setup_coding_system (Qemacs_mule, &coding);
3881 /* ... but with the special flag to indicate to read in a
3882 multibyte sequence for eight-bit-control char as is. */
3883 coding.flags = 1;
3884 coding.src_multibyte = 0;
3885 coding.dst_multibyte
3886 = !NILP (current_buffer->enable_multibyte_characters);
3887 coding.eol_type = CODING_EOL_LF;
3888 coding_system_decided = 1;
3890 else if (BEG < Z)
3892 /* Decide the coding system to use for reading the file now
3893 because we can't use an optimized method for handling
3894 `coding:' tag if the current buffer is not empty. */
3895 Lisp_Object val;
3896 val = Qnil;
3898 if (!NILP (Vcoding_system_for_read))
3899 val = Vcoding_system_for_read;
3900 else
3902 /* Don't try looking inside a file for a coding system
3903 specification if it is not seekable. */
3904 if (! not_regular && ! NILP (Vset_auto_coding_function))
3906 /* Find a coding system specified in the heading two
3907 lines or in the tailing several lines of the file.
3908 We assume that the 1K-byte and 3K-byte for heading
3909 and tailing respectively are sufficient for this
3910 purpose. */
3911 int nread;
3913 if (st.st_size <= (1024 * 4))
3914 nread = emacs_read (fd, read_buf, 1024 * 4);
3915 else
3917 nread = emacs_read (fd, read_buf, 1024);
3918 if (nread >= 0)
3920 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3921 report_file_error ("Setting file position",
3922 Fcons (orig_filename, Qnil));
3923 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3927 if (nread < 0)
3928 error ("IO error reading %s: %s",
3929 SDATA (orig_filename), emacs_strerror (errno));
3930 else if (nread > 0)
3932 struct buffer *prev = current_buffer;
3933 Lisp_Object buffer;
3934 struct buffer *buf;
3936 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3938 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3939 buf = XBUFFER (buffer);
3941 delete_all_overlays (buf);
3942 buf->directory = current_buffer->directory;
3943 buf->read_only = Qnil;
3944 buf->filename = Qnil;
3945 buf->undo_list = Qt;
3946 eassert (buf->overlays_before == NULL);
3947 eassert (buf->overlays_after == NULL);
3949 set_buffer_internal (buf);
3950 Ferase_buffer ();
3951 buf->enable_multibyte_characters = Qnil;
3953 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3954 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3955 val = call2 (Vset_auto_coding_function,
3956 filename, make_number (nread));
3957 set_buffer_internal (prev);
3959 /* Discard the unwind protect for recovering the
3960 current buffer. */
3961 specpdl_ptr--;
3963 /* Rewind the file for the actual read done later. */
3964 if (lseek (fd, 0, 0) < 0)
3965 report_file_error ("Setting file position",
3966 Fcons (orig_filename, Qnil));
3970 if (NILP (val))
3972 /* If we have not yet decided a coding system, check
3973 file-coding-system-alist. */
3974 Lisp_Object args[6], coding_systems;
3976 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3977 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3978 coding_systems = Ffind_operation_coding_system (6, args);
3979 if (CONSP (coding_systems))
3980 val = XCAR (coding_systems);
3984 setup_coding_system (Fcheck_coding_system (val), &coding);
3985 /* Ensure we set Vlast_coding_system_used. */
3986 set_coding_system = 1;
3988 if (NILP (current_buffer->enable_multibyte_characters)
3989 && ! NILP (val))
3990 /* We must suppress all character code conversion except for
3991 end-of-line conversion. */
3992 setup_raw_text_coding_system (&coding);
3994 coding.src_multibyte = 0;
3995 coding.dst_multibyte
3996 = !NILP (current_buffer->enable_multibyte_characters);
3997 coding_system_decided = 1;
4000 /* If requested, replace the accessible part of the buffer
4001 with the file contents. Avoid replacing text at the
4002 beginning or end of the buffer that matches the file contents;
4003 that preserves markers pointing to the unchanged parts.
4005 Here we implement this feature in an optimized way
4006 for the case where code conversion is NOT needed.
4007 The following if-statement handles the case of conversion
4008 in a less optimal way.
4010 If the code conversion is "automatic" then we try using this
4011 method and hope for the best.
4012 But if we discover the need for conversion, we give up on this method
4013 and let the following if-statement handle the replace job. */
4014 if (!NILP (replace)
4015 && BEGV < ZV
4016 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
4018 /* same_at_start and same_at_end count bytes,
4019 because file access counts bytes
4020 and BEG and END count bytes. */
4021 int same_at_start = BEGV_BYTE;
4022 int same_at_end = ZV_BYTE;
4023 int overlap;
4024 /* There is still a possibility we will find the need to do code
4025 conversion. If that happens, we set this variable to 1 to
4026 give up on handling REPLACE in the optimized way. */
4027 int giveup_match_end = 0;
4029 if (XINT (beg) != 0)
4031 if (lseek (fd, XINT (beg), 0) < 0)
4032 report_file_error ("Setting file position",
4033 Fcons (orig_filename, Qnil));
4036 immediate_quit = 1;
4037 QUIT;
4038 /* Count how many chars at the start of the file
4039 match the text at the beginning of the buffer. */
4040 while (1)
4042 int nread, bufpos;
4044 nread = emacs_read (fd, buffer, sizeof buffer);
4045 if (nread < 0)
4046 error ("IO error reading %s: %s",
4047 SDATA (orig_filename), emacs_strerror (errno));
4048 else if (nread == 0)
4049 break;
4051 if (coding.type == coding_type_undecided)
4052 detect_coding (&coding, buffer, nread);
4053 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
4054 /* We found that the file should be decoded somehow.
4055 Let's give up here. */
4057 giveup_match_end = 1;
4058 break;
4061 if (coding.eol_type == CODING_EOL_UNDECIDED)
4062 detect_eol (&coding, buffer, nread);
4063 if (coding.eol_type != CODING_EOL_UNDECIDED
4064 && coding.eol_type != CODING_EOL_LF)
4065 /* We found that the format of eol should be decoded.
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 int same_at_start = BEGV_BYTE;
4209 int same_at_end = ZV_BYTE;
4210 int overlap;
4211 int bufpos;
4212 /* Make sure that the gap is large enough. */
4213 int bufsize = 2 * st.st_size;
4214 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4215 int temp;
4217 /* First read the whole file, performing code conversion into
4218 CONVERSION_BUFFER. */
4220 if (lseek (fd, XINT (beg), 0) < 0)
4222 xfree (conversion_buffer);
4223 report_file_error ("Setting file position",
4224 Fcons (orig_filename, Qnil));
4227 total = st.st_size; /* Total bytes in the file. */
4228 how_much = 0; /* Bytes read from file so far. */
4229 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4230 unprocessed = 0; /* Bytes not processed in previous loop. */
4232 while (how_much < total)
4234 /* try is reserved in some compilers (Microsoft C) */
4235 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4236 unsigned char *destination = read_buf + unprocessed;
4237 int this;
4239 /* Allow quitting out of the actual I/O. */
4240 immediate_quit = 1;
4241 QUIT;
4242 this = emacs_read (fd, destination, trytry);
4243 immediate_quit = 0;
4245 if (this < 0 || this + unprocessed == 0)
4247 how_much = this;
4248 break;
4251 how_much += this;
4253 if (CODING_MAY_REQUIRE_DECODING (&coding))
4255 int require, result;
4257 this += unprocessed;
4259 /* If we are using more space than estimated,
4260 make CONVERSION_BUFFER bigger. */
4261 require = decoding_buffer_size (&coding, this);
4262 if (inserted + require + 2 * (total - how_much) > bufsize)
4264 bufsize = inserted + require + 2 * (total - how_much);
4265 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4268 /* Convert this batch with results in CONVERSION_BUFFER. */
4269 if (how_much >= total) /* This is the last block. */
4270 coding.mode |= CODING_MODE_LAST_BLOCK;
4271 if (coding.composing != COMPOSITION_DISABLED)
4272 coding_allocate_composition_data (&coding, BEGV);
4273 result = decode_coding (&coding, read_buf,
4274 conversion_buffer + inserted,
4275 this, bufsize - inserted);
4277 /* Save for next iteration whatever we didn't convert. */
4278 unprocessed = this - coding.consumed;
4279 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4280 if (!NILP (current_buffer->enable_multibyte_characters))
4281 this = coding.produced;
4282 else
4283 this = str_as_unibyte (conversion_buffer + inserted,
4284 coding.produced);
4287 inserted += this;
4290 /* At this point, INSERTED is how many characters (i.e. bytes)
4291 are present in CONVERSION_BUFFER.
4292 HOW_MUCH should equal TOTAL,
4293 or should be <= 0 if we couldn't read the file. */
4295 if (how_much < 0)
4297 xfree (conversion_buffer);
4298 coding_free_composition_data (&coding);
4299 error ("IO error reading %s: %s",
4300 SDATA (orig_filename), emacs_strerror (errno));
4303 /* Compare the beginning of the converted file
4304 with the buffer text. */
4306 bufpos = 0;
4307 while (bufpos < inserted && same_at_start < same_at_end
4308 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4309 same_at_start++, bufpos++;
4311 /* If the file matches the buffer completely,
4312 there's no need to replace anything. */
4314 if (bufpos == inserted)
4316 xfree (conversion_buffer);
4317 coding_free_composition_data (&coding);
4318 emacs_close (fd);
4319 specpdl_ptr--;
4320 /* Truncate the buffer to the size of the file. */
4321 del_range_byte (same_at_start, same_at_end, 0);
4322 inserted = 0;
4323 goto handled;
4326 /* Extend the start of non-matching text area to multibyte
4327 character boundary. */
4328 if (! NILP (current_buffer->enable_multibyte_characters))
4329 while (same_at_start > BEGV_BYTE
4330 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4331 same_at_start--;
4333 /* Scan this bufferful from the end, comparing with
4334 the Emacs buffer. */
4335 bufpos = inserted;
4337 /* Compare with same_at_start to avoid counting some buffer text
4338 as matching both at the file's beginning and at the end. */
4339 while (bufpos > 0 && same_at_end > same_at_start
4340 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4341 same_at_end--, bufpos--;
4343 /* Extend the end of non-matching text area to multibyte
4344 character boundary. */
4345 if (! NILP (current_buffer->enable_multibyte_characters))
4346 while (same_at_end < ZV_BYTE
4347 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4348 same_at_end++;
4350 /* Don't try to reuse the same piece of text twice. */
4351 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4352 if (overlap > 0)
4353 same_at_end += overlap;
4355 /* If display currently starts at beginning of line,
4356 keep it that way. */
4357 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4358 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4360 /* Replace the chars that we need to replace,
4361 and update INSERTED to equal the number of bytes
4362 we are taking from the file. */
4363 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4365 if (same_at_end != same_at_start)
4367 del_range_byte (same_at_start, same_at_end, 0);
4368 temp = GPT;
4369 same_at_start = GPT_BYTE;
4371 else
4373 temp = BYTE_TO_CHAR (same_at_start);
4375 /* Insert from the file at the proper position. */
4376 SET_PT_BOTH (temp, same_at_start);
4377 insert_1 (conversion_buffer + same_at_start - BEGV_BYTE, inserted,
4378 0, 0, 0);
4379 if (coding.cmp_data && coding.cmp_data->used)
4380 coding_restore_composition (&coding, Fcurrent_buffer ());
4381 coding_free_composition_data (&coding);
4383 /* Set `inserted' to the number of inserted characters. */
4384 inserted = PT - temp;
4385 /* Set point before the inserted characters. */
4386 SET_PT_BOTH (temp, same_at_start);
4388 xfree (conversion_buffer);
4389 emacs_close (fd);
4390 specpdl_ptr--;
4392 goto handled;
4395 if (! not_regular)
4397 register Lisp_Object temp;
4399 total = XINT (end) - XINT (beg);
4401 /* Make sure point-max won't overflow after this insertion. */
4402 XSETINT (temp, total);
4403 if (total != XINT (temp))
4404 error ("Maximum buffer size exceeded");
4406 else
4407 /* For a special file, all we can do is guess. */
4408 total = READ_BUF_SIZE;
4410 if (NILP (visit) && inserted > 0)
4412 #ifdef CLASH_DETECTION
4413 if (!NILP (current_buffer->file_truename)
4414 /* Make binding buffer-file-name to nil effective. */
4415 && !NILP (current_buffer->filename)
4416 && SAVE_MODIFF >= MODIFF)
4417 we_locked_file = 1;
4418 #endif /* CLASH_DETECTION */
4419 prepare_to_modify_buffer (GPT, GPT, NULL);
4422 move_gap (PT);
4423 if (GAP_SIZE < total)
4424 make_gap (total - GAP_SIZE);
4426 if (XINT (beg) != 0 || !NILP (replace))
4428 if (lseek (fd, XINT (beg), 0) < 0)
4429 report_file_error ("Setting file position",
4430 Fcons (orig_filename, Qnil));
4433 /* In the following loop, HOW_MUCH contains the total bytes read so
4434 far for a regular file, and not changed for a special file. But,
4435 before exiting the loop, it is set to a negative value if I/O
4436 error occurs. */
4437 how_much = 0;
4439 /* Total bytes inserted. */
4440 inserted = 0;
4442 /* Here, we don't do code conversion in the loop. It is done by
4443 code_convert_region after all data are read into the buffer. */
4445 int gap_size = GAP_SIZE;
4447 while (how_much < total)
4449 /* try is reserved in some compilers (Microsoft C) */
4450 int trytry = min (total - how_much, READ_BUF_SIZE);
4451 int this;
4453 if (not_regular)
4455 Lisp_Object val;
4457 /* Maybe make more room. */
4458 if (gap_size < trytry)
4460 make_gap (total - gap_size);
4461 gap_size = GAP_SIZE;
4464 /* Read from the file, capturing `quit'. When an
4465 error occurs, end the loop, and arrange for a quit
4466 to be signaled after decoding the text we read. */
4467 non_regular_fd = fd;
4468 non_regular_inserted = inserted;
4469 non_regular_nbytes = trytry;
4470 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4471 read_non_regular_quit);
4472 if (NILP (val))
4474 read_quit = 1;
4475 break;
4478 this = XINT (val);
4480 else
4482 /* Allow quitting out of the actual I/O. We don't make text
4483 part of the buffer until all the reading is done, so a C-g
4484 here doesn't do any harm. */
4485 immediate_quit = 1;
4486 QUIT;
4487 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4488 immediate_quit = 0;
4491 if (this <= 0)
4493 how_much = this;
4494 break;
4497 gap_size -= this;
4499 /* For a regular file, where TOTAL is the real size,
4500 count HOW_MUCH to compare with it.
4501 For a special file, where TOTAL is just a buffer size,
4502 so don't bother counting in HOW_MUCH.
4503 (INSERTED is where we count the number of characters inserted.) */
4504 if (! not_regular)
4505 how_much += this;
4506 inserted += this;
4510 /* Now we have read all the file data into the gap.
4511 If it was empty, undo marking the buffer modified. */
4513 if (inserted == 0)
4515 #ifdef CLASH_DETECTION
4516 if (we_locked_file)
4517 unlock_file (current_buffer->file_truename);
4518 #endif
4519 Vdeactivate_mark = old_Vdeactivate_mark;
4521 else
4522 Vdeactivate_mark = Qt;
4524 /* Make the text read part of the buffer. */
4525 GAP_SIZE -= inserted;
4526 GPT += inserted;
4527 GPT_BYTE += inserted;
4528 ZV += inserted;
4529 ZV_BYTE += inserted;
4530 Z += inserted;
4531 Z_BYTE += inserted;
4533 if (GAP_SIZE > 0)
4534 /* Put an anchor to ensure multi-byte form ends at gap. */
4535 *GPT_ADDR = 0;
4537 emacs_close (fd);
4539 /* Discard the unwind protect for closing the file. */
4540 specpdl_ptr--;
4542 if (how_much < 0)
4543 error ("IO error reading %s: %s",
4544 SDATA (orig_filename), emacs_strerror (errno));
4546 notfound:
4548 if (! coding_system_decided)
4550 /* The coding system is not yet decided. Decide it by an
4551 optimized method for handling `coding:' tag.
4553 Note that we can get here only if the buffer was empty
4554 before the insertion. */
4555 Lisp_Object val;
4556 val = Qnil;
4558 if (!NILP (Vcoding_system_for_read))
4559 val = Vcoding_system_for_read;
4560 else
4562 /* Since we are sure that the current buffer was empty
4563 before the insertion, we can toggle
4564 enable-multibyte-characters directly here without taking
4565 care of marker adjustment and byte combining problem. By
4566 this way, we can run Lisp program safely before decoding
4567 the inserted text. */
4568 Lisp_Object unwind_data;
4569 int count = SPECPDL_INDEX ();
4571 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4572 Fcons (current_buffer->undo_list,
4573 Fcurrent_buffer ()));
4574 current_buffer->enable_multibyte_characters = Qnil;
4575 current_buffer->undo_list = Qt;
4576 record_unwind_protect (decide_coding_unwind, unwind_data);
4578 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4580 val = call2 (Vset_auto_coding_function,
4581 filename, make_number (inserted));
4584 if (NILP (val))
4586 /* If the coding system is not yet decided, check
4587 file-coding-system-alist. */
4588 Lisp_Object args[6], coding_systems;
4590 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4591 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4592 coding_systems = Ffind_operation_coding_system (6, args);
4593 if (CONSP (coding_systems))
4594 val = XCAR (coding_systems);
4596 unbind_to (count, Qnil);
4597 inserted = Z_BYTE - BEG_BYTE;
4600 /* The following kludgy code is to avoid some compiler bug.
4601 We can't simply do
4602 setup_coding_system (val, &coding);
4603 on some system. */
4605 struct coding_system temp_coding;
4606 setup_coding_system (Fcheck_coding_system (val), &temp_coding);
4607 bcopy (&temp_coding, &coding, sizeof coding);
4609 /* Ensure we set Vlast_coding_system_used. */
4610 set_coding_system = 1;
4612 if (NILP (current_buffer->enable_multibyte_characters)
4613 && ! NILP (val))
4614 /* We must suppress all character code conversion except for
4615 end-of-line conversion. */
4616 setup_raw_text_coding_system (&coding);
4617 coding.src_multibyte = 0;
4618 coding.dst_multibyte
4619 = !NILP (current_buffer->enable_multibyte_characters);
4622 if (!NILP (visit)
4623 /* Can't do this if part of the buffer might be preserved. */
4624 && NILP (replace)
4625 && (coding.type == coding_type_no_conversion
4626 || coding.type == coding_type_raw_text))
4628 /* Visiting a file with these coding system makes the buffer
4629 unibyte. */
4630 current_buffer->enable_multibyte_characters = Qnil;
4631 coding.dst_multibyte = 0;
4634 if (inserted > 0 || coding.type == coding_type_ccl)
4636 if (CODING_MAY_REQUIRE_DECODING (&coding))
4638 if (coding.type == coding_type_ccl)
4639 coding.spec.ccl.decoder.quit_silently = 1;
4640 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4641 &coding, 0, 0);
4642 if (coding.type == coding_type_ccl)
4643 coding.spec.ccl.decoder.quit_silently = 0;
4644 if (coding.result == CODING_FINISH_INTERRUPT)
4646 /* Fixme: It is better that we report that the decoding
4647 was interruppted by the user, and the current buffer
4648 contents doesn't reflect the file correctly. */
4649 Fsignal (Qquit, Qnil);
4651 inserted = coding.produced_char;
4653 else
4654 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4655 inserted);
4658 /* Now INSERTED is measured in characters. */
4660 #ifdef DOS_NT
4661 /* Use the conversion type to determine buffer-file-type
4662 (find-buffer-file-type is now used to help determine the
4663 conversion). */
4664 if ((coding.eol_type == CODING_EOL_UNDECIDED
4665 || coding.eol_type == CODING_EOL_LF)
4666 && ! CODING_REQUIRE_DECODING (&coding))
4667 current_buffer->buffer_file_type = Qt;
4668 else
4669 current_buffer->buffer_file_type = Qnil;
4670 #endif
4672 handled:
4674 if (!NILP (visit))
4676 if (!EQ (current_buffer->undo_list, Qt))
4677 current_buffer->undo_list = Qnil;
4678 #ifdef APOLLO
4679 stat (SDATA (filename), &st);
4680 #endif
4682 if (NILP (handler))
4684 current_buffer->modtime = st.st_mtime;
4685 current_buffer->filename = orig_filename;
4688 SAVE_MODIFF = MODIFF;
4689 current_buffer->auto_save_modified = MODIFF;
4690 XSETFASTINT (current_buffer->save_length, Z - BEG);
4691 #ifdef CLASH_DETECTION
4692 if (NILP (handler))
4694 if (!NILP (current_buffer->file_truename))
4695 unlock_file (current_buffer->file_truename);
4696 unlock_file (filename);
4698 #endif /* CLASH_DETECTION */
4699 if (not_regular)
4700 xsignal2 (Qfile_error,
4701 build_string ("not a regular file"), orig_filename);
4704 if (set_coding_system)
4705 Vlast_coding_system_used = coding.symbol;
4707 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4709 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4710 visit);
4711 if (! NILP (insval))
4713 CHECK_NUMBER (insval);
4714 inserted = XFASTINT (insval);
4718 /* Decode file format */
4719 if (inserted > 0)
4721 int empty_undo_list_p = 0;
4723 /* If we're anyway going to discard undo information, don't
4724 record it in the first place. The buffer's undo list at this
4725 point is either nil or t when visiting a file. */
4726 if (!NILP (visit))
4728 empty_undo_list_p = NILP (current_buffer->undo_list);
4729 current_buffer->undo_list = Qt;
4732 insval = call3 (Qformat_decode,
4733 Qnil, make_number (inserted), visit);
4734 CHECK_NUMBER (insval);
4735 inserted = XFASTINT (insval);
4737 if (!NILP (visit))
4738 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4741 /* Call after-change hooks for the inserted text, aside from the case
4742 of normal visiting (not with REPLACE), which is done in a new buffer
4743 "before" the buffer is changed. */
4744 if (inserted > 0 && total > 0
4745 && (NILP (visit) || !NILP (replace)))
4747 signal_after_change (PT, 0, inserted);
4748 update_compositions (PT, PT, CHECK_BORDER);
4751 p = Vafter_insert_file_functions;
4752 while (CONSP (p))
4754 insval = call1 (XCAR (p), make_number (inserted));
4755 if (!NILP (insval))
4757 CHECK_NUMBER (insval);
4758 inserted = XFASTINT (insval);
4760 QUIT;
4761 p = XCDR (p);
4764 if (!NILP (visit)
4765 && current_buffer->modtime == -1)
4767 /* If visiting nonexistent file, return nil. */
4768 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4771 if (read_quit)
4772 Fsignal (Qquit, Qnil);
4774 /* ??? Retval needs to be dealt with in all cases consistently. */
4775 if (NILP (val))
4776 val = Fcons (orig_filename,
4777 Fcons (make_number (inserted),
4778 Qnil));
4780 RETURN_UNGCPRO (unbind_to (count, val));
4783 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4784 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4785 Lisp_Object, Lisp_Object));
4787 /* If build_annotations switched buffers, switch back to BUF.
4788 Kill the temporary buffer that was selected in the meantime.
4790 Since this kill only the last temporary buffer, some buffers remain
4791 not killed if build_annotations switched buffers more than once.
4792 -- K.Handa */
4794 static Lisp_Object
4795 build_annotations_unwind (buf)
4796 Lisp_Object buf;
4798 Lisp_Object tembuf;
4800 if (XBUFFER (buf) == current_buffer)
4801 return Qnil;
4802 tembuf = Fcurrent_buffer ();
4803 Fset_buffer (buf);
4804 Fkill_buffer (tembuf);
4805 return Qnil;
4808 /* Decide the coding-system to encode the data with. */
4810 void
4811 choose_write_coding_system (start, end, filename,
4812 append, visit, lockname, coding)
4813 Lisp_Object start, end, filename, append, visit, lockname;
4814 struct coding_system *coding;
4816 Lisp_Object val;
4818 if (auto_saving
4819 && NILP (Fstring_equal (current_buffer->filename,
4820 current_buffer->auto_save_file_name)))
4822 /* We use emacs-mule for auto saving... */
4823 setup_coding_system (Qemacs_mule, coding);
4824 /* ... but with the special flag to indicate not to strip off
4825 leading code of eight-bit-control chars. */
4826 coding->flags = 1;
4827 /* We force LF for end-of-line because that is faster. */
4828 coding->eol_type = CODING_EOL_LF;
4829 goto done_setup_coding;
4831 else if (!NILP (Vcoding_system_for_write))
4833 val = Vcoding_system_for_write;
4834 if (coding_system_require_warning
4835 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4836 /* Confirm that VAL can surely encode the current region. */
4837 val = call5 (Vselect_safe_coding_system_function,
4838 start, end, Fcons (Qt, Fcons (val, Qnil)),
4839 Qnil, filename);
4841 else
4843 /* If the variable `buffer-file-coding-system' is set locally,
4844 it means that the file was read with some kind of code
4845 conversion or the variable is explicitly set by users. We
4846 had better write it out with the same coding system even if
4847 `enable-multibyte-characters' is nil.
4849 If it is not set locally, we anyway have to convert EOL
4850 format if the default value of `buffer-file-coding-system'
4851 tells that it is not Unix-like (LF only) format. */
4852 int using_default_coding = 0;
4853 int force_raw_text = 0;
4855 val = current_buffer->buffer_file_coding_system;
4856 if (NILP (val)
4857 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4859 val = Qnil;
4860 if (NILP (current_buffer->enable_multibyte_characters))
4861 force_raw_text = 1;
4864 if (NILP (val))
4866 /* Check file-coding-system-alist. */
4867 Lisp_Object args[7], coding_systems;
4869 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4870 args[3] = filename; args[4] = append; args[5] = visit;
4871 args[6] = lockname;
4872 coding_systems = Ffind_operation_coding_system (7, args);
4873 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4874 val = XCDR (coding_systems);
4877 if (NILP (val)
4878 && !NILP (current_buffer->buffer_file_coding_system))
4880 /* If we still have not decided a coding system, use the
4881 default value of buffer-file-coding-system. */
4882 val = current_buffer->buffer_file_coding_system;
4883 using_default_coding = 1;
4886 if (!force_raw_text
4887 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4888 /* Confirm that VAL can surely encode the current region. */
4889 val = call5 (Vselect_safe_coding_system_function,
4890 start, end, val, Qnil, filename);
4892 setup_coding_system (Fcheck_coding_system (val), coding);
4893 if (coding->eol_type == CODING_EOL_UNDECIDED
4894 && !using_default_coding)
4896 if (! EQ (default_buffer_file_coding.symbol,
4897 buffer_defaults.buffer_file_coding_system))
4898 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4899 &default_buffer_file_coding);
4900 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4902 Lisp_Object subsidiaries;
4904 coding->eol_type = default_buffer_file_coding.eol_type;
4905 subsidiaries = Fget (coding->symbol, Qeol_type);
4906 if (VECTORP (subsidiaries)
4907 && XVECTOR (subsidiaries)->size == 3)
4908 coding->symbol
4909 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4913 if (force_raw_text)
4914 setup_raw_text_coding_system (coding);
4915 goto done_setup_coding;
4918 setup_coding_system (Fcheck_coding_system (val), coding);
4920 done_setup_coding:
4921 if (coding->eol_type == CODING_EOL_UNDECIDED)
4922 coding->eol_type = system_eol_type;
4923 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4924 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4927 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4928 "r\nFWrite region to file: \ni\ni\ni\np",
4929 doc: /* Write current region into specified file.
4930 When called from a program, requires three arguments:
4931 START, END and FILENAME. START and END are normally buffer positions
4932 specifying the part of the buffer to write.
4933 If START is nil, that means to use the entire buffer contents.
4934 If START is a string, then output that string to the file
4935 instead of any buffer contents; END is ignored.
4937 Optional fourth argument APPEND if non-nil means
4938 append to existing file contents (if any). If it is an integer,
4939 seek to that offset in the file before writing.
4940 Optional fifth argument VISIT, if t or a string, means
4941 set the last-save-file-modtime of buffer to this file's modtime
4942 and mark buffer not modified.
4943 If VISIT is a string, it is a second file name;
4944 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4945 VISIT is also the file name to lock and unlock for clash detection.
4946 If VISIT is neither t nor nil nor a string,
4947 that means do not display the \"Wrote file\" message.
4948 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4949 use for locking and unlocking, overriding FILENAME and VISIT.
4950 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4951 for an existing file with the same name. If MUSTBENEW is `excl',
4952 that means to get an error if the file already exists; never overwrite.
4953 If MUSTBENEW is neither nil nor `excl', that means ask for
4954 confirmation before overwriting, but do go ahead and overwrite the file
4955 if the user confirms.
4957 This does code conversion according to the value of
4958 `coding-system-for-write', `buffer-file-coding-system', or
4959 `file-coding-system-alist', and sets the variable
4960 `last-coding-system-used' to the coding system actually used. */)
4961 (start, end, filename, append, visit, lockname, mustbenew)
4962 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4964 register int desc;
4965 int failure;
4966 int save_errno = 0;
4967 const unsigned char *fn;
4968 struct stat st;
4969 int tem;
4970 int count = SPECPDL_INDEX ();
4971 int count1;
4972 #ifdef VMS
4973 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4974 #endif /* VMS */
4975 Lisp_Object handler;
4976 Lisp_Object visit_file;
4977 Lisp_Object annotations;
4978 Lisp_Object encoded_filename;
4979 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4980 int quietly = !NILP (visit);
4981 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4982 struct buffer *given_buffer;
4983 #ifdef DOS_NT
4984 int buffer_file_type = O_BINARY;
4985 #endif /* DOS_NT */
4986 struct coding_system coding;
4988 if (current_buffer->base_buffer && visiting)
4989 error ("Cannot do file visiting in an indirect buffer");
4991 if (!NILP (start) && !STRINGP (start))
4992 validate_region (&start, &end);
4994 visit_file = Qnil;
4995 GCPRO5 (start, filename, visit, visit_file, lockname);
4997 filename = Fexpand_file_name (filename, Qnil);
4999 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
5000 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
5002 if (STRINGP (visit))
5003 visit_file = Fexpand_file_name (visit, Qnil);
5004 else
5005 visit_file = filename;
5007 if (NILP (lockname))
5008 lockname = visit_file;
5010 annotations = Qnil;
5012 /* If the file name has special constructs in it,
5013 call the corresponding file handler. */
5014 handler = Ffind_file_name_handler (filename, Qwrite_region);
5015 /* If FILENAME has no handler, see if VISIT has one. */
5016 if (NILP (handler) && STRINGP (visit))
5017 handler = Ffind_file_name_handler (visit, Qwrite_region);
5019 if (!NILP (handler))
5021 Lisp_Object val;
5022 val = call6 (handler, Qwrite_region, start, end,
5023 filename, append, visit);
5025 if (visiting)
5027 SAVE_MODIFF = MODIFF;
5028 XSETFASTINT (current_buffer->save_length, Z - BEG);
5029 current_buffer->filename = visit_file;
5031 UNGCPRO;
5032 return val;
5035 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5037 /* Special kludge to simplify auto-saving. */
5038 if (NILP (start))
5040 XSETFASTINT (start, BEG);
5041 XSETFASTINT (end, Z);
5042 Fwiden ();
5045 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5046 count1 = SPECPDL_INDEX ();
5048 given_buffer = current_buffer;
5050 if (!STRINGP (start))
5052 annotations = build_annotations (start, end);
5054 if (current_buffer != given_buffer)
5056 XSETFASTINT (start, BEGV);
5057 XSETFASTINT (end, ZV);
5061 UNGCPRO;
5063 GCPRO5 (start, filename, annotations, visit_file, lockname);
5065 /* Decide the coding-system to encode the data with.
5066 We used to make this choice before calling build_annotations, but that
5067 leads to problems when a write-annotate-function takes care of
5068 unsavable chars (as was the case with X-Symbol). */
5069 choose_write_coding_system (start, end, filename,
5070 append, visit, lockname, &coding);
5071 Vlast_coding_system_used = coding.symbol;
5073 given_buffer = current_buffer;
5074 if (! STRINGP (start))
5076 annotations = build_annotations_2 (start, end,
5077 coding.pre_write_conversion, annotations);
5078 if (current_buffer != given_buffer)
5080 XSETFASTINT (start, BEGV);
5081 XSETFASTINT (end, ZV);
5085 #ifdef CLASH_DETECTION
5086 if (!auto_saving)
5088 #if 0 /* This causes trouble for GNUS. */
5089 /* If we've locked this file for some other buffer,
5090 query before proceeding. */
5091 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5092 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5093 #endif
5095 lock_file (lockname);
5097 #endif /* CLASH_DETECTION */
5099 encoded_filename = ENCODE_FILE (filename);
5101 fn = SDATA (encoded_filename);
5102 desc = -1;
5103 if (!NILP (append))
5104 #ifdef DOS_NT
5105 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5106 #else /* not DOS_NT */
5107 desc = emacs_open (fn, O_WRONLY, 0);
5108 #endif /* not DOS_NT */
5110 if (desc < 0 && (NILP (append) || errno == ENOENT))
5111 #ifdef VMS
5112 if (auto_saving) /* Overwrite any previous version of autosave file */
5114 vms_truncate (fn); /* if fn exists, truncate to zero length */
5115 desc = emacs_open (fn, O_RDWR, 0);
5116 if (desc < 0)
5117 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5118 ? SDATA (current_buffer->filename) : 0,
5119 fn);
5121 else /* Write to temporary name and rename if no errors */
5123 Lisp_Object temp_name;
5124 temp_name = Ffile_name_directory (filename);
5126 if (!NILP (temp_name))
5128 temp_name = Fmake_temp_name (concat2 (temp_name,
5129 build_string ("$$SAVE$$")));
5130 fname = SDATA (filename);
5131 fn = SDATA (temp_name);
5132 desc = creat_copy_attrs (fname, fn);
5133 if (desc < 0)
5135 /* If we can't open the temporary file, try creating a new
5136 version of the original file. VMS "creat" creates a
5137 new version rather than truncating an existing file. */
5138 fn = fname;
5139 fname = 0;
5140 desc = creat (fn, 0666);
5141 #if 0 /* This can clobber an existing file and fail to replace it,
5142 if the user runs out of space. */
5143 if (desc < 0)
5145 /* We can't make a new version;
5146 try to truncate and rewrite existing version if any. */
5147 vms_truncate (fn);
5148 desc = emacs_open (fn, O_RDWR, 0);
5150 #endif
5153 else
5154 desc = creat (fn, 0666);
5156 #else /* not VMS */
5157 #ifdef DOS_NT
5158 desc = emacs_open (fn,
5159 O_WRONLY | O_CREAT | buffer_file_type
5160 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5161 S_IREAD | S_IWRITE);
5162 #else /* not DOS_NT */
5163 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5164 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5165 auto_saving ? auto_save_mode_bits : 0666);
5166 #endif /* not DOS_NT */
5167 #endif /* not VMS */
5169 if (desc < 0)
5171 #ifdef CLASH_DETECTION
5172 save_errno = errno;
5173 if (!auto_saving) unlock_file (lockname);
5174 errno = save_errno;
5175 #endif /* CLASH_DETECTION */
5176 UNGCPRO;
5177 report_file_error ("Opening output file", Fcons (filename, Qnil));
5180 record_unwind_protect (close_file_unwind, make_number (desc));
5182 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5184 long ret;
5186 if (NUMBERP (append))
5187 ret = lseek (desc, XINT (append), 1);
5188 else
5189 ret = lseek (desc, 0, 2);
5190 if (ret < 0)
5192 #ifdef CLASH_DETECTION
5193 if (!auto_saving) unlock_file (lockname);
5194 #endif /* CLASH_DETECTION */
5195 UNGCPRO;
5196 report_file_error ("Lseek error", Fcons (filename, Qnil));
5200 UNGCPRO;
5202 #ifdef VMS
5204 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5205 * if we do writes that don't end with a carriage return. Furthermore
5206 * it cannot handle writes of more then 16K. The modified
5207 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5208 * this EXCEPT for the last record (if it doesn't end with a carriage
5209 * return). This implies that if your buffer doesn't end with a carriage
5210 * return, you get one free... tough. However it also means that if
5211 * we make two calls to sys_write (a la the following code) you can
5212 * get one at the gap as well. The easiest way to fix this (honest)
5213 * is to move the gap to the next newline (or the end of the buffer).
5214 * Thus this change.
5216 * Yech!
5218 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5219 move_gap (find_next_newline (GPT, 1));
5220 #else
5221 /* Whether VMS or not, we must move the gap to the next of newline
5222 when we must put designation sequences at beginning of line. */
5223 if (INTEGERP (start)
5224 && coding.type == coding_type_iso2022
5225 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5226 && GPT > BEG && GPT_ADDR[-1] != '\n')
5228 int opoint = PT, opoint_byte = PT_BYTE;
5229 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5230 move_gap_both (PT, PT_BYTE);
5231 SET_PT_BOTH (opoint, opoint_byte);
5233 #endif
5235 failure = 0;
5236 immediate_quit = 1;
5238 if (STRINGP (start))
5240 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5241 &annotations, &coding);
5242 save_errno = errno;
5244 else if (XINT (start) != XINT (end))
5246 tem = CHAR_TO_BYTE (XINT (start));
5248 if (XINT (start) < GPT)
5250 failure = 0 > a_write (desc, Qnil, XINT (start),
5251 min (GPT, XINT (end)) - XINT (start),
5252 &annotations, &coding);
5253 save_errno = errno;
5256 if (XINT (end) > GPT && !failure)
5258 tem = max (XINT (start), GPT);
5259 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5260 &annotations, &coding);
5261 save_errno = errno;
5264 else
5266 /* If file was empty, still need to write the annotations */
5267 coding.mode |= CODING_MODE_LAST_BLOCK;
5268 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5269 save_errno = errno;
5272 if (CODING_REQUIRE_FLUSHING (&coding)
5273 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5274 && ! failure)
5276 /* We have to flush out a data. */
5277 coding.mode |= CODING_MODE_LAST_BLOCK;
5278 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5279 save_errno = errno;
5282 immediate_quit = 0;
5284 #ifdef HAVE_FSYNC
5285 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5286 Disk full in NFS may be reported here. */
5287 /* mib says that closing the file will try to write as fast as NFS can do
5288 it, and that means the fsync here is not crucial for autosave files. */
5289 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
5291 /* If fsync fails with EINTR, don't treat that as serious. Also
5292 ignore EINVAL which happens when fsync is not supported on this
5293 file. */
5294 if (errno != EINTR && errno != EINVAL)
5295 failure = 1, save_errno = errno;
5297 #endif
5299 /* Spurious "file has changed on disk" warnings have been
5300 observed on Suns as well.
5301 It seems that `close' can change the modtime, under nfs.
5303 (This has supposedly been fixed in Sunos 4,
5304 but who knows about all the other machines with NFS?) */
5305 #if 0
5307 /* On VMS and APOLLO, must do the stat after the close
5308 since closing changes the modtime. */
5309 #ifndef VMS
5310 #ifndef APOLLO
5311 /* Recall that #if defined does not work on VMS. */
5312 #define FOO
5313 fstat (desc, &st);
5314 #endif
5315 #endif
5316 #endif
5318 /* NFS can report a write failure now. */
5319 if (emacs_close (desc) < 0)
5320 failure = 1, save_errno = errno;
5322 #ifdef VMS
5323 /* If we wrote to a temporary name and had no errors, rename to real name. */
5324 if (fname)
5326 if (!failure)
5327 failure = (rename (fn, fname) != 0), save_errno = errno;
5328 fn = fname;
5330 #endif /* VMS */
5332 #ifndef FOO
5333 stat (fn, &st);
5334 #endif
5335 /* Discard the unwind protect for close_file_unwind. */
5336 specpdl_ptr = specpdl + count1;
5337 /* Restore the original current buffer. */
5338 visit_file = unbind_to (count, visit_file);
5340 #ifdef CLASH_DETECTION
5341 if (!auto_saving)
5342 unlock_file (lockname);
5343 #endif /* CLASH_DETECTION */
5345 /* Do this before reporting IO error
5346 to avoid a "file has changed on disk" warning on
5347 next attempt to save. */
5348 if (visiting)
5349 current_buffer->modtime = st.st_mtime;
5351 if (failure)
5352 error ("IO error writing %s: %s", SDATA (filename),
5353 emacs_strerror (save_errno));
5355 if (visiting)
5357 SAVE_MODIFF = MODIFF;
5358 XSETFASTINT (current_buffer->save_length, Z - BEG);
5359 current_buffer->filename = visit_file;
5360 update_mode_lines++;
5362 else if (quietly)
5364 if (auto_saving
5365 && ! NILP (Fstring_equal (current_buffer->filename,
5366 current_buffer->auto_save_file_name)))
5367 SAVE_MODIFF = MODIFF;
5369 return Qnil;
5372 if (!auto_saving)
5373 message_with_string ((INTEGERP (append)
5374 ? "Updated %s"
5375 : ! NILP (append)
5376 ? "Added to %s"
5377 : "Wrote %s"),
5378 visit_file, 1);
5380 return Qnil;
5383 Lisp_Object merge ();
5385 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5386 doc: /* Return t if (car A) is numerically less than (car B). */)
5387 (a, b)
5388 Lisp_Object a, b;
5390 return Flss (Fcar (a), Fcar (b));
5393 /* Build the complete list of annotations appropriate for writing out
5394 the text between START and END, by calling all the functions in
5395 write-region-annotate-functions and merging the lists they return.
5396 If one of these functions switches to a different buffer, we assume
5397 that buffer contains altered text. Therefore, the caller must
5398 make sure to restore the current buffer in all cases,
5399 as save-excursion would do. */
5401 static Lisp_Object
5402 build_annotations (start, end)
5403 Lisp_Object start, end;
5405 Lisp_Object annotations;
5406 Lisp_Object p, res;
5407 struct gcpro gcpro1, gcpro2;
5408 Lisp_Object original_buffer;
5409 int i, used_global = 0;
5411 XSETBUFFER (original_buffer, current_buffer);
5413 annotations = Qnil;
5414 p = Vwrite_region_annotate_functions;
5415 GCPRO2 (annotations, p);
5416 while (CONSP (p))
5418 struct buffer *given_buffer = current_buffer;
5419 if (EQ (Qt, XCAR (p)) && !used_global)
5420 { /* Use the global value of the hook. */
5421 Lisp_Object arg[2];
5422 used_global = 1;
5423 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5424 arg[1] = XCDR (p);
5425 p = Fappend (2, arg);
5426 continue;
5428 Vwrite_region_annotations_so_far = annotations;
5429 res = call2 (XCAR (p), start, end);
5430 /* If the function makes a different buffer current,
5431 assume that means this buffer contains altered text to be output.
5432 Reset START and END from the buffer bounds
5433 and discard all previous annotations because they should have
5434 been dealt with by this function. */
5435 if (current_buffer != given_buffer)
5437 XSETFASTINT (start, BEGV);
5438 XSETFASTINT (end, ZV);
5439 annotations = Qnil;
5441 Flength (res); /* Check basic validity of return value */
5442 annotations = merge (annotations, res, Qcar_less_than_car);
5443 p = XCDR (p);
5446 /* Now do the same for annotation functions implied by the file-format */
5447 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5448 p = current_buffer->auto_save_file_format;
5449 else
5450 p = current_buffer->file_format;
5451 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5453 struct buffer *given_buffer = current_buffer;
5455 Vwrite_region_annotations_so_far = annotations;
5457 /* Value is either a list of annotations or nil if the function
5458 has written annotations to a temporary buffer, which is now
5459 current. */
5460 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5461 original_buffer, make_number (i));
5462 if (current_buffer != given_buffer)
5464 XSETFASTINT (start, BEGV);
5465 XSETFASTINT (end, ZV);
5466 annotations = Qnil;
5469 if (CONSP (res))
5470 annotations = merge (annotations, res, Qcar_less_than_car);
5473 UNGCPRO;
5474 return annotations;
5477 static Lisp_Object
5478 build_annotations_2 (start, end, pre_write_conversion, annotations)
5479 Lisp_Object start, end, pre_write_conversion, annotations;
5481 struct gcpro gcpro1;
5482 Lisp_Object res;
5484 GCPRO1 (annotations);
5485 /* At last, do the same for the function PRE_WRITE_CONVERSION
5486 implied by the current coding-system. */
5487 if (!NILP (pre_write_conversion))
5489 struct buffer *given_buffer = current_buffer;
5490 Vwrite_region_annotations_so_far = annotations;
5491 res = call2 (pre_write_conversion, start, end);
5492 Flength (res);
5493 annotations = (current_buffer != given_buffer
5494 ? res
5495 : merge (annotations, res, Qcar_less_than_car));
5498 UNGCPRO;
5499 return annotations;
5502 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5503 If STRING is nil, POS is the character position in the current buffer.
5504 Intersperse with them the annotations from *ANNOT
5505 which fall within the range of POS to POS + NCHARS,
5506 each at its appropriate position.
5508 We modify *ANNOT by discarding elements as we use them up.
5510 The return value is negative in case of system call failure. */
5512 static int
5513 a_write (desc, string, pos, nchars, annot, coding)
5514 int desc;
5515 Lisp_Object string;
5516 register int nchars;
5517 int pos;
5518 Lisp_Object *annot;
5519 struct coding_system *coding;
5521 Lisp_Object tem;
5522 int nextpos;
5523 int lastpos = pos + nchars;
5525 while (NILP (*annot) || CONSP (*annot))
5527 tem = Fcar_safe (Fcar (*annot));
5528 nextpos = pos - 1;
5529 if (INTEGERP (tem))
5530 nextpos = XFASTINT (tem);
5532 /* If there are no more annotations in this range,
5533 output the rest of the range all at once. */
5534 if (! (nextpos >= pos && nextpos <= lastpos))
5535 return e_write (desc, string, pos, lastpos, coding);
5537 /* Output buffer text up to the next annotation's position. */
5538 if (nextpos > pos)
5540 if (0 > e_write (desc, string, pos, nextpos, coding))
5541 return -1;
5542 pos = nextpos;
5544 /* Output the annotation. */
5545 tem = Fcdr (Fcar (*annot));
5546 if (STRINGP (tem))
5548 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5549 return -1;
5551 *annot = Fcdr (*annot);
5553 return 0;
5556 #ifndef WRITE_BUF_SIZE
5557 #define WRITE_BUF_SIZE (16 * 1024)
5558 #endif
5560 /* Write text in the range START and END into descriptor DESC,
5561 encoding them with coding system CODING. If STRING is nil, START
5562 and END are character positions of the current buffer, else they
5563 are indexes to the string STRING. */
5565 static int
5566 e_write (desc, string, start, end, coding)
5567 int desc;
5568 Lisp_Object string;
5569 int start, end;
5570 struct coding_system *coding;
5572 register char *addr;
5573 register int nbytes;
5574 char buf[WRITE_BUF_SIZE];
5575 int return_val = 0;
5577 if (start >= end)
5578 coding->composing = COMPOSITION_DISABLED;
5579 if (coding->composing != COMPOSITION_DISABLED)
5580 coding_save_composition (coding, start, end, string);
5582 if (STRINGP (string))
5584 addr = SDATA (string);
5585 nbytes = SBYTES (string);
5586 coding->src_multibyte = STRING_MULTIBYTE (string);
5588 else if (start < end)
5590 /* It is assured that the gap is not in the range START and END-1. */
5591 addr = CHAR_POS_ADDR (start);
5592 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5593 coding->src_multibyte
5594 = !NILP (current_buffer->enable_multibyte_characters);
5596 else
5598 addr = "";
5599 nbytes = 0;
5600 coding->src_multibyte = 1;
5603 /* We used to have a code for handling selective display here. But,
5604 now it is handled within encode_coding. */
5605 while (1)
5607 int result;
5609 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5610 if (coding->produced > 0)
5612 coding->produced -= emacs_write (desc, buf, coding->produced);
5613 if (coding->produced)
5615 return_val = -1;
5616 break;
5619 nbytes -= coding->consumed;
5620 addr += coding->consumed;
5621 if (result == CODING_FINISH_INSUFFICIENT_SRC
5622 && nbytes > 0)
5624 /* The source text ends by an incomplete multibyte form.
5625 There's no way other than write it out as is. */
5626 nbytes -= emacs_write (desc, addr, nbytes);
5627 if (nbytes)
5629 return_val = -1;
5630 break;
5633 if (nbytes <= 0)
5634 break;
5635 start += coding->consumed_char;
5636 if (coding->cmp_data)
5637 coding_adjust_composition_offset (coding, start);
5640 if (coding->cmp_data)
5641 coding_free_composition_data (coding);
5643 return return_val;
5646 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5647 Sverify_visited_file_modtime, 1, 1, 0,
5648 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5649 This means that the file has not been changed since it was visited or saved.
5650 See Info node `(elisp)Modification Time' for more details. */)
5651 (buf)
5652 Lisp_Object buf;
5654 struct buffer *b;
5655 struct stat st;
5656 Lisp_Object handler;
5657 Lisp_Object filename;
5659 CHECK_BUFFER (buf);
5660 b = XBUFFER (buf);
5662 if (!STRINGP (b->filename)) return Qt;
5663 if (b->modtime == 0) return Qt;
5665 /* If the file name has special constructs in it,
5666 call the corresponding file handler. */
5667 handler = Ffind_file_name_handler (b->filename,
5668 Qverify_visited_file_modtime);
5669 if (!NILP (handler))
5670 return call2 (handler, Qverify_visited_file_modtime, buf);
5672 filename = ENCODE_FILE (b->filename);
5674 if (stat (SDATA (filename), &st) < 0)
5676 /* If the file doesn't exist now and didn't exist before,
5677 we say that it isn't modified, provided the error is a tame one. */
5678 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5679 st.st_mtime = -1;
5680 else
5681 st.st_mtime = 0;
5683 if (st.st_mtime == b->modtime
5684 /* If both are positive, accept them if they are off by one second. */
5685 || (st.st_mtime > 0 && b->modtime > 0
5686 && (st.st_mtime == b->modtime + 1
5687 || st.st_mtime == b->modtime - 1)))
5688 return Qt;
5689 return Qnil;
5692 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5693 Sclear_visited_file_modtime, 0, 0, 0,
5694 doc: /* Clear out records of last mod time of visited file.
5695 Next attempt to save will certainly not complain of a discrepancy. */)
5698 current_buffer->modtime = 0;
5699 return Qnil;
5702 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5703 Svisited_file_modtime, 0, 0, 0,
5704 doc: /* Return the current buffer's recorded visited file modification time.
5705 The value is a list of the form (HIGH LOW), like the time values
5706 that `file-attributes' returns. If the current buffer has no recorded
5707 file modification time, this function returns 0.
5708 See Info node `(elisp)Modification Time' for more details. */)
5711 if (! current_buffer->modtime)
5712 return make_number (0);
5713 return make_time ((time_t) current_buffer->modtime);
5716 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5717 Sset_visited_file_modtime, 0, 1, 0,
5718 doc: /* Update buffer's recorded modification time from the visited file's time.
5719 Useful if the buffer was not read from the file normally
5720 or if the file itself has been changed for some known benign reason.
5721 An argument specifies the modification time value to use
5722 \(instead of that of the visited file), in the form of a list
5723 \(HIGH . LOW) or (HIGH LOW). */)
5724 (time_list)
5725 Lisp_Object time_list;
5727 if (!NILP (time_list))
5728 current_buffer->modtime = cons_to_long (time_list);
5729 else
5731 register Lisp_Object filename;
5732 struct stat st;
5733 Lisp_Object handler;
5735 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5737 /* If the file name has special constructs in it,
5738 call the corresponding file handler. */
5739 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5740 if (!NILP (handler))
5741 /* The handler can find the file name the same way we did. */
5742 return call2 (handler, Qset_visited_file_modtime, Qnil);
5744 filename = ENCODE_FILE (filename);
5746 if (stat (SDATA (filename), &st) >= 0)
5747 current_buffer->modtime = st.st_mtime;
5750 return Qnil;
5753 Lisp_Object
5754 auto_save_error (error)
5755 Lisp_Object error;
5757 Lisp_Object args[3], msg;
5758 int i, nbytes;
5759 struct gcpro gcpro1;
5760 char *msgbuf;
5761 USE_SAFE_ALLOCA;
5763 auto_save_error_occurred = 1;
5765 ring_bell ();
5767 args[0] = build_string ("Auto-saving %s: %s");
5768 args[1] = current_buffer->name;
5769 args[2] = Ferror_message_string (error);
5770 msg = Fformat (3, args);
5771 GCPRO1 (msg);
5772 nbytes = SBYTES (msg);
5773 SAFE_ALLOCA (msgbuf, char *, nbytes);
5774 bcopy (SDATA (msg), msgbuf, nbytes);
5776 for (i = 0; i < 3; ++i)
5778 if (i == 0)
5779 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5780 else
5781 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5782 Fsleep_for (make_number (1), Qnil);
5785 SAFE_FREE ();
5786 UNGCPRO;
5787 return Qnil;
5790 Lisp_Object
5791 auto_save_1 ()
5793 struct stat st;
5794 Lisp_Object modes;
5796 auto_save_mode_bits = 0666;
5798 /* Get visited file's mode to become the auto save file's mode. */
5799 if (! NILP (current_buffer->filename))
5801 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5802 /* But make sure we can overwrite it later! */
5803 auto_save_mode_bits = st.st_mode | 0600;
5804 else if ((modes = Ffile_modes (current_buffer->filename),
5805 INTEGERP (modes)))
5806 /* Remote files don't cooperate with stat. */
5807 auto_save_mode_bits = XINT (modes) | 0600;
5810 return
5811 Fwrite_region (Qnil, Qnil,
5812 current_buffer->auto_save_file_name,
5813 Qnil, Qlambda, Qnil, Qnil);
5816 static Lisp_Object
5817 do_auto_save_unwind (arg) /* used as unwind-protect function */
5818 Lisp_Object arg;
5820 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5821 auto_saving = 0;
5822 if (stream != NULL)
5824 BLOCK_INPUT;
5825 fclose (stream);
5826 UNBLOCK_INPUT;
5828 return Qnil;
5831 static Lisp_Object
5832 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5833 Lisp_Object value;
5835 minibuffer_auto_raise = XINT (value);
5836 return Qnil;
5839 static Lisp_Object
5840 do_auto_save_make_dir (dir)
5841 Lisp_Object dir;
5843 Lisp_Object mode;
5845 call2 (Qmake_directory, dir, Qt);
5846 XSETFASTINT (mode, 0700);
5847 return Fset_file_modes (dir, mode);
5850 static Lisp_Object
5851 do_auto_save_eh (ignore)
5852 Lisp_Object ignore;
5854 return Qnil;
5857 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5858 doc: /* Auto-save all buffers that need it.
5859 This is all buffers that have auto-saving enabled
5860 and are changed since last auto-saved.
5861 Auto-saving writes the buffer into a file
5862 so that your editing is not lost if the system crashes.
5863 This file is not the file you visited; that changes only when you save.
5864 Normally we run the normal hook `auto-save-hook' before saving.
5866 A non-nil NO-MESSAGE argument means do not print any message if successful.
5867 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5868 (no_message, current_only)
5869 Lisp_Object no_message, current_only;
5871 struct buffer *old = current_buffer, *b;
5872 Lisp_Object tail, buf;
5873 int auto_saved = 0;
5874 int do_handled_files;
5875 Lisp_Object oquit;
5876 FILE *stream = NULL;
5877 int count = SPECPDL_INDEX ();
5878 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5879 int old_message_p = 0;
5880 struct gcpro gcpro1, gcpro2;
5882 if (max_specpdl_size < specpdl_size + 40)
5883 max_specpdl_size = specpdl_size + 40;
5885 if (minibuf_level)
5886 no_message = Qt;
5888 if (NILP (no_message))
5890 old_message_p = push_message ();
5891 record_unwind_protect (pop_message_unwind, Qnil);
5894 /* Ordinarily don't quit within this function,
5895 but don't make it impossible to quit (in case we get hung in I/O). */
5896 oquit = Vquit_flag;
5897 Vquit_flag = Qnil;
5899 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5900 point to non-strings reached from Vbuffer_alist. */
5902 if (!NILP (Vrun_hooks))
5903 call1 (Vrun_hooks, intern ("auto-save-hook"));
5905 if (STRINGP (Vauto_save_list_file_name))
5907 Lisp_Object listfile;
5909 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5911 /* Don't try to create the directory when shutting down Emacs,
5912 because creating the directory might signal an error, and
5913 that would leave Emacs in a strange state. */
5914 if (!NILP (Vrun_hooks))
5916 Lisp_Object dir;
5917 dir = Qnil;
5918 GCPRO2 (dir, listfile);
5919 dir = Ffile_name_directory (listfile);
5920 if (NILP (Ffile_directory_p (dir)))
5921 internal_condition_case_1 (do_auto_save_make_dir,
5922 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5923 do_auto_save_eh);
5924 UNGCPRO;
5927 stream = fopen (SDATA (listfile), "w");
5930 record_unwind_protect (do_auto_save_unwind,
5931 make_save_value (stream, 0));
5932 record_unwind_protect (do_auto_save_unwind_1,
5933 make_number (minibuffer_auto_raise));
5934 minibuffer_auto_raise = 0;
5935 auto_saving = 1;
5936 auto_save_error_occurred = 0;
5938 /* On first pass, save all files that don't have handlers.
5939 On second pass, save all files that do have handlers.
5941 If Emacs is crashing, the handlers may tweak what is causing
5942 Emacs to crash in the first place, and it would be a shame if
5943 Emacs failed to autosave perfectly ordinary files because it
5944 couldn't handle some ange-ftp'd file. */
5946 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5947 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5949 buf = XCDR (XCAR (tail));
5950 b = XBUFFER (buf);
5952 /* Record all the buffers that have auto save mode
5953 in the special file that lists them. For each of these buffers,
5954 Record visited name (if any) and auto save name. */
5955 if (STRINGP (b->auto_save_file_name)
5956 && stream != NULL && do_handled_files == 0)
5958 BLOCK_INPUT;
5959 if (!NILP (b->filename))
5961 fwrite (SDATA (b->filename), 1,
5962 SBYTES (b->filename), stream);
5964 putc ('\n', stream);
5965 fwrite (SDATA (b->auto_save_file_name), 1,
5966 SBYTES (b->auto_save_file_name), stream);
5967 putc ('\n', stream);
5968 UNBLOCK_INPUT;
5971 if (!NILP (current_only)
5972 && b != current_buffer)
5973 continue;
5975 /* Don't auto-save indirect buffers.
5976 The base buffer takes care of it. */
5977 if (b->base_buffer)
5978 continue;
5980 /* Check for auto save enabled
5981 and file changed since last auto save
5982 and file changed since last real save. */
5983 if (STRINGP (b->auto_save_file_name)
5984 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5985 && b->auto_save_modified < BUF_MODIFF (b)
5986 /* -1 means we've turned off autosaving for a while--see below. */
5987 && XINT (b->save_length) >= 0
5988 && (do_handled_files
5989 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5990 Qwrite_region))))
5992 EMACS_TIME before_time, after_time;
5994 EMACS_GET_TIME (before_time);
5996 /* If we had a failure, don't try again for 20 minutes. */
5997 if (b->auto_save_failure_time >= 0
5998 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5999 continue;
6001 if ((XFASTINT (b->save_length) * 10
6002 > (BUF_Z (b) - BUF_BEG (b)) * 13)
6003 /* A short file is likely to change a large fraction;
6004 spare the user annoying messages. */
6005 && XFASTINT (b->save_length) > 5000
6006 /* These messages are frequent and annoying for `*mail*'. */
6007 && !EQ (b->filename, Qnil)
6008 && NILP (no_message))
6010 /* It has shrunk too much; turn off auto-saving here. */
6011 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6012 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6013 b->name, 1);
6014 minibuffer_auto_raise = 0;
6015 /* Turn off auto-saving until there's a real save,
6016 and prevent any more warnings. */
6017 XSETINT (b->save_length, -1);
6018 Fsleep_for (make_number (1), Qnil);
6019 continue;
6021 set_buffer_internal (b);
6022 if (!auto_saved && NILP (no_message))
6023 message1 ("Auto-saving...");
6024 internal_condition_case (auto_save_1, Qt, auto_save_error);
6025 auto_saved++;
6026 b->auto_save_modified = BUF_MODIFF (b);
6027 XSETFASTINT (current_buffer->save_length, Z - BEG);
6028 set_buffer_internal (old);
6030 EMACS_GET_TIME (after_time);
6032 /* If auto-save took more than 60 seconds,
6033 assume it was an NFS failure that got a timeout. */
6034 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6035 b->auto_save_failure_time = EMACS_SECS (after_time);
6039 /* Prevent another auto save till enough input events come in. */
6040 record_auto_save ();
6042 if (auto_saved && NILP (no_message))
6044 if (old_message_p)
6046 /* If we are going to restore an old message,
6047 give time to read ours. */
6048 sit_for (make_number (1), 0, 0);
6049 restore_message ();
6051 else if (!auto_save_error_occurred)
6052 /* Don't overwrite the error message if an error occurred.
6053 If we displayed a message and then restored a state
6054 with no message, leave a "done" message on the screen. */
6055 message1 ("Auto-saving...done");
6058 Vquit_flag = oquit;
6060 /* This restores the message-stack status. */
6061 unbind_to (count, Qnil);
6062 return Qnil;
6065 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6066 Sset_buffer_auto_saved, 0, 0, 0,
6067 doc: /* Mark current buffer as auto-saved with its current text.
6068 No auto-save file will be written until the buffer changes again. */)
6071 current_buffer->auto_save_modified = MODIFF;
6072 XSETFASTINT (current_buffer->save_length, Z - BEG);
6073 current_buffer->auto_save_failure_time = -1;
6074 return Qnil;
6077 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6078 Sclear_buffer_auto_save_failure, 0, 0, 0,
6079 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6082 current_buffer->auto_save_failure_time = -1;
6083 return Qnil;
6086 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6087 0, 0, 0,
6088 doc: /* Return t if current buffer has been auto-saved recently.
6089 More precisely, if it has been auto-saved since last read from or saved
6090 in the visited file. If the buffer has no visited file,
6091 then any auto-save counts as "recent". */)
6094 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6097 /* Reading and completing file names */
6098 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6099 extern Lisp_Object Qcompletion_ignore_case;
6101 /* In the string VAL, change each $ to $$ and return the result. */
6103 static Lisp_Object
6104 double_dollars (val)
6105 Lisp_Object val;
6107 register const unsigned char *old;
6108 register unsigned char *new;
6109 register int n;
6110 int osize, count;
6112 osize = SBYTES (val);
6114 /* Count the number of $ characters. */
6115 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6116 if (*old++ == '$') count++;
6117 if (count > 0)
6119 old = SDATA (val);
6120 val = make_uninit_multibyte_string (SCHARS (val) + count,
6121 osize + count);
6122 new = SDATA (val);
6123 for (n = osize; n > 0; n--)
6124 if (*old != '$')
6125 *new++ = *old++;
6126 else
6128 *new++ = '$';
6129 *new++ = '$';
6130 old++;
6133 return val;
6136 static Lisp_Object
6137 read_file_name_cleanup (arg)
6138 Lisp_Object arg;
6140 return (current_buffer->directory = arg);
6143 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
6144 3, 3, 0,
6145 doc: /* Internal subroutine for read-file-name. Do not call this. */)
6146 (string, dir, action)
6147 Lisp_Object string, dir, action;
6148 /* action is nil for complete, t for return list of completions,
6149 lambda for verify final value */
6151 Lisp_Object name, specdir, realdir, val, orig_string;
6152 int changed;
6153 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6155 CHECK_STRING (string);
6157 realdir = dir;
6158 name = string;
6159 orig_string = Qnil;
6160 specdir = Qnil;
6161 changed = 0;
6162 /* No need to protect ACTION--we only compare it with t and nil. */
6163 GCPRO5 (string, realdir, name, specdir, orig_string);
6165 if (SCHARS (string) == 0)
6167 if (EQ (action, Qlambda))
6169 UNGCPRO;
6170 return Qnil;
6173 else
6175 orig_string = string;
6176 string = Fsubstitute_in_file_name (string);
6177 changed = NILP (Fstring_equal (string, orig_string));
6178 name = Ffile_name_nondirectory (string);
6179 val = Ffile_name_directory (string);
6180 if (! NILP (val))
6181 realdir = Fexpand_file_name (val, realdir);
6184 if (NILP (action))
6186 specdir = Ffile_name_directory (string);
6187 val = Ffile_name_completion (name, realdir, Vread_file_name_predicate);
6188 UNGCPRO;
6189 if (!STRINGP (val))
6191 if (changed)
6192 return double_dollars (string);
6193 return val;
6196 if (!NILP (specdir))
6197 val = concat2 (specdir, val);
6198 #ifndef VMS
6199 return double_dollars (val);
6200 #else /* not VMS */
6201 return val;
6202 #endif /* not VMS */
6204 UNGCPRO;
6206 if (EQ (action, Qt))
6208 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6209 Lisp_Object comp;
6210 int count;
6212 if (NILP (Vread_file_name_predicate)
6213 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6214 return all;
6216 #ifndef VMS
6217 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6219 /* Brute-force speed up for directory checking:
6220 Discard strings which don't end in a slash. */
6221 for (comp = Qnil; CONSP (all); all = XCDR (all))
6223 Lisp_Object tem = XCAR (all);
6224 int len;
6225 if (STRINGP (tem)
6226 && (len = SBYTES (tem), len > 0)
6227 && IS_DIRECTORY_SEP (SREF (tem, len-1)))
6228 comp = Fcons (tem, comp);
6231 else
6232 #endif
6234 /* Must do it the hard (and slow) way. */
6235 Lisp_Object tem;
6236 GCPRO3 (all, comp, specdir);
6237 count = SPECPDL_INDEX ();
6238 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6239 current_buffer->directory = realdir;
6240 for (comp = Qnil; CONSP (all); all = XCDR (all))
6242 tem = call1 (Vread_file_name_predicate, XCAR (all));
6243 if (!NILP (tem))
6244 comp = Fcons (XCAR (all), comp);
6246 unbind_to (count, Qnil);
6247 UNGCPRO;
6249 return Fnreverse (comp);
6252 /* Only other case actually used is ACTION = lambda */
6253 #ifdef VMS
6254 /* Supposedly this helps commands such as `cd' that read directory names,
6255 but can someone explain how it helps them? -- RMS */
6256 if (SCHARS (name) == 0)
6257 return Qt;
6258 #endif /* VMS */
6259 string = Fexpand_file_name (string, dir);
6260 if (!NILP (Vread_file_name_predicate))
6261 return call1 (Vread_file_name_predicate, string);
6262 return Ffile_exists_p (string);
6265 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6266 Snext_read_file_uses_dialog_p, 0, 0, 0,
6267 doc: /* Return t if a call to `read-file-name' will use a dialog.
6268 The return value is only relevant for a call to `read-file-name' that happens
6269 before any other event (mouse or keypress) is handeled. */)
6272 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6273 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6274 && use_dialog_box
6275 && use_file_dialog
6276 && have_menus_p ())
6277 return Qt;
6278 #endif
6279 return Qnil;
6282 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6283 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6284 Value is not expanded---you must call `expand-file-name' yourself.
6285 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6286 the same non-empty string that was inserted by this function.
6287 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6288 except that if INITIAL is specified, that combined with DIR is used.)
6289 If the user exits with an empty minibuffer, this function returns
6290 an empty string. (This can only happen if the user erased the
6291 pre-inserted contents or if `insert-default-directory' is nil.)
6292 Fourth arg MUSTMATCH non-nil means require existing file's name.
6293 Non-nil and non-t means also require confirmation after completion.
6294 Fifth arg INITIAL specifies text to start with.
6295 If optional sixth arg PREDICATE is non-nil, possible completions and
6296 the resulting file name must satisfy (funcall PREDICATE NAME).
6297 DIR should be an absolute directory name. It defaults to the value of
6298 `default-directory'.
6300 If this command was invoked with the mouse, use a file dialog box if
6301 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6302 provides a file dialog box.
6304 See also `read-file-name-completion-ignore-case'
6305 and `read-file-name-function'. */)
6306 (prompt, dir, default_filename, mustmatch, initial, predicate)
6307 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6309 Lisp_Object val, insdef, tem;
6310 struct gcpro gcpro1, gcpro2;
6311 register char *homedir;
6312 Lisp_Object decoded_homedir;
6313 int replace_in_history = 0;
6314 int add_to_history = 0;
6315 int count;
6317 if (NILP (dir))
6318 dir = current_buffer->directory;
6319 if (NILP (Ffile_name_absolute_p (dir)))
6320 dir = Fexpand_file_name (dir, Qnil);
6321 if (NILP (default_filename))
6322 default_filename
6323 = (!NILP (initial)
6324 ? Fexpand_file_name (initial, dir)
6325 : current_buffer->filename);
6327 /* If dir starts with user's homedir, change that to ~. */
6328 homedir = (char *) egetenv ("HOME");
6329 #ifdef DOS_NT
6330 /* homedir can be NULL in temacs, since Vprocess_environment is not
6331 yet set up. We shouldn't crash in that case. */
6332 if (homedir != 0)
6334 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6335 CORRECT_DIR_SEPS (homedir);
6337 #endif
6338 if (homedir != 0)
6339 decoded_homedir
6340 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6341 if (homedir != 0
6342 && STRINGP (dir)
6343 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6344 SBYTES (decoded_homedir))
6345 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6347 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6348 dir = concat2 (build_string ("~"), dir);
6350 /* Likewise for default_filename. */
6351 if (homedir != 0
6352 && STRINGP (default_filename)
6353 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6354 SBYTES (decoded_homedir))
6355 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6357 default_filename
6358 = Fsubstring (default_filename,
6359 make_number (SCHARS (decoded_homedir)), Qnil);
6360 default_filename = concat2 (build_string ("~"), default_filename);
6362 if (!NILP (default_filename))
6364 CHECK_STRING (default_filename);
6365 default_filename = double_dollars (default_filename);
6368 if (insert_default_directory && STRINGP (dir))
6370 insdef = dir;
6371 if (!NILP (initial))
6373 Lisp_Object args[2], pos;
6375 args[0] = insdef;
6376 args[1] = initial;
6377 insdef = Fconcat (2, args);
6378 pos = make_number (SCHARS (double_dollars (dir)));
6379 insdef = Fcons (double_dollars (insdef), pos);
6381 else
6382 insdef = double_dollars (insdef);
6384 else if (STRINGP (initial))
6385 insdef = Fcons (double_dollars (initial), make_number (0));
6386 else
6387 insdef = Qnil;
6389 if (!NILP (Vread_file_name_function))
6391 Lisp_Object args[7];
6393 GCPRO2 (insdef, default_filename);
6394 args[0] = Vread_file_name_function;
6395 args[1] = prompt;
6396 args[2] = dir;
6397 args[3] = default_filename;
6398 args[4] = mustmatch;
6399 args[5] = initial;
6400 args[6] = predicate;
6401 RETURN_UNGCPRO (Ffuncall (7, args));
6404 count = SPECPDL_INDEX ();
6405 specbind (Qcompletion_ignore_case,
6406 read_file_name_completion_ignore_case ? Qt : Qnil);
6407 specbind (intern ("minibuffer-completing-file-name"), Qt);
6408 specbind (intern ("read-file-name-predicate"),
6409 (NILP (predicate) ? Qfile_exists_p : predicate));
6411 GCPRO2 (insdef, default_filename);
6413 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6414 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6416 /* If DIR contains a file name, split it. */
6417 Lisp_Object file;
6418 file = Ffile_name_nondirectory (dir);
6419 if (SCHARS (file) && NILP (default_filename))
6421 default_filename = file;
6422 dir = Ffile_name_directory (dir);
6424 if (!NILP(default_filename))
6425 default_filename = Fexpand_file_name (default_filename, dir);
6426 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch,
6427 EQ (predicate, Qfile_directory_p) ? Qt : Qnil);
6428 add_to_history = 1;
6430 else
6431 #endif
6432 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6433 dir, mustmatch, insdef,
6434 Qfile_name_history, default_filename, Qnil);
6436 tem = Fsymbol_value (Qfile_name_history);
6437 if (CONSP (tem) && EQ (XCAR (tem), val))
6438 replace_in_history = 1;
6440 /* If Fcompleting_read returned the inserted default string itself
6441 (rather than a new string with the same contents),
6442 it has to mean that the user typed RET with the minibuffer empty.
6443 In that case, we really want to return ""
6444 so that commands such as set-visited-file-name can distinguish. */
6445 if (EQ (val, default_filename))
6447 /* In this case, Fcompleting_read has not added an element
6448 to the history. Maybe we should. */
6449 if (! replace_in_history)
6450 add_to_history = 1;
6452 val = empty_string;
6455 unbind_to (count, Qnil);
6456 UNGCPRO;
6457 if (NILP (val))
6458 error ("No file name specified");
6460 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6462 if (!NILP (tem) && !NILP (default_filename))
6463 val = default_filename;
6464 val = Fsubstitute_in_file_name (val);
6466 if (replace_in_history)
6467 /* Replace what Fcompleting_read added to the history
6468 with what we will actually return. */
6470 Lisp_Object val1 = double_dollars (val);
6471 tem = Fsymbol_value (Qfile_name_history);
6472 if (history_delete_duplicates)
6473 XSETCDR (tem, Fdelete (val1, XCDR(tem)));
6474 XSETCAR (tem, val1);
6476 else if (add_to_history)
6478 /* Add the value to the history--but not if it matches
6479 the last value already there. */
6480 Lisp_Object val1 = double_dollars (val);
6481 tem = Fsymbol_value (Qfile_name_history);
6482 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6484 if (history_delete_duplicates) tem = Fdelete (val1, tem);
6485 Fset (Qfile_name_history, Fcons (val1, tem));
6489 return val;
6493 void
6494 init_fileio_once ()
6496 /* Must be set before any path manipulation is performed. */
6497 XSETFASTINT (Vdirectory_sep_char, '/');
6501 void
6502 syms_of_fileio ()
6504 Qoperations = intern ("operations");
6505 Qexpand_file_name = intern ("expand-file-name");
6506 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6507 Qdirectory_file_name = intern ("directory-file-name");
6508 Qfile_name_directory = intern ("file-name-directory");
6509 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6510 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6511 Qfile_name_as_directory = intern ("file-name-as-directory");
6512 Qcopy_file = intern ("copy-file");
6513 Qmake_directory_internal = intern ("make-directory-internal");
6514 Qmake_directory = intern ("make-directory");
6515 Qdelete_directory = intern ("delete-directory");
6516 Qdelete_file = intern ("delete-file");
6517 Qrename_file = intern ("rename-file");
6518 Qadd_name_to_file = intern ("add-name-to-file");
6519 Qmake_symbolic_link = intern ("make-symbolic-link");
6520 Qfile_exists_p = intern ("file-exists-p");
6521 Qfile_executable_p = intern ("file-executable-p");
6522 Qfile_readable_p = intern ("file-readable-p");
6523 Qfile_writable_p = intern ("file-writable-p");
6524 Qfile_symlink_p = intern ("file-symlink-p");
6525 Qaccess_file = intern ("access-file");
6526 Qfile_directory_p = intern ("file-directory-p");
6527 Qfile_regular_p = intern ("file-regular-p");
6528 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6529 Qfile_modes = intern ("file-modes");
6530 Qset_file_modes = intern ("set-file-modes");
6531 Qset_file_times = intern ("set-file-times");
6532 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6533 Qinsert_file_contents = intern ("insert-file-contents");
6534 Qwrite_region = intern ("write-region");
6535 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6536 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6537 Qauto_save_coding = intern ("auto-save-coding");
6539 staticpro (&Qoperations);
6540 staticpro (&Qexpand_file_name);
6541 staticpro (&Qsubstitute_in_file_name);
6542 staticpro (&Qdirectory_file_name);
6543 staticpro (&Qfile_name_directory);
6544 staticpro (&Qfile_name_nondirectory);
6545 staticpro (&Qunhandled_file_name_directory);
6546 staticpro (&Qfile_name_as_directory);
6547 staticpro (&Qcopy_file);
6548 staticpro (&Qmake_directory_internal);
6549 staticpro (&Qmake_directory);
6550 staticpro (&Qdelete_directory);
6551 staticpro (&Qdelete_file);
6552 staticpro (&Qrename_file);
6553 staticpro (&Qadd_name_to_file);
6554 staticpro (&Qmake_symbolic_link);
6555 staticpro (&Qfile_exists_p);
6556 staticpro (&Qfile_executable_p);
6557 staticpro (&Qfile_readable_p);
6558 staticpro (&Qfile_writable_p);
6559 staticpro (&Qaccess_file);
6560 staticpro (&Qfile_symlink_p);
6561 staticpro (&Qfile_directory_p);
6562 staticpro (&Qfile_regular_p);
6563 staticpro (&Qfile_accessible_directory_p);
6564 staticpro (&Qfile_modes);
6565 staticpro (&Qset_file_modes);
6566 staticpro (&Qset_file_times);
6567 staticpro (&Qfile_newer_than_file_p);
6568 staticpro (&Qinsert_file_contents);
6569 staticpro (&Qwrite_region);
6570 staticpro (&Qverify_visited_file_modtime);
6571 staticpro (&Qset_visited_file_modtime);
6572 staticpro (&Qauto_save_coding);
6574 Qfile_name_history = intern ("file-name-history");
6575 Fset (Qfile_name_history, Qnil);
6576 staticpro (&Qfile_name_history);
6578 Qfile_error = intern ("file-error");
6579 staticpro (&Qfile_error);
6580 Qfile_already_exists = intern ("file-already-exists");
6581 staticpro (&Qfile_already_exists);
6582 Qfile_date_error = intern ("file-date-error");
6583 staticpro (&Qfile_date_error);
6584 Qexcl = intern ("excl");
6585 staticpro (&Qexcl);
6587 #ifdef DOS_NT
6588 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6589 staticpro (&Qfind_buffer_file_type);
6590 #endif /* DOS_NT */
6592 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6593 doc: /* *Coding system for encoding file names.
6594 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6595 Vfile_name_coding_system = Qnil;
6597 DEFVAR_LISP ("default-file-name-coding-system",
6598 &Vdefault_file_name_coding_system,
6599 doc: /* Default coding system for encoding file names.
6600 This variable is used only when `file-name-coding-system' is nil.
6602 This variable is set/changed by the command `set-language-environment'.
6603 User should not set this variable manually,
6604 instead use `file-name-coding-system' to get a constant encoding
6605 of file names regardless of the current language environment. */);
6606 Vdefault_file_name_coding_system = Qnil;
6608 Qformat_decode = intern ("format-decode");
6609 staticpro (&Qformat_decode);
6610 Qformat_annotate_function = intern ("format-annotate-function");
6611 staticpro (&Qformat_annotate_function);
6612 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6613 staticpro (&Qafter_insert_file_set_coding);
6615 Qcar_less_than_car = intern ("car-less-than-car");
6616 staticpro (&Qcar_less_than_car);
6618 Fput (Qfile_error, Qerror_conditions,
6619 list2 (Qfile_error, Qerror));
6620 Fput (Qfile_error, Qerror_message,
6621 build_string ("File error"));
6623 Fput (Qfile_already_exists, Qerror_conditions,
6624 list3 (Qfile_already_exists, Qfile_error, Qerror));
6625 Fput (Qfile_already_exists, Qerror_message,
6626 build_string ("File already exists"));
6628 Fput (Qfile_date_error, Qerror_conditions,
6629 list3 (Qfile_date_error, Qfile_error, Qerror));
6630 Fput (Qfile_date_error, Qerror_message,
6631 build_string ("Cannot set file date"));
6633 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6634 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6635 Vread_file_name_function = Qnil;
6637 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6638 doc: /* Current predicate used by `read-file-name-internal'. */);
6639 Vread_file_name_predicate = Qnil;
6641 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case,
6642 doc: /* *Non-nil means when reading a file name completion ignores case. */);
6643 #if defined VMS || defined DOS_NT || defined MAC_OS
6644 read_file_name_completion_ignore_case = 1;
6645 #else
6646 read_file_name_completion_ignore_case = 0;
6647 #endif
6649 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6650 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6652 When the initial minibuffer contents show a name of a file or a directory,
6653 typing RETURN without editing the initial contents is equivalent to typing
6654 the default file name.
6656 If this variable is non-nil, the minibuffer contents are always
6657 initially non-empty, and typing RETURN without editing will fetch the
6658 default name, if one is provided. Note however that this default name
6659 is not necessarily the same as initial contents inserted in the minibuffer,
6660 if the initial contents is just the default directory.
6662 If this variable is nil, the minibuffer often starts out empty. In
6663 that case you may have to explicitly fetch the next history element to
6664 request the default name; typing RETURN without editing will leave
6665 the minibuffer empty.
6667 For some commands, exiting with an empty minibuffer has a special meaning,
6668 such as making the current buffer visit no file in the case of
6669 `set-visited-file-name'. */);
6670 insert_default_directory = 1;
6672 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6673 doc: /* *Non-nil means write new files with record format `stmlf'.
6674 nil means use format `var'. This variable is meaningful only on VMS. */);
6675 vms_stmlf_recfm = 0;
6677 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6678 doc: /* Directory separator character for built-in functions that return file names.
6679 The value is always ?/. Don't use this variable, just use `/'. */);
6681 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6682 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6683 If a file name matches REGEXP, then all I/O on that file is done by calling
6684 HANDLER.
6686 The first argument given to HANDLER is the name of the I/O primitive
6687 to be handled; the remaining arguments are the arguments that were
6688 passed to that primitive. For example, if you do
6689 (file-exists-p FILENAME)
6690 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6691 (funcall HANDLER 'file-exists-p FILENAME)
6692 The function `find-file-name-handler' checks this list for a handler
6693 for its argument. */);
6694 Vfile_name_handler_alist = Qnil;
6696 DEFVAR_LISP ("set-auto-coding-function",
6697 &Vset_auto_coding_function,
6698 doc: /* If non-nil, a function to call to decide a coding system of file.
6699 Two arguments are passed to this function: the file name
6700 and the length of a file contents following the point.
6701 This function should return a coding system to decode the file contents.
6702 It should check the file name against `auto-coding-alist'.
6703 If no coding system is decided, it should check a coding system
6704 specified in the heading lines with the format:
6705 -*- ... coding: CODING-SYSTEM; ... -*-
6706 or local variable spec of the tailing lines with `coding:' tag. */);
6707 Vset_auto_coding_function = Qnil;
6709 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6710 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6711 Each is passed one argument, the number of characters inserted.
6712 It should return the new character count, and leave point the same.
6713 If `insert-file-contents' is intercepted by a handler from
6714 `file-name-handler-alist', that handler is responsible for calling the
6715 functions in `after-insert-file-functions' if appropriate. */);
6716 Vafter_insert_file_functions = Qnil;
6718 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6719 doc: /* A list of functions to be called at the start of `write-region'.
6720 Each is passed two arguments, START and END as for `write-region'.
6721 These are usually two numbers but not always; see the documentation
6722 for `write-region'. The function should return a list of pairs
6723 of the form (POSITION . STRING), consisting of strings to be effectively
6724 inserted at the specified positions of the file being written (1 means to
6725 insert before the first byte written). The POSITIONs must be sorted into
6726 increasing order. If there are several functions in the list, the several
6727 lists are merged destructively. Alternatively, the function can return
6728 with a different buffer current; in that case it should pay attention
6729 to the annotations returned by previous functions and listed in
6730 `write-region-annotations-so-far'.*/);
6731 Vwrite_region_annotate_functions = Qnil;
6732 staticpro (&Qwrite_region_annotate_functions);
6733 Qwrite_region_annotate_functions
6734 = intern ("write-region-annotate-functions");
6736 DEFVAR_LISP ("write-region-annotations-so-far",
6737 &Vwrite_region_annotations_so_far,
6738 doc: /* When an annotation function is called, this holds the previous annotations.
6739 These are the annotations made by other annotation functions
6740 that were already called. See also `write-region-annotate-functions'. */);
6741 Vwrite_region_annotations_so_far = Qnil;
6743 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6744 doc: /* A list of file name handlers that temporarily should not be used.
6745 This applies only to the operation `inhibit-file-name-operation'. */);
6746 Vinhibit_file_name_handlers = Qnil;
6748 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6749 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6750 Vinhibit_file_name_operation = Qnil;
6752 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6753 doc: /* File name in which we write a list of all auto save file names.
6754 This variable is initialized automatically from `auto-save-list-file-prefix'
6755 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6756 a non-nil value. */);
6757 Vauto_save_list_file_name = Qnil;
6759 #ifdef HAVE_FSYNC
6760 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
6761 doc: /* *Non-nil means don't call fsync in `write-region'.
6762 This variable affects calls to `write-region' as well as save commands.
6763 A non-nil value may result in data loss! */);
6764 write_region_inhibit_fsync = 0;
6765 #endif
6767 defsubr (&Sfind_file_name_handler);
6768 defsubr (&Sfile_name_directory);
6769 defsubr (&Sfile_name_nondirectory);
6770 defsubr (&Sunhandled_file_name_directory);
6771 defsubr (&Sfile_name_as_directory);
6772 defsubr (&Sdirectory_file_name);
6773 defsubr (&Smake_temp_name);
6774 defsubr (&Sexpand_file_name);
6775 defsubr (&Ssubstitute_in_file_name);
6776 defsubr (&Scopy_file);
6777 defsubr (&Smake_directory_internal);
6778 defsubr (&Sdelete_directory);
6779 defsubr (&Sdelete_file);
6780 defsubr (&Srename_file);
6781 defsubr (&Sadd_name_to_file);
6782 #ifdef S_IFLNK
6783 defsubr (&Smake_symbolic_link);
6784 #endif /* S_IFLNK */
6785 #ifdef VMS
6786 defsubr (&Sdefine_logical_name);
6787 #endif /* VMS */
6788 #ifdef HPUX_NET
6789 defsubr (&Ssysnetunam);
6790 #endif /* HPUX_NET */
6791 defsubr (&Sfile_name_absolute_p);
6792 defsubr (&Sfile_exists_p);
6793 defsubr (&Sfile_executable_p);
6794 defsubr (&Sfile_readable_p);
6795 defsubr (&Sfile_writable_p);
6796 defsubr (&Saccess_file);
6797 defsubr (&Sfile_symlink_p);
6798 defsubr (&Sfile_directory_p);
6799 defsubr (&Sfile_accessible_directory_p);
6800 defsubr (&Sfile_regular_p);
6801 defsubr (&Sfile_modes);
6802 defsubr (&Sset_file_modes);
6803 defsubr (&Sset_file_times);
6804 defsubr (&Sset_default_file_modes);
6805 defsubr (&Sdefault_file_modes);
6806 defsubr (&Sfile_newer_than_file_p);
6807 defsubr (&Sinsert_file_contents);
6808 defsubr (&Swrite_region);
6809 defsubr (&Scar_less_than_car);
6810 defsubr (&Sverify_visited_file_modtime);
6811 defsubr (&Sclear_visited_file_modtime);
6812 defsubr (&Svisited_file_modtime);
6813 defsubr (&Sset_visited_file_modtime);
6814 defsubr (&Sdo_auto_save);
6815 defsubr (&Sset_buffer_auto_saved);
6816 defsubr (&Sclear_buffer_auto_save_failure);
6817 defsubr (&Srecent_auto_save_p);
6819 defsubr (&Sread_file_name_internal);
6820 defsubr (&Sread_file_name);
6821 defsubr (&Snext_read_file_uses_dialog_p);
6823 #ifdef HAVE_SYNC
6824 defsubr (&Sunix_sync);
6825 #endif
6828 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6829 (do not change this comment) */