fileio.c 173 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* File IO for GNU Emacs.
2
   Copyright (C) 1985,86,87,88,93,94,95,96,97,98,1999 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20

Dave Love's avatar
Dave Love committed
21 22
#define _GNU_SOURCE		/* for euidaccess */

23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24

25 26 27 28
#if defined (USG5) || defined (BSD_SYSTEM) || defined (LINUX)
#include <fcntl.h>
#endif

29
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
30 31
#include <sys/types.h>
#include <sys/stat.h>
Jim Blandy's avatar
Jim Blandy committed
32

33 34 35 36
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

37 38 39 40
#if !defined (S_ISLNK) && defined (S_IFLNK)
#  define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
#endif

41 42 43 44
#if !defined (S_ISFIFO) && defined (S_IFIFO)
#  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
#endif

45 46 47 48
#if !defined (S_ISREG) && defined (S_IFREG)
#  define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
#endif

Jim Blandy's avatar
Jim Blandy committed
49
#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
50
#include "vms-pwd.h"
Jim Blandy's avatar
Jim Blandy committed
51
#else
Jim Blandy's avatar
Jim Blandy committed
52
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
53 54
#endif

Jim Blandy's avatar
Jim Blandy committed
55
#include <ctype.h>
Jim Blandy's avatar
Jim Blandy committed
56 57

#ifdef VMS
Richard M. Stallman's avatar
Richard M. Stallman committed
58
#include "vmsdir.h"
Jim Blandy's avatar
Jim Blandy committed
59 60 61 62 63
#include <perror.h>
#include <stddef.h>
#include <string.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
64 65
#include <errno.h>

Jim Blandy's avatar
Jim Blandy committed
66
#ifndef vax11c
Jim Blandy's avatar
Jim Blandy committed
67 68 69 70 71 72 73
extern int errno;
#endif

#ifdef APOLLO
#include <sys/time.h>
#endif

74 75 76
#ifndef USG
#ifndef VMS
#ifndef BSD4_1
77
#ifndef WINDOWSNT
78 79 80 81
#define HAVE_FSYNC
#endif
#endif
#endif
82
#endif
83

Jim Blandy's avatar
Jim Blandy committed
84
#include "lisp.h"
85
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
86
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
87 88
#include "charset.h"
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
89 90
#include "window.h"

91 92 93 94 95 96 97
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Eli Zaretskii's avatar
Eli Zaretskii committed
98 99 100 101 102 103 104 105 106
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#if __DJGPP__ >= 2
#include <fcntl.h>
#include <string.h>
#endif
#endif

107 108 109 110 111 112 113 114 115 116 117 118 119
#ifdef DOS_NT
#define CORRECT_DIR_SEPS(s) \
  do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
       else unixtodos_filename (s); \
  } while (0)
/* On Windows, drive letters must be alphabetic - on DOS, the Netware
   redirector allows the six letters between 'Z' and 'a' as well. */
#ifdef MSDOS
#define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
#endif
#ifdef WINDOWSNT
#define IS_DRIVE(x) isalpha (x)
#endif
120 121 122 123
/* Need to lower-case the drive letter, or else expanded
   filenames will sometimes compare inequal, because
   `expand-file-name' doesn't always down-case the drive letter.  */
#define DRIVE_LETTER(x) (tolower (x))
124 125
#endif

Jim Blandy's avatar
Jim Blandy committed
126 127 128 129 130 131 132
#ifdef VMS
#include <file.h>
#include <rmsdef.h>
#include <fab.h>
#include <nam.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
133
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
134 135 136

#ifdef HPUX
#include <netio.h>
Jim Blandy's avatar
Jim Blandy committed
137
#ifndef HPUX8
138
#ifndef HPUX9
Jim Blandy's avatar
Jim Blandy committed
139 140
#include <errnet.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
141
#endif
142
#endif
Jim Blandy's avatar
Jim Blandy committed
143

144 145 146
#include "commands.h"
extern int use_dialog_box;

Jim Blandy's avatar
Jim Blandy committed
147 148 149 150
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
151 152 153 154
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

155 156 157 158
#ifndef S_ISLNK
#  define lstat stat
#endif

Jim Blandy's avatar
Jim Blandy committed
159 160 161 162 163 164 165 166 167 168
#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

/* Nonzero during writing of auto-save files */
int auto_saving;

/* Set by auto_save_1 to mode of original file so Fwrite_region will create
   a new file with the same mode as the original */
int auto_save_mode_bits;

169 170 171
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

172 173 174 175
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

176
/* Alist of elements (REGEXP . HANDLER) for file names
177 178 179
   whose I/O is done with a special handler.  */
Lisp_Object Vfile_name_handler_alist;

180 181 182 183 184 185
/* Format for auto-save files */
Lisp_Object Vauto_save_file_format;

/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

186
/* Function to be called to decide a coding system of a reading file.  */
187
Lisp_Object Vset_auto_coding_function;
188

189 190 191 192 193 194
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;

195 196 197 198
/* During build_annotations, each time an annotation function is called,
   this holds the annotations made by the previous functions.  */
Lisp_Object Vwrite_region_annotations_so_far;

199 200 201
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

Jim Blandy's avatar
Jim Blandy committed
202 203 204 205 206 207 208 209
/* Nonzero means, when reading a filename in the minibuffer,
 start out by inserting the default directory into the minibuffer. */
int insert_default_directory;

/* On VMS, nonzero means write new files with record format stmlf.
   Zero means use var format.  */
int vms_stmlf_recfm;

210 211 212 213
/* On NT, specifies the directory separator character, used (eg.) when
   expanding file names.  This can be bound to / or \. */
Lisp_Object Vdirectory_sep_char;

214 215
extern Lisp_Object Vuser_login_name;

216 217 218 219
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

220 221
extern int minibuf_level;

222 223
extern int minibuffer_auto_raise;

224 225 226 227 228 229 230
/* These variables describe handlers that have "already" had a chance
   to handle the current operation.

   Vinhibit_file_name_handlers is a list of file name handlers.
   Vinhibit_file_name_operation is the operation being handled.
   If we try to handle that operation, we ignore those handlers.  */

231
static Lisp_Object Vinhibit_file_name_handlers;
232
static Lisp_Object Vinhibit_file_name_operation;
233

234
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
235
Lisp_Object Qexcl;
236 237
Lisp_Object Qfile_name_history;

238 239
Lisp_Object Qcar_less_than_car;

240
static int a_write P_ ((int, Lisp_Object, int, int,
241
			Lisp_Object *, struct coding_system *));
242 243
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

244

245
void
Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250
report_file_error (string, data)
     char *string;
     Lisp_Object data;
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
251
  int errorno = errno;
Jim Blandy's avatar
Jim Blandy committed
252

253
  synchronize_system_messages_locale ();
254 255 256
  errstring = code_convert_string_norecord (build_string (strerror (errorno)),
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
257
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
258 259 260 261 262 263 264 265 266 267 268 269 270 271
    switch (errorno)
      {
      case EEXIST:
	Fsignal (Qfile_already_exists, Fcons (errstring, data));
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
	   unless it is followed by a slash.  */
	if (XSTRING (errstring)->data[1] != '/')
	  XSTRING (errstring)->data[0] = DOWNCASE (XSTRING (errstring)->data[0]);

	Fsignal (Qfile_error,
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
272
}
273

274
Lisp_Object
275 276 277
close_file_unwind (fd)
     Lisp_Object fd;
{
278
  emacs_close (XFASTINT (fd));
279
  return Qnil;
280
}
281 282 283

/* Restore point, having saved it as a marker.  */

284
static Lisp_Object
285
restore_point_unwind (location)
286
     Lisp_Object location;
287
{
288
  Fgoto_char (location);
289
  Fset_marker (location, Qnil, Qnil);
290
  return Qnil;
291
}
Jim Blandy's avatar
Jim Blandy committed
292

293
Lisp_Object Qexpand_file_name;
294
Lisp_Object Qsubstitute_in_file_name;
295 296 297
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
298
Lisp_Object Qunhandled_file_name_directory;
299
Lisp_Object Qfile_name_as_directory;
300
Lisp_Object Qcopy_file;
301
Lisp_Object Qmake_directory_internal;
302 303 304 305 306 307 308 309 310
Lisp_Object Qdelete_directory;
Lisp_Object Qdelete_file;
Lisp_Object Qrename_file;
Lisp_Object Qadd_name_to_file;
Lisp_Object Qmake_symbolic_link;
Lisp_Object Qfile_exists_p;
Lisp_Object Qfile_executable_p;
Lisp_Object Qfile_readable_p;
Lisp_Object Qfile_writable_p;
311 312
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
313
Lisp_Object Qfile_directory_p;
314
Lisp_Object Qfile_regular_p;
315 316 317 318 319 320 321
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
322
Lisp_Object Qset_visited_file_modtime;
323

324 325
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
  "Return FILENAME's handler function for OPERATION, if it has one.\n\
326 327
Otherwise, return nil.\n\
A file name is handled if one of the regular expressions in\n\
328
`file-name-handler-alist' matches it.\n\n\
329 330 331
If OPERATION equals `inhibit-file-name-operation', then we ignore\n\
any handlers that are members of `inhibit-file-name-handlers',\n\
but we still do run any other handlers.  This lets handlers\n\
332
use the standard functions without calling themselves recursively.")
333 334
  (filename, operation)
    Lisp_Object filename, operation;
335
{
336
  /* This function must not munge the match data.  */
337
  Lisp_Object chain, inhibited_handlers;
338

339 340
  CHECK_STRING (filename, 0);

341 342 343 344
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
345

346
  for (chain = Vfile_name_handler_alist; CONSP (chain);
347
       chain = XCDR (chain))
348 349
    {
      Lisp_Object elt;
350
      elt = XCAR (chain);
351
      if (CONSP (elt))
352 353
	{
	  Lisp_Object string;
354
	  string = XCAR (elt);
355
	  if (STRINGP (string) && fast_string_match (string, filename) >= 0)
356 357 358
	    {
	      Lisp_Object handler, tem;

359
	      handler = XCDR (elt);
360 361 362 363
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
		return handler;
	    }
364
	}
365 366

      QUIT;
367 368 369 370
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
371 372
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
  1, 1, 0,
373 374
  "Return the directory component in file name FILENAME.\n\
Return nil if FILENAME does not include a directory.\n\
Jim Blandy's avatar
Jim Blandy committed
375 376 377
Otherwise return a directory spec.\n\
Given a Unix syntax file name, returns a string ending in slash;\n\
on VMS, perhaps instead a string ending in `:', `]' or `>'.")
378 379
  (filename)
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
380 381 382
{
  register unsigned char *beg;
  register unsigned char *p;
383
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
384

385
  CHECK_STRING (filename, 0);
Jim Blandy's avatar
Jim Blandy committed
386

387 388
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
389
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
390
  if (!NILP (handler))
391
    return call2 (handler, Qfile_name_directory, filename);
392

393
#ifdef FILE_SYSTEM_CASE
394
  filename = FILE_SYSTEM_CASE (filename);
395
#endif
396
  beg = XSTRING (filename)->data;
397 398 399
#ifdef DOS_NT
  beg = strcpy (alloca (strlen (beg) + 1), beg);
#endif
400
  p = beg + STRING_BYTES (XSTRING (filename));
Jim Blandy's avatar
Jim Blandy committed
401

402
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
403 404 405
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
406
#ifdef DOS_NT
407 408 409 410 411
	 /* only recognise drive specifier at the beginning */
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" and "/:foo" cases correctly  */
	      && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
		  || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
412
#endif
Jim Blandy's avatar
Jim Blandy committed
413 414 415 416
	 ) p--;

  if (p == beg)
    return Qnil;
417
#ifdef DOS_NT
418
  /* Expansion of "c:" to drive and default directory.  */
419
  if (p[-1] == ':')
420 421
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
422
      unsigned char *res = alloca (MAXPATHLEN + 1);
423 424 425 426 427 428 429 430 431 432
      unsigned char *r = res;

      if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
	{
	  strncpy (res, beg, 2);
	  beg += 2;
	  r += 2;
	}

      if (getdefdir (toupper (*beg) - 'A' + 1, r))
433
	{
434
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
435 436 437 438 439
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
440
  CORRECT_DIR_SEPS (beg);
441
#endif /* DOS_NT */
442 443 444 445

  if (STRING_MULTIBYTE (filename))
    return make_string (beg, p - beg);
  return make_unibyte_string (beg, p - beg);
Jim Blandy's avatar
Jim Blandy committed
446 447
}

448 449
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
450
  "Return file name FILENAME sans its directory.\n\
Jim Blandy's avatar
Jim Blandy committed
451 452 453
For example, in a Unix-syntax file name,\n\
this is everything after the last slash,\n\
or the entire name if it contains no slash.")
454 455
  (filename)
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
456 457
{
  register unsigned char *beg, *p, *end;
458
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
459

460
  CHECK_STRING (filename, 0);
Jim Blandy's avatar
Jim Blandy committed
461

462 463
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
464
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
465
  if (!NILP (handler))
466
    return call2 (handler, Qfile_name_nondirectory, filename);
467

468
  beg = XSTRING (filename)->data;
469
  end = p = beg + STRING_BYTES (XSTRING (filename));
Jim Blandy's avatar
Jim Blandy committed
470

471
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
472 473 474
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
475 476
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
477 478 479
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
480
#endif
481 482
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
483

484 485 486
  if (STRING_MULTIBYTE (filename))
    return make_string (p, end - p);
  return make_unibyte_string (p, end - p);
Jim Blandy's avatar
Jim Blandy committed
487
}
488

489 490
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
491 492 493 494
  "Return a directly usable directory name somehow associated with FILENAME.\n\
A `directly usable' directory name is one that may be used without the\n\
intervention of any file handler.\n\
If FILENAME is a directly usable file itself, return\n\
495
\(file-name-directory FILENAME).\n\
496 497 498 499 500 501 502 503 504
The `call-process' and `start-process' functions use this function to\n\
get a current directory to run processes in.")
  (filename)
    Lisp_Object filename;
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
505
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
506 507 508 509 510 511
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
512 513 514 515 516 517 518 519 520

char *
file_name_as_directory (out, in)
     char *out, *in;
{
  int size = strlen (in) - 1;

  strcpy (out, in);

521 522
  if (size < 0)
    {
523 524 525
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
526 527 528
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
#ifdef VMS
  /* Is it already a directory string? */
  if (in[size] == ':' || in[size] == ']' || in[size] == '>')
    return out;
  /* Is it a VMS directory file name?  If so, hack VMS syntax.  */
  else if (! index (in, '/')
	   && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
	       || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
	       || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
				|| ! strncmp (&in[size - 5], ".dir", 4))
		   && (in[size - 1] == '.' || in[size - 1] == ';')
		   && in[size] == '1')))
    {
      register char *p, *dot;
      char brack;

      /* x.dir -> [.x]
	 dir:x.dir --> dir:[x]
	 dir:[x]y.dir --> dir:[x.y] */
      p = in + size;
      while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
      if (p != in)
	{
	  strncpy (out, in, p - in);
	  out[p - in] = '\0';
	  if (*p == ':')
	    {
	      brack = ']';
	      strcat (out, ":[");
	    }
	  else
	    {
	      brack = *p;
	      strcat (out, ".");
	    }
	  p++;
	}
      else
	{
	  brack = ']';
	  strcpy (out, "[.");
	}
Jim Blandy's avatar
Jim Blandy committed
571 572
      dot = index (p, '.');
      if (dot)
Jim Blandy's avatar
Jim Blandy committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
	{
	  /* blindly remove any extension */
	  size = strlen (out) + (dot - p);
	  strncat (out, p, dot - p);
	}
      else
	{
	  strcat (out, p);
	  size = strlen (out);
	}
      out[size++] = brack;
      out[size] = '\0';
    }
#else /* not VMS */
  /* For Unix syntax, Append a slash if necessary */
588
  if (!IS_DIRECTORY_SEP (out[size]))
589 590 591 592
    {
      out[size + 1] = DIRECTORY_SEP;
      out[size + 2] = '\0';
    }
593 594 595
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
#endif /* not VMS */
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
  "Return a string representing file FILENAME interpreted as a directory.\n\
This operation exists because a directory is also a file, but its name as\n\
a directory is different from its name as a file.\n\
The result can be used as the value of `default-directory'\n\
or passed as second argument to `expand-file-name'.\n\
For a Unix-syntax file name, just appends a slash.\n\
On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc.")
  (file)
     Lisp_Object file;
{
  char *buf;
613
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
614 615

  CHECK_STRING (file, 0);
Jim Blandy's avatar
Jim Blandy committed
616
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
617
    return Qnil;
618 619 620

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
621
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
622 623 624
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

625
  buf = (char *) alloca (STRING_BYTES (XSTRING (file)) + 10);
Jim Blandy's avatar
Jim Blandy committed
626 627 628 629 630 631 632 633
  return build_string (file_name_as_directory (buf, XSTRING (file)->data));
}

/*
 * Convert from directory name to filename.
 * On VMS:
 *       xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
 *       xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
634
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638

 * Value is nonzero if the string output is different from the input.
 */

Andreas Schwab's avatar
Andreas Schwab committed
639
int
Jim Blandy's avatar
Jim Blandy committed
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
directory_file_name (src, dst)
     char *src, *dst;
{
  long slen;
#ifdef VMS
  long rlen;
  char * ptr, * rptr;
  char bracket;
  struct FAB fab = cc$rms_fab;
  struct NAM nam = cc$rms_nam;
  char esa[NAM$C_MAXRSS];
#endif /* VMS */

  slen = strlen (src);
#ifdef VMS
  if (! index (src, '/')
      && (src[slen - 1] == ']'
	  || src[slen - 1] == ':'
	  || src[slen - 1] == '>'))
    {
      /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
      fab.fab$l_fna = src;
      fab.fab$b_fns = slen;
      fab.fab$l_nam = &nam;
      fab.fab$l_fop = FAB$M_NAM;

      nam.nam$l_esa = esa;
      nam.nam$b_ess = sizeof esa;
      nam.nam$b_nop |= NAM$M_SYNCHK;

      /* We call SYS$PARSE to handle such things as [--] for us. */
671
      if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
Jim Blandy's avatar
Jim Blandy committed
672 673 674 675 676 677 678 679 680 681 682
	{
	  slen = nam.nam$b_esl;
	  if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
	    slen -= 2;
	  esa[slen] = '\0';
	  src = esa;
	}
      if (src[slen - 1] != ']' && src[slen - 1] != '>')
	{
	  /* what about when we have logical_name:???? */
	  if (src[slen - 1] == ':')
683
	    {                   /* Xlate logical name and see what we get */
Jim Blandy's avatar
Jim Blandy committed
684 685 686 687 688 689 690
	      ptr = strcpy (dst, src); /* upper case for getenv */
	      while (*ptr)
		{
		  if ('a' <= *ptr && *ptr <= 'z')
		    *ptr -= 040;
		  ptr++;
		}
691
	      dst[slen - 1] = 0;        /* remove colon */
Jim Blandy's avatar
Jim Blandy committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
	      if (!(src = egetenv (dst)))
		return 0;
	      /* should we jump to the beginning of this procedure?
		 Good points: allows us to use logical names that xlate
		 to Unix names,
		 Bad points: can be a problem if we just translated to a device
		 name...
		 For now, I'll punt and always expect VMS names, and hope for
		 the best! */
	      slen = strlen (src);
	      if (src[slen - 1] != ']' && src[slen - 1] != '>')
		{ /* no recursion here! */
		  strcpy (dst, src);
		  return 0;
		}
	    }
	  else
709
	    {           /* not a directory spec */
Jim Blandy's avatar
Jim Blandy committed
710 711 712 713 714 715 716 717
	      strcpy (dst, src);
	      return 0;
	    }
	}
      bracket = src[slen - 1];

      /* If bracket is ']' or '>', bracket - 2 is the corresponding
	 opening bracket.  */
Jim Blandy's avatar
Jim Blandy committed
718 719
      ptr = index (src, bracket - 2);
      if (ptr == 0)
Jim Blandy's avatar
Jim Blandy committed
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
	{ /* no opening bracket */
	  strcpy (dst, src);
	  return 0;
	}
      if (!(rptr = rindex (src, '.')))
	rptr = ptr;
      slen = rptr - src;
      strncpy (dst, src, slen);
      dst[slen] = '\0';
      if (*rptr == '.')
	{
	  dst[slen++] = bracket;
	  dst[slen] = '\0';
	}
      else
	{
	  /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
	     then translate the device and recurse. */
	  if (dst[slen - 1] == ':'
739
	      && dst[slen - 2] != ':'   /* skip decnet nodes */
740
	      && strcmp (src + slen, "[000000]") == 0)
Jim Blandy's avatar
Jim Blandy committed
741 742 743 744 745 746 747
	    {
	      dst[slen - 1] = '\0';
	      if ((ptr = egetenv (dst))
		  && (rlen = strlen (ptr) - 1) > 0
		  && (ptr[rlen] == ']' || ptr[rlen] == '>')
		  && ptr[rlen - 1] == '.')
		{
748 749 750 751 752
		  char * buf = (char *) alloca (strlen (ptr) + 1);
		  strcpy (buf, ptr);
		  buf[rlen - 1] = ']';
		  buf[rlen] = '\0';
		  return directory_file_name (buf, dst);
Jim Blandy's avatar
Jim Blandy committed
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
		}
	      else
		dst[slen - 1] = ':';
	    }
	  strcat (dst, "[000000]");
	  slen += 8;
	}
      rptr++;
      rlen = strlen (rptr) - 1;
      strncat (dst, rptr, rlen);
      dst[slen + rlen] = '\0';
      strcat (dst, ".DIR.1");
      return 1;
    }
#endif /* VMS */
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
771 772 773 774 775 776
#ifdef APOLLO
  /* Handle // as root for apollo's.  */
  if ((slen > 2 && dst[slen - 1] == '/')
      || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
    dst[slen - 1] = 0;
#else
777
  if (slen > 1
778
      && IS_DIRECTORY_SEP (dst[slen - 1])
779 780 781 782
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
783
    dst[slen - 1] = 0;
784 785 786
#endif
#ifdef DOS_NT
  CORRECT_DIR_SEPS (dst);
787
#endif
Jim Blandy's avatar
Jim Blandy committed
788 789 790 791 792
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
  1, 1, 0,
793 794
  "Returns the file name of the directory named DIRECTORY.\n\
This is the name of the file that holds the data for the directory DIRECTORY.\n\
Jim Blandy's avatar
Jim Blandy committed
795 796 797 798 799 800 801 802 803
This operation exists because a directory is also a file, but its name as\n\
a directory is different from its name as a file.\n\
In Unix-syntax, this function just removes the final slash.\n\
On VMS, given a VMS-syntax directory name such as \"[X.Y]\",\n\
it returns a file name such as \"[X]Y.DIR.1\".")
  (directory)
     Lisp_Object directory;
{
  char *buf;
804
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
805 806 807

  CHECK_STRING (directory, 0);

Jim Blandy's avatar
Jim Blandy committed
808
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
809
    return Qnil;
810 811 812

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
813
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
814 815 816
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

Jim Blandy's avatar
Jim Blandy committed
817 818 819 820
#ifdef VMS
  /* 20 extra chars is insufficient for VMS, since we might perform a
     logical name translation. an equivalence string can be up to 255
     chars long, so grab that much extra space...  - sss */
821
  buf = (char *) alloca (STRING_BYTES (XSTRING (directory)) + 20 + 255);
Jim Blandy's avatar
Jim Blandy committed
822
#else
823
  buf = (char *) alloca (STRING_BYTES (XSTRING (directory)) + 20);
Jim Blandy's avatar
Jim Blandy committed
824 825 826 827 828
#endif
  directory_file_name (XSTRING (directory)->data, buf);
  return build_string (buf);
}

829 830 831 832 833 834 835 836 837 838 839 840 841
static char make_temp_name_tbl[64] =
{
  'A','B','C','D','E','F','G','H',
  'I','J','K','L','M','N','O','P',
  'Q','R','S','T','U','V','W','X',
  'Y','Z','a','b','c','d','e','f',
  'g','h','i','j','k','l','m','n',
  'o','p','q','r','s','t','u','v',
  'w','x','y','z','0','1','2','3',
  '4','5','6','7','8','9','-','_'
};
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

Jim Blandy's avatar
Jim Blandy committed
842 843 844
DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
  "Generate temporary file name (string) starting with PREFIX (a string).\n\
The Emacs process number forms part of the result,\n\
845
so there is no danger of generating a name being used by another process.\n\
846
\n\
847
In addition, this function makes an attempt to choose a name\n\
848
which has no existing file.  To make this work,\n\
849 850
PREFIX should be an absolute file name.\n\
\n\
851 852
There is a race condition between calling `make-temp-name' and creating the\n\
file which opens all kinds of security holes.  For that reason, you should\n\
853
probably use `make-temp-file' instead.")
Jim Blandy's avatar
Jim Blandy committed
854 855 856 857
  (prefix)
     Lisp_Object prefix;
{
  Lisp_Object val;
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
  int len;
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;

  CHECK_STRING (prefix, 0);

  /* VAL is created by adding 6 characters to PREFIX.  The first
     three are the PID of this process, in base 64, and the second
     three are incremented if the file already exists.  This ensures
     262144 unique file names per PID per PREFIX.  */

  pid = (int) getpid ();

#ifdef HAVE_LONG_FILE_NAMES
  sprintf (pidbuf, "%d", pid);
  pidlen = strlen (pidbuf);
876
#else
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
  pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
  pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
  pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
  pidlen = 3;
#endif

  len = XSTRING (prefix)->size;
  val = make_uninit_string (len + 3 + pidlen);
  data = XSTRING (val)->data;
  bcopy(XSTRING (prefix)->data, data, len);
  p = data + len;

  bcopy (pidbuf, p, pidlen);
  p += pidlen;

  /* Here we try to minimize useless stat'ing when this function is
     invoked many times successively with the same PREFIX.  We achieve
     this by initializing count to a random value, and incrementing it
Richard M. Stallman's avatar
Richard M. Stallman committed
895 896 897 898 899 900
     afterwards.

     We don't want make-temp-name to be called while dumping,
     because then make_temp_name_count_initialized_p would get set
     and then make_temp_name_count would not be set when Emacs starts.  */

901 902 903 904 905 906 907 908 909
  if (!make_temp_name_count_initialized_p)
    {
      make_temp_name_count = (unsigned) time (NULL);
      make_temp_name_count_initialized_p = 1;
    }

  while (1)
    {
      struct stat ignored;
910
      unsigned num = make_temp_name_count;
911 912 913 914 915

      p[0] = make_temp_name_tbl[num & 63], num >>= 6;
      p[1] = make_temp_name_tbl[num & 63], num >>= 6;
      p[2] = make_temp_name_tbl[num & 63], num >>= 6;

916 917 918 919 920
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

921 922 923 924 925 926 927 928 929 930
      if (stat (data, &ignored) < 0)
	{
	  /* We want to return only if errno is ENOENT.  */
	  if (errno == ENOENT)
	    return val;
	  else
	    /* The error here is dubious, but there is little else we
	       can do.  The alternatives are to return nil, which is
	       as bad as (and in many cases worse than) throwing the
	       error, or to ignore the error, which will likely result
931 932 933
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
934 935 936 937 938 939 940 941 942
	    report_file_error ("Cannot create temporary name for prefix `%s'",
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
	 XSTRING (prefix)->data);
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
943
}
944

Jim Blandy's avatar
Jim Blandy committed
945 946

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
947 948 949
  "Convert filename NAME to absolute, and canonicalize it.\n\
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative\n\
 (does not start with slash); if DEFAULT-DIRECTORY is nil or missing,\n\
Jim Blandy's avatar
Jim Blandy committed
950
the current buffer's value of default-directory is used.\n\
951 952
File name components that are `.' are removed, and \n\
so are file name components followed by `..', along with the `..' itself;\n\
Jim Blandy's avatar
Jim Blandy committed
953
note that these simplifications are done without checking the resulting\n\
954
file names in the file system.\n\
Jim Blandy's avatar
Jim Blandy committed
955 956
An initial `~/' expands to your home directory.\n\
An initial `~USER/' expands to USER's home directory.\n\
Jim Blandy's avatar
Jim Blandy committed
957
See also the function `substitute-in-file-name'.")
958
  (name, default_directory)
959
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
960 961
{
  unsigned char *nm;
962

Jim Blandy's avatar
Jim Blandy committed
963 964 965 966 967 968 969 970 971 972 973 974
  register unsigned char *newdir, *p, *o;
  int tlen;
  unsigned char *target;
  struct passwd *pw;
#ifdef VMS
  unsigned char * colon = 0;
  unsigned char * close = 0;
  unsigned char * slash = 0;
  unsigned char * brack = 0;
  int lbrack = 0, rbrack = 0;
  int dots = 0;
#endif /* VMS */
975
#ifdef DOS_NT
976
  int drive = 0;
977
  int collapse_newdir = 1;
978
  int is_escaped = 0;
979
#endif /* DOS_NT */
980
  int length;
981
  Lisp_Object handler;
982

Jim Blandy's avatar
Jim Blandy committed
983 984
  CHECK_STRING (name, 0);

985 986
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
987
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
988
  if (!NILP (handler))
989
    return call3 (handler, Qexpand_file_name, name, default_directory);
990

991 992 993
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
994 995
  if (! STRINGP (default_directory))
    default_directory = build_string ("/");
996

997
  if (!NILP (default_directory))
998
    {
999
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1000
      if (!NILP (handler))
1001
	return call3 (handler, Qexpand_file_name, name, default_directory);
1002
    }
1003

1004
  o = XSTRING (default_directory)->data;
1005

1006
  /* Make sure DEFAULT_DIRECTORY is properly expanded.
1007
     It would be better to do this down below where we actually use
1008
     default_directory.  Unfortunately, calling Fexpand_file_name recursively
1009 1010 1011 1012
     could invoke GC, and the strings might be relocated.  This would
     be annoying because we have pointers into strings lying around
     that would need adjusting, and people would add new pointers to
     the code and forget to adjust them, resulting in intermittent bugs.
1013 1014 1015
     Putting this call here avoids all that crud.

     The EQ test avoids infinite recursion.  */
1016
  if (! NILP (default_directory) && !EQ (default_directory, name)
1017 1018 1019
      /* Save time in some common cases - as long as default_directory
	 is not relative, it can be canonicalized with name below (if it
	 is needed at all) without requiring it to be expanded now.  */
1020
#ifdef DOS_NT
1021
      /* Detect MSDOS file names with drive specifiers.  */
1022
      && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1023 1024 1025
#ifdef WINDOWSNT
      /* Detect Windows file names in UNC format.  */
      && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1026
#endif
1027 1028 1029 1030 1031 1032
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
      && ! (IS_DIRECTORY_SEP (o[0]))
#endif /* not DOS_NT */
      )
1033 1034 1035 1036
    {
      struct gcpro gcpro1;

      GCPRO1 (name);
1037
      default_directory = Fexpand_file_name (default_directory, Qnil);
1038 1039 1040
      UNGCPRO;
    }

Jim Blandy's avatar
Jim Blandy committed
1041 1042 1043 1044
#ifdef VMS
  /* Filenames on VMS are always upper case.  */
  name = Fupcase (name);
#endif
1045 1046 1047
#ifdef FILE_SYSTEM_CASE
  name = FILE_SYSTEM_CASE (name);
#endif
Jim Blandy's avatar
Jim Blandy committed
1048 1049

  nm = XSTRING (name)->data;
1050

1051
#ifdef DOS_NT
1052 1053 1054 1055
  /* We will force directory separators to be either all \ or /, so make
     a local copy to modify, even if there ends up being no change. */
  nm = strcpy (alloca (strlen (nm) + 1), nm);

1056 1057 1058 1059 1060 1061 1062
  /* Note if special escape prefix is present, but remove for now.  */
  if (nm[0] == '/' && nm[1] == ':')
    {
      is_escaped = 1;
      nm += 2;
    }

1063
  /* Find and remove drive specifier if present; this makes nm absolute
1064 1065 1066 1067 1068 1069 1070
     even if the rest of the name appears to be relative.  Only look for
     drive specifier at the beginning.  */
  if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
    {
      drive = nm[0];
      nm += 2;
    }
1071 1072 1073 1074 1075 1076 1077 1078

#ifdef WINDOWSNT
  /* If we see "c://somedir", we want to strip the first slash after the
     colon when stripping the drive letter.  Otherwise, this expands to
     "//somedir".  */
  if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
    nm++;
#endif /* WINDOWSNT */
1079
#endif /* DOS_NT */
1080

1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
#ifdef WINDOWSNT
  /* Discard any previous drive specifier if nm is now in UNC format. */
  if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
    {
      drive = 0;
    }
#endif

  /* If nm is absolute, look for /./ or /../ sequences; if none are
     found, we can probably return right away.  We will avoid allocating
     a new string if name is already fully expanded.  */
Jim Blandy's avatar
Jim Blandy committed
1092
  if (
1093
      IS_DIRECTORY_SEP (nm[0])
1094
#ifdef MSDOS
1095
      && drive && !is_escaped
1096 1097
#endif
#ifdef WINDOWSNT
1098
      && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
1099
#endif
Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102 1103 1104
#ifdef VMS
      || index (nm, ':')
#endif /* VMS */
      )
    {
1105 1106 1107 1108 1109 1110 1111 1112
      /* If it turns out that the filename we want to return is just a
	 suffix of FILENAME, we don't need to go through and edit
	 things; we just need to construct a new string using data
	 starting at the middle of FILENAME.  If we set lose to a
	 non-zero value, that means we've discovered that we can't do
	 that cool trick.  */
      int lose = 0;

Jim Blandy's avatar
Jim Blandy committed
1113 1114 1115
      p = nm;
      while (*p)
	{