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