fileio.c 196 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* File IO for GNU Emacs.
2
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998,
3
     1999, 2000, 2001, 2003, 2004, 2005  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

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

24
#ifdef HAVE_FCNTL_H
25 26 27
#include <fcntl.h>
#endif

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

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

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

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

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

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

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

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

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

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

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

#include "lisp.h"
76
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
77
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
78 79
#include "charset.h"
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
80 81
#include "window.h"

82 83 84 85 86 87 88
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Eli Zaretskii's avatar
Eli Zaretskii committed
89 90 91 92 93 94 95 96 97
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#if __DJGPP__ >= 2
#include <fcntl.h>
#include <string.h>
#endif
#endif

98 99 100 101 102 103 104 105 106 107 108 109 110
#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
111 112 113 114
/* 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))
115 116
#endif

Jim Blandy's avatar
Jim Blandy committed
117 118 119 120 121 122 123
#ifdef VMS
#include <file.h>
#include <rmsdef.h>
#include <fab.h>
#include <nam.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
124
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
125 126 127

#ifdef HPUX
#include <netio.h>
Jim Blandy's avatar
Jim Blandy committed
128
#ifndef HPUX8
129
#ifndef HPUX9
Jim Blandy's avatar
Jim Blandy committed
130 131
#include <errnet.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
132
#endif
133
#endif
Jim Blandy's avatar
Jim Blandy committed
134

135 136
#include "commands.h"
extern int use_dialog_box;
137
extern int use_file_dialog;
138

Jim Blandy's avatar
Jim Blandy committed
139 140 141 142
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
143 144 145 146
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

147 148 149 150
#ifndef S_ISLNK
#  define lstat stat
#endif

151 152 153 154
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
155 156 157 158 159 160 161
/* 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;

162 163 164 165 166 167 168
/* The symbol bound to coding-system-for-read when
   insert-file-contents is called for recovering a file.  This is not
   an actual coding system name, but just an indicator to tell
   insert-file-contents to use `emacs-mule' with a special flag for
   auto saving and recovering a file.  */
Lisp_Object Qauto_save_coding;

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
/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

183
/* Function to be called to decide a coding system of a reading file.  */
184
Lisp_Object Vset_auto_coding_function;
185

186 187 188
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

189
/* Lisp function for setting buffer-file-coding-system and the
190
   multibyteness of the current buffer after inserting a file.  */
191
Lisp_Object Qafter_insert_file_set_coding;
192

193 194
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
195
Lisp_Object Qwrite_region_annotate_functions;
196

197 198 199 200
/* 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;

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

204
/* Function to call to read a file name.  */
205
Lisp_Object Vread_file_name_function;
206 207 208 209

/* Current predicate used by read_file_name_internal.  */
Lisp_Object Vread_file_name_predicate;

210 211 212
/* Nonzero means completion ignores case when reading file name.  */
int read_file_name_completion_ignore_case;

Jim Blandy's avatar
Jim Blandy committed
213 214 215 216 217 218 219 220
/* 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;

221 222 223 224
/* On NT, specifies the directory separator character, used (eg.) when
   expanding file names.  This can be bound to / or \. */
Lisp_Object Vdirectory_sep_char;

225 226
extern Lisp_Object Vuser_login_name;

227 228 229 230
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

231 232
extern int minibuf_level;

233 234
extern int minibuffer_auto_raise;

235 236
extern int history_delete_duplicates;

237 238 239 240 241 242 243
/* 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.  */

244
static Lisp_Object Vinhibit_file_name_handlers;
245
static Lisp_Object Vinhibit_file_name_operation;
246

247
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
248
Lisp_Object Qexcl;
249 250
Lisp_Object Qfile_name_history;

251 252
Lisp_Object Qcar_less_than_car;

253
static int a_write P_ ((int, Lisp_Object, int, int,
254
			Lisp_Object *, struct coding_system *));
255 256
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

257

258
void
Jim Blandy's avatar
Jim Blandy committed
259
report_file_error (string, data)
260
     const char *string;
Jim Blandy's avatar
Jim Blandy committed
261 262 263
     Lisp_Object data;
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
264
  int errorno = errno;
Jim Blandy's avatar
Jim Blandy committed
265

266
  synchronize_system_messages_locale ();
267 268 269
  errstring = code_convert_string_norecord (build_string (strerror (errorno)),
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
270
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
271 272 273 274 275 276 277 278
    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.  */
279
	if (SREF (errstring, 1) != '/')
280
	  SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
Richard M. Stallman's avatar
Richard M. Stallman committed
281 282 283 284

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

287
Lisp_Object
288 289 290
close_file_unwind (fd)
     Lisp_Object fd;
{
291
  emacs_close (XFASTINT (fd));
292
  return Qnil;
293
}
294 295 296

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

297
static Lisp_Object
298
restore_point_unwind (location)
299
     Lisp_Object location;
300
{
301
  Fgoto_char (location);
302
  Fset_marker (location, Qnil, Qnil);
303
  return Qnil;
304
}
Jim Blandy's avatar
Jim Blandy committed
305

306
Lisp_Object Qexpand_file_name;
307
Lisp_Object Qsubstitute_in_file_name;
308 309 310
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
311
Lisp_Object Qunhandled_file_name_directory;
312
Lisp_Object Qfile_name_as_directory;
313
Lisp_Object Qcopy_file;
314
Lisp_Object Qmake_directory_internal;
315
Lisp_Object Qmake_directory;
316 317 318 319 320 321 322 323 324
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;
325 326
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
327
Lisp_Object Qfile_directory_p;
328
Lisp_Object Qfile_regular_p;
329 330 331
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
332
Lisp_Object Qset_file_times;
333 334 335 336
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
337
Lisp_Object Qset_visited_file_modtime;
338

339
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
340 341 342 343 344 345 346 347 348 349 350
       doc: /* Return FILENAME's handler function for OPERATION, if it has one.
Otherwise, return nil.
A file name is handled if one of the regular expressions in
`file-name-handler-alist' matches it.

If OPERATION equals `inhibit-file-name-operation', then we ignore
any handlers that are members of `inhibit-file-name-handlers',
but we still do run any other handlers.  This lets handlers
use the standard functions without calling themselves recursively.  */)
     (filename, operation)
     Lisp_Object filename, operation;
351
{
352
  /* This function must not munge the match data.  */
353
  Lisp_Object chain, inhibited_handlers, result;
354
  int pos = -1;
355

356
  result = Qnil;
357
  CHECK_STRING (filename);
358

359 360 361 362
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
363

364
  for (chain = Vfile_name_handler_alist; CONSP (chain);
365
       chain = XCDR (chain))
366 367
    {
      Lisp_Object elt;
368
      elt = XCAR (chain);
369
      if (CONSP (elt))
370 371
	{
	  Lisp_Object string;
372
	  int match_pos;
373
	  string = XCAR (elt);
374 375
	  if (STRINGP (string)
	      && (match_pos = fast_string_match (string, filename)) > pos)
376 377 378
	    {
	      Lisp_Object handler, tem;

379
	      handler = XCDR (elt);
380 381
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
382 383 384 385
		{
		  result = handler;
		  pos = match_pos;
		}
386
	    }
387
	}
388 389

      QUIT;
390
    }
391
  return result;
392 393
}

Jim Blandy's avatar
Jim Blandy committed
394
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
395 396 397 398 399 400 401
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
Otherwise return a directory spec.
Given a Unix syntax file name, returns a string ending in slash;
on VMS, perhaps instead a string ending in `:', `]' or `>'.  */)
     (filename)
402
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
403
{
404
#ifndef DOS_NT
405
  register const unsigned char *beg;
406 407 408
#else
  register unsigned char *beg;
#endif
409
  register const unsigned char *p;
410
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
411

412
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
413

414 415
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
416
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
417
  if (!NILP (handler))
418
    return call2 (handler, Qfile_name_directory, filename);
419

420
  filename = FILE_SYSTEM_CASE (filename);
421
  beg = SDATA (filename);
422 423 424
#ifdef DOS_NT
  beg = strcpy (alloca (strlen (beg) + 1), beg);
#endif
425
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
426

427
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
428 429 430
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
431
#ifdef DOS_NT
432 433 434 435 436
	 /* 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))))
437
#endif
Jim Blandy's avatar
Jim Blandy committed
438 439 440 441
	 ) p--;

  if (p == beg)
    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 449 450 451 452 453 454 455 456 457
      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))
458
	{
459
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
460 461 462 463 464
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
465
  CORRECT_DIR_SEPS (beg);
466
#endif /* DOS_NT */
467

468
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
469 470
}

471 472
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
473 474 475 476 477
       doc: /* Return file name FILENAME sans its directory.
For example, in a Unix-syntax file name,
this is everything after the last slash,
or the entire name if it contains no slash.  */)
     (filename)
478
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
479
{
480
  register const unsigned char *beg, *p, *end;
481
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
482

483
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
484

485 486
  /* If the file name has special constructs in it,
     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 492
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
493

494
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
495 496 497
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
498 499
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
500 501 502
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
503
#endif
504 505
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
506

507
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
508
}
509

510 511
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
512 513 514 515 516 517 518 519 520
       doc: /* Return a directly usable directory name somehow associated with FILENAME.
A `directly usable' directory name is one that may be used without the
intervention of any file handler.
If FILENAME is a directly usable file itself, return
\(file-name-directory FILENAME).
The `call-process' and `start-process' functions use this function to
get a current directory to run processes in.  */)
     (filename)
     Lisp_Object filename;
521 522 523 524 525
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
526
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
527 528 529 530 531 532
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
533 534 535 536 537 538 539 540 541

char *
file_name_as_directory (out, in)
     char *out, *in;
{
  int size = strlen (in) - 1;

  strcpy (out, in);

542 543
  if (size < 0)
    {
544 545 546
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
547 548 549
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
#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
592 593
      dot = index (p, '.');
      if (dot)
Jim Blandy's avatar
Jim Blandy committed
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
	{
	  /* 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 */
609
  if (!IS_DIRECTORY_SEP (out[size]))
610
    {
611 612
      /* Cannot use DIRECTORY_SEP, which could have any value */
      out[size + 1] = '/';
613 614
      out[size + 2] = '\0';
    }
615 616 617
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
618 619 620 621 622 623
#endif /* not VMS */
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
624
       doc: /* Return a string representing the file name FILE interpreted as a directory.
625 626 627 628 629 630 631
This operation exists because a directory is also a file, but its name as
a directory is different from its name as a file.
The result can be used as the value of `default-directory'
or passed as second argument to `expand-file-name'.
For a Unix-syntax file name, just appends a slash.
On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc.  */)
     (file)
Jim Blandy's avatar
Jim Blandy committed
632 633 634
     Lisp_Object file;
{
  char *buf;
635
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
636

637
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
638
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
639
    return Qnil;
640 641 642

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
643
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
644 645 646
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

647
  buf = (char *) alloca (SBYTES (file) + 10);
648 649 650
  file_name_as_directory (buf, SDATA (file));
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (file));
Jim Blandy's avatar
Jim Blandy committed
651 652 653 654 655 656 657
}

/*
 * Convert from directory name to filename.
 * On VMS:
 *       xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
 *       xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
658
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
659 660 661 662

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

Andreas Schwab's avatar
Andreas Schwab committed
663
int
Jim Blandy's avatar
Jim Blandy committed
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
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. */
695
      if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
Jim Blandy's avatar
Jim Blandy committed
696 697 698 699 700 701 702 703 704 705 706
	{
	  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] == ':')
707
	    {                   /* Xlate logical name and see what we get */
Jim Blandy's avatar
Jim Blandy committed
708 709 710 711 712 713 714
	      ptr = strcpy (dst, src); /* upper case for getenv */
	      while (*ptr)
		{
		  if ('a' <= *ptr && *ptr <= 'z')
		    *ptr -= 040;
		  ptr++;
		}
715
	      dst[slen - 1] = 0;        /* remove colon */
Jim Blandy's avatar
Jim Blandy committed
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
	      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
733
	    {           /* not a directory spec */
Jim Blandy's avatar
Jim Blandy committed
734 735 736 737 738 739 740 741
	      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
742 743
      ptr = index (src, bracket - 2);
      if (ptr == 0)
Jim Blandy's avatar
Jim Blandy committed
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
	{ /* 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] == ':'
763
	      && dst[slen - 2] != ':'   /* skip decnet nodes */
764
	      && strcmp (src + slen, "[000000]") == 0)
Jim Blandy's avatar
Jim Blandy committed
765 766 767 768 769 770 771
	    {
	      dst[slen - 1] = '\0';
	      if ((ptr = egetenv (dst))
		  && (rlen = strlen (ptr) - 1) > 0
		  && (ptr[rlen] == ']' || ptr[rlen] == '>')
		  && ptr[rlen - 1] == '.')
		{
772 773 774 775 776
		  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
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
		}
	      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);
795 796 797 798 799 800
#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
801
  if (slen > 1
802
      && IS_DIRECTORY_SEP (dst[slen - 1])
803 804 805 806
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
807
    dst[slen - 1] = 0;
808 809 810
#endif
#ifdef DOS_NT
  CORRECT_DIR_SEPS (dst);
811
#endif
Jim Blandy's avatar
Jim Blandy committed
812 813 814 815
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
816 817 818 819 820 821 822 823 824
       1, 1, 0,
       doc: /* Returns the file name of the directory named DIRECTORY.
This is the name of the file that holds the data for the directory DIRECTORY.
This operation exists because a directory is also a file, but its name as
a directory is different from its name as a file.
In Unix-syntax, this function just removes the final slash.
On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
it returns a file name such as \"[X]Y.DIR.1\".  */)
     (directory)
Jim Blandy's avatar
Jim Blandy committed
825 826 827
     Lisp_Object directory;
{
  char *buf;
828
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
829

830
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
831

Jim Blandy's avatar
Jim Blandy committed
832
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
833
    return Qnil;
834 835 836

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
837
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
838 839 840
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

Jim Blandy's avatar
Jim Blandy committed
841 842 843 844
#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 */
845
  buf = (char *) alloca (SBYTES (directory) + 20 + 255);
Jim Blandy's avatar
Jim Blandy committed
846
#else
847
  buf = (char *) alloca (SBYTES (directory) + 20);
Jim Blandy's avatar
Jim Blandy committed
848
#endif
849
  directory_file_name (SDATA (directory), buf);
850 851
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
852 853
}

854 855 856 857 858 859 860 861 862 863 864
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','-','_'
};
865

866 867
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

868
/* Value is a temporary file name starting with PREFIX, a string.
869

870 871 872 873 874
   The Emacs process number forms part of the result, so there is
   no danger of generating a name being used by another process.
   In addition, this function makes an attempt to choose a name
   which has no existing file.  To make this work, PREFIX should be
   an absolute file name.
875

876 877 878 879 880 881 882 883 884 885
   BASE64_P non-zero means add the pid as 3 characters in base64
   encoding.  In this case, 6 characters will be added to PREFIX to
   form the file name.  Otherwise, if Emacs is running on a system
   with long file names, add the pid as a decimal number.

   This function signals an error if no unique file name could be
   generated.  */

Lisp_Object
make_temp_name (prefix, base64_p)
Jim Blandy's avatar
Jim Blandy committed
886
     Lisp_Object prefix;
887
     int base64_p;
Jim Blandy's avatar
Jim Blandy committed
888 889
{
  Lisp_Object val;
890
  int len, clen;
891 892 893 894
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
895

896
  CHECK_STRING (prefix);
897 898 899 900 901 902 903 904

  /* 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 ();

905 906 907 908 909 910 911 912 913
  if (base64_p)
    {
      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;
    }
  else
    {
914
#ifdef HAVE_LONG_FILE_NAMES
915 916
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
917
#else
918 919 920 921
      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;
922
#endif
923
    }
924

925 926 927 928
  len = SBYTES (prefix); clen = SCHARS (prefix);
  val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
  if (!STRING_MULTIBYTE (prefix))
    STRING_SET_UNIBYTE (val);
929 930
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
931 932 933 934 935 936 937 938
  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
939 940 941 942 943 944
     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.  */

945 946 947 948 949 950 951 952 953
  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;
954
      unsigned num = make_temp_name_count;
955 956 957 958 959

      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;

960 961 962 963 964
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

965 966 967 968 969 970 971 972 973 974
      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
975 976 977
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
978
	    report_file_error ("Cannot create temporary name for prefix",
979 980 981 982 983 984
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
985
	 SDATA (prefix));
986
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
987
}
988

989 990

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
991 992 993 994 995 996 997 998 999 1000
       doc: /* Generate temporary file name (string) starting with PREFIX (a string).
The Emacs process number forms part of the result,
so there is no danger of generating a name being used by another process.

In addition, this function makes an attempt to choose a name
which has no existing file.  To make this work,
PREFIX should be an absolute file name.

There is a race condition between calling `make-temp-name' and creating the
file which opens all kinds of security holes.  For that reason, you should
1001 1002 1003 1004 1005
probably use `make-temp-file' instead, except in three circumstances:

* If you are creating the file in the user's home directory.
* If you are creating a directory rather than an ordinary file.
* If you are taking special precautions as `make-temp-file' does.  */)
1006
     (prefix)
1007 1008 1009 1010 1011 1012
     Lisp_Object prefix;
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
1013 1014

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1015 1016
       doc: /* Convert filename NAME to absolute, and canonicalize it.
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 1019 1020 1021 1022 1023 1024 1025 1026
the current buffer's value of default-directory is used.
File name components that are `.' are removed, and
so are file name components followed by `..', along with the `..' itself;
note that these simplifications are done without checking the resulting
file names in the file system.
An initial `~/' expands to your home directory.
An initial `~USER/' expands to USER's home directory.
See also the function `substitute-in-file-name'.  */)
     (name, default_directory)
1027
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
1028 1029
{
  unsigned char *nm;
1030

Jim Blandy's avatar
Jim Blandy committed
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
  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 */
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);
Jim Blandy's avatar
Jim Blandy committed
1052

1053 1054
  /* If the file name has special constructs in it,
     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 1060 1061
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
1062
  if (! STRINGP (default_directory))
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
    {
#ifdef DOS_NT
      /* "/" is not considered a root directory on DOS_NT, so using "/"
	 here causes an infinite recursion in, e.g., the following:

            (let (default-directory)
	      (expand-file-name "a"))

	 To avoid this, we set default_directory to the root of the
	 current drive.  */
      extern char *emacs_root_dir (void);

      default_directory = build_string (emacs_root_dir ());
#else
      default_directory = build_string ("/");
#endif
    }