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

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
10
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

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

25
#ifdef HAVE_FCNTL_H
26 27 28
#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

49
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
50
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
51 52
#endif

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

161 162 163 164 165 166 167
/* 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;

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

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

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

179 180 181 182
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

183 184 185
/* 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
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

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

196 197
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
198
Lisp_Object Qwrite_region_annotate_functions;
199

200 201 202 203
/* 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;

204 205 206
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

207
/* Function to call to read a file name.  */
208
Lisp_Object Vread_file_name_function;
209 210 211 212

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

213 214 215
/* Nonzero means completion ignores case when reading file name.  */
int read_file_name_completion_ignore_case;

Jim Blandy's avatar
Jim Blandy committed
216 217 218 219 220 221 222 223
/* 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;

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

228 229 230 231 232
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

233 234
extern Lisp_Object Vuser_login_name;

235 236 237 238
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

239 240
extern int minibuf_level;

241 242
extern int minibuffer_auto_raise;

243 244
extern int history_delete_duplicates;

245 246 247 248 249 250 251
/* 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.  */

252
static Lisp_Object Vinhibit_file_name_handlers;
253
static Lisp_Object Vinhibit_file_name_operation;
254

255
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
256
Lisp_Object Qexcl;
257 258
Lisp_Object Qfile_name_history;

259 260
Lisp_Object Qcar_less_than_car;

261
static int a_write P_ ((int, Lisp_Object, int, int,
262
			Lisp_Object *, struct coding_system *));
263 264
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

265

266
void
Jim Blandy's avatar
Jim Blandy committed
267
report_file_error (string, data)
268
     const char *string;
Jim Blandy's avatar
Jim Blandy committed
269 270 271
     Lisp_Object data;
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
272
  int errorno = errno;
Jim Blandy's avatar
Jim Blandy committed
273

274
  synchronize_system_messages_locale ();
275 276 277
  errstring = code_convert_string_norecord (build_string (strerror (errorno)),
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
278
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
279 280 281 282 283 284 285 286
    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.  */
287
	if (SREF (errstring, 1) != '/')
288
	  SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
Richard M. Stallman's avatar
Richard M. Stallman committed
289 290 291 292

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

295
Lisp_Object
296 297 298
close_file_unwind (fd)
     Lisp_Object fd;
{
299
  emacs_close (XFASTINT (fd));
300
  return Qnil;
301
}
302 303 304

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

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

347
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
348 349 350 351 352 353 354 355 356 357 358
       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;
359
{
360
  /* This function must not munge the match data.  */
361
  Lisp_Object chain, inhibited_handlers, result;
362
  int pos = -1;
363

364
  result = Qnil;
365
  CHECK_STRING (filename);
366

367 368 369 370
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
371

372
  for (chain = Vfile_name_handler_alist; CONSP (chain);
373
       chain = XCDR (chain))
374 375
    {
      Lisp_Object elt;
376
      elt = XCAR (chain);
377
      if (CONSP (elt))
378
	{
379
	  Lisp_Object string = XCAR (elt);
380
	  int match_pos;
381
	  Lisp_Object handler = XCDR (elt);
382 383 384 385
	  Lisp_Object operations = Qnil;

	  if (SYMBOLP (handler))
	    operations = Fget (handler, Qoperations);
386

387
	  if (STRINGP (string)
388 389
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
390
	    {
391
	      Lisp_Object tem;
392

393
	      handler = XCDR (elt);
394 395
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
396 397 398 399
		{
		  result = handler;
		  pos = match_pos;
		}
400
	    }
401
	}
402 403

      QUIT;
404
    }
405
  return result;
406 407
}

Jim Blandy's avatar
Jim Blandy committed
408
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
409 410 411 412 413 414 415
       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)
416
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
417
{
418
#ifndef DOS_NT
419
  register const unsigned char *beg;
420 421 422
#else
  register unsigned char *beg;
#endif
423
  register const unsigned char *p;
424
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
425

426
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
427

428 429
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
430
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
431
  if (!NILP (handler))
432
    return call2 (handler, Qfile_name_directory, filename);
433

434
  filename = FILE_SYSTEM_CASE (filename);
435
  beg = SDATA (filename);
436 437 438
#ifdef DOS_NT
  beg = strcpy (alloca (strlen (beg) + 1), beg);
#endif
439
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
440

441
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
442 443 444
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
445
#ifdef DOS_NT
446 447 448 449 450
	 /* 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))))
451
#endif
Jim Blandy's avatar
Jim Blandy committed
452 453 454 455
	 ) p--;

  if (p == beg)
    return Qnil;
456
#ifdef DOS_NT
457
  /* Expansion of "c:" to drive and default directory.  */
458
  if (p[-1] == ':')
459 460
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
461
      unsigned char *res = alloca (MAXPATHLEN + 1);
462 463 464 465 466 467 468 469 470 471
      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))
472
	{
473
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
474 475 476 477 478
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
479
  CORRECT_DIR_SEPS (beg);
480
#endif /* DOS_NT */
481

482
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
483 484
}

485 486
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
487 488 489 490 491
       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)
492
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
493
{
494
  register const unsigned char *beg, *p, *end;
495
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
496

497
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
498

499 500
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
501
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
502
  if (!NILP (handler))
503
    return call2 (handler, Qfile_name_nondirectory, filename);
504

505 506
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
507

508
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
509 510 511
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
512 513
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
514 515 516
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
517
#endif
518 519
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
520

521
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
522
}
523

524 525
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
526 527 528 529 530 531 532 533 534
       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;
535 536 537 538 539
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
540
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
541 542 543 544 545 546
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552 553 554 555

char *
file_name_as_directory (out, in)
     char *out, *in;
{
  int size = strlen (in) - 1;

  strcpy (out, in);

556 557
  if (size < 0)
    {
558 559 560
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
561 562 563
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
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 592 593 594 595 596 597 598 599 600 601 602 603 604 605
#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
606 607
      dot = index (p, '.');
      if (dot)
Jim Blandy's avatar
Jim Blandy committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
	{
	  /* 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 */
623
  if (!IS_DIRECTORY_SEP (out[size]))
624
    {
625 626
      /* Cannot use DIRECTORY_SEP, which could have any value */
      out[size + 1] = '/';
627 628
      out[size + 2] = '\0';
    }
629 630 631
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
632 633 634 635 636 637
#endif /* not VMS */
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
638
       doc: /* Return a string representing the file name FILE interpreted as a directory.
639 640 641 642 643 644 645
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
646 647 648
     Lisp_Object file;
{
  char *buf;
649
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
650

651
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
652
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
653
    return Qnil;
654 655 656

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
657
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
658 659 660
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

661
  buf = (char *) alloca (SBYTES (file) + 10);
662 663 664
  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
665 666 667 668 669 670 671
}

/*
 * Convert from directory name to filename.
 * On VMS:
 *       xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
 *       xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
672
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
673 674 675 676

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

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

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
830 831 832 833 834 835 836 837 838
       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
839 840 841
     Lisp_Object directory;
{
  char *buf;
842
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
843

844
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
845

Jim Blandy's avatar
Jim Blandy committed
846
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
847
    return Qnil;
848 849 850

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
851
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
852 853 854
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

Jim Blandy's avatar
Jim Blandy committed
855 856 857 858
#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 */
859
  buf = (char *) alloca (SBYTES (directory) + 20 + 255);
Jim Blandy's avatar
Jim Blandy committed
860
#else
861
  buf = (char *) alloca (SBYTES (directory) + 20);
Jim Blandy's avatar
Jim Blandy committed
862
#endif
863
  directory_file_name (SDATA (directory), buf);
864 865
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
866 867
}

868 869 870 871 872 873 874 875 876 877 878
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','-','_'
};
879

880 881
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

882
/* Value is a temporary file name starting with PREFIX, a string.
883

884 885 886 887 888
   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.
889

890 891 892 893 894 895 896 897 898 899
   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
900
     Lisp_Object prefix;
901
     int base64_p;
Jim Blandy's avatar
Jim Blandy committed
902 903
{
  Lisp_Object val;
904
  int len, clen;
905 906 907 908
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
909

910
  CHECK_STRING (prefix);
911 912 913 914 915 916 917 918

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

919 920 921 922 923 924 925 926 927
  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
    {
928
#ifdef HAVE_LONG_FILE_NAMES
929 930
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
931
#else
932 933 934 935
      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;
936
#endif
937
    }
938

939 940 941 942
  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);
943 944
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
945 946 947 948 949 950 951 952
  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
953 954 955 956 957 958
     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.  */

959 960 961 962 963 964 965 966 967
  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;
968
      unsigned num = make_temp_name_count;
969 970 971 972 973

      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;

974 975 976 977 978
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

979 980 981 982 983 984 985 986 987 988
      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
989 990 991
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
992
	    report_file_error ("Cannot create temporary name for prefix",
993 994 995 996 997 998
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
999
	 SDATA (prefix));
1000
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
1001
}
1002

1003 1004

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
       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
1015 1016 1017 1018 1019
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.  */)
1020
     (prefix)
1021 1022 1023 1024 1025 1026
     Lisp_Object prefix;
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
1027 1028

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1029 1030
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1031
\(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1032
the current buffer's value of `default-directory' is used.
1033 1034 1035 1036 1037 1038 1039 1040
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)
1041
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
1042 1043
{
  unsigned char *nm;
1044

Jim Blandy's avatar
Jim Blandy committed
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
  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 */
1057
#ifdef DOS_NT
1058
  int drive = 0;
1059
  int collapse_newdir = 1;
1060
  int is_escaped = 0;
1061
#endif /* DOS_NT */
1062
  int length;
1063
  Lisp_Object handler, result;
1064
  int multibyte;
1065

1066
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
1067

1068 1069
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
1070
  handler = Ffind_file_name_handler (name, Qexpand_file_name);