Fix bug #15148 with garbled display in Dired when cache-long-scans is ON.
[bpt/emacs.git] / src / callproc.c
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2013
3 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <sys/types.h>
25 #include <unistd.h>
26
27 #include <sys/file.h>
28 #include <fcntl.h>
29
30 #include "lisp.h"
31
32 #ifdef WINDOWSNT
33 #define NOMINMAX
34 #include <sys/socket.h> /* for fcntl */
35 #include <windows.h>
36 #include "w32.h"
37 #define _P_NOWAIT 1 /* from process.h */
38 #endif
39
40 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
41 #include <sys/stat.h>
42 #include <sys/param.h>
43 #endif /* MSDOS */
44
45 #include "commands.h"
46 #include "character.h"
47 #include "buffer.h"
48 #include "ccl.h"
49 #include "coding.h"
50 #include "composite.h"
51 #include <epaths.h>
52 #include "process.h"
53 #include "syssignal.h"
54 #include "systty.h"
55 #include "syswait.h"
56 #include "blockinput.h"
57 #include "frame.h"
58 #include "termhooks.h"
59
60 #ifdef MSDOS
61 #include "msdos.h"
62 #endif
63
64 #ifdef HAVE_NS
65 #include "nsterm.h"
66 #endif
67
68 /* Pattern used by call-process-region to make temp files. */
69 static Lisp_Object Vtemp_file_name_pattern;
70
71 /* The next two variables are used while record-unwind-protect is in place
72 during call-process for a subprocess for which record_deleted_pid has
73 not yet been called. At other times, synch_process_pid is zero and
74 synch_process_tempfile's contents are irrelevant. Doing this via static
75 C variables is more convenient than putting them into the arguments
76 of record-unwind-protect, as they need to be updated at randomish
77 times in the code, and Lisp cannot always store these values as
78 Emacs integers. It's safe to use static variables here, as the
79 code is never invoked reentrantly. */
80
81 /* If nonzero, a process-ID that has not been reaped. */
82 static pid_t synch_process_pid;
83
84 /* If a string, the name of a temp file that has not been removed. */
85 #ifdef MSDOS
86 static Lisp_Object synch_process_tempfile;
87 #else
88 # define synch_process_tempfile make_number (0)
89 #endif
90
91 /* Indexes of file descriptors that need closing on call_process_kill. */
92 enum
93 {
94 /* The subsidiary process's stdout and stderr. stdin is handled
95 separately, in either Fcall_process_region or create_temp_file. */
96 CALLPROC_STDOUT, CALLPROC_STDERR,
97
98 /* How to read from a pipe (or substitute) from the subsidiary process. */
99 CALLPROC_PIPEREAD,
100
101 /* A bound on the number of file descriptors. */
102 CALLPROC_FDS
103 };
104
105 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
106 \f
107 /* Block SIGCHLD. */
108
109 void
110 block_child_signal (void)
111 {
112 sigset_t blocked;
113 sigemptyset (&blocked);
114 sigaddset (&blocked, SIGCHLD);
115 pthread_sigmask (SIG_BLOCK, &blocked, 0);
116 }
117
118 /* Unblock SIGCHLD. */
119
120 void
121 unblock_child_signal (void)
122 {
123 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
124 }
125
126 /* Return the current buffer's working directory, or the home
127 directory if it's unreachable, as a string suitable for a system call.
128 Signal an error if the result would not be an accessible directory. */
129
130 Lisp_Object
131 encode_current_directory (void)
132 {
133 Lisp_Object dir;
134 struct gcpro gcpro1;
135
136 dir = BVAR (current_buffer, directory);
137 GCPRO1 (dir);
138
139 dir = Funhandled_file_name_directory (dir);
140
141 /* If the file name handler says that dir is unreachable, use
142 a sensible default. */
143 if (NILP (dir))
144 dir = build_string ("~");
145
146 dir = expand_and_dir_to_file (dir, Qnil);
147
148 if (STRING_MULTIBYTE (dir))
149 dir = ENCODE_FILE (dir);
150 if (! file_accessible_directory_p (SSDATA (dir)))
151 report_file_error ("Setting current directory",
152 BVAR (current_buffer, directory));
153
154 RETURN_UNGCPRO (dir);
155 }
156
157 /* If P is reapable, record it as a deleted process and kill it.
158 Do this in a critical section. Unless PID is wedged it will be
159 reaped on receipt of the first SIGCHLD after the critical section. */
160
161 void
162 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
163 {
164 block_child_signal ();
165
166 if (p->alive)
167 {
168 record_deleted_pid (p->pid, tempfile);
169 p->alive = 0;
170 kill (- p->pid, SIGKILL);
171 }
172
173 unblock_child_signal ();
174 }
175
176 /* Clean up files, file descriptors and processes created by Fcall_process. */
177
178 static void
179 delete_temp_file (Lisp_Object name)
180 {
181 unlink (SSDATA (name));
182 }
183
184 static void
185 call_process_kill (void *ptr)
186 {
187 int *callproc_fd = ptr;
188 int i;
189 for (i = 0; i < CALLPROC_FDS; i++)
190 if (0 <= callproc_fd[i])
191 emacs_close (callproc_fd[i]);
192
193 if (synch_process_pid)
194 {
195 struct Lisp_Process proc;
196 proc.alive = 1;
197 proc.pid = synch_process_pid;
198 record_kill_process (&proc, synch_process_tempfile);
199 synch_process_pid = 0;
200 }
201 else if (STRINGP (synch_process_tempfile))
202 delete_temp_file (synch_process_tempfile);
203 }
204
205 /* Clean up when exiting Fcall_process: restore the buffer, and
206 kill the subsidiary process group if the process still exists. */
207
208 static void
209 call_process_cleanup (Lisp_Object buffer)
210 {
211 Fset_buffer (buffer);
212
213 if (synch_process_pid)
214 {
215 kill (-synch_process_pid, SIGINT);
216 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
217 immediate_quit = 1;
218 QUIT;
219 wait_for_termination (synch_process_pid, 0, 1);
220 synch_process_pid = 0;
221 immediate_quit = 0;
222 message1 ("Waiting for process to die...done");
223 }
224 }
225
226 #ifdef DOS_NT
227 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
228 #else
229 static mode_t const default_output_mode = 0666;
230 #endif
231
232 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
233 doc: /* Call PROGRAM synchronously in separate process.
234 The remaining arguments are optional.
235 The program's input comes from file INFILE (nil means `/dev/null').
236 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
237 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
238 FILE is a file name string, means that it should be written to that file
239 \(if the file already exists it is overwritten).
240 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
241 REAL-BUFFER says what to do with standard output, as above,
242 while STDERR-FILE says what to do with standard error in the child.
243 STDERR-FILE may be nil (discard standard error output),
244 t (mix it with ordinary output), or a file name string.
245
246 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
247 Remaining arguments are strings passed as command arguments to PROGRAM.
248
249 If executable PROGRAM can't be found as an executable, `call-process'
250 signals a Lisp error. `call-process' reports errors in execution of
251 the program only through its return and output.
252
253 If DESTINATION is 0, `call-process' returns immediately with value nil.
254 Otherwise it waits for PROGRAM to terminate
255 and returns a numeric exit status or a signal description string.
256 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
257
258 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
259 (ptrdiff_t nargs, Lisp_Object *args)
260 {
261 Lisp_Object infile, encoded_infile;
262 int filefd;
263 struct gcpro gcpro1;
264 ptrdiff_t count = SPECPDL_INDEX ();
265
266 if (nargs >= 2 && ! NILP (args[1]))
267 {
268 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
269 CHECK_STRING (infile);
270 }
271 else
272 infile = build_string (NULL_DEVICE);
273
274 GCPRO1 (infile);
275 encoded_infile = STRING_MULTIBYTE (infile) ? ENCODE_FILE (infile) : infile;
276
277 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
278 if (filefd < 0)
279 report_file_error ("Opening process input file", infile);
280 record_unwind_protect_int (close_file_unwind, filefd);
281 UNGCPRO;
282 return unbind_to (count, call_process (nargs, args, filefd, -1));
283 }
284
285 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
286
287 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
288 unwinder that is intended to remove the input temporary file; in
289 this case NARGS must be at least 2 and ARGS[1] is the file's name.
290
291 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
292
293 static Lisp_Object
294 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
295 ptrdiff_t tempfile_index)
296 {
297 Lisp_Object buffer, current_dir, path;
298 bool display_p;
299 int fd0;
300 int callproc_fd[CALLPROC_FDS];
301 int status;
302 ptrdiff_t i;
303 ptrdiff_t count = SPECPDL_INDEX ();
304 USE_SAFE_ALLOCA;
305
306 char **new_argv;
307 /* File to use for stderr in the child.
308 t means use same as standard output. */
309 Lisp_Object error_file;
310 Lisp_Object output_file = Qnil;
311 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
312 char *tempfile = NULL;
313 int pid;
314 #else
315 pid_t pid;
316 #endif
317 int child_errno;
318 int fd_output, fd_error;
319 struct coding_system process_coding; /* coding-system of process output */
320 struct coding_system argument_coding; /* coding-system of arguments */
321 /* Set to the return value of Ffind_operation_coding_system. */
322 Lisp_Object coding_systems;
323 bool discard_output;
324
325 if (synch_process_pid)
326 error ("call-process invoked recursively");
327
328 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
329 coding_systems = Qt;
330
331 CHECK_STRING (args[0]);
332
333 error_file = Qt;
334
335 #ifndef subprocesses
336 /* Without asynchronous processes we cannot have BUFFER == 0. */
337 if (nargs >= 3
338 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
339 error ("Operating system cannot handle asynchronous subprocesses");
340 #endif /* subprocesses */
341
342 /* Decide the coding-system for giving arguments. */
343 {
344 Lisp_Object val, *args2;
345
346 /* If arguments are supplied, we may have to encode them. */
347 if (nargs >= 5)
348 {
349 bool must_encode = 0;
350 Lisp_Object coding_attrs;
351
352 for (i = 4; i < nargs; i++)
353 CHECK_STRING (args[i]);
354
355 for (i = 4; i < nargs; i++)
356 if (STRING_MULTIBYTE (args[i]))
357 must_encode = 1;
358
359 if (!NILP (Vcoding_system_for_write))
360 val = Vcoding_system_for_write;
361 else if (! must_encode)
362 val = Qraw_text;
363 else
364 {
365 SAFE_NALLOCA (args2, 1, nargs + 1);
366 args2[0] = Qcall_process;
367 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
368 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
369 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
370 }
371 val = complement_process_encoding_system (val);
372 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
373 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
374 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
375 {
376 /* We should not use an ASCII incompatible coding system. */
377 val = raw_text_coding_system (val);
378 setup_coding_system (val, &argument_coding);
379 }
380 }
381 }
382
383 if (nargs < 3)
384 buffer = Qnil;
385 else
386 {
387 buffer = args[2];
388
389 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
390 FILE-FOR-STDERR), unless the first element is :file, in which case see
391 the next paragraph. */
392 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
393 {
394 if (CONSP (XCDR (buffer)))
395 {
396 Lisp_Object stderr_file;
397 stderr_file = XCAR (XCDR (buffer));
398
399 if (NILP (stderr_file) || EQ (Qt, stderr_file))
400 error_file = stderr_file;
401 else
402 error_file = Fexpand_file_name (stderr_file, Qnil);
403 }
404
405 buffer = XCAR (buffer);
406 }
407
408 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
409 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
410 {
411 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
412 BVAR (current_buffer, directory));
413 CHECK_STRING (output_file);
414 buffer = Qnil;
415 }
416
417 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
418 {
419 Lisp_Object spec_buffer;
420 spec_buffer = buffer;
421 buffer = Fget_buffer_create (buffer);
422 /* Mention the buffer name for a better error message. */
423 if (NILP (buffer))
424 CHECK_BUFFER (spec_buffer);
425 CHECK_BUFFER (buffer);
426 }
427 }
428
429 /* Make sure that the child will be able to chdir to the current
430 buffer's current directory, or its unhandled equivalent. We
431 can't just have the child check for an error when it does the
432 chdir, since it's in a vfork.
433
434 We have to GCPRO around this because Fexpand_file_name,
435 Funhandled_file_name_directory, and Ffile_accessible_directory_p
436 might call a file name handling function. The argument list is
437 protected by the caller, so all we really have to worry about is
438 buffer. */
439 {
440 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
441
442 current_dir = encode_current_directory ();
443
444 GCPRO4 (buffer, current_dir, error_file, output_file);
445
446 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
447 error_file = ENCODE_FILE (error_file);
448 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
449 output_file = ENCODE_FILE (output_file);
450 UNGCPRO;
451 }
452
453 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
454
455 for (i = 0; i < CALLPROC_FDS; i++)
456 callproc_fd[i] = -1;
457 #ifdef MSDOS
458 synch_process_tempfile = make_number (0);
459 #endif
460 record_unwind_protect_ptr (call_process_kill, callproc_fd);
461
462 /* Search for program; barf if not found. */
463 {
464 struct gcpro gcpro1, gcpro2, gcpro3;
465 int ok;
466
467 GCPRO3 (buffer, current_dir, error_file);
468 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
469 UNGCPRO;
470 if (ok < 0)
471 report_file_error ("Searching for program", args[0]);
472 }
473
474 /* If program file name starts with /: for quoting a magic name,
475 discard that. */
476 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
477 && SREF (path, 1) == ':')
478 path = Fsubstring (path, make_number (2), Qnil);
479
480 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
481
482 {
483 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
484
485 GCPRO4 (buffer, current_dir, path, error_file);
486 if (nargs > 4)
487 {
488 ptrdiff_t i;
489
490 argument_coding.dst_multibyte = 0;
491 for (i = 4; i < nargs; i++)
492 {
493 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
494 if (CODING_REQUIRE_ENCODING (&argument_coding))
495 /* We must encode this argument. */
496 args[i] = encode_coding_string (&argument_coding, args[i], 1);
497 }
498 for (i = 4; i < nargs; i++)
499 new_argv[i - 3] = SSDATA (args[i]);
500 new_argv[i - 3] = 0;
501 }
502 else
503 new_argv[1] = 0;
504 if (STRING_MULTIBYTE (path))
505 path = ENCODE_FILE (path);
506 new_argv[0] = SSDATA (path);
507 UNGCPRO;
508 }
509
510 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
511
512 #ifdef MSDOS
513 if (! discard_output && ! STRINGP (output_file))
514 {
515 char const *tmpdir = egetenv ("TMPDIR");
516 char const *outf = tmpdir ? tmpdir : "";
517 tempfile = alloca (strlen (outf) + 20);
518 strcpy (tempfile, outf);
519 dostounix_filename (tempfile, 0);
520 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
521 strcat (tempfile, "/");
522 strcat (tempfile, "detmp.XXX");
523 mktemp (tempfile);
524 if (!*tempfile)
525 report_file_error ("Opening process output file", Qnil);
526 output_file = build_string (tempfile);
527 synch_process_tempfile = output_file;
528 }
529 #endif
530
531 if (discard_output)
532 {
533 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
534 if (fd_output < 0)
535 report_file_error ("Opening null device", Qnil);
536 }
537 else if (STRINGP (output_file))
538 {
539 fd_output = emacs_open (SSDATA (output_file),
540 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
541 default_output_mode);
542 if (fd_output < 0)
543 {
544 int open_errno = errno;
545 output_file = DECODE_FILE (output_file);
546 report_file_errno ("Opening process output file",
547 output_file, open_errno);
548 }
549 }
550 else
551 {
552 int fd[2];
553 if (emacs_pipe (fd) != 0)
554 report_file_error ("Creating process pipe", Qnil);
555 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
556 fd_output = fd[1];
557 }
558 callproc_fd[CALLPROC_STDOUT] = fd_output;
559
560 fd_error = fd_output;
561
562 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
563 {
564 fd_error = emacs_open ((STRINGP (error_file)
565 ? SSDATA (error_file)
566 : NULL_DEVICE),
567 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
568 default_output_mode);
569 if (fd_error < 0)
570 {
571 int open_errno = errno;
572 report_file_errno ("Cannot redirect stderr",
573 (STRINGP (error_file)
574 ? DECODE_FILE (error_file)
575 : build_string (NULL_DEVICE)),
576 open_errno);
577 }
578 callproc_fd[CALLPROC_STDERR] = fd_error;
579 }
580
581 #ifdef MSDOS /* MW, July 1993 */
582 /* Note that on MSDOS `child_setup' actually returns the child process
583 exit status, not its PID, so assign it to status below. */
584 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
585
586 if (pid < 0)
587 {
588 child_errno = errno;
589 unbind_to (count, Qnil);
590 synchronize_system_messages_locale ();
591 return
592 code_convert_string_norecord (build_string (strerror (child_errno)),
593 Vlocale_coding_system, 0);
594 }
595 status = pid;
596
597 for (i = 0; i < CALLPROC_FDS; i++)
598 if (0 <= callproc_fd[i])
599 {
600 emacs_close (callproc_fd[i]);
601 callproc_fd[i] = -1;
602 }
603 emacs_close (filefd);
604 clear_unwind_protect (count - 1);
605
606 if (tempfile)
607 {
608 /* Since CRLF is converted to LF within `decode_coding', we
609 can always open a file with binary mode. */
610 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
611 O_RDONLY | O_BINARY, 0);
612 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
613 {
614 int open_errno = errno;
615 report_file_errno ("Cannot re-open temporary file",
616 build_string (tempfile), open_errno);
617 }
618 }
619
620 #endif /* MSDOS */
621
622 /* Do the unwind-protect now, even though the pid is not known, so
623 that no storage allocation is done in the critical section.
624 The actual PID will be filled in during the critical section. */
625 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
626
627 #ifndef MSDOS
628
629 block_input ();
630 block_child_signal ();
631
632 #ifdef WINDOWSNT
633 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
634 #else /* not WINDOWSNT */
635
636 /* vfork, and prevent local vars from being clobbered by the vfork. */
637 {
638 Lisp_Object volatile buffer_volatile = buffer;
639 Lisp_Object volatile coding_systems_volatile = coding_systems;
640 Lisp_Object volatile current_dir_volatile = current_dir;
641 bool volatile display_p_volatile = display_p;
642 bool volatile sa_must_free_volatile = sa_must_free;
643 int volatile fd_error_volatile = fd_error;
644 int volatile filefd_volatile = filefd;
645 ptrdiff_t volatile count_volatile = count;
646 ptrdiff_t volatile sa_count_volatile = sa_count;
647 char **volatile new_argv_volatile = new_argv;
648 int volatile callproc_fd_volatile[CALLPROC_FDS];
649 for (i = 0; i < CALLPROC_FDS; i++)
650 callproc_fd_volatile[i] = callproc_fd[i];
651
652 pid = vfork ();
653
654 buffer = buffer_volatile;
655 coding_systems = coding_systems_volatile;
656 current_dir = current_dir_volatile;
657 display_p = display_p_volatile;
658 sa_must_free = sa_must_free_volatile;
659 fd_error = fd_error_volatile;
660 filefd = filefd_volatile;
661 count = count_volatile;
662 sa_count = sa_count_volatile;
663 new_argv = new_argv_volatile;
664
665 for (i = 0; i < CALLPROC_FDS; i++)
666 callproc_fd[i] = callproc_fd_volatile[i];
667 fd_output = callproc_fd[CALLPROC_STDOUT];
668 }
669
670 if (pid == 0)
671 {
672 unblock_child_signal ();
673
674 setsid ();
675
676 /* Emacs ignores SIGPIPE, but the child should not. */
677 signal (SIGPIPE, SIG_DFL);
678
679 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
680 }
681
682 #endif /* not WINDOWSNT */
683
684 child_errno = errno;
685
686 if (pid > 0)
687 {
688 synch_process_pid = pid;
689
690 if (INTEGERP (buffer))
691 {
692 if (tempfile_index < 0)
693 record_deleted_pid (pid, Qnil);
694 else
695 {
696 eassert (1 < nargs);
697 record_deleted_pid (pid, args[1]);
698 clear_unwind_protect (tempfile_index);
699 }
700 synch_process_pid = 0;
701 }
702 }
703
704 unblock_child_signal ();
705 unblock_input ();
706
707 #endif /* not MSDOS */
708
709 if (pid < 0)
710 report_file_errno ("Doing vfork", Qnil, child_errno);
711
712 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
713 since we will use that to read input from. */
714 for (i = 0; i < CALLPROC_FDS; i++)
715 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
716 {
717 emacs_close (callproc_fd[i]);
718 callproc_fd[i] = -1;
719 }
720 emacs_close (filefd);
721 clear_unwind_protect (count - 1);
722
723 if (INTEGERP (buffer))
724 return unbind_to (count, Qnil);
725
726 if (BUFFERP (buffer))
727 Fset_buffer (buffer);
728
729 fd0 = callproc_fd[CALLPROC_PIPEREAD];
730
731 if (0 <= fd0)
732 {
733 Lisp_Object val, *args2;
734
735 val = Qnil;
736 if (!NILP (Vcoding_system_for_read))
737 val = Vcoding_system_for_read;
738 else
739 {
740 if (EQ (coding_systems, Qt))
741 {
742 ptrdiff_t i;
743
744 SAFE_NALLOCA (args2, 1, nargs + 1);
745 args2[0] = Qcall_process;
746 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
747 coding_systems
748 = Ffind_operation_coding_system (nargs + 1, args2);
749 }
750 if (CONSP (coding_systems))
751 val = XCAR (coding_systems);
752 else if (CONSP (Vdefault_process_coding_system))
753 val = XCAR (Vdefault_process_coding_system);
754 else
755 val = Qnil;
756 }
757 Fcheck_coding_system (val);
758 /* In unibyte mode, character code conversion should not take
759 place but EOL conversion should. So, setup raw-text or one
760 of the subsidiary according to the information just setup. */
761 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
762 && !NILP (val))
763 val = raw_text_coding_system (val);
764 setup_coding_system (val, &process_coding);
765 process_coding.dst_multibyte
766 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
767 process_coding.src_multibyte = 0;
768 }
769
770 immediate_quit = 1;
771 QUIT;
772
773 if (0 <= fd0)
774 {
775 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
776 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
777 char buf[CALLPROC_BUFFER_SIZE_MAX];
778 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
779 int nread;
780 bool first = 1;
781 EMACS_INT total_read = 0;
782 int carryover = 0;
783 bool display_on_the_fly = display_p;
784 struct coding_system saved_coding = process_coding;
785
786 while (1)
787 {
788 /* Repeatedly read until we've filled as much as possible
789 of the buffer size we have. But don't read
790 less than 1024--save that for the next bufferful. */
791 nread = carryover;
792 while (nread < bufsize - 1024)
793 {
794 int this_read = emacs_read (fd0, buf + nread,
795 bufsize - nread);
796
797 if (this_read < 0)
798 goto give_up;
799
800 if (this_read == 0)
801 {
802 process_coding.mode |= CODING_MODE_LAST_BLOCK;
803 break;
804 }
805
806 nread += this_read;
807 total_read += this_read;
808
809 if (display_on_the_fly)
810 break;
811 }
812
813 /* Now NREAD is the total amount of data in the buffer. */
814 immediate_quit = 0;
815
816 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
817 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
818 insert_1_both (buf, nread, nread, 0, 1, 0);
819 else
820 { /* We have to decode the input. */
821 Lisp_Object curbuf;
822 ptrdiff_t count1 = SPECPDL_INDEX ();
823
824 XSETBUFFER (curbuf, current_buffer);
825 prepare_to_modify_buffer (PT, PT, NULL);
826 /* We cannot allow after-change-functions be run
827 during decoding, because that might modify the
828 buffer, while we rely on process_coding.produced to
829 faithfully reflect inserted text until we
830 TEMP_SET_PT_BOTH below. */
831 specbind (Qinhibit_modification_hooks, Qt);
832 decode_coding_c_string (&process_coding,
833 (unsigned char *) buf, nread, curbuf);
834 unbind_to (count1, Qnil);
835 if (display_on_the_fly
836 && CODING_REQUIRE_DETECTION (&saved_coding)
837 && ! CODING_REQUIRE_DETECTION (&process_coding))
838 {
839 /* We have detected some coding system, but the
840 detection may have been via insufficient data.
841 So give up displaying on the fly. */
842 if (process_coding.produced > 0)
843 del_range_2 (process_coding.dst_pos,
844 process_coding.dst_pos_byte,
845 (process_coding.dst_pos
846 + process_coding.produced_char),
847 (process_coding.dst_pos_byte
848 + process_coding.produced),
849 0);
850 display_on_the_fly = 0;
851 process_coding = saved_coding;
852 carryover = nread;
853 /* Make the above condition always fail in the future. */
854 saved_coding.common_flags
855 &= ~CODING_REQUIRE_DETECTION_MASK;
856 continue;
857 }
858
859 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
860 PT_BYTE + process_coding.produced);
861 carryover = process_coding.carryover_bytes;
862 if (carryover > 0)
863 memcpy (buf, process_coding.carryover,
864 process_coding.carryover_bytes);
865 }
866
867 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
868 break;
869
870 /* Make the buffer bigger as we continue to read more data,
871 but not past CALLPROC_BUFFER_SIZE_MAX. */
872 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
873 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
874 bufsize = CALLPROC_BUFFER_SIZE_MAX;
875
876 if (display_p)
877 {
878 if (first)
879 prepare_menu_bars ();
880 first = 0;
881 redisplay_preserve_echo_area (1);
882 /* This variable might have been set to 0 for code
883 detection. In that case, set it back to 1 because
884 we should have already detected a coding system. */
885 display_on_the_fly = 1;
886 }
887 immediate_quit = 1;
888 QUIT;
889 }
890 give_up: ;
891
892 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
893 /* If the caller required, let the buffer inherit the
894 coding-system used to decode the process output. */
895 if (inherit_process_coding_system)
896 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
897 make_number (total_read));
898 }
899
900 #ifndef MSDOS
901 /* Wait for it to terminate, unless it already has. */
902 wait_for_termination (pid, &status, fd0 < 0);
903 #endif
904
905 immediate_quit = 0;
906
907 /* Don't kill any children that the subprocess may have left behind
908 when exiting. */
909 synch_process_pid = 0;
910
911 SAFE_FREE ();
912 unbind_to (count, Qnil);
913
914 if (WIFSIGNALED (status))
915 {
916 const char *signame;
917
918 synchronize_system_messages_locale ();
919 signame = strsignal (WTERMSIG (status));
920
921 if (signame == 0)
922 signame = "unknown";
923
924 return code_convert_string_norecord (build_string (signame),
925 Vlocale_coding_system, 0);
926 }
927
928 eassert (WIFEXITED (status));
929 return make_number (WEXITSTATUS (status));
930 }
931 \f
932 /* Create a temporary file suitable for storing the input data of
933 call-process-region. NARGS and ARGS are the same as for
934 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
935 naming the file, and return a file descriptor for reading.
936 Unwind-protect the file, so that the file descriptor will be closed
937 and the file removed when the caller unwinds the specpdl stack. */
938
939 static int
940 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
941 Lisp_Object *filename_string_ptr)
942 {
943 int fd;
944 struct gcpro gcpro1;
945 Lisp_Object filename_string;
946 Lisp_Object val, start, end;
947 Lisp_Object tmpdir;
948
949 if (STRINGP (Vtemporary_file_directory))
950 tmpdir = Vtemporary_file_directory;
951 else
952 {
953 char *outf;
954 #ifndef DOS_NT
955 outf = getenv ("TMPDIR");
956 tmpdir = build_string (outf ? outf : "/tmp/");
957 #else /* DOS_NT */
958 if ((outf = egetenv ("TMPDIR"))
959 || (outf = egetenv ("TMP"))
960 || (outf = egetenv ("TEMP")))
961 tmpdir = build_string (outf);
962 else
963 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
964 #endif
965 }
966
967 {
968 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
969 char *tempfile;
970 ptrdiff_t count;
971
972 #ifdef WINDOWSNT
973 /* Cannot use the result of Fexpand_file_name, because it
974 downcases the XXXXXX part of the pattern, and mktemp then
975 doesn't recognize it. */
976 if (!NILP (Vw32_downcase_file_names))
977 {
978 Lisp_Object dirname = Ffile_name_directory (pattern);
979
980 if (NILP (dirname))
981 pattern = Vtemp_file_name_pattern;
982 else
983 pattern = concat2 (dirname, Vtemp_file_name_pattern);
984 }
985 #endif
986
987 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
988 GCPRO1 (filename_string);
989 tempfile = SSDATA (filename_string);
990
991 count = SPECPDL_INDEX ();
992 record_unwind_protect_nothing ();
993 fd = mkostemp (tempfile, O_CLOEXEC);
994 if (fd < 0)
995 report_file_error ("Failed to open temporary file using pattern",
996 pattern);
997 set_unwind_protect (count, delete_temp_file, filename_string);
998 record_unwind_protect_int (close_file_unwind, fd);
999 }
1000
1001 start = args[0];
1002 end = args[1];
1003 /* Decide coding-system of the contents of the temporary file. */
1004 if (!NILP (Vcoding_system_for_write))
1005 val = Vcoding_system_for_write;
1006 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1007 val = Qraw_text;
1008 else
1009 {
1010 Lisp_Object coding_systems;
1011 Lisp_Object *args2;
1012 USE_SAFE_ALLOCA;
1013 SAFE_NALLOCA (args2, 1, nargs + 1);
1014 args2[0] = Qcall_process_region;
1015 memcpy (args2 + 1, args, nargs * sizeof *args);
1016 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1017 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1018 SAFE_FREE ();
1019 }
1020 val = complement_process_encoding_system (val);
1021
1022 {
1023 ptrdiff_t count1 = SPECPDL_INDEX ();
1024
1025 specbind (intern ("coding-system-for-write"), val);
1026 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1027 happen to get a ".Z" suffix. */
1028 specbind (intern ("file-name-handler-alist"), Qnil);
1029 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
1030
1031 unbind_to (count1, Qnil);
1032 }
1033
1034 if (lseek (fd, 0, SEEK_SET) < 0)
1035 report_file_error ("Setting file position", filename_string);
1036
1037 /* Note that Fcall_process takes care of binding
1038 coding-system-for-read. */
1039
1040 *filename_string_ptr = filename_string;
1041 UNGCPRO;
1042 return fd;
1043 }
1044
1045 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1046 3, MANY, 0,
1047 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1048 The remaining arguments are optional.
1049 Delete the text if fourth arg DELETE is non-nil.
1050
1051 Insert output in BUFFER before point; t means current buffer; nil for
1052 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1053 FILE)', where FILE is a file name string, means that it should be
1054 written to that file (if the file already exists it is overwritten).
1055 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1056 REAL-BUFFER says what to do with standard output, as above,
1057 while STDERR-FILE says what to do with standard error in the child.
1058 STDERR-FILE may be nil (discard standard error output),
1059 t (mix it with ordinary output), or a file name string.
1060
1061 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1062 Remaining args are passed to PROGRAM at startup as command args.
1063
1064 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1065 Otherwise it waits for PROGRAM to terminate
1066 and returns a numeric exit status or a signal description string.
1067 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1068
1069 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1070 (ptrdiff_t nargs, Lisp_Object *args)
1071 {
1072 struct gcpro gcpro1;
1073 Lisp_Object infile, val;
1074 ptrdiff_t count = SPECPDL_INDEX ();
1075 Lisp_Object start = args[0];
1076 Lisp_Object end = args[1];
1077 bool empty_input;
1078 int fd;
1079
1080 if (STRINGP (start))
1081 empty_input = SCHARS (start) == 0;
1082 else if (NILP (start))
1083 empty_input = BEG == Z;
1084 else
1085 {
1086 validate_region (&args[0], &args[1]);
1087 start = args[0];
1088 end = args[1];
1089 empty_input = XINT (start) == XINT (end);
1090 }
1091
1092 if (!empty_input)
1093 fd = create_temp_file (nargs, args, &infile);
1094 else
1095 {
1096 infile = Qnil;
1097 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1098 if (fd < 0)
1099 report_file_error ("Opening null device", Qnil);
1100 record_unwind_protect_int (close_file_unwind, fd);
1101 }
1102
1103 GCPRO1 (infile);
1104
1105 if (nargs > 3 && !NILP (args[3]))
1106 Fdelete_region (start, end);
1107
1108 if (nargs > 3)
1109 {
1110 args += 2;
1111 nargs -= 2;
1112 }
1113 else
1114 {
1115 args[0] = args[2];
1116 nargs = 2;
1117 }
1118 args[1] = infile;
1119
1120 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1121 RETURN_UNGCPRO (unbind_to (count, val));
1122 }
1123 \f
1124 #ifndef WINDOWSNT
1125 static int relocate_fd (int fd, int minfd);
1126 #endif
1127
1128 static char **
1129 add_env (char **env, char **new_env, char *string)
1130 {
1131 char **ep;
1132 bool ok = 1;
1133 if (string == NULL)
1134 return new_env;
1135
1136 /* See if this string duplicates any string already in the env.
1137 If so, don't put it in.
1138 When an env var has multiple definitions,
1139 we keep the definition that comes first in process-environment. */
1140 for (ep = env; ok && ep != new_env; ep++)
1141 {
1142 char *p = *ep, *q = string;
1143 while (ok)
1144 {
1145 if (*q != *p)
1146 break;
1147 if (*q == 0)
1148 /* The string is a lone variable name; keep it for now, we
1149 will remove it later. It is a placeholder for a
1150 variable that is not to be included in the environment. */
1151 break;
1152 if (*q == '=')
1153 ok = 0;
1154 p++, q++;
1155 }
1156 }
1157 if (ok)
1158 *new_env++ = string;
1159 return new_env;
1160 }
1161
1162 /* This is the last thing run in a newly forked inferior
1163 either synchronous or asynchronous.
1164 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1165 Initialize inferior's priority, pgrp, connected dir and environment.
1166 then exec another program based on new_argv.
1167
1168 If SET_PGRP, put the subprocess into a separate process group.
1169
1170 CURRENT_DIR is an elisp string giving the path of the current
1171 directory the subprocess should have. Since we can't really signal
1172 a decent error from within the child, this should be verified as an
1173 executable directory by the parent. */
1174
1175 int
1176 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1177 Lisp_Object current_dir)
1178 {
1179 char **env;
1180 char *pwd_var;
1181 #ifdef WINDOWSNT
1182 int cpid;
1183 HANDLE handles[3];
1184 #else
1185 int exec_errno;
1186
1187 pid_t pid = getpid ();
1188 #endif /* WINDOWSNT */
1189
1190 /* Note that use of alloca is always safe here. It's obvious for systems
1191 that do not have true vfork or that have true (stack) alloca.
1192 If using vfork and C_ALLOCA (when Emacs used to include
1193 src/alloca.c) it is safe because that changes the superior's
1194 static variables as if the superior had done alloca and will be
1195 cleaned up in the usual way. */
1196 {
1197 char *temp;
1198 ptrdiff_t i;
1199
1200 i = SBYTES (current_dir);
1201 #ifdef MSDOS
1202 /* MSDOS must have all environment variables malloc'ed, because
1203 low-level libc functions that launch subsidiary processes rely
1204 on that. */
1205 pwd_var = xmalloc (i + 5);
1206 #else
1207 pwd_var = alloca (i + 5);
1208 #endif
1209 temp = pwd_var + 4;
1210 memcpy (pwd_var, "PWD=", 4);
1211 strcpy (temp, SSDATA (current_dir));
1212
1213 #ifndef DOS_NT
1214 /* We can't signal an Elisp error here; we're in a vfork. Since
1215 the callers check the current directory before forking, this
1216 should only return an error if the directory's permissions
1217 are changed between the check and this chdir, but we should
1218 at least check. */
1219 if (chdir (temp) < 0)
1220 _exit (EXIT_CANCELED);
1221 #else /* DOS_NT */
1222 /* Get past the drive letter, so that d:/ is left alone. */
1223 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1224 {
1225 temp += 2;
1226 i -= 2;
1227 }
1228 #endif /* DOS_NT */
1229
1230 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1231 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1232 temp[--i] = 0;
1233 }
1234
1235 /* Set `env' to a vector of the strings in the environment. */
1236 {
1237 register Lisp_Object tem;
1238 register char **new_env;
1239 char **p, **q;
1240 register int new_length;
1241 Lisp_Object display = Qnil;
1242
1243 new_length = 0;
1244
1245 for (tem = Vprocess_environment;
1246 CONSP (tem) && STRINGP (XCAR (tem));
1247 tem = XCDR (tem))
1248 {
1249 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1250 && (SDATA (XCAR (tem)) [7] == '\0'
1251 || SDATA (XCAR (tem)) [7] == '='))
1252 /* DISPLAY is specified in process-environment. */
1253 display = Qt;
1254 new_length++;
1255 }
1256
1257 /* If not provided yet, use the frame's DISPLAY. */
1258 if (NILP (display))
1259 {
1260 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1261 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1262 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1263 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1264 Vinitial_environment);
1265 if (STRINGP (tmp))
1266 {
1267 display = tmp;
1268 new_length++;
1269 }
1270 }
1271
1272 /* new_length + 2 to include PWD and terminating 0. */
1273 env = new_env = alloca ((new_length + 2) * sizeof *env);
1274 /* If we have a PWD envvar, pass one down,
1275 but with corrected value. */
1276 if (egetenv ("PWD"))
1277 *new_env++ = pwd_var;
1278
1279 if (STRINGP (display))
1280 {
1281 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1282 strcpy (vdata, "DISPLAY=");
1283 strcat (vdata, SSDATA (display));
1284 new_env = add_env (env, new_env, vdata);
1285 }
1286
1287 /* Overrides. */
1288 for (tem = Vprocess_environment;
1289 CONSP (tem) && STRINGP (XCAR (tem));
1290 tem = XCDR (tem))
1291 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1292
1293 *new_env = 0;
1294
1295 /* Remove variable names without values. */
1296 p = q = env;
1297 while (*p != 0)
1298 {
1299 while (*q != 0 && strchr (*q, '=') == NULL)
1300 q++;
1301 *p = *q++;
1302 if (*p != 0)
1303 p++;
1304 }
1305 }
1306
1307
1308 #ifdef WINDOWSNT
1309 prepare_standard_handles (in, out, err, handles);
1310 set_process_dir (SDATA (current_dir));
1311 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1312 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1313 reset_standard_handles (in, out, err, handles);
1314 if (cpid == -1)
1315 /* An error occurred while trying to spawn the process. */
1316 report_file_error ("Spawning child process", Qnil);
1317 return cpid;
1318
1319 #else /* not WINDOWSNT */
1320 /* Make sure that in, out, and err are not actually already in
1321 descriptors zero, one, or two; this could happen if Emacs is
1322 started with its standard in, out, or error closed, as might
1323 happen under X. */
1324 {
1325 int oin = in, oout = out;
1326
1327 /* We have to avoid relocating the same descriptor twice! */
1328
1329 in = relocate_fd (in, 3);
1330
1331 if (out == oin)
1332 out = in;
1333 else
1334 out = relocate_fd (out, 3);
1335
1336 if (err == oin)
1337 err = in;
1338 else if (err == oout)
1339 err = out;
1340 else
1341 err = relocate_fd (err, 3);
1342 }
1343
1344 #ifndef MSDOS
1345 /* Redirect file descriptors and clear the close-on-exec flag on the
1346 redirected ones. IN, OUT, and ERR are close-on-exec so they
1347 need not be closed explicitly. */
1348 dup2 (in, 0);
1349 dup2 (out, 1);
1350 dup2 (err, 2);
1351
1352 setpgid (0, 0);
1353 tcsetpgrp (0, pid);
1354
1355 execve (new_argv[0], new_argv, env);
1356 exec_errno = errno;
1357
1358 /* Avoid deadlock if the child's perror writes to a full pipe; the
1359 pipe's reader is the parent, but with vfork the parent can't
1360 run until the child exits. Truncate the diagnostic instead. */
1361 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1362
1363 errno = exec_errno;
1364 emacs_perror (new_argv[0]);
1365 _exit (exec_errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1366
1367 #else /* MSDOS */
1368 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1369 xfree (pwd_var);
1370 if (pid == -1)
1371 /* An error occurred while trying to run the subprocess. */
1372 report_file_error ("Spawning child process", Qnil);
1373 return pid;
1374 #endif /* MSDOS */
1375 #endif /* not WINDOWSNT */
1376 }
1377
1378 #ifndef WINDOWSNT
1379 /* Move the file descriptor FD so that its number is not less than MINFD.
1380 If the file descriptor is moved at all, the original is closed on MSDOS,
1381 but not elsewhere as the caller will close it anyway. */
1382 static int
1383 relocate_fd (int fd, int minfd)
1384 {
1385 if (fd >= minfd)
1386 return fd;
1387 else
1388 {
1389 int new = fcntl (fd, F_DUPFD_CLOEXEC, minfd);
1390 if (new == -1)
1391 {
1392 emacs_perror ("while setting up child");
1393 _exit (EXIT_CANCELED);
1394 }
1395 #ifdef MSDOS
1396 emacs_close (fd);
1397 #endif
1398 return new;
1399 }
1400 }
1401 #endif /* not WINDOWSNT */
1402
1403 static bool
1404 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1405 ptrdiff_t *valuelen, Lisp_Object env)
1406 {
1407 for (; CONSP (env); env = XCDR (env))
1408 {
1409 Lisp_Object entry = XCAR (env);
1410 if (STRINGP (entry)
1411 && SBYTES (entry) >= varlen
1412 #ifdef WINDOWSNT
1413 /* NT environment variables are case insensitive. */
1414 && ! strnicmp (SDATA (entry), var, varlen)
1415 #else /* not WINDOWSNT */
1416 && ! memcmp (SDATA (entry), var, varlen)
1417 #endif /* not WINDOWSNT */
1418 )
1419 {
1420 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1421 {
1422 *value = SSDATA (entry) + (varlen + 1);
1423 *valuelen = SBYTES (entry) - (varlen + 1);
1424 return 1;
1425 }
1426 else if (SBYTES (entry) == varlen)
1427 {
1428 /* Lone variable names in Vprocess_environment mean that
1429 variable should be removed from the environment. */
1430 *value = NULL;
1431 return 1;
1432 }
1433 }
1434 }
1435 return 0;
1436 }
1437
1438 static bool
1439 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1440 ptrdiff_t *valuelen, Lisp_Object frame)
1441 {
1442 /* Try to find VAR in Vprocess_environment first. */
1443 if (getenv_internal_1 (var, varlen, value, valuelen,
1444 Vprocess_environment))
1445 return *value ? 1 : 0;
1446
1447 /* For DISPLAY try to get the values from the frame or the initial env. */
1448 if (strcmp (var, "DISPLAY") == 0)
1449 {
1450 Lisp_Object display
1451 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1452 if (STRINGP (display))
1453 {
1454 *value = SSDATA (display);
1455 *valuelen = SBYTES (display);
1456 return 1;
1457 }
1458 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1459 if (getenv_internal_1 (var, varlen, value, valuelen,
1460 Vinitial_environment))
1461 return *value ? 1 : 0;
1462 }
1463
1464 return 0;
1465 }
1466
1467 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1468 doc: /* Get the value of environment variable VARIABLE.
1469 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1470 the environment. Otherwise, value is a string.
1471
1472 This function searches `process-environment' for VARIABLE.
1473
1474 If optional parameter ENV is a list, then search this list instead of
1475 `process-environment', and return t when encountering a negative entry
1476 \(an entry for a variable with no value). */)
1477 (Lisp_Object variable, Lisp_Object env)
1478 {
1479 char *value;
1480 ptrdiff_t valuelen;
1481
1482 CHECK_STRING (variable);
1483 if (CONSP (env))
1484 {
1485 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1486 &value, &valuelen, env))
1487 return value ? make_string (value, valuelen) : Qt;
1488 else
1489 return Qnil;
1490 }
1491 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1492 &value, &valuelen, env))
1493 return make_string (value, valuelen);
1494 else
1495 return Qnil;
1496 }
1497
1498 /* A version of getenv that consults the Lisp environment lists,
1499 easily callable from C. */
1500 char *
1501 egetenv (const char *var)
1502 {
1503 char *value;
1504 ptrdiff_t valuelen;
1505
1506 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1507 return value;
1508 else
1509 return 0;
1510 }
1511
1512 \f
1513 /* This is run before init_cmdargs. */
1514
1515 void
1516 init_callproc_1 (void)
1517 {
1518 #ifdef HAVE_NS
1519 const char *etc_dir = ns_etc_directory ();
1520 const char *path_exec = ns_exec_path ();
1521 #endif
1522
1523 Vdata_directory = decode_env_path ("EMACSDATA",
1524 #ifdef HAVE_NS
1525 etc_dir ? etc_dir :
1526 #endif
1527 PATH_DATA);
1528 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1529
1530 Vdoc_directory = decode_env_path ("EMACSDOC",
1531 #ifdef HAVE_NS
1532 etc_dir ? etc_dir :
1533 #endif
1534 PATH_DOC);
1535 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1536
1537 /* Check the EMACSPATH environment variable, defaulting to the
1538 PATH_EXEC path from epaths.h. */
1539 Vexec_path = decode_env_path ("EMACSPATH",
1540 #ifdef HAVE_NS
1541 path_exec ? path_exec :
1542 #endif
1543 PATH_EXEC);
1544 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1545 /* FIXME? For ns, path_exec should go at the front? */
1546 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1547 }
1548
1549 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1550
1551 void
1552 init_callproc (void)
1553 {
1554 char *data_dir = egetenv ("EMACSDATA");
1555
1556 register char * sh;
1557 Lisp_Object tempdir;
1558 #ifdef HAVE_NS
1559 if (data_dir == 0)
1560 {
1561 const char *etc_dir = ns_etc_directory ();
1562 if (etc_dir)
1563 {
1564 data_dir = alloca (strlen (etc_dir) + 1);
1565 strcpy (data_dir, etc_dir);
1566 }
1567 }
1568 #endif
1569
1570 if (!NILP (Vinstallation_directory))
1571 {
1572 /* Add to the path the lib-src subdir of the installation dir. */
1573 Lisp_Object tem;
1574 tem = Fexpand_file_name (build_string ("lib-src"),
1575 Vinstallation_directory);
1576 #ifndef MSDOS
1577 /* MSDOS uses wrapped binaries, so don't do this. */
1578 if (NILP (Fmember (tem, Vexec_path)))
1579 {
1580 #ifdef HAVE_NS
1581 const char *path_exec = ns_exec_path ();
1582 #endif
1583 Vexec_path = decode_env_path ("EMACSPATH",
1584 #ifdef HAVE_NS
1585 path_exec ? path_exec :
1586 #endif
1587 PATH_EXEC);
1588 Vexec_path = Fcons (tem, Vexec_path);
1589 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1590 }
1591
1592 Vexec_directory = Ffile_name_as_directory (tem);
1593 #endif /* not MSDOS */
1594
1595 /* Maybe use ../etc as well as ../lib-src. */
1596 if (data_dir == 0)
1597 {
1598 tem = Fexpand_file_name (build_string ("etc"),
1599 Vinstallation_directory);
1600 Vdoc_directory = Ffile_name_as_directory (tem);
1601 }
1602 }
1603
1604 /* Look for the files that should be in etc. We don't use
1605 Vinstallation_directory, because these files are never installed
1606 near the executable, and they are never in the build
1607 directory when that's different from the source directory.
1608
1609 Instead, if these files are not in the nominal place, we try the
1610 source directory. */
1611 if (data_dir == 0)
1612 {
1613 Lisp_Object tem, tem1, srcdir;
1614
1615 srcdir = Fexpand_file_name (build_string ("../src/"),
1616 build_unibyte_string (PATH_DUMPLOADSEARCH));
1617 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1618 tem1 = Ffile_exists_p (tem);
1619 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1620 {
1621 Lisp_Object newdir;
1622 newdir = Fexpand_file_name (build_string ("../etc/"),
1623 build_unibyte_string (PATH_DUMPLOADSEARCH));
1624 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1625 tem1 = Ffile_exists_p (tem);
1626 if (!NILP (tem1))
1627 Vdata_directory = newdir;
1628 }
1629 }
1630
1631 #ifndef CANNOT_DUMP
1632 if (initialized)
1633 #endif
1634 {
1635 tempdir = Fdirectory_file_name (Vexec_directory);
1636 if (! file_accessible_directory_p (SSDATA (tempdir)))
1637 dir_warning ("arch-dependent data dir", Vexec_directory);
1638 }
1639
1640 tempdir = Fdirectory_file_name (Vdata_directory);
1641 if (! file_accessible_directory_p (SSDATA (tempdir)))
1642 dir_warning ("arch-independent data dir", Vdata_directory);
1643
1644 sh = getenv ("SHELL");
1645 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1646
1647 #ifdef DOS_NT
1648 Vshared_game_score_directory = Qnil;
1649 #else
1650 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1651 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1652 Vshared_game_score_directory = Qnil;
1653 #endif
1654 }
1655
1656 void
1657 set_initial_environment (void)
1658 {
1659 char **envp;
1660 for (envp = environ; *envp; envp++)
1661 Vprocess_environment = Fcons (build_string (*envp),
1662 Vprocess_environment);
1663 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1664 to use `delete' and friends on process-environment. */
1665 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1666 }
1667
1668 void
1669 syms_of_callproc (void)
1670 {
1671 #ifndef DOS_NT
1672 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1673 #elif defined (WINDOWSNT)
1674 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1675 #else
1676 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1677 #endif
1678 staticpro (&Vtemp_file_name_pattern);
1679
1680 #ifdef MSDOS
1681 synch_process_tempfile = make_number (0);
1682 staticpro (&synch_process_tempfile);
1683 #endif
1684
1685 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1686 doc: /* File name to load inferior shells from.
1687 Initialized from the SHELL environment variable, or to a system-dependent
1688 default if SHELL is not set. */);
1689
1690 DEFVAR_LISP ("exec-path", Vexec_path,
1691 doc: /* List of directories to search programs to run in subprocesses.
1692 Each element is a string (directory name) or nil (try default directory). */);
1693
1694 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1695 doc: /* List of suffixes to try to find executable file names.
1696 Each element is a string. */);
1697 Vexec_suffixes = Qnil;
1698
1699 DEFVAR_LISP ("exec-directory", Vexec_directory,
1700 doc: /* Directory for executables for Emacs to invoke.
1701 More generally, this includes any architecture-dependent files
1702 that are built and installed from the Emacs distribution. */);
1703
1704 DEFVAR_LISP ("data-directory", Vdata_directory,
1705 doc: /* Directory of machine-independent files that come with GNU Emacs.
1706 These are files intended for Emacs to use while it runs. */);
1707
1708 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1709 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1710 This is usually the same as `data-directory'. */);
1711
1712 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1713 doc: /* For internal use by the build procedure only.
1714 This is the name of the directory in which the build procedure installed
1715 Emacs's info files; the default value for `Info-default-directory-list'
1716 includes this. */);
1717 Vconfigure_info_directory = build_string (PATH_INFO);
1718
1719 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1720 doc: /* Directory of score files for games which come with GNU Emacs.
1721 If this variable is nil, then Emacs is unable to use a shared directory. */);
1722 #ifdef DOS_NT
1723 Vshared_game_score_directory = Qnil;
1724 #else
1725 Vshared_game_score_directory = build_string (PATH_GAME);
1726 #endif
1727
1728 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1729 doc: /* List of environment variables inherited from the parent process.
1730 Each element should be a string of the form ENVVARNAME=VALUE.
1731 The elements must normally be decoded (using `locale-coding-system') for use. */);
1732 Vinitial_environment = Qnil;
1733
1734 DEFVAR_LISP ("process-environment", Vprocess_environment,
1735 doc: /* List of overridden environment variables for subprocesses to inherit.
1736 Each element should be a string of the form ENVVARNAME=VALUE.
1737
1738 Entries in this list take precedence to those in the frame-local
1739 environments. Therefore, let-binding `process-environment' is an easy
1740 way to temporarily change the value of an environment variable,
1741 irrespective of where it comes from. To use `process-environment' to
1742 remove an environment variable, include only its name in the list,
1743 without "=VALUE".
1744
1745 This variable is set to nil when Emacs starts.
1746
1747 If multiple entries define the same variable, the first one always
1748 takes precedence.
1749
1750 Non-ASCII characters are encoded according to the initial value of
1751 `locale-coding-system', i.e. the elements must normally be decoded for
1752 use.
1753
1754 See `setenv' and `getenv'. */);
1755 Vprocess_environment = Qnil;
1756
1757 defsubr (&Scall_process);
1758 defsubr (&Sgetenv_internal);
1759 defsubr (&Scall_process_region);
1760 }