Don't require `cl'.
[emacs.git] / src / fileio.c
blob62331122a249b21ab9d54d514a1fdab18ff21ca5
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 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 /* The symbol bound to coding-system-for-read when
163 insert-file-contents is called for recovering a file. This is not
164 an actual coding system name, but just an indicator to tell
165 insert-file-contents to use `emacs-mule' with a special flag for
166 auto saving and recovering a file. */
167 Lisp_Object Qauto_save_coding;
169 /* Coding system for file names, or nil if none. */
170 Lisp_Object Vfile_name_coding_system;
172 /* Coding system for file names used only when
173 Vfile_name_coding_system is nil. */
174 Lisp_Object Vdefault_file_name_coding_system;
176 /* Alist of elements (REGEXP . HANDLER) for file names
177 whose I/O is done with a special handler. */
178 Lisp_Object Vfile_name_handler_alist;
180 /* Property name of a file name handler,
181 which gives a list of operations it handles.. */
182 Lisp_Object Qoperations;
184 /* Lisp functions for translating file formats */
185 Lisp_Object Qformat_decode, Qformat_annotate_function;
187 /* Function to be called to decide a coding system of a reading file. */
188 Lisp_Object Vset_auto_coding_function;
190 /* Functions to be called to process text properties in inserted file. */
191 Lisp_Object Vafter_insert_file_functions;
193 /* Lisp function for setting buffer-file-coding-system and the
194 multibyteness of the current buffer after inserting a file. */
195 Lisp_Object Qafter_insert_file_set_coding;
197 /* Functions to be called to create text property annotations for file. */
198 Lisp_Object Vwrite_region_annotate_functions;
199 Lisp_Object Qwrite_region_annotate_functions;
201 /* During build_annotations, each time an annotation function is called,
202 this holds the annotations made by the previous functions. */
203 Lisp_Object Vwrite_region_annotations_so_far;
205 /* File name in which we write a list of all our auto save files. */
206 Lisp_Object Vauto_save_list_file_name;
208 /* Function to call to read a file name. */
209 Lisp_Object Vread_file_name_function;
211 /* Current predicate used by read_file_name_internal. */
212 Lisp_Object Vread_file_name_predicate;
214 /* Nonzero means completion ignores case when reading file name. */
215 int read_file_name_completion_ignore_case;
217 /* Nonzero means, when reading a filename in the minibuffer,
218 start out by inserting the default directory into the minibuffer. */
219 int insert_default_directory;
221 /* On VMS, nonzero means write new files with record format stmlf.
222 Zero means use var format. */
223 int vms_stmlf_recfm;
225 /* On NT, specifies the directory separator character, used (eg.) when
226 expanding file names. This can be bound to / or \. */
227 Lisp_Object Vdirectory_sep_char;
229 #ifdef HAVE_FSYNC
230 /* Nonzero means skip the call to fsync in Fwrite-region. */
231 int write_region_inhibit_fsync;
232 #endif
234 extern Lisp_Object Vuser_login_name;
236 #ifdef WINDOWSNT
237 extern Lisp_Object Vw32_get_true_file_attributes;
238 #endif
240 extern int minibuf_level;
242 extern int minibuffer_auto_raise;
244 extern int history_delete_duplicates;
246 /* These variables describe handlers that have "already" had a chance
247 to handle the current operation.
249 Vinhibit_file_name_handlers is a list of file name handlers.
250 Vinhibit_file_name_operation is the operation being handled.
251 If we try to handle that operation, we ignore those handlers. */
253 static Lisp_Object Vinhibit_file_name_handlers;
254 static Lisp_Object Vinhibit_file_name_operation;
256 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
257 Lisp_Object Qexcl;
258 Lisp_Object Qfile_name_history;
260 Lisp_Object Qcar_less_than_car;
262 static int a_write P_ ((int, Lisp_Object, int, int,
263 Lisp_Object *, struct coding_system *));
264 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
267 void
268 report_file_error (string, data)
269 const char *string;
270 Lisp_Object data;
272 Lisp_Object errstring;
273 int errorno = errno;
275 synchronize_system_messages_locale ();
276 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
277 Vlocale_coding_system, 0);
279 while (1)
280 switch (errorno)
282 case EEXIST:
283 xsignal (Qfile_already_exists, Fcons (errstring, data));
284 break;
285 default:
286 /* System error messages are capitalized. Downcase the initial
287 unless it is followed by a slash. */
288 if (SREF (errstring, 1) != '/')
289 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
291 xsignal (Qfile_error,
292 Fcons (build_string (string), Fcons (errstring, data)));
296 Lisp_Object
297 close_file_unwind (fd)
298 Lisp_Object fd;
300 emacs_close (XFASTINT (fd));
301 return Qnil;
304 /* Restore point, having saved it as a marker. */
306 static Lisp_Object
307 restore_point_unwind (location)
308 Lisp_Object location;
310 Fgoto_char (location);
311 Fset_marker (location, Qnil, Qnil);
312 return Qnil;
315 Lisp_Object Qexpand_file_name;
316 Lisp_Object Qsubstitute_in_file_name;
317 Lisp_Object Qdirectory_file_name;
318 Lisp_Object Qfile_name_directory;
319 Lisp_Object Qfile_name_nondirectory;
320 Lisp_Object Qunhandled_file_name_directory;
321 Lisp_Object Qfile_name_as_directory;
322 Lisp_Object Qcopy_file;
323 Lisp_Object Qmake_directory_internal;
324 Lisp_Object Qmake_directory;
325 Lisp_Object Qdelete_directory;
326 Lisp_Object Qdelete_file;
327 Lisp_Object Qrename_file;
328 Lisp_Object Qadd_name_to_file;
329 Lisp_Object Qmake_symbolic_link;
330 Lisp_Object Qfile_exists_p;
331 Lisp_Object Qfile_executable_p;
332 Lisp_Object Qfile_readable_p;
333 Lisp_Object Qfile_writable_p;
334 Lisp_Object Qfile_symlink_p;
335 Lisp_Object Qaccess_file;
336 Lisp_Object Qfile_directory_p;
337 Lisp_Object Qfile_regular_p;
338 Lisp_Object Qfile_accessible_directory_p;
339 Lisp_Object Qfile_modes;
340 Lisp_Object Qset_file_modes;
341 Lisp_Object Qset_file_times;
342 Lisp_Object Qfile_newer_than_file_p;
343 Lisp_Object Qinsert_file_contents;
344 Lisp_Object Qwrite_region;
345 Lisp_Object Qverify_visited_file_modtime;
346 Lisp_Object Qset_visited_file_modtime;
348 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
349 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
350 Otherwise, return nil.
351 A file name is handled if one of the regular expressions in
352 `file-name-handler-alist' matches it.
354 If OPERATION equals `inhibit-file-name-operation', then we ignore
355 any handlers that are members of `inhibit-file-name-handlers',
356 but we still do run any other handlers. This lets handlers
357 use the standard functions without calling themselves recursively. */)
358 (filename, operation)
359 Lisp_Object filename, operation;
361 /* This function must not munge the match data. */
362 Lisp_Object chain, inhibited_handlers, result;
363 int pos = -1;
365 result = Qnil;
366 CHECK_STRING (filename);
368 if (EQ (operation, Vinhibit_file_name_operation))
369 inhibited_handlers = Vinhibit_file_name_handlers;
370 else
371 inhibited_handlers = Qnil;
373 for (chain = Vfile_name_handler_alist; CONSP (chain);
374 chain = XCDR (chain))
376 Lisp_Object elt;
377 elt = XCAR (chain);
378 if (CONSP (elt))
380 Lisp_Object string = XCAR (elt);
381 int match_pos;
382 Lisp_Object handler = XCDR (elt);
383 Lisp_Object operations = Qnil;
385 if (SYMBOLP (handler))
386 operations = Fget (handler, Qoperations);
388 if (STRINGP (string)
389 && (match_pos = fast_string_match (string, filename)) > pos
390 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
392 Lisp_Object tem;
394 handler = XCDR (elt);
395 tem = Fmemq (handler, inhibited_handlers);
396 if (NILP (tem))
398 result = handler;
399 pos = match_pos;
404 QUIT;
406 return result;
409 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
410 1, 1, 0,
411 doc: /* Return the directory component in file name FILENAME.
412 Return nil if FILENAME does not include a directory.
413 Otherwise return a directory spec.
414 Given a Unix syntax file name, returns a string ending in slash;
415 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
416 (filename)
417 Lisp_Object filename;
419 #ifndef DOS_NT
420 register const unsigned char *beg;
421 #else
422 register unsigned char *beg;
423 #endif
424 register const unsigned char *p;
425 Lisp_Object handler;
427 CHECK_STRING (filename);
429 /* If the file name has special constructs in it,
430 call the corresponding file handler. */
431 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
432 if (!NILP (handler))
433 return call2 (handler, Qfile_name_directory, filename);
435 filename = FILE_SYSTEM_CASE (filename);
436 beg = SDATA (filename);
437 #ifdef DOS_NT
438 beg = strcpy (alloca (strlen (beg) + 1), beg);
439 #endif
440 p = beg + SBYTES (filename);
442 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
443 #ifdef VMS
444 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
445 #endif /* VMS */
446 #ifdef DOS_NT
447 /* only recognise drive specifier at the beginning */
448 && !(p[-1] == ':'
449 /* handle the "/:d:foo" and "/:foo" cases correctly */
450 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
451 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
452 #endif
453 ) p--;
455 if (p == beg)
456 return Qnil;
457 #ifdef DOS_NT
458 /* Expansion of "c:" to drive and default directory. */
459 if (p[-1] == ':')
461 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
462 unsigned char *res = alloca (MAXPATHLEN + 1);
463 unsigned char *r = res;
465 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
467 strncpy (res, beg, 2);
468 beg += 2;
469 r += 2;
472 if (getdefdir (toupper (*beg) - 'A' + 1, r))
474 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
475 strcat (res, "/");
476 beg = res;
477 p = beg + strlen (beg);
480 CORRECT_DIR_SEPS (beg);
481 #endif /* DOS_NT */
483 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
486 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
487 Sfile_name_nondirectory, 1, 1, 0,
488 doc: /* Return file name FILENAME sans its directory.
489 For example, in a Unix-syntax file name,
490 this is everything after the last slash,
491 or the entire name if it contains no slash. */)
492 (filename)
493 Lisp_Object filename;
495 register const unsigned char *beg, *p, *end;
496 Lisp_Object handler;
498 CHECK_STRING (filename);
500 /* If the file name has special constructs in it,
501 call the corresponding file handler. */
502 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
503 if (!NILP (handler))
504 return call2 (handler, Qfile_name_nondirectory, filename);
506 beg = SDATA (filename);
507 end = p = beg + SBYTES (filename);
509 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
510 #ifdef VMS
511 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
512 #endif /* VMS */
513 #ifdef DOS_NT
514 /* only recognise drive specifier at beginning */
515 && !(p[-1] == ':'
516 /* handle the "/:d:foo" case correctly */
517 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
518 #endif
520 p--;
522 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
525 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
526 Sunhandled_file_name_directory, 1, 1, 0,
527 doc: /* Return a directly usable directory name somehow associated with FILENAME.
528 A `directly usable' directory name is one that may be used without the
529 intervention of any file handler.
530 If FILENAME is a directly usable file itself, return
531 \(file-name-directory FILENAME).
532 The `call-process' and `start-process' functions use this function to
533 get a current directory to run processes in. */)
534 (filename)
535 Lisp_Object filename;
537 Lisp_Object handler;
539 /* If the file name has special constructs in it,
540 call the corresponding file handler. */
541 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
542 if (!NILP (handler))
543 return call2 (handler, Qunhandled_file_name_directory, filename);
545 return Ffile_name_directory (filename);
549 char *
550 file_name_as_directory (out, in)
551 char *out, *in;
553 int size = strlen (in) - 1;
555 strcpy (out, in);
557 if (size < 0)
559 out[0] = '.';
560 out[1] = '/';
561 out[2] = 0;
562 return out;
565 #ifdef VMS
566 /* Is it already a directory string? */
567 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
568 return out;
569 /* Is it a VMS directory file name? If so, hack VMS syntax. */
570 else if (! index (in, '/')
571 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
572 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
573 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
574 || ! strncmp (&in[size - 5], ".dir", 4))
575 && (in[size - 1] == '.' || in[size - 1] == ';')
576 && in[size] == '1')))
578 register char *p, *dot;
579 char brack;
581 /* x.dir -> [.x]
582 dir:x.dir --> dir:[x]
583 dir:[x]y.dir --> dir:[x.y] */
584 p = in + size;
585 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
586 if (p != in)
588 strncpy (out, in, p - in);
589 out[p - in] = '\0';
590 if (*p == ':')
592 brack = ']';
593 strcat (out, ":[");
595 else
597 brack = *p;
598 strcat (out, ".");
600 p++;
602 else
604 brack = ']';
605 strcpy (out, "[.");
607 dot = index (p, '.');
608 if (dot)
610 /* blindly remove any extension */
611 size = strlen (out) + (dot - p);
612 strncat (out, p, dot - p);
614 else
616 strcat (out, p);
617 size = strlen (out);
619 out[size++] = brack;
620 out[size] = '\0';
622 #else /* not VMS */
623 /* For Unix syntax, Append a slash if necessary */
624 if (!IS_DIRECTORY_SEP (out[size]))
626 /* Cannot use DIRECTORY_SEP, which could have any value */
627 out[size + 1] = '/';
628 out[size + 2] = '\0';
630 #ifdef DOS_NT
631 CORRECT_DIR_SEPS (out);
632 #endif
633 #endif /* not VMS */
634 return out;
637 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
638 Sfile_name_as_directory, 1, 1, 0,
639 doc: /* Return a string representing the file name FILE interpreted as a directory.
640 This operation exists because a directory is also a file, but its name as
641 a directory is different from its name as a file.
642 The result can be used as the value of `default-directory'
643 or passed as second argument to `expand-file-name'.
644 For a Unix-syntax file name, just appends a slash.
645 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
646 (file)
647 Lisp_Object file;
649 char *buf;
650 Lisp_Object handler;
652 CHECK_STRING (file);
653 if (NILP (file))
654 return Qnil;
656 /* If the file name has special constructs in it,
657 call the corresponding file handler. */
658 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
659 if (!NILP (handler))
660 return call2 (handler, Qfile_name_as_directory, file);
662 buf = (char *) alloca (SBYTES (file) + 10);
663 file_name_as_directory (buf, SDATA (file));
664 return make_specified_string (buf, -1, strlen (buf),
665 STRING_MULTIBYTE (file));
669 * Convert from directory name to filename.
670 * On VMS:
671 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
672 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
673 * On UNIX, it's simple: just make sure there isn't a terminating /
675 * Value is nonzero if the string output is different from the input.
679 directory_file_name (src, dst)
680 char *src, *dst;
682 long slen;
683 #ifdef VMS
684 long rlen;
685 char * ptr, * rptr;
686 char bracket;
687 struct FAB fab = cc$rms_fab;
688 struct NAM nam = cc$rms_nam;
689 char esa[NAM$C_MAXRSS];
690 #endif /* VMS */
692 slen = strlen (src);
693 #ifdef VMS
694 if (! index (src, '/')
695 && (src[slen - 1] == ']'
696 || src[slen - 1] == ':'
697 || src[slen - 1] == '>'))
699 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
700 fab.fab$l_fna = src;
701 fab.fab$b_fns = slen;
702 fab.fab$l_nam = &nam;
703 fab.fab$l_fop = FAB$M_NAM;
705 nam.nam$l_esa = esa;
706 nam.nam$b_ess = sizeof esa;
707 nam.nam$b_nop |= NAM$M_SYNCHK;
709 /* We call SYS$PARSE to handle such things as [--] for us. */
710 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
712 slen = nam.nam$b_esl;
713 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
714 slen -= 2;
715 esa[slen] = '\0';
716 src = esa;
718 if (src[slen - 1] != ']' && src[slen - 1] != '>')
720 /* what about when we have logical_name:???? */
721 if (src[slen - 1] == ':')
722 { /* Xlate logical name and see what we get */
723 ptr = strcpy (dst, src); /* upper case for getenv */
724 while (*ptr)
726 if ('a' <= *ptr && *ptr <= 'z')
727 *ptr -= 040;
728 ptr++;
730 dst[slen - 1] = 0; /* remove colon */
731 if (!(src = egetenv (dst)))
732 return 0;
733 /* should we jump to the beginning of this procedure?
734 Good points: allows us to use logical names that xlate
735 to Unix names,
736 Bad points: can be a problem if we just translated to a device
737 name...
738 For now, I'll punt and always expect VMS names, and hope for
739 the best! */
740 slen = strlen (src);
741 if (src[slen - 1] != ']' && src[slen - 1] != '>')
742 { /* no recursion here! */
743 strcpy (dst, src);
744 return 0;
747 else
748 { /* not a directory spec */
749 strcpy (dst, src);
750 return 0;
753 bracket = src[slen - 1];
755 /* If bracket is ']' or '>', bracket - 2 is the corresponding
756 opening bracket. */
757 ptr = index (src, bracket - 2);
758 if (ptr == 0)
759 { /* no opening bracket */
760 strcpy (dst, src);
761 return 0;
763 if (!(rptr = rindex (src, '.')))
764 rptr = ptr;
765 slen = rptr - src;
766 strncpy (dst, src, slen);
767 dst[slen] = '\0';
768 if (*rptr == '.')
770 dst[slen++] = bracket;
771 dst[slen] = '\0';
773 else
775 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
776 then translate the device and recurse. */
777 if (dst[slen - 1] == ':'
778 && dst[slen - 2] != ':' /* skip decnet nodes */
779 && strcmp (src + slen, "[000000]") == 0)
781 dst[slen - 1] = '\0';
782 if ((ptr = egetenv (dst))
783 && (rlen = strlen (ptr) - 1) > 0
784 && (ptr[rlen] == ']' || ptr[rlen] == '>')
785 && ptr[rlen - 1] == '.')
787 char * buf = (char *) alloca (strlen (ptr) + 1);
788 strcpy (buf, ptr);
789 buf[rlen - 1] = ']';
790 buf[rlen] = '\0';
791 return directory_file_name (buf, dst);
793 else
794 dst[slen - 1] = ':';
796 strcat (dst, "[000000]");
797 slen += 8;
799 rptr++;
800 rlen = strlen (rptr) - 1;
801 strncat (dst, rptr, rlen);
802 dst[slen + rlen] = '\0';
803 strcat (dst, ".DIR.1");
804 return 1;
806 #endif /* VMS */
807 /* Process as Unix format: just remove any final slash.
808 But leave "/" unchanged; do not change it to "". */
809 strcpy (dst, src);
810 #ifdef APOLLO
811 /* Handle // as root for apollo's. */
812 if ((slen > 2 && dst[slen - 1] == '/')
813 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
814 dst[slen - 1] = 0;
815 #else
816 if (slen > 1
817 && IS_DIRECTORY_SEP (dst[slen - 1])
818 #ifdef DOS_NT
819 && !IS_ANY_SEP (dst[slen - 2])
820 #endif
822 dst[slen - 1] = 0;
823 #endif
824 #ifdef DOS_NT
825 CORRECT_DIR_SEPS (dst);
826 #endif
827 return 1;
830 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
831 1, 1, 0,
832 doc: /* Returns the file name of the directory named DIRECTORY.
833 This is the name of the file that holds the data for the directory DIRECTORY.
834 This operation exists because a directory is also a file, but its name as
835 a directory is different from its name as a file.
836 In Unix-syntax, this function just removes the final slash.
837 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
838 it returns a file name such as \"[X]Y.DIR.1\". */)
839 (directory)
840 Lisp_Object directory;
842 char *buf;
843 Lisp_Object handler;
845 CHECK_STRING (directory);
847 if (NILP (directory))
848 return Qnil;
850 /* If the file name has special constructs in it,
851 call the corresponding file handler. */
852 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
853 if (!NILP (handler))
854 return call2 (handler, Qdirectory_file_name, directory);
856 #ifdef VMS
857 /* 20 extra chars is insufficient for VMS, since we might perform a
858 logical name translation. an equivalence string can be up to 255
859 chars long, so grab that much extra space... - sss */
860 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
861 #else
862 buf = (char *) alloca (SBYTES (directory) + 20);
863 #endif
864 directory_file_name (SDATA (directory), buf);
865 return make_specified_string (buf, -1, strlen (buf),
866 STRING_MULTIBYTE (directory));
869 static char make_temp_name_tbl[64] =
871 'A','B','C','D','E','F','G','H',
872 'I','J','K','L','M','N','O','P',
873 'Q','R','S','T','U','V','W','X',
874 'Y','Z','a','b','c','d','e','f',
875 'g','h','i','j','k','l','m','n',
876 'o','p','q','r','s','t','u','v',
877 'w','x','y','z','0','1','2','3',
878 '4','5','6','7','8','9','-','_'
881 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
883 /* Value is a temporary file name starting with PREFIX, a string.
885 The Emacs process number forms part of the result, so there is
886 no danger of generating a name being used by another process.
887 In addition, this function makes an attempt to choose a name
888 which has no existing file. To make this work, PREFIX should be
889 an absolute file name.
891 BASE64_P non-zero means add the pid as 3 characters in base64
892 encoding. In this case, 6 characters will be added to PREFIX to
893 form the file name. Otherwise, if Emacs is running on a system
894 with long file names, add the pid as a decimal number.
896 This function signals an error if no unique file name could be
897 generated. */
899 Lisp_Object
900 make_temp_name (prefix, base64_p)
901 Lisp_Object prefix;
902 int base64_p;
904 Lisp_Object val;
905 int len, clen;
906 int pid;
907 unsigned char *p, *data;
908 char pidbuf[20];
909 int pidlen;
911 CHECK_STRING (prefix);
913 /* VAL is created by adding 6 characters to PREFIX. The first
914 three are the PID of this process, in base 64, and the second
915 three are incremented if the file already exists. This ensures
916 262144 unique file names per PID per PREFIX. */
918 pid = (int) getpid ();
920 if (base64_p)
922 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
923 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
924 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
925 pidlen = 3;
927 else
929 #ifdef HAVE_LONG_FILE_NAMES
930 sprintf (pidbuf, "%d", pid);
931 pidlen = strlen (pidbuf);
932 #else
933 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
934 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
935 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
936 pidlen = 3;
937 #endif
940 len = SBYTES (prefix); clen = SCHARS (prefix);
941 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
942 if (!STRING_MULTIBYTE (prefix))
943 STRING_SET_UNIBYTE (val);
944 data = SDATA (val);
945 bcopy(SDATA (prefix), data, len);
946 p = data + len;
948 bcopy (pidbuf, p, pidlen);
949 p += pidlen;
951 /* Here we try to minimize useless stat'ing when this function is
952 invoked many times successively with the same PREFIX. We achieve
953 this by initializing count to a random value, and incrementing it
954 afterwards.
956 We don't want make-temp-name to be called while dumping,
957 because then make_temp_name_count_initialized_p would get set
958 and then make_temp_name_count would not be set when Emacs starts. */
960 if (!make_temp_name_count_initialized_p)
962 make_temp_name_count = (unsigned) time (NULL);
963 make_temp_name_count_initialized_p = 1;
966 while (1)
968 struct stat ignored;
969 unsigned num = make_temp_name_count;
971 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
972 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
973 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
975 /* Poor man's congruential RN generator. Replace with
976 ++make_temp_name_count for debugging. */
977 make_temp_name_count += 25229;
978 make_temp_name_count %= 225307;
980 if (stat (data, &ignored) < 0)
982 /* We want to return only if errno is ENOENT. */
983 if (errno == ENOENT)
984 return val;
985 else
986 /* The error here is dubious, but there is little else we
987 can do. The alternatives are to return nil, which is
988 as bad as (and in many cases worse than) throwing the
989 error, or to ignore the error, which will likely result
990 in looping through 225307 stat's, which is not only
991 dog-slow, but also useless since it will fallback to
992 the errow below, anyway. */
993 report_file_error ("Cannot create temporary name for prefix",
994 Fcons (prefix, Qnil));
995 /* not reached */
999 error ("Cannot create temporary name for prefix `%s'",
1000 SDATA (prefix));
1001 return Qnil;
1005 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1006 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
1007 The Emacs process number forms part of the result,
1008 so there is no danger of generating a name being used by another process.
1010 In addition, this function makes an attempt to choose a name
1011 which has no existing file. To make this work,
1012 PREFIX should be an absolute file name.
1014 There is a race condition between calling `make-temp-name' and creating the
1015 file which opens all kinds of security holes. For that reason, you should
1016 probably use `make-temp-file' instead, except in three circumstances:
1018 * If you are creating the file in the user's home directory.
1019 * If you are creating a directory rather than an ordinary file.
1020 * If you are taking special precautions as `make-temp-file' does. */)
1021 (prefix)
1022 Lisp_Object prefix;
1024 return make_temp_name (prefix, 0);
1029 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1030 doc: /* Convert filename NAME to absolute, and canonicalize it.
1031 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1032 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1033 the current buffer's value of `default-directory' is used.
1034 File name components that are `.' are removed, and
1035 so are file name components followed by `..', along with the `..' itself;
1036 note that these simplifications are done without checking the resulting
1037 file names in the file system.
1038 An initial `~/' expands to your home directory.
1039 An initial `~USER/' expands to USER's home directory.
1040 See also the function `substitute-in-file-name'. */)
1041 (name, default_directory)
1042 Lisp_Object name, default_directory;
1044 unsigned char *nm;
1046 register unsigned char *newdir, *p, *o;
1047 int tlen;
1048 unsigned char *target;
1049 struct passwd *pw;
1050 #ifdef VMS
1051 unsigned char * colon = 0;
1052 unsigned char * close = 0;
1053 unsigned char * slash = 0;
1054 unsigned char * brack = 0;
1055 int lbrack = 0, rbrack = 0;
1056 int dots = 0;
1057 #endif /* VMS */
1058 #ifdef DOS_NT
1059 int drive = 0;
1060 int collapse_newdir = 1;
1061 int is_escaped = 0;
1062 #endif /* DOS_NT */
1063 int length;
1064 Lisp_Object handler, result;
1065 int multibyte;
1067 CHECK_STRING (name);
1069 /* If the file name has special constructs in it,
1070 call the corresponding file handler. */
1071 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1072 if (!NILP (handler))
1073 return call3 (handler, Qexpand_file_name, name, default_directory);
1075 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1076 if (NILP (default_directory))
1077 default_directory = current_buffer->directory;
1078 if (! STRINGP (default_directory))
1080 #ifdef DOS_NT
1081 /* "/" is not considered a root directory on DOS_NT, so using "/"
1082 here causes an infinite recursion in, e.g., the following:
1084 (let (default-directory)
1085 (expand-file-name "a"))
1087 To avoid this, we set default_directory to the root of the
1088 current drive. */
1089 extern char *emacs_root_dir (void);
1091 default_directory = build_string (emacs_root_dir ());
1092 #else
1093 default_directory = build_string ("/");
1094 #endif
1097 if (!NILP (default_directory))
1099 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1100 if (!NILP (handler))
1101 return call3 (handler, Qexpand_file_name, name, default_directory);
1104 o = SDATA (default_directory);
1106 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1107 It would be better to do this down below where we actually use
1108 default_directory. Unfortunately, calling Fexpand_file_name recursively
1109 could invoke GC, and the strings might be relocated. This would
1110 be annoying because we have pointers into strings lying around
1111 that would need adjusting, and people would add new pointers to
1112 the code and forget to adjust them, resulting in intermittent bugs.
1113 Putting this call here avoids all that crud.
1115 The EQ test avoids infinite recursion. */
1116 if (! NILP (default_directory) && !EQ (default_directory, name)
1117 /* Save time in some common cases - as long as default_directory
1118 is not relative, it can be canonicalized with name below (if it
1119 is needed at all) without requiring it to be expanded now. */
1120 #ifdef DOS_NT
1121 /* Detect MSDOS file names with drive specifiers. */
1122 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1123 #ifdef WINDOWSNT
1124 /* Detect Windows file names in UNC format. */
1125 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1126 #endif
1127 #else /* not DOS_NT */
1128 /* Detect Unix absolute file names (/... alone is not absolute on
1129 DOS or Windows). */
1130 && ! (IS_DIRECTORY_SEP (o[0]))
1131 #endif /* not DOS_NT */
1134 struct gcpro gcpro1;
1136 GCPRO1 (name);
1137 default_directory = Fexpand_file_name (default_directory, Qnil);
1138 UNGCPRO;
1141 name = FILE_SYSTEM_CASE (name);
1142 nm = SDATA (name);
1143 multibyte = STRING_MULTIBYTE (name);
1145 #ifdef DOS_NT
1146 /* We will force directory separators to be either all \ or /, so make
1147 a local copy to modify, even if there ends up being no change. */
1148 nm = strcpy (alloca (strlen (nm) + 1), nm);
1150 /* Note if special escape prefix is present, but remove for now. */
1151 if (nm[0] == '/' && nm[1] == ':')
1153 is_escaped = 1;
1154 nm += 2;
1157 /* Find and remove drive specifier if present; this makes nm absolute
1158 even if the rest of the name appears to be relative. Only look for
1159 drive specifier at the beginning. */
1160 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1162 drive = nm[0];
1163 nm += 2;
1166 #ifdef WINDOWSNT
1167 /* If we see "c://somedir", we want to strip the first slash after the
1168 colon when stripping the drive letter. Otherwise, this expands to
1169 "//somedir". */
1170 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1171 nm++;
1172 #endif /* WINDOWSNT */
1173 #endif /* DOS_NT */
1175 #ifdef WINDOWSNT
1176 /* Discard any previous drive specifier if nm is now in UNC format. */
1177 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1179 drive = 0;
1181 #endif
1183 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1184 none are found, we can probably return right away. We will avoid
1185 allocating a new string if name is already fully expanded. */
1186 if (
1187 IS_DIRECTORY_SEP (nm[0])
1188 #ifdef MSDOS
1189 && drive && !is_escaped
1190 #endif
1191 #ifdef WINDOWSNT
1192 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1193 #endif
1194 #ifdef VMS
1195 || index (nm, ':')
1196 #endif /* VMS */
1199 /* If it turns out that the filename we want to return is just a
1200 suffix of FILENAME, we don't need to go through and edit
1201 things; we just need to construct a new string using data
1202 starting at the middle of FILENAME. If we set lose to a
1203 non-zero value, that means we've discovered that we can't do
1204 that cool trick. */
1205 int lose = 0;
1207 p = nm;
1208 while (*p)
1210 /* Since we know the name is absolute, we can assume that each
1211 element starts with a "/". */
1213 /* "." and ".." are hairy. */
1214 if (IS_DIRECTORY_SEP (p[0])
1215 && p[1] == '.'
1216 && (IS_DIRECTORY_SEP (p[2])
1217 || p[2] == 0
1218 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1219 || p[3] == 0))))
1220 lose = 1;
1221 /* We want to replace multiple `/' in a row with a single
1222 slash. */
1223 else if (p > nm
1224 && IS_DIRECTORY_SEP (p[0])
1225 && IS_DIRECTORY_SEP (p[1]))
1226 lose = 1;
1228 #ifdef VMS
1229 if (p[0] == '\\')
1230 lose = 1;
1231 if (p[0] == '/') {
1232 /* if dev:[dir]/, move nm to / */
1233 if (!slash && p > nm && (brack || colon)) {
1234 nm = (brack ? brack + 1 : colon + 1);
1235 lbrack = rbrack = 0;
1236 brack = 0;
1237 colon = 0;
1239 slash = p;
1241 if (p[0] == '-')
1242 #ifdef NO_HYPHENS_IN_FILENAMES
1243 if (lbrack == rbrack)
1245 /* Avoid clobbering negative version numbers. */
1246 if (dots < 2)
1247 p[0] = '_';
1249 else
1250 #endif /* NO_HYPHENS_IN_FILENAMES */
1251 if (lbrack > rbrack
1252 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1253 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1254 lose = 1;
1255 #ifdef NO_HYPHENS_IN_FILENAMES
1256 else
1257 p[0] = '_';
1258 #endif /* NO_HYPHENS_IN_FILENAMES */
1259 /* count open brackets, reset close bracket pointer */
1260 if (p[0] == '[' || p[0] == '<')
1261 lbrack++, brack = 0;
1262 /* count close brackets, set close bracket pointer */
1263 if (p[0] == ']' || p[0] == '>')
1264 rbrack++, brack = p;
1265 /* detect ][ or >< */
1266 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1267 lose = 1;
1268 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1269 nm = p + 1, lose = 1;
1270 if (p[0] == ':' && (colon || slash))
1271 /* if dev1:[dir]dev2:, move nm to dev2: */
1272 if (brack)
1274 nm = brack + 1;
1275 brack = 0;
1277 /* if /name/dev:, move nm to dev: */
1278 else if (slash)
1279 nm = slash + 1;
1280 /* if node::dev:, move colon following dev */
1281 else if (colon && colon[-1] == ':')
1282 colon = p;
1283 /* if dev1:dev2:, move nm to dev2: */
1284 else if (colon && colon[-1] != ':')
1286 nm = colon + 1;
1287 colon = 0;
1289 if (p[0] == ':' && !colon)
1291 if (p[1] == ':')
1292 p++;
1293 colon = p;
1295 if (lbrack == rbrack)
1296 if (p[0] == ';')
1297 dots = 2;
1298 else if (p[0] == '.')
1299 dots++;
1300 #endif /* VMS */
1301 p++;
1303 if (!lose)
1305 #ifdef VMS
1306 if (index (nm, '/'))
1308 nm = sys_translate_unix (nm);
1309 return make_specified_string (nm, -1, strlen (nm), multibyte);
1311 #endif /* VMS */
1312 #ifdef DOS_NT
1313 /* Make sure directories are all separated with / or \ as
1314 desired, but avoid allocation of a new string when not
1315 required. */
1316 CORRECT_DIR_SEPS (nm);
1317 #ifdef WINDOWSNT
1318 if (IS_DIRECTORY_SEP (nm[1]))
1320 if (strcmp (nm, SDATA (name)) != 0)
1321 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1323 else
1324 #endif
1325 /* drive must be set, so this is okay */
1326 if (strcmp (nm - 2, SDATA (name)) != 0)
1328 char temp[] = " :";
1330 name = make_specified_string (nm, -1, p - nm, multibyte);
1331 temp[0] = DRIVE_LETTER (drive);
1332 name = concat2 (build_string (temp), name);
1334 return name;
1335 #else /* not DOS_NT */
1336 if (nm == SDATA (name))
1337 return name;
1338 return make_specified_string (nm, -1, strlen (nm), multibyte);
1339 #endif /* not DOS_NT */
1343 /* At this point, nm might or might not be an absolute file name. We
1344 need to expand ~ or ~user if present, otherwise prefix nm with
1345 default_directory if nm is not absolute, and finally collapse /./
1346 and /foo/../ sequences.
1348 We set newdir to be the appropriate prefix if one is needed:
1349 - the relevant user directory if nm starts with ~ or ~user
1350 - the specified drive's working dir (DOS/NT only) if nm does not
1351 start with /
1352 - the value of default_directory.
1354 Note that these prefixes are not guaranteed to be absolute (except
1355 for the working dir of a drive). Therefore, to ensure we always
1356 return an absolute name, if the final prefix is not absolute we
1357 append it to the current working directory. */
1359 newdir = 0;
1361 if (nm[0] == '~') /* prefix ~ */
1363 if (IS_DIRECTORY_SEP (nm[1])
1364 #ifdef VMS
1365 || nm[1] == ':'
1366 #endif /* VMS */
1367 || nm[1] == 0) /* ~ by itself */
1369 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1370 newdir = (unsigned char *) "";
1371 nm++;
1372 #ifdef DOS_NT
1373 collapse_newdir = 0;
1374 #endif
1375 #ifdef VMS
1376 nm++; /* Don't leave the slash in nm. */
1377 #endif /* VMS */
1379 else /* ~user/filename */
1381 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1382 #ifdef VMS
1383 && *p != ':'
1384 #endif /* VMS */
1385 ); p++);
1386 o = (unsigned char *) alloca (p - nm + 1);
1387 bcopy ((char *) nm, o, p - nm);
1388 o [p - nm] = 0;
1390 BLOCK_INPUT;
1391 pw = (struct passwd *) getpwnam (o + 1);
1392 UNBLOCK_INPUT;
1393 if (pw)
1395 newdir = (unsigned char *) pw -> pw_dir;
1396 #ifdef VMS
1397 nm = p + 1; /* skip the terminator */
1398 #else
1399 nm = p;
1400 #ifdef DOS_NT
1401 collapse_newdir = 0;
1402 #endif
1403 #endif /* VMS */
1406 /* If we don't find a user of that name, leave the name
1407 unchanged; don't move nm forward to p. */
1411 #ifdef DOS_NT
1412 /* On DOS and Windows, nm is absolute if a drive name was specified;
1413 use the drive's current directory as the prefix if needed. */
1414 if (!newdir && drive)
1416 /* Get default directory if needed to make nm absolute. */
1417 if (!IS_DIRECTORY_SEP (nm[0]))
1419 newdir = alloca (MAXPATHLEN + 1);
1420 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1421 newdir = NULL;
1423 if (!newdir)
1425 /* Either nm starts with /, or drive isn't mounted. */
1426 newdir = alloca (4);
1427 newdir[0] = DRIVE_LETTER (drive);
1428 newdir[1] = ':';
1429 newdir[2] = '/';
1430 newdir[3] = 0;
1433 #endif /* DOS_NT */
1435 /* Finally, if no prefix has been specified and nm is not absolute,
1436 then it must be expanded relative to default_directory. */
1438 if (1
1439 #ifndef DOS_NT
1440 /* /... alone is not absolute on DOS and Windows. */
1441 && !IS_DIRECTORY_SEP (nm[0])
1442 #endif
1443 #ifdef WINDOWSNT
1444 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1445 #endif
1446 #ifdef VMS
1447 && !index (nm, ':')
1448 #endif
1449 && !newdir)
1451 newdir = SDATA (default_directory);
1452 multibyte |= STRING_MULTIBYTE (default_directory);
1453 #ifdef DOS_NT
1454 /* Note if special escape prefix is present, but remove for now. */
1455 if (newdir[0] == '/' && newdir[1] == ':')
1457 is_escaped = 1;
1458 newdir += 2;
1460 #endif
1463 #ifdef DOS_NT
1464 if (newdir)
1466 /* First ensure newdir is an absolute name. */
1467 if (
1468 /* Detect MSDOS file names with drive specifiers. */
1469 ! (IS_DRIVE (newdir[0])
1470 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1471 #ifdef WINDOWSNT
1472 /* Detect Windows file names in UNC format. */
1473 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1474 #endif
1477 /* Effectively, let newdir be (expand-file-name newdir cwd).
1478 Because of the admonition against calling expand-file-name
1479 when we have pointers into lisp strings, we accomplish this
1480 indirectly by prepending newdir to nm if necessary, and using
1481 cwd (or the wd of newdir's drive) as the new newdir. */
1483 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1485 drive = newdir[0];
1486 newdir += 2;
1488 if (!IS_DIRECTORY_SEP (nm[0]))
1490 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1491 file_name_as_directory (tmp, newdir);
1492 strcat (tmp, nm);
1493 nm = tmp;
1495 newdir = alloca (MAXPATHLEN + 1);
1496 if (drive)
1498 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1499 newdir = "/";
1501 else
1502 getwd (newdir);
1505 /* Strip off drive name from prefix, if present. */
1506 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1508 drive = newdir[0];
1509 newdir += 2;
1512 /* Keep only a prefix from newdir if nm starts with slash
1513 (//server/share for UNC, nothing otherwise). */
1514 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1516 #ifdef WINDOWSNT
1517 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1519 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1520 p = newdir + 2;
1521 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1522 p++;
1523 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1524 *p = 0;
1526 else
1527 #endif
1528 newdir = "";
1531 #endif /* DOS_NT */
1533 if (newdir)
1535 /* Get rid of any slash at the end of newdir, unless newdir is
1536 just / or // (an incomplete UNC name). */
1537 length = strlen (newdir);
1538 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1539 #ifdef WINDOWSNT
1540 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1541 #endif
1544 unsigned char *temp = (unsigned char *) alloca (length);
1545 bcopy (newdir, temp, length - 1);
1546 temp[length - 1] = 0;
1547 newdir = temp;
1549 tlen = length + 1;
1551 else
1552 tlen = 0;
1554 /* Now concatenate the directory and name to new space in the stack frame */
1555 tlen += strlen (nm) + 1;
1556 #ifdef DOS_NT
1557 /* Reserve space for drive specifier and escape prefix, since either
1558 or both may need to be inserted. (The Microsoft x86 compiler
1559 produces incorrect code if the following two lines are combined.) */
1560 target = (unsigned char *) alloca (tlen + 4);
1561 target += 4;
1562 #else /* not DOS_NT */
1563 target = (unsigned char *) alloca (tlen);
1564 #endif /* not DOS_NT */
1565 *target = 0;
1567 if (newdir)
1569 #ifndef VMS
1570 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1572 #ifdef DOS_NT
1573 /* If newdir is effectively "C:/", then the drive letter will have
1574 been stripped and newdir will be "/". Concatenating with an
1575 absolute directory in nm produces "//", which will then be
1576 incorrectly treated as a network share. Ignore newdir in
1577 this case (keeping the drive letter). */
1578 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1579 && newdir[1] == '\0'))
1580 #endif
1581 strcpy (target, newdir);
1583 else
1584 #endif
1585 file_name_as_directory (target, newdir);
1588 strcat (target, nm);
1589 #ifdef VMS
1590 if (index (target, '/'))
1591 strcpy (target, sys_translate_unix (target));
1592 #endif /* VMS */
1594 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1596 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1597 appear. */
1599 p = target;
1600 o = target;
1602 while (*p)
1604 #ifdef VMS
1605 if (*p != ']' && *p != '>' && *p != '-')
1607 if (*p == '\\')
1608 p++;
1609 *o++ = *p++;
1611 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1612 /* brackets are offset from each other by 2 */
1614 p += 2;
1615 if (*p != '.' && *p != '-' && o[-1] != '.')
1616 /* convert [foo][bar] to [bar] */
1617 while (o[-1] != '[' && o[-1] != '<')
1618 o--;
1619 else if (*p == '-' && *o != '.')
1620 *--p = '.';
1622 else if (p[0] == '-' && o[-1] == '.'
1623 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1624 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1627 o--;
1628 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1629 if (p[1] == '.') /* foo.-.bar ==> bar. */
1630 p += 2;
1631 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1632 p++, o--;
1633 /* else [foo.-] ==> [-] */
1635 else
1637 #ifdef NO_HYPHENS_IN_FILENAMES
1638 if (*p == '-'
1639 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
1640 && p[1] != ']' && p[1] != '>' && p[1] != '.')
1641 *p = '_';
1642 #endif /* NO_HYPHENS_IN_FILENAMES */
1643 *o++ = *p++;
1645 #else /* not VMS */
1646 if (!IS_DIRECTORY_SEP (*p))
1648 *o++ = *p++;
1650 else if (p[1] == '.'
1651 && (IS_DIRECTORY_SEP (p[2])
1652 || p[2] == 0))
1654 /* If "/." is the entire filename, keep the "/". Otherwise,
1655 just delete the whole "/.". */
1656 if (o == target && p[2] == '\0')
1657 *o++ = *p;
1658 p += 2;
1660 else if (p[1] == '.' && p[2] == '.'
1661 /* `/../' is the "superroot" on certain file systems.
1662 Turned off on DOS_NT systems because they have no
1663 "superroot" and because this causes us to produce
1664 file names like "d:/../foo" which fail file-related
1665 functions of the underlying OS. (To reproduce, try a
1666 long series of "../../" in default_directory, longer
1667 than the number of levels from the root.) */
1668 #ifndef DOS_NT
1669 && o != target
1670 #endif
1671 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1673 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1675 /* Keep initial / only if this is the whole name. */
1676 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1677 ++o;
1678 p += 3;
1680 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1681 /* Collapse multiple `/' in a row. */
1682 p++;
1683 else
1685 *o++ = *p++;
1687 #endif /* not VMS */
1690 #ifdef DOS_NT
1691 /* At last, set drive name. */
1692 #ifdef WINDOWSNT
1693 /* Except for network file name. */
1694 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1695 #endif /* WINDOWSNT */
1697 if (!drive) abort ();
1698 target -= 2;
1699 target[0] = DRIVE_LETTER (drive);
1700 target[1] = ':';
1702 /* Reinsert the escape prefix if required. */
1703 if (is_escaped)
1705 target -= 2;
1706 target[0] = '/';
1707 target[1] = ':';
1709 CORRECT_DIR_SEPS (target);
1710 #endif /* DOS_NT */
1712 result = make_specified_string (target, -1, o - target, multibyte);
1714 /* Again look to see if the file name has special constructs in it
1715 and perhaps call the corresponding file handler. This is needed
1716 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1717 the ".." component gives us "/user@host:/bar/../baz" which needs
1718 to be expanded again. */
1719 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1720 if (!NILP (handler))
1721 return call3 (handler, Qexpand_file_name, result, default_directory);
1723 return result;
1726 #if 0
1727 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1728 This is the old version of expand-file-name, before it was thoroughly
1729 rewritten for Emacs 10.31. We leave this version here commented-out,
1730 because the code is very complex and likely to have subtle bugs. If
1731 bugs _are_ found, it might be of interest to look at the old code and
1732 see what did it do in the relevant situation.
1734 Don't remove this code: it's true that it will be accessible via CVS,
1735 but a few years from deletion, people will forget it is there. */
1737 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1738 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1739 "Convert FILENAME to absolute, and canonicalize it.\n\
1740 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1741 \(does not start with slash); if DEFAULT is nil or missing,\n\
1742 the current buffer's value of default-directory is used.\n\
1743 Filenames containing `.' or `..' as components are simplified;\n\
1744 initial `~/' expands to your home directory.\n\
1745 See also the function `substitute-in-file-name'.")
1746 (name, defalt)
1747 Lisp_Object name, defalt;
1749 unsigned char *nm;
1751 register unsigned char *newdir, *p, *o;
1752 int tlen;
1753 unsigned char *target;
1754 struct passwd *pw;
1755 int lose;
1756 #ifdef VMS
1757 unsigned char * colon = 0;
1758 unsigned char * close = 0;
1759 unsigned char * slash = 0;
1760 unsigned char * brack = 0;
1761 int lbrack = 0, rbrack = 0;
1762 int dots = 0;
1763 #endif /* VMS */
1765 CHECK_STRING (name);
1767 #ifdef VMS
1768 /* Filenames on VMS are always upper case. */
1769 name = Fupcase (name);
1770 #endif
1772 nm = SDATA (name);
1774 /* If nm is absolute, flush ...// and detect /./ and /../.
1775 If no /./ or /../ we can return right away. */
1776 if (
1777 nm[0] == '/'
1778 #ifdef VMS
1779 || index (nm, ':')
1780 #endif /* VMS */
1783 p = nm;
1784 lose = 0;
1785 while (*p)
1787 if (p[0] == '/' && p[1] == '/'
1788 #ifdef APOLLO
1789 /* // at start of filename is meaningful on Apollo system. */
1790 && nm != p
1791 #endif /* APOLLO */
1793 nm = p + 1;
1794 if (p[0] == '/' && p[1] == '~')
1795 nm = p + 1, lose = 1;
1796 if (p[0] == '/' && p[1] == '.'
1797 && (p[2] == '/' || p[2] == 0
1798 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1799 lose = 1;
1800 #ifdef VMS
1801 if (p[0] == '\\')
1802 lose = 1;
1803 if (p[0] == '/') {
1804 /* if dev:[dir]/, move nm to / */
1805 if (!slash && p > nm && (brack || colon)) {
1806 nm = (brack ? brack + 1 : colon + 1);
1807 lbrack = rbrack = 0;
1808 brack = 0;
1809 colon = 0;
1811 slash = p;
1813 if (p[0] == '-')
1814 #ifndef VMS4_4
1815 /* VMS pre V4.4,convert '-'s in filenames. */
1816 if (lbrack == rbrack)
1818 if (dots < 2) /* this is to allow negative version numbers */
1819 p[0] = '_';
1821 else
1822 #endif /* VMS4_4 */
1823 if (lbrack > rbrack
1824 && ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<')
1825 && (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1826 lose = 1;
1827 #ifndef VMS4_4
1828 else
1829 p[0] = '_';
1830 #endif /* VMS4_4 */
1831 /* count open brackets, reset close bracket pointer */
1832 if (p[0] == '[' || p[0] == '<')
1833 lbrack++, brack = 0;
1834 /* count close brackets, set close bracket pointer */
1835 if (p[0] == ']' || p[0] == '>')
1836 rbrack++, brack = p;
1837 /* detect ][ or >< */
1838 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1839 lose = 1;
1840 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1841 nm = p + 1, lose = 1;
1842 if (p[0] == ':' && (colon || slash))
1843 /* if dev1:[dir]dev2:, move nm to dev2: */
1844 if (brack)
1846 nm = brack + 1;
1847 brack = 0;
1849 /* If /name/dev:, move nm to dev: */
1850 else if (slash)
1851 nm = slash + 1;
1852 /* If node::dev:, move colon following dev */
1853 else if (colon && colon[-1] == ':')
1854 colon = p;
1855 /* If dev1:dev2:, move nm to dev2: */
1856 else if (colon && colon[-1] != ':')
1858 nm = colon + 1;
1859 colon = 0;
1861 if (p[0] == ':' && !colon)
1863 if (p[1] == ':')
1864 p++;
1865 colon = p;
1867 if (lbrack == rbrack)
1868 if (p[0] == ';')
1869 dots = 2;
1870 else if (p[0] == '.')
1871 dots++;
1872 #endif /* VMS */
1873 p++;
1875 if (!lose)
1877 #ifdef VMS
1878 if (index (nm, '/'))
1879 return build_string (sys_translate_unix (nm));
1880 #endif /* VMS */
1881 if (nm == SDATA (name))
1882 return name;
1883 return build_string (nm);
1887 /* Now determine directory to start with and put it in NEWDIR */
1889 newdir = 0;
1891 if (nm[0] == '~') /* prefix ~ */
1892 if (nm[1] == '/'
1893 #ifdef VMS
1894 || nm[1] == ':'
1895 #endif /* VMS */
1896 || nm[1] == 0)/* ~/filename */
1898 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1899 newdir = (unsigned char *) "";
1900 nm++;
1901 #ifdef VMS
1902 nm++; /* Don't leave the slash in nm. */
1903 #endif /* VMS */
1905 else /* ~user/filename */
1907 /* Get past ~ to user */
1908 unsigned char *user = nm + 1;
1909 /* Find end of name. */
1910 unsigned char *ptr = (unsigned char *) index (user, '/');
1911 int len = ptr ? ptr - user : strlen (user);
1912 #ifdef VMS
1913 unsigned char *ptr1 = index (user, ':');
1914 if (ptr1 != 0 && ptr1 - user < len)
1915 len = ptr1 - user;
1916 #endif /* VMS */
1917 /* Copy the user name into temp storage. */
1918 o = (unsigned char *) alloca (len + 1);
1919 bcopy ((char *) user, o, len);
1920 o[len] = 0;
1922 /* Look up the user name. */
1923 BLOCK_INPUT;
1924 pw = (struct passwd *) getpwnam (o + 1);
1925 UNBLOCK_INPUT;
1926 if (!pw)
1927 error ("\"%s\" isn't a registered user", o + 1);
1929 newdir = (unsigned char *) pw->pw_dir;
1931 /* Discard the user name from NM. */
1932 nm += len;
1935 if (nm[0] != '/'
1936 #ifdef VMS
1937 && !index (nm, ':')
1938 #endif /* not VMS */
1939 && !newdir)
1941 if (NILP (defalt))
1942 defalt = current_buffer->directory;
1943 CHECK_STRING (defalt);
1944 newdir = SDATA (defalt);
1947 /* Now concatenate the directory and name to new space in the stack frame */
1949 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1950 target = (unsigned char *) alloca (tlen);
1951 *target = 0;
1953 if (newdir)
1955 #ifndef VMS
1956 if (nm[0] == 0 || nm[0] == '/')
1957 strcpy (target, newdir);
1958 else
1959 #endif
1960 file_name_as_directory (target, newdir);
1963 strcat (target, nm);
1964 #ifdef VMS
1965 if (index (target, '/'))
1966 strcpy (target, sys_translate_unix (target));
1967 #endif /* VMS */
1969 /* Now canonicalize by removing /. and /foo/.. if they appear */
1971 p = target;
1972 o = target;
1974 while (*p)
1976 #ifdef VMS
1977 if (*p != ']' && *p != '>' && *p != '-')
1979 if (*p == '\\')
1980 p++;
1981 *o++ = *p++;
1983 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1984 /* brackets are offset from each other by 2 */
1986 p += 2;
1987 if (*p != '.' && *p != '-' && o[-1] != '.')
1988 /* convert [foo][bar] to [bar] */
1989 while (o[-1] != '[' && o[-1] != '<')
1990 o--;
1991 else if (*p == '-' && *o != '.')
1992 *--p = '.';
1994 else if (p[0] == '-' && o[-1] == '.'
1995 && (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1996 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1999 o--;
2000 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
2001 if (p[1] == '.') /* foo.-.bar ==> bar. */
2002 p += 2;
2003 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2004 p++, o--;
2005 /* else [foo.-] ==> [-] */
2007 else
2009 #ifndef VMS4_4
2010 if (*p == '-'
2011 && o[-1] != '[' && o[-1] != '<' && o[-1] != '.'
2012 && p[1] != ']' && p[1] != '>' && p[1] != '.')
2013 *p = '_';
2014 #endif /* VMS4_4 */
2015 *o++ = *p++;
2017 #else /* not VMS */
2018 if (*p != '/')
2020 *o++ = *p++;
2022 else if (!strncmp (p, "//", 2)
2023 #ifdef APOLLO
2024 /* // at start of filename is meaningful in Apollo system. */
2025 && o != target
2026 #endif /* APOLLO */
2029 o = target;
2030 p++;
2032 else if (p[0] == '/' && p[1] == '.'
2033 && (p[2] == '/' || p[2] == 0))
2034 p += 2;
2035 else if (!strncmp (p, "/..", 3)
2036 /* `/../' is the "superroot" on certain file systems. */
2037 && o != target
2038 && (p[3] == '/' || p[3] == 0))
2040 while (o != target && *--o != '/')
2042 #ifdef APOLLO
2043 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
2044 ++o;
2045 else
2046 #endif /* APOLLO */
2047 if (o == target && *o == '/')
2048 ++o;
2049 p += 3;
2051 else
2053 *o++ = *p++;
2055 #endif /* not VMS */
2058 return make_string (target, o - target);
2060 #endif
2062 /* If /~ or // appears, discard everything through first slash. */
2063 static int
2064 file_name_absolute_p (filename)
2065 const unsigned char *filename;
2067 return
2068 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2069 #ifdef VMS
2070 /* ??? This criterion is probably wrong for '<'. */
2071 || index (filename, ':') || index (filename, '<')
2072 || (*filename == '[' && (filename[1] != '-'
2073 || (filename[2] != '.' && filename[2] != ']'))
2074 && filename[1] != '.')
2075 #endif /* VMS */
2076 #ifdef DOS_NT
2077 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2078 && IS_DIRECTORY_SEP (filename[2]))
2079 #endif
2083 static unsigned char *
2084 search_embedded_absfilename (nm, endp)
2085 unsigned char *nm, *endp;
2087 unsigned char *p, *s;
2089 for (p = nm + 1; p < endp; p++)
2091 if ((0
2092 #ifdef VMS
2093 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2094 #endif /* VMS */
2095 || IS_DIRECTORY_SEP (p[-1]))
2096 && file_name_absolute_p (p)
2097 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2098 /* // at start of file name is meaningful in Apollo,
2099 WindowsNT and Cygwin systems. */
2100 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2101 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2104 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2105 #ifdef VMS
2106 && *s != ':'
2107 #endif /* VMS */
2108 ); s++);
2109 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2111 unsigned char *o = alloca (s - p + 1);
2112 struct passwd *pw;
2113 bcopy (p, o, s - p);
2114 o [s - p] = 0;
2116 /* If we have ~user and `user' exists, discard
2117 everything up to ~. But if `user' does not exist, leave
2118 ~user alone, it might be a literal file name. */
2119 BLOCK_INPUT;
2120 pw = getpwnam (o + 1);
2121 UNBLOCK_INPUT;
2122 if (pw)
2123 return p;
2125 else
2126 return p;
2129 return NULL;
2132 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2133 Ssubstitute_in_file_name, 1, 1, 0,
2134 doc: /* Substitute environment variables referred to in FILENAME.
2135 `$FOO' where FOO is an environment variable name means to substitute
2136 the value of that variable. The variable name should be terminated
2137 with a character not a letter, digit or underscore; otherwise, enclose
2138 the entire variable name in braces.
2139 If `/~' appears, all of FILENAME through that `/' is discarded.
2141 On VMS, `$' substitution is not done; this function does little and only
2142 duplicates what `expand-file-name' does. */)
2143 (filename)
2144 Lisp_Object filename;
2146 unsigned char *nm;
2148 register unsigned char *s, *p, *o, *x, *endp;
2149 unsigned char *target = NULL;
2150 int total = 0;
2151 int substituted = 0;
2152 unsigned char *xnm;
2153 Lisp_Object handler;
2155 CHECK_STRING (filename);
2157 /* If the file name has special constructs in it,
2158 call the corresponding file handler. */
2159 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2160 if (!NILP (handler))
2161 return call2 (handler, Qsubstitute_in_file_name, filename);
2163 nm = SDATA (filename);
2164 #ifdef DOS_NT
2165 nm = strcpy (alloca (strlen (nm) + 1), nm);
2166 CORRECT_DIR_SEPS (nm);
2167 substituted = (strcmp (nm, SDATA (filename)) != 0);
2168 #endif
2169 endp = nm + SBYTES (filename);
2171 /* If /~ or // appears, discard everything through first slash. */
2172 p = search_embedded_absfilename (nm, endp);
2173 if (p)
2174 /* Start over with the new string, so we check the file-name-handler
2175 again. Important with filenames like "/home/foo//:/hello///there"
2176 which whould substitute to "/:/hello///there" rather than "/there". */
2177 return Fsubstitute_in_file_name
2178 (make_specified_string (p, -1, endp - p,
2179 STRING_MULTIBYTE (filename)));
2181 #ifdef VMS
2182 return filename;
2183 #else
2185 /* See if any variables are substituted into the string
2186 and find the total length of their values in `total' */
2188 for (p = nm; p != endp;)
2189 if (*p != '$')
2190 p++;
2191 else
2193 p++;
2194 if (p == endp)
2195 goto badsubst;
2196 else if (*p == '$')
2198 /* "$$" means a single "$" */
2199 p++;
2200 total -= 1;
2201 substituted = 1;
2202 continue;
2204 else if (*p == '{')
2206 o = ++p;
2207 while (p != endp && *p != '}') p++;
2208 if (*p != '}') goto missingclose;
2209 s = p;
2211 else
2213 o = p;
2214 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2215 s = p;
2218 /* Copy out the variable name */
2219 target = (unsigned char *) alloca (s - o + 1);
2220 strncpy (target, o, s - o);
2221 target[s - o] = 0;
2222 #ifdef DOS_NT
2223 strupr (target); /* $home == $HOME etc. */
2224 #endif /* DOS_NT */
2226 /* Get variable value */
2227 o = (unsigned char *) egetenv (target);
2228 if (o)
2230 total += strlen (o);
2231 substituted = 1;
2233 else if (*p == '}')
2234 goto badvar;
2237 if (!substituted)
2238 return filename;
2240 /* If substitution required, recopy the string and do it */
2241 /* Make space in stack frame for the new copy */
2242 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2243 x = xnm;
2245 /* Copy the rest of the name through, replacing $ constructs with values */
2246 for (p = nm; *p;)
2247 if (*p != '$')
2248 *x++ = *p++;
2249 else
2251 p++;
2252 if (p == endp)
2253 goto badsubst;
2254 else if (*p == '$')
2256 *x++ = *p++;
2257 continue;
2259 else if (*p == '{')
2261 o = ++p;
2262 while (p != endp && *p != '}') p++;
2263 if (*p != '}') goto missingclose;
2264 s = p++;
2266 else
2268 o = p;
2269 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2270 s = p;
2273 /* Copy out the variable name */
2274 target = (unsigned char *) alloca (s - o + 1);
2275 strncpy (target, o, s - o);
2276 target[s - o] = 0;
2277 #ifdef DOS_NT
2278 strupr (target); /* $home == $HOME etc. */
2279 #endif /* DOS_NT */
2281 /* Get variable value */
2282 o = (unsigned char *) egetenv (target);
2283 if (!o)
2285 *x++ = '$';
2286 strcpy (x, target); x+= strlen (target);
2288 else if (STRING_MULTIBYTE (filename))
2290 /* If the original string is multibyte,
2291 convert what we substitute into multibyte. */
2292 while (*o)
2294 int c = unibyte_char_to_multibyte (*o++);
2295 x += CHAR_STRING (c, x);
2298 else
2300 strcpy (x, o);
2301 x += strlen (o);
2305 *x = 0;
2307 /* If /~ or // appears, discard everything through first slash. */
2308 while ((p = search_embedded_absfilename (xnm, x)))
2309 /* This time we do not start over because we've already expanded envvars
2310 and replaced $$ with $. Maybe we should start over as well, but we'd
2311 need to quote some $ to $$ first. */
2312 xnm = p;
2314 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2316 badsubst:
2317 error ("Bad format environment-variable substitution");
2318 missingclose:
2319 error ("Missing \"}\" in environment-variable substitution");
2320 badvar:
2321 error ("Substituting nonexistent environment variable \"%s\"", target);
2323 /* NOTREACHED */
2324 #endif /* not VMS */
2325 return Qnil;
2328 /* A slightly faster and more convenient way to get
2329 (directory-file-name (expand-file-name FOO)). */
2331 Lisp_Object
2332 expand_and_dir_to_file (filename, defdir)
2333 Lisp_Object filename, defdir;
2335 register Lisp_Object absname;
2337 absname = Fexpand_file_name (filename, defdir);
2338 #ifdef VMS
2340 register int c = SREF (absname, SBYTES (absname) - 1);
2341 if (c == ':' || c == ']' || c == '>')
2342 absname = Fdirectory_file_name (absname);
2344 #else
2345 /* Remove final slash, if any (unless this is the root dir).
2346 stat behaves differently depending! */
2347 if (SCHARS (absname) > 1
2348 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2349 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2350 /* We cannot take shortcuts; they might be wrong for magic file names. */
2351 absname = Fdirectory_file_name (absname);
2352 #endif
2353 return absname;
2356 /* Signal an error if the file ABSNAME already exists.
2357 If INTERACTIVE is nonzero, ask the user whether to proceed,
2358 and bypass the error if the user says to go ahead.
2359 QUERYSTRING is a name for the action that is being considered
2360 to alter the file.
2362 *STATPTR is used to store the stat information if the file exists.
2363 If the file does not exist, STATPTR->st_mode is set to 0.
2364 If STATPTR is null, we don't store into it.
2366 If QUICK is nonzero, we ask for y or n, not yes or no. */
2368 void
2369 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2370 Lisp_Object absname;
2371 unsigned char *querystring;
2372 int interactive;
2373 struct stat *statptr;
2374 int quick;
2376 register Lisp_Object tem, encoded_filename;
2377 struct stat statbuf;
2378 struct gcpro gcpro1;
2380 encoded_filename = ENCODE_FILE (absname);
2382 /* stat is a good way to tell whether the file exists,
2383 regardless of what access permissions it has. */
2384 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2386 if (! interactive)
2387 xsignal2 (Qfile_already_exists,
2388 build_string ("File already exists"), absname);
2389 GCPRO1 (absname);
2390 tem = format2 ("File %s already exists; %s anyway? ",
2391 absname, build_string (querystring));
2392 if (quick)
2393 tem = Fy_or_n_p (tem);
2394 else
2395 tem = do_yes_or_no_p (tem);
2396 UNGCPRO;
2397 if (NILP (tem))
2398 xsignal2 (Qfile_already_exists,
2399 build_string ("File already exists"), absname);
2400 if (statptr)
2401 *statptr = statbuf;
2403 else
2405 if (statptr)
2406 statptr->st_mode = 0;
2408 return;
2411 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
2412 "fCopy file: \nGCopy %s to file: \np\nP",
2413 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2414 If NEWNAME names a directory, copy FILE there.
2416 This function always sets the file modes of the output file to match
2417 the input file.
2419 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
2420 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
2421 signal a `file-already-exists' error without overwriting. If
2422 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
2423 about overwriting; this is what happens in interactive use with M-x.
2424 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
2425 existing file.
2427 Fourth arg KEEP-TIME non-nil means give the output file the same
2428 last-modified time as the old one. (This works on only some systems.)
2430 A prefix arg makes KEEP-TIME non-nil.
2432 If PRESERVE-UID-GID is non-nil, we try to transfer the
2433 uid and gid of FILE to NEWNAME. */)
2434 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid)
2435 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2436 Lisp_Object preserve_uid_gid;
2438 int ifd, ofd, n;
2439 char buf[16 * 1024];
2440 struct stat st, out_st;
2441 Lisp_Object handler;
2442 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2443 int count = SPECPDL_INDEX ();
2444 int input_file_statable_p;
2445 Lisp_Object encoded_file, encoded_newname;
2447 encoded_file = encoded_newname = Qnil;
2448 GCPRO4 (file, newname, encoded_file, encoded_newname);
2449 CHECK_STRING (file);
2450 CHECK_STRING (newname);
2452 if (!NILP (Ffile_directory_p (newname)))
2453 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2454 else
2455 newname = Fexpand_file_name (newname, Qnil);
2457 file = Fexpand_file_name (file, Qnil);
2459 /* If the input file name has special constructs in it,
2460 call the corresponding file handler. */
2461 handler = Ffind_file_name_handler (file, Qcopy_file);
2462 /* Likewise for output file name. */
2463 if (NILP (handler))
2464 handler = Ffind_file_name_handler (newname, Qcopy_file);
2465 if (!NILP (handler))
2466 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2467 ok_if_already_exists, keep_time));
2469 encoded_file = ENCODE_FILE (file);
2470 encoded_newname = ENCODE_FILE (newname);
2472 if (NILP (ok_if_already_exists)
2473 || INTEGERP (ok_if_already_exists))
2474 barf_or_query_if_file_exists (newname, "copy to it",
2475 INTEGERP (ok_if_already_exists), &out_st, 0);
2476 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2477 out_st.st_mode = 0;
2479 #ifdef WINDOWSNT
2480 if (!CopyFile (SDATA (encoded_file),
2481 SDATA (encoded_newname),
2482 FALSE))
2483 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2484 /* CopyFile retains the timestamp by default. */
2485 else if (NILP (keep_time))
2487 EMACS_TIME now;
2488 DWORD attributes;
2489 char * filename;
2491 EMACS_GET_TIME (now);
2492 filename = SDATA (encoded_newname);
2494 /* Ensure file is writable while its modified time is set. */
2495 attributes = GetFileAttributes (filename);
2496 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2497 if (set_file_times (filename, now, now))
2499 /* Restore original attributes. */
2500 SetFileAttributes (filename, attributes);
2501 xsignal2 (Qfile_date_error,
2502 build_string ("Cannot set file date"), newname);
2504 /* Restore original attributes. */
2505 SetFileAttributes (filename, attributes);
2507 #else /* not WINDOWSNT */
2508 immediate_quit = 1;
2509 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2510 immediate_quit = 0;
2512 if (ifd < 0)
2513 report_file_error ("Opening input file", Fcons (file, Qnil));
2515 record_unwind_protect (close_file_unwind, make_number (ifd));
2517 /* We can only copy regular files and symbolic links. Other files are not
2518 copyable by us. */
2519 input_file_statable_p = (fstat (ifd, &st) >= 0);
2521 #if !defined (MSDOS) || __DJGPP__ > 1
2522 if (out_st.st_mode != 0
2523 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2525 errno = 0;
2526 report_file_error ("Input and output files are the same",
2527 Fcons (file, Fcons (newname, Qnil)));
2529 #endif
2531 #if defined (S_ISREG) && defined (S_ISLNK)
2532 if (input_file_statable_p)
2534 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2536 #if defined (EISDIR)
2537 /* Get a better looking error message. */
2538 errno = EISDIR;
2539 #endif /* EISDIR */
2540 report_file_error ("Non-regular file", Fcons (file, Qnil));
2543 #endif /* S_ISREG && S_ISLNK */
2545 #ifdef VMS
2546 /* Create the copy file with the same record format as the input file */
2547 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2548 #else
2549 #ifdef MSDOS
2550 /* System's default file type was set to binary by _fmode in emacs.c. */
2551 ofd = emacs_open (SDATA (encoded_newname),
2552 O_WRONLY | O_TRUNC | O_CREAT
2553 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2554 S_IREAD | S_IWRITE);
2555 #else /* not MSDOS */
2556 ofd = emacs_open (SDATA (encoded_newname),
2557 O_WRONLY | O_TRUNC | O_CREAT
2558 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2559 0666);
2560 #endif /* not MSDOS */
2561 #endif /* VMS */
2562 if (ofd < 0)
2563 report_file_error ("Opening output file", Fcons (newname, Qnil));
2565 record_unwind_protect (close_file_unwind, make_number (ofd));
2567 immediate_quit = 1;
2568 QUIT;
2569 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2570 if (emacs_write (ofd, buf, n) != n)
2571 report_file_error ("I/O error", Fcons (newname, Qnil));
2572 immediate_quit = 0;
2574 #ifndef MSDOS
2575 /* Preserve the original file modes, and if requested, also its
2576 owner and group. */
2577 if (input_file_statable_p)
2579 if (! NILP (preserve_uid_gid))
2580 fchown (ofd, st.st_uid, st.st_gid);
2581 fchmod (ofd, st.st_mode & 07777);
2583 #endif /* not MSDOS */
2585 /* Closing the output clobbers the file times on some systems. */
2586 if (emacs_close (ofd) < 0)
2587 report_file_error ("I/O error", Fcons (newname, Qnil));
2589 if (input_file_statable_p)
2591 if (!NILP (keep_time))
2593 EMACS_TIME atime, mtime;
2594 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2595 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2596 if (set_file_times (SDATA (encoded_newname),
2597 atime, mtime))
2598 xsignal2 (Qfile_date_error,
2599 build_string ("Cannot set file date"), newname);
2603 emacs_close (ifd);
2605 #if defined (__DJGPP__) && __DJGPP__ > 1
2606 if (input_file_statable_p)
2608 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2609 and if it can't, it tells so. Otherwise, under MSDOS we usually
2610 get only the READ bit, which will make the copied file read-only,
2611 so it's better not to chmod at all. */
2612 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2613 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2615 #endif /* DJGPP version 2 or newer */
2616 #endif /* not WINDOWSNT */
2618 /* Discard the unwind protects. */
2619 specpdl_ptr = specpdl + count;
2621 UNGCPRO;
2622 return Qnil;
2625 DEFUN ("make-directory-internal", Fmake_directory_internal,
2626 Smake_directory_internal, 1, 1, 0,
2627 doc: /* Create a new directory named DIRECTORY. */)
2628 (directory)
2629 Lisp_Object directory;
2631 const unsigned char *dir;
2632 Lisp_Object handler;
2633 Lisp_Object encoded_dir;
2635 CHECK_STRING (directory);
2636 directory = Fexpand_file_name (directory, Qnil);
2638 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2639 if (!NILP (handler))
2640 return call2 (handler, Qmake_directory_internal, directory);
2642 encoded_dir = ENCODE_FILE (directory);
2644 dir = SDATA (encoded_dir);
2646 #ifdef WINDOWSNT
2647 if (mkdir (dir) != 0)
2648 #else
2649 if (mkdir (dir, 0777) != 0)
2650 #endif
2651 report_file_error ("Creating directory", list1 (directory));
2653 return Qnil;
2656 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2657 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2658 (directory)
2659 Lisp_Object directory;
2661 const unsigned char *dir;
2662 Lisp_Object handler;
2663 Lisp_Object encoded_dir;
2665 CHECK_STRING (directory);
2666 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2668 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2669 if (!NILP (handler))
2670 return call2 (handler, Qdelete_directory, directory);
2672 encoded_dir = ENCODE_FILE (directory);
2674 dir = SDATA (encoded_dir);
2676 if (rmdir (dir) != 0)
2677 report_file_error ("Removing directory", list1 (directory));
2679 return Qnil;
2682 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2683 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2684 If file has multiple names, it continues to exist with the other names. */)
2685 (filename)
2686 Lisp_Object filename;
2688 Lisp_Object handler;
2689 Lisp_Object encoded_file;
2690 struct gcpro gcpro1;
2692 GCPRO1 (filename);
2693 if (!NILP (Ffile_directory_p (filename))
2694 && NILP (Ffile_symlink_p (filename)))
2695 xsignal2 (Qfile_error,
2696 build_string ("Removing old name: is a directory"),
2697 filename);
2698 UNGCPRO;
2699 filename = Fexpand_file_name (filename, Qnil);
2701 handler = Ffind_file_name_handler (filename, Qdelete_file);
2702 if (!NILP (handler))
2703 return call2 (handler, Qdelete_file, filename);
2705 encoded_file = ENCODE_FILE (filename);
2707 if (0 > unlink (SDATA (encoded_file)))
2708 report_file_error ("Removing old name", list1 (filename));
2709 return Qnil;
2712 static Lisp_Object
2713 internal_delete_file_1 (ignore)
2714 Lisp_Object ignore;
2716 return Qt;
2719 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2722 internal_delete_file (filename)
2723 Lisp_Object filename;
2725 Lisp_Object tem;
2726 tem = internal_condition_case_1 (Fdelete_file, filename,
2727 Qt, internal_delete_file_1);
2728 return NILP (tem);
2731 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2732 "fRename file: \nGRename %s to file: \np",
2733 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2734 If file has names other than FILE, it continues to have those names.
2735 Signals a `file-already-exists' error if a file NEWNAME already exists
2736 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2737 A number as third arg means request confirmation if NEWNAME already exists.
2738 This is what happens in interactive use with M-x. */)
2739 (file, newname, ok_if_already_exists)
2740 Lisp_Object file, newname, ok_if_already_exists;
2742 Lisp_Object handler;
2743 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2744 Lisp_Object encoded_file, encoded_newname, symlink_target;
2746 symlink_target = encoded_file = encoded_newname = Qnil;
2747 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2748 CHECK_STRING (file);
2749 CHECK_STRING (newname);
2750 file = Fexpand_file_name (file, Qnil);
2752 if ((!NILP (Ffile_directory_p (newname)))
2753 #ifdef DOS_NT
2754 /* If the file names are identical but for the case,
2755 don't attempt to move directory to itself. */
2756 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2757 #endif
2759 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2760 else
2761 newname = Fexpand_file_name (newname, Qnil);
2763 /* If the file name has special constructs in it,
2764 call the corresponding file handler. */
2765 handler = Ffind_file_name_handler (file, Qrename_file);
2766 if (NILP (handler))
2767 handler = Ffind_file_name_handler (newname, Qrename_file);
2768 if (!NILP (handler))
2769 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2770 file, newname, ok_if_already_exists));
2772 encoded_file = ENCODE_FILE (file);
2773 encoded_newname = ENCODE_FILE (newname);
2775 #ifdef DOS_NT
2776 /* If the file names are identical but for the case, don't ask for
2777 confirmation: they simply want to change the letter-case of the
2778 file name. */
2779 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2780 #endif
2781 if (NILP (ok_if_already_exists)
2782 || INTEGERP (ok_if_already_exists))
2783 barf_or_query_if_file_exists (newname, "rename to it",
2784 INTEGERP (ok_if_already_exists), 0, 0);
2785 #ifndef BSD4_1
2786 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2787 #else
2788 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2789 || 0 > unlink (SDATA (encoded_file)))
2790 #endif
2792 if (errno == EXDEV)
2794 #ifdef S_IFLNK
2795 symlink_target = Ffile_symlink_p (file);
2796 if (! NILP (symlink_target))
2797 Fmake_symbolic_link (symlink_target, newname,
2798 NILP (ok_if_already_exists) ? Qnil : Qt);
2799 else
2800 #endif
2801 Fcopy_file (file, newname,
2802 /* We have already prompted if it was an integer,
2803 so don't have copy-file prompt again. */
2804 NILP (ok_if_already_exists) ? Qnil : Qt,
2805 Qt, Qt);
2807 Fdelete_file (file);
2809 else
2810 report_file_error ("Renaming", list2 (file, newname));
2812 UNGCPRO;
2813 return Qnil;
2816 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2817 "fAdd name to file: \nGName to add to %s: \np",
2818 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2819 Signals a `file-already-exists' error if a file NEWNAME already exists
2820 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2821 A number as third arg means request confirmation if NEWNAME already exists.
2822 This is what happens in interactive use with M-x. */)
2823 (file, newname, ok_if_already_exists)
2824 Lisp_Object file, newname, ok_if_already_exists;
2826 Lisp_Object handler;
2827 Lisp_Object encoded_file, encoded_newname;
2828 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2830 GCPRO4 (file, newname, encoded_file, encoded_newname);
2831 encoded_file = encoded_newname = Qnil;
2832 CHECK_STRING (file);
2833 CHECK_STRING (newname);
2834 file = Fexpand_file_name (file, Qnil);
2836 if (!NILP (Ffile_directory_p (newname)))
2837 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2838 else
2839 newname = Fexpand_file_name (newname, Qnil);
2841 /* If the file name has special constructs in it,
2842 call the corresponding file handler. */
2843 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2844 if (!NILP (handler))
2845 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2846 newname, ok_if_already_exists));
2848 /* If the new name has special constructs in it,
2849 call the corresponding file handler. */
2850 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2851 if (!NILP (handler))
2852 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2853 newname, ok_if_already_exists));
2855 encoded_file = ENCODE_FILE (file);
2856 encoded_newname = ENCODE_FILE (newname);
2858 if (NILP (ok_if_already_exists)
2859 || INTEGERP (ok_if_already_exists))
2860 barf_or_query_if_file_exists (newname, "make it a new name",
2861 INTEGERP (ok_if_already_exists), 0, 0);
2863 unlink (SDATA (newname));
2864 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2865 report_file_error ("Adding new name", list2 (file, newname));
2867 UNGCPRO;
2868 return Qnil;
2871 #ifdef S_IFLNK
2872 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2873 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2874 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2875 Both args must be strings.
2876 Signals a `file-already-exists' error if a file LINKNAME already exists
2877 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2878 A number as third arg means request confirmation if LINKNAME already exists.
2879 This happens for interactive use with M-x. */)
2880 (filename, linkname, ok_if_already_exists)
2881 Lisp_Object filename, linkname, ok_if_already_exists;
2883 Lisp_Object handler;
2884 Lisp_Object encoded_filename, encoded_linkname;
2885 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2887 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2888 encoded_filename = encoded_linkname = Qnil;
2889 CHECK_STRING (filename);
2890 CHECK_STRING (linkname);
2891 /* If the link target has a ~, we must expand it to get
2892 a truly valid file name. Otherwise, do not expand;
2893 we want to permit links to relative file names. */
2894 if (SREF (filename, 0) == '~')
2895 filename = Fexpand_file_name (filename, Qnil);
2897 if (!NILP (Ffile_directory_p (linkname)))
2898 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2899 else
2900 linkname = Fexpand_file_name (linkname, Qnil);
2902 /* If the file name has special constructs in it,
2903 call the corresponding file handler. */
2904 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2905 if (!NILP (handler))
2906 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2907 linkname, ok_if_already_exists));
2909 /* If the new link name has special constructs in it,
2910 call the corresponding file handler. */
2911 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2912 if (!NILP (handler))
2913 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2914 linkname, ok_if_already_exists));
2916 encoded_filename = ENCODE_FILE (filename);
2917 encoded_linkname = ENCODE_FILE (linkname);
2919 if (NILP (ok_if_already_exists)
2920 || INTEGERP (ok_if_already_exists))
2921 barf_or_query_if_file_exists (linkname, "make it a link",
2922 INTEGERP (ok_if_already_exists), 0, 0);
2923 if (0 > symlink (SDATA (encoded_filename),
2924 SDATA (encoded_linkname)))
2926 /* If we didn't complain already, silently delete existing file. */
2927 if (errno == EEXIST)
2929 unlink (SDATA (encoded_linkname));
2930 if (0 <= symlink (SDATA (encoded_filename),
2931 SDATA (encoded_linkname)))
2933 UNGCPRO;
2934 return Qnil;
2938 report_file_error ("Making symbolic link", list2 (filename, linkname));
2940 UNGCPRO;
2941 return Qnil;
2943 #endif /* S_IFLNK */
2945 #ifdef VMS
2947 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2948 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2949 doc: /* Define the job-wide logical name NAME to have the value STRING.
2950 If STRING is nil or a null string, the logical name NAME is deleted. */)
2951 (name, string)
2952 Lisp_Object name;
2953 Lisp_Object string;
2955 CHECK_STRING (name);
2956 if (NILP (string))
2957 delete_logical_name (SDATA (name));
2958 else
2960 CHECK_STRING (string);
2962 if (SCHARS (string) == 0)
2963 delete_logical_name (SDATA (name));
2964 else
2965 define_logical_name (SDATA (name), SDATA (string));
2968 return string;
2970 #endif /* VMS */
2972 #ifdef HPUX_NET
2974 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2975 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2976 (path, login)
2977 Lisp_Object path, login;
2979 int netresult;
2981 CHECK_STRING (path);
2982 CHECK_STRING (login);
2984 netresult = netunam (SDATA (path), SDATA (login));
2986 if (netresult == -1)
2987 return Qnil;
2988 else
2989 return Qt;
2991 #endif /* HPUX_NET */
2993 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2994 1, 1, 0,
2995 doc: /* Return t if file FILENAME specifies an absolute file name.
2996 On Unix, this is a name starting with a `/' or a `~'. */)
2997 (filename)
2998 Lisp_Object filename;
3000 CHECK_STRING (filename);
3001 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3004 /* Return nonzero if file FILENAME exists and can be executed. */
3006 static int
3007 check_executable (filename)
3008 char *filename;
3010 #ifdef DOS_NT
3011 int len = strlen (filename);
3012 char *suffix;
3013 struct stat st;
3014 if (stat (filename, &st) < 0)
3015 return 0;
3016 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3017 return ((st.st_mode & S_IEXEC) != 0);
3018 #else
3019 return (S_ISREG (st.st_mode)
3020 && len >= 5
3021 && (stricmp ((suffix = filename + len-4), ".com") == 0
3022 || stricmp (suffix, ".exe") == 0
3023 || stricmp (suffix, ".bat") == 0)
3024 || (st.st_mode & S_IFMT) == S_IFDIR);
3025 #endif /* not WINDOWSNT */
3026 #else /* not DOS_NT */
3027 #ifdef HAVE_EUIDACCESS
3028 return (euidaccess (filename, 1) >= 0);
3029 #else
3030 /* Access isn't quite right because it uses the real uid
3031 and we really want to test with the effective uid.
3032 But Unix doesn't give us a right way to do it. */
3033 return (access (filename, 1) >= 0);
3034 #endif
3035 #endif /* not DOS_NT */
3038 /* Return nonzero if file FILENAME exists and can be written. */
3040 static int
3041 check_writable (filename)
3042 char *filename;
3044 #ifdef MSDOS
3045 struct stat st;
3046 if (stat (filename, &st) < 0)
3047 return 0;
3048 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3049 #else /* not MSDOS */
3050 #ifdef HAVE_EUIDACCESS
3051 return (euidaccess (filename, 2) >= 0);
3052 #else
3053 /* Access isn't quite right because it uses the real uid
3054 and we really want to test with the effective uid.
3055 But Unix doesn't give us a right way to do it.
3056 Opening with O_WRONLY could work for an ordinary file,
3057 but would lose for directories. */
3058 return (access (filename, 2) >= 0);
3059 #endif
3060 #endif /* not MSDOS */
3063 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3064 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3065 See also `file-readable-p' and `file-attributes'.
3066 This returns nil for a symlink to a nonexistent file.
3067 Use `file-symlink-p' to test for such links. */)
3068 (filename)
3069 Lisp_Object filename;
3071 Lisp_Object absname;
3072 Lisp_Object handler;
3073 struct stat statbuf;
3075 CHECK_STRING (filename);
3076 absname = Fexpand_file_name (filename, Qnil);
3078 /* If the file name has special constructs in it,
3079 call the corresponding file handler. */
3080 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3081 if (!NILP (handler))
3082 return call2 (handler, Qfile_exists_p, absname);
3084 absname = ENCODE_FILE (absname);
3086 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3089 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3090 doc: /* Return t if FILENAME can be executed by you.
3091 For a directory, this means you can access files in that directory. */)
3092 (filename)
3093 Lisp_Object filename;
3095 Lisp_Object absname;
3096 Lisp_Object handler;
3098 CHECK_STRING (filename);
3099 absname = Fexpand_file_name (filename, Qnil);
3101 /* If the file name has special constructs in it,
3102 call the corresponding file handler. */
3103 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3104 if (!NILP (handler))
3105 return call2 (handler, Qfile_executable_p, absname);
3107 absname = ENCODE_FILE (absname);
3109 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3112 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3113 doc: /* Return t if file FILENAME exists and you can read it.
3114 See also `file-exists-p' and `file-attributes'. */)
3115 (filename)
3116 Lisp_Object filename;
3118 Lisp_Object absname;
3119 Lisp_Object handler;
3120 int desc;
3121 int flags;
3122 struct stat statbuf;
3124 CHECK_STRING (filename);
3125 absname = Fexpand_file_name (filename, Qnil);
3127 /* If the file name has special constructs in it,
3128 call the corresponding file handler. */
3129 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3130 if (!NILP (handler))
3131 return call2 (handler, Qfile_readable_p, absname);
3133 absname = ENCODE_FILE (absname);
3135 #if defined(DOS_NT) || defined(macintosh)
3136 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3137 directories. */
3138 if (access (SDATA (absname), 0) == 0)
3139 return Qt;
3140 return Qnil;
3141 #else /* not DOS_NT and not macintosh */
3142 flags = O_RDONLY;
3143 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3144 /* Opening a fifo without O_NONBLOCK can wait.
3145 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3146 except in the case of a fifo, on a system which handles it. */
3147 desc = stat (SDATA (absname), &statbuf);
3148 if (desc < 0)
3149 return Qnil;
3150 if (S_ISFIFO (statbuf.st_mode))
3151 flags |= O_NONBLOCK;
3152 #endif
3153 desc = emacs_open (SDATA (absname), flags, 0);
3154 if (desc < 0)
3155 return Qnil;
3156 emacs_close (desc);
3157 return Qt;
3158 #endif /* not DOS_NT and not macintosh */
3161 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3162 on the RT/PC. */
3163 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3164 doc: /* Return t if file FILENAME can be written or created by you. */)
3165 (filename)
3166 Lisp_Object filename;
3168 Lisp_Object absname, dir, encoded;
3169 Lisp_Object handler;
3170 struct stat statbuf;
3172 CHECK_STRING (filename);
3173 absname = Fexpand_file_name (filename, Qnil);
3175 /* If the file name has special constructs in it,
3176 call the corresponding file handler. */
3177 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3178 if (!NILP (handler))
3179 return call2 (handler, Qfile_writable_p, absname);
3181 encoded = ENCODE_FILE (absname);
3182 if (stat (SDATA (encoded), &statbuf) >= 0)
3183 return (check_writable (SDATA (encoded))
3184 ? Qt : Qnil);
3186 dir = Ffile_name_directory (absname);
3187 #ifdef VMS
3188 if (!NILP (dir))
3189 dir = Fdirectory_file_name (dir);
3190 #endif /* VMS */
3191 #ifdef MSDOS
3192 if (!NILP (dir))
3193 dir = Fdirectory_file_name (dir);
3194 #endif /* MSDOS */
3196 dir = ENCODE_FILE (dir);
3197 #ifdef WINDOWSNT
3198 /* The read-only attribute of the parent directory doesn't affect
3199 whether a file or directory can be created within it. Some day we
3200 should check ACLs though, which do affect this. */
3201 if (stat (SDATA (dir), &statbuf) < 0)
3202 return Qnil;
3203 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3204 #else
3205 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3206 ? Qt : Qnil);
3207 #endif
3210 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3211 doc: /* Access file FILENAME, and get an error if that does not work.
3212 The second argument STRING is used in the error message.
3213 If there is no error, returns nil. */)
3214 (filename, string)
3215 Lisp_Object filename, string;
3217 Lisp_Object handler, encoded_filename, absname;
3218 int fd;
3220 CHECK_STRING (filename);
3221 absname = Fexpand_file_name (filename, Qnil);
3223 CHECK_STRING (string);
3225 /* If the file name has special constructs in it,
3226 call the corresponding file handler. */
3227 handler = Ffind_file_name_handler (absname, Qaccess_file);
3228 if (!NILP (handler))
3229 return call3 (handler, Qaccess_file, absname, string);
3231 encoded_filename = ENCODE_FILE (absname);
3233 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3234 if (fd < 0)
3235 report_file_error (SDATA (string), Fcons (filename, Qnil));
3236 emacs_close (fd);
3238 return Qnil;
3241 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3242 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3243 The value is the link target, as a string.
3244 Otherwise it returns nil.
3246 This function returns t when given the name of a symlink that
3247 points to a nonexistent file. */)
3248 (filename)
3249 Lisp_Object filename;
3251 Lisp_Object handler;
3253 CHECK_STRING (filename);
3254 filename = Fexpand_file_name (filename, Qnil);
3256 /* If the file name has special constructs in it,
3257 call the corresponding file handler. */
3258 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3259 if (!NILP (handler))
3260 return call2 (handler, Qfile_symlink_p, filename);
3262 #ifdef S_IFLNK
3264 char *buf;
3265 int bufsize;
3266 int valsize;
3267 Lisp_Object val;
3269 filename = ENCODE_FILE (filename);
3271 bufsize = 50;
3272 buf = NULL;
3275 bufsize *= 2;
3276 buf = (char *) xrealloc (buf, bufsize);
3277 bzero (buf, bufsize);
3279 errno = 0;
3280 valsize = readlink (SDATA (filename), buf, bufsize);
3281 if (valsize == -1)
3283 #ifdef ERANGE
3284 /* HP-UX reports ERANGE if buffer is too small. */
3285 if (errno == ERANGE)
3286 valsize = bufsize;
3287 else
3288 #endif
3290 xfree (buf);
3291 return Qnil;
3295 while (valsize >= bufsize);
3297 val = make_string (buf, valsize);
3298 if (buf[0] == '/' && index (buf, ':'))
3299 val = concat2 (build_string ("/:"), val);
3300 xfree (buf);
3301 val = DECODE_FILE (val);
3302 return val;
3304 #else /* not S_IFLNK */
3305 return Qnil;
3306 #endif /* not S_IFLNK */
3309 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3310 doc: /* Return t if FILENAME names an existing directory.
3311 Symbolic links to directories count as directories.
3312 See `file-symlink-p' to distinguish symlinks. */)
3313 (filename)
3314 Lisp_Object filename;
3316 register Lisp_Object absname;
3317 struct stat st;
3318 Lisp_Object handler;
3320 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3322 /* If the file name has special constructs in it,
3323 call the corresponding file handler. */
3324 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3325 if (!NILP (handler))
3326 return call2 (handler, Qfile_directory_p, absname);
3328 absname = ENCODE_FILE (absname);
3330 if (stat (SDATA (absname), &st) < 0)
3331 return Qnil;
3332 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3335 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3336 doc: /* Return t if file FILENAME names a directory you can open.
3337 For the value to be t, FILENAME must specify the name of a directory as a file,
3338 and the directory must allow you to open files in it. In order to use a
3339 directory as a buffer's current directory, this predicate must return true.
3340 A directory name spec may be given instead; then the value is t
3341 if the directory so specified exists and really is a readable and
3342 searchable directory. */)
3343 (filename)
3344 Lisp_Object filename;
3346 Lisp_Object handler;
3347 int tem;
3348 struct gcpro gcpro1;
3350 /* If the file name has special constructs in it,
3351 call the corresponding file handler. */
3352 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3353 if (!NILP (handler))
3354 return call2 (handler, Qfile_accessible_directory_p, filename);
3356 GCPRO1 (filename);
3357 tem = (NILP (Ffile_directory_p (filename))
3358 || NILP (Ffile_executable_p (filename)));
3359 UNGCPRO;
3360 return tem ? Qnil : Qt;
3363 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3364 doc: /* Return t if FILENAME names a regular file.
3365 This is the sort of file that holds an ordinary stream of data bytes.
3366 Symbolic links to regular files count as regular files.
3367 See `file-symlink-p' to distinguish symlinks. */)
3368 (filename)
3369 Lisp_Object filename;
3371 register Lisp_Object absname;
3372 struct stat st;
3373 Lisp_Object handler;
3375 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3377 /* If the file name has special constructs in it,
3378 call the corresponding file handler. */
3379 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3380 if (!NILP (handler))
3381 return call2 (handler, Qfile_regular_p, absname);
3383 absname = ENCODE_FILE (absname);
3385 #ifdef WINDOWSNT
3387 int result;
3388 Lisp_Object tem = Vw32_get_true_file_attributes;
3390 /* Tell stat to use expensive method to get accurate info. */
3391 Vw32_get_true_file_attributes = Qt;
3392 result = stat (SDATA (absname), &st);
3393 Vw32_get_true_file_attributes = tem;
3395 if (result < 0)
3396 return Qnil;
3397 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3399 #else
3400 if (stat (SDATA (absname), &st) < 0)
3401 return Qnil;
3402 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3403 #endif
3406 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3407 doc: /* Return mode bits of file named FILENAME, as an integer.
3408 Return nil, if file does not exist or is not accessible. */)
3409 (filename)
3410 Lisp_Object filename;
3412 Lisp_Object absname;
3413 struct stat st;
3414 Lisp_Object handler;
3416 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3418 /* If the file name has special constructs in it,
3419 call the corresponding file handler. */
3420 handler = Ffind_file_name_handler (absname, Qfile_modes);
3421 if (!NILP (handler))
3422 return call2 (handler, Qfile_modes, absname);
3424 absname = ENCODE_FILE (absname);
3426 if (stat (SDATA (absname), &st) < 0)
3427 return Qnil;
3428 #if defined (MSDOS) && __DJGPP__ < 2
3429 if (check_executable (SDATA (absname)))
3430 st.st_mode |= S_IEXEC;
3431 #endif /* MSDOS && __DJGPP__ < 2 */
3433 return make_number (st.st_mode & 07777);
3436 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3437 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3438 Only the 12 low bits of MODE are used. */)
3439 (filename, mode)
3440 Lisp_Object filename, mode;
3442 Lisp_Object absname, encoded_absname;
3443 Lisp_Object handler;
3445 absname = Fexpand_file_name (filename, current_buffer->directory);
3446 CHECK_NUMBER (mode);
3448 /* If the file name has special constructs in it,
3449 call the corresponding file handler. */
3450 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3451 if (!NILP (handler))
3452 return call3 (handler, Qset_file_modes, absname, mode);
3454 encoded_absname = ENCODE_FILE (absname);
3456 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3457 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3459 return Qnil;
3462 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3463 doc: /* Set the file permission bits for newly created files.
3464 The argument MODE should be an integer; only the low 9 bits are used.
3465 This setting is inherited by subprocesses. */)
3466 (mode)
3467 Lisp_Object mode;
3469 CHECK_NUMBER (mode);
3471 umask ((~ XINT (mode)) & 0777);
3473 return Qnil;
3476 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3477 doc: /* Return the default file protection for created files.
3478 The value is an integer. */)
3481 int realmask;
3482 Lisp_Object value;
3484 realmask = umask (0);
3485 umask (realmask);
3487 XSETINT (value, (~ realmask) & 0777);
3488 return value;
3491 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3493 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3494 doc: /* Set times of file FILENAME to TIME.
3495 Set both access and modification times.
3496 Return t on success, else nil.
3497 Use the current time if TIME is nil. TIME is in the format of
3498 `current-time'. */)
3499 (filename, time)
3500 Lisp_Object filename, time;
3502 Lisp_Object absname, encoded_absname;
3503 Lisp_Object handler;
3504 time_t sec;
3505 int usec;
3507 if (! lisp_time_argument (time, &sec, &usec))
3508 error ("Invalid time specification");
3510 absname = Fexpand_file_name (filename, current_buffer->directory);
3512 /* If the file name has special constructs in it,
3513 call the corresponding file handler. */
3514 handler = Ffind_file_name_handler (absname, Qset_file_times);
3515 if (!NILP (handler))
3516 return call3 (handler, Qset_file_times, absname, time);
3518 encoded_absname = ENCODE_FILE (absname);
3521 EMACS_TIME t;
3523 EMACS_SET_SECS (t, sec);
3524 EMACS_SET_USECS (t, usec);
3526 if (set_file_times (SDATA (encoded_absname), t, t))
3528 #ifdef DOS_NT
3529 struct stat st;
3531 /* Setting times on a directory always fails. */
3532 if (stat (SDATA (encoded_absname), &st) == 0
3533 && (st.st_mode & S_IFMT) == S_IFDIR)
3534 return Qnil;
3535 #endif
3536 report_file_error ("Setting file times", Fcons (absname, Qnil));
3537 return Qnil;
3541 return Qt;
3544 #ifdef HAVE_SYNC
3545 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3546 doc: /* Tell Unix to finish all pending disk updates. */)
3549 sync ();
3550 return Qnil;
3553 #endif /* HAVE_SYNC */
3555 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3556 doc: /* Return t if file FILE1 is newer than file FILE2.
3557 If FILE1 does not exist, the answer is nil;
3558 otherwise, if FILE2 does not exist, the answer is t. */)
3559 (file1, file2)
3560 Lisp_Object file1, file2;
3562 Lisp_Object absname1, absname2;
3563 struct stat st;
3564 int mtime1;
3565 Lisp_Object handler;
3566 struct gcpro gcpro1, gcpro2;
3568 CHECK_STRING (file1);
3569 CHECK_STRING (file2);
3571 absname1 = Qnil;
3572 GCPRO2 (absname1, file2);
3573 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3574 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3575 UNGCPRO;
3577 /* If the file name has special constructs in it,
3578 call the corresponding file handler. */
3579 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3580 if (NILP (handler))
3581 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3582 if (!NILP (handler))
3583 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3585 GCPRO2 (absname1, absname2);
3586 absname1 = ENCODE_FILE (absname1);
3587 absname2 = ENCODE_FILE (absname2);
3588 UNGCPRO;
3590 if (stat (SDATA (absname1), &st) < 0)
3591 return Qnil;
3593 mtime1 = st.st_mtime;
3595 if (stat (SDATA (absname2), &st) < 0)
3596 return Qt;
3598 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3601 #ifdef DOS_NT
3602 Lisp_Object Qfind_buffer_file_type;
3603 #endif /* DOS_NT */
3605 #ifndef READ_BUF_SIZE
3606 #define READ_BUF_SIZE (64 << 10)
3607 #endif
3609 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3611 /* This function is called after Lisp functions to decide a coding
3612 system are called, or when they cause an error. Before they are
3613 called, the current buffer is set unibyte and it contains only a
3614 newly inserted text (thus the buffer was empty before the
3615 insertion).
3617 The functions may set markers, overlays, text properties, or even
3618 alter the buffer contents, change the current buffer.
3620 Here, we reset all those changes by:
3621 o set back the current buffer.
3622 o move all markers and overlays to BEG.
3623 o remove all text properties.
3624 o set back the buffer multibyteness. */
3626 static Lisp_Object
3627 decide_coding_unwind (unwind_data)
3628 Lisp_Object unwind_data;
3630 Lisp_Object multibyte, undo_list, buffer;
3632 multibyte = XCAR (unwind_data);
3633 unwind_data = XCDR (unwind_data);
3634 undo_list = XCAR (unwind_data);
3635 buffer = XCDR (unwind_data);
3637 if (current_buffer != XBUFFER (buffer))
3638 set_buffer_internal (XBUFFER (buffer));
3639 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3640 adjust_overlays_for_delete (BEG, Z - BEG);
3641 BUF_INTERVALS (current_buffer) = 0;
3642 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3644 /* Now we are safe to change the buffer's multibyteness directly. */
3645 current_buffer->enable_multibyte_characters = multibyte;
3646 current_buffer->undo_list = undo_list;
3648 return Qnil;
3652 /* Used to pass values from insert-file-contents to read_non_regular. */
3654 static int non_regular_fd;
3655 static int non_regular_inserted;
3656 static int non_regular_nbytes;
3659 /* Read from a non-regular file.
3660 Read non_regular_trytry bytes max from non_regular_fd.
3661 Non_regular_inserted specifies where to put the read bytes.
3662 Value is the number of bytes read. */
3664 static Lisp_Object
3665 read_non_regular ()
3667 int nbytes;
3669 immediate_quit = 1;
3670 QUIT;
3671 nbytes = emacs_read (non_regular_fd,
3672 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3673 non_regular_nbytes);
3674 immediate_quit = 0;
3675 return make_number (nbytes);
3679 /* Condition-case handler used when reading from non-regular files
3680 in insert-file-contents. */
3682 static Lisp_Object
3683 read_non_regular_quit ()
3685 return Qnil;
3689 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3690 1, 5, 0,
3691 doc: /* Insert contents of file FILENAME after point.
3692 Returns list of absolute file name and number of characters inserted.
3693 If second argument VISIT is non-nil, the buffer's visited filename and
3694 last save file modtime are set, and it is marked unmodified. If
3695 visiting and the file does not exist, visiting is completed before the
3696 error is signaled.
3698 The optional third and fourth arguments BEG and END specify what portion
3699 of the file to insert. These arguments count bytes in the file, not
3700 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3702 If optional fifth argument REPLACE is non-nil, replace the current
3703 buffer contents (in the accessible portion) with the file contents.
3704 This is better than simply deleting and inserting the whole thing
3705 because (1) it preserves some marker positions and (2) it puts less data
3706 in the undo list. When REPLACE is non-nil, the second return value is
3707 the number of characters that replace previous buffer contents.
3709 This function does code conversion according to the value of
3710 `coding-system-for-read' or `file-coding-system-alist', and sets the
3711 variable `last-coding-system-used' to the coding system actually used. */)
3712 (filename, visit, beg, end, replace)
3713 Lisp_Object filename, visit, beg, end, replace;
3715 struct stat st;
3716 register int fd;
3717 int inserted = 0;
3718 register int how_much;
3719 register int unprocessed;
3720 int count = SPECPDL_INDEX ();
3721 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3722 Lisp_Object handler, val, insval, orig_filename, old_undo;
3723 Lisp_Object p;
3724 int total = 0;
3725 int not_regular = 0;
3726 unsigned char read_buf[READ_BUF_SIZE];
3727 struct coding_system coding;
3728 unsigned char buffer[1 << 14];
3729 int replace_handled = 0;
3730 int set_coding_system = 0;
3731 int coding_system_decided = 0;
3732 int read_quit = 0;
3733 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3734 int we_locked_file = 0;
3736 if (current_buffer->base_buffer && ! NILP (visit))
3737 error ("Cannot do file visiting in an indirect buffer");
3739 if (!NILP (current_buffer->read_only))
3740 Fbarf_if_buffer_read_only ();
3742 val = Qnil;
3743 p = Qnil;
3744 orig_filename = Qnil;
3745 old_undo = Qnil;
3747 GCPRO5 (filename, val, p, orig_filename, old_undo);
3749 CHECK_STRING (filename);
3750 filename = Fexpand_file_name (filename, Qnil);
3752 /* If the file name has special constructs in it,
3753 call the corresponding file handler. */
3754 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3755 if (!NILP (handler))
3757 val = call6 (handler, Qinsert_file_contents, filename,
3758 visit, beg, end, replace);
3759 if (CONSP (val) && CONSP (XCDR (val)))
3760 inserted = XINT (XCAR (XCDR (val)));
3761 goto handled;
3764 orig_filename = filename;
3765 filename = ENCODE_FILE (filename);
3767 fd = -1;
3769 #ifdef WINDOWSNT
3771 Lisp_Object tem = Vw32_get_true_file_attributes;
3773 /* Tell stat to use expensive method to get accurate info. */
3774 Vw32_get_true_file_attributes = Qt;
3775 total = stat (SDATA (filename), &st);
3776 Vw32_get_true_file_attributes = tem;
3778 if (total < 0)
3779 #else
3780 #ifndef APOLLO
3781 if (stat (SDATA (filename), &st) < 0)
3782 #else
3783 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3784 || fstat (fd, &st) < 0)
3785 #endif /* not APOLLO */
3786 #endif /* WINDOWSNT */
3788 if (fd >= 0) emacs_close (fd);
3789 badopen:
3790 if (NILP (visit))
3791 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3792 st.st_mtime = -1;
3793 how_much = 0;
3794 if (!NILP (Vcoding_system_for_read))
3795 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3796 goto notfound;
3799 #ifdef S_IFREG
3800 /* This code will need to be changed in order to work on named
3801 pipes, and it's probably just not worth it. So we should at
3802 least signal an error. */
3803 if (!S_ISREG (st.st_mode))
3805 not_regular = 1;
3807 if (! NILP (visit))
3808 goto notfound;
3810 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3811 xsignal2 (Qfile_error,
3812 build_string ("not a regular file"), orig_filename);
3814 #endif
3816 if (fd < 0)
3817 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3818 goto badopen;
3820 /* Replacement should preserve point as it preserves markers. */
3821 if (!NILP (replace))
3822 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3824 record_unwind_protect (close_file_unwind, make_number (fd));
3826 /* Supposedly happens on VMS. */
3827 /* Can happen on any platform that uses long as type of off_t, but allows
3828 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3829 give a message suitable for the latter case. */
3830 if (! not_regular && st.st_size < 0)
3831 error ("Maximum buffer size exceeded");
3833 /* Prevent redisplay optimizations. */
3834 current_buffer->clip_changed = 1;
3836 if (!NILP (visit))
3838 if (!NILP (beg) || !NILP (end))
3839 error ("Attempt to visit less than an entire file");
3840 if (BEG < Z && NILP (replace))
3841 error ("Cannot do file visiting in a non-empty buffer");
3844 if (!NILP (beg))
3845 CHECK_NUMBER (beg);
3846 else
3847 XSETFASTINT (beg, 0);
3849 if (!NILP (end))
3850 CHECK_NUMBER (end);
3851 else
3853 if (! not_regular)
3855 XSETINT (end, st.st_size);
3857 /* Arithmetic overflow can occur if an Emacs integer cannot
3858 represent the file size, or if the calculations below
3859 overflow. The calculations below double the file size
3860 twice, so check that it can be multiplied by 4 safely. */
3861 if (XINT (end) != st.st_size
3862 || ((int) st.st_size * 4) / 4 != st.st_size)
3863 error ("Maximum buffer size exceeded");
3865 /* The file size returned from stat may be zero, but data
3866 may be readable nonetheless, for example when this is a
3867 file in the /proc filesystem. */
3868 if (st.st_size == 0)
3869 XSETINT (end, READ_BUF_SIZE);
3873 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3875 /* We use emacs-mule for auto saving... */
3876 setup_coding_system (Qemacs_mule, &coding);
3877 /* ... but with the special flag to indicate to read in a
3878 multibyte sequence for eight-bit-control char as is. */
3879 coding.flags = 1;
3880 coding.src_multibyte = 0;
3881 coding.dst_multibyte
3882 = !NILP (current_buffer->enable_multibyte_characters);
3883 coding.eol_type = CODING_EOL_LF;
3884 coding_system_decided = 1;
3886 else if (BEG < Z)
3888 /* Decide the coding system to use for reading the file now
3889 because we can't use an optimized method for handling
3890 `coding:' tag if the current buffer is not empty. */
3891 Lisp_Object val;
3892 val = Qnil;
3894 if (!NILP (Vcoding_system_for_read))
3895 val = Vcoding_system_for_read;
3896 else
3898 /* Don't try looking inside a file for a coding system
3899 specification if it is not seekable. */
3900 if (! not_regular && ! NILP (Vset_auto_coding_function))
3902 /* Find a coding system specified in the heading two
3903 lines or in the tailing several lines of the file.
3904 We assume that the 1K-byte and 3K-byte for heading
3905 and tailing respectively are sufficient for this
3906 purpose. */
3907 int nread;
3909 if (st.st_size <= (1024 * 4))
3910 nread = emacs_read (fd, read_buf, 1024 * 4);
3911 else
3913 nread = emacs_read (fd, read_buf, 1024);
3914 if (nread >= 0)
3916 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3917 report_file_error ("Setting file position",
3918 Fcons (orig_filename, Qnil));
3919 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3923 if (nread < 0)
3924 error ("IO error reading %s: %s",
3925 SDATA (orig_filename), emacs_strerror (errno));
3926 else if (nread > 0)
3928 struct buffer *prev = current_buffer;
3929 Lisp_Object buffer;
3930 struct buffer *buf;
3932 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3934 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3935 buf = XBUFFER (buffer);
3937 delete_all_overlays (buf);
3938 buf->directory = current_buffer->directory;
3939 buf->read_only = Qnil;
3940 buf->filename = Qnil;
3941 buf->undo_list = Qt;
3942 eassert (buf->overlays_before == NULL);
3943 eassert (buf->overlays_after == NULL);
3945 set_buffer_internal (buf);
3946 Ferase_buffer ();
3947 buf->enable_multibyte_characters = Qnil;
3949 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3950 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3951 val = call2 (Vset_auto_coding_function,
3952 filename, make_number (nread));
3953 set_buffer_internal (prev);
3955 /* Discard the unwind protect for recovering the
3956 current buffer. */
3957 specpdl_ptr--;
3959 /* Rewind the file for the actual read done later. */
3960 if (lseek (fd, 0, 0) < 0)
3961 report_file_error ("Setting file position",
3962 Fcons (orig_filename, Qnil));
3966 if (NILP (val))
3968 /* If we have not yet decided a coding system, check
3969 file-coding-system-alist. */
3970 Lisp_Object args[6], coding_systems;
3972 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3973 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3974 coding_systems = Ffind_operation_coding_system (6, args);
3975 if (CONSP (coding_systems))
3976 val = XCAR (coding_systems);
3980 setup_coding_system (Fcheck_coding_system (val), &coding);
3981 /* Ensure we set Vlast_coding_system_used. */
3982 set_coding_system = 1;
3984 if (NILP (current_buffer->enable_multibyte_characters)
3985 && ! NILP (val))
3986 /* We must suppress all character code conversion except for
3987 end-of-line conversion. */
3988 setup_raw_text_coding_system (&coding);
3990 coding.src_multibyte = 0;
3991 coding.dst_multibyte
3992 = !NILP (current_buffer->enable_multibyte_characters);
3993 coding_system_decided = 1;
3996 /* If requested, replace the accessible part of the buffer
3997 with the file contents. Avoid replacing text at the
3998 beginning or end of the buffer that matches the file contents;
3999 that preserves markers pointing to the unchanged parts.
4001 Here we implement this feature in an optimized way
4002 for the case where code conversion is NOT needed.
4003 The following if-statement handles the case of conversion
4004 in a less optimal way.
4006 If the code conversion is "automatic" then we try using this
4007 method and hope for the best.
4008 But if we discover the need for conversion, we give up on this method
4009 and let the following if-statement handle the replace job. */
4010 if (!NILP (replace)
4011 && BEGV < ZV
4012 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
4014 /* same_at_start and same_at_end count bytes,
4015 because file access counts bytes
4016 and BEG and END count bytes. */
4017 int same_at_start = BEGV_BYTE;
4018 int same_at_end = ZV_BYTE;
4019 int overlap;
4020 /* There is still a possibility we will find the need to do code
4021 conversion. If that happens, we set this variable to 1 to
4022 give up on handling REPLACE in the optimized way. */
4023 int giveup_match_end = 0;
4025 if (XINT (beg) != 0)
4027 if (lseek (fd, XINT (beg), 0) < 0)
4028 report_file_error ("Setting file position",
4029 Fcons (orig_filename, Qnil));
4032 immediate_quit = 1;
4033 QUIT;
4034 /* Count how many chars at the start of the file
4035 match the text at the beginning of the buffer. */
4036 while (1)
4038 int nread, bufpos;
4040 nread = emacs_read (fd, buffer, sizeof buffer);
4041 if (nread < 0)
4042 error ("IO error reading %s: %s",
4043 SDATA (orig_filename), emacs_strerror (errno));
4044 else if (nread == 0)
4045 break;
4047 if (coding.type == coding_type_undecided)
4048 detect_coding (&coding, buffer, nread);
4049 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
4050 /* We found that the file should be decoded somehow.
4051 Let's give up here. */
4053 giveup_match_end = 1;
4054 break;
4057 if (coding.eol_type == CODING_EOL_UNDECIDED)
4058 detect_eol (&coding, buffer, nread);
4059 if (coding.eol_type != CODING_EOL_UNDECIDED
4060 && coding.eol_type != CODING_EOL_LF)
4061 /* We found that the format of eol should be decoded.
4062 Let's give up here. */
4064 giveup_match_end = 1;
4065 break;
4068 bufpos = 0;
4069 while (bufpos < nread && same_at_start < ZV_BYTE
4070 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4071 same_at_start++, bufpos++;
4072 /* If we found a discrepancy, stop the scan.
4073 Otherwise loop around and scan the next bufferful. */
4074 if (bufpos != nread)
4075 break;
4077 immediate_quit = 0;
4078 /* If the file matches the buffer completely,
4079 there's no need to replace anything. */
4080 if (same_at_start - BEGV_BYTE == XINT (end))
4082 emacs_close (fd);
4083 specpdl_ptr--;
4084 /* Truncate the buffer to the size of the file. */
4085 del_range_1 (same_at_start, same_at_end, 0, 0);
4086 goto handled;
4088 immediate_quit = 1;
4089 QUIT;
4090 /* Count how many chars at the end of the file
4091 match the text at the end of the buffer. But, if we have
4092 already found that decoding is necessary, don't waste time. */
4093 while (!giveup_match_end)
4095 int total_read, nread, bufpos, curpos, trial;
4097 /* At what file position are we now scanning? */
4098 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4099 /* If the entire file matches the buffer tail, stop the scan. */
4100 if (curpos == 0)
4101 break;
4102 /* How much can we scan in the next step? */
4103 trial = min (curpos, sizeof buffer);
4104 if (lseek (fd, curpos - trial, 0) < 0)
4105 report_file_error ("Setting file position",
4106 Fcons (orig_filename, Qnil));
4108 total_read = nread = 0;
4109 while (total_read < trial)
4111 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4112 if (nread < 0)
4113 error ("IO error reading %s: %s",
4114 SDATA (orig_filename), emacs_strerror (errno));
4115 else if (nread == 0)
4116 break;
4117 total_read += nread;
4120 /* Scan this bufferful from the end, comparing with
4121 the Emacs buffer. */
4122 bufpos = total_read;
4124 /* Compare with same_at_start to avoid counting some buffer text
4125 as matching both at the file's beginning and at the end. */
4126 while (bufpos > 0 && same_at_end > same_at_start
4127 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4128 same_at_end--, bufpos--;
4130 /* If we found a discrepancy, stop the scan.
4131 Otherwise loop around and scan the preceding bufferful. */
4132 if (bufpos != 0)
4134 /* If this discrepancy is because of code conversion,
4135 we cannot use this method; giveup and try the other. */
4136 if (same_at_end > same_at_start
4137 && FETCH_BYTE (same_at_end - 1) >= 0200
4138 && ! NILP (current_buffer->enable_multibyte_characters)
4139 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4140 giveup_match_end = 1;
4141 break;
4144 if (nread == 0)
4145 break;
4147 immediate_quit = 0;
4149 if (! giveup_match_end)
4151 int temp;
4153 /* We win! We can handle REPLACE the optimized way. */
4155 /* Extend the start of non-matching text area to multibyte
4156 character boundary. */
4157 if (! NILP (current_buffer->enable_multibyte_characters))
4158 while (same_at_start > BEGV_BYTE
4159 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4160 same_at_start--;
4162 /* Extend the end of non-matching text area to multibyte
4163 character boundary. */
4164 if (! NILP (current_buffer->enable_multibyte_characters))
4165 while (same_at_end < ZV_BYTE
4166 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4167 same_at_end++;
4169 /* Don't try to reuse the same piece of text twice. */
4170 overlap = (same_at_start - BEGV_BYTE
4171 - (same_at_end + st.st_size - ZV));
4172 if (overlap > 0)
4173 same_at_end += overlap;
4175 /* Arrange to read only the nonmatching middle part of the file. */
4176 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4177 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4179 del_range_byte (same_at_start, same_at_end, 0);
4180 /* Insert from the file at the proper position. */
4181 temp = BYTE_TO_CHAR (same_at_start);
4182 SET_PT_BOTH (temp, same_at_start);
4184 /* If display currently starts at beginning of line,
4185 keep it that way. */
4186 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4187 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4189 replace_handled = 1;
4193 /* If requested, replace the accessible part of the buffer
4194 with the file contents. Avoid replacing text at the
4195 beginning or end of the buffer that matches the file contents;
4196 that preserves markers pointing to the unchanged parts.
4198 Here we implement this feature for the case where code conversion
4199 is needed, in a simple way that needs a lot of memory.
4200 The preceding if-statement handles the case of no conversion
4201 in a more optimized way. */
4202 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4204 int same_at_start = BEGV_BYTE;
4205 int same_at_end = ZV_BYTE;
4206 int overlap;
4207 int bufpos;
4208 /* Make sure that the gap is large enough. */
4209 int bufsize = 2 * st.st_size;
4210 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4211 int temp;
4213 /* First read the whole file, performing code conversion into
4214 CONVERSION_BUFFER. */
4216 if (lseek (fd, XINT (beg), 0) < 0)
4218 xfree (conversion_buffer);
4219 report_file_error ("Setting file position",
4220 Fcons (orig_filename, Qnil));
4223 total = st.st_size; /* Total bytes in the file. */
4224 how_much = 0; /* Bytes read from file so far. */
4225 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4226 unprocessed = 0; /* Bytes not processed in previous loop. */
4228 while (how_much < total)
4230 /* try is reserved in some compilers (Microsoft C) */
4231 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4232 unsigned char *destination = read_buf + unprocessed;
4233 int this;
4235 /* Allow quitting out of the actual I/O. */
4236 immediate_quit = 1;
4237 QUIT;
4238 this = emacs_read (fd, destination, trytry);
4239 immediate_quit = 0;
4241 if (this < 0 || this + unprocessed == 0)
4243 how_much = this;
4244 break;
4247 how_much += this;
4249 if (CODING_MAY_REQUIRE_DECODING (&coding))
4251 int require, result;
4253 this += unprocessed;
4255 /* If we are using more space than estimated,
4256 make CONVERSION_BUFFER bigger. */
4257 require = decoding_buffer_size (&coding, this);
4258 if (inserted + require + 2 * (total - how_much) > bufsize)
4260 bufsize = inserted + require + 2 * (total - how_much);
4261 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4264 /* Convert this batch with results in CONVERSION_BUFFER. */
4265 if (how_much >= total) /* This is the last block. */
4266 coding.mode |= CODING_MODE_LAST_BLOCK;
4267 if (coding.composing != COMPOSITION_DISABLED)
4268 coding_allocate_composition_data (&coding, BEGV);
4269 result = decode_coding (&coding, read_buf,
4270 conversion_buffer + inserted,
4271 this, bufsize - inserted);
4273 /* Save for next iteration whatever we didn't convert. */
4274 unprocessed = this - coding.consumed;
4275 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4276 if (!NILP (current_buffer->enable_multibyte_characters))
4277 this = coding.produced;
4278 else
4279 this = str_as_unibyte (conversion_buffer + inserted,
4280 coding.produced);
4283 inserted += this;
4286 /* At this point, INSERTED is how many characters (i.e. bytes)
4287 are present in CONVERSION_BUFFER.
4288 HOW_MUCH should equal TOTAL,
4289 or should be <= 0 if we couldn't read the file. */
4291 if (how_much < 0)
4293 xfree (conversion_buffer);
4294 coding_free_composition_data (&coding);
4295 error ("IO error reading %s: %s",
4296 SDATA (orig_filename), emacs_strerror (errno));
4299 /* Compare the beginning of the converted file
4300 with the buffer text. */
4302 bufpos = 0;
4303 while (bufpos < inserted && same_at_start < same_at_end
4304 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4305 same_at_start++, bufpos++;
4307 /* If the file matches the buffer completely,
4308 there's no need to replace anything. */
4310 if (bufpos == inserted)
4312 xfree (conversion_buffer);
4313 coding_free_composition_data (&coding);
4314 emacs_close (fd);
4315 specpdl_ptr--;
4316 /* Truncate the buffer to the size of the file. */
4317 del_range_byte (same_at_start, same_at_end, 0);
4318 inserted = 0;
4319 goto handled;
4322 /* Extend the start of non-matching text area to multibyte
4323 character boundary. */
4324 if (! NILP (current_buffer->enable_multibyte_characters))
4325 while (same_at_start > BEGV_BYTE
4326 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4327 same_at_start--;
4329 /* Scan this bufferful from the end, comparing with
4330 the Emacs buffer. */
4331 bufpos = inserted;
4333 /* Compare with same_at_start to avoid counting some buffer text
4334 as matching both at the file's beginning and at the end. */
4335 while (bufpos > 0 && same_at_end > same_at_start
4336 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4337 same_at_end--, bufpos--;
4339 /* Extend the end of non-matching text area to multibyte
4340 character boundary. */
4341 if (! NILP (current_buffer->enable_multibyte_characters))
4342 while (same_at_end < ZV_BYTE
4343 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4344 same_at_end++;
4346 /* Don't try to reuse the same piece of text twice. */
4347 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4348 if (overlap > 0)
4349 same_at_end += overlap;
4351 /* If display currently starts at beginning of line,
4352 keep it that way. */
4353 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4354 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4356 /* Replace the chars that we need to replace,
4357 and update INSERTED to equal the number of bytes
4358 we are taking from the file. */
4359 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4361 if (same_at_end != same_at_start)
4363 del_range_byte (same_at_start, same_at_end, 0);
4364 temp = GPT;
4365 same_at_start = GPT_BYTE;
4367 else
4369 temp = BYTE_TO_CHAR (same_at_start);
4371 /* Insert from the file at the proper position. */
4372 SET_PT_BOTH (temp, same_at_start);
4373 insert_1 (conversion_buffer + same_at_start - BEGV_BYTE, inserted,
4374 0, 0, 0);
4375 if (coding.cmp_data && coding.cmp_data->used)
4376 coding_restore_composition (&coding, Fcurrent_buffer ());
4377 coding_free_composition_data (&coding);
4379 /* Set `inserted' to the number of inserted characters. */
4380 inserted = PT - temp;
4381 /* Set point before the inserted characters. */
4382 SET_PT_BOTH (temp, same_at_start);
4384 xfree (conversion_buffer);
4385 emacs_close (fd);
4386 specpdl_ptr--;
4388 goto handled;
4391 if (! not_regular)
4393 register Lisp_Object temp;
4395 total = XINT (end) - XINT (beg);
4397 /* Make sure point-max won't overflow after this insertion. */
4398 XSETINT (temp, total);
4399 if (total != XINT (temp))
4400 error ("Maximum buffer size exceeded");
4402 else
4403 /* For a special file, all we can do is guess. */
4404 total = READ_BUF_SIZE;
4406 if (NILP (visit) && inserted > 0)
4408 #ifdef CLASH_DETECTION
4409 if (!NILP (current_buffer->file_truename)
4410 /* Make binding buffer-file-name to nil effective. */
4411 && !NILP (current_buffer->filename)
4412 && SAVE_MODIFF >= MODIFF)
4413 we_locked_file = 1;
4414 #endif /* CLASH_DETECTION */
4415 prepare_to_modify_buffer (GPT, GPT, NULL);
4418 move_gap (PT);
4419 if (GAP_SIZE < total)
4420 make_gap (total - GAP_SIZE);
4422 if (XINT (beg) != 0 || !NILP (replace))
4424 if (lseek (fd, XINT (beg), 0) < 0)
4425 report_file_error ("Setting file position",
4426 Fcons (orig_filename, Qnil));
4429 /* In the following loop, HOW_MUCH contains the total bytes read so
4430 far for a regular file, and not changed for a special file. But,
4431 before exiting the loop, it is set to a negative value if I/O
4432 error occurs. */
4433 how_much = 0;
4435 /* Total bytes inserted. */
4436 inserted = 0;
4438 /* Here, we don't do code conversion in the loop. It is done by
4439 code_convert_region after all data are read into the buffer. */
4441 int gap_size = GAP_SIZE;
4443 while (how_much < total)
4445 /* try is reserved in some compilers (Microsoft C) */
4446 int trytry = min (total - how_much, READ_BUF_SIZE);
4447 int this;
4449 if (not_regular)
4451 Lisp_Object val;
4453 /* Maybe make more room. */
4454 if (gap_size < trytry)
4456 make_gap (total - gap_size);
4457 gap_size = GAP_SIZE;
4460 /* Read from the file, capturing `quit'. When an
4461 error occurs, end the loop, and arrange for a quit
4462 to be signaled after decoding the text we read. */
4463 non_regular_fd = fd;
4464 non_regular_inserted = inserted;
4465 non_regular_nbytes = trytry;
4466 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4467 read_non_regular_quit);
4468 if (NILP (val))
4470 read_quit = 1;
4471 break;
4474 this = XINT (val);
4476 else
4478 /* Allow quitting out of the actual I/O. We don't make text
4479 part of the buffer until all the reading is done, so a C-g
4480 here doesn't do any harm. */
4481 immediate_quit = 1;
4482 QUIT;
4483 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4484 immediate_quit = 0;
4487 if (this <= 0)
4489 how_much = this;
4490 break;
4493 gap_size -= this;
4495 /* For a regular file, where TOTAL is the real size,
4496 count HOW_MUCH to compare with it.
4497 For a special file, where TOTAL is just a buffer size,
4498 so don't bother counting in HOW_MUCH.
4499 (INSERTED is where we count the number of characters inserted.) */
4500 if (! not_regular)
4501 how_much += this;
4502 inserted += this;
4506 /* Now we have read all the file data into the gap.
4507 If it was empty, undo marking the buffer modified. */
4509 if (inserted == 0)
4511 #ifdef CLASH_DETECTION
4512 if (we_locked_file)
4513 unlock_file (current_buffer->file_truename);
4514 #endif
4515 Vdeactivate_mark = old_Vdeactivate_mark;
4517 else
4518 Vdeactivate_mark = Qt;
4520 /* Make the text read part of the buffer. */
4521 GAP_SIZE -= inserted;
4522 GPT += inserted;
4523 GPT_BYTE += inserted;
4524 ZV += inserted;
4525 ZV_BYTE += inserted;
4526 Z += inserted;
4527 Z_BYTE += inserted;
4529 if (GAP_SIZE > 0)
4530 /* Put an anchor to ensure multi-byte form ends at gap. */
4531 *GPT_ADDR = 0;
4533 emacs_close (fd);
4535 /* Discard the unwind protect for closing the file. */
4536 specpdl_ptr--;
4538 if (how_much < 0)
4539 error ("IO error reading %s: %s",
4540 SDATA (orig_filename), emacs_strerror (errno));
4542 notfound:
4544 if (! coding_system_decided)
4546 /* The coding system is not yet decided. Decide it by an
4547 optimized method for handling `coding:' tag.
4549 Note that we can get here only if the buffer was empty
4550 before the insertion. */
4551 Lisp_Object val;
4552 val = Qnil;
4554 if (!NILP (Vcoding_system_for_read))
4555 val = Vcoding_system_for_read;
4556 else
4558 /* Since we are sure that the current buffer was empty
4559 before the insertion, we can toggle
4560 enable-multibyte-characters directly here without taking
4561 care of marker adjustment and byte combining problem. By
4562 this way, we can run Lisp program safely before decoding
4563 the inserted text. */
4564 Lisp_Object unwind_data;
4565 int count = SPECPDL_INDEX ();
4567 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4568 Fcons (current_buffer->undo_list,
4569 Fcurrent_buffer ()));
4570 current_buffer->enable_multibyte_characters = Qnil;
4571 current_buffer->undo_list = Qt;
4572 record_unwind_protect (decide_coding_unwind, unwind_data);
4574 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4576 val = call2 (Vset_auto_coding_function,
4577 filename, make_number (inserted));
4580 if (NILP (val))
4582 /* If the coding system is not yet decided, check
4583 file-coding-system-alist. */
4584 Lisp_Object args[6], coding_systems;
4586 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4587 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4588 coding_systems = Ffind_operation_coding_system (6, args);
4589 if (CONSP (coding_systems))
4590 val = XCAR (coding_systems);
4592 unbind_to (count, Qnil);
4593 inserted = Z_BYTE - BEG_BYTE;
4596 /* The following kludgy code is to avoid some compiler bug.
4597 We can't simply do
4598 setup_coding_system (val, &coding);
4599 on some system. */
4601 struct coding_system temp_coding;
4602 setup_coding_system (Fcheck_coding_system (val), &temp_coding);
4603 bcopy (&temp_coding, &coding, sizeof coding);
4605 /* Ensure we set Vlast_coding_system_used. */
4606 set_coding_system = 1;
4608 if (NILP (current_buffer->enable_multibyte_characters)
4609 && ! NILP (val))
4610 /* We must suppress all character code conversion except for
4611 end-of-line conversion. */
4612 setup_raw_text_coding_system (&coding);
4613 coding.src_multibyte = 0;
4614 coding.dst_multibyte
4615 = !NILP (current_buffer->enable_multibyte_characters);
4618 if (!NILP (visit)
4619 /* Can't do this if part of the buffer might be preserved. */
4620 && NILP (replace)
4621 && (coding.type == coding_type_no_conversion
4622 || coding.type == coding_type_raw_text))
4624 /* Visiting a file with these coding system makes the buffer
4625 unibyte. */
4626 current_buffer->enable_multibyte_characters = Qnil;
4627 coding.dst_multibyte = 0;
4630 if (inserted > 0 || coding.type == coding_type_ccl)
4632 if (CODING_MAY_REQUIRE_DECODING (&coding))
4634 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4635 &coding, 0, 0);
4636 inserted = coding.produced_char;
4638 else
4639 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4640 inserted);
4643 /* Now INSERTED is measured in characters. */
4645 #ifdef DOS_NT
4646 /* Use the conversion type to determine buffer-file-type
4647 (find-buffer-file-type is now used to help determine the
4648 conversion). */
4649 if ((coding.eol_type == CODING_EOL_UNDECIDED
4650 || coding.eol_type == CODING_EOL_LF)
4651 && ! CODING_REQUIRE_DECODING (&coding))
4652 current_buffer->buffer_file_type = Qt;
4653 else
4654 current_buffer->buffer_file_type = Qnil;
4655 #endif
4657 handled:
4659 if (!NILP (visit))
4661 if (!EQ (current_buffer->undo_list, Qt))
4662 current_buffer->undo_list = Qnil;
4663 #ifdef APOLLO
4664 stat (SDATA (filename), &st);
4665 #endif
4667 if (NILP (handler))
4669 current_buffer->modtime = st.st_mtime;
4670 current_buffer->filename = orig_filename;
4673 SAVE_MODIFF = MODIFF;
4674 current_buffer->auto_save_modified = MODIFF;
4675 XSETFASTINT (current_buffer->save_length, Z - BEG);
4676 #ifdef CLASH_DETECTION
4677 if (NILP (handler))
4679 if (!NILP (current_buffer->file_truename))
4680 unlock_file (current_buffer->file_truename);
4681 unlock_file (filename);
4683 #endif /* CLASH_DETECTION */
4684 if (not_regular)
4685 xsignal2 (Qfile_error,
4686 build_string ("not a regular file"), orig_filename);
4689 if (set_coding_system)
4690 Vlast_coding_system_used = coding.symbol;
4692 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4694 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4695 visit);
4696 if (! NILP (insval))
4698 CHECK_NUMBER (insval);
4699 inserted = XFASTINT (insval);
4703 /* Decode file format */
4704 if (inserted > 0)
4706 /* Don't run point motion or modification hooks when decoding. */
4707 int count = SPECPDL_INDEX ();
4708 specbind (Qinhibit_point_motion_hooks, Qt);
4709 specbind (Qinhibit_modification_hooks, Qt);
4711 /* Save old undo list and don't record undo for decoding. */
4712 old_undo = current_buffer->undo_list;
4713 current_buffer->undo_list = Qt;
4715 if (NILP (replace))
4717 insval = call3 (Qformat_decode,
4718 Qnil, make_number (inserted), visit);
4719 CHECK_NUMBER (insval);
4720 inserted = XFASTINT (insval);
4722 else
4724 /* If REPLACE is non-nil and we succeeded in not replacing the
4725 beginning or end of the buffer text with the file's contents,
4726 call format-decode with `point' positioned at the beginning of
4727 the buffer and `inserted' equalling the number of characters
4728 in the buffer. Otherwise, format-decode might fail to
4729 correctly analyze the beginning or end of the buffer. Hence
4730 we temporarily save `point' and `inserted' here and restore
4731 `point' iff format-decode did not insert or delete any text.
4732 Otherwise we leave `point' at point-min. */
4733 int opoint = PT;
4734 int opoint_byte = PT_BYTE;
4735 int oinserted = ZV - BEGV;
4736 int ochars_modiff = CHARS_MODIFF;
4738 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4739 insval = call3 (Qformat_decode,
4740 Qnil, make_number (oinserted), visit);
4741 CHECK_NUMBER (insval);
4742 if (ochars_modiff == CHARS_MODIFF)
4743 /* format_decode didn't modify buffer's characters => move
4744 point back to position before inserted text and leave
4745 value of inserted alone. */
4746 SET_PT_BOTH (opoint, opoint_byte);
4747 else
4748 /* format_decode modified buffer's characters => consider
4749 entire buffer changed and leave point at point-min. */
4750 inserted = XFASTINT (insval);
4753 /* For consistency with format-decode call these now iff inserted > 0
4754 (martin 2007-06-28) */
4755 p = Vafter_insert_file_functions;
4756 while (CONSP (p))
4758 if (NILP (replace))
4760 insval = call1 (XCAR (p), make_number (inserted));
4761 if (!NILP (insval))
4763 CHECK_NUMBER (insval);
4764 inserted = XFASTINT (insval);
4767 else
4769 /* For the rationale of this see the comment on format-decode above. */
4770 int opoint = PT;
4771 int opoint_byte = PT_BYTE;
4772 int oinserted = ZV - BEGV;
4773 int ochars_modiff = CHARS_MODIFF;
4775 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4776 insval = call1 (XCAR (p), make_number (oinserted));
4777 if (!NILP (insval))
4779 CHECK_NUMBER (insval);
4780 if (ochars_modiff == CHARS_MODIFF)
4781 /* after_insert_file_functions didn't modify
4782 buffer's characters => move point back to
4783 position before inserted text and leave value of
4784 inserted alone. */
4785 SET_PT_BOTH (opoint, opoint_byte);
4786 else
4787 /* after_insert_file_functions did modify buffer's
4788 characters => consider entire buffer changed and
4789 leave point at point-min. */
4790 inserted = XFASTINT (insval);
4794 QUIT;
4795 p = XCDR (p);
4798 if (NILP (visit))
4800 Lisp_Object lbeg, lend;
4801 XSETINT (lbeg, PT);
4802 XSETINT (lend, PT + inserted);
4803 if (CONSP (old_undo))
4805 Lisp_Object tem = XCAR (old_undo);
4806 if (CONSP (tem) && INTEGERP (XCAR (tem)) &&
4807 INTEGERP (XCDR (tem)) && EQ (XCAR (tem), lbeg))
4808 /* In the non-visiting case record only the final insertion. */
4809 current_buffer->undo_list =
4810 Fcons (Fcons (lbeg, lend), Fcdr (old_undo));
4813 else
4814 /* If undo_list was Qt before, keep it that way.
4815 Otherwise start with an empty undo_list. */
4816 current_buffer->undo_list = EQ (old_undo, Qt) ? Qt : Qnil;
4818 unbind_to (count, Qnil);
4821 /* Call after-change hooks for the inserted text, aside from the case
4822 of normal visiting (not with REPLACE), which is done in a new buffer
4823 "before" the buffer is changed. */
4824 if (inserted > 0 && total > 0
4825 && (NILP (visit) || !NILP (replace)))
4827 signal_after_change (PT, 0, inserted);
4828 update_compositions (PT, PT, CHECK_BORDER);
4831 if (!NILP (visit)
4832 && current_buffer->modtime == -1)
4834 /* If visiting nonexistent file, return nil. */
4835 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4838 if (read_quit)
4839 Fsignal (Qquit, Qnil);
4841 /* ??? Retval needs to be dealt with in all cases consistently. */
4842 if (NILP (val))
4843 val = Fcons (orig_filename,
4844 Fcons (make_number (inserted),
4845 Qnil));
4847 RETURN_UNGCPRO (unbind_to (count, val));
4850 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4851 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4852 Lisp_Object, Lisp_Object));
4854 /* If build_annotations switched buffers, switch back to BUF.
4855 Kill the temporary buffer that was selected in the meantime.
4857 Since this kill only the last temporary buffer, some buffers remain
4858 not killed if build_annotations switched buffers more than once.
4859 -- K.Handa */
4861 static Lisp_Object
4862 build_annotations_unwind (buf)
4863 Lisp_Object buf;
4865 Lisp_Object tembuf;
4867 if (XBUFFER (buf) == current_buffer)
4868 return Qnil;
4869 tembuf = Fcurrent_buffer ();
4870 Fset_buffer (buf);
4871 Fkill_buffer (tembuf);
4872 return Qnil;
4875 /* Decide the coding-system to encode the data with. */
4877 void
4878 choose_write_coding_system (start, end, filename,
4879 append, visit, lockname, coding)
4880 Lisp_Object start, end, filename, append, visit, lockname;
4881 struct coding_system *coding;
4883 Lisp_Object val;
4885 if (auto_saving
4886 && NILP (Fstring_equal (current_buffer->filename,
4887 current_buffer->auto_save_file_name)))
4889 /* We use emacs-mule for auto saving... */
4890 setup_coding_system (Qemacs_mule, coding);
4891 /* ... but with the special flag to indicate not to strip off
4892 leading code of eight-bit-control chars. */
4893 coding->flags = 1;
4894 /* We force LF for end-of-line because that is faster. */
4895 coding->eol_type = CODING_EOL_LF;
4896 goto done_setup_coding;
4898 else if (!NILP (Vcoding_system_for_write))
4900 val = Vcoding_system_for_write;
4901 if (coding_system_require_warning
4902 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4903 /* Confirm that VAL can surely encode the current region. */
4904 val = call5 (Vselect_safe_coding_system_function,
4905 start, end, Fcons (Qt, Fcons (val, Qnil)),
4906 Qnil, filename);
4908 else
4910 /* If the variable `buffer-file-coding-system' is set locally,
4911 it means that the file was read with some kind of code
4912 conversion or the variable is explicitly set by users. We
4913 had better write it out with the same coding system even if
4914 `enable-multibyte-characters' is nil.
4916 If it is not set locally, we anyway have to convert EOL
4917 format if the default value of `buffer-file-coding-system'
4918 tells that it is not Unix-like (LF only) format. */
4919 int using_default_coding = 0;
4920 int force_raw_text = 0;
4922 val = current_buffer->buffer_file_coding_system;
4923 if (NILP (val)
4924 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4926 val = Qnil;
4927 if (NILP (current_buffer->enable_multibyte_characters))
4928 force_raw_text = 1;
4931 if (NILP (val))
4933 /* Check file-coding-system-alist. */
4934 Lisp_Object args[7], coding_systems;
4936 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4937 args[3] = filename; args[4] = append; args[5] = visit;
4938 args[6] = lockname;
4939 coding_systems = Ffind_operation_coding_system (7, args);
4940 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4941 val = XCDR (coding_systems);
4944 if (NILP (val)
4945 && !NILP (current_buffer->buffer_file_coding_system))
4947 /* If we still have not decided a coding system, use the
4948 default value of buffer-file-coding-system. */
4949 val = current_buffer->buffer_file_coding_system;
4950 using_default_coding = 1;
4953 if (!force_raw_text
4954 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4955 /* Confirm that VAL can surely encode the current region. */
4956 val = call5 (Vselect_safe_coding_system_function,
4957 start, end, val, Qnil, filename);
4959 setup_coding_system (Fcheck_coding_system (val), coding);
4960 if (coding->eol_type == CODING_EOL_UNDECIDED
4961 && !using_default_coding)
4963 if (! EQ (default_buffer_file_coding.symbol,
4964 buffer_defaults.buffer_file_coding_system))
4965 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4966 &default_buffer_file_coding);
4967 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4969 Lisp_Object subsidiaries;
4971 coding->eol_type = default_buffer_file_coding.eol_type;
4972 subsidiaries = Fget (coding->symbol, Qeol_type);
4973 if (VECTORP (subsidiaries)
4974 && XVECTOR (subsidiaries)->size == 3)
4975 coding->symbol
4976 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4980 if (force_raw_text)
4981 setup_raw_text_coding_system (coding);
4982 goto done_setup_coding;
4985 setup_coding_system (Fcheck_coding_system (val), coding);
4987 done_setup_coding:
4988 if (coding->eol_type == CODING_EOL_UNDECIDED)
4989 coding->eol_type = system_eol_type;
4990 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4991 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4994 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4995 "r\nFWrite region to file: \ni\ni\ni\np",
4996 doc: /* Write current region into specified file.
4997 When called from a program, requires three arguments:
4998 START, END and FILENAME. START and END are normally buffer positions
4999 specifying the part of the buffer to write.
5000 If START is nil, that means to use the entire buffer contents.
5001 If START is a string, then output that string to the file
5002 instead of any buffer contents; END is ignored.
5004 Optional fourth argument APPEND if non-nil means
5005 append to existing file contents (if any). If it is an integer,
5006 seek to that offset in the file before writing.
5007 Optional fifth argument VISIT, if t or a string, means
5008 set the last-save-file-modtime of buffer to this file's modtime
5009 and mark buffer not modified.
5010 If VISIT is a string, it is a second file name;
5011 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
5012 VISIT is also the file name to lock and unlock for clash detection.
5013 If VISIT is neither t nor nil nor a string,
5014 that means do not display the \"Wrote file\" message.
5015 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
5016 use for locking and unlocking, overriding FILENAME and VISIT.
5017 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
5018 for an existing file with the same name. If MUSTBENEW is `excl',
5019 that means to get an error if the file already exists; never overwrite.
5020 If MUSTBENEW is neither nil nor `excl', that means ask for
5021 confirmation before overwriting, but do go ahead and overwrite the file
5022 if the user confirms.
5024 This does code conversion according to the value of
5025 `coding-system-for-write', `buffer-file-coding-system', or
5026 `file-coding-system-alist', and sets the variable
5027 `last-coding-system-used' to the coding system actually used. */)
5028 (start, end, filename, append, visit, lockname, mustbenew)
5029 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
5031 register int desc;
5032 int failure;
5033 int save_errno = 0;
5034 const unsigned char *fn;
5035 struct stat st;
5036 int tem;
5037 int count = SPECPDL_INDEX ();
5038 int count1;
5039 #ifdef VMS
5040 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
5041 #endif /* VMS */
5042 Lisp_Object handler;
5043 Lisp_Object visit_file;
5044 Lisp_Object annotations;
5045 Lisp_Object encoded_filename;
5046 int visiting = (EQ (visit, Qt) || STRINGP (visit));
5047 int quietly = !NILP (visit);
5048 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5049 struct buffer *given_buffer;
5050 #ifdef DOS_NT
5051 int buffer_file_type = O_BINARY;
5052 #endif /* DOS_NT */
5053 struct coding_system coding;
5055 if (current_buffer->base_buffer && visiting)
5056 error ("Cannot do file visiting in an indirect buffer");
5058 if (!NILP (start) && !STRINGP (start))
5059 validate_region (&start, &end);
5061 visit_file = Qnil;
5062 GCPRO5 (start, filename, visit, visit_file, lockname);
5064 filename = Fexpand_file_name (filename, Qnil);
5066 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
5067 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
5069 if (STRINGP (visit))
5070 visit_file = Fexpand_file_name (visit, Qnil);
5071 else
5072 visit_file = filename;
5074 if (NILP (lockname))
5075 lockname = visit_file;
5077 annotations = Qnil;
5079 /* If the file name has special constructs in it,
5080 call the corresponding file handler. */
5081 handler = Ffind_file_name_handler (filename, Qwrite_region);
5082 /* If FILENAME has no handler, see if VISIT has one. */
5083 if (NILP (handler) && STRINGP (visit))
5084 handler = Ffind_file_name_handler (visit, Qwrite_region);
5086 if (!NILP (handler))
5088 Lisp_Object val;
5089 val = call6 (handler, Qwrite_region, start, end,
5090 filename, append, visit);
5092 if (visiting)
5094 SAVE_MODIFF = MODIFF;
5095 XSETFASTINT (current_buffer->save_length, Z - BEG);
5096 current_buffer->filename = visit_file;
5098 UNGCPRO;
5099 return val;
5102 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5104 /* Special kludge to simplify auto-saving. */
5105 if (NILP (start))
5107 XSETFASTINT (start, BEG);
5108 XSETFASTINT (end, Z);
5109 Fwiden ();
5112 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5113 count1 = SPECPDL_INDEX ();
5115 given_buffer = current_buffer;
5117 if (!STRINGP (start))
5119 annotations = build_annotations (start, end);
5121 if (current_buffer != given_buffer)
5123 XSETFASTINT (start, BEGV);
5124 XSETFASTINT (end, ZV);
5128 UNGCPRO;
5130 GCPRO5 (start, filename, annotations, visit_file, lockname);
5132 /* Decide the coding-system to encode the data with.
5133 We used to make this choice before calling build_annotations, but that
5134 leads to problems when a write-annotate-function takes care of
5135 unsavable chars (as was the case with X-Symbol). */
5136 choose_write_coding_system (start, end, filename,
5137 append, visit, lockname, &coding);
5138 Vlast_coding_system_used = coding.symbol;
5140 given_buffer = current_buffer;
5141 if (! STRINGP (start))
5143 annotations = build_annotations_2 (start, end,
5144 coding.pre_write_conversion, annotations);
5145 if (current_buffer != given_buffer)
5147 XSETFASTINT (start, BEGV);
5148 XSETFASTINT (end, ZV);
5152 #ifdef CLASH_DETECTION
5153 if (!auto_saving)
5155 #if 0 /* This causes trouble for GNUS. */
5156 /* If we've locked this file for some other buffer,
5157 query before proceeding. */
5158 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5159 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5160 #endif
5162 lock_file (lockname);
5164 #endif /* CLASH_DETECTION */
5166 encoded_filename = ENCODE_FILE (filename);
5168 fn = SDATA (encoded_filename);
5169 desc = -1;
5170 if (!NILP (append))
5171 #ifdef DOS_NT
5172 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5173 #else /* not DOS_NT */
5174 desc = emacs_open (fn, O_WRONLY, 0);
5175 #endif /* not DOS_NT */
5177 if (desc < 0 && (NILP (append) || errno == ENOENT))
5178 #ifdef VMS
5179 if (auto_saving) /* Overwrite any previous version of autosave file */
5181 vms_truncate (fn); /* if fn exists, truncate to zero length */
5182 desc = emacs_open (fn, O_RDWR, 0);
5183 if (desc < 0)
5184 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5185 ? SDATA (current_buffer->filename) : 0,
5186 fn);
5188 else /* Write to temporary name and rename if no errors */
5190 Lisp_Object temp_name;
5191 temp_name = Ffile_name_directory (filename);
5193 if (!NILP (temp_name))
5195 temp_name = Fmake_temp_name (concat2 (temp_name,
5196 build_string ("$$SAVE$$")));
5197 fname = SDATA (filename);
5198 fn = SDATA (temp_name);
5199 desc = creat_copy_attrs (fname, fn);
5200 if (desc < 0)
5202 /* If we can't open the temporary file, try creating a new
5203 version of the original file. VMS "creat" creates a
5204 new version rather than truncating an existing file. */
5205 fn = fname;
5206 fname = 0;
5207 desc = creat (fn, 0666);
5208 #if 0 /* This can clobber an existing file and fail to replace it,
5209 if the user runs out of space. */
5210 if (desc < 0)
5212 /* We can't make a new version;
5213 try to truncate and rewrite existing version if any. */
5214 vms_truncate (fn);
5215 desc = emacs_open (fn, O_RDWR, 0);
5217 #endif
5220 else
5221 desc = creat (fn, 0666);
5223 #else /* not VMS */
5224 #ifdef DOS_NT
5225 desc = emacs_open (fn,
5226 O_WRONLY | O_CREAT | buffer_file_type
5227 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5228 S_IREAD | S_IWRITE);
5229 #else /* not DOS_NT */
5230 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5231 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5232 auto_saving ? auto_save_mode_bits : 0666);
5233 #endif /* not DOS_NT */
5234 #endif /* not VMS */
5236 if (desc < 0)
5238 #ifdef CLASH_DETECTION
5239 save_errno = errno;
5240 if (!auto_saving) unlock_file (lockname);
5241 errno = save_errno;
5242 #endif /* CLASH_DETECTION */
5243 UNGCPRO;
5244 report_file_error ("Opening output file", Fcons (filename, Qnil));
5247 record_unwind_protect (close_file_unwind, make_number (desc));
5249 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5251 long ret;
5253 if (NUMBERP (append))
5254 ret = lseek (desc, XINT (append), 1);
5255 else
5256 ret = lseek (desc, 0, 2);
5257 if (ret < 0)
5259 #ifdef CLASH_DETECTION
5260 if (!auto_saving) unlock_file (lockname);
5261 #endif /* CLASH_DETECTION */
5262 UNGCPRO;
5263 report_file_error ("Lseek error", Fcons (filename, Qnil));
5267 UNGCPRO;
5269 #ifdef VMS
5271 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5272 * if we do writes that don't end with a carriage return. Furthermore
5273 * it cannot handle writes of more then 16K. The modified
5274 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5275 * this EXCEPT for the last record (if it doesn't end with a carriage
5276 * return). This implies that if your buffer doesn't end with a carriage
5277 * return, you get one free... tough. However it also means that if
5278 * we make two calls to sys_write (a la the following code) you can
5279 * get one at the gap as well. The easiest way to fix this (honest)
5280 * is to move the gap to the next newline (or the end of the buffer).
5281 * Thus this change.
5283 * Yech!
5285 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5286 move_gap (find_next_newline (GPT, 1));
5287 #else
5288 /* Whether VMS or not, we must move the gap to the next of newline
5289 when we must put designation sequences at beginning of line. */
5290 if (INTEGERP (start)
5291 && coding.type == coding_type_iso2022
5292 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5293 && GPT > BEG && GPT_ADDR[-1] != '\n')
5295 int opoint = PT, opoint_byte = PT_BYTE;
5296 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5297 move_gap_both (PT, PT_BYTE);
5298 SET_PT_BOTH (opoint, opoint_byte);
5300 #endif
5302 failure = 0;
5303 immediate_quit = 1;
5305 if (STRINGP (start))
5307 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5308 &annotations, &coding);
5309 save_errno = errno;
5311 else if (XINT (start) != XINT (end))
5313 tem = CHAR_TO_BYTE (XINT (start));
5315 if (XINT (start) < GPT)
5317 failure = 0 > a_write (desc, Qnil, XINT (start),
5318 min (GPT, XINT (end)) - XINT (start),
5319 &annotations, &coding);
5320 save_errno = errno;
5323 if (XINT (end) > GPT && !failure)
5325 tem = max (XINT (start), GPT);
5326 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5327 &annotations, &coding);
5328 save_errno = errno;
5331 else
5333 /* If file was empty, still need to write the annotations */
5334 coding.mode |= CODING_MODE_LAST_BLOCK;
5335 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5336 save_errno = errno;
5339 if (CODING_REQUIRE_FLUSHING (&coding)
5340 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5341 && ! failure)
5343 /* We have to flush out a data. */
5344 coding.mode |= CODING_MODE_LAST_BLOCK;
5345 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5346 save_errno = errno;
5349 immediate_quit = 0;
5351 #ifdef HAVE_FSYNC
5352 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5353 Disk full in NFS may be reported here. */
5354 /* mib says that closing the file will try to write as fast as NFS can do
5355 it, and that means the fsync here is not crucial for autosave files. */
5356 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
5358 /* If fsync fails with EINTR, don't treat that as serious. */
5359 if (errno != EINTR)
5360 failure = 1, save_errno = errno;
5362 #endif
5364 /* Spurious "file has changed on disk" warnings have been
5365 observed on Suns as well.
5366 It seems that `close' can change the modtime, under nfs.
5368 (This has supposedly been fixed in Sunos 4,
5369 but who knows about all the other machines with NFS?) */
5370 #if 0
5372 /* On VMS and APOLLO, must do the stat after the close
5373 since closing changes the modtime. */
5374 #ifndef VMS
5375 #ifndef APOLLO
5376 /* Recall that #if defined does not work on VMS. */
5377 #define FOO
5378 fstat (desc, &st);
5379 #endif
5380 #endif
5381 #endif
5383 /* NFS can report a write failure now. */
5384 if (emacs_close (desc) < 0)
5385 failure = 1, save_errno = errno;
5387 #ifdef VMS
5388 /* If we wrote to a temporary name and had no errors, rename to real name. */
5389 if (fname)
5391 if (!failure)
5392 failure = (rename (fn, fname) != 0), save_errno = errno;
5393 fn = fname;
5395 #endif /* VMS */
5397 #ifndef FOO
5398 stat (fn, &st);
5399 #endif
5400 /* Discard the unwind protect for close_file_unwind. */
5401 specpdl_ptr = specpdl + count1;
5402 /* Restore the original current buffer. */
5403 visit_file = unbind_to (count, visit_file);
5405 #ifdef CLASH_DETECTION
5406 if (!auto_saving)
5407 unlock_file (lockname);
5408 #endif /* CLASH_DETECTION */
5410 /* Do this before reporting IO error
5411 to avoid a "file has changed on disk" warning on
5412 next attempt to save. */
5413 if (visiting)
5414 current_buffer->modtime = st.st_mtime;
5416 if (failure)
5417 error ("IO error writing %s: %s", SDATA (filename),
5418 emacs_strerror (save_errno));
5420 if (visiting)
5422 SAVE_MODIFF = MODIFF;
5423 XSETFASTINT (current_buffer->save_length, Z - BEG);
5424 current_buffer->filename = visit_file;
5425 update_mode_lines++;
5427 else if (quietly)
5429 if (auto_saving
5430 && ! NILP (Fstring_equal (current_buffer->filename,
5431 current_buffer->auto_save_file_name)))
5432 SAVE_MODIFF = MODIFF;
5434 return Qnil;
5437 if (!auto_saving)
5438 message_with_string ((INTEGERP (append)
5439 ? "Updated %s"
5440 : ! NILP (append)
5441 ? "Added to %s"
5442 : "Wrote %s"),
5443 visit_file, 1);
5445 return Qnil;
5448 Lisp_Object merge ();
5450 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5451 doc: /* Return t if (car A) is numerically less than (car B). */)
5452 (a, b)
5453 Lisp_Object a, b;
5455 return Flss (Fcar (a), Fcar (b));
5458 /* Build the complete list of annotations appropriate for writing out
5459 the text between START and END, by calling all the functions in
5460 write-region-annotate-functions and merging the lists they return.
5461 If one of these functions switches to a different buffer, we assume
5462 that buffer contains altered text. Therefore, the caller must
5463 make sure to restore the current buffer in all cases,
5464 as save-excursion would do. */
5466 static Lisp_Object
5467 build_annotations (start, end)
5468 Lisp_Object start, end;
5470 Lisp_Object annotations;
5471 Lisp_Object p, res;
5472 struct gcpro gcpro1, gcpro2;
5473 Lisp_Object original_buffer;
5474 int i, used_global = 0;
5476 XSETBUFFER (original_buffer, current_buffer);
5478 annotations = Qnil;
5479 p = Vwrite_region_annotate_functions;
5480 GCPRO2 (annotations, p);
5481 while (CONSP (p))
5483 struct buffer *given_buffer = current_buffer;
5484 if (EQ (Qt, XCAR (p)) && !used_global)
5485 { /* Use the global value of the hook. */
5486 Lisp_Object arg[2];
5487 used_global = 1;
5488 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5489 arg[1] = XCDR (p);
5490 p = Fappend (2, arg);
5491 continue;
5493 Vwrite_region_annotations_so_far = annotations;
5494 res = call2 (XCAR (p), start, end);
5495 /* If the function makes a different buffer current,
5496 assume that means this buffer contains altered text to be output.
5497 Reset START and END from the buffer bounds
5498 and discard all previous annotations because they should have
5499 been dealt with by this function. */
5500 if (current_buffer != given_buffer)
5502 XSETFASTINT (start, BEGV);
5503 XSETFASTINT (end, ZV);
5504 annotations = Qnil;
5506 Flength (res); /* Check basic validity of return value */
5507 annotations = merge (annotations, res, Qcar_less_than_car);
5508 p = XCDR (p);
5511 /* Now do the same for annotation functions implied by the file-format */
5512 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5513 p = current_buffer->auto_save_file_format;
5514 else
5515 p = current_buffer->file_format;
5516 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5518 struct buffer *given_buffer = current_buffer;
5520 Vwrite_region_annotations_so_far = annotations;
5522 /* Value is either a list of annotations or nil if the function
5523 has written annotations to a temporary buffer, which is now
5524 current. */
5525 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5526 original_buffer, make_number (i));
5527 if (current_buffer != given_buffer)
5529 XSETFASTINT (start, BEGV);
5530 XSETFASTINT (end, ZV);
5531 annotations = Qnil;
5534 if (CONSP (res))
5535 annotations = merge (annotations, res, Qcar_less_than_car);
5538 UNGCPRO;
5539 return annotations;
5542 static Lisp_Object
5543 build_annotations_2 (start, end, pre_write_conversion, annotations)
5544 Lisp_Object start, end, pre_write_conversion, annotations;
5546 struct gcpro gcpro1;
5547 Lisp_Object res;
5549 GCPRO1 (annotations);
5550 /* At last, do the same for the function PRE_WRITE_CONVERSION
5551 implied by the current coding-system. */
5552 if (!NILP (pre_write_conversion))
5554 struct buffer *given_buffer = current_buffer;
5555 Vwrite_region_annotations_so_far = annotations;
5556 res = call2 (pre_write_conversion, start, end);
5557 Flength (res);
5558 annotations = (current_buffer != given_buffer
5559 ? res
5560 : merge (annotations, res, Qcar_less_than_car));
5563 UNGCPRO;
5564 return annotations;
5567 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5568 If STRING is nil, POS is the character position in the current buffer.
5569 Intersperse with them the annotations from *ANNOT
5570 which fall within the range of POS to POS + NCHARS,
5571 each at its appropriate position.
5573 We modify *ANNOT by discarding elements as we use them up.
5575 The return value is negative in case of system call failure. */
5577 static int
5578 a_write (desc, string, pos, nchars, annot, coding)
5579 int desc;
5580 Lisp_Object string;
5581 register int nchars;
5582 int pos;
5583 Lisp_Object *annot;
5584 struct coding_system *coding;
5586 Lisp_Object tem;
5587 int nextpos;
5588 int lastpos = pos + nchars;
5590 while (NILP (*annot) || CONSP (*annot))
5592 tem = Fcar_safe (Fcar (*annot));
5593 nextpos = pos - 1;
5594 if (INTEGERP (tem))
5595 nextpos = XFASTINT (tem);
5597 /* If there are no more annotations in this range,
5598 output the rest of the range all at once. */
5599 if (! (nextpos >= pos && nextpos <= lastpos))
5600 return e_write (desc, string, pos, lastpos, coding);
5602 /* Output buffer text up to the next annotation's position. */
5603 if (nextpos > pos)
5605 if (0 > e_write (desc, string, pos, nextpos, coding))
5606 return -1;
5607 pos = nextpos;
5609 /* Output the annotation. */
5610 tem = Fcdr (Fcar (*annot));
5611 if (STRINGP (tem))
5613 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5614 return -1;
5616 *annot = Fcdr (*annot);
5618 return 0;
5621 #ifndef WRITE_BUF_SIZE
5622 #define WRITE_BUF_SIZE (16 * 1024)
5623 #endif
5625 /* Write text in the range START and END into descriptor DESC,
5626 encoding them with coding system CODING. If STRING is nil, START
5627 and END are character positions of the current buffer, else they
5628 are indexes to the string STRING. */
5630 static int
5631 e_write (desc, string, start, end, coding)
5632 int desc;
5633 Lisp_Object string;
5634 int start, end;
5635 struct coding_system *coding;
5637 register char *addr;
5638 register int nbytes;
5639 char buf[WRITE_BUF_SIZE];
5640 int return_val = 0;
5642 if (start >= end)
5643 coding->composing = COMPOSITION_DISABLED;
5644 if (coding->composing != COMPOSITION_DISABLED)
5645 coding_save_composition (coding, start, end, string);
5647 if (STRINGP (string))
5649 addr = SDATA (string);
5650 nbytes = SBYTES (string);
5651 coding->src_multibyte = STRING_MULTIBYTE (string);
5653 else if (start < end)
5655 /* It is assured that the gap is not in the range START and END-1. */
5656 addr = CHAR_POS_ADDR (start);
5657 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5658 coding->src_multibyte
5659 = !NILP (current_buffer->enable_multibyte_characters);
5661 else
5663 addr = "";
5664 nbytes = 0;
5665 coding->src_multibyte = 1;
5668 /* We used to have a code for handling selective display here. But,
5669 now it is handled within encode_coding. */
5670 while (1)
5672 int result;
5674 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5675 if (coding->produced > 0)
5677 coding->produced -= emacs_write (desc, buf, coding->produced);
5678 if (coding->produced)
5680 return_val = -1;
5681 break;
5684 nbytes -= coding->consumed;
5685 addr += coding->consumed;
5686 if (result == CODING_FINISH_INSUFFICIENT_SRC
5687 && nbytes > 0)
5689 /* The source text ends by an incomplete multibyte form.
5690 There's no way other than write it out as is. */
5691 nbytes -= emacs_write (desc, addr, nbytes);
5692 if (nbytes)
5694 return_val = -1;
5695 break;
5698 if (nbytes <= 0)
5699 break;
5700 start += coding->consumed_char;
5701 if (coding->cmp_data)
5702 coding_adjust_composition_offset (coding, start);
5705 if (coding->cmp_data)
5706 coding_free_composition_data (coding);
5708 return return_val;
5711 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5712 Sverify_visited_file_modtime, 1, 1, 0,
5713 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5714 This means that the file has not been changed since it was visited or saved.
5715 See Info node `(elisp)Modification Time' for more details. */)
5716 (buf)
5717 Lisp_Object buf;
5719 struct buffer *b;
5720 struct stat st;
5721 Lisp_Object handler;
5722 Lisp_Object filename;
5724 CHECK_BUFFER (buf);
5725 b = XBUFFER (buf);
5727 if (!STRINGP (b->filename)) return Qt;
5728 if (b->modtime == 0) return Qt;
5730 /* If the file name has special constructs in it,
5731 call the corresponding file handler. */
5732 handler = Ffind_file_name_handler (b->filename,
5733 Qverify_visited_file_modtime);
5734 if (!NILP (handler))
5735 return call2 (handler, Qverify_visited_file_modtime, buf);
5737 filename = ENCODE_FILE (b->filename);
5739 if (stat (SDATA (filename), &st) < 0)
5741 /* If the file doesn't exist now and didn't exist before,
5742 we say that it isn't modified, provided the error is a tame one. */
5743 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5744 st.st_mtime = -1;
5745 else
5746 st.st_mtime = 0;
5748 if (st.st_mtime == b->modtime
5749 /* If both are positive, accept them if they are off by one second. */
5750 || (st.st_mtime > 0 && b->modtime > 0
5751 && (st.st_mtime == b->modtime + 1
5752 || st.st_mtime == b->modtime - 1)))
5753 return Qt;
5754 return Qnil;
5757 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5758 Sclear_visited_file_modtime, 0, 0, 0,
5759 doc: /* Clear out records of last mod time of visited file.
5760 Next attempt to save will certainly not complain of a discrepancy. */)
5763 current_buffer->modtime = 0;
5764 return Qnil;
5767 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5768 Svisited_file_modtime, 0, 0, 0,
5769 doc: /* Return the current buffer's recorded visited file modification time.
5770 The value is a list of the form (HIGH LOW), like the time values
5771 that `file-attributes' returns. If the current buffer has no recorded
5772 file modification time, this function returns 0.
5773 See Info node `(elisp)Modification Time' for more details. */)
5776 if (! current_buffer->modtime)
5777 return make_number (0);
5778 return make_time ((time_t) current_buffer->modtime);
5781 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5782 Sset_visited_file_modtime, 0, 1, 0,
5783 doc: /* Update buffer's recorded modification time from the visited file's time.
5784 Useful if the buffer was not read from the file normally
5785 or if the file itself has been changed for some known benign reason.
5786 An argument specifies the modification time value to use
5787 \(instead of that of the visited file), in the form of a list
5788 \(HIGH . LOW) or (HIGH LOW). */)
5789 (time_list)
5790 Lisp_Object time_list;
5792 if (!NILP (time_list))
5793 current_buffer->modtime = cons_to_long (time_list);
5794 else
5796 register Lisp_Object filename;
5797 struct stat st;
5798 Lisp_Object handler;
5800 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5802 /* If the file name has special constructs in it,
5803 call the corresponding file handler. */
5804 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5805 if (!NILP (handler))
5806 /* The handler can find the file name the same way we did. */
5807 return call2 (handler, Qset_visited_file_modtime, Qnil);
5809 filename = ENCODE_FILE (filename);
5811 if (stat (SDATA (filename), &st) >= 0)
5812 current_buffer->modtime = st.st_mtime;
5815 return Qnil;
5818 Lisp_Object
5819 auto_save_error (error)
5820 Lisp_Object error;
5822 Lisp_Object args[3], msg;
5823 int i, nbytes;
5824 struct gcpro gcpro1;
5825 char *msgbuf;
5826 USE_SAFE_ALLOCA;
5828 ring_bell ();
5830 args[0] = build_string ("Auto-saving %s: %s");
5831 args[1] = current_buffer->name;
5832 args[2] = Ferror_message_string (error);
5833 msg = Fformat (3, args);
5834 GCPRO1 (msg);
5835 nbytes = SBYTES (msg);
5836 SAFE_ALLOCA (msgbuf, char *, nbytes);
5837 bcopy (SDATA (msg), msgbuf, nbytes);
5839 for (i = 0; i < 3; ++i)
5841 if (i == 0)
5842 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5843 else
5844 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5845 Fsleep_for (make_number (1), Qnil);
5848 SAFE_FREE ();
5849 UNGCPRO;
5850 return Qnil;
5853 Lisp_Object
5854 auto_save_1 ()
5856 struct stat st;
5857 Lisp_Object modes;
5859 auto_save_mode_bits = 0666;
5861 /* Get visited file's mode to become the auto save file's mode. */
5862 if (! NILP (current_buffer->filename))
5864 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5865 /* But make sure we can overwrite it later! */
5866 auto_save_mode_bits = st.st_mode | 0600;
5867 else if ((modes = Ffile_modes (current_buffer->filename),
5868 INTEGERP (modes)))
5869 /* Remote files don't cooperate with stat. */
5870 auto_save_mode_bits = XINT (modes) | 0600;
5873 return
5874 Fwrite_region (Qnil, Qnil,
5875 current_buffer->auto_save_file_name,
5876 Qnil, Qlambda, Qnil, Qnil);
5879 static Lisp_Object
5880 do_auto_save_unwind (arg) /* used as unwind-protect function */
5881 Lisp_Object arg;
5883 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5884 auto_saving = 0;
5885 if (stream != NULL)
5887 BLOCK_INPUT;
5888 fclose (stream);
5889 UNBLOCK_INPUT;
5891 return Qnil;
5894 static Lisp_Object
5895 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5896 Lisp_Object value;
5898 minibuffer_auto_raise = XINT (value);
5899 return Qnil;
5902 static Lisp_Object
5903 do_auto_save_make_dir (dir)
5904 Lisp_Object dir;
5906 Lisp_Object mode;
5908 call2 (Qmake_directory, dir, Qt);
5909 XSETFASTINT (mode, 0700);
5910 return Fset_file_modes (dir, mode);
5913 static Lisp_Object
5914 do_auto_save_eh (ignore)
5915 Lisp_Object ignore;
5917 return Qnil;
5920 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5921 doc: /* Auto-save all buffers that need it.
5922 This is all buffers that have auto-saving enabled
5923 and are changed since last auto-saved.
5924 Auto-saving writes the buffer into a file
5925 so that your editing is not lost if the system crashes.
5926 This file is not the file you visited; that changes only when you save.
5927 Normally we run the normal hook `auto-save-hook' before saving.
5929 A non-nil NO-MESSAGE argument means do not print any message if successful.
5930 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5931 (no_message, current_only)
5932 Lisp_Object no_message, current_only;
5934 struct buffer *old = current_buffer, *b;
5935 Lisp_Object tail, buf;
5936 int auto_saved = 0;
5937 int do_handled_files;
5938 Lisp_Object oquit;
5939 FILE *stream = NULL;
5940 int count = SPECPDL_INDEX ();
5941 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5942 int old_message_p = 0;
5943 struct gcpro gcpro1, gcpro2;
5945 if (max_specpdl_size < specpdl_size + 40)
5946 max_specpdl_size = specpdl_size + 40;
5948 if (minibuf_level)
5949 no_message = Qt;
5951 if (NILP (no_message))
5953 old_message_p = push_message ();
5954 record_unwind_protect (pop_message_unwind, Qnil);
5957 /* Ordinarily don't quit within this function,
5958 but don't make it impossible to quit (in case we get hung in I/O). */
5959 oquit = Vquit_flag;
5960 Vquit_flag = Qnil;
5962 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5963 point to non-strings reached from Vbuffer_alist. */
5965 if (!NILP (Vrun_hooks))
5966 call1 (Vrun_hooks, intern ("auto-save-hook"));
5968 if (STRINGP (Vauto_save_list_file_name))
5970 Lisp_Object listfile;
5972 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5974 /* Don't try to create the directory when shutting down Emacs,
5975 because creating the directory might signal an error, and
5976 that would leave Emacs in a strange state. */
5977 if (!NILP (Vrun_hooks))
5979 Lisp_Object dir;
5980 dir = Qnil;
5981 GCPRO2 (dir, listfile);
5982 dir = Ffile_name_directory (listfile);
5983 if (NILP (Ffile_directory_p (dir)))
5984 internal_condition_case_1 (do_auto_save_make_dir,
5985 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5986 do_auto_save_eh);
5987 UNGCPRO;
5990 stream = fopen (SDATA (listfile), "w");
5993 record_unwind_protect (do_auto_save_unwind,
5994 make_save_value (stream, 0));
5995 record_unwind_protect (do_auto_save_unwind_1,
5996 make_number (minibuffer_auto_raise));
5997 minibuffer_auto_raise = 0;
5998 auto_saving = 1;
6000 /* On first pass, save all files that don't have handlers.
6001 On second pass, save all files that do have handlers.
6003 If Emacs is crashing, the handlers may tweak what is causing
6004 Emacs to crash in the first place, and it would be a shame if
6005 Emacs failed to autosave perfectly ordinary files because it
6006 couldn't handle some ange-ftp'd file. */
6008 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
6009 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
6011 buf = XCDR (XCAR (tail));
6012 b = XBUFFER (buf);
6014 /* Record all the buffers that have auto save mode
6015 in the special file that lists them. For each of these buffers,
6016 Record visited name (if any) and auto save name. */
6017 if (STRINGP (b->auto_save_file_name)
6018 && stream != NULL && do_handled_files == 0)
6020 BLOCK_INPUT;
6021 if (!NILP (b->filename))
6023 fwrite (SDATA (b->filename), 1,
6024 SBYTES (b->filename), stream);
6026 putc ('\n', stream);
6027 fwrite (SDATA (b->auto_save_file_name), 1,
6028 SBYTES (b->auto_save_file_name), stream);
6029 putc ('\n', stream);
6030 UNBLOCK_INPUT;
6033 if (!NILP (current_only)
6034 && b != current_buffer)
6035 continue;
6037 /* Don't auto-save indirect buffers.
6038 The base buffer takes care of it. */
6039 if (b->base_buffer)
6040 continue;
6042 /* Check for auto save enabled
6043 and file changed since last auto save
6044 and file changed since last real save. */
6045 if (STRINGP (b->auto_save_file_name)
6046 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
6047 && b->auto_save_modified < BUF_MODIFF (b)
6048 /* -1 means we've turned off autosaving for a while--see below. */
6049 && XINT (b->save_length) >= 0
6050 && (do_handled_files
6051 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
6052 Qwrite_region))))
6054 EMACS_TIME before_time, after_time;
6056 EMACS_GET_TIME (before_time);
6058 /* If we had a failure, don't try again for 20 minutes. */
6059 if (b->auto_save_failure_time >= 0
6060 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
6061 continue;
6063 if ((XFASTINT (b->save_length) * 10
6064 > (BUF_Z (b) - BUF_BEG (b)) * 13)
6065 /* A short file is likely to change a large fraction;
6066 spare the user annoying messages. */
6067 && XFASTINT (b->save_length) > 5000
6068 /* These messages are frequent and annoying for `*mail*'. */
6069 && !EQ (b->filename, Qnil)
6070 && NILP (no_message))
6072 /* It has shrunk too much; turn off auto-saving here. */
6073 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6074 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6075 b->name, 1);
6076 minibuffer_auto_raise = 0;
6077 /* Turn off auto-saving until there's a real save,
6078 and prevent any more warnings. */
6079 XSETINT (b->save_length, -1);
6080 Fsleep_for (make_number (1), Qnil);
6081 continue;
6083 set_buffer_internal (b);
6084 if (!auto_saved && NILP (no_message))
6085 message1 ("Auto-saving...");
6086 internal_condition_case (auto_save_1, Qt, auto_save_error);
6087 auto_saved++;
6088 b->auto_save_modified = BUF_MODIFF (b);
6089 XSETFASTINT (current_buffer->save_length, Z - BEG);
6090 set_buffer_internal (old);
6092 EMACS_GET_TIME (after_time);
6094 /* If auto-save took more than 60 seconds,
6095 assume it was an NFS failure that got a timeout. */
6096 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6097 b->auto_save_failure_time = EMACS_SECS (after_time);
6101 /* Prevent another auto save till enough input events come in. */
6102 record_auto_save ();
6104 if (auto_saved && NILP (no_message))
6106 if (old_message_p)
6108 /* If we are going to restore an old message,
6109 give time to read ours. */
6110 sit_for (make_number (1), 0, 0);
6111 restore_message ();
6113 else
6114 /* If we displayed a message and then restored a state
6115 with no message, leave a "done" message on the screen. */
6116 message1 ("Auto-saving...done");
6119 Vquit_flag = oquit;
6121 /* This restores the message-stack status. */
6122 unbind_to (count, Qnil);
6123 return Qnil;
6126 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6127 Sset_buffer_auto_saved, 0, 0, 0,
6128 doc: /* Mark current buffer as auto-saved with its current text.
6129 No auto-save file will be written until the buffer changes again. */)
6132 current_buffer->auto_save_modified = MODIFF;
6133 XSETFASTINT (current_buffer->save_length, Z - BEG);
6134 current_buffer->auto_save_failure_time = -1;
6135 return Qnil;
6138 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6139 Sclear_buffer_auto_save_failure, 0, 0, 0,
6140 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6143 current_buffer->auto_save_failure_time = -1;
6144 return Qnil;
6147 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6148 0, 0, 0,
6149 doc: /* Return t if current buffer has been auto-saved recently.
6150 More precisely, if it has been auto-saved since last read from or saved
6151 in the visited file. If the buffer has no visited file,
6152 then any auto-save counts as "recent". */)
6155 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6158 /* Reading and completing file names */
6159 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6161 /* In the string VAL, change each $ to $$ and return the result. */
6163 static Lisp_Object
6164 double_dollars (val)
6165 Lisp_Object val;
6167 register const unsigned char *old;
6168 register unsigned char *new;
6169 register int n;
6170 int osize, count;
6172 osize = SBYTES (val);
6174 /* Count the number of $ characters. */
6175 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6176 if (*old++ == '$') count++;
6177 if (count > 0)
6179 old = SDATA (val);
6180 val = make_uninit_multibyte_string (SCHARS (val) + count,
6181 osize + count);
6182 new = SDATA (val);
6183 for (n = osize; n > 0; n--)
6184 if (*old != '$')
6185 *new++ = *old++;
6186 else
6188 *new++ = '$';
6189 *new++ = '$';
6190 old++;
6193 return val;
6196 static Lisp_Object
6197 read_file_name_cleanup (arg)
6198 Lisp_Object arg;
6200 return (current_buffer->directory = arg);
6203 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
6204 3, 3, 0,
6205 doc: /* Internal subroutine for read-file-name. Do not call this. */)
6206 (string, dir, action)
6207 Lisp_Object string, dir, action;
6208 /* action is nil for complete, t for return list of completions,
6209 lambda for verify final value */
6211 Lisp_Object name, specdir, realdir, val, orig_string;
6212 int changed;
6213 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6215 CHECK_STRING (string);
6217 realdir = dir;
6218 name = string;
6219 orig_string = Qnil;
6220 specdir = Qnil;
6221 changed = 0;
6222 /* No need to protect ACTION--we only compare it with t and nil. */
6223 GCPRO5 (string, realdir, name, specdir, orig_string);
6225 if (SCHARS (string) == 0)
6227 if (EQ (action, Qlambda))
6229 UNGCPRO;
6230 return Qnil;
6233 else
6235 orig_string = string;
6236 string = Fsubstitute_in_file_name (string);
6237 changed = NILP (Fstring_equal (string, orig_string));
6238 name = Ffile_name_nondirectory (string);
6239 val = Ffile_name_directory (string);
6240 if (! NILP (val))
6241 realdir = Fexpand_file_name (val, realdir);
6244 if (NILP (action))
6246 specdir = Ffile_name_directory (string);
6247 val = Ffile_name_completion (name, realdir, Vread_file_name_predicate);
6248 UNGCPRO;
6249 if (!STRINGP (val))
6251 if (changed)
6252 return double_dollars (string);
6253 return val;
6256 if (!NILP (specdir))
6257 val = concat2 (specdir, val);
6258 #ifndef VMS
6259 return double_dollars (val);
6260 #else /* not VMS */
6261 return val;
6262 #endif /* not VMS */
6264 UNGCPRO;
6266 if (EQ (action, Qt))
6268 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6269 Lisp_Object comp;
6270 int count;
6272 if (NILP (Vread_file_name_predicate)
6273 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6274 return all;
6276 #ifndef VMS
6277 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6279 /* Brute-force speed up for directory checking:
6280 Discard strings which don't end in a slash. */
6281 for (comp = Qnil; CONSP (all); all = XCDR (all))
6283 Lisp_Object tem = XCAR (all);
6284 int len;
6285 if (STRINGP (tem)
6286 && (len = SBYTES (tem), len > 0)
6287 && IS_DIRECTORY_SEP (SREF (tem, len-1)))
6288 comp = Fcons (tem, comp);
6291 else
6292 #endif
6294 /* Must do it the hard (and slow) way. */
6295 Lisp_Object tem;
6296 GCPRO3 (all, comp, specdir);
6297 count = SPECPDL_INDEX ();
6298 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6299 current_buffer->directory = realdir;
6300 for (comp = Qnil; CONSP (all); all = XCDR (all))
6302 tem = call1 (Vread_file_name_predicate, XCAR (all));
6303 if (!NILP (tem))
6304 comp = Fcons (XCAR (all), comp);
6306 unbind_to (count, Qnil);
6307 UNGCPRO;
6309 return Fnreverse (comp);
6312 /* Only other case actually used is ACTION = lambda */
6313 #ifdef VMS
6314 /* Supposedly this helps commands such as `cd' that read directory names,
6315 but can someone explain how it helps them? -- RMS */
6316 if (SCHARS (name) == 0)
6317 return Qt;
6318 #endif /* VMS */
6319 string = Fexpand_file_name (string, dir);
6320 if (!NILP (Vread_file_name_predicate))
6321 return call1 (Vread_file_name_predicate, string);
6322 return Ffile_exists_p (string);
6325 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6326 Snext_read_file_uses_dialog_p, 0, 0, 0,
6327 doc: /* Return t if a call to `read-file-name' will use a dialog.
6328 The return value is only relevant for a call to `read-file-name' that happens
6329 before any other event (mouse or keypress) is handeled. */)
6332 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6333 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6334 && use_dialog_box
6335 && use_file_dialog
6336 && have_menus_p ())
6337 return Qt;
6338 #endif
6339 return Qnil;
6342 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6343 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6344 Value is not expanded---you must call `expand-file-name' yourself.
6345 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6346 the same non-empty string that was inserted by this function.
6347 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6348 except that if INITIAL is specified, that combined with DIR is used.)
6349 If the user exits with an empty minibuffer, this function returns
6350 an empty string. (This can only happen if the user erased the
6351 pre-inserted contents or if `insert-default-directory' is nil.)
6352 Fourth arg MUSTMATCH non-nil means require existing file's name.
6353 Non-nil and non-t means also require confirmation after completion.
6354 Fifth arg INITIAL specifies text to start with.
6355 If optional sixth arg PREDICATE is non-nil, possible completions and
6356 the resulting file name must satisfy (funcall PREDICATE NAME).
6357 DIR should be an absolute directory name. It defaults to the value of
6358 `default-directory'.
6360 If this command was invoked with the mouse, use a file dialog box if
6361 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6362 provides a file dialog box.
6364 See also `read-file-name-completion-ignore-case'
6365 and `read-file-name-function'. */)
6366 (prompt, dir, default_filename, mustmatch, initial, predicate)
6367 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6369 Lisp_Object val, insdef, tem;
6370 struct gcpro gcpro1, gcpro2;
6371 register char *homedir;
6372 Lisp_Object decoded_homedir;
6373 int replace_in_history = 0;
6374 int add_to_history = 0;
6375 int count;
6377 if (NILP (dir))
6378 dir = current_buffer->directory;
6379 if (NILP (Ffile_name_absolute_p (dir)))
6380 dir = Fexpand_file_name (dir, Qnil);
6381 if (NILP (default_filename))
6382 default_filename
6383 = (!NILP (initial)
6384 ? Fexpand_file_name (initial, dir)
6385 : current_buffer->filename);
6387 /* If dir starts with user's homedir, change that to ~. */
6388 homedir = (char *) egetenv ("HOME");
6389 #ifdef DOS_NT
6390 /* homedir can be NULL in temacs, since Vprocess_environment is not
6391 yet set up. We shouldn't crash in that case. */
6392 if (homedir != 0)
6394 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6395 CORRECT_DIR_SEPS (homedir);
6397 #endif
6398 if (homedir != 0)
6399 decoded_homedir
6400 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6401 if (homedir != 0
6402 && STRINGP (dir)
6403 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6404 SBYTES (decoded_homedir))
6405 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6407 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6408 dir = concat2 (build_string ("~"), dir);
6410 /* Likewise for default_filename. */
6411 if (homedir != 0
6412 && STRINGP (default_filename)
6413 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6414 SBYTES (decoded_homedir))
6415 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6417 default_filename
6418 = Fsubstring (default_filename,
6419 make_number (SCHARS (decoded_homedir)), Qnil);
6420 default_filename = concat2 (build_string ("~"), default_filename);
6422 if (!NILP (default_filename))
6424 CHECK_STRING (default_filename);
6425 default_filename = double_dollars (default_filename);
6428 if (insert_default_directory && STRINGP (dir))
6430 insdef = dir;
6431 if (!NILP (initial))
6433 Lisp_Object args[2], pos;
6435 args[0] = insdef;
6436 args[1] = initial;
6437 insdef = Fconcat (2, args);
6438 pos = make_number (SCHARS (double_dollars (dir)));
6439 insdef = Fcons (double_dollars (insdef), pos);
6441 else
6442 insdef = double_dollars (insdef);
6444 else if (STRINGP (initial))
6445 insdef = Fcons (double_dollars (initial), make_number (0));
6446 else
6447 insdef = Qnil;
6449 if (!NILP (Vread_file_name_function))
6451 Lisp_Object args[7];
6453 GCPRO2 (insdef, default_filename);
6454 args[0] = Vread_file_name_function;
6455 args[1] = prompt;
6456 args[2] = dir;
6457 args[3] = default_filename;
6458 args[4] = mustmatch;
6459 args[5] = initial;
6460 args[6] = predicate;
6461 RETURN_UNGCPRO (Ffuncall (7, args));
6464 count = SPECPDL_INDEX ();
6465 specbind (intern ("completion-ignore-case"),
6466 read_file_name_completion_ignore_case ? Qt : Qnil);
6467 specbind (intern ("minibuffer-completing-file-name"), Qt);
6468 specbind (intern ("read-file-name-predicate"),
6469 (NILP (predicate) ? Qfile_exists_p : predicate));
6471 GCPRO2 (insdef, default_filename);
6473 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6474 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6476 /* If DIR contains a file name, split it. */
6477 Lisp_Object file;
6478 file = Ffile_name_nondirectory (dir);
6479 if (SCHARS (file) && NILP (default_filename))
6481 default_filename = file;
6482 dir = Ffile_name_directory (dir);
6484 if (!NILP(default_filename))
6485 default_filename = Fexpand_file_name (default_filename, dir);
6486 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch,
6487 EQ (predicate, Qfile_directory_p) ? Qt : Qnil);
6488 add_to_history = 1;
6490 else
6491 #endif
6492 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6493 dir, mustmatch, insdef,
6494 Qfile_name_history, default_filename, Qnil);
6496 tem = Fsymbol_value (Qfile_name_history);
6497 if (CONSP (tem) && EQ (XCAR (tem), val))
6498 replace_in_history = 1;
6500 /* If Fcompleting_read returned the inserted default string itself
6501 (rather than a new string with the same contents),
6502 it has to mean that the user typed RET with the minibuffer empty.
6503 In that case, we really want to return ""
6504 so that commands such as set-visited-file-name can distinguish. */
6505 if (EQ (val, default_filename))
6507 /* In this case, Fcompleting_read has not added an element
6508 to the history. Maybe we should. */
6509 if (! replace_in_history)
6510 add_to_history = 1;
6512 val = empty_unibyte_string;
6515 unbind_to (count, Qnil);
6516 UNGCPRO;
6517 if (NILP (val))
6518 error ("No file name specified");
6520 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6522 if (!NILP (tem) && !NILP (default_filename))
6523 val = default_filename;
6524 val = Fsubstitute_in_file_name (val);
6526 if (replace_in_history)
6527 /* Replace what Fcompleting_read added to the history
6528 with what we will actually return. */
6530 Lisp_Object val1 = double_dollars (val);
6531 tem = Fsymbol_value (Qfile_name_history);
6532 if (history_delete_duplicates)
6533 XSETCDR (tem, Fdelete (val1, XCDR(tem)));
6534 XSETCAR (tem, val1);
6536 else if (add_to_history)
6538 /* Add the value to the history--but not if it matches
6539 the last value already there. */
6540 Lisp_Object val1 = double_dollars (val);
6541 tem = Fsymbol_value (Qfile_name_history);
6542 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6544 if (history_delete_duplicates) tem = Fdelete (val1, tem);
6545 Fset (Qfile_name_history, Fcons (val1, tem));
6549 return val;
6553 void
6554 init_fileio_once ()
6556 /* Must be set before any path manipulation is performed. */
6557 XSETFASTINT (Vdirectory_sep_char, '/');
6561 void
6562 syms_of_fileio ()
6564 Qoperations = intern ("operations");
6565 Qexpand_file_name = intern ("expand-file-name");
6566 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6567 Qdirectory_file_name = intern ("directory-file-name");
6568 Qfile_name_directory = intern ("file-name-directory");
6569 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6570 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6571 Qfile_name_as_directory = intern ("file-name-as-directory");
6572 Qcopy_file = intern ("copy-file");
6573 Qmake_directory_internal = intern ("make-directory-internal");
6574 Qmake_directory = intern ("make-directory");
6575 Qdelete_directory = intern ("delete-directory");
6576 Qdelete_file = intern ("delete-file");
6577 Qrename_file = intern ("rename-file");
6578 Qadd_name_to_file = intern ("add-name-to-file");
6579 Qmake_symbolic_link = intern ("make-symbolic-link");
6580 Qfile_exists_p = intern ("file-exists-p");
6581 Qfile_executable_p = intern ("file-executable-p");
6582 Qfile_readable_p = intern ("file-readable-p");
6583 Qfile_writable_p = intern ("file-writable-p");
6584 Qfile_symlink_p = intern ("file-symlink-p");
6585 Qaccess_file = intern ("access-file");
6586 Qfile_directory_p = intern ("file-directory-p");
6587 Qfile_regular_p = intern ("file-regular-p");
6588 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6589 Qfile_modes = intern ("file-modes");
6590 Qset_file_modes = intern ("set-file-modes");
6591 Qset_file_times = intern ("set-file-times");
6592 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6593 Qinsert_file_contents = intern ("insert-file-contents");
6594 Qwrite_region = intern ("write-region");
6595 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6596 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6597 Qauto_save_coding = intern ("auto-save-coding");
6599 staticpro (&Qoperations);
6600 staticpro (&Qexpand_file_name);
6601 staticpro (&Qsubstitute_in_file_name);
6602 staticpro (&Qdirectory_file_name);
6603 staticpro (&Qfile_name_directory);
6604 staticpro (&Qfile_name_nondirectory);
6605 staticpro (&Qunhandled_file_name_directory);
6606 staticpro (&Qfile_name_as_directory);
6607 staticpro (&Qcopy_file);
6608 staticpro (&Qmake_directory_internal);
6609 staticpro (&Qmake_directory);
6610 staticpro (&Qdelete_directory);
6611 staticpro (&Qdelete_file);
6612 staticpro (&Qrename_file);
6613 staticpro (&Qadd_name_to_file);
6614 staticpro (&Qmake_symbolic_link);
6615 staticpro (&Qfile_exists_p);
6616 staticpro (&Qfile_executable_p);
6617 staticpro (&Qfile_readable_p);
6618 staticpro (&Qfile_writable_p);
6619 staticpro (&Qaccess_file);
6620 staticpro (&Qfile_symlink_p);
6621 staticpro (&Qfile_directory_p);
6622 staticpro (&Qfile_regular_p);
6623 staticpro (&Qfile_accessible_directory_p);
6624 staticpro (&Qfile_modes);
6625 staticpro (&Qset_file_modes);
6626 staticpro (&Qset_file_times);
6627 staticpro (&Qfile_newer_than_file_p);
6628 staticpro (&Qinsert_file_contents);
6629 staticpro (&Qwrite_region);
6630 staticpro (&Qverify_visited_file_modtime);
6631 staticpro (&Qset_visited_file_modtime);
6632 staticpro (&Qauto_save_coding);
6634 Qfile_name_history = intern ("file-name-history");
6635 Fset (Qfile_name_history, Qnil);
6636 staticpro (&Qfile_name_history);
6638 Qfile_error = intern ("file-error");
6639 staticpro (&Qfile_error);
6640 Qfile_already_exists = intern ("file-already-exists");
6641 staticpro (&Qfile_already_exists);
6642 Qfile_date_error = intern ("file-date-error");
6643 staticpro (&Qfile_date_error);
6644 Qexcl = intern ("excl");
6645 staticpro (&Qexcl);
6647 #ifdef DOS_NT
6648 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6649 staticpro (&Qfind_buffer_file_type);
6650 #endif /* DOS_NT */
6652 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6653 doc: /* *Coding system for encoding file names.
6654 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6655 Vfile_name_coding_system = Qnil;
6657 DEFVAR_LISP ("default-file-name-coding-system",
6658 &Vdefault_file_name_coding_system,
6659 doc: /* Default coding system for encoding file names.
6660 This variable is used only when `file-name-coding-system' is nil.
6662 This variable is set/changed by the command `set-language-environment'.
6663 User should not set this variable manually,
6664 instead use `file-name-coding-system' to get a constant encoding
6665 of file names regardless of the current language environment. */);
6666 Vdefault_file_name_coding_system = Qnil;
6668 Qformat_decode = intern ("format-decode");
6669 staticpro (&Qformat_decode);
6670 Qformat_annotate_function = intern ("format-annotate-function");
6671 staticpro (&Qformat_annotate_function);
6672 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6673 staticpro (&Qafter_insert_file_set_coding);
6675 Qcar_less_than_car = intern ("car-less-than-car");
6676 staticpro (&Qcar_less_than_car);
6678 Fput (Qfile_error, Qerror_conditions,
6679 list2 (Qfile_error, Qerror));
6680 Fput (Qfile_error, Qerror_message,
6681 build_string ("File error"));
6683 Fput (Qfile_already_exists, Qerror_conditions,
6684 list3 (Qfile_already_exists, Qfile_error, Qerror));
6685 Fput (Qfile_already_exists, Qerror_message,
6686 build_string ("File already exists"));
6688 Fput (Qfile_date_error, Qerror_conditions,
6689 list3 (Qfile_date_error, Qfile_error, Qerror));
6690 Fput (Qfile_date_error, Qerror_message,
6691 build_string ("Cannot set file date"));
6693 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6694 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6695 Vread_file_name_function = Qnil;
6697 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6698 doc: /* Current predicate used by `read-file-name-internal'. */);
6699 Vread_file_name_predicate = Qnil;
6701 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case,
6702 doc: /* *Non-nil means when reading a file name completion ignores case. */);
6703 #if defined VMS || defined DOS_NT || defined MAC_OS
6704 read_file_name_completion_ignore_case = 1;
6705 #else
6706 read_file_name_completion_ignore_case = 0;
6707 #endif
6709 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6710 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6711 If the initial minibuffer contents are non-empty, you can usually
6712 request a default filename by typing RETURN without editing. For some
6713 commands, exiting with an empty minibuffer has a special meaning,
6714 such as making the current buffer visit no file in the case of
6715 `set-visited-file-name'.
6716 If this variable is non-nil, the minibuffer contents are always
6717 initially non-empty and typing RETURN without editing will fetch the
6718 default name, if one is provided. Note however that this default name
6719 is not necessarily the name originally inserted in the minibuffer, if
6720 that is just the default directory.
6721 If this variable is nil, the minibuffer often starts out empty. In
6722 that case you may have to explicitly fetch the next history element to
6723 request the default name. */);
6724 insert_default_directory = 1;
6726 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6727 doc: /* *Non-nil means write new files with record format `stmlf'.
6728 nil means use format `var'. This variable is meaningful only on VMS. */);
6729 vms_stmlf_recfm = 0;
6731 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6732 doc: /* Directory separator character for built-in functions that return file names.
6733 The value is always ?/. Don't use this variable, just use `/'. */);
6735 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6736 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6737 If a file name matches REGEXP, then all I/O on that file is done by calling
6738 HANDLER.
6740 The first argument given to HANDLER is the name of the I/O primitive
6741 to be handled; the remaining arguments are the arguments that were
6742 passed to that primitive. For example, if you do
6743 (file-exists-p FILENAME)
6744 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6745 (funcall HANDLER 'file-exists-p FILENAME)
6746 The function `find-file-name-handler' checks this list for a handler
6747 for its argument. */);
6748 Vfile_name_handler_alist = Qnil;
6750 DEFVAR_LISP ("set-auto-coding-function",
6751 &Vset_auto_coding_function,
6752 doc: /* If non-nil, a function to call to decide a coding system of file.
6753 Two arguments are passed to this function: the file name
6754 and the length of a file contents following the point.
6755 This function should return a coding system to decode the file contents.
6756 It should check the file name against `auto-coding-alist'.
6757 If no coding system is decided, it should check a coding system
6758 specified in the heading lines with the format:
6759 -*- ... coding: CODING-SYSTEM; ... -*-
6760 or local variable spec of the tailing lines with `coding:' tag. */);
6761 Vset_auto_coding_function = Qnil;
6763 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6764 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6765 Each is passed one argument, the number of characters inserted,
6766 with point at the start of the inserted text. Each function
6767 should leave point the same, and return the new character count.
6768 If `insert-file-contents' is intercepted by a handler from
6769 `file-name-handler-alist', that handler is responsible for calling the
6770 functions in `after-insert-file-functions' if appropriate. */);
6771 Vafter_insert_file_functions = Qnil;
6773 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6774 doc: /* A list of functions to be called at the start of `write-region'.
6775 Each is passed two arguments, START and END as for `write-region'.
6776 These are usually two numbers but not always; see the documentation
6777 for `write-region'. The function should return a list of pairs
6778 of the form (POSITION . STRING), consisting of strings to be effectively
6779 inserted at the specified positions of the file being written (1 means to
6780 insert before the first byte written). The POSITIONs must be sorted into
6781 increasing order. If there are several functions in the list, the several
6782 lists are merged destructively. Alternatively, the function can return
6783 with a different buffer current; in that case it should pay attention
6784 to the annotations returned by previous functions and listed in
6785 `write-region-annotations-so-far'.*/);
6786 Vwrite_region_annotate_functions = Qnil;
6787 staticpro (&Qwrite_region_annotate_functions);
6788 Qwrite_region_annotate_functions
6789 = intern ("write-region-annotate-functions");
6791 DEFVAR_LISP ("write-region-annotations-so-far",
6792 &Vwrite_region_annotations_so_far,
6793 doc: /* When an annotation function is called, this holds the previous annotations.
6794 These are the annotations made by other annotation functions
6795 that were already called. See also `write-region-annotate-functions'. */);
6796 Vwrite_region_annotations_so_far = Qnil;
6798 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6799 doc: /* A list of file name handlers that temporarily should not be used.
6800 This applies only to the operation `inhibit-file-name-operation'. */);
6801 Vinhibit_file_name_handlers = Qnil;
6803 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6804 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6805 Vinhibit_file_name_operation = Qnil;
6807 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6808 doc: /* File name in which we write a list of all auto save file names.
6809 This variable is initialized automatically from `auto-save-list-file-prefix'
6810 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6811 a non-nil value. */);
6812 Vauto_save_list_file_name = Qnil;
6814 #ifdef HAVE_FSYNC
6815 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
6816 doc: /* *Non-nil means don't call fsync in `write-region'.
6817 This variable affects calls to `write-region' as well as save commands.
6818 A non-nil value may result in data loss! */);
6819 write_region_inhibit_fsync = 0;
6820 #endif
6822 defsubr (&Sfind_file_name_handler);
6823 defsubr (&Sfile_name_directory);
6824 defsubr (&Sfile_name_nondirectory);
6825 defsubr (&Sunhandled_file_name_directory);
6826 defsubr (&Sfile_name_as_directory);
6827 defsubr (&Sdirectory_file_name);
6828 defsubr (&Smake_temp_name);
6829 defsubr (&Sexpand_file_name);
6830 defsubr (&Ssubstitute_in_file_name);
6831 defsubr (&Scopy_file);
6832 defsubr (&Smake_directory_internal);
6833 defsubr (&Sdelete_directory);
6834 defsubr (&Sdelete_file);
6835 defsubr (&Srename_file);
6836 defsubr (&Sadd_name_to_file);
6837 #ifdef S_IFLNK
6838 defsubr (&Smake_symbolic_link);
6839 #endif /* S_IFLNK */
6840 #ifdef VMS
6841 defsubr (&Sdefine_logical_name);
6842 #endif /* VMS */
6843 #ifdef HPUX_NET
6844 defsubr (&Ssysnetunam);
6845 #endif /* HPUX_NET */
6846 defsubr (&Sfile_name_absolute_p);
6847 defsubr (&Sfile_exists_p);
6848 defsubr (&Sfile_executable_p);
6849 defsubr (&Sfile_readable_p);
6850 defsubr (&Sfile_writable_p);
6851 defsubr (&Saccess_file);
6852 defsubr (&Sfile_symlink_p);
6853 defsubr (&Sfile_directory_p);
6854 defsubr (&Sfile_accessible_directory_p);
6855 defsubr (&Sfile_regular_p);
6856 defsubr (&Sfile_modes);
6857 defsubr (&Sset_file_modes);
6858 defsubr (&Sset_file_times);
6859 defsubr (&Sset_default_file_modes);
6860 defsubr (&Sdefault_file_modes);
6861 defsubr (&Sfile_newer_than_file_p);
6862 defsubr (&Sinsert_file_contents);
6863 defsubr (&Swrite_region);
6864 defsubr (&Scar_less_than_car);
6865 defsubr (&Sverify_visited_file_modtime);
6866 defsubr (&Sclear_visited_file_modtime);
6867 defsubr (&Svisited_file_modtime);
6868 defsubr (&Sset_visited_file_modtime);
6869 defsubr (&Sdo_auto_save);
6870 defsubr (&Sset_buffer_auto_saved);
6871 defsubr (&Sclear_buffer_auto_save_failure);
6872 defsubr (&Srecent_auto_save_p);
6874 defsubr (&Sread_file_name_internal);
6875 defsubr (&Sread_file_name);
6876 defsubr (&Snext_read_file_uses_dialog_p);
6878 #ifdef HAVE_SYNC
6879 defsubr (&Sunix_sync);
6880 #endif
6883 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6884 (do not change this comment) */