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