]> code.delx.au - gnu-emacs/blob - src/fileio.c
Merged from miles@gnu.org--gnu-2005 (patch 70-73, 320-331)
[gnu-emacs] / src / fileio.c
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22 #include <config.h>
23
24 #ifdef HAVE_FCNTL_H
25 #include <fcntl.h>
26 #endif
27
28 #include <stdio.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31
32 #ifdef HAVE_UNISTD_H
33 #include <unistd.h>
34 #endif
35
36 #if !defined (S_ISLNK) && defined (S_IFLNK)
37 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
38 #endif
39
40 #if !defined (S_ISFIFO) && defined (S_IFIFO)
41 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
42 #endif
43
44 #if !defined (S_ISREG) && defined (S_IFREG)
45 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
46 #endif
47
48 #ifdef HAVE_PWD_H
49 #include <pwd.h>
50 #endif
51
52 #include <ctype.h>
53
54 #ifdef VMS
55 #include "vmsdir.h"
56 #include <perror.h>
57 #include <stddef.h>
58 #include <string.h>
59 #endif
60
61 #include <errno.h>
62
63 #ifndef vax11c
64 #ifndef USE_CRT_DLL
65 extern int errno;
66 #endif
67 #endif
68
69 #ifdef APOLLO
70 #include <sys/time.h>
71 #endif
72
73 #include "lisp.h"
74 #include "intervals.h"
75 #include "buffer.h"
76 #include "charset.h"
77 #include "coding.h"
78 #include "window.h"
79 #include "frame.h"
80 #include "dispextern.h"
81
82 #ifdef WINDOWSNT
83 #define NOMINMAX 1
84 #include <windows.h>
85 #include <stdlib.h>
86 #include <fcntl.h>
87 #endif /* not WINDOWSNT */
88
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
97
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
116
117 #ifdef VMS
118 #include <file.h>
119 #include <rmsdef.h>
120 #include <fab.h>
121 #include <nam.h>
122 #endif
123
124 #include "systime.h"
125
126 #ifdef HPUX
127 #include <netio.h>
128 #ifndef HPUX8
129 #ifndef HPUX9
130 #include <errnet.h>
131 #endif
132 #endif
133 #endif
134
135 #include "commands.h"
136 extern int use_dialog_box;
137 extern int use_file_dialog;
138
139 #ifndef O_WRONLY
140 #define O_WRONLY 1
141 #endif
142
143 #ifndef O_RDONLY
144 #define O_RDONLY 0
145 #endif
146
147 #ifndef S_ISLNK
148 # define lstat stat
149 #endif
150
151 #ifndef FILE_SYSTEM_CASE
152 #define FILE_SYSTEM_CASE(filename) (filename)
153 #endif
154
155 /* Nonzero during writing of auto-save files */
156 int auto_saving;
157
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;
161
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;
168
169 /* Coding system for file names, or nil if none. */
170 Lisp_Object Vfile_name_coding_system;
171
172 /* Coding system for file names used only when
173 Vfile_name_coding_system is nil. */
174 Lisp_Object Vdefault_file_name_coding_system;
175
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;
179
180 /* Property name of a file name handler,
181 which gives a list of operations it handles.. */
182 Lisp_Object Qoperations;
183
184 /* Lisp functions for translating file formats */
185 Lisp_Object Qformat_decode, Qformat_annotate_function;
186
187 /* Function to be called to decide a coding system of a reading file. */
188 Lisp_Object Vset_auto_coding_function;
189
190 /* Functions to be called to process text properties in inserted file. */
191 Lisp_Object Vafter_insert_file_functions;
192
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;
196
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;
200
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;
204
205 /* File name in which we write a list of all our auto save files. */
206 Lisp_Object Vauto_save_list_file_name;
207
208 /* Function to call to read a file name. */
209 Lisp_Object Vread_file_name_function;
210
211 /* Current predicate used by read_file_name_internal. */
212 Lisp_Object Vread_file_name_predicate;
213
214 /* Nonzero means completion ignores case when reading file name. */
215 int read_file_name_completion_ignore_case;
216
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;
220
221 /* On VMS, nonzero means write new files with record format stmlf.
222 Zero means use var format. */
223 int vms_stmlf_recfm;
224
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;
228
229 extern Lisp_Object Vuser_login_name;
230
231 #ifdef WINDOWSNT
232 extern Lisp_Object Vw32_get_true_file_attributes;
233 #endif
234
235 extern int minibuf_level;
236
237 extern int minibuffer_auto_raise;
238
239 extern int history_delete_duplicates;
240
241 /* These variables describe handlers that have "already" had a chance
242 to handle the current operation.
243
244 Vinhibit_file_name_handlers is a list of file name handlers.
245 Vinhibit_file_name_operation is the operation being handled.
246 If we try to handle that operation, we ignore those handlers. */
247
248 static Lisp_Object Vinhibit_file_name_handlers;
249 static Lisp_Object Vinhibit_file_name_operation;
250
251 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
252 Lisp_Object Qexcl;
253 Lisp_Object Qfile_name_history;
254
255 Lisp_Object Qcar_less_than_car;
256
257 static int a_write P_ ((int, Lisp_Object, int, int,
258 Lisp_Object *, struct coding_system *));
259 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
260
261 \f
262 void
263 report_file_error (string, data)
264 const char *string;
265 Lisp_Object data;
266 {
267 Lisp_Object errstring;
268 int errorno = errno;
269
270 synchronize_system_messages_locale ();
271 errstring = code_convert_string_norecord (build_string (strerror (errorno)),
272 Vlocale_coding_system, 0);
273
274 while (1)
275 switch (errorno)
276 {
277 case EEXIST:
278 Fsignal (Qfile_already_exists, Fcons (errstring, data));
279 break;
280 default:
281 /* System error messages are capitalized. Downcase the initial
282 unless it is followed by a slash. */
283 if (SREF (errstring, 1) != '/')
284 SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
285
286 Fsignal (Qfile_error,
287 Fcons (build_string (string), Fcons (errstring, data)));
288 }
289 }
290
291 Lisp_Object
292 close_file_unwind (fd)
293 Lisp_Object fd;
294 {
295 emacs_close (XFASTINT (fd));
296 return Qnil;
297 }
298
299 /* Restore point, having saved it as a marker. */
300
301 static Lisp_Object
302 restore_point_unwind (location)
303 Lisp_Object location;
304 {
305 Fgoto_char (location);
306 Fset_marker (location, Qnil, Qnil);
307 return Qnil;
308 }
309 \f
310 Lisp_Object Qexpand_file_name;
311 Lisp_Object Qsubstitute_in_file_name;
312 Lisp_Object Qdirectory_file_name;
313 Lisp_Object Qfile_name_directory;
314 Lisp_Object Qfile_name_nondirectory;
315 Lisp_Object Qunhandled_file_name_directory;
316 Lisp_Object Qfile_name_as_directory;
317 Lisp_Object Qcopy_file;
318 Lisp_Object Qmake_directory_internal;
319 Lisp_Object Qmake_directory;
320 Lisp_Object Qdelete_directory;
321 Lisp_Object Qdelete_file;
322 Lisp_Object Qrename_file;
323 Lisp_Object Qadd_name_to_file;
324 Lisp_Object Qmake_symbolic_link;
325 Lisp_Object Qfile_exists_p;
326 Lisp_Object Qfile_executable_p;
327 Lisp_Object Qfile_readable_p;
328 Lisp_Object Qfile_writable_p;
329 Lisp_Object Qfile_symlink_p;
330 Lisp_Object Qaccess_file;
331 Lisp_Object Qfile_directory_p;
332 Lisp_Object Qfile_regular_p;
333 Lisp_Object Qfile_accessible_directory_p;
334 Lisp_Object Qfile_modes;
335 Lisp_Object Qset_file_modes;
336 Lisp_Object Qset_file_times;
337 Lisp_Object Qfile_newer_than_file_p;
338 Lisp_Object Qinsert_file_contents;
339 Lisp_Object Qwrite_region;
340 Lisp_Object Qverify_visited_file_modtime;
341 Lisp_Object Qset_visited_file_modtime;
342
343 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
344 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
345 Otherwise, return nil.
346 A file name is handled if one of the regular expressions in
347 `file-name-handler-alist' matches it.
348
349 If OPERATION equals `inhibit-file-name-operation', then we ignore
350 any handlers that are members of `inhibit-file-name-handlers',
351 but we still do run any other handlers. This lets handlers
352 use the standard functions without calling themselves recursively. */)
353 (filename, operation)
354 Lisp_Object filename, operation;
355 {
356 /* This function must not munge the match data. */
357 Lisp_Object chain, inhibited_handlers, result;
358 int pos = -1;
359
360 result = Qnil;
361 CHECK_STRING (filename);
362
363 if (EQ (operation, Vinhibit_file_name_operation))
364 inhibited_handlers = Vinhibit_file_name_handlers;
365 else
366 inhibited_handlers = Qnil;
367
368 for (chain = Vfile_name_handler_alist; CONSP (chain);
369 chain = XCDR (chain))
370 {
371 Lisp_Object elt;
372 elt = XCAR (chain);
373 if (CONSP (elt))
374 {
375 Lisp_Object string = XCAR (elt);
376 int match_pos;
377 Lisp_Object handler = XCDR (elt);
378 Lisp_Object operations = Qnil;
379
380 if (SYMBOLP (handler))
381 operations = Fget (handler, Qoperations);
382
383 if (STRINGP (string)
384 && (match_pos = fast_string_match (string, filename)) > pos
385 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
386 {
387 Lisp_Object tem;
388
389 handler = XCDR (elt);
390 tem = Fmemq (handler, inhibited_handlers);
391 if (NILP (tem))
392 {
393 result = handler;
394 pos = match_pos;
395 }
396 }
397 }
398
399 QUIT;
400 }
401 return result;
402 }
403 \f
404 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
405 1, 1, 0,
406 doc: /* Return the directory component in file name FILENAME.
407 Return nil if FILENAME does not include a directory.
408 Otherwise return a directory spec.
409 Given a Unix syntax file name, returns a string ending in slash;
410 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
411 (filename)
412 Lisp_Object filename;
413 {
414 #ifndef DOS_NT
415 register const unsigned char *beg;
416 #else
417 register unsigned char *beg;
418 #endif
419 register const unsigned char *p;
420 Lisp_Object handler;
421
422 CHECK_STRING (filename);
423
424 /* If the file name has special constructs in it,
425 call the corresponding file handler. */
426 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
427 if (!NILP (handler))
428 return call2 (handler, Qfile_name_directory, filename);
429
430 filename = FILE_SYSTEM_CASE (filename);
431 beg = SDATA (filename);
432 #ifdef DOS_NT
433 beg = strcpy (alloca (strlen (beg) + 1), beg);
434 #endif
435 p = beg + SBYTES (filename);
436
437 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
438 #ifdef VMS
439 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
440 #endif /* VMS */
441 #ifdef DOS_NT
442 /* only recognise drive specifier at the beginning */
443 && !(p[-1] == ':'
444 /* handle the "/:d:foo" and "/:foo" cases correctly */
445 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
446 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
447 #endif
448 ) p--;
449
450 if (p == beg)
451 return Qnil;
452 #ifdef DOS_NT
453 /* Expansion of "c:" to drive and default directory. */
454 if (p[-1] == ':')
455 {
456 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
457 unsigned char *res = alloca (MAXPATHLEN + 1);
458 unsigned char *r = res;
459
460 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
461 {
462 strncpy (res, beg, 2);
463 beg += 2;
464 r += 2;
465 }
466
467 if (getdefdir (toupper (*beg) - 'A' + 1, r))
468 {
469 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
470 strcat (res, "/");
471 beg = res;
472 p = beg + strlen (beg);
473 }
474 }
475 CORRECT_DIR_SEPS (beg);
476 #endif /* DOS_NT */
477
478 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
479 }
480
481 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
482 Sfile_name_nondirectory, 1, 1, 0,
483 doc: /* Return file name FILENAME sans its directory.
484 For example, in a Unix-syntax file name,
485 this is everything after the last slash,
486 or the entire name if it contains no slash. */)
487 (filename)
488 Lisp_Object filename;
489 {
490 register const unsigned char *beg, *p, *end;
491 Lisp_Object handler;
492
493 CHECK_STRING (filename);
494
495 /* If the file name has special constructs in it,
496 call the corresponding file handler. */
497 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
498 if (!NILP (handler))
499 return call2 (handler, Qfile_name_nondirectory, filename);
500
501 beg = SDATA (filename);
502 end = p = beg + SBYTES (filename);
503
504 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
505 #ifdef VMS
506 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
507 #endif /* VMS */
508 #ifdef DOS_NT
509 /* only recognise drive specifier at beginning */
510 && !(p[-1] == ':'
511 /* handle the "/:d:foo" case correctly */
512 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
513 #endif
514 )
515 p--;
516
517 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
518 }
519
520 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
521 Sunhandled_file_name_directory, 1, 1, 0,
522 doc: /* Return a directly usable directory name somehow associated with FILENAME.
523 A `directly usable' directory name is one that may be used without the
524 intervention of any file handler.
525 If FILENAME is a directly usable file itself, return
526 \(file-name-directory FILENAME).
527 The `call-process' and `start-process' functions use this function to
528 get a current directory to run processes in. */)
529 (filename)
530 Lisp_Object filename;
531 {
532 Lisp_Object handler;
533
534 /* If the file name has special constructs in it,
535 call the corresponding file handler. */
536 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
537 if (!NILP (handler))
538 return call2 (handler, Qunhandled_file_name_directory, filename);
539
540 return Ffile_name_directory (filename);
541 }
542
543 \f
544 char *
545 file_name_as_directory (out, in)
546 char *out, *in;
547 {
548 int size = strlen (in) - 1;
549
550 strcpy (out, in);
551
552 if (size < 0)
553 {
554 out[0] = '.';
555 out[1] = '/';
556 out[2] = 0;
557 return out;
558 }
559
560 #ifdef VMS
561 /* Is it already a directory string? */
562 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
563 return out;
564 /* Is it a VMS directory file name? If so, hack VMS syntax. */
565 else if (! index (in, '/')
566 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
567 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
568 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
569 || ! strncmp (&in[size - 5], ".dir", 4))
570 && (in[size - 1] == '.' || in[size - 1] == ';')
571 && in[size] == '1')))
572 {
573 register char *p, *dot;
574 char brack;
575
576 /* x.dir -> [.x]
577 dir:x.dir --> dir:[x]
578 dir:[x]y.dir --> dir:[x.y] */
579 p = in + size;
580 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
581 if (p != in)
582 {
583 strncpy (out, in, p - in);
584 out[p - in] = '\0';
585 if (*p == ':')
586 {
587 brack = ']';
588 strcat (out, ":[");
589 }
590 else
591 {
592 brack = *p;
593 strcat (out, ".");
594 }
595 p++;
596 }
597 else
598 {
599 brack = ']';
600 strcpy (out, "[.");
601 }
602 dot = index (p, '.');
603 if (dot)
604 {
605 /* blindly remove any extension */
606 size = strlen (out) + (dot - p);
607 strncat (out, p, dot - p);
608 }
609 else
610 {
611 strcat (out, p);
612 size = strlen (out);
613 }
614 out[size++] = brack;
615 out[size] = '\0';
616 }
617 #else /* not VMS */
618 /* For Unix syntax, Append a slash if necessary */
619 if (!IS_DIRECTORY_SEP (out[size]))
620 {
621 /* Cannot use DIRECTORY_SEP, which could have any value */
622 out[size + 1] = '/';
623 out[size + 2] = '\0';
624 }
625 #ifdef DOS_NT
626 CORRECT_DIR_SEPS (out);
627 #endif
628 #endif /* not VMS */
629 return out;
630 }
631
632 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
633 Sfile_name_as_directory, 1, 1, 0,
634 doc: /* Return a string representing the file name FILE interpreted as a directory.
635 This operation exists because a directory is also a file, but its name as
636 a directory is different from its name as a file.
637 The result can be used as the value of `default-directory'
638 or passed as second argument to `expand-file-name'.
639 For a Unix-syntax file name, just appends a slash.
640 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
641 (file)
642 Lisp_Object file;
643 {
644 char *buf;
645 Lisp_Object handler;
646
647 CHECK_STRING (file);
648 if (NILP (file))
649 return Qnil;
650
651 /* If the file name has special constructs in it,
652 call the corresponding file handler. */
653 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
654 if (!NILP (handler))
655 return call2 (handler, Qfile_name_as_directory, file);
656
657 buf = (char *) alloca (SBYTES (file) + 10);
658 file_name_as_directory (buf, SDATA (file));
659 return make_specified_string (buf, -1, strlen (buf),
660 STRING_MULTIBYTE (file));
661 }
662 \f
663 /*
664 * Convert from directory name to filename.
665 * On VMS:
666 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
667 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
668 * On UNIX, it's simple: just make sure there isn't a terminating /
669
670 * Value is nonzero if the string output is different from the input.
671 */
672
673 int
674 directory_file_name (src, dst)
675 char *src, *dst;
676 {
677 long slen;
678 #ifdef VMS
679 long rlen;
680 char * ptr, * rptr;
681 char bracket;
682 struct FAB fab = cc$rms_fab;
683 struct NAM nam = cc$rms_nam;
684 char esa[NAM$C_MAXRSS];
685 #endif /* VMS */
686
687 slen = strlen (src);
688 #ifdef VMS
689 if (! index (src, '/')
690 && (src[slen - 1] == ']'
691 || src[slen - 1] == ':'
692 || src[slen - 1] == '>'))
693 {
694 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
695 fab.fab$l_fna = src;
696 fab.fab$b_fns = slen;
697 fab.fab$l_nam = &nam;
698 fab.fab$l_fop = FAB$M_NAM;
699
700 nam.nam$l_esa = esa;
701 nam.nam$b_ess = sizeof esa;
702 nam.nam$b_nop |= NAM$M_SYNCHK;
703
704 /* We call SYS$PARSE to handle such things as [--] for us. */
705 if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
706 {
707 slen = nam.nam$b_esl;
708 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
709 slen -= 2;
710 esa[slen] = '\0';
711 src = esa;
712 }
713 if (src[slen - 1] != ']' && src[slen - 1] != '>')
714 {
715 /* what about when we have logical_name:???? */
716 if (src[slen - 1] == ':')
717 { /* Xlate logical name and see what we get */
718 ptr = strcpy (dst, src); /* upper case for getenv */
719 while (*ptr)
720 {
721 if ('a' <= *ptr && *ptr <= 'z')
722 *ptr -= 040;
723 ptr++;
724 }
725 dst[slen - 1] = 0; /* remove colon */
726 if (!(src = egetenv (dst)))
727 return 0;
728 /* should we jump to the beginning of this procedure?
729 Good points: allows us to use logical names that xlate
730 to Unix names,
731 Bad points: can be a problem if we just translated to a device
732 name...
733 For now, I'll punt and always expect VMS names, and hope for
734 the best! */
735 slen = strlen (src);
736 if (src[slen - 1] != ']' && src[slen - 1] != '>')
737 { /* no recursion here! */
738 strcpy (dst, src);
739 return 0;
740 }
741 }
742 else
743 { /* not a directory spec */
744 strcpy (dst, src);
745 return 0;
746 }
747 }
748 bracket = src[slen - 1];
749
750 /* If bracket is ']' or '>', bracket - 2 is the corresponding
751 opening bracket. */
752 ptr = index (src, bracket - 2);
753 if (ptr == 0)
754 { /* no opening bracket */
755 strcpy (dst, src);
756 return 0;
757 }
758 if (!(rptr = rindex (src, '.')))
759 rptr = ptr;
760 slen = rptr - src;
761 strncpy (dst, src, slen);
762 dst[slen] = '\0';
763 if (*rptr == '.')
764 {
765 dst[slen++] = bracket;
766 dst[slen] = '\0';
767 }
768 else
769 {
770 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
771 then translate the device and recurse. */
772 if (dst[slen - 1] == ':'
773 && dst[slen - 2] != ':' /* skip decnet nodes */
774 && strcmp (src + slen, "[000000]") == 0)
775 {
776 dst[slen - 1] = '\0';
777 if ((ptr = egetenv (dst))
778 && (rlen = strlen (ptr) - 1) > 0
779 && (ptr[rlen] == ']' || ptr[rlen] == '>')
780 && ptr[rlen - 1] == '.')
781 {
782 char * buf = (char *) alloca (strlen (ptr) + 1);
783 strcpy (buf, ptr);
784 buf[rlen - 1] = ']';
785 buf[rlen] = '\0';
786 return directory_file_name (buf, dst);
787 }
788 else
789 dst[slen - 1] = ':';
790 }
791 strcat (dst, "[000000]");
792 slen += 8;
793 }
794 rptr++;
795 rlen = strlen (rptr) - 1;
796 strncat (dst, rptr, rlen);
797 dst[slen + rlen] = '\0';
798 strcat (dst, ".DIR.1");
799 return 1;
800 }
801 #endif /* VMS */
802 /* Process as Unix format: just remove any final slash.
803 But leave "/" unchanged; do not change it to "". */
804 strcpy (dst, src);
805 #ifdef APOLLO
806 /* Handle // as root for apollo's. */
807 if ((slen > 2 && dst[slen - 1] == '/')
808 || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
809 dst[slen - 1] = 0;
810 #else
811 if (slen > 1
812 && IS_DIRECTORY_SEP (dst[slen - 1])
813 #ifdef DOS_NT
814 && !IS_ANY_SEP (dst[slen - 2])
815 #endif
816 )
817 dst[slen - 1] = 0;
818 #endif
819 #ifdef DOS_NT
820 CORRECT_DIR_SEPS (dst);
821 #endif
822 return 1;
823 }
824
825 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
826 1, 1, 0,
827 doc: /* Returns the file name of the directory named DIRECTORY.
828 This is the name of the file that holds the data for the directory DIRECTORY.
829 This operation exists because a directory is also a file, but its name as
830 a directory is different from its name as a file.
831 In Unix-syntax, this function just removes the final slash.
832 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
833 it returns a file name such as \"[X]Y.DIR.1\". */)
834 (directory)
835 Lisp_Object directory;
836 {
837 char *buf;
838 Lisp_Object handler;
839
840 CHECK_STRING (directory);
841
842 if (NILP (directory))
843 return Qnil;
844
845 /* If the file name has special constructs in it,
846 call the corresponding file handler. */
847 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
848 if (!NILP (handler))
849 return call2 (handler, Qdirectory_file_name, directory);
850
851 #ifdef VMS
852 /* 20 extra chars is insufficient for VMS, since we might perform a
853 logical name translation. an equivalence string can be up to 255
854 chars long, so grab that much extra space... - sss */
855 buf = (char *) alloca (SBYTES (directory) + 20 + 255);
856 #else
857 buf = (char *) alloca (SBYTES (directory) + 20);
858 #endif
859 directory_file_name (SDATA (directory), buf);
860 return make_specified_string (buf, -1, strlen (buf),
861 STRING_MULTIBYTE (directory));
862 }
863
864 static char make_temp_name_tbl[64] =
865 {
866 'A','B','C','D','E','F','G','H',
867 'I','J','K','L','M','N','O','P',
868 'Q','R','S','T','U','V','W','X',
869 'Y','Z','a','b','c','d','e','f',
870 'g','h','i','j','k','l','m','n',
871 'o','p','q','r','s','t','u','v',
872 'w','x','y','z','0','1','2','3',
873 '4','5','6','7','8','9','-','_'
874 };
875
876 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
877
878 /* Value is a temporary file name starting with PREFIX, a string.
879
880 The Emacs process number forms part of the result, so there is
881 no danger of generating a name being used by another process.
882 In addition, this function makes an attempt to choose a name
883 which has no existing file. To make this work, PREFIX should be
884 an absolute file name.
885
886 BASE64_P non-zero means add the pid as 3 characters in base64
887 encoding. In this case, 6 characters will be added to PREFIX to
888 form the file name. Otherwise, if Emacs is running on a system
889 with long file names, add the pid as a decimal number.
890
891 This function signals an error if no unique file name could be
892 generated. */
893
894 Lisp_Object
895 make_temp_name (prefix, base64_p)
896 Lisp_Object prefix;
897 int base64_p;
898 {
899 Lisp_Object val;
900 int len, clen;
901 int pid;
902 unsigned char *p, *data;
903 char pidbuf[20];
904 int pidlen;
905
906 CHECK_STRING (prefix);
907
908 /* VAL is created by adding 6 characters to PREFIX. The first
909 three are the PID of this process, in base 64, and the second
910 three are incremented if the file already exists. This ensures
911 262144 unique file names per PID per PREFIX. */
912
913 pid = (int) getpid ();
914
915 if (base64_p)
916 {
917 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
918 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
919 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
920 pidlen = 3;
921 }
922 else
923 {
924 #ifdef HAVE_LONG_FILE_NAMES
925 sprintf (pidbuf, "%d", pid);
926 pidlen = strlen (pidbuf);
927 #else
928 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
929 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
930 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
931 pidlen = 3;
932 #endif
933 }
934
935 len = SBYTES (prefix); clen = SCHARS (prefix);
936 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
937 if (!STRING_MULTIBYTE (prefix))
938 STRING_SET_UNIBYTE (val);
939 data = SDATA (val);
940 bcopy(SDATA (prefix), data, len);
941 p = data + len;
942
943 bcopy (pidbuf, p, pidlen);
944 p += pidlen;
945
946 /* Here we try to minimize useless stat'ing when this function is
947 invoked many times successively with the same PREFIX. We achieve
948 this by initializing count to a random value, and incrementing it
949 afterwards.
950
951 We don't want make-temp-name to be called while dumping,
952 because then make_temp_name_count_initialized_p would get set
953 and then make_temp_name_count would not be set when Emacs starts. */
954
955 if (!make_temp_name_count_initialized_p)
956 {
957 make_temp_name_count = (unsigned) time (NULL);
958 make_temp_name_count_initialized_p = 1;
959 }
960
961 while (1)
962 {
963 struct stat ignored;
964 unsigned num = make_temp_name_count;
965
966 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
967 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
968 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
969
970 /* Poor man's congruential RN generator. Replace with
971 ++make_temp_name_count for debugging. */
972 make_temp_name_count += 25229;
973 make_temp_name_count %= 225307;
974
975 if (stat (data, &ignored) < 0)
976 {
977 /* We want to return only if errno is ENOENT. */
978 if (errno == ENOENT)
979 return val;
980 else
981 /* The error here is dubious, but there is little else we
982 can do. The alternatives are to return nil, which is
983 as bad as (and in many cases worse than) throwing the
984 error, or to ignore the error, which will likely result
985 in looping through 225307 stat's, which is not only
986 dog-slow, but also useless since it will fallback to
987 the errow below, anyway. */
988 report_file_error ("Cannot create temporary name for prefix",
989 Fcons (prefix, Qnil));
990 /* not reached */
991 }
992 }
993
994 error ("Cannot create temporary name for prefix `%s'",
995 SDATA (prefix));
996 return Qnil;
997 }
998
999
1000 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1001 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
1002 The Emacs process number forms part of the result,
1003 so there is no danger of generating a name being used by another process.
1004
1005 In addition, this function makes an attempt to choose a name
1006 which has no existing file. To make this work,
1007 PREFIX should be an absolute file name.
1008
1009 There is a race condition between calling `make-temp-name' and creating the
1010 file which opens all kinds of security holes. For that reason, you should
1011 probably use `make-temp-file' instead, except in three circumstances:
1012
1013 * If you are creating the file in the user's home directory.
1014 * If you are creating a directory rather than an ordinary file.
1015 * If you are taking special precautions as `make-temp-file' does. */)
1016 (prefix)
1017 Lisp_Object prefix;
1018 {
1019 return make_temp_name (prefix, 0);
1020 }
1021
1022
1023 \f
1024 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1025 doc: /* Convert filename NAME to absolute, and canonicalize it.
1026 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1027 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1028 the current buffer's value of `default-directory' is used.
1029 File name components that are `.' are removed, and
1030 so are file name components followed by `..', along with the `..' itself;
1031 note that these simplifications are done without checking the resulting
1032 file names in the file system.
1033 An initial `~/' expands to your home directory.
1034 An initial `~USER/' expands to USER's home directory.
1035 See also the function `substitute-in-file-name'. */)
1036 (name, default_directory)
1037 Lisp_Object name, default_directory;
1038 {
1039 unsigned char *nm;
1040
1041 register unsigned char *newdir, *p, *o;
1042 int tlen;
1043 unsigned char *target;
1044 struct passwd *pw;
1045 #ifdef VMS
1046 unsigned char * colon = 0;
1047 unsigned char * close = 0;
1048 unsigned char * slash = 0;
1049 unsigned char * brack = 0;
1050 int lbrack = 0, rbrack = 0;
1051 int dots = 0;
1052 #endif /* VMS */
1053 #ifdef DOS_NT
1054 int drive = 0;
1055 int collapse_newdir = 1;
1056 int is_escaped = 0;
1057 #endif /* DOS_NT */
1058 int length;
1059 Lisp_Object handler, result;
1060
1061 CHECK_STRING (name);
1062
1063 /* If the file name has special constructs in it,
1064 call the corresponding file handler. */
1065 handler = Ffind_file_name_handler (name, Qexpand_file_name);
1066 if (!NILP (handler))
1067 return call3 (handler, Qexpand_file_name, name, default_directory);
1068
1069 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1070 if (NILP (default_directory))
1071 default_directory = current_buffer->directory;
1072 if (! STRINGP (default_directory))
1073 {
1074 #ifdef DOS_NT
1075 /* "/" is not considered a root directory on DOS_NT, so using "/"
1076 here causes an infinite recursion in, e.g., the following:
1077
1078 (let (default-directory)
1079 (expand-file-name "a"))
1080
1081 To avoid this, we set default_directory to the root of the
1082 current drive. */
1083 extern char *emacs_root_dir (void);
1084
1085 default_directory = build_string (emacs_root_dir ());
1086 #else
1087 default_directory = build_string ("/");
1088 #endif
1089 }
1090
1091 if (!NILP (default_directory))
1092 {
1093 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1094 if (!NILP (handler))
1095 return call3 (handler, Qexpand_file_name, name, default_directory);
1096 }
1097
1098 o = SDATA (default_directory);
1099
1100 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1101 It would be better to do this down below where we actually use
1102 default_directory. Unfortunately, calling Fexpand_file_name recursively
1103 could invoke GC, and the strings might be relocated. This would
1104 be annoying because we have pointers into strings lying around
1105 that would need adjusting, and people would add new pointers to
1106 the code and forget to adjust them, resulting in intermittent bugs.
1107 Putting this call here avoids all that crud.
1108
1109 The EQ test avoids infinite recursion. */
1110 if (! NILP (default_directory) && !EQ (default_directory, name)
1111 /* Save time in some common cases - as long as default_directory
1112 is not relative, it can be canonicalized with name below (if it
1113 is needed at all) without requiring it to be expanded now. */
1114 #ifdef DOS_NT
1115 /* Detect MSDOS file names with drive specifiers. */
1116 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1117 #ifdef WINDOWSNT
1118 /* Detect Windows file names in UNC format. */
1119 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1120 #endif
1121 #else /* not DOS_NT */
1122 /* Detect Unix absolute file names (/... alone is not absolute on
1123 DOS or Windows). */
1124 && ! (IS_DIRECTORY_SEP (o[0]))
1125 #endif /* not DOS_NT */
1126 )
1127 {
1128 struct gcpro gcpro1;
1129
1130 GCPRO1 (name);
1131 default_directory = Fexpand_file_name (default_directory, Qnil);
1132 UNGCPRO;
1133 }
1134
1135 name = FILE_SYSTEM_CASE (name);
1136 nm = SDATA (name);
1137
1138 #ifdef DOS_NT
1139 /* We will force directory separators to be either all \ or /, so make
1140 a local copy to modify, even if there ends up being no change. */
1141 nm = strcpy (alloca (strlen (nm) + 1), nm);
1142
1143 /* Note if special escape prefix is present, but remove for now. */
1144 if (nm[0] == '/' && nm[1] == ':')
1145 {
1146 is_escaped = 1;
1147 nm += 2;
1148 }
1149
1150 /* Find and remove drive specifier if present; this makes nm absolute
1151 even if the rest of the name appears to be relative. Only look for
1152 drive specifier at the beginning. */
1153 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
1154 {
1155 drive = nm[0];
1156 nm += 2;
1157 }
1158
1159 #ifdef WINDOWSNT
1160 /* If we see "c://somedir", we want to strip the first slash after the
1161 colon when stripping the drive letter. Otherwise, this expands to
1162 "//somedir". */
1163 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1164 nm++;
1165 #endif /* WINDOWSNT */
1166 #endif /* DOS_NT */
1167
1168 #ifdef WINDOWSNT
1169 /* Discard any previous drive specifier if nm is now in UNC format. */
1170 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1171 {
1172 drive = 0;
1173 }
1174 #endif
1175
1176 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1177 none are found, we can probably return right away. We will avoid
1178 allocating a new string if name is already fully expanded. */
1179 if (
1180 IS_DIRECTORY_SEP (nm[0])
1181 #ifdef MSDOS
1182 && drive && !is_escaped
1183 #endif
1184 #ifdef WINDOWSNT
1185 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1186 #endif
1187 #ifdef VMS
1188 || index (nm, ':')
1189 #endif /* VMS */
1190 )
1191 {
1192 /* If it turns out that the filename we want to return is just a
1193 suffix of FILENAME, we don't need to go through and edit
1194 things; we just need to construct a new string using data
1195 starting at the middle of FILENAME. If we set lose to a
1196 non-zero value, that means we've discovered that we can't do
1197 that cool trick. */
1198 int lose = 0;
1199
1200 p = nm;
1201 while (*p)
1202 {
1203 /* Since we know the name is absolute, we can assume that each
1204 element starts with a "/". */
1205
1206 /* "." and ".." are hairy. */
1207 if (IS_DIRECTORY_SEP (p[0])
1208 && p[1] == '.'
1209 && (IS_DIRECTORY_SEP (p[2])
1210 || p[2] == 0
1211 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1212 || p[3] == 0))))
1213 lose = 1;
1214 /* We want to replace multiple `/' in a row with a single
1215 slash. */
1216 else if (p > nm
1217 && IS_DIRECTORY_SEP (p[0])
1218 && IS_DIRECTORY_SEP (p[1]))
1219 lose = 1;
1220
1221 #ifdef VMS
1222 if (p[0] == '\\')
1223 lose = 1;
1224 if (p[0] == '/') {
1225 /* if dev:[dir]/, move nm to / */
1226 if (!slash && p > nm && (brack || colon)) {
1227 nm = (brack ? brack + 1 : colon + 1);
1228 lbrack = rbrack = 0;
1229 brack = 0;
1230 colon = 0;
1231 }
1232 slash = p;
1233 }
1234 if (p[0] == '-')
1235 #ifdef NO_HYPHENS_IN_FILENAMES
1236 if (lbrack == rbrack)
1237 {
1238 /* Avoid clobbering negative version numbers. */
1239 if (dots < 2)
1240 p[0] = '_';
1241 }
1242 else
1243 #endif /* NO_HYPHENS_IN_FILENAMES */
1244 if (lbrack > rbrack &&
1245 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1246 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1247 lose = 1;
1248 #ifdef NO_HYPHENS_IN_FILENAMES
1249 else
1250 p[0] = '_';
1251 #endif /* NO_HYPHENS_IN_FILENAMES */
1252 /* count open brackets, reset close bracket pointer */
1253 if (p[0] == '[' || p[0] == '<')
1254 lbrack++, brack = 0;
1255 /* count close brackets, set close bracket pointer */
1256 if (p[0] == ']' || p[0] == '>')
1257 rbrack++, brack = p;
1258 /* detect ][ or >< */
1259 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1260 lose = 1;
1261 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1262 nm = p + 1, lose = 1;
1263 if (p[0] == ':' && (colon || slash))
1264 /* if dev1:[dir]dev2:, move nm to dev2: */
1265 if (brack)
1266 {
1267 nm = brack + 1;
1268 brack = 0;
1269 }
1270 /* if /name/dev:, move nm to dev: */
1271 else if (slash)
1272 nm = slash + 1;
1273 /* if node::dev:, move colon following dev */
1274 else if (colon && colon[-1] == ':')
1275 colon = p;
1276 /* if dev1:dev2:, move nm to dev2: */
1277 else if (colon && colon[-1] != ':')
1278 {
1279 nm = colon + 1;
1280 colon = 0;
1281 }
1282 if (p[0] == ':' && !colon)
1283 {
1284 if (p[1] == ':')
1285 p++;
1286 colon = p;
1287 }
1288 if (lbrack == rbrack)
1289 if (p[0] == ';')
1290 dots = 2;
1291 else if (p[0] == '.')
1292 dots++;
1293 #endif /* VMS */
1294 p++;
1295 }
1296 if (!lose)
1297 {
1298 #ifdef VMS
1299 if (index (nm, '/'))
1300 {
1301 nm = sys_translate_unix (nm);
1302 return make_specified_string (nm, -1, strlen (nm),
1303 STRING_MULTIBYTE (name));
1304 }
1305 #endif /* VMS */
1306 #ifdef DOS_NT
1307 /* Make sure directories are all separated with / or \ as
1308 desired, but avoid allocation of a new string when not
1309 required. */
1310 CORRECT_DIR_SEPS (nm);
1311 #ifdef WINDOWSNT
1312 if (IS_DIRECTORY_SEP (nm[1]))
1313 {
1314 if (strcmp (nm, SDATA (name)) != 0)
1315 name = make_specified_string (nm, -1, strlen (nm),
1316 STRING_MULTIBYTE (name));
1317 }
1318 else
1319 #endif
1320 /* drive must be set, so this is okay */
1321 if (strcmp (nm - 2, SDATA (name)) != 0)
1322 {
1323 char temp[] = " :";
1324
1325 name = make_specified_string (nm, -1, p - nm,
1326 STRING_MULTIBYTE (name));
1327 temp[0] = DRIVE_LETTER (drive);
1328 name = concat2 (build_string (temp), name);
1329 }
1330 return name;
1331 #else /* not DOS_NT */
1332 if (nm == SDATA (name))
1333 return name;
1334 return make_specified_string (nm, -1, strlen (nm),
1335 STRING_MULTIBYTE (name));
1336 #endif /* not DOS_NT */
1337 }
1338 }
1339
1340 /* At this point, nm might or might not be an absolute file name. We
1341 need to expand ~ or ~user if present, otherwise prefix nm with
1342 default_directory if nm is not absolute, and finally collapse /./
1343 and /foo/../ sequences.
1344
1345 We set newdir to be the appropriate prefix if one is needed:
1346 - the relevant user directory if nm starts with ~ or ~user
1347 - the specified drive's working dir (DOS/NT only) if nm does not
1348 start with /
1349 - the value of default_directory.
1350
1351 Note that these prefixes are not guaranteed to be absolute (except
1352 for the working dir of a drive). Therefore, to ensure we always
1353 return an absolute name, if the final prefix is not absolute we
1354 append it to the current working directory. */
1355
1356 newdir = 0;
1357
1358 if (nm[0] == '~') /* prefix ~ */
1359 {
1360 if (IS_DIRECTORY_SEP (nm[1])
1361 #ifdef VMS
1362 || nm[1] == ':'
1363 #endif /* VMS */
1364 || nm[1] == 0) /* ~ by itself */
1365 {
1366 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1367 newdir = (unsigned char *) "";
1368 nm++;
1369 #ifdef DOS_NT
1370 collapse_newdir = 0;
1371 #endif
1372 #ifdef VMS
1373 nm++; /* Don't leave the slash in nm. */
1374 #endif /* VMS */
1375 }
1376 else /* ~user/filename */
1377 {
1378 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
1379 #ifdef VMS
1380 && *p != ':'
1381 #endif /* VMS */
1382 ); p++);
1383 o = (unsigned char *) alloca (p - nm + 1);
1384 bcopy ((char *) nm, o, p - nm);
1385 o [p - nm] = 0;
1386
1387 pw = (struct passwd *) getpwnam (o + 1);
1388 if (pw)
1389 {
1390 newdir = (unsigned char *) pw -> pw_dir;
1391 #ifdef VMS
1392 nm = p + 1; /* skip the terminator */
1393 #else
1394 nm = p;
1395 #ifdef DOS_NT
1396 collapse_newdir = 0;
1397 #endif
1398 #endif /* VMS */
1399 }
1400
1401 /* If we don't find a user of that name, leave the name
1402 unchanged; don't move nm forward to p. */
1403 }
1404 }
1405
1406 #ifdef DOS_NT
1407 /* On DOS and Windows, nm is absolute if a drive name was specified;
1408 use the drive's current directory as the prefix if needed. */
1409 if (!newdir && drive)
1410 {
1411 /* Get default directory if needed to make nm absolute. */
1412 if (!IS_DIRECTORY_SEP (nm[0]))
1413 {
1414 newdir = alloca (MAXPATHLEN + 1);
1415 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1416 newdir = NULL;
1417 }
1418 if (!newdir)
1419 {
1420 /* Either nm starts with /, or drive isn't mounted. */
1421 newdir = alloca (4);
1422 newdir[0] = DRIVE_LETTER (drive);
1423 newdir[1] = ':';
1424 newdir[2] = '/';
1425 newdir[3] = 0;
1426 }
1427 }
1428 #endif /* DOS_NT */
1429
1430 /* Finally, if no prefix has been specified and nm is not absolute,
1431 then it must be expanded relative to default_directory. */
1432
1433 if (1
1434 #ifndef DOS_NT
1435 /* /... alone is not absolute on DOS and Windows. */
1436 && !IS_DIRECTORY_SEP (nm[0])
1437 #endif
1438 #ifdef WINDOWSNT
1439 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1440 #endif
1441 #ifdef VMS
1442 && !index (nm, ':')
1443 #endif
1444 && !newdir)
1445 {
1446 newdir = SDATA (default_directory);
1447 #ifdef DOS_NT
1448 /* Note if special escape prefix is present, but remove for now. */
1449 if (newdir[0] == '/' && newdir[1] == ':')
1450 {
1451 is_escaped = 1;
1452 newdir += 2;
1453 }
1454 #endif
1455 }
1456
1457 #ifdef DOS_NT
1458 if (newdir)
1459 {
1460 /* First ensure newdir is an absolute name. */
1461 if (
1462 /* Detect MSDOS file names with drive specifiers. */
1463 ! (IS_DRIVE (newdir[0])
1464 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1465 #ifdef WINDOWSNT
1466 /* Detect Windows file names in UNC format. */
1467 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1468 #endif
1469 )
1470 {
1471 /* Effectively, let newdir be (expand-file-name newdir cwd).
1472 Because of the admonition against calling expand-file-name
1473 when we have pointers into lisp strings, we accomplish this
1474 indirectly by prepending newdir to nm if necessary, and using
1475 cwd (or the wd of newdir's drive) as the new newdir. */
1476
1477 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1478 {
1479 drive = newdir[0];
1480 newdir += 2;
1481 }
1482 if (!IS_DIRECTORY_SEP (nm[0]))
1483 {
1484 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1485 file_name_as_directory (tmp, newdir);
1486 strcat (tmp, nm);
1487 nm = tmp;
1488 }
1489 newdir = alloca (MAXPATHLEN + 1);
1490 if (drive)
1491 {
1492 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1493 newdir = "/";
1494 }
1495 else
1496 getwd (newdir);
1497 }
1498
1499 /* Strip off drive name from prefix, if present. */
1500 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1501 {
1502 drive = newdir[0];
1503 newdir += 2;
1504 }
1505
1506 /* Keep only a prefix from newdir if nm starts with slash
1507 (//server/share for UNC, nothing otherwise). */
1508 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1509 {
1510 #ifdef WINDOWSNT
1511 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1512 {
1513 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1514 p = newdir + 2;
1515 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1516 p++;
1517 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1518 *p = 0;
1519 }
1520 else
1521 #endif
1522 newdir = "";
1523 }
1524 }
1525 #endif /* DOS_NT */
1526
1527 if (newdir)
1528 {
1529 /* Get rid of any slash at the end of newdir, unless newdir is
1530 just / or // (an incomplete UNC name). */
1531 length = strlen (newdir);
1532 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1533 #ifdef WINDOWSNT
1534 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1535 #endif
1536 )
1537 {
1538 unsigned char *temp = (unsigned char *) alloca (length);
1539 bcopy (newdir, temp, length - 1);
1540 temp[length - 1] = 0;
1541 newdir = temp;
1542 }
1543 tlen = length + 1;
1544 }
1545 else
1546 tlen = 0;
1547
1548 /* Now concatenate the directory and name to new space in the stack frame */
1549 tlen += strlen (nm) + 1;
1550 #ifdef DOS_NT
1551 /* Reserve space for drive specifier and escape prefix, since either
1552 or both may need to be inserted. (The Microsoft x86 compiler
1553 produces incorrect code if the following two lines are combined.) */
1554 target = (unsigned char *) alloca (tlen + 4);
1555 target += 4;
1556 #else /* not DOS_NT */
1557 target = (unsigned char *) alloca (tlen);
1558 #endif /* not DOS_NT */
1559 *target = 0;
1560
1561 if (newdir)
1562 {
1563 #ifndef VMS
1564 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1565 {
1566 #ifdef DOS_NT
1567 /* If newdir is effectively "C:/", then the drive letter will have
1568 been stripped and newdir will be "/". Concatenating with an
1569 absolute directory in nm produces "//", which will then be
1570 incorrectly treated as a network share. Ignore newdir in
1571 this case (keeping the drive letter). */
1572 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1573 && newdir[1] == '\0'))
1574 #endif
1575 strcpy (target, newdir);
1576 }
1577 else
1578 #endif
1579 file_name_as_directory (target, newdir);
1580 }
1581
1582 strcat (target, nm);
1583 #ifdef VMS
1584 if (index (target, '/'))
1585 strcpy (target, sys_translate_unix (target));
1586 #endif /* VMS */
1587
1588 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1589
1590 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1591 appear. */
1592
1593 p = target;
1594 o = target;
1595
1596 while (*p)
1597 {
1598 #ifdef VMS
1599 if (*p != ']' && *p != '>' && *p != '-')
1600 {
1601 if (*p == '\\')
1602 p++;
1603 *o++ = *p++;
1604 }
1605 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1606 /* brackets are offset from each other by 2 */
1607 {
1608 p += 2;
1609 if (*p != '.' && *p != '-' && o[-1] != '.')
1610 /* convert [foo][bar] to [bar] */
1611 while (o[-1] != '[' && o[-1] != '<')
1612 o--;
1613 else if (*p == '-' && *o != '.')
1614 *--p = '.';
1615 }
1616 else if (p[0] == '-' && o[-1] == '.' &&
1617 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1618 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1619 {
1620 do
1621 o--;
1622 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1623 if (p[1] == '.') /* foo.-.bar ==> bar. */
1624 p += 2;
1625 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1626 p++, o--;
1627 /* else [foo.-] ==> [-] */
1628 }
1629 else
1630 {
1631 #ifdef NO_HYPHENS_IN_FILENAMES
1632 if (*p == '-' &&
1633 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1634 p[1] != ']' && p[1] != '>' && p[1] != '.')
1635 *p = '_';
1636 #endif /* NO_HYPHENS_IN_FILENAMES */
1637 *o++ = *p++;
1638 }
1639 #else /* not VMS */
1640 if (!IS_DIRECTORY_SEP (*p))
1641 {
1642 *o++ = *p++;
1643 }
1644 else if (IS_DIRECTORY_SEP (p[0])
1645 && p[1] == '.'
1646 && (IS_DIRECTORY_SEP (p[2])
1647 || p[2] == 0))
1648 {
1649 /* If "/." is the entire filename, keep the "/". Otherwise,
1650 just delete the whole "/.". */
1651 if (o == target && p[2] == '\0')
1652 *o++ = *p;
1653 p += 2;
1654 }
1655 else if (IS_DIRECTORY_SEP (p[0]) && p[1] == '.' && p[2] == '.'
1656 /* `/../' is the "superroot" on certain file systems.
1657 Turned off on DOS_NT systems because they have no
1658 "superroot" and because this causes us to produce
1659 file names like "d:/../foo" which fail file-related
1660 functions of the underlying OS. (To reproduce, try a
1661 long series of "../../" in default_directory, longer
1662 than the number of levels from the root.) */
1663 #ifndef DOS_NT
1664 && o != target
1665 #endif
1666 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1667 {
1668 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1669 ;
1670 /* Keep initial / only if this is the whole name. */
1671 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1672 ++o;
1673 p += 3;
1674 }
1675 else if (p > target
1676 && IS_DIRECTORY_SEP (p[0]) && IS_DIRECTORY_SEP (p[1]))
1677 {
1678 /* Collapse multiple `/' in a row. */
1679 *o++ = *p++;
1680 while (IS_DIRECTORY_SEP (*p))
1681 ++p;
1682 }
1683 else
1684 {
1685 *o++ = *p++;
1686 }
1687 #endif /* not VMS */
1688 }
1689
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 */
1696 {
1697 if (!drive) abort ();
1698 target -= 2;
1699 target[0] = DRIVE_LETTER (drive);
1700 target[1] = ':';
1701 }
1702 /* Reinsert the escape prefix if required. */
1703 if (is_escaped)
1704 {
1705 target -= 2;
1706 target[0] = '/';
1707 target[1] = ':';
1708 }
1709 CORRECT_DIR_SEPS (target);
1710 #endif /* DOS_NT */
1711
1712 result = make_specified_string (target, -1, o - target,
1713 STRING_MULTIBYTE (name));
1714
1715 /* Again look to see if the file name has special constructs in it
1716 and perhaps call the corresponding file handler. This is needed
1717 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1718 the ".." component gives us "/user@host:/bar/../baz" which needs
1719 to be expanded again. */
1720 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1721 if (!NILP (handler))
1722 return call3 (handler, Qexpand_file_name, result, default_directory);
1723
1724 return result;
1725 }
1726
1727 #if 0
1728 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1729 This is the old version of expand-file-name, before it was thoroughly
1730 rewritten for Emacs 10.31. We leave this version here commented-out,
1731 because the code is very complex and likely to have subtle bugs. If
1732 bugs _are_ found, it might be of interest to look at the old code and
1733 see what did it do in the relevant situation.
1734
1735 Don't remove this code: it's true that it will be accessible via CVS,
1736 but a few years from deletion, people will forget it is there. */
1737
1738 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1739 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1740 "Convert FILENAME to absolute, and canonicalize it.\n\
1741 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1742 \(does not start with slash); if DEFAULT is nil or missing,\n\
1743 the current buffer's value of default-directory is used.\n\
1744 Filenames containing `.' or `..' as components are simplified;\n\
1745 initial `~/' expands to your home directory.\n\
1746 See also the function `substitute-in-file-name'.")
1747 (name, defalt)
1748 Lisp_Object name, defalt;
1749 {
1750 unsigned char *nm;
1751
1752 register unsigned char *newdir, *p, *o;
1753 int tlen;
1754 unsigned char *target;
1755 struct passwd *pw;
1756 int lose;
1757 #ifdef VMS
1758 unsigned char * colon = 0;
1759 unsigned char * close = 0;
1760 unsigned char * slash = 0;
1761 unsigned char * brack = 0;
1762 int lbrack = 0, rbrack = 0;
1763 int dots = 0;
1764 #endif /* VMS */
1765
1766 CHECK_STRING (name);
1767
1768 #ifdef VMS
1769 /* Filenames on VMS are always upper case. */
1770 name = Fupcase (name);
1771 #endif
1772
1773 nm = SDATA (name);
1774
1775 /* If nm is absolute, flush ...// and detect /./ and /../.
1776 If no /./ or /../ we can return right away. */
1777 if (
1778 nm[0] == '/'
1779 #ifdef VMS
1780 || index (nm, ':')
1781 #endif /* VMS */
1782 )
1783 {
1784 p = nm;
1785 lose = 0;
1786 while (*p)
1787 {
1788 if (p[0] == '/' && p[1] == '/'
1789 #ifdef APOLLO
1790 /* // at start of filename is meaningful on Apollo system. */
1791 && nm != p
1792 #endif /* APOLLO */
1793 )
1794 nm = p + 1;
1795 if (p[0] == '/' && p[1] == '~')
1796 nm = p + 1, lose = 1;
1797 if (p[0] == '/' && p[1] == '.'
1798 && (p[2] == '/' || p[2] == 0
1799 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1800 lose = 1;
1801 #ifdef VMS
1802 if (p[0] == '\\')
1803 lose = 1;
1804 if (p[0] == '/') {
1805 /* if dev:[dir]/, move nm to / */
1806 if (!slash && p > nm && (brack || colon)) {
1807 nm = (brack ? brack + 1 : colon + 1);
1808 lbrack = rbrack = 0;
1809 brack = 0;
1810 colon = 0;
1811 }
1812 slash = p;
1813 }
1814 if (p[0] == '-')
1815 #ifndef VMS4_4
1816 /* VMS pre V4.4,convert '-'s in filenames. */
1817 if (lbrack == rbrack)
1818 {
1819 if (dots < 2) /* this is to allow negative version numbers */
1820 p[0] = '_';
1821 }
1822 else
1823 #endif /* VMS4_4 */
1824 if (lbrack > rbrack &&
1825 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1826 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1827 lose = 1;
1828 #ifndef VMS4_4
1829 else
1830 p[0] = '_';
1831 #endif /* VMS4_4 */
1832 /* count open brackets, reset close bracket pointer */
1833 if (p[0] == '[' || p[0] == '<')
1834 lbrack++, brack = 0;
1835 /* count close brackets, set close bracket pointer */
1836 if (p[0] == ']' || p[0] == '>')
1837 rbrack++, brack = p;
1838 /* detect ][ or >< */
1839 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1840 lose = 1;
1841 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1842 nm = p + 1, lose = 1;
1843 if (p[0] == ':' && (colon || slash))
1844 /* if dev1:[dir]dev2:, move nm to dev2: */
1845 if (brack)
1846 {
1847 nm = brack + 1;
1848 brack = 0;
1849 }
1850 /* If /name/dev:, move nm to dev: */
1851 else if (slash)
1852 nm = slash + 1;
1853 /* If node::dev:, move colon following dev */
1854 else if (colon && colon[-1] == ':')
1855 colon = p;
1856 /* If dev1:dev2:, move nm to dev2: */
1857 else if (colon && colon[-1] != ':')
1858 {
1859 nm = colon + 1;
1860 colon = 0;
1861 }
1862 if (p[0] == ':' && !colon)
1863 {
1864 if (p[1] == ':')
1865 p++;
1866 colon = p;
1867 }
1868 if (lbrack == rbrack)
1869 if (p[0] == ';')
1870 dots = 2;
1871 else if (p[0] == '.')
1872 dots++;
1873 #endif /* VMS */
1874 p++;
1875 }
1876 if (!lose)
1877 {
1878 #ifdef VMS
1879 if (index (nm, '/'))
1880 return build_string (sys_translate_unix (nm));
1881 #endif /* VMS */
1882 if (nm == SDATA (name))
1883 return name;
1884 return build_string (nm);
1885 }
1886 }
1887
1888 /* Now determine directory to start with and put it in NEWDIR */
1889
1890 newdir = 0;
1891
1892 if (nm[0] == '~') /* prefix ~ */
1893 if (nm[1] == '/'
1894 #ifdef VMS
1895 || nm[1] == ':'
1896 #endif /* VMS */
1897 || nm[1] == 0)/* ~/filename */
1898 {
1899 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1900 newdir = (unsigned char *) "";
1901 nm++;
1902 #ifdef VMS
1903 nm++; /* Don't leave the slash in nm. */
1904 #endif /* VMS */
1905 }
1906 else /* ~user/filename */
1907 {
1908 /* Get past ~ to user */
1909 unsigned char *user = nm + 1;
1910 /* Find end of name. */
1911 unsigned char *ptr = (unsigned char *) index (user, '/');
1912 int len = ptr ? ptr - user : strlen (user);
1913 #ifdef VMS
1914 unsigned char *ptr1 = index (user, ':');
1915 if (ptr1 != 0 && ptr1 - user < len)
1916 len = ptr1 - user;
1917 #endif /* VMS */
1918 /* Copy the user name into temp storage. */
1919 o = (unsigned char *) alloca (len + 1);
1920 bcopy ((char *) user, o, len);
1921 o[len] = 0;
1922
1923 /* Look up the user name. */
1924 pw = (struct passwd *) getpwnam (o + 1);
1925 if (!pw)
1926 error ("\"%s\" isn't a registered user", o + 1);
1927
1928 newdir = (unsigned char *) pw->pw_dir;
1929
1930 /* Discard the user name from NM. */
1931 nm += len;
1932 }
1933
1934 if (nm[0] != '/'
1935 #ifdef VMS
1936 && !index (nm, ':')
1937 #endif /* not VMS */
1938 && !newdir)
1939 {
1940 if (NILP (defalt))
1941 defalt = current_buffer->directory;
1942 CHECK_STRING (defalt);
1943 newdir = SDATA (defalt);
1944 }
1945
1946 /* Now concatenate the directory and name to new space in the stack frame */
1947
1948 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1949 target = (unsigned char *) alloca (tlen);
1950 *target = 0;
1951
1952 if (newdir)
1953 {
1954 #ifndef VMS
1955 if (nm[0] == 0 || nm[0] == '/')
1956 strcpy (target, newdir);
1957 else
1958 #endif
1959 file_name_as_directory (target, newdir);
1960 }
1961
1962 strcat (target, nm);
1963 #ifdef VMS
1964 if (index (target, '/'))
1965 strcpy (target, sys_translate_unix (target));
1966 #endif /* VMS */
1967
1968 /* Now canonicalize by removing /. and /foo/.. if they appear */
1969
1970 p = target;
1971 o = target;
1972
1973 while (*p)
1974 {
1975 #ifdef VMS
1976 if (*p != ']' && *p != '>' && *p != '-')
1977 {
1978 if (*p == '\\')
1979 p++;
1980 *o++ = *p++;
1981 }
1982 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1983 /* brackets are offset from each other by 2 */
1984 {
1985 p += 2;
1986 if (*p != '.' && *p != '-' && o[-1] != '.')
1987 /* convert [foo][bar] to [bar] */
1988 while (o[-1] != '[' && o[-1] != '<')
1989 o--;
1990 else if (*p == '-' && *o != '.')
1991 *--p = '.';
1992 }
1993 else if (p[0] == '-' && o[-1] == '.' &&
1994 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1995 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1996 {
1997 do
1998 o--;
1999 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
2000 if (p[1] == '.') /* foo.-.bar ==> bar. */
2001 p += 2;
2002 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
2003 p++, o--;
2004 /* else [foo.-] ==> [-] */
2005 }
2006 else
2007 {
2008 #ifndef VMS4_4
2009 if (*p == '-' &&
2010 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
2011 p[1] != ']' && p[1] != '>' && p[1] != '.')
2012 *p = '_';
2013 #endif /* VMS4_4 */
2014 *o++ = *p++;
2015 }
2016 #else /* not VMS */
2017 if (*p != '/')
2018 {
2019 *o++ = *p++;
2020 }
2021 else if (!strncmp (p, "//", 2)
2022 #ifdef APOLLO
2023 /* // at start of filename is meaningful in Apollo system. */
2024 && o != target
2025 #endif /* APOLLO */
2026 )
2027 {
2028 o = target;
2029 p++;
2030 }
2031 else if (p[0] == '/' && p[1] == '.' &&
2032 (p[2] == '/' || p[2] == 0))
2033 p += 2;
2034 else if (!strncmp (p, "/..", 3)
2035 /* `/../' is the "superroot" on certain file systems. */
2036 && o != target
2037 && (p[3] == '/' || p[3] == 0))
2038 {
2039 while (o != target && *--o != '/')
2040 ;
2041 #ifdef APOLLO
2042 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
2043 ++o;
2044 else
2045 #endif /* APOLLO */
2046 if (o == target && *o == '/')
2047 ++o;
2048 p += 3;
2049 }
2050 else
2051 {
2052 *o++ = *p++;
2053 }
2054 #endif /* not VMS */
2055 }
2056
2057 return make_string (target, o - target);
2058 }
2059 #endif
2060 \f
2061 /* If /~ or // appears, discard everything through first slash. */
2062 static int
2063 file_name_absolute_p (filename)
2064 const unsigned char *filename;
2065 {
2066 return
2067 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
2068 #ifdef VMS
2069 /* ??? This criterion is probably wrong for '<'. */
2070 || index (filename, ':') || index (filename, '<')
2071 || (*filename == '[' && (filename[1] != '-'
2072 || (filename[2] != '.' && filename[2] != ']'))
2073 && filename[1] != '.')
2074 #endif /* VMS */
2075 #ifdef DOS_NT
2076 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
2077 && IS_DIRECTORY_SEP (filename[2]))
2078 #endif
2079 );
2080 }
2081
2082 static unsigned char *
2083 search_embedded_absfilename (nm, endp)
2084 unsigned char *nm, *endp;
2085 {
2086 unsigned char *p, *s;
2087
2088 for (p = nm + 1; p < endp; p++)
2089 {
2090 if ((0
2091 #ifdef VMS
2092 || p[-1] == ':' || p[-1] == ']' || p[-1] == '>'
2093 #endif /* VMS */
2094 || IS_DIRECTORY_SEP (p[-1]))
2095 && file_name_absolute_p (p)
2096 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2097 /* // at start of file name is meaningful in Apollo,
2098 WindowsNT and Cygwin systems. */
2099 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
2100 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2101 )
2102 {
2103 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)
2104 #ifdef VMS
2105 && *s != ':'
2106 #endif /* VMS */
2107 ); s++);
2108 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
2109 {
2110 unsigned char *o = alloca (s - p + 1);
2111 struct passwd *pw;
2112 bcopy (p, o, s - p);
2113 o [s - p] = 0;
2114
2115 /* If we have ~user and `user' exists, discard
2116 everything up to ~. But if `user' does not exist, leave
2117 ~user alone, it might be a literal file name. */
2118 if ((pw = getpwnam (o + 1)))
2119 return p;
2120 else
2121 xfree (pw);
2122 }
2123 else
2124 return p;
2125 }
2126 }
2127 return NULL;
2128 }
2129
2130 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
2131 Ssubstitute_in_file_name, 1, 1, 0,
2132 doc: /* Substitute environment variables referred to in FILENAME.
2133 `$FOO' where FOO is an environment variable name means to substitute
2134 the value of that variable. The variable name should be terminated
2135 with a character not a letter, digit or underscore; otherwise, enclose
2136 the entire variable name in braces.
2137 If `/~' appears, all of FILENAME through that `/' is discarded.
2138
2139 On VMS, `$' substitution is not done; this function does little and only
2140 duplicates what `expand-file-name' does. */)
2141 (filename)
2142 Lisp_Object filename;
2143 {
2144 unsigned char *nm;
2145
2146 register unsigned char *s, *p, *o, *x, *endp;
2147 unsigned char *target = NULL;
2148 int total = 0;
2149 int substituted = 0;
2150 unsigned char *xnm;
2151 Lisp_Object handler;
2152
2153 CHECK_STRING (filename);
2154
2155 /* If the file name has special constructs in it,
2156 call the corresponding file handler. */
2157 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
2158 if (!NILP (handler))
2159 return call2 (handler, Qsubstitute_in_file_name, filename);
2160
2161 nm = SDATA (filename);
2162 #ifdef DOS_NT
2163 nm = strcpy (alloca (strlen (nm) + 1), nm);
2164 CORRECT_DIR_SEPS (nm);
2165 substituted = (strcmp (nm, SDATA (filename)) != 0);
2166 #endif
2167 endp = nm + SBYTES (filename);
2168
2169 /* If /~ or // appears, discard everything through first slash. */
2170 p = search_embedded_absfilename (nm, endp);
2171 if (p)
2172 /* Start over with the new string, so we check the file-name-handler
2173 again. Important with filenames like "/home/foo//:/hello///there"
2174 which whould substitute to "/:/hello///there" rather than "/there". */
2175 return Fsubstitute_in_file_name
2176 (make_specified_string (p, -1, endp - p,
2177 STRING_MULTIBYTE (filename)));
2178
2179 #ifdef VMS
2180 return filename;
2181 #else
2182
2183 /* See if any variables are substituted into the string
2184 and find the total length of their values in `total' */
2185
2186 for (p = nm; p != endp;)
2187 if (*p != '$')
2188 p++;
2189 else
2190 {
2191 p++;
2192 if (p == endp)
2193 goto badsubst;
2194 else if (*p == '$')
2195 {
2196 /* "$$" means a single "$" */
2197 p++;
2198 total -= 1;
2199 substituted = 1;
2200 continue;
2201 }
2202 else if (*p == '{')
2203 {
2204 o = ++p;
2205 while (p != endp && *p != '}') p++;
2206 if (*p != '}') goto missingclose;
2207 s = p;
2208 }
2209 else
2210 {
2211 o = p;
2212 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2213 s = p;
2214 }
2215
2216 /* Copy out the variable name */
2217 target = (unsigned char *) alloca (s - o + 1);
2218 strncpy (target, o, s - o);
2219 target[s - o] = 0;
2220 #ifdef DOS_NT
2221 strupr (target); /* $home == $HOME etc. */
2222 #endif /* DOS_NT */
2223
2224 /* Get variable value */
2225 o = (unsigned char *) egetenv (target);
2226 if (o)
2227 {
2228 total += strlen (o);
2229 substituted = 1;
2230 }
2231 else if (*p == '}')
2232 goto badvar;
2233 }
2234
2235 if (!substituted)
2236 return filename;
2237
2238 /* If substitution required, recopy the string and do it */
2239 /* Make space in stack frame for the new copy */
2240 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
2241 x = xnm;
2242
2243 /* Copy the rest of the name through, replacing $ constructs with values */
2244 for (p = nm; *p;)
2245 if (*p != '$')
2246 *x++ = *p++;
2247 else
2248 {
2249 p++;
2250 if (p == endp)
2251 goto badsubst;
2252 else if (*p == '$')
2253 {
2254 *x++ = *p++;
2255 continue;
2256 }
2257 else if (*p == '{')
2258 {
2259 o = ++p;
2260 while (p != endp && *p != '}') p++;
2261 if (*p != '}') goto missingclose;
2262 s = p++;
2263 }
2264 else
2265 {
2266 o = p;
2267 while (p != endp && (isalnum (*p) || *p == '_')) p++;
2268 s = p;
2269 }
2270
2271 /* Copy out the variable name */
2272 target = (unsigned char *) alloca (s - o + 1);
2273 strncpy (target, o, s - o);
2274 target[s - o] = 0;
2275 #ifdef DOS_NT
2276 strupr (target); /* $home == $HOME etc. */
2277 #endif /* DOS_NT */
2278
2279 /* Get variable value */
2280 o = (unsigned char *) egetenv (target);
2281 if (!o)
2282 {
2283 *x++ = '$';
2284 strcpy (x, target); x+= strlen (target);
2285 }
2286 else if (STRING_MULTIBYTE (filename))
2287 {
2288 /* If the original string is multibyte,
2289 convert what we substitute into multibyte. */
2290 while (*o)
2291 {
2292 int c = unibyte_char_to_multibyte (*o++);
2293 x += CHAR_STRING (c, x);
2294 }
2295 }
2296 else
2297 {
2298 strcpy (x, o);
2299 x += strlen (o);
2300 }
2301 }
2302
2303 *x = 0;
2304
2305 /* If /~ or // appears, discard everything through first slash. */
2306 while ((p = search_embedded_absfilename (xnm, x)))
2307 /* This time we do not start over because we've already expanded envvars
2308 and replaced $$ with $. Maybe we should start over as well, but we'd
2309 need to quote some $ to $$ first. */
2310 xnm = p;
2311
2312 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
2313
2314 badsubst:
2315 error ("Bad format environment-variable substitution");
2316 missingclose:
2317 error ("Missing \"}\" in environment-variable substitution");
2318 badvar:
2319 error ("Substituting nonexistent environment variable \"%s\"", target);
2320
2321 /* NOTREACHED */
2322 #endif /* not VMS */
2323 return Qnil;
2324 }
2325 \f
2326 /* A slightly faster and more convenient way to get
2327 (directory-file-name (expand-file-name FOO)). */
2328
2329 Lisp_Object
2330 expand_and_dir_to_file (filename, defdir)
2331 Lisp_Object filename, defdir;
2332 {
2333 register Lisp_Object absname;
2334
2335 absname = Fexpand_file_name (filename, defdir);
2336 #ifdef VMS
2337 {
2338 register int c = SREF (absname, SBYTES (absname) - 1);
2339 if (c == ':' || c == ']' || c == '>')
2340 absname = Fdirectory_file_name (absname);
2341 }
2342 #else
2343 /* Remove final slash, if any (unless this is the root dir).
2344 stat behaves differently depending! */
2345 if (SCHARS (absname) > 1
2346 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
2347 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
2348 /* We cannot take shortcuts; they might be wrong for magic file names. */
2349 absname = Fdirectory_file_name (absname);
2350 #endif
2351 return absname;
2352 }
2353 \f
2354 /* Signal an error if the file ABSNAME already exists.
2355 If INTERACTIVE is nonzero, ask the user whether to proceed,
2356 and bypass the error if the user says to go ahead.
2357 QUERYSTRING is a name for the action that is being considered
2358 to alter the file.
2359
2360 *STATPTR is used to store the stat information if the file exists.
2361 If the file does not exist, STATPTR->st_mode is set to 0.
2362 If STATPTR is null, we don't store into it.
2363
2364 If QUICK is nonzero, we ask for y or n, not yes or no. */
2365
2366 void
2367 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
2368 Lisp_Object absname;
2369 unsigned char *querystring;
2370 int interactive;
2371 struct stat *statptr;
2372 int quick;
2373 {
2374 register Lisp_Object tem, encoded_filename;
2375 struct stat statbuf;
2376 struct gcpro gcpro1;
2377
2378 encoded_filename = ENCODE_FILE (absname);
2379
2380 /* stat is a good way to tell whether the file exists,
2381 regardless of what access permissions it has. */
2382 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
2383 {
2384 if (! interactive)
2385 Fsignal (Qfile_already_exists,
2386 Fcons (build_string ("File already exists"),
2387 Fcons (absname, Qnil)));
2388 GCPRO1 (absname);
2389 tem = format2 ("File %s already exists; %s anyway? ",
2390 absname, build_string (querystring));
2391 if (quick)
2392 tem = Fy_or_n_p (tem);
2393 else
2394 tem = do_yes_or_no_p (tem);
2395 UNGCPRO;
2396 if (NILP (tem))
2397 Fsignal (Qfile_already_exists,
2398 Fcons (build_string ("File already exists"),
2399 Fcons (absname, Qnil)));
2400 if (statptr)
2401 *statptr = statbuf;
2402 }
2403 else
2404 {
2405 if (statptr)
2406 statptr->st_mode = 0;
2407 }
2408 return;
2409 }
2410
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.
2415 Signals a `file-already-exists' error if file NEWNAME already exists,
2416 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2417 A number as third arg means request confirmation if NEWNAME already exists.
2418 This is what happens in interactive use with M-x.
2419 Always sets the file modes of the output file to match the input file.
2420
2421 Fourth arg KEEP-TIME non-nil means give the output file the same
2422 last-modified time as the old one. (This works on only some systems.)
2423
2424 A prefix arg makes KEEP-TIME non-nil.
2425
2426 The optional fifth arg MUSTBENEW, if non-nil, insists on a check
2427 for an existing file with the same name. If MUSTBENEW is `excl',
2428 that means to get an error if the file already exists; never overwrite.
2429 If MUSTBENEW is neither nil nor `excl', that means ask for
2430 confirmation before overwriting, but do go ahead and overwrite the file
2431 if the user confirms. */)
2432 (file, newname, ok_if_already_exists, keep_time, mustbenew)
2433 Lisp_Object file, newname, ok_if_already_exists, keep_time, mustbenew;
2434 {
2435 int ifd, ofd, n;
2436 char buf[16 * 1024];
2437 struct stat st, out_st;
2438 Lisp_Object handler;
2439 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2440 int count = SPECPDL_INDEX ();
2441 int input_file_statable_p;
2442 Lisp_Object encoded_file, encoded_newname;
2443
2444 encoded_file = encoded_newname = Qnil;
2445 GCPRO4 (file, newname, encoded_file, encoded_newname);
2446 CHECK_STRING (file);
2447 CHECK_STRING (newname);
2448
2449 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
2450 barf_or_query_if_file_exists (newname, "overwrite", 1, 0, 1);
2451
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);
2456
2457 file = Fexpand_file_name (file, Qnil);
2458
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));
2468
2469 encoded_file = ENCODE_FILE (file);
2470 encoded_newname = ENCODE_FILE (newname);
2471
2472 if (NILP (ok_if_already_exists)
2473 || INTEGERP (ok_if_already_exists))
2474 barf_or_query_if_file_exists (encoded_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;
2478
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))
2486 {
2487 EMACS_TIME now;
2488 DWORD attributes;
2489 char * filename;
2490
2491 EMACS_GET_TIME (now);
2492 filename = SDATA (encoded_newname);
2493
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))
2498 {
2499 /* Restore original attributes. */
2500 SetFileAttributes (filename, attributes);
2501 Fsignal (Qfile_date_error,
2502 Fcons (build_string ("Cannot set file date"),
2503 Fcons (newname, Qnil)));
2504 }
2505 /* Restore original attributes. */
2506 SetFileAttributes (filename, attributes);
2507 }
2508 #else /* not WINDOWSNT */
2509 immediate_quit = 1;
2510 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2511 immediate_quit = 0;
2512
2513 if (ifd < 0)
2514 report_file_error ("Opening input file", Fcons (file, Qnil));
2515
2516 record_unwind_protect (close_file_unwind, make_number (ifd));
2517
2518 /* We can only copy regular files and symbolic links. Other files are not
2519 copyable by us. */
2520 input_file_statable_p = (fstat (ifd, &st) >= 0);
2521
2522 #if !defined (DOS_NT) || __DJGPP__ > 1
2523 if (out_st.st_mode != 0
2524 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2525 {
2526 errno = 0;
2527 report_file_error ("Input and output files are the same",
2528 Fcons (file, Fcons (newname, Qnil)));
2529 }
2530 #endif
2531
2532 #if defined (S_ISREG) && defined (S_ISLNK)
2533 if (input_file_statable_p)
2534 {
2535 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2536 {
2537 #if defined (EISDIR)
2538 /* Get a better looking error message. */
2539 errno = EISDIR;
2540 #endif /* EISDIR */
2541 report_file_error ("Non-regular file", Fcons (file, Qnil));
2542 }
2543 }
2544 #endif /* S_ISREG && S_ISLNK */
2545
2546 #ifdef VMS
2547 /* Create the copy file with the same record format as the input file */
2548 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2549 #else
2550 #ifdef MSDOS
2551 /* System's default file type was set to binary by _fmode in emacs.c. */
2552 ofd = emacs_open (SDATA (encoded_newname),
2553 O_WRONLY | O_TRUNC | O_CREAT
2554 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
2555 S_IREAD | S_IWRITE);
2556 #else /* not MSDOS */
2557 ofd = emacs_open (SDATA (encoded_newname),
2558 O_WRONLY | O_TRUNC | O_CREAT
2559 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
2560 0666);
2561 #endif /* not MSDOS */
2562 #endif /* VMS */
2563 if (ofd < 0)
2564 report_file_error ("Opening output file", Fcons (newname, Qnil));
2565
2566 record_unwind_protect (close_file_unwind, make_number (ofd));
2567
2568 immediate_quit = 1;
2569 QUIT;
2570 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2571 if (emacs_write (ofd, buf, n) != n)
2572 report_file_error ("I/O error", Fcons (newname, Qnil));
2573 immediate_quit = 0;
2574
2575 /* Closing the output clobbers the file times on some systems. */
2576 if (emacs_close (ofd) < 0)
2577 report_file_error ("I/O error", Fcons (newname, Qnil));
2578
2579 if (input_file_statable_p)
2580 {
2581 if (!NILP (keep_time))
2582 {
2583 EMACS_TIME atime, mtime;
2584 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2585 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2586 if (set_file_times (SDATA (encoded_newname),
2587 atime, mtime))
2588 Fsignal (Qfile_date_error,
2589 Fcons (build_string ("Cannot set file date"),
2590 Fcons (newname, Qnil)));
2591 }
2592 #ifndef MSDOS
2593 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2594 #else /* MSDOS */
2595 #if defined (__DJGPP__) && __DJGPP__ > 1
2596 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2597 and if it can't, it tells so. Otherwise, under MSDOS we usually
2598 get only the READ bit, which will make the copied file read-only,
2599 so it's better not to chmod at all. */
2600 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2601 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2602 #endif /* DJGPP version 2 or newer */
2603 #endif /* MSDOS */
2604 }
2605
2606 emacs_close (ifd);
2607 #endif /* WINDOWSNT */
2608
2609 /* Discard the unwind protects. */
2610 specpdl_ptr = specpdl + count;
2611
2612 UNGCPRO;
2613 return Qnil;
2614 }
2615 \f
2616 DEFUN ("make-directory-internal", Fmake_directory_internal,
2617 Smake_directory_internal, 1, 1, 0,
2618 doc: /* Create a new directory named DIRECTORY. */)
2619 (directory)
2620 Lisp_Object directory;
2621 {
2622 const unsigned char *dir;
2623 Lisp_Object handler;
2624 Lisp_Object encoded_dir;
2625
2626 CHECK_STRING (directory);
2627 directory = Fexpand_file_name (directory, Qnil);
2628
2629 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2630 if (!NILP (handler))
2631 return call2 (handler, Qmake_directory_internal, directory);
2632
2633 encoded_dir = ENCODE_FILE (directory);
2634
2635 dir = SDATA (encoded_dir);
2636
2637 #ifdef WINDOWSNT
2638 if (mkdir (dir) != 0)
2639 #else
2640 if (mkdir (dir, 0777) != 0)
2641 #endif
2642 report_file_error ("Creating directory", Flist (1, &directory));
2643
2644 return Qnil;
2645 }
2646
2647 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2648 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2649 (directory)
2650 Lisp_Object directory;
2651 {
2652 const unsigned char *dir;
2653 Lisp_Object handler;
2654 Lisp_Object encoded_dir;
2655
2656 CHECK_STRING (directory);
2657 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2658
2659 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2660 if (!NILP (handler))
2661 return call2 (handler, Qdelete_directory, directory);
2662
2663 encoded_dir = ENCODE_FILE (directory);
2664
2665 dir = SDATA (encoded_dir);
2666
2667 if (rmdir (dir) != 0)
2668 report_file_error ("Removing directory", Flist (1, &directory));
2669
2670 return Qnil;
2671 }
2672
2673 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2674 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2675 If file has multiple names, it continues to exist with the other names. */)
2676 (filename)
2677 Lisp_Object filename;
2678 {
2679 Lisp_Object handler;
2680 Lisp_Object encoded_file;
2681 struct gcpro gcpro1;
2682
2683 GCPRO1 (filename);
2684 if (!NILP (Ffile_directory_p (filename))
2685 && NILP (Ffile_symlink_p (filename)))
2686 Fsignal (Qfile_error,
2687 Fcons (build_string ("Removing old name: is a directory"),
2688 Fcons (filename, Qnil)));
2689 UNGCPRO;
2690 filename = Fexpand_file_name (filename, Qnil);
2691
2692 handler = Ffind_file_name_handler (filename, Qdelete_file);
2693 if (!NILP (handler))
2694 return call2 (handler, Qdelete_file, filename);
2695
2696 encoded_file = ENCODE_FILE (filename);
2697
2698 if (0 > unlink (SDATA (encoded_file)))
2699 report_file_error ("Removing old name", Flist (1, &filename));
2700 return Qnil;
2701 }
2702
2703 static Lisp_Object
2704 internal_delete_file_1 (ignore)
2705 Lisp_Object ignore;
2706 {
2707 return Qt;
2708 }
2709
2710 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2711
2712 int
2713 internal_delete_file (filename)
2714 Lisp_Object filename;
2715 {
2716 return NILP (internal_condition_case_1 (Fdelete_file, filename,
2717 Qt, internal_delete_file_1));
2718 }
2719 \f
2720 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2721 "fRename file: \nGRename %s to file: \np",
2722 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2723 If file has names other than FILE, it continues to have those names.
2724 Signals a `file-already-exists' error if a file NEWNAME already exists
2725 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2726 A number as third arg means request confirmation if NEWNAME already exists.
2727 This is what happens in interactive use with M-x. */)
2728 (file, newname, ok_if_already_exists)
2729 Lisp_Object file, newname, ok_if_already_exists;
2730 {
2731 #ifdef NO_ARG_ARRAY
2732 Lisp_Object args[2];
2733 #endif
2734 Lisp_Object handler;
2735 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2736 Lisp_Object encoded_file, encoded_newname, symlink_target;
2737
2738 symlink_target = encoded_file = encoded_newname = Qnil;
2739 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2740 CHECK_STRING (file);
2741 CHECK_STRING (newname);
2742 file = Fexpand_file_name (file, Qnil);
2743
2744 if (!NILP (Ffile_directory_p (newname)))
2745 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2746 else
2747 newname = Fexpand_file_name (newname, Qnil);
2748
2749 /* If the file name has special constructs in it,
2750 call the corresponding file handler. */
2751 handler = Ffind_file_name_handler (file, Qrename_file);
2752 if (NILP (handler))
2753 handler = Ffind_file_name_handler (newname, Qrename_file);
2754 if (!NILP (handler))
2755 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2756 file, newname, ok_if_already_exists));
2757
2758 encoded_file = ENCODE_FILE (file);
2759 encoded_newname = ENCODE_FILE (newname);
2760
2761 #ifdef DOS_NT
2762 /* If the file names are identical but for the case, don't ask for
2763 confirmation: they simply want to change the letter-case of the
2764 file name. */
2765 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2766 #endif
2767 if (NILP (ok_if_already_exists)
2768 || INTEGERP (ok_if_already_exists))
2769 barf_or_query_if_file_exists (encoded_newname, "rename to it",
2770 INTEGERP (ok_if_already_exists), 0, 0);
2771 #ifndef BSD4_1
2772 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2773 #else
2774 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2775 || 0 > unlink (SDATA (encoded_file)))
2776 #endif
2777 {
2778 if (errno == EXDEV)
2779 {
2780 #ifdef S_IFLNK
2781 symlink_target = Ffile_symlink_p (file);
2782 if (! NILP (symlink_target))
2783 Fmake_symbolic_link (symlink_target, newname,
2784 NILP (ok_if_already_exists) ? Qnil : Qt);
2785 else
2786 #endif
2787 Fcopy_file (file, newname,
2788 /* We have already prompted if it was an integer,
2789 so don't have copy-file prompt again. */
2790 NILP (ok_if_already_exists) ? Qnil : Qt,
2791 Qt, Qnil);
2792 Fdelete_file (file);
2793 }
2794 else
2795 #ifdef NO_ARG_ARRAY
2796 {
2797 args[0] = file;
2798 args[1] = newname;
2799 report_file_error ("Renaming", Flist (2, args));
2800 }
2801 #else
2802 report_file_error ("Renaming", Flist (2, &file));
2803 #endif
2804 }
2805 UNGCPRO;
2806 return Qnil;
2807 }
2808
2809 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2810 "fAdd name to file: \nGName to add to %s: \np",
2811 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2812 Signals a `file-already-exists' error if a file NEWNAME already exists
2813 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2814 A number as third arg means request confirmation if NEWNAME already exists.
2815 This is what happens in interactive use with M-x. */)
2816 (file, newname, ok_if_already_exists)
2817 Lisp_Object file, newname, ok_if_already_exists;
2818 {
2819 #ifdef NO_ARG_ARRAY
2820 Lisp_Object args[2];
2821 #endif
2822 Lisp_Object handler;
2823 Lisp_Object encoded_file, encoded_newname;
2824 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2825
2826 GCPRO4 (file, newname, encoded_file, encoded_newname);
2827 encoded_file = encoded_newname = Qnil;
2828 CHECK_STRING (file);
2829 CHECK_STRING (newname);
2830 file = Fexpand_file_name (file, Qnil);
2831
2832 if (!NILP (Ffile_directory_p (newname)))
2833 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2834 else
2835 newname = Fexpand_file_name (newname, Qnil);
2836
2837 /* If the file name has special constructs in it,
2838 call the corresponding file handler. */
2839 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2840 if (!NILP (handler))
2841 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2842 newname, ok_if_already_exists));
2843
2844 /* If the new name has special constructs in it,
2845 call the corresponding file handler. */
2846 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2847 if (!NILP (handler))
2848 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2849 newname, ok_if_already_exists));
2850
2851 encoded_file = ENCODE_FILE (file);
2852 encoded_newname = ENCODE_FILE (newname);
2853
2854 if (NILP (ok_if_already_exists)
2855 || INTEGERP (ok_if_already_exists))
2856 barf_or_query_if_file_exists (encoded_newname, "make it a new name",
2857 INTEGERP (ok_if_already_exists), 0, 0);
2858
2859 unlink (SDATA (newname));
2860 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2861 {
2862 #ifdef NO_ARG_ARRAY
2863 args[0] = file;
2864 args[1] = newname;
2865 report_file_error ("Adding new name", Flist (2, args));
2866 #else
2867 report_file_error ("Adding new name", Flist (2, &file));
2868 #endif
2869 }
2870
2871 UNGCPRO;
2872 return Qnil;
2873 }
2874
2875 #ifdef S_IFLNK
2876 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2877 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2878 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2879 Both args must be strings.
2880 Signals a `file-already-exists' error if a file LINKNAME already exists
2881 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2882 A number as third arg means request confirmation if LINKNAME already exists.
2883 This happens for interactive use with M-x. */)
2884 (filename, linkname, ok_if_already_exists)
2885 Lisp_Object filename, linkname, ok_if_already_exists;
2886 {
2887 #ifdef NO_ARG_ARRAY
2888 Lisp_Object args[2];
2889 #endif
2890 Lisp_Object handler;
2891 Lisp_Object encoded_filename, encoded_linkname;
2892 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2893
2894 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2895 encoded_filename = encoded_linkname = Qnil;
2896 CHECK_STRING (filename);
2897 CHECK_STRING (linkname);
2898 /* If the link target has a ~, we must expand it to get
2899 a truly valid file name. Otherwise, do not expand;
2900 we want to permit links to relative file names. */
2901 if (SREF (filename, 0) == '~')
2902 filename = Fexpand_file_name (filename, Qnil);
2903
2904 if (!NILP (Ffile_directory_p (linkname)))
2905 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2906 else
2907 linkname = Fexpand_file_name (linkname, Qnil);
2908
2909 /* If the file name has special constructs in it,
2910 call the corresponding file handler. */
2911 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2912 if (!NILP (handler))
2913 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2914 linkname, ok_if_already_exists));
2915
2916 /* If the new link name has special constructs in it,
2917 call the corresponding file handler. */
2918 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2919 if (!NILP (handler))
2920 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2921 linkname, ok_if_already_exists));
2922
2923 encoded_filename = ENCODE_FILE (filename);
2924 encoded_linkname = ENCODE_FILE (linkname);
2925
2926 if (NILP (ok_if_already_exists)
2927 || INTEGERP (ok_if_already_exists))
2928 barf_or_query_if_file_exists (encoded_linkname, "make it a link",
2929 INTEGERP (ok_if_already_exists), 0, 0);
2930 if (0 > symlink (SDATA (encoded_filename),
2931 SDATA (encoded_linkname)))
2932 {
2933 /* If we didn't complain already, silently delete existing file. */
2934 if (errno == EEXIST)
2935 {
2936 unlink (SDATA (encoded_linkname));
2937 if (0 <= symlink (SDATA (encoded_filename),
2938 SDATA (encoded_linkname)))
2939 {
2940 UNGCPRO;
2941 return Qnil;
2942 }
2943 }
2944
2945 #ifdef NO_ARG_ARRAY
2946 args[0] = filename;
2947 args[1] = linkname;
2948 report_file_error ("Making symbolic link", Flist (2, args));
2949 #else
2950 report_file_error ("Making symbolic link", Flist (2, &filename));
2951 #endif
2952 }
2953 UNGCPRO;
2954 return Qnil;
2955 }
2956 #endif /* S_IFLNK */
2957
2958 #ifdef VMS
2959
2960 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2961 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2962 doc: /* Define the job-wide logical name NAME to have the value STRING.
2963 If STRING is nil or a null string, the logical name NAME is deleted. */)
2964 (name, string)
2965 Lisp_Object name;
2966 Lisp_Object string;
2967 {
2968 CHECK_STRING (name);
2969 if (NILP (string))
2970 delete_logical_name (SDATA (name));
2971 else
2972 {
2973 CHECK_STRING (string);
2974
2975 if (SCHARS (string) == 0)
2976 delete_logical_name (SDATA (name));
2977 else
2978 define_logical_name (SDATA (name), SDATA (string));
2979 }
2980
2981 return string;
2982 }
2983 #endif /* VMS */
2984
2985 #ifdef HPUX_NET
2986
2987 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2988 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
2989 (path, login)
2990 Lisp_Object path, login;
2991 {
2992 int netresult;
2993
2994 CHECK_STRING (path);
2995 CHECK_STRING (login);
2996
2997 netresult = netunam (SDATA (path), SDATA (login));
2998
2999 if (netresult == -1)
3000 return Qnil;
3001 else
3002 return Qt;
3003 }
3004 #endif /* HPUX_NET */
3005 \f
3006 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
3007 1, 1, 0,
3008 doc: /* Return t if file FILENAME specifies an absolute file name.
3009 On Unix, this is a name starting with a `/' or a `~'. */)
3010 (filename)
3011 Lisp_Object filename;
3012 {
3013 CHECK_STRING (filename);
3014 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3015 }
3016 \f
3017 /* Return nonzero if file FILENAME exists and can be executed. */
3018
3019 static int
3020 check_executable (filename)
3021 char *filename;
3022 {
3023 #ifdef DOS_NT
3024 int len = strlen (filename);
3025 char *suffix;
3026 struct stat st;
3027 if (stat (filename, &st) < 0)
3028 return 0;
3029 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3030 return ((st.st_mode & S_IEXEC) != 0);
3031 #else
3032 return (S_ISREG (st.st_mode)
3033 && len >= 5
3034 && (stricmp ((suffix = filename + len-4), ".com") == 0
3035 || stricmp (suffix, ".exe") == 0
3036 || stricmp (suffix, ".bat") == 0)
3037 || (st.st_mode & S_IFMT) == S_IFDIR);
3038 #endif /* not WINDOWSNT */
3039 #else /* not DOS_NT */
3040 #ifdef HAVE_EUIDACCESS
3041 return (euidaccess (filename, 1) >= 0);
3042 #else
3043 /* Access isn't quite right because it uses the real uid
3044 and we really want to test with the effective uid.
3045 But Unix doesn't give us a right way to do it. */
3046 return (access (filename, 1) >= 0);
3047 #endif
3048 #endif /* not DOS_NT */
3049 }
3050
3051 /* Return nonzero if file FILENAME exists and can be written. */
3052
3053 static int
3054 check_writable (filename)
3055 char *filename;
3056 {
3057 #ifdef MSDOS
3058 struct stat st;
3059 if (stat (filename, &st) < 0)
3060 return 0;
3061 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3062 #else /* not MSDOS */
3063 #ifdef HAVE_EUIDACCESS
3064 return (euidaccess (filename, 2) >= 0);
3065 #else
3066 /* Access isn't quite right because it uses the real uid
3067 and we really want to test with the effective uid.
3068 But Unix doesn't give us a right way to do it.
3069 Opening with O_WRONLY could work for an ordinary file,
3070 but would lose for directories. */
3071 return (access (filename, 2) >= 0);
3072 #endif
3073 #endif /* not MSDOS */
3074 }
3075
3076 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3077 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3078 See also `file-readable-p' and `file-attributes'.
3079 This returns nil for a symlink to a nonexistent file.
3080 Use `file-symlink-p' to test for such links. */)
3081 (filename)
3082 Lisp_Object filename;
3083 {
3084 Lisp_Object absname;
3085 Lisp_Object handler;
3086 struct stat statbuf;
3087
3088 CHECK_STRING (filename);
3089 absname = Fexpand_file_name (filename, Qnil);
3090
3091 /* If the file name has special constructs in it,
3092 call the corresponding file handler. */
3093 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3094 if (!NILP (handler))
3095 return call2 (handler, Qfile_exists_p, absname);
3096
3097 absname = ENCODE_FILE (absname);
3098
3099 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3100 }
3101
3102 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3103 doc: /* Return t if FILENAME can be executed by you.
3104 For a directory, this means you can access files in that directory. */)
3105 (filename)
3106 Lisp_Object filename;
3107 {
3108 Lisp_Object absname;
3109 Lisp_Object handler;
3110
3111 CHECK_STRING (filename);
3112 absname = Fexpand_file_name (filename, Qnil);
3113
3114 /* If the file name has special constructs in it,
3115 call the corresponding file handler. */
3116 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3117 if (!NILP (handler))
3118 return call2 (handler, Qfile_executable_p, absname);
3119
3120 absname = ENCODE_FILE (absname);
3121
3122 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3123 }
3124
3125 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3126 doc: /* Return t if file FILENAME exists and you can read it.
3127 See also `file-exists-p' and `file-attributes'. */)
3128 (filename)
3129 Lisp_Object filename;
3130 {
3131 Lisp_Object absname;
3132 Lisp_Object handler;
3133 int desc;
3134 int flags;
3135 struct stat statbuf;
3136
3137 CHECK_STRING (filename);
3138 absname = Fexpand_file_name (filename, Qnil);
3139
3140 /* If the file name has special constructs in it,
3141 call the corresponding file handler. */
3142 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3143 if (!NILP (handler))
3144 return call2 (handler, Qfile_readable_p, absname);
3145
3146 absname = ENCODE_FILE (absname);
3147
3148 #if defined(DOS_NT) || defined(macintosh)
3149 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3150 directories. */
3151 if (access (SDATA (absname), 0) == 0)
3152 return Qt;
3153 return Qnil;
3154 #else /* not DOS_NT and not macintosh */
3155 flags = O_RDONLY;
3156 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3157 /* Opening a fifo without O_NONBLOCK can wait.
3158 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3159 except in the case of a fifo, on a system which handles it. */
3160 desc = stat (SDATA (absname), &statbuf);
3161 if (desc < 0)
3162 return Qnil;
3163 if (S_ISFIFO (statbuf.st_mode))
3164 flags |= O_NONBLOCK;
3165 #endif
3166 desc = emacs_open (SDATA (absname), flags, 0);
3167 if (desc < 0)
3168 return Qnil;
3169 emacs_close (desc);
3170 return Qt;
3171 #endif /* not DOS_NT and not macintosh */
3172 }
3173
3174 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3175 on the RT/PC. */
3176 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3177 doc: /* Return t if file FILENAME can be written or created by you. */)
3178 (filename)
3179 Lisp_Object filename;
3180 {
3181 Lisp_Object absname, dir, encoded;
3182 Lisp_Object handler;
3183 struct stat statbuf;
3184
3185 CHECK_STRING (filename);
3186 absname = Fexpand_file_name (filename, Qnil);
3187
3188 /* If the file name has special constructs in it,
3189 call the corresponding file handler. */
3190 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3191 if (!NILP (handler))
3192 return call2 (handler, Qfile_writable_p, absname);
3193
3194 encoded = ENCODE_FILE (absname);
3195 if (stat (SDATA (encoded), &statbuf) >= 0)
3196 return (check_writable (SDATA (encoded))
3197 ? Qt : Qnil);
3198
3199 dir = Ffile_name_directory (absname);
3200 #ifdef VMS
3201 if (!NILP (dir))
3202 dir = Fdirectory_file_name (dir);
3203 #endif /* VMS */
3204 #ifdef MSDOS
3205 if (!NILP (dir))
3206 dir = Fdirectory_file_name (dir);
3207 #endif /* MSDOS */
3208
3209 dir = ENCODE_FILE (dir);
3210 #ifdef WINDOWSNT
3211 /* The read-only attribute of the parent directory doesn't affect
3212 whether a file or directory can be created within it. Some day we
3213 should check ACLs though, which do affect this. */
3214 if (stat (SDATA (dir), &statbuf) < 0)
3215 return Qnil;
3216 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3217 #else
3218 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3219 ? Qt : Qnil);
3220 #endif
3221 }
3222 \f
3223 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3224 doc: /* Access file FILENAME, and get an error if that does not work.
3225 The second argument STRING is used in the error message.
3226 If there is no error, returns nil. */)
3227 (filename, string)
3228 Lisp_Object filename, string;
3229 {
3230 Lisp_Object handler, encoded_filename, absname;
3231 int fd;
3232
3233 CHECK_STRING (filename);
3234 absname = Fexpand_file_name (filename, Qnil);
3235
3236 CHECK_STRING (string);
3237
3238 /* If the file name has special constructs in it,
3239 call the corresponding file handler. */
3240 handler = Ffind_file_name_handler (absname, Qaccess_file);
3241 if (!NILP (handler))
3242 return call3 (handler, Qaccess_file, absname, string);
3243
3244 encoded_filename = ENCODE_FILE (absname);
3245
3246 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3247 if (fd < 0)
3248 report_file_error (SDATA (string), Fcons (filename, Qnil));
3249 emacs_close (fd);
3250
3251 return Qnil;
3252 }
3253 \f
3254 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3255 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3256 The value is the link target, as a string.
3257 Otherwise it returns nil.
3258
3259 This function returns t when given the name of a symlink that
3260 points to a nonexistent file. */)
3261 (filename)
3262 Lisp_Object filename;
3263 {
3264 Lisp_Object handler;
3265
3266 CHECK_STRING (filename);
3267 filename = Fexpand_file_name (filename, Qnil);
3268
3269 /* If the file name has special constructs in it,
3270 call the corresponding file handler. */
3271 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3272 if (!NILP (handler))
3273 return call2 (handler, Qfile_symlink_p, filename);
3274
3275 #ifdef S_IFLNK
3276 {
3277 char *buf;
3278 int bufsize;
3279 int valsize;
3280 Lisp_Object val;
3281
3282 filename = ENCODE_FILE (filename);
3283
3284 bufsize = 50;
3285 buf = NULL;
3286 do
3287 {
3288 bufsize *= 2;
3289 buf = (char *) xrealloc (buf, bufsize);
3290 bzero (buf, bufsize);
3291
3292 errno = 0;
3293 valsize = readlink (SDATA (filename), buf, bufsize);
3294 if (valsize == -1)
3295 {
3296 #ifdef ERANGE
3297 /* HP-UX reports ERANGE if buffer is too small. */
3298 if (errno == ERANGE)
3299 valsize = bufsize;
3300 else
3301 #endif
3302 {
3303 xfree (buf);
3304 return Qnil;
3305 }
3306 }
3307 }
3308 while (valsize >= bufsize);
3309
3310 val = make_string (buf, valsize);
3311 if (buf[0] == '/' && index (buf, ':'))
3312 val = concat2 (build_string ("/:"), val);
3313 xfree (buf);
3314 val = DECODE_FILE (val);
3315 return val;
3316 }
3317 #else /* not S_IFLNK */
3318 return Qnil;
3319 #endif /* not S_IFLNK */
3320 }
3321
3322 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3323 doc: /* Return t if FILENAME names an existing directory.
3324 Symbolic links to directories count as directories.
3325 See `file-symlink-p' to distinguish symlinks. */)
3326 (filename)
3327 Lisp_Object filename;
3328 {
3329 register Lisp_Object absname;
3330 struct stat st;
3331 Lisp_Object handler;
3332
3333 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3334
3335 /* If the file name has special constructs in it,
3336 call the corresponding file handler. */
3337 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3338 if (!NILP (handler))
3339 return call2 (handler, Qfile_directory_p, absname);
3340
3341 absname = ENCODE_FILE (absname);
3342
3343 if (stat (SDATA (absname), &st) < 0)
3344 return Qnil;
3345 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3346 }
3347
3348 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3349 doc: /* Return t if file FILENAME names a directory you can open.
3350 For the value to be t, FILENAME must specify the name of a directory as a file,
3351 and the directory must allow you to open files in it. In order to use a
3352 directory as a buffer's current directory, this predicate must return true.
3353 A directory name spec may be given instead; then the value is t
3354 if the directory so specified exists and really is a readable and
3355 searchable directory. */)
3356 (filename)
3357 Lisp_Object filename;
3358 {
3359 Lisp_Object handler;
3360 int tem;
3361 struct gcpro gcpro1;
3362
3363 /* If the file name has special constructs in it,
3364 call the corresponding file handler. */
3365 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3366 if (!NILP (handler))
3367 return call2 (handler, Qfile_accessible_directory_p, filename);
3368
3369 GCPRO1 (filename);
3370 tem = (NILP (Ffile_directory_p (filename))
3371 || NILP (Ffile_executable_p (filename)));
3372 UNGCPRO;
3373 return tem ? Qnil : Qt;
3374 }
3375
3376 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3377 doc: /* Return t if file FILENAME is the name of a regular file.
3378 This is the sort of file that holds an ordinary stream of data bytes. */)
3379 (filename)
3380 Lisp_Object filename;
3381 {
3382 register Lisp_Object absname;
3383 struct stat st;
3384 Lisp_Object handler;
3385
3386 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3387
3388 /* If the file name has special constructs in it,
3389 call the corresponding file handler. */
3390 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3391 if (!NILP (handler))
3392 return call2 (handler, Qfile_regular_p, absname);
3393
3394 absname = ENCODE_FILE (absname);
3395
3396 #ifdef WINDOWSNT
3397 {
3398 int result;
3399 Lisp_Object tem = Vw32_get_true_file_attributes;
3400
3401 /* Tell stat to use expensive method to get accurate info. */
3402 Vw32_get_true_file_attributes = Qt;
3403 result = stat (SDATA (absname), &st);
3404 Vw32_get_true_file_attributes = tem;
3405
3406 if (result < 0)
3407 return Qnil;
3408 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3409 }
3410 #else
3411 if (stat (SDATA (absname), &st) < 0)
3412 return Qnil;
3413 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3414 #endif
3415 }
3416 \f
3417 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3418 doc: /* Return mode bits of file named FILENAME, as an integer.
3419 Return nil, if file does not exist or is not accessible. */)
3420 (filename)
3421 Lisp_Object filename;
3422 {
3423 Lisp_Object absname;
3424 struct stat st;
3425 Lisp_Object handler;
3426
3427 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3428
3429 /* If the file name has special constructs in it,
3430 call the corresponding file handler. */
3431 handler = Ffind_file_name_handler (absname, Qfile_modes);
3432 if (!NILP (handler))
3433 return call2 (handler, Qfile_modes, absname);
3434
3435 absname = ENCODE_FILE (absname);
3436
3437 if (stat (SDATA (absname), &st) < 0)
3438 return Qnil;
3439 #if defined (MSDOS) && __DJGPP__ < 2
3440 if (check_executable (SDATA (absname)))
3441 st.st_mode |= S_IEXEC;
3442 #endif /* MSDOS && __DJGPP__ < 2 */
3443
3444 return make_number (st.st_mode & 07777);
3445 }
3446
3447 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3448 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3449 Only the 12 low bits of MODE are used. */)
3450 (filename, mode)
3451 Lisp_Object filename, mode;
3452 {
3453 Lisp_Object absname, encoded_absname;
3454 Lisp_Object handler;
3455
3456 absname = Fexpand_file_name (filename, current_buffer->directory);
3457 CHECK_NUMBER (mode);
3458
3459 /* If the file name has special constructs in it,
3460 call the corresponding file handler. */
3461 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3462 if (!NILP (handler))
3463 return call3 (handler, Qset_file_modes, absname, mode);
3464
3465 encoded_absname = ENCODE_FILE (absname);
3466
3467 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3468 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3469
3470 return Qnil;
3471 }
3472
3473 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3474 doc: /* Set the file permission bits for newly created files.
3475 The argument MODE should be an integer; only the low 9 bits are used.
3476 This setting is inherited by subprocesses. */)
3477 (mode)
3478 Lisp_Object mode;
3479 {
3480 CHECK_NUMBER (mode);
3481
3482 umask ((~ XINT (mode)) & 0777);
3483
3484 return Qnil;
3485 }
3486
3487 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3488 doc: /* Return the default file protection for created files.
3489 The value is an integer. */)
3490 ()
3491 {
3492 int realmask;
3493 Lisp_Object value;
3494
3495 realmask = umask (0);
3496 umask (realmask);
3497
3498 XSETINT (value, (~ realmask) & 0777);
3499 return value;
3500 }
3501 \f
3502 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3503
3504 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3505 doc: /* Set times of file FILENAME to TIME.
3506 Set both access and modification times.
3507 Return t on success, else nil.
3508 Use the current time if TIME is nil. TIME is in the format of
3509 `current-time'. */)
3510 (filename, time)
3511 Lisp_Object filename, time;
3512 {
3513 Lisp_Object absname, encoded_absname;
3514 Lisp_Object handler;
3515 time_t sec;
3516 int usec;
3517
3518 if (! lisp_time_argument (time, &sec, &usec))
3519 error ("Invalid time specification");
3520
3521 absname = Fexpand_file_name (filename, current_buffer->directory);
3522
3523 /* If the file name has special constructs in it,
3524 call the corresponding file handler. */
3525 handler = Ffind_file_name_handler (absname, Qset_file_times);
3526 if (!NILP (handler))
3527 return call3 (handler, Qset_file_times, absname, time);
3528
3529 encoded_absname = ENCODE_FILE (absname);
3530
3531 {
3532 EMACS_TIME t;
3533
3534 EMACS_SET_SECS (t, sec);
3535 EMACS_SET_USECS (t, usec);
3536
3537 if (set_file_times (SDATA (encoded_absname), t, t))
3538 {
3539 #ifdef DOS_NT
3540 struct stat st;
3541
3542 /* Setting times on a directory always fails. */
3543 if (stat (SDATA (encoded_absname), &st) == 0
3544 && (st.st_mode & S_IFMT) == S_IFDIR)
3545 return Qnil;
3546 #endif
3547 report_file_error ("Setting file times", Fcons (absname, Qnil));
3548 return Qnil;
3549 }
3550 }
3551
3552 return Qt;
3553 }
3554 \f
3555 #ifdef __NetBSD__
3556 #define unix 42
3557 #endif
3558
3559 #ifdef unix
3560 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3561 doc: /* Tell Unix to finish all pending disk updates. */)
3562 ()
3563 {
3564 sync ();
3565 return Qnil;
3566 }
3567
3568 #endif /* unix */
3569
3570 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3571 doc: /* Return t if file FILE1 is newer than file FILE2.
3572 If FILE1 does not exist, the answer is nil;
3573 otherwise, if FILE2 does not exist, the answer is t. */)
3574 (file1, file2)
3575 Lisp_Object file1, file2;
3576 {
3577 Lisp_Object absname1, absname2;
3578 struct stat st;
3579 int mtime1;
3580 Lisp_Object handler;
3581 struct gcpro gcpro1, gcpro2;
3582
3583 CHECK_STRING (file1);
3584 CHECK_STRING (file2);
3585
3586 absname1 = Qnil;
3587 GCPRO2 (absname1, file2);
3588 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3589 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3590 UNGCPRO;
3591
3592 /* If the file name has special constructs in it,
3593 call the corresponding file handler. */
3594 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3595 if (NILP (handler))
3596 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3597 if (!NILP (handler))
3598 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3599
3600 GCPRO2 (absname1, absname2);
3601 absname1 = ENCODE_FILE (absname1);
3602 absname2 = ENCODE_FILE (absname2);
3603 UNGCPRO;
3604
3605 if (stat (SDATA (absname1), &st) < 0)
3606 return Qnil;
3607
3608 mtime1 = st.st_mtime;
3609
3610 if (stat (SDATA (absname2), &st) < 0)
3611 return Qt;
3612
3613 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3614 }
3615 \f
3616 #ifdef DOS_NT
3617 Lisp_Object Qfind_buffer_file_type;
3618 #endif /* DOS_NT */
3619
3620 #ifndef READ_BUF_SIZE
3621 #define READ_BUF_SIZE (64 << 10)
3622 #endif
3623
3624 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3625
3626 /* This function is called after Lisp functions to decide a coding
3627 system are called, or when they cause an error. Before they are
3628 called, the current buffer is set unibyte and it contains only a
3629 newly inserted text (thus the buffer was empty before the
3630 insertion).
3631
3632 The functions may set markers, overlays, text properties, or even
3633 alter the buffer contents, change the current buffer.
3634
3635 Here, we reset all those changes by:
3636 o set back the current buffer.
3637 o move all markers and overlays to BEG.
3638 o remove all text properties.
3639 o set back the buffer multibyteness. */
3640
3641 static Lisp_Object
3642 decide_coding_unwind (unwind_data)
3643 Lisp_Object unwind_data;
3644 {
3645 Lisp_Object multibyte, undo_list, buffer;
3646
3647 multibyte = XCAR (unwind_data);
3648 unwind_data = XCDR (unwind_data);
3649 undo_list = XCAR (unwind_data);
3650 buffer = XCDR (unwind_data);
3651
3652 if (current_buffer != XBUFFER (buffer))
3653 set_buffer_internal (XBUFFER (buffer));
3654 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3655 adjust_overlays_for_delete (BEG, Z - BEG);
3656 BUF_INTERVALS (current_buffer) = 0;
3657 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3658
3659 /* Now we are safe to change the buffer's multibyteness directly. */
3660 current_buffer->enable_multibyte_characters = multibyte;
3661 current_buffer->undo_list = undo_list;
3662
3663 return Qnil;
3664 }
3665
3666
3667 /* Used to pass values from insert-file-contents to read_non_regular. */
3668
3669 static int non_regular_fd;
3670 static int non_regular_inserted;
3671 static int non_regular_nbytes;
3672
3673
3674 /* Read from a non-regular file.
3675 Read non_regular_trytry bytes max from non_regular_fd.
3676 Non_regular_inserted specifies where to put the read bytes.
3677 Value is the number of bytes read. */
3678
3679 static Lisp_Object
3680 read_non_regular ()
3681 {
3682 int nbytes;
3683
3684 immediate_quit = 1;
3685 QUIT;
3686 nbytes = emacs_read (non_regular_fd,
3687 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3688 non_regular_nbytes);
3689 immediate_quit = 0;
3690 return make_number (nbytes);
3691 }
3692
3693
3694 /* Condition-case handler used when reading from non-regular files
3695 in insert-file-contents. */
3696
3697 static Lisp_Object
3698 read_non_regular_quit ()
3699 {
3700 return Qnil;
3701 }
3702
3703
3704 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3705 1, 5, 0,
3706 doc: /* Insert contents of file FILENAME after point.
3707 Returns list of absolute file name and number of characters inserted.
3708 If second argument VISIT is non-nil, the buffer's visited filename
3709 and last save file modtime are set, and it is marked unmodified.
3710 If visiting and the file does not exist, visiting is completed
3711 before the error is signaled.
3712 The optional third and fourth arguments BEG and END
3713 specify what portion of the file to insert.
3714 These arguments count bytes in the file, not characters in the buffer.
3715 If VISIT is non-nil, BEG and END must be nil.
3716
3717 If optional fifth argument REPLACE is non-nil,
3718 it means replace the current buffer contents (in the accessible portion)
3719 with the file contents. This is better than simply deleting and inserting
3720 the whole thing because (1) it preserves some marker positions
3721 and (2) it puts less data in the undo list.
3722 When REPLACE is non-nil, the value is the number of characters actually read,
3723 which is often less than the number of characters to be read.
3724
3725 This does code conversion according to the value of
3726 `coding-system-for-read' or `file-coding-system-alist',
3727 and sets the variable `last-coding-system-used' to the coding system
3728 actually used. */)
3729 (filename, visit, beg, end, replace)
3730 Lisp_Object filename, visit, beg, end, replace;
3731 {
3732 struct stat st;
3733 register int fd;
3734 int inserted = 0;
3735 register int how_much;
3736 register int unprocessed;
3737 int count = SPECPDL_INDEX ();
3738 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3739 Lisp_Object handler, val, insval, orig_filename;
3740 Lisp_Object p;
3741 int total = 0;
3742 int not_regular = 0;
3743 unsigned char read_buf[READ_BUF_SIZE];
3744 struct coding_system coding;
3745 unsigned char buffer[1 << 14];
3746 int replace_handled = 0;
3747 int set_coding_system = 0;
3748 int coding_system_decided = 0;
3749 int read_quit = 0;
3750 int old_Vdeactivate_mark = Vdeactivate_mark;
3751 int we_locked_file = 0;
3752
3753 if (current_buffer->base_buffer && ! NILP (visit))
3754 error ("Cannot do file visiting in an indirect buffer");
3755
3756 if (!NILP (current_buffer->read_only))
3757 Fbarf_if_buffer_read_only ();
3758
3759 val = Qnil;
3760 p = Qnil;
3761 orig_filename = Qnil;
3762
3763 GCPRO4 (filename, val, p, orig_filename);
3764
3765 CHECK_STRING (filename);
3766 filename = Fexpand_file_name (filename, Qnil);
3767
3768 /* If the file name has special constructs in it,
3769 call the corresponding file handler. */
3770 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3771 if (!NILP (handler))
3772 {
3773 val = call6 (handler, Qinsert_file_contents, filename,
3774 visit, beg, end, replace);
3775 if (CONSP (val) && CONSP (XCDR (val)))
3776 inserted = XINT (XCAR (XCDR (val)));
3777 goto handled;
3778 }
3779
3780 orig_filename = filename;
3781 filename = ENCODE_FILE (filename);
3782
3783 fd = -1;
3784
3785 #ifdef WINDOWSNT
3786 {
3787 Lisp_Object tem = Vw32_get_true_file_attributes;
3788
3789 /* Tell stat to use expensive method to get accurate info. */
3790 Vw32_get_true_file_attributes = Qt;
3791 total = stat (SDATA (filename), &st);
3792 Vw32_get_true_file_attributes = tem;
3793 }
3794 if (total < 0)
3795 #else
3796 #ifndef APOLLO
3797 if (stat (SDATA (filename), &st) < 0)
3798 #else
3799 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3800 || fstat (fd, &st) < 0)
3801 #endif /* not APOLLO */
3802 #endif /* WINDOWSNT */
3803 {
3804 if (fd >= 0) emacs_close (fd);
3805 badopen:
3806 if (NILP (visit))
3807 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3808 st.st_mtime = -1;
3809 how_much = 0;
3810 if (!NILP (Vcoding_system_for_read))
3811 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3812 goto notfound;
3813 }
3814
3815 #ifdef S_IFREG
3816 /* This code will need to be changed in order to work on named
3817 pipes, and it's probably just not worth it. So we should at
3818 least signal an error. */
3819 if (!S_ISREG (st.st_mode))
3820 {
3821 not_regular = 1;
3822
3823 if (! NILP (visit))
3824 goto notfound;
3825
3826 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3827 Fsignal (Qfile_error,
3828 Fcons (build_string ("not a regular file"),
3829 Fcons (orig_filename, Qnil)));
3830 }
3831 #endif
3832
3833 if (fd < 0)
3834 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3835 goto badopen;
3836
3837 /* Replacement should preserve point as it preserves markers. */
3838 if (!NILP (replace))
3839 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3840
3841 record_unwind_protect (close_file_unwind, make_number (fd));
3842
3843 /* Supposedly happens on VMS. */
3844 /* Can happen on any platform that uses long as type of off_t, but allows
3845 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3846 give a message suitable for the latter case. */
3847 if (! not_regular && st.st_size < 0)
3848 error ("Maximum buffer size exceeded");
3849
3850 /* Prevent redisplay optimizations. */
3851 current_buffer->clip_changed = 1;
3852
3853 if (!NILP (visit))
3854 {
3855 if (!NILP (beg) || !NILP (end))
3856 error ("Attempt to visit less than an entire file");
3857 if (BEG < Z && NILP (replace))
3858 error ("Cannot do file visiting in a non-empty buffer");
3859 }
3860
3861 if (!NILP (beg))
3862 CHECK_NUMBER (beg);
3863 else
3864 XSETFASTINT (beg, 0);
3865
3866 if (!NILP (end))
3867 CHECK_NUMBER (end);
3868 else
3869 {
3870 if (! not_regular)
3871 {
3872 XSETINT (end, st.st_size);
3873
3874 /* Arithmetic overflow can occur if an Emacs integer cannot
3875 represent the file size, or if the calculations below
3876 overflow. The calculations below double the file size
3877 twice, so check that it can be multiplied by 4 safely. */
3878 if (XINT (end) != st.st_size
3879 || ((int) st.st_size * 4) / 4 != st.st_size)
3880 error ("Maximum buffer size exceeded");
3881
3882 /* The file size returned from stat may be zero, but data
3883 may be readable nonetheless, for example when this is a
3884 file in the /proc filesystem. */
3885 if (st.st_size == 0)
3886 XSETINT (end, READ_BUF_SIZE);
3887 }
3888 }
3889
3890 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3891 {
3892 /* We use emacs-mule for auto saving... */
3893 setup_coding_system (Qemacs_mule, &coding);
3894 /* ... but with the special flag to indicate to read in a
3895 multibyte sequence for eight-bit-control char as is. */
3896 coding.flags = 1;
3897 coding.src_multibyte = 0;
3898 coding.dst_multibyte
3899 = !NILP (current_buffer->enable_multibyte_characters);
3900 coding.eol_type = CODING_EOL_LF;
3901 coding_system_decided = 1;
3902 }
3903 else if (BEG < Z)
3904 {
3905 /* Decide the coding system to use for reading the file now
3906 because we can't use an optimized method for handling
3907 `coding:' tag if the current buffer is not empty. */
3908 Lisp_Object val;
3909 val = Qnil;
3910
3911 if (!NILP (Vcoding_system_for_read))
3912 val = Vcoding_system_for_read;
3913 else
3914 {
3915 /* Don't try looking inside a file for a coding system
3916 specification if it is not seekable. */
3917 if (! not_regular && ! NILP (Vset_auto_coding_function))
3918 {
3919 /* Find a coding system specified in the heading two
3920 lines or in the tailing several lines of the file.
3921 We assume that the 1K-byte and 3K-byte for heading
3922 and tailing respectively are sufficient for this
3923 purpose. */
3924 int nread;
3925
3926 if (st.st_size <= (1024 * 4))
3927 nread = emacs_read (fd, read_buf, 1024 * 4);
3928 else
3929 {
3930 nread = emacs_read (fd, read_buf, 1024);
3931 if (nread >= 0)
3932 {
3933 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3934 report_file_error ("Setting file position",
3935 Fcons (orig_filename, Qnil));
3936 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3937 }
3938 }
3939
3940 if (nread < 0)
3941 error ("IO error reading %s: %s",
3942 SDATA (orig_filename), emacs_strerror (errno));
3943 else if (nread > 0)
3944 {
3945 struct buffer *prev = current_buffer;
3946 Lisp_Object buffer;
3947 struct buffer *buf;
3948
3949 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3950
3951 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3952 buf = XBUFFER (buffer);
3953
3954 delete_all_overlays (buf);
3955 buf->directory = current_buffer->directory;
3956 buf->read_only = Qnil;
3957 buf->filename = Qnil;
3958 buf->undo_list = Qt;
3959 eassert (buf->overlays_before == NULL);
3960 eassert (buf->overlays_after == NULL);
3961
3962 set_buffer_internal (buf);
3963 Ferase_buffer ();
3964 buf->enable_multibyte_characters = Qnil;
3965
3966 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3967 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3968 val = call2 (Vset_auto_coding_function,
3969 filename, make_number (nread));
3970 set_buffer_internal (prev);
3971
3972 /* Discard the unwind protect for recovering the
3973 current buffer. */
3974 specpdl_ptr--;
3975
3976 /* Rewind the file for the actual read done later. */
3977 if (lseek (fd, 0, 0) < 0)
3978 report_file_error ("Setting file position",
3979 Fcons (orig_filename, Qnil));
3980 }
3981 }
3982
3983 if (NILP (val))
3984 {
3985 /* If we have not yet decided a coding system, check
3986 file-coding-system-alist. */
3987 Lisp_Object args[6], coding_systems;
3988
3989 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3990 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3991 coding_systems = Ffind_operation_coding_system (6, args);
3992 if (CONSP (coding_systems))
3993 val = XCAR (coding_systems);
3994 }
3995 }
3996
3997 setup_coding_system (Fcheck_coding_system (val), &coding);
3998 /* Ensure we set Vlast_coding_system_used. */
3999 set_coding_system = 1;
4000
4001 if (NILP (current_buffer->enable_multibyte_characters)
4002 && ! NILP (val))
4003 /* We must suppress all character code conversion except for
4004 end-of-line conversion. */
4005 setup_raw_text_coding_system (&coding);
4006
4007 coding.src_multibyte = 0;
4008 coding.dst_multibyte
4009 = !NILP (current_buffer->enable_multibyte_characters);
4010 coding_system_decided = 1;
4011 }
4012
4013 /* If requested, replace the accessible part of the buffer
4014 with the file contents. Avoid replacing text at the
4015 beginning or end of the buffer that matches the file contents;
4016 that preserves markers pointing to the unchanged parts.
4017
4018 Here we implement this feature in an optimized way
4019 for the case where code conversion is NOT needed.
4020 The following if-statement handles the case of conversion
4021 in a less optimal way.
4022
4023 If the code conversion is "automatic" then we try using this
4024 method and hope for the best.
4025 But if we discover the need for conversion, we give up on this method
4026 and let the following if-statement handle the replace job. */
4027 if (!NILP (replace)
4028 && BEGV < ZV
4029 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
4030 {
4031 /* same_at_start and same_at_end count bytes,
4032 because file access counts bytes
4033 and BEG and END count bytes. */
4034 int same_at_start = BEGV_BYTE;
4035 int same_at_end = ZV_BYTE;
4036 int overlap;
4037 /* There is still a possibility we will find the need to do code
4038 conversion. If that happens, we set this variable to 1 to
4039 give up on handling REPLACE in the optimized way. */
4040 int giveup_match_end = 0;
4041
4042 if (XINT (beg) != 0)
4043 {
4044 if (lseek (fd, XINT (beg), 0) < 0)
4045 report_file_error ("Setting file position",
4046 Fcons (orig_filename, Qnil));
4047 }
4048
4049 immediate_quit = 1;
4050 QUIT;
4051 /* Count how many chars at the start of the file
4052 match the text at the beginning of the buffer. */
4053 while (1)
4054 {
4055 int nread, bufpos;
4056
4057 nread = emacs_read (fd, buffer, sizeof buffer);
4058 if (nread < 0)
4059 error ("IO error reading %s: %s",
4060 SDATA (orig_filename), emacs_strerror (errno));
4061 else if (nread == 0)
4062 break;
4063
4064 if (coding.type == coding_type_undecided)
4065 detect_coding (&coding, buffer, nread);
4066 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
4067 /* We found that the file should be decoded somehow.
4068 Let's give up here. */
4069 {
4070 giveup_match_end = 1;
4071 break;
4072 }
4073
4074 if (coding.eol_type == CODING_EOL_UNDECIDED)
4075 detect_eol (&coding, buffer, nread);
4076 if (coding.eol_type != CODING_EOL_UNDECIDED
4077 && coding.eol_type != CODING_EOL_LF)
4078 /* We found that the format of eol should be decoded.
4079 Let's give up here. */
4080 {
4081 giveup_match_end = 1;
4082 break;
4083 }
4084
4085 bufpos = 0;
4086 while (bufpos < nread && same_at_start < ZV_BYTE
4087 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4088 same_at_start++, bufpos++;
4089 /* If we found a discrepancy, stop the scan.
4090 Otherwise loop around and scan the next bufferful. */
4091 if (bufpos != nread)
4092 break;
4093 }
4094 immediate_quit = 0;
4095 /* If the file matches the buffer completely,
4096 there's no need to replace anything. */
4097 if (same_at_start - BEGV_BYTE == XINT (end))
4098 {
4099 emacs_close (fd);
4100 specpdl_ptr--;
4101 /* Truncate the buffer to the size of the file. */
4102 del_range_1 (same_at_start, same_at_end, 0, 0);
4103 goto handled;
4104 }
4105 immediate_quit = 1;
4106 QUIT;
4107 /* Count how many chars at the end of the file
4108 match the text at the end of the buffer. But, if we have
4109 already found that decoding is necessary, don't waste time. */
4110 while (!giveup_match_end)
4111 {
4112 int total_read, nread, bufpos, curpos, trial;
4113
4114 /* At what file position are we now scanning? */
4115 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4116 /* If the entire file matches the buffer tail, stop the scan. */
4117 if (curpos == 0)
4118 break;
4119 /* How much can we scan in the next step? */
4120 trial = min (curpos, sizeof buffer);
4121 if (lseek (fd, curpos - trial, 0) < 0)
4122 report_file_error ("Setting file position",
4123 Fcons (orig_filename, Qnil));
4124
4125 total_read = nread = 0;
4126 while (total_read < trial)
4127 {
4128 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4129 if (nread < 0)
4130 error ("IO error reading %s: %s",
4131 SDATA (orig_filename), emacs_strerror (errno));
4132 else if (nread == 0)
4133 break;
4134 total_read += nread;
4135 }
4136
4137 /* Scan this bufferful from the end, comparing with
4138 the Emacs buffer. */
4139 bufpos = total_read;
4140
4141 /* Compare with same_at_start to avoid counting some buffer text
4142 as matching both at the file's beginning and at the end. */
4143 while (bufpos > 0 && same_at_end > same_at_start
4144 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4145 same_at_end--, bufpos--;
4146
4147 /* If we found a discrepancy, stop the scan.
4148 Otherwise loop around and scan the preceding bufferful. */
4149 if (bufpos != 0)
4150 {
4151 /* If this discrepancy is because of code conversion,
4152 we cannot use this method; giveup and try the other. */
4153 if (same_at_end > same_at_start
4154 && FETCH_BYTE (same_at_end - 1) >= 0200
4155 && ! NILP (current_buffer->enable_multibyte_characters)
4156 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4157 giveup_match_end = 1;
4158 break;
4159 }
4160
4161 if (nread == 0)
4162 break;
4163 }
4164 immediate_quit = 0;
4165
4166 if (! giveup_match_end)
4167 {
4168 int temp;
4169
4170 /* We win! We can handle REPLACE the optimized way. */
4171
4172 /* Extend the start of non-matching text area to multibyte
4173 character boundary. */
4174 if (! NILP (current_buffer->enable_multibyte_characters))
4175 while (same_at_start > BEGV_BYTE
4176 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4177 same_at_start--;
4178
4179 /* Extend the end of non-matching text area to multibyte
4180 character boundary. */
4181 if (! NILP (current_buffer->enable_multibyte_characters))
4182 while (same_at_end < ZV_BYTE
4183 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4184 same_at_end++;
4185
4186 /* Don't try to reuse the same piece of text twice. */
4187 overlap = (same_at_start - BEGV_BYTE
4188 - (same_at_end + st.st_size - ZV));
4189 if (overlap > 0)
4190 same_at_end += overlap;
4191
4192 /* Arrange to read only the nonmatching middle part of the file. */
4193 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4194 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4195
4196 del_range_byte (same_at_start, same_at_end, 0);
4197 /* Insert from the file at the proper position. */
4198 temp = BYTE_TO_CHAR (same_at_start);
4199 SET_PT_BOTH (temp, same_at_start);
4200
4201 /* If display currently starts at beginning of line,
4202 keep it that way. */
4203 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4204 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4205
4206 replace_handled = 1;
4207 }
4208 }
4209
4210 /* If requested, replace the accessible part of the buffer
4211 with the file contents. Avoid replacing text at the
4212 beginning or end of the buffer that matches the file contents;
4213 that preserves markers pointing to the unchanged parts.
4214
4215 Here we implement this feature for the case where code conversion
4216 is needed, in a simple way that needs a lot of memory.
4217 The preceding if-statement handles the case of no conversion
4218 in a more optimized way. */
4219 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4220 {
4221 int same_at_start = BEGV_BYTE;
4222 int same_at_end = ZV_BYTE;
4223 int overlap;
4224 int bufpos;
4225 /* Make sure that the gap is large enough. */
4226 int bufsize = 2 * st.st_size;
4227 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4228 int temp;
4229
4230 /* First read the whole file, performing code conversion into
4231 CONVERSION_BUFFER. */
4232
4233 if (lseek (fd, XINT (beg), 0) < 0)
4234 {
4235 xfree (conversion_buffer);
4236 report_file_error ("Setting file position",
4237 Fcons (orig_filename, Qnil));
4238 }
4239
4240 total = st.st_size; /* Total bytes in the file. */
4241 how_much = 0; /* Bytes read from file so far. */
4242 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4243 unprocessed = 0; /* Bytes not processed in previous loop. */
4244
4245 while (how_much < total)
4246 {
4247 /* try is reserved in some compilers (Microsoft C) */
4248 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4249 unsigned char *destination = read_buf + unprocessed;
4250 int this;
4251
4252 /* Allow quitting out of the actual I/O. */
4253 immediate_quit = 1;
4254 QUIT;
4255 this = emacs_read (fd, destination, trytry);
4256 immediate_quit = 0;
4257
4258 if (this < 0 || this + unprocessed == 0)
4259 {
4260 how_much = this;
4261 break;
4262 }
4263
4264 how_much += this;
4265
4266 if (CODING_MAY_REQUIRE_DECODING (&coding))
4267 {
4268 int require, result;
4269
4270 this += unprocessed;
4271
4272 /* If we are using more space than estimated,
4273 make CONVERSION_BUFFER bigger. */
4274 require = decoding_buffer_size (&coding, this);
4275 if (inserted + require + 2 * (total - how_much) > bufsize)
4276 {
4277 bufsize = inserted + require + 2 * (total - how_much);
4278 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4279 }
4280
4281 /* Convert this batch with results in CONVERSION_BUFFER. */
4282 if (how_much >= total) /* This is the last block. */
4283 coding.mode |= CODING_MODE_LAST_BLOCK;
4284 if (coding.composing != COMPOSITION_DISABLED)
4285 coding_allocate_composition_data (&coding, BEGV);
4286 result = decode_coding (&coding, read_buf,
4287 conversion_buffer + inserted,
4288 this, bufsize - inserted);
4289
4290 /* Save for next iteration whatever we didn't convert. */
4291 unprocessed = this - coding.consumed;
4292 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4293 if (!NILP (current_buffer->enable_multibyte_characters))
4294 this = coding.produced;
4295 else
4296 this = str_as_unibyte (conversion_buffer + inserted,
4297 coding.produced);
4298 }
4299
4300 inserted += this;
4301 }
4302
4303 /* At this point, INSERTED is how many characters (i.e. bytes)
4304 are present in CONVERSION_BUFFER.
4305 HOW_MUCH should equal TOTAL,
4306 or should be <= 0 if we couldn't read the file. */
4307
4308 if (how_much < 0)
4309 {
4310 xfree (conversion_buffer);
4311 coding_free_composition_data (&coding);
4312 if (how_much == -1)
4313 error ("IO error reading %s: %s",
4314 SDATA (orig_filename), emacs_strerror (errno));
4315 else if (how_much == -2)
4316 error ("maximum buffer size exceeded");
4317 }
4318
4319 /* Compare the beginning of the converted file
4320 with the buffer text. */
4321
4322 bufpos = 0;
4323 while (bufpos < inserted && same_at_start < same_at_end
4324 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4325 same_at_start++, bufpos++;
4326
4327 /* If the file matches the buffer completely,
4328 there's no need to replace anything. */
4329
4330 if (bufpos == inserted)
4331 {
4332 xfree (conversion_buffer);
4333 coding_free_composition_data (&coding);
4334 emacs_close (fd);
4335 specpdl_ptr--;
4336 /* Truncate the buffer to the size of the file. */
4337 del_range_byte (same_at_start, same_at_end, 0);
4338 inserted = 0;
4339 goto handled;
4340 }
4341
4342 /* Extend the start of non-matching text area to multibyte
4343 character boundary. */
4344 if (! NILP (current_buffer->enable_multibyte_characters))
4345 while (same_at_start > BEGV_BYTE
4346 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4347 same_at_start--;
4348
4349 /* Scan this bufferful from the end, comparing with
4350 the Emacs buffer. */
4351 bufpos = inserted;
4352
4353 /* Compare with same_at_start to avoid counting some buffer text
4354 as matching both at the file's beginning and at the end. */
4355 while (bufpos > 0 && same_at_end > same_at_start
4356 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4357 same_at_end--, bufpos--;
4358
4359 /* Extend the end of non-matching text area to multibyte
4360 character boundary. */
4361 if (! NILP (current_buffer->enable_multibyte_characters))
4362 while (same_at_end < ZV_BYTE
4363 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4364 same_at_end++;
4365
4366 /* Don't try to reuse the same piece of text twice. */
4367 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4368 if (overlap > 0)
4369 same_at_end += overlap;
4370
4371 /* If display currently starts at beginning of line,
4372 keep it that way. */
4373 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4374 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4375
4376 /* Replace the chars that we need to replace,
4377 and update INSERTED to equal the number of bytes
4378 we are taking from the file. */
4379 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4380
4381 if (same_at_end != same_at_start)
4382 {
4383 del_range_byte (same_at_start, same_at_end, 0);
4384 temp = GPT;
4385 same_at_start = GPT_BYTE;
4386 }
4387 else
4388 {
4389 temp = BYTE_TO_CHAR (same_at_start);
4390 }
4391 /* Insert from the file at the proper position. */
4392 SET_PT_BOTH (temp, same_at_start);
4393 insert_1 (conversion_buffer + same_at_start - BEGV_BYTE, inserted,
4394 0, 0, 0);
4395 if (coding.cmp_data && coding.cmp_data->used)
4396 coding_restore_composition (&coding, Fcurrent_buffer ());
4397 coding_free_composition_data (&coding);
4398
4399 /* Set `inserted' to the number of inserted characters. */
4400 inserted = PT - temp;
4401
4402 xfree (conversion_buffer);
4403 emacs_close (fd);
4404 specpdl_ptr--;
4405
4406 goto handled;
4407 }
4408
4409 if (! not_regular)
4410 {
4411 register Lisp_Object temp;
4412
4413 total = XINT (end) - XINT (beg);
4414
4415 /* Make sure point-max won't overflow after this insertion. */
4416 XSETINT (temp, total);
4417 if (total != XINT (temp))
4418 error ("Maximum buffer size exceeded");
4419 }
4420 else
4421 /* For a special file, all we can do is guess. */
4422 total = READ_BUF_SIZE;
4423
4424 if (NILP (visit) && inserted > 0)
4425 {
4426 #ifdef CLASH_DETECTION
4427 if (!NILP (current_buffer->file_truename)
4428 /* Make binding buffer-file-name to nil effective. */
4429 && !NILP (current_buffer->filename)
4430 && SAVE_MODIFF >= MODIFF)
4431 we_locked_file = 1;
4432 #endif /* CLASH_DETECTION */
4433 prepare_to_modify_buffer (GPT, GPT, NULL);
4434 }
4435
4436 move_gap (PT);
4437 if (GAP_SIZE < total)
4438 make_gap (total - GAP_SIZE);
4439
4440 if (XINT (beg) != 0 || !NILP (replace))
4441 {
4442 if (lseek (fd, XINT (beg), 0) < 0)
4443 report_file_error ("Setting file position",
4444 Fcons (orig_filename, Qnil));
4445 }
4446
4447 /* In the following loop, HOW_MUCH contains the total bytes read so
4448 far for a regular file, and not changed for a special file. But,
4449 before exiting the loop, it is set to a negative value if I/O
4450 error occurs. */
4451 how_much = 0;
4452
4453 /* Total bytes inserted. */
4454 inserted = 0;
4455
4456 /* Here, we don't do code conversion in the loop. It is done by
4457 code_convert_region after all data are read into the buffer. */
4458 {
4459 int gap_size = GAP_SIZE;
4460
4461 while (how_much < total)
4462 {
4463 /* try is reserved in some compilers (Microsoft C) */
4464 int trytry = min (total - how_much, READ_BUF_SIZE);
4465 int this;
4466
4467 if (not_regular)
4468 {
4469 Lisp_Object val;
4470
4471 /* Maybe make more room. */
4472 if (gap_size < trytry)
4473 {
4474 make_gap (total - gap_size);
4475 gap_size = GAP_SIZE;
4476 }
4477
4478 /* Read from the file, capturing `quit'. When an
4479 error occurs, end the loop, and arrange for a quit
4480 to be signaled after decoding the text we read. */
4481 non_regular_fd = fd;
4482 non_regular_inserted = inserted;
4483 non_regular_nbytes = trytry;
4484 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4485 read_non_regular_quit);
4486 if (NILP (val))
4487 {
4488 read_quit = 1;
4489 break;
4490 }
4491
4492 this = XINT (val);
4493 }
4494 else
4495 {
4496 /* Allow quitting out of the actual I/O. We don't make text
4497 part of the buffer until all the reading is done, so a C-g
4498 here doesn't do any harm. */
4499 immediate_quit = 1;
4500 QUIT;
4501 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4502 immediate_quit = 0;
4503 }
4504
4505 if (this <= 0)
4506 {
4507 how_much = this;
4508 break;
4509 }
4510
4511 gap_size -= this;
4512
4513 /* For a regular file, where TOTAL is the real size,
4514 count HOW_MUCH to compare with it.
4515 For a special file, where TOTAL is just a buffer size,
4516 so don't bother counting in HOW_MUCH.
4517 (INSERTED is where we count the number of characters inserted.) */
4518 if (! not_regular)
4519 how_much += this;
4520 inserted += this;
4521 }
4522 }
4523
4524 /* Now we have read all the file data into the gap.
4525 If it was empty, undo marking the buffer modified. */
4526
4527 if (inserted == 0)
4528 {
4529 #ifdef CLASH_DETECTION
4530 if (we_locked_file)
4531 unlock_file (current_buffer->file_truename);
4532 #endif
4533 Vdeactivate_mark = old_Vdeactivate_mark;
4534 }
4535
4536 /* Make the text read part of the buffer. */
4537 GAP_SIZE -= inserted;
4538 GPT += inserted;
4539 GPT_BYTE += inserted;
4540 ZV += inserted;
4541 ZV_BYTE += inserted;
4542 Z += inserted;
4543 Z_BYTE += inserted;
4544
4545 if (GAP_SIZE > 0)
4546 /* Put an anchor to ensure multi-byte form ends at gap. */
4547 *GPT_ADDR = 0;
4548
4549 emacs_close (fd);
4550
4551 /* Discard the unwind protect for closing the file. */
4552 specpdl_ptr--;
4553
4554 if (how_much < 0)
4555 error ("IO error reading %s: %s",
4556 SDATA (orig_filename), emacs_strerror (errno));
4557
4558 notfound:
4559
4560 if (! coding_system_decided)
4561 {
4562 /* The coding system is not yet decided. Decide it by an
4563 optimized method for handling `coding:' tag.
4564
4565 Note that we can get here only if the buffer was empty
4566 before the insertion. */
4567 Lisp_Object val;
4568 val = Qnil;
4569
4570 if (!NILP (Vcoding_system_for_read))
4571 val = Vcoding_system_for_read;
4572 else
4573 {
4574 /* Since we are sure that the current buffer was empty
4575 before the insertion, we can toggle
4576 enable-multibyte-characters directly here without taking
4577 care of marker adjustment and byte combining problem. By
4578 this way, we can run Lisp program safely before decoding
4579 the inserted text. */
4580 Lisp_Object unwind_data;
4581 int count = SPECPDL_INDEX ();
4582
4583 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4584 Fcons (current_buffer->undo_list,
4585 Fcurrent_buffer ()));
4586 current_buffer->enable_multibyte_characters = Qnil;
4587 current_buffer->undo_list = Qt;
4588 record_unwind_protect (decide_coding_unwind, unwind_data);
4589
4590 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4591 {
4592 val = call2 (Vset_auto_coding_function,
4593 filename, make_number (inserted));
4594 }
4595
4596 if (NILP (val))
4597 {
4598 /* If the coding system is not yet decided, check
4599 file-coding-system-alist. */
4600 Lisp_Object args[6], coding_systems;
4601
4602 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4603 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4604 coding_systems = Ffind_operation_coding_system (6, args);
4605 if (CONSP (coding_systems))
4606 val = XCAR (coding_systems);
4607 }
4608 unbind_to (count, Qnil);
4609 inserted = Z_BYTE - BEG_BYTE;
4610 }
4611
4612 /* The following kludgy code is to avoid some compiler bug.
4613 We can't simply do
4614 setup_coding_system (val, &coding);
4615 on some system. */
4616 {
4617 struct coding_system temp_coding;
4618 setup_coding_system (Fcheck_coding_system (val), &temp_coding);
4619 bcopy (&temp_coding, &coding, sizeof coding);
4620 }
4621 /* Ensure we set Vlast_coding_system_used. */
4622 set_coding_system = 1;
4623
4624 if (NILP (current_buffer->enable_multibyte_characters)
4625 && ! NILP (val))
4626 /* We must suppress all character code conversion except for
4627 end-of-line conversion. */
4628 setup_raw_text_coding_system (&coding);
4629 coding.src_multibyte = 0;
4630 coding.dst_multibyte
4631 = !NILP (current_buffer->enable_multibyte_characters);
4632 }
4633
4634 if (!NILP (visit)
4635 /* Can't do this if part of the buffer might be preserved. */
4636 && NILP (replace)
4637 && (coding.type == coding_type_no_conversion
4638 || coding.type == coding_type_raw_text))
4639 {
4640 /* Visiting a file with these coding system makes the buffer
4641 unibyte. */
4642 current_buffer->enable_multibyte_characters = Qnil;
4643 coding.dst_multibyte = 0;
4644 }
4645
4646 if (inserted > 0 || coding.type == coding_type_ccl)
4647 {
4648 if (CODING_MAY_REQUIRE_DECODING (&coding))
4649 {
4650 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4651 &coding, 0, 0);
4652 inserted = coding.produced_char;
4653 }
4654 else
4655 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4656 inserted);
4657 }
4658
4659 /* Now INSERTED is measured in characters. */
4660
4661 #ifdef DOS_NT
4662 /* Use the conversion type to determine buffer-file-type
4663 (find-buffer-file-type is now used to help determine the
4664 conversion). */
4665 if ((coding.eol_type == CODING_EOL_UNDECIDED
4666 || coding.eol_type == CODING_EOL_LF)
4667 && ! CODING_REQUIRE_DECODING (&coding))
4668 current_buffer->buffer_file_type = Qt;
4669 else
4670 current_buffer->buffer_file_type = Qnil;
4671 #endif
4672
4673 handled:
4674
4675 if (!NILP (visit))
4676 {
4677 if (!EQ (current_buffer->undo_list, Qt))
4678 current_buffer->undo_list = Qnil;
4679 #ifdef APOLLO
4680 stat (SDATA (filename), &st);
4681 #endif
4682
4683 if (NILP (handler))
4684 {
4685 current_buffer->modtime = st.st_mtime;
4686 current_buffer->filename = orig_filename;
4687 }
4688
4689 SAVE_MODIFF = MODIFF;
4690 current_buffer->auto_save_modified = MODIFF;
4691 XSETFASTINT (current_buffer->save_length, Z - BEG);
4692 #ifdef CLASH_DETECTION
4693 if (NILP (handler))
4694 {
4695 if (!NILP (current_buffer->file_truename))
4696 unlock_file (current_buffer->file_truename);
4697 unlock_file (filename);
4698 }
4699 #endif /* CLASH_DETECTION */
4700 if (not_regular)
4701 Fsignal (Qfile_error,
4702 Fcons (build_string ("not a regular file"),
4703 Fcons (orig_filename, Qnil)));
4704 }
4705
4706 if (set_coding_system)
4707 Vlast_coding_system_used = coding.symbol;
4708
4709 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4710 {
4711 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4712 visit);
4713 if (! NILP (insval))
4714 {
4715 CHECK_NUMBER (insval);
4716 inserted = XFASTINT (insval);
4717 }
4718 }
4719
4720 /* Decode file format */
4721 if (inserted > 0)
4722 {
4723 int empty_undo_list_p = 0;
4724
4725 /* If we're anyway going to discard undo information, don't
4726 record it in the first place. The buffer's undo list at this
4727 point is either nil or t when visiting a file. */
4728 if (!NILP (visit))
4729 {
4730 empty_undo_list_p = NILP (current_buffer->undo_list);
4731 current_buffer->undo_list = Qt;
4732 }
4733
4734 insval = call3 (Qformat_decode,
4735 Qnil, make_number (inserted), visit);
4736 CHECK_NUMBER (insval);
4737 inserted = XFASTINT (insval);
4738
4739 if (!NILP (visit))
4740 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4741 }
4742
4743 /* Call after-change hooks for the inserted text, aside from the case
4744 of normal visiting (not with REPLACE), which is done in a new buffer
4745 "before" the buffer is changed. */
4746 if (inserted > 0 && total > 0
4747 && (NILP (visit) || !NILP (replace)))
4748 {
4749 signal_after_change (PT, 0, inserted);
4750 update_compositions (PT, PT, CHECK_BORDER);
4751 }
4752
4753 p = Vafter_insert_file_functions;
4754 while (CONSP (p))
4755 {
4756 insval = call1 (XCAR (p), make_number (inserted));
4757 if (!NILP (insval))
4758 {
4759 CHECK_NUMBER (insval);
4760 inserted = XFASTINT (insval);
4761 }
4762 QUIT;
4763 p = XCDR (p);
4764 }
4765
4766 if (!NILP (visit)
4767 && current_buffer->modtime == -1)
4768 {
4769 /* If visiting nonexistent file, return nil. */
4770 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4771 }
4772
4773 if (read_quit)
4774 Fsignal (Qquit, Qnil);
4775
4776 /* ??? Retval needs to be dealt with in all cases consistently. */
4777 if (NILP (val))
4778 val = Fcons (orig_filename,
4779 Fcons (make_number (inserted),
4780 Qnil));
4781
4782 RETURN_UNGCPRO (unbind_to (count, val));
4783 }
4784 \f
4785 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4786 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4787 Lisp_Object, Lisp_Object));
4788
4789 /* If build_annotations switched buffers, switch back to BUF.
4790 Kill the temporary buffer that was selected in the meantime.
4791
4792 Since this kill only the last temporary buffer, some buffers remain
4793 not killed if build_annotations switched buffers more than once.
4794 -- K.Handa */
4795
4796 static Lisp_Object
4797 build_annotations_unwind (buf)
4798 Lisp_Object buf;
4799 {
4800 Lisp_Object tembuf;
4801
4802 if (XBUFFER (buf) == current_buffer)
4803 return Qnil;
4804 tembuf = Fcurrent_buffer ();
4805 Fset_buffer (buf);
4806 Fkill_buffer (tembuf);
4807 return Qnil;
4808 }
4809
4810 /* Decide the coding-system to encode the data with. */
4811
4812 void
4813 choose_write_coding_system (start, end, filename,
4814 append, visit, lockname, coding)
4815 Lisp_Object start, end, filename, append, visit, lockname;
4816 struct coding_system *coding;
4817 {
4818 Lisp_Object val;
4819
4820 if (auto_saving
4821 && NILP (Fstring_equal (current_buffer->filename,
4822 current_buffer->auto_save_file_name)))
4823 {
4824 /* We use emacs-mule for auto saving... */
4825 setup_coding_system (Qemacs_mule, coding);
4826 /* ... but with the special flag to indicate not to strip off
4827 leading code of eight-bit-control chars. */
4828 coding->flags = 1;
4829 goto done_setup_coding;
4830 }
4831 else if (!NILP (Vcoding_system_for_write))
4832 {
4833 val = Vcoding_system_for_write;
4834 if (coding_system_require_warning
4835 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4836 /* Confirm that VAL can surely encode the current region. */
4837 val = call5 (Vselect_safe_coding_system_function,
4838 start, end, Fcons (Qt, Fcons (val, Qnil)),
4839 Qnil, filename);
4840 }
4841 else
4842 {
4843 /* If the variable `buffer-file-coding-system' is set locally,
4844 it means that the file was read with some kind of code
4845 conversion or the variable is explicitly set by users. We
4846 had better write it out with the same coding system even if
4847 `enable-multibyte-characters' is nil.
4848
4849 If it is not set locally, we anyway have to convert EOL
4850 format if the default value of `buffer-file-coding-system'
4851 tells that it is not Unix-like (LF only) format. */
4852 int using_default_coding = 0;
4853 int force_raw_text = 0;
4854
4855 val = current_buffer->buffer_file_coding_system;
4856 if (NILP (val)
4857 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4858 {
4859 val = Qnil;
4860 if (NILP (current_buffer->enable_multibyte_characters))
4861 force_raw_text = 1;
4862 }
4863
4864 if (NILP (val))
4865 {
4866 /* Check file-coding-system-alist. */
4867 Lisp_Object args[7], coding_systems;
4868
4869 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4870 args[3] = filename; args[4] = append; args[5] = visit;
4871 args[6] = lockname;
4872 coding_systems = Ffind_operation_coding_system (7, args);
4873 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4874 val = XCDR (coding_systems);
4875 }
4876
4877 if (NILP (val)
4878 && !NILP (current_buffer->buffer_file_coding_system))
4879 {
4880 /* If we still have not decided a coding system, use the
4881 default value of buffer-file-coding-system. */
4882 val = current_buffer->buffer_file_coding_system;
4883 using_default_coding = 1;
4884 }
4885
4886 if (!force_raw_text
4887 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4888 /* Confirm that VAL can surely encode the current region. */
4889 val = call5 (Vselect_safe_coding_system_function,
4890 start, end, val, Qnil, filename);
4891
4892 setup_coding_system (Fcheck_coding_system (val), coding);
4893 if (coding->eol_type == CODING_EOL_UNDECIDED
4894 && !using_default_coding)
4895 {
4896 if (! EQ (default_buffer_file_coding.symbol,
4897 buffer_defaults.buffer_file_coding_system))
4898 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4899 &default_buffer_file_coding);
4900 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4901 {
4902 Lisp_Object subsidiaries;
4903
4904 coding->eol_type = default_buffer_file_coding.eol_type;
4905 subsidiaries = Fget (coding->symbol, Qeol_type);
4906 if (VECTORP (subsidiaries)
4907 && XVECTOR (subsidiaries)->size == 3)
4908 coding->symbol
4909 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4910 }
4911 }
4912
4913 if (force_raw_text)
4914 setup_raw_text_coding_system (coding);
4915 goto done_setup_coding;
4916 }
4917
4918 setup_coding_system (Fcheck_coding_system (val), coding);
4919
4920 done_setup_coding:
4921 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4922 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4923 }
4924
4925 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4926 "r\nFWrite region to file: \ni\ni\ni\np",
4927 doc: /* Write current region into specified file.
4928 When called from a program, requires three arguments:
4929 START, END and FILENAME. START and END are normally buffer positions
4930 specifying the part of the buffer to write.
4931 If START is nil, that means to use the entire buffer contents.
4932 If START is a string, then output that string to the file
4933 instead of any buffer contents; END is ignored.
4934
4935 Optional fourth argument APPEND if non-nil means
4936 append to existing file contents (if any). If it is an integer,
4937 seek to that offset in the file before writing.
4938 Optional fifth argument VISIT, if t or a string, means
4939 set the last-save-file-modtime of buffer to this file's modtime
4940 and mark buffer not modified.
4941 If VISIT is a string, it is a second file name;
4942 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4943 VISIT is also the file name to lock and unlock for clash detection.
4944 If VISIT is neither t nor nil nor a string,
4945 that means do not display the \"Wrote file\" message.
4946 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4947 use for locking and unlocking, overriding FILENAME and VISIT.
4948 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4949 for an existing file with the same name. If MUSTBENEW is `excl',
4950 that means to get an error if the file already exists; never overwrite.
4951 If MUSTBENEW is neither nil nor `excl', that means ask for
4952 confirmation before overwriting, but do go ahead and overwrite the file
4953 if the user confirms.
4954
4955 This does code conversion according to the value of
4956 `coding-system-for-write', `buffer-file-coding-system', or
4957 `file-coding-system-alist', and sets the variable
4958 `last-coding-system-used' to the coding system actually used. */)
4959 (start, end, filename, append, visit, lockname, mustbenew)
4960 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4961 {
4962 register int desc;
4963 int failure;
4964 int save_errno = 0;
4965 const unsigned char *fn;
4966 struct stat st;
4967 int tem;
4968 int count = SPECPDL_INDEX ();
4969 int count1;
4970 #ifdef VMS
4971 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4972 #endif /* VMS */
4973 Lisp_Object handler;
4974 Lisp_Object visit_file;
4975 Lisp_Object annotations;
4976 Lisp_Object encoded_filename;
4977 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4978 int quietly = !NILP (visit);
4979 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4980 struct buffer *given_buffer;
4981 #ifdef DOS_NT
4982 int buffer_file_type = O_BINARY;
4983 #endif /* DOS_NT */
4984 struct coding_system coding;
4985
4986 if (current_buffer->base_buffer && visiting)
4987 error ("Cannot do file visiting in an indirect buffer");
4988
4989 if (!NILP (start) && !STRINGP (start))
4990 validate_region (&start, &end);
4991
4992 GCPRO5 (start, filename, visit, visit_file, lockname);
4993
4994 filename = Fexpand_file_name (filename, Qnil);
4995
4996 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
4997 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
4998
4999 if (STRINGP (visit))
5000 visit_file = Fexpand_file_name (visit, Qnil);
5001 else
5002 visit_file = filename;
5003
5004 if (NILP (lockname))
5005 lockname = visit_file;
5006
5007 annotations = Qnil;
5008
5009 /* If the file name has special constructs in it,
5010 call the corresponding file handler. */
5011 handler = Ffind_file_name_handler (filename, Qwrite_region);
5012 /* If FILENAME has no handler, see if VISIT has one. */
5013 if (NILP (handler) && STRINGP (visit))
5014 handler = Ffind_file_name_handler (visit, Qwrite_region);
5015
5016 if (!NILP (handler))
5017 {
5018 Lisp_Object val;
5019 val = call6 (handler, Qwrite_region, start, end,
5020 filename, append, visit);
5021
5022 if (visiting)
5023 {
5024 SAVE_MODIFF = MODIFF;
5025 XSETFASTINT (current_buffer->save_length, Z - BEG);
5026 current_buffer->filename = visit_file;
5027 }
5028 UNGCPRO;
5029 return val;
5030 }
5031
5032 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5033
5034 /* Special kludge to simplify auto-saving. */
5035 if (NILP (start))
5036 {
5037 XSETFASTINT (start, BEG);
5038 XSETFASTINT (end, Z);
5039 Fwiden ();
5040 }
5041
5042 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5043 count1 = SPECPDL_INDEX ();
5044
5045 given_buffer = current_buffer;
5046
5047 if (!STRINGP (start))
5048 {
5049 annotations = build_annotations (start, end);
5050
5051 if (current_buffer != given_buffer)
5052 {
5053 XSETFASTINT (start, BEGV);
5054 XSETFASTINT (end, ZV);
5055 }
5056 }
5057
5058 UNGCPRO;
5059
5060 GCPRO5 (start, filename, annotations, visit_file, lockname);
5061
5062 /* Decide the coding-system to encode the data with.
5063 We used to make this choice before calling build_annotations, but that
5064 leads to problems when a write-annotate-function takes care of
5065 unsavable chars (as was the case with X-Symbol). */
5066 choose_write_coding_system (start, end, filename,
5067 append, visit, lockname, &coding);
5068 Vlast_coding_system_used = coding.symbol;
5069
5070 given_buffer = current_buffer;
5071 if (! STRINGP (start))
5072 {
5073 annotations = build_annotations_2 (start, end,
5074 coding.pre_write_conversion, annotations);
5075 if (current_buffer != given_buffer)
5076 {
5077 XSETFASTINT (start, BEGV);
5078 XSETFASTINT (end, ZV);
5079 }
5080 }
5081
5082 #ifdef CLASH_DETECTION
5083 if (!auto_saving)
5084 {
5085 #if 0 /* This causes trouble for GNUS. */
5086 /* If we've locked this file for some other buffer,
5087 query before proceeding. */
5088 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5089 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5090 #endif
5091
5092 lock_file (lockname);
5093 }
5094 #endif /* CLASH_DETECTION */
5095
5096 encoded_filename = ENCODE_FILE (filename);
5097
5098 fn = SDATA (encoded_filename);
5099 desc = -1;
5100 if (!NILP (append))
5101 #ifdef DOS_NT
5102 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5103 #else /* not DOS_NT */
5104 desc = emacs_open (fn, O_WRONLY, 0);
5105 #endif /* not DOS_NT */
5106
5107 if (desc < 0 && (NILP (append) || errno == ENOENT))
5108 #ifdef VMS
5109 if (auto_saving) /* Overwrite any previous version of autosave file */
5110 {
5111 vms_truncate (fn); /* if fn exists, truncate to zero length */
5112 desc = emacs_open (fn, O_RDWR, 0);
5113 if (desc < 0)
5114 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5115 ? SDATA (current_buffer->filename) : 0,
5116 fn);
5117 }
5118 else /* Write to temporary name and rename if no errors */
5119 {
5120 Lisp_Object temp_name;
5121 temp_name = Ffile_name_directory (filename);
5122
5123 if (!NILP (temp_name))
5124 {
5125 temp_name = Fmake_temp_name (concat2 (temp_name,
5126 build_string ("$$SAVE$$")));
5127 fname = SDATA (filename);
5128 fn = SDATA (temp_name);
5129 desc = creat_copy_attrs (fname, fn);
5130 if (desc < 0)
5131 {
5132 /* If we can't open the temporary file, try creating a new
5133 version of the original file. VMS "creat" creates a
5134 new version rather than truncating an existing file. */
5135 fn = fname;
5136 fname = 0;
5137 desc = creat (fn, 0666);
5138 #if 0 /* This can clobber an existing file and fail to replace it,
5139 if the user runs out of space. */
5140 if (desc < 0)
5141 {
5142 /* We can't make a new version;
5143 try to truncate and rewrite existing version if any. */
5144 vms_truncate (fn);
5145 desc = emacs_open (fn, O_RDWR, 0);
5146 }
5147 #endif
5148 }
5149 }
5150 else
5151 desc = creat (fn, 0666);
5152 }
5153 #else /* not VMS */
5154 #ifdef DOS_NT
5155 desc = emacs_open (fn,
5156 O_WRONLY | O_CREAT | buffer_file_type
5157 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5158 S_IREAD | S_IWRITE);
5159 #else /* not DOS_NT */
5160 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5161 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5162 auto_saving ? auto_save_mode_bits : 0666);
5163 #endif /* not DOS_NT */
5164 #endif /* not VMS */
5165
5166 if (desc < 0)
5167 {
5168 #ifdef CLASH_DETECTION
5169 save_errno = errno;
5170 if (!auto_saving) unlock_file (lockname);
5171 errno = save_errno;
5172 #endif /* CLASH_DETECTION */
5173 UNGCPRO;
5174 report_file_error ("Opening output file", Fcons (filename, Qnil));
5175 }
5176
5177 record_unwind_protect (close_file_unwind, make_number (desc));
5178
5179 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5180 {
5181 long ret;
5182
5183 if (NUMBERP (append))
5184 ret = lseek (desc, XINT (append), 1);
5185 else
5186 ret = lseek (desc, 0, 2);
5187 if (ret < 0)
5188 {
5189 #ifdef CLASH_DETECTION
5190 if (!auto_saving) unlock_file (lockname);
5191 #endif /* CLASH_DETECTION */
5192 UNGCPRO;
5193 report_file_error ("Lseek error", Fcons (filename, Qnil));
5194 }
5195 }
5196
5197 UNGCPRO;
5198
5199 #ifdef VMS
5200 /*
5201 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5202 * if we do writes that don't end with a carriage return. Furthermore
5203 * it cannot handle writes of more then 16K. The modified
5204 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5205 * this EXCEPT for the last record (iff it doesn't end with a carriage
5206 * return). This implies that if your buffer doesn't end with a carriage
5207 * return, you get one free... tough. However it also means that if
5208 * we make two calls to sys_write (a la the following code) you can
5209 * get one at the gap as well. The easiest way to fix this (honest)
5210 * is to move the gap to the next newline (or the end of the buffer).
5211 * Thus this change.
5212 *
5213 * Yech!
5214 */
5215 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5216 move_gap (find_next_newline (GPT, 1));
5217 #else
5218 /* Whether VMS or not, we must move the gap to the next of newline
5219 when we must put designation sequences at beginning of line. */
5220 if (INTEGERP (start)
5221 && coding.type == coding_type_iso2022
5222 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5223 && GPT > BEG && GPT_ADDR[-1] != '\n')
5224 {
5225 int opoint = PT, opoint_byte = PT_BYTE;
5226 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5227 move_gap_both (PT, PT_BYTE);
5228 SET_PT_BOTH (opoint, opoint_byte);
5229 }
5230 #endif
5231
5232 failure = 0;
5233 immediate_quit = 1;
5234
5235 if (STRINGP (start))
5236 {
5237 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5238 &annotations, &coding);
5239 save_errno = errno;
5240 }
5241 else if (XINT (start) != XINT (end))
5242 {
5243 tem = CHAR_TO_BYTE (XINT (start));
5244
5245 if (XINT (start) < GPT)
5246 {
5247 failure = 0 > a_write (desc, Qnil, XINT (start),
5248 min (GPT, XINT (end)) - XINT (start),
5249 &annotations, &coding);
5250 save_errno = errno;
5251 }
5252
5253 if (XINT (end) > GPT && !failure)
5254 {
5255 tem = max (XINT (start), GPT);
5256 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5257 &annotations, &coding);
5258 save_errno = errno;
5259 }
5260 }
5261 else
5262 {
5263 /* If file was empty, still need to write the annotations */
5264 coding.mode |= CODING_MODE_LAST_BLOCK;
5265 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5266 save_errno = errno;
5267 }
5268
5269 if (CODING_REQUIRE_FLUSHING (&coding)
5270 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5271 && ! failure)
5272 {
5273 /* We have to flush out a data. */
5274 coding.mode |= CODING_MODE_LAST_BLOCK;
5275 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5276 save_errno = errno;
5277 }
5278
5279 immediate_quit = 0;
5280
5281 #ifdef HAVE_FSYNC
5282 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5283 Disk full in NFS may be reported here. */
5284 /* mib says that closing the file will try to write as fast as NFS can do
5285 it, and that means the fsync here is not crucial for autosave files. */
5286 if (!auto_saving && fsync (desc) < 0)
5287 {
5288 /* If fsync fails with EINTR, don't treat that as serious. */
5289 if (errno != EINTR)
5290 failure = 1, save_errno = errno;
5291 }
5292 #endif
5293
5294 /* Spurious "file has changed on disk" warnings have been
5295 observed on Suns as well.
5296 It seems that `close' can change the modtime, under nfs.
5297
5298 (This has supposedly been fixed in Sunos 4,
5299 but who knows about all the other machines with NFS?) */
5300 #if 0
5301
5302 /* On VMS and APOLLO, must do the stat after the close
5303 since closing changes the modtime. */
5304 #ifndef VMS
5305 #ifndef APOLLO
5306 /* Recall that #if defined does not work on VMS. */
5307 #define FOO
5308 fstat (desc, &st);
5309 #endif
5310 #endif
5311 #endif
5312
5313 /* NFS can report a write failure now. */
5314 if (emacs_close (desc) < 0)
5315 failure = 1, save_errno = errno;
5316
5317 #ifdef VMS
5318 /* If we wrote to a temporary name and had no errors, rename to real name. */
5319 if (fname)
5320 {
5321 if (!failure)
5322 failure = (rename (fn, fname) != 0), save_errno = errno;
5323 fn = fname;
5324 }
5325 #endif /* VMS */
5326
5327 #ifndef FOO
5328 stat (fn, &st);
5329 #endif
5330 /* Discard the unwind protect for close_file_unwind. */
5331 specpdl_ptr = specpdl + count1;
5332 /* Restore the original current buffer. */
5333 visit_file = unbind_to (count, visit_file);
5334
5335 #ifdef CLASH_DETECTION
5336 if (!auto_saving)
5337 unlock_file (lockname);
5338 #endif /* CLASH_DETECTION */
5339
5340 /* Do this before reporting IO error
5341 to avoid a "file has changed on disk" warning on
5342 next attempt to save. */
5343 if (visiting)
5344 current_buffer->modtime = st.st_mtime;
5345
5346 if (failure)
5347 error ("IO error writing %s: %s", SDATA (filename),
5348 emacs_strerror (save_errno));
5349
5350 if (visiting)
5351 {
5352 SAVE_MODIFF = MODIFF;
5353 XSETFASTINT (current_buffer->save_length, Z - BEG);
5354 current_buffer->filename = visit_file;
5355 update_mode_lines++;
5356 }
5357 else if (quietly)
5358 {
5359 if (auto_saving
5360 && ! NILP (Fstring_equal (current_buffer->filename,
5361 current_buffer->auto_save_file_name)))
5362 SAVE_MODIFF = MODIFF;
5363
5364 return Qnil;
5365 }
5366
5367 if (!auto_saving)
5368 message_with_string ((INTEGERP (append)
5369 ? "Updated %s"
5370 : ! NILP (append)
5371 ? "Added to %s"
5372 : "Wrote %s"),
5373 visit_file, 1);
5374
5375 return Qnil;
5376 }
5377 \f
5378 Lisp_Object merge ();
5379
5380 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5381 doc: /* Return t if (car A) is numerically less than (car B). */)
5382 (a, b)
5383 Lisp_Object a, b;
5384 {
5385 return Flss (Fcar (a), Fcar (b));
5386 }
5387
5388 /* Build the complete list of annotations appropriate for writing out
5389 the text between START and END, by calling all the functions in
5390 write-region-annotate-functions and merging the lists they return.
5391 If one of these functions switches to a different buffer, we assume
5392 that buffer contains altered text. Therefore, the caller must
5393 make sure to restore the current buffer in all cases,
5394 as save-excursion would do. */
5395
5396 static Lisp_Object
5397 build_annotations (start, end)
5398 Lisp_Object start, end;
5399 {
5400 Lisp_Object annotations;
5401 Lisp_Object p, res;
5402 struct gcpro gcpro1, gcpro2;
5403 Lisp_Object original_buffer;
5404 int i, used_global = 0;
5405
5406 XSETBUFFER (original_buffer, current_buffer);
5407
5408 annotations = Qnil;
5409 p = Vwrite_region_annotate_functions;
5410 GCPRO2 (annotations, p);
5411 while (CONSP (p))
5412 {
5413 struct buffer *given_buffer = current_buffer;
5414 if (EQ (Qt, XCAR (p)) && !used_global)
5415 { /* Use the global value of the hook. */
5416 Lisp_Object arg[2];
5417 used_global = 1;
5418 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5419 arg[1] = XCDR (p);
5420 p = Fappend (2, arg);
5421 continue;
5422 }
5423 Vwrite_region_annotations_so_far = annotations;
5424 res = call2 (XCAR (p), start, end);
5425 /* If the function makes a different buffer current,
5426 assume that means this buffer contains altered text to be output.
5427 Reset START and END from the buffer bounds
5428 and discard all previous annotations because they should have
5429 been dealt with by this function. */
5430 if (current_buffer != given_buffer)
5431 {
5432 XSETFASTINT (start, BEGV);
5433 XSETFASTINT (end, ZV);
5434 annotations = Qnil;
5435 }
5436 Flength (res); /* Check basic validity of return value */
5437 annotations = merge (annotations, res, Qcar_less_than_car);
5438 p = XCDR (p);
5439 }
5440
5441 /* Now do the same for annotation functions implied by the file-format */
5442 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5443 p = current_buffer->auto_save_file_format;
5444 else
5445 p = current_buffer->file_format;
5446 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5447 {
5448 struct buffer *given_buffer = current_buffer;
5449
5450 Vwrite_region_annotations_so_far = annotations;
5451
5452 /* Value is either a list of annotations or nil if the function
5453 has written annotations to a temporary buffer, which is now
5454 current. */
5455 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5456 original_buffer, make_number (i));
5457 if (current_buffer != given_buffer)
5458 {
5459 XSETFASTINT (start, BEGV);
5460 XSETFASTINT (end, ZV);
5461 annotations = Qnil;
5462 }
5463
5464 if (CONSP (res))
5465 annotations = merge (annotations, res, Qcar_less_than_car);
5466 }
5467
5468 UNGCPRO;
5469 return annotations;
5470 }
5471
5472 static Lisp_Object
5473 build_annotations_2 (start, end, pre_write_conversion, annotations)
5474 Lisp_Object start, end, pre_write_conversion, annotations;
5475 {
5476 struct gcpro gcpro1;
5477 Lisp_Object res;
5478
5479 GCPRO1 (annotations);
5480 /* At last, do the same for the function PRE_WRITE_CONVERSION
5481 implied by the current coding-system. */
5482 if (!NILP (pre_write_conversion))
5483 {
5484 struct buffer *given_buffer = current_buffer;
5485 Vwrite_region_annotations_so_far = annotations;
5486 res = call2 (pre_write_conversion, start, end);
5487 Flength (res);
5488 annotations = (current_buffer != given_buffer
5489 ? res
5490 : merge (annotations, res, Qcar_less_than_car));
5491 }
5492
5493 UNGCPRO;
5494 return annotations;
5495 }
5496 \f
5497 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5498 If STRING is nil, POS is the character position in the current buffer.
5499 Intersperse with them the annotations from *ANNOT
5500 which fall within the range of POS to POS + NCHARS,
5501 each at its appropriate position.
5502
5503 We modify *ANNOT by discarding elements as we use them up.
5504
5505 The return value is negative in case of system call failure. */
5506
5507 static int
5508 a_write (desc, string, pos, nchars, annot, coding)
5509 int desc;
5510 Lisp_Object string;
5511 register int nchars;
5512 int pos;
5513 Lisp_Object *annot;
5514 struct coding_system *coding;
5515 {
5516 Lisp_Object tem;
5517 int nextpos;
5518 int lastpos = pos + nchars;
5519
5520 while (NILP (*annot) || CONSP (*annot))
5521 {
5522 tem = Fcar_safe (Fcar (*annot));
5523 nextpos = pos - 1;
5524 if (INTEGERP (tem))
5525 nextpos = XFASTINT (tem);
5526
5527 /* If there are no more annotations in this range,
5528 output the rest of the range all at once. */
5529 if (! (nextpos >= pos && nextpos <= lastpos))
5530 return e_write (desc, string, pos, lastpos, coding);
5531
5532 /* Output buffer text up to the next annotation's position. */
5533 if (nextpos > pos)
5534 {
5535 if (0 > e_write (desc, string, pos, nextpos, coding))
5536 return -1;
5537 pos = nextpos;
5538 }
5539 /* Output the annotation. */
5540 tem = Fcdr (Fcar (*annot));
5541 if (STRINGP (tem))
5542 {
5543 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5544 return -1;
5545 }
5546 *annot = Fcdr (*annot);
5547 }
5548 return 0;
5549 }
5550
5551 #ifndef WRITE_BUF_SIZE
5552 #define WRITE_BUF_SIZE (16 * 1024)
5553 #endif
5554
5555 /* Write text in the range START and END into descriptor DESC,
5556 encoding them with coding system CODING. If STRING is nil, START
5557 and END are character positions of the current buffer, else they
5558 are indexes to the string STRING. */
5559
5560 static int
5561 e_write (desc, string, start, end, coding)
5562 int desc;
5563 Lisp_Object string;
5564 int start, end;
5565 struct coding_system *coding;
5566 {
5567 register char *addr;
5568 register int nbytes;
5569 char buf[WRITE_BUF_SIZE];
5570 int return_val = 0;
5571
5572 if (start >= end)
5573 coding->composing = COMPOSITION_DISABLED;
5574 if (coding->composing != COMPOSITION_DISABLED)
5575 coding_save_composition (coding, start, end, string);
5576
5577 if (STRINGP (string))
5578 {
5579 addr = SDATA (string);
5580 nbytes = SBYTES (string);
5581 coding->src_multibyte = STRING_MULTIBYTE (string);
5582 }
5583 else if (start < end)
5584 {
5585 /* It is assured that the gap is not in the range START and END-1. */
5586 addr = CHAR_POS_ADDR (start);
5587 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5588 coding->src_multibyte
5589 = !NILP (current_buffer->enable_multibyte_characters);
5590 }
5591 else
5592 {
5593 addr = "";
5594 nbytes = 0;
5595 coding->src_multibyte = 1;
5596 }
5597
5598 /* We used to have a code for handling selective display here. But,
5599 now it is handled within encode_coding. */
5600 while (1)
5601 {
5602 int result;
5603
5604 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5605 if (coding->produced > 0)
5606 {
5607 coding->produced -= emacs_write (desc, buf, coding->produced);
5608 if (coding->produced)
5609 {
5610 return_val = -1;
5611 break;
5612 }
5613 }
5614 nbytes -= coding->consumed;
5615 addr += coding->consumed;
5616 if (result == CODING_FINISH_INSUFFICIENT_SRC
5617 && nbytes > 0)
5618 {
5619 /* The source text ends by an incomplete multibyte form.
5620 There's no way other than write it out as is. */
5621 nbytes -= emacs_write (desc, addr, nbytes);
5622 if (nbytes)
5623 {
5624 return_val = -1;
5625 break;
5626 }
5627 }
5628 if (nbytes <= 0)
5629 break;
5630 start += coding->consumed_char;
5631 if (coding->cmp_data)
5632 coding_adjust_composition_offset (coding, start);
5633 }
5634
5635 if (coding->cmp_data)
5636 coding_free_composition_data (coding);
5637
5638 return return_val;
5639 }
5640 \f
5641 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5642 Sverify_visited_file_modtime, 1, 1, 0,
5643 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5644 This means that the file has not been changed since it was visited or saved.
5645 See Info node `(elisp)Modification Time' for more details. */)
5646 (buf)
5647 Lisp_Object buf;
5648 {
5649 struct buffer *b;
5650 struct stat st;
5651 Lisp_Object handler;
5652 Lisp_Object filename;
5653
5654 CHECK_BUFFER (buf);
5655 b = XBUFFER (buf);
5656
5657 if (!STRINGP (b->filename)) return Qt;
5658 if (b->modtime == 0) return Qt;
5659
5660 /* If the file name has special constructs in it,
5661 call the corresponding file handler. */
5662 handler = Ffind_file_name_handler (b->filename,
5663 Qverify_visited_file_modtime);
5664 if (!NILP (handler))
5665 return call2 (handler, Qverify_visited_file_modtime, buf);
5666
5667 filename = ENCODE_FILE (b->filename);
5668
5669 if (stat (SDATA (filename), &st) < 0)
5670 {
5671 /* If the file doesn't exist now and didn't exist before,
5672 we say that it isn't modified, provided the error is a tame one. */
5673 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5674 st.st_mtime = -1;
5675 else
5676 st.st_mtime = 0;
5677 }
5678 if (st.st_mtime == b->modtime
5679 /* If both are positive, accept them if they are off by one second. */
5680 || (st.st_mtime > 0 && b->modtime > 0
5681 && (st.st_mtime == b->modtime + 1
5682 || st.st_mtime == b->modtime - 1)))
5683 return Qt;
5684 return Qnil;
5685 }
5686
5687 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5688 Sclear_visited_file_modtime, 0, 0, 0,
5689 doc: /* Clear out records of last mod time of visited file.
5690 Next attempt to save will certainly not complain of a discrepancy. */)
5691 ()
5692 {
5693 current_buffer->modtime = 0;
5694 return Qnil;
5695 }
5696
5697 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5698 Svisited_file_modtime, 0, 0, 0,
5699 doc: /* Return the current buffer's recorded visited file modification time.
5700 The value is a list of the form (HIGH LOW), like the time values
5701 that `file-attributes' returns. If the current buffer has no recorded
5702 file modification time, this function returns 0.
5703 See Info node `(elisp)Modification Time' for more details. */)
5704 ()
5705 {
5706 Lisp_Object tcons;
5707 tcons = long_to_cons ((unsigned long) current_buffer->modtime);
5708 if (CONSP (tcons))
5709 return list2 (XCAR (tcons), XCDR (tcons));
5710 return tcons;
5711 }
5712
5713 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5714 Sset_visited_file_modtime, 0, 1, 0,
5715 doc: /* Update buffer's recorded modification time from the visited file's time.
5716 Useful if the buffer was not read from the file normally
5717 or if the file itself has been changed for some known benign reason.
5718 An argument specifies the modification time value to use
5719 \(instead of that of the visited file), in the form of a list
5720 \(HIGH . LOW) or (HIGH LOW). */)
5721 (time_list)
5722 Lisp_Object time_list;
5723 {
5724 if (!NILP (time_list))
5725 current_buffer->modtime = cons_to_long (time_list);
5726 else
5727 {
5728 register Lisp_Object filename;
5729 struct stat st;
5730 Lisp_Object handler;
5731
5732 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5733
5734 /* If the file name has special constructs in it,
5735 call the corresponding file handler. */
5736 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5737 if (!NILP (handler))
5738 /* The handler can find the file name the same way we did. */
5739 return call2 (handler, Qset_visited_file_modtime, Qnil);
5740
5741 filename = ENCODE_FILE (filename);
5742
5743 if (stat (SDATA (filename), &st) >= 0)
5744 current_buffer->modtime = st.st_mtime;
5745 }
5746
5747 return Qnil;
5748 }
5749 \f
5750 Lisp_Object
5751 auto_save_error (error)
5752 Lisp_Object error;
5753 {
5754 Lisp_Object args[3], msg;
5755 int i, nbytes;
5756 struct gcpro gcpro1;
5757
5758 ring_bell (XFRAME (selected_frame));
5759
5760 args[0] = build_string ("Auto-saving %s: %s");
5761 args[1] = current_buffer->name;
5762 args[2] = Ferror_message_string (error);
5763 msg = Fformat (3, args);
5764 GCPRO1 (msg);
5765 nbytes = SBYTES (msg);
5766
5767 for (i = 0; i < 3; ++i)
5768 {
5769 if (i == 0)
5770 message2 (SDATA (msg), nbytes, STRING_MULTIBYTE (msg));
5771 else
5772 message2_nolog (SDATA (msg), nbytes, STRING_MULTIBYTE (msg));
5773 Fsleep_for (make_number (1), Qnil);
5774 }
5775
5776 UNGCPRO;
5777 return Qnil;
5778 }
5779
5780 Lisp_Object
5781 auto_save_1 ()
5782 {
5783 struct stat st;
5784 Lisp_Object modes;
5785
5786 auto_save_mode_bits = 0666;
5787
5788 /* Get visited file's mode to become the auto save file's mode. */
5789 if (! NILP (current_buffer->filename))
5790 {
5791 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5792 /* But make sure we can overwrite it later! */
5793 auto_save_mode_bits = st.st_mode | 0600;
5794 else if ((modes = Ffile_modes (current_buffer->filename),
5795 INTEGERP (modes)))
5796 /* Remote files don't cooperate with stat. */
5797 auto_save_mode_bits = XINT (modes) | 0600;
5798 }
5799
5800 return
5801 Fwrite_region (Qnil, Qnil,
5802 current_buffer->auto_save_file_name,
5803 Qnil, Qlambda, Qnil, Qnil);
5804 }
5805
5806 static Lisp_Object
5807 do_auto_save_unwind (stream) /* used as unwind-protect function */
5808 Lisp_Object stream;
5809 {
5810 auto_saving = 0;
5811 if (!NILP (stream))
5812 fclose ((FILE *) (XFASTINT (XCAR (stream)) << 16
5813 | XFASTINT (XCDR (stream))));
5814 return Qnil;
5815 }
5816
5817 static Lisp_Object
5818 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5819 Lisp_Object value;
5820 {
5821 minibuffer_auto_raise = XINT (value);
5822 return Qnil;
5823 }
5824
5825 static Lisp_Object
5826 do_auto_save_make_dir (dir)
5827 Lisp_Object dir;
5828 {
5829 return call2 (Qmake_directory, dir, Qt);
5830 }
5831
5832 static Lisp_Object
5833 do_auto_save_eh (ignore)
5834 Lisp_Object ignore;
5835 {
5836 return Qnil;
5837 }
5838
5839 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5840 doc: /* Auto-save all buffers that need it.
5841 This is all buffers that have auto-saving enabled
5842 and are changed since last auto-saved.
5843 Auto-saving writes the buffer into a file
5844 so that your editing is not lost if the system crashes.
5845 This file is not the file you visited; that changes only when you save.
5846 Normally we run the normal hook `auto-save-hook' before saving.
5847
5848 A non-nil NO-MESSAGE argument means do not print any message if successful.
5849 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5850 (no_message, current_only)
5851 Lisp_Object no_message, current_only;
5852 {
5853 struct buffer *old = current_buffer, *b;
5854 Lisp_Object tail, buf;
5855 int auto_saved = 0;
5856 int do_handled_files;
5857 Lisp_Object oquit;
5858 FILE *stream;
5859 Lisp_Object lispstream;
5860 int count = SPECPDL_INDEX ();
5861 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5862 int old_message_p = 0;
5863 struct gcpro gcpro1, gcpro2;
5864
5865 if (max_specpdl_size < specpdl_size + 40)
5866 max_specpdl_size = specpdl_size + 40;
5867
5868 if (minibuf_level)
5869 no_message = Qt;
5870
5871 if (NILP (no_message))
5872 {
5873 old_message_p = push_message ();
5874 record_unwind_protect (pop_message_unwind, Qnil);
5875 }
5876
5877 /* Ordinarily don't quit within this function,
5878 but don't make it impossible to quit (in case we get hung in I/O). */
5879 oquit = Vquit_flag;
5880 Vquit_flag = Qnil;
5881
5882 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5883 point to non-strings reached from Vbuffer_alist. */
5884
5885 if (!NILP (Vrun_hooks))
5886 call1 (Vrun_hooks, intern ("auto-save-hook"));
5887
5888 if (STRINGP (Vauto_save_list_file_name))
5889 {
5890 Lisp_Object listfile;
5891
5892 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5893
5894 /* Don't try to create the directory when shutting down Emacs,
5895 because creating the directory might signal an error, and
5896 that would leave Emacs in a strange state. */
5897 if (!NILP (Vrun_hooks))
5898 {
5899 Lisp_Object dir;
5900 dir = Qnil;
5901 GCPRO2 (dir, listfile);
5902 dir = Ffile_name_directory (listfile);
5903 if (NILP (Ffile_directory_p (dir)))
5904 internal_condition_case_1 (do_auto_save_make_dir,
5905 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5906 do_auto_save_eh);
5907 UNGCPRO;
5908 }
5909
5910 stream = fopen (SDATA (listfile), "w");
5911 if (stream != NULL)
5912 {
5913 /* Arrange to close that file whether or not we get an error.
5914 Also reset auto_saving to 0. */
5915 lispstream = Fcons (Qnil, Qnil);
5916 XSETCARFASTINT (lispstream, (EMACS_UINT)stream >> 16);
5917 XSETCDRFASTINT (lispstream, (EMACS_UINT)stream & 0xffff);
5918 }
5919 else
5920 lispstream = Qnil;
5921 }
5922 else
5923 {
5924 stream = NULL;
5925 lispstream = Qnil;
5926 }
5927
5928 record_unwind_protect (do_auto_save_unwind, lispstream);
5929 record_unwind_protect (do_auto_save_unwind_1,
5930 make_number (minibuffer_auto_raise));
5931 minibuffer_auto_raise = 0;
5932 auto_saving = 1;
5933
5934 /* On first pass, save all files that don't have handlers.
5935 On second pass, save all files that do have handlers.
5936
5937 If Emacs is crashing, the handlers may tweak what is causing
5938 Emacs to crash in the first place, and it would be a shame if
5939 Emacs failed to autosave perfectly ordinary files because it
5940 couldn't handle some ange-ftp'd file. */
5941
5942 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5943 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5944 {
5945 buf = XCDR (XCAR (tail));
5946 b = XBUFFER (buf);
5947
5948 /* Record all the buffers that have auto save mode
5949 in the special file that lists them. For each of these buffers,
5950 Record visited name (if any) and auto save name. */
5951 if (STRINGP (b->auto_save_file_name)
5952 && stream != NULL && do_handled_files == 0)
5953 {
5954 if (!NILP (b->filename))
5955 {
5956 fwrite (SDATA (b->filename), 1,
5957 SBYTES (b->filename), stream);
5958 }
5959 putc ('\n', stream);
5960 fwrite (SDATA (b->auto_save_file_name), 1,
5961 SBYTES (b->auto_save_file_name), stream);
5962 putc ('\n', stream);
5963 }
5964
5965 if (!NILP (current_only)
5966 && b != current_buffer)
5967 continue;
5968
5969 /* Don't auto-save indirect buffers.
5970 The base buffer takes care of it. */
5971 if (b->base_buffer)
5972 continue;
5973
5974 /* Check for auto save enabled
5975 and file changed since last auto save
5976 and file changed since last real save. */
5977 if (STRINGP (b->auto_save_file_name)
5978 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5979 && b->auto_save_modified < BUF_MODIFF (b)
5980 /* -1 means we've turned off autosaving for a while--see below. */
5981 && XINT (b->save_length) >= 0
5982 && (do_handled_files
5983 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5984 Qwrite_region))))
5985 {
5986 EMACS_TIME before_time, after_time;
5987
5988 EMACS_GET_TIME (before_time);
5989
5990 /* If we had a failure, don't try again for 20 minutes. */
5991 if (b->auto_save_failure_time >= 0
5992 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5993 continue;
5994
5995 if ((XFASTINT (b->save_length) * 10
5996 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5997 /* A short file is likely to change a large fraction;
5998 spare the user annoying messages. */
5999 && XFASTINT (b->save_length) > 5000
6000 /* These messages are frequent and annoying for `*mail*'. */
6001 && !EQ (b->filename, Qnil)
6002 && NILP (no_message))
6003 {
6004 /* It has shrunk too much; turn off auto-saving here. */
6005 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6006 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6007 b->name, 1);
6008 minibuffer_auto_raise = 0;
6009 /* Turn off auto-saving until there's a real save,
6010 and prevent any more warnings. */
6011 XSETINT (b->save_length, -1);
6012 Fsleep_for (make_number (1), Qnil);
6013 continue;
6014 }
6015 set_buffer_internal (b);
6016 if (!auto_saved && NILP (no_message))
6017 message1 ("Auto-saving...");
6018 internal_condition_case (auto_save_1, Qt, auto_save_error);
6019 auto_saved++;
6020 b->auto_save_modified = BUF_MODIFF (b);
6021 XSETFASTINT (current_buffer->save_length, Z - BEG);
6022 set_buffer_internal (old);
6023
6024 EMACS_GET_TIME (after_time);
6025
6026 /* If auto-save took more than 60 seconds,
6027 assume it was an NFS failure that got a timeout. */
6028 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6029 b->auto_save_failure_time = EMACS_SECS (after_time);
6030 }
6031 }
6032
6033 /* Prevent another auto save till enough input events come in. */
6034 record_auto_save ();
6035
6036 if (auto_saved && NILP (no_message))
6037 {
6038 if (old_message_p)
6039 {
6040 /* If we are going to restore an old message,
6041 give time to read ours. */
6042 sit_for (1, 0, 0, 0, 0);
6043 restore_message ();
6044 }
6045 else
6046 /* If we displayed a message and then restored a state
6047 with no message, leave a "done" message on the screen. */
6048 message1 ("Auto-saving...done");
6049 }
6050
6051 Vquit_flag = oquit;
6052
6053 /* This restores the message-stack status. */
6054 unbind_to (count, Qnil);
6055 return Qnil;
6056 }
6057
6058 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6059 Sset_buffer_auto_saved, 0, 0, 0,
6060 doc: /* Mark current buffer as auto-saved with its current text.
6061 No auto-save file will be written until the buffer changes again. */)
6062 ()
6063 {
6064 current_buffer->auto_save_modified = MODIFF;
6065 XSETFASTINT (current_buffer->save_length, Z - BEG);
6066 current_buffer->auto_save_failure_time = -1;
6067 return Qnil;
6068 }
6069
6070 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6071 Sclear_buffer_auto_save_failure, 0, 0, 0,
6072 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6073 ()
6074 {
6075 current_buffer->auto_save_failure_time = -1;
6076 return Qnil;
6077 }
6078
6079 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6080 0, 0, 0,
6081 doc: /* Return t if current buffer has been auto-saved recently.
6082 More precisely, if it has been auto-saved since last read from or saved
6083 in the visited file. If the buffer has no visited file,
6084 then any auto-save counts as "recent". */)
6085 ()
6086 {
6087 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6088 }
6089 \f
6090 /* Reading and completing file names */
6091 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6092
6093 /* In the string VAL, change each $ to $$ and return the result. */
6094
6095 static Lisp_Object
6096 double_dollars (val)
6097 Lisp_Object val;
6098 {
6099 register const unsigned char *old;
6100 register unsigned char *new;
6101 register int n;
6102 int osize, count;
6103
6104 osize = SBYTES (val);
6105
6106 /* Count the number of $ characters. */
6107 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6108 if (*old++ == '$') count++;
6109 if (count > 0)
6110 {
6111 old = SDATA (val);
6112 val = make_uninit_multibyte_string (SCHARS (val) + count,
6113 osize + count);
6114 new = SDATA (val);
6115 for (n = osize; n > 0; n--)
6116 if (*old != '$')
6117 *new++ = *old++;
6118 else
6119 {
6120 *new++ = '$';
6121 *new++ = '$';
6122 old++;
6123 }
6124 }
6125 return val;
6126 }
6127
6128 static Lisp_Object
6129 read_file_name_cleanup (arg)
6130 Lisp_Object arg;
6131 {
6132 return (current_buffer->directory = arg);
6133 }
6134
6135 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
6136 3, 3, 0,
6137 doc: /* Internal subroutine for read-file-name. Do not call this. */)
6138 (string, dir, action)
6139 Lisp_Object string, dir, action;
6140 /* action is nil for complete, t for return list of completions,
6141 lambda for verify final value */
6142 {
6143 Lisp_Object name, specdir, realdir, val, orig_string;
6144 int changed;
6145 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6146
6147 CHECK_STRING (string);
6148
6149 realdir = dir;
6150 name = string;
6151 orig_string = Qnil;
6152 specdir = Qnil;
6153 changed = 0;
6154 /* No need to protect ACTION--we only compare it with t and nil. */
6155 GCPRO5 (string, realdir, name, specdir, orig_string);
6156
6157 if (SCHARS (string) == 0)
6158 {
6159 if (EQ (action, Qlambda))
6160 {
6161 UNGCPRO;
6162 return Qnil;
6163 }
6164 }
6165 else
6166 {
6167 orig_string = string;
6168 string = Fsubstitute_in_file_name (string);
6169 changed = NILP (Fstring_equal (string, orig_string));
6170 name = Ffile_name_nondirectory (string);
6171 val = Ffile_name_directory (string);
6172 if (! NILP (val))
6173 realdir = Fexpand_file_name (val, realdir);
6174 }
6175
6176 if (NILP (action))
6177 {
6178 specdir = Ffile_name_directory (string);
6179 val = Ffile_name_completion (name, realdir);
6180 UNGCPRO;
6181 if (!STRINGP (val))
6182 {
6183 if (changed)
6184 return double_dollars (string);
6185 return val;
6186 }
6187
6188 if (!NILP (specdir))
6189 val = concat2 (specdir, val);
6190 #ifndef VMS
6191 return double_dollars (val);
6192 #else /* not VMS */
6193 return val;
6194 #endif /* not VMS */
6195 }
6196 UNGCPRO;
6197
6198 if (EQ (action, Qt))
6199 {
6200 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6201 Lisp_Object comp;
6202 int count;
6203
6204 if (NILP (Vread_file_name_predicate)
6205 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6206 return all;
6207
6208 #ifndef VMS
6209 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6210 {
6211 /* Brute-force speed up for directory checking:
6212 Discard strings which don't end in a slash. */
6213 for (comp = Qnil; CONSP (all); all = XCDR (all))
6214 {
6215 Lisp_Object tem = XCAR (all);
6216 int len;
6217 if (STRINGP (tem) &&
6218 (len = SCHARS (tem), len > 0) &&
6219 IS_DIRECTORY_SEP (SREF (tem, len-1)))
6220 comp = Fcons (tem, comp);
6221 }
6222 }
6223 else
6224 #endif
6225 {
6226 /* Must do it the hard (and slow) way. */
6227 GCPRO3 (all, comp, specdir);
6228 count = SPECPDL_INDEX ();
6229 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6230 current_buffer->directory = realdir;
6231 for (comp = Qnil; CONSP (all); all = XCDR (all))
6232 if (!NILP (call1 (Vread_file_name_predicate, XCAR (all))))
6233 comp = Fcons (XCAR (all), comp);
6234 unbind_to (count, Qnil);
6235 UNGCPRO;
6236 }
6237 return Fnreverse (comp);
6238 }
6239
6240 /* Only other case actually used is ACTION = lambda */
6241 #ifdef VMS
6242 /* Supposedly this helps commands such as `cd' that read directory names,
6243 but can someone explain how it helps them? -- RMS */
6244 if (SCHARS (name) == 0)
6245 return Qt;
6246 #endif /* VMS */
6247 string = Fexpand_file_name (string, dir);
6248 if (!NILP (Vread_file_name_predicate))
6249 return call1 (Vread_file_name_predicate, string);
6250 return Ffile_exists_p (string);
6251 }
6252
6253 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6254 Snext_read_file_uses_dialog_p, 0, 0, 0,
6255 doc: /* Return t if a call to `read-file-name' will use a dialog.
6256 The return value is only relevant for a call to `read-file-name' that happens
6257 before any other event (mouse or keypress) is handeled. */)
6258 ()
6259 {
6260 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6261 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6262 && use_dialog_box
6263 && use_file_dialog
6264 && have_menus_p ())
6265 return Qt;
6266 #endif
6267 return Qnil;
6268 }
6269
6270 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6271 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6272 Value is not expanded---you must call `expand-file-name' yourself.
6273 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6274 the same non-empty string that was inserted by this function.
6275 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6276 except that if INITIAL is specified, that combined with DIR is used.)
6277 If the user exits with an empty minibuffer, this function returns
6278 an empty string. (This can only happen if the user erased the
6279 pre-inserted contents or if `insert-default-directory' is nil.)
6280 Fourth arg MUSTMATCH non-nil means require existing file's name.
6281 Non-nil and non-t means also require confirmation after completion.
6282 Fifth arg INITIAL specifies text to start with.
6283 If optional sixth arg PREDICATE is non-nil, possible completions and
6284 the resulting file name must satisfy (funcall PREDICATE NAME).
6285 DIR should be an absolute directory name. It defaults to the value of
6286 `default-directory'.
6287
6288 If this command was invoked with the mouse, use a file dialog box if
6289 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6290 provides a file dialog box.
6291
6292 See also `read-file-name-completion-ignore-case'
6293 and `read-file-name-function'. */)
6294 (prompt, dir, default_filename, mustmatch, initial, predicate)
6295 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6296 {
6297 Lisp_Object val, insdef, tem;
6298 struct gcpro gcpro1, gcpro2;
6299 register char *homedir;
6300 Lisp_Object decoded_homedir;
6301 int replace_in_history = 0;
6302 int add_to_history = 0;
6303 int count;
6304
6305 if (NILP (dir))
6306 dir = current_buffer->directory;
6307 if (NILP (Ffile_name_absolute_p (dir)))
6308 dir = Fexpand_file_name (dir, Qnil);
6309 if (NILP (default_filename))
6310 default_filename
6311 = (!NILP (initial)
6312 ? Fexpand_file_name (initial, dir)
6313 : current_buffer->filename);
6314
6315 /* If dir starts with user's homedir, change that to ~. */
6316 homedir = (char *) egetenv ("HOME");
6317 #ifdef DOS_NT
6318 /* homedir can be NULL in temacs, since Vprocess_environment is not
6319 yet set up. We shouldn't crash in that case. */
6320 if (homedir != 0)
6321 {
6322 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6323 CORRECT_DIR_SEPS (homedir);
6324 }
6325 #endif
6326 if (homedir != 0)
6327 decoded_homedir
6328 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6329 if (homedir != 0
6330 && STRINGP (dir)
6331 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6332 SBYTES (decoded_homedir))
6333 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6334 {
6335 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6336 dir = concat2 (build_string ("~"), dir);
6337 }
6338 /* Likewise for default_filename. */
6339 if (homedir != 0
6340 && STRINGP (default_filename)
6341 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6342 SBYTES (decoded_homedir))
6343 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6344 {
6345 default_filename
6346 = Fsubstring (default_filename,
6347 make_number (SCHARS (decoded_homedir)), Qnil);
6348 default_filename = concat2 (build_string ("~"), default_filename);
6349 }
6350 if (!NILP (default_filename))
6351 {
6352 CHECK_STRING (default_filename);
6353 default_filename = double_dollars (default_filename);
6354 }
6355
6356 if (insert_default_directory && STRINGP (dir))
6357 {
6358 insdef = dir;
6359 if (!NILP (initial))
6360 {
6361 Lisp_Object args[2], pos;
6362
6363 args[0] = insdef;
6364 args[1] = initial;
6365 insdef = Fconcat (2, args);
6366 pos = make_number (SCHARS (double_dollars (dir)));
6367 insdef = Fcons (double_dollars (insdef), pos);
6368 }
6369 else
6370 insdef = double_dollars (insdef);
6371 }
6372 else if (STRINGP (initial))
6373 insdef = Fcons (double_dollars (initial), make_number (0));
6374 else
6375 insdef = Qnil;
6376
6377 if (!NILP (Vread_file_name_function))
6378 {
6379 Lisp_Object args[7];
6380
6381 GCPRO2 (insdef, default_filename);
6382 args[0] = Vread_file_name_function;
6383 args[1] = prompt;
6384 args[2] = dir;
6385 args[3] = default_filename;
6386 args[4] = mustmatch;
6387 args[5] = initial;
6388 args[6] = predicate;
6389 RETURN_UNGCPRO (Ffuncall (7, args));
6390 }
6391
6392 count = SPECPDL_INDEX ();
6393 specbind (intern ("completion-ignore-case"),
6394 read_file_name_completion_ignore_case ? Qt : Qnil);
6395 specbind (intern ("minibuffer-completing-file-name"), Qt);
6396 specbind (intern ("read-file-name-predicate"),
6397 (NILP (predicate) ? Qfile_exists_p : predicate));
6398
6399 GCPRO2 (insdef, default_filename);
6400
6401 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6402 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6403 {
6404 /* If DIR contains a file name, split it. */
6405 Lisp_Object file;
6406 file = Ffile_name_nondirectory (dir);
6407 if (SCHARS (file) && NILP (default_filename))
6408 {
6409 default_filename = file;
6410 dir = Ffile_name_directory (dir);
6411 }
6412 if (!NILP(default_filename))
6413 default_filename = Fexpand_file_name (default_filename, dir);
6414 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch,
6415 EQ (predicate, Qfile_directory_p) ? Qt : Qnil);
6416 add_to_history = 1;
6417 }
6418 else
6419 #endif
6420 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6421 dir, mustmatch, insdef,
6422 Qfile_name_history, default_filename, Qnil);
6423
6424 tem = Fsymbol_value (Qfile_name_history);
6425 if (CONSP (tem) && EQ (XCAR (tem), val))
6426 replace_in_history = 1;
6427
6428 /* If Fcompleting_read returned the inserted default string itself
6429 (rather than a new string with the same contents),
6430 it has to mean that the user typed RET with the minibuffer empty.
6431 In that case, we really want to return ""
6432 so that commands such as set-visited-file-name can distinguish. */
6433 if (EQ (val, default_filename))
6434 {
6435 /* In this case, Fcompleting_read has not added an element
6436 to the history. Maybe we should. */
6437 if (! replace_in_history)
6438 add_to_history = 1;
6439
6440 val = empty_string;
6441 }
6442
6443 unbind_to (count, Qnil);
6444 UNGCPRO;
6445 if (NILP (val))
6446 error ("No file name specified");
6447
6448 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6449
6450 if (!NILP (tem) && !NILP (default_filename))
6451 val = default_filename;
6452 val = Fsubstitute_in_file_name (val);
6453
6454 if (replace_in_history)
6455 /* Replace what Fcompleting_read added to the history
6456 with what we will actually return. */
6457 {
6458 Lisp_Object val1 = double_dollars (val);
6459 tem = Fsymbol_value (Qfile_name_history);
6460 if (history_delete_duplicates)
6461 XSETCDR (tem, Fdelete (val1, XCDR(tem)));
6462 XSETCAR (tem, val1);
6463 }
6464 else if (add_to_history)
6465 {
6466 /* Add the value to the history--but not if it matches
6467 the last value already there. */
6468 Lisp_Object val1 = double_dollars (val);
6469 tem = Fsymbol_value (Qfile_name_history);
6470 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6471 {
6472 if (history_delete_duplicates) tem = Fdelete (val1, tem);
6473 Fset (Qfile_name_history, Fcons (val1, tem));
6474 }
6475 }
6476
6477 return val;
6478 }
6479
6480 \f
6481 void
6482 init_fileio_once ()
6483 {
6484 /* Must be set before any path manipulation is performed. */
6485 XSETFASTINT (Vdirectory_sep_char, '/');
6486 }
6487
6488 \f
6489 void
6490 syms_of_fileio ()
6491 {
6492 Qoperations = intern ("operations");
6493 Qexpand_file_name = intern ("expand-file-name");
6494 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6495 Qdirectory_file_name = intern ("directory-file-name");
6496 Qfile_name_directory = intern ("file-name-directory");
6497 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6498 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6499 Qfile_name_as_directory = intern ("file-name-as-directory");
6500 Qcopy_file = intern ("copy-file");
6501 Qmake_directory_internal = intern ("make-directory-internal");
6502 Qmake_directory = intern ("make-directory");
6503 Qdelete_directory = intern ("delete-directory");
6504 Qdelete_file = intern ("delete-file");
6505 Qrename_file = intern ("rename-file");
6506 Qadd_name_to_file = intern ("add-name-to-file");
6507 Qmake_symbolic_link = intern ("make-symbolic-link");
6508 Qfile_exists_p = intern ("file-exists-p");
6509 Qfile_executable_p = intern ("file-executable-p");
6510 Qfile_readable_p = intern ("file-readable-p");
6511 Qfile_writable_p = intern ("file-writable-p");
6512 Qfile_symlink_p = intern ("file-symlink-p");
6513 Qaccess_file = intern ("access-file");
6514 Qfile_directory_p = intern ("file-directory-p");
6515 Qfile_regular_p = intern ("file-regular-p");
6516 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6517 Qfile_modes = intern ("file-modes");
6518 Qset_file_modes = intern ("set-file-modes");
6519 Qset_file_times = intern ("set-file-times");
6520 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6521 Qinsert_file_contents = intern ("insert-file-contents");
6522 Qwrite_region = intern ("write-region");
6523 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6524 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6525 Qauto_save_coding = intern ("auto-save-coding");
6526
6527 staticpro (&Qoperations);
6528 staticpro (&Qexpand_file_name);
6529 staticpro (&Qsubstitute_in_file_name);
6530 staticpro (&Qdirectory_file_name);
6531 staticpro (&Qfile_name_directory);
6532 staticpro (&Qfile_name_nondirectory);
6533 staticpro (&Qunhandled_file_name_directory);
6534 staticpro (&Qfile_name_as_directory);
6535 staticpro (&Qcopy_file);
6536 staticpro (&Qmake_directory_internal);
6537 staticpro (&Qmake_directory);
6538 staticpro (&Qdelete_directory);
6539 staticpro (&Qdelete_file);
6540 staticpro (&Qrename_file);
6541 staticpro (&Qadd_name_to_file);
6542 staticpro (&Qmake_symbolic_link);
6543 staticpro (&Qfile_exists_p);
6544 staticpro (&Qfile_executable_p);
6545 staticpro (&Qfile_readable_p);
6546 staticpro (&Qfile_writable_p);
6547 staticpro (&Qaccess_file);
6548 staticpro (&Qfile_symlink_p);
6549 staticpro (&Qfile_directory_p);
6550 staticpro (&Qfile_regular_p);
6551 staticpro (&Qfile_accessible_directory_p);
6552 staticpro (&Qfile_modes);
6553 staticpro (&Qset_file_modes);
6554 staticpro (&Qset_file_times);
6555 staticpro (&Qfile_newer_than_file_p);
6556 staticpro (&Qinsert_file_contents);
6557 staticpro (&Qwrite_region);
6558 staticpro (&Qverify_visited_file_modtime);
6559 staticpro (&Qset_visited_file_modtime);
6560 staticpro (&Qauto_save_coding);
6561
6562 Qfile_name_history = intern ("file-name-history");
6563 Fset (Qfile_name_history, Qnil);
6564 staticpro (&Qfile_name_history);
6565
6566 Qfile_error = intern ("file-error");
6567 staticpro (&Qfile_error);
6568 Qfile_already_exists = intern ("file-already-exists");
6569 staticpro (&Qfile_already_exists);
6570 Qfile_date_error = intern ("file-date-error");
6571 staticpro (&Qfile_date_error);
6572 Qexcl = intern ("excl");
6573 staticpro (&Qexcl);
6574
6575 #ifdef DOS_NT
6576 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6577 staticpro (&Qfind_buffer_file_type);
6578 #endif /* DOS_NT */
6579
6580 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6581 doc: /* *Coding system for encoding file names.
6582 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6583 Vfile_name_coding_system = Qnil;
6584
6585 DEFVAR_LISP ("default-file-name-coding-system",
6586 &Vdefault_file_name_coding_system,
6587 doc: /* Default coding system for encoding file names.
6588 This variable is used only when `file-name-coding-system' is nil.
6589
6590 This variable is set/changed by the command `set-language-environment'.
6591 User should not set this variable manually,
6592 instead use `file-name-coding-system' to get a constant encoding
6593 of file names regardless of the current language environment. */);
6594 Vdefault_file_name_coding_system = Qnil;
6595
6596 Qformat_decode = intern ("format-decode");
6597 staticpro (&Qformat_decode);
6598 Qformat_annotate_function = intern ("format-annotate-function");
6599 staticpro (&Qformat_annotate_function);
6600 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6601 staticpro (&Qafter_insert_file_set_coding);
6602
6603 Qcar_less_than_car = intern ("car-less-than-car");
6604 staticpro (&Qcar_less_than_car);
6605
6606 Fput (Qfile_error, Qerror_conditions,
6607 Fcons (Qfile_error, Fcons (Qerror, Qnil)));
6608 Fput (Qfile_error, Qerror_message,
6609 build_string ("File error"));
6610
6611 Fput (Qfile_already_exists, Qerror_conditions,
6612 Fcons (Qfile_already_exists,
6613 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6614 Fput (Qfile_already_exists, Qerror_message,
6615 build_string ("File already exists"));
6616
6617 Fput (Qfile_date_error, Qerror_conditions,
6618 Fcons (Qfile_date_error,
6619 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
6620 Fput (Qfile_date_error, Qerror_message,
6621 build_string ("Cannot set file date"));
6622
6623 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6624 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6625 Vread_file_name_function = Qnil;
6626
6627 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6628 doc: /* Current predicate used by `read-file-name-internal'. */);
6629 Vread_file_name_predicate = Qnil;
6630
6631 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case,
6632 doc: /* *Non-nil means when reading a file name completion ignores case. */);
6633 #if defined VMS || defined DOS_NT || defined MAC_OS
6634 read_file_name_completion_ignore_case = 1;
6635 #else
6636 read_file_name_completion_ignore_case = 0;
6637 #endif
6638
6639 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6640 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6641 If the initial minibuffer contents are non-empty, you can usually
6642 request a default filename by typing RETURN without editing. For some
6643 commands, exiting with an empty minibuffer has a special meaning,
6644 such as making the current buffer visit no file in the case of
6645 `set-visited-file-name'.
6646 If this variable is non-nil, the minibuffer contents are always
6647 initially non-empty and typing RETURN without editing will fetch the
6648 default name, if one is provided. Note however that this default name
6649 is not necessarily the name originally inserted in the minibuffer, if
6650 that is just the default directory.
6651 If this variable is nil, the minibuffer often starts out empty. In
6652 that case you may have to explicitly fetch the next history element to
6653 request the default name. */);
6654 insert_default_directory = 1;
6655
6656 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6657 doc: /* *Non-nil means write new files with record format `stmlf'.
6658 nil means use format `var'. This variable is meaningful only on VMS. */);
6659 vms_stmlf_recfm = 0;
6660
6661 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6662 doc: /* Directory separator character for built-in functions that return file names.
6663 The value is always ?/. Don't use this variable, just use `/'. */);
6664
6665 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6666 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6667 If a file name matches REGEXP, then all I/O on that file is done by calling
6668 HANDLER.
6669
6670 The first argument given to HANDLER is the name of the I/O primitive
6671 to be handled; the remaining arguments are the arguments that were
6672 passed to that primitive. For example, if you do
6673 (file-exists-p FILENAME)
6674 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6675 (funcall HANDLER 'file-exists-p FILENAME)
6676 The function `find-file-name-handler' checks this list for a handler
6677 for its argument. */);
6678 Vfile_name_handler_alist = Qnil;
6679
6680 DEFVAR_LISP ("set-auto-coding-function",
6681 &Vset_auto_coding_function,
6682 doc: /* If non-nil, a function to call to decide a coding system of file.
6683 Two arguments are passed to this function: the file name
6684 and the length of a file contents following the point.
6685 This function should return a coding system to decode the file contents.
6686 It should check the file name against `auto-coding-alist'.
6687 If no coding system is decided, it should check a coding system
6688 specified in the heading lines with the format:
6689 -*- ... coding: CODING-SYSTEM; ... -*-
6690 or local variable spec of the tailing lines with `coding:' tag. */);
6691 Vset_auto_coding_function = Qnil;
6692
6693 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6694 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6695 Each is passed one argument, the number of characters inserted.
6696 It should return the new character count, and leave point the same.
6697 If `insert-file-contents' is intercepted by a handler from
6698 `file-name-handler-alist', that handler is responsible for calling the
6699 functions in `after-insert-file-functions' if appropriate. */);
6700 Vafter_insert_file_functions = Qnil;
6701
6702 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6703 doc: /* A list of functions to be called at the start of `write-region'.
6704 Each is passed two arguments, START and END as for `write-region'.
6705 These are usually two numbers but not always; see the documentation
6706 for `write-region'. The function should return a list of pairs
6707 of the form (POSITION . STRING), consisting of strings to be effectively
6708 inserted at the specified positions of the file being written (1 means to
6709 insert before the first byte written). The POSITIONs must be sorted into
6710 increasing order. If there are several functions in the list, the several
6711 lists are merged destructively. Alternatively, the function can return
6712 with a different buffer current; in that case it should pay attention
6713 to the annotations returned by previous functions and listed in
6714 `write-region-annotations-so-far'.*/);
6715 Vwrite_region_annotate_functions = Qnil;
6716 staticpro (&Qwrite_region_annotate_functions);
6717 Qwrite_region_annotate_functions
6718 = intern ("write-region-annotate-functions");
6719
6720 DEFVAR_LISP ("write-region-annotations-so-far",
6721 &Vwrite_region_annotations_so_far,
6722 doc: /* When an annotation function is called, this holds the previous annotations.
6723 These are the annotations made by other annotation functions
6724 that were already called. See also `write-region-annotate-functions'. */);
6725 Vwrite_region_annotations_so_far = Qnil;
6726
6727 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6728 doc: /* A list of file name handlers that temporarily should not be used.
6729 This applies only to the operation `inhibit-file-name-operation'. */);
6730 Vinhibit_file_name_handlers = Qnil;
6731
6732 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6733 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6734 Vinhibit_file_name_operation = Qnil;
6735
6736 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6737 doc: /* File name in which we write a list of all auto save file names.
6738 This variable is initialized automatically from `auto-save-list-file-prefix'
6739 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6740 a non-nil value. */);
6741 Vauto_save_list_file_name = Qnil;
6742
6743 defsubr (&Sfind_file_name_handler);
6744 defsubr (&Sfile_name_directory);
6745 defsubr (&Sfile_name_nondirectory);
6746 defsubr (&Sunhandled_file_name_directory);
6747 defsubr (&Sfile_name_as_directory);
6748 defsubr (&Sdirectory_file_name);
6749 defsubr (&Smake_temp_name);
6750 defsubr (&Sexpand_file_name);
6751 defsubr (&Ssubstitute_in_file_name);
6752 defsubr (&Scopy_file);
6753 defsubr (&Smake_directory_internal);
6754 defsubr (&Sdelete_directory);
6755 defsubr (&Sdelete_file);
6756 defsubr (&Srename_file);
6757 defsubr (&Sadd_name_to_file);
6758 #ifdef S_IFLNK
6759 defsubr (&Smake_symbolic_link);
6760 #endif /* S_IFLNK */
6761 #ifdef VMS
6762 defsubr (&Sdefine_logical_name);
6763 #endif /* VMS */
6764 #ifdef HPUX_NET
6765 defsubr (&Ssysnetunam);
6766 #endif /* HPUX_NET */
6767 defsubr (&Sfile_name_absolute_p);
6768 defsubr (&Sfile_exists_p);
6769 defsubr (&Sfile_executable_p);
6770 defsubr (&Sfile_readable_p);
6771 defsubr (&Sfile_writable_p);
6772 defsubr (&Saccess_file);
6773 defsubr (&Sfile_symlink_p);
6774 defsubr (&Sfile_directory_p);
6775 defsubr (&Sfile_accessible_directory_p);
6776 defsubr (&Sfile_regular_p);
6777 defsubr (&Sfile_modes);
6778 defsubr (&Sset_file_modes);
6779 defsubr (&Sset_file_times);
6780 defsubr (&Sset_default_file_modes);
6781 defsubr (&Sdefault_file_modes);
6782 defsubr (&Sfile_newer_than_file_p);
6783 defsubr (&Sinsert_file_contents);
6784 defsubr (&Swrite_region);
6785 defsubr (&Scar_less_than_car);
6786 defsubr (&Sverify_visited_file_modtime);
6787 defsubr (&Sclear_visited_file_modtime);
6788 defsubr (&Svisited_file_modtime);
6789 defsubr (&Sset_visited_file_modtime);
6790 defsubr (&Sdo_auto_save);
6791 defsubr (&Sset_buffer_auto_saved);
6792 defsubr (&Sclear_buffer_auto_save_failure);
6793 defsubr (&Srecent_auto_save_p);
6794
6795 defsubr (&Sread_file_name_internal);
6796 defsubr (&Sread_file_name);
6797 defsubr (&Snext_read_file_uses_dialog_p);
6798
6799 #ifdef unix
6800 defsubr (&Sunix_sync);
6801 #endif
6802 }
6803
6804 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6805 (do not change this comment) */