fileio.c 198 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* File IO for GNU Emacs.
2 3 4
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
                 2005 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
extern Lisp_Object Vuser_login_name;

230 231 232 233
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

234 235
extern int minibuf_level;

236 237
extern int minibuffer_auto_raise;

238 239
extern int history_delete_duplicates;

240 241 242 243 244 245 246
/* 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.  */

247
static Lisp_Object Vinhibit_file_name_handlers;
248
static Lisp_Object Vinhibit_file_name_operation;
249

250
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
251
Lisp_Object Qexcl;
252 253
Lisp_Object Qfile_name_history;

254 255
Lisp_Object Qcar_less_than_car;

256
static int a_write P_ ((int, Lisp_Object, int, int,
257
			Lisp_Object *, struct coding_system *));
258 259
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

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

269
  synchronize_system_messages_locale ();
270 271 272
  errstring = code_convert_string_norecord (build_string (strerror (errorno)),
					    Vlocale_coding_system, 0);

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

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

290
Lisp_Object
291 292 293
close_file_unwind (fd)
     Lisp_Object fd;
{
294
  emacs_close (XFASTINT (fd));
295
  return Qnil;
296
}
297 298 299

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

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

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

359
  result = Qnil;
360
  CHECK_STRING (filename);
361

362 363 364 365
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
366

367
  for (chain = Vfile_name_handler_alist; CONSP (chain);
368
       chain = XCDR (chain))
369 370
    {
      Lisp_Object elt;
371
      elt = XCAR (chain);
372
      if (CONSP (elt))
373
	{
374
	  Lisp_Object string = XCAR (elt);
375
	  int match_pos;
376
	  Lisp_Object handler = XCDR (elt);
377 378 379 380
	  Lisp_Object operations = Qnil;

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

382
	  if (STRINGP (string)
383 384
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
385
	    {
386
	      Lisp_Object tem;
387

388
	      handler = XCDR (elt);
389 390
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
391 392 393 394
		{
		  result = handler;
		  pos = match_pos;
		}
395
	    }
396
	}
397 398

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

421
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
422

423 424
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
425
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
426
  if (!NILP (handler))
427
    return call2 (handler, Qfile_name_directory, filename);
428

429
  filename = FILE_SYSTEM_CASE (filename);
430
  beg = SDATA (filename);
431 432 433
#ifdef DOS_NT
  beg = strcpy (alloca (strlen (beg) + 1), beg);
#endif
434
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
435

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

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

477
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
478 479
}

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

492
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
493

494 495
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
496
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
497
  if (!NILP (handler))
498
    return call2 (handler, Qfile_name_nondirectory, filename);
499

500 501
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
502

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

516
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
517
}
518

519 520
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
521 522 523 524 525 526 527 528 529
       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;
530 531 532 533 534
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
535
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
536 537 538 539 540 541
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
542 543 544 545 546 547 548 549 550

char *
file_name_as_directory (out, in)
     char *out, *in;
{
  int size = strlen (in) - 1;

  strcpy (out, in);

551 552
  if (size < 0)
    {
553 554 555
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
556 557 558
      return out;
    }

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

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

646
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
647
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
648
    return Qnil;
649 650 651

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
652
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
653 654 655
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

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

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

Andreas Schwab's avatar
Andreas Schwab committed
672
int
Jim Blandy's avatar
Jim Blandy committed
673 674 675 676 677 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
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. */
704
      if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
Jim Blandy's avatar
Jim Blandy committed
705 706 707 708 709 710 711 712 713 714 715
	{
	  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] == ':')
716
	    {                   /* Xlate logical name and see what we get */
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721 722 723
	      ptr = strcpy (dst, src); /* upper case for getenv */
	      while (*ptr)
		{
		  if ('a' <= *ptr && *ptr <= 'z')
		    *ptr -= 040;
		  ptr++;
		}
724
	      dst[slen - 1] = 0;        /* remove colon */
Jim Blandy's avatar
Jim Blandy committed
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
	      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
742
	    {           /* not a directory spec */
Jim Blandy's avatar
Jim Blandy committed
743 744 745 746 747 748 749 750
	      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
751 752
      ptr = index (src, bracket - 2);
      if (ptr == 0)
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 771
	{ /* 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] == ':'
772
	      && dst[slen - 2] != ':'   /* skip decnet nodes */
773
	      && strcmp (src + slen, "[000000]") == 0)
Jim Blandy's avatar
Jim Blandy committed
774 775 776 777 778 779 780
	    {
	      dst[slen - 1] = '\0';
	      if ((ptr = egetenv (dst))
		  && (rlen = strlen (ptr) - 1) > 0
		  && (ptr[rlen] == ']' || ptr[rlen] == '>')
		  && ptr[rlen - 1] == '.')
		{
781 782 783 784 785
		  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
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
		}
	      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);
804 805 806 807 808 809
#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
810
  if (slen > 1
811
      && IS_DIRECTORY_SEP (dst[slen - 1])
812 813 814 815
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
816
    dst[slen - 1] = 0;
817 818 819
#endif
#ifdef DOS_NT
  CORRECT_DIR_SEPS (dst);
820
#endif
Jim Blandy's avatar
Jim Blandy committed
821 822 823 824
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
825 826 827 828 829 830 831 832 833
       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
834 835 836
     Lisp_Object directory;
{
  char *buf;
837
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
838

839
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
840

Jim Blandy's avatar
Jim Blandy committed
841
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
842
    return Qnil;
843 844 845

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
846
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
847 848 849
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

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

863 864 865 866 867 868 869 870 871 872 873
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','-','_'
};
874

875 876
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

877
/* Value is a temporary file name starting with PREFIX, a string.
878

879 880 881 882 883
   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.
884

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

905
  CHECK_STRING (prefix);
906 907 908 909 910 911 912 913

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

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

934 935 936 937
  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);
938 939
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
940 941 942 943 944 945 946 947
  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
948 949 950 951 952 953
     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.  */

954 955 956 957 958 959 960 961 962
  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;
963
      unsigned num = make_temp_name_count;
964 965 966 967 968

      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;

969 970 971 972 973
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

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

  error ("Cannot create temporary name for prefix `%s'",
994
	 SDATA (prefix));
995
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
996
}
997

998 999

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


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

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

1061
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
1062

1063 1064
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
1065
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
1066
  if (!NILP (handler))
1067
    return call3 (handler, Qexpand_file_name, name, default_directory);
1068