Merge from emacs-24; up to 2012-12-26T22:30:58Z!yamaoka@jpl.org
[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
34#include <windows.h>
489f9371 35#include "w32.h"
bad95d8f
RS
36#define _P_NOWAIT 1 /* from process.h */
37#endif
38
7e6c2178 39#ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
7e6c2178
RS
40#include <sys/stat.h>
41#include <sys/param.h>
7e6c2178
RS
42#endif /* MSDOS */
43
80856e74 44#include "commands.h"
91183bfd 45#include "character.h"
e5560ff7 46#include "buffer.h"
edf496dd 47#include "ccl.h"
32d08644 48#include "coding.h"
f0b950cf 49#include "composite.h"
57bda87a 50#include <epaths.h>
80856e74 51#include "process.h"
d177f194 52#include "syssignal.h"
a129418f 53#include "systty.h"
afea8a8a 54#include "syswait.h"
aba637ec 55#include "blockinput.h"
f105f403
KL
56#include "frame.h"
57#include "termhooks.h"
80856e74 58
5f027cea
EZ
59#ifdef MSDOS
60#include "msdos.h"
61#endif
62
d01ba2f1
GM
63#ifdef HAVE_NS
64#include "nsterm.h"
65#endif
66
f92d51d8
CY
67/* Pattern used by call-process-region to make temp files. */
68static Lisp_Object Vtemp_file_name_pattern;
69
bb5f74ee
PE
70/* The next two variables are valid only while record-unwind-protect
71 is in place during call-process for a synchronous subprocess. At
72 other times, their contents are irrelevant. Doing this via static
73 C variables is more convenient than putting them into the arguments
74 of record-unwind-protect, as they need to be updated at randomish
75 times in the code, and Lisp cannot always store these values as
76 Emacs integers. It's safe to use static variables here, as the
77 code is never invoked reentrantly. */
78
79/* If nonzero, a process-ID that has not been reaped. */
80static pid_t synch_process_pid;
81
82/* If nonnegative, a file descriptor that has not been closed. */
83static int synch_process_fd;
84\f
85/* Block SIGCHLD. */
80856e74 86
bb5f74ee
PE
87static void
88block_child_signal (void)
89{
bb5f74ee
PE
90 sigset_t blocked;
91 sigemptyset (&blocked);
92 sigaddset (&blocked, SIGCHLD);
93 pthread_sigmask (SIG_BLOCK, &blocked, 0);
bb5f74ee 94}
6b61353c 95
bb5f74ee 96/* Unblock SIGCHLD. */
f105f403 97
bb5f74ee
PE
98static void
99unblock_child_signal (void)
100{
bb5f74ee 101 pthread_sigmask (SIG_SETMASK, &empty_mask, 0);
bb5f74ee 102}
37d54121 103
35fb8050
PE
104/* If P is reapable, record it as a deleted process and kill it.
105 Do this in a critical section. Unless PID is wedged it will be
106 reaped on receipt of the first SIGCHLD after the critical section. */
107
108void
109record_kill_process (struct Lisp_Process *p)
110{
111 block_child_signal ();
112
113 if (p->alive)
114 {
115 p->alive = 0;
116 record_deleted_pid (p->pid);
d983a10b 117 kill (- p->pid, SIGKILL);
35fb8050
PE
118 }
119
120 unblock_child_signal ();
121}
122
bb5f74ee 123/* Clean up when exiting call_process_cleanup. */
37d54121 124
d177f194 125static Lisp_Object
bb5f74ee 126call_process_kill (Lisp_Object ignored)
d177f194 127{
908589fd 128 if (synch_process_fd >= 0)
bb5f74ee
PE
129 emacs_close (synch_process_fd);
130
bb5f74ee
PE
131 if (synch_process_pid)
132 {
35fb8050
PE
133 struct Lisp_Process proc;
134 proc.alive = 1;
135 proc.pid = synch_process_pid;
136 record_kill_process (&proc);
bb5f74ee
PE
137 }
138
d177f194
JB
139 return Qnil;
140}
141
bb5f74ee
PE
142/* Clean up when exiting Fcall_process.
143 On MSDOS, delete the temporary file on any kind of termination.
144 On Unix, kill the process and any children on termination by signal. */
145
7710357c 146static Lisp_Object
971de7fb 147call_process_cleanup (Lisp_Object arg)
80856e74 148{
bb5f74ee
PE
149#ifdef MSDOS
150 Lisp_Object buffer = Fcar (arg);
151 Lisp_Object file = Fcdr (arg);
ad3aaf33 152#else
bb5f74ee 153 Lisp_Object buffer = arg;
ad3aaf33
AS
154#endif
155
bb5f74ee 156 Fset_buffer (buffer);
d177f194 157
bb5f74ee
PE
158#ifndef MSDOS
159 /* If the process still exists, kill its process group. */
160 if (synch_process_pid)
d177f194 161 {
d311d28c 162 ptrdiff_t count = SPECPDL_INDEX ();
d983a10b 163 kill (-synch_process_pid, SIGINT);
bb5f74ee 164 record_unwind_protect (call_process_kill, make_number (0));
d177f194
JB
165 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
166 immediate_quit = 1;
167 QUIT;
bb5f74ee
PE
168 wait_for_termination (synch_process_pid, 0, 1);
169 synch_process_pid = 0;
d177f194
JB
170 immediate_quit = 0;
171 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
172 message1 ("Waiting for process to die...done");
173 }
bb5f74ee
PE
174#endif
175
908589fd 176 if (synch_process_fd >= 0)
bb5f74ee
PE
177 emacs_close (synch_process_fd);
178
179#ifdef MSDOS
180 /* FILE is "" when we didn't actually create a temporary file in
181 call-process. */
182 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
183 unlink (SDATA (file));
184#endif
185
80856e74
JB
186 return Qnil;
187}
188
a7ca3326 189DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
fdb82f93
PJ
190 doc: /* Call PROGRAM synchronously in separate process.
191The remaining arguments are optional.
192The program's input comes from file INFILE (nil means `/dev/null').
1ef14cb4
LMI
193Insert output in BUFFER before point; t means current buffer; nil for BUFFER
194 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
1b9f60cc
GM
195 FILE is a file name string, means that it should be written to that file
196 \(if the file already exists it is overwritten).
fdb82f93
PJ
197BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
198REAL-BUFFER says what to do with standard output, as above,
199while STDERR-FILE says what to do with standard error in the child.
200STDERR-FILE may be nil (discard standard error output),
201t (mix it with ordinary output), or a file name string.
202
203Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
204Remaining arguments are strings passed as command arguments to PROGRAM.
205
a4feb144
RS
206If executable PROGRAM can't be found as an executable, `call-process'
207signals a Lisp error. `call-process' reports errors in execution of
208the program only through its return and output.
209
fdb82f93
PJ
210If BUFFER is 0, `call-process' returns immediately with value nil.
211Otherwise it waits for PROGRAM to terminate
212and returns a numeric exit status or a signal description string.
d98b59b5
MB
213If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
214
215usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
f66c7cf8 216 (ptrdiff_t nargs, Lisp_Object *args)
80856e74 217{
bb5f74ee 218 Lisp_Object infile, buffer, current_dir, path;
2f221583 219 bool display_p;
60aeceb8 220 int fd0, fd1, filefd;
bb5f74ee 221 int status;
d311d28c
PE
222 ptrdiff_t count = SPECPDL_INDEX ();
223 USE_SAFE_ALLOCA;
2d607244 224
60aeceb8 225 char **new_argv;
39eaa782
RS
226 /* File to use for stderr in the child.
227 t means use same as standard output. */
228 Lisp_Object error_file;
1ef14cb4 229 Lisp_Object output_file = Qnil;
7e6c2178 230#ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
888c9e86 231 char *outf, *tempfile = NULL;
7e6c2178 232 int outfilefd;
d311d28c
PE
233 int pid;
234#else
235 pid_t pid;
80856e74 236#endif
bb5f74ee 237 int child_errno;
1ef14cb4 238 int fd_output = -1;
32d08644
KH
239 struct coding_system process_coding; /* coding-system of process output */
240 struct coding_system argument_coding; /* coding-system of arguments */
09494912
RS
241 /* Set to the return value of Ffind_operation_coding_system. */
242 Lisp_Object coding_systems;
2f221583 243 bool output_to_buffer = 1;
09494912
RS
244
245 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
246 coding_systems = Qt;
32d08644 247
b7826503 248 CHECK_STRING (args[0]);
80856e74 249
39eaa782
RS
250 error_file = Qt;
251
7e6c2178
RS
252#ifndef subprocesses
253 /* Without asynchronous processes we cannot have BUFFER == 0. */
177c0ea7 254 if (nargs >= 3
09ffb8b5 255 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
7e6c2178
RS
256 error ("Operating system cannot handle asynchronous subprocesses");
257#endif /* subprocesses */
258
09494912 259 /* Decide the coding-system for giving arguments. */
32d08644
KH
260 {
261 Lisp_Object val, *args2;
f66c7cf8 262 ptrdiff_t i;
32d08644
KH
263
264 /* If arguments are supplied, we may have to encode them. */
265 if (nargs >= 5)
266 {
2f221583 267 bool must_encode = 0;
6e50da0a 268 Lisp_Object coding_attrs;
30d57b8e 269
e7c1c20e 270 for (i = 4; i < nargs; i++)
b7826503 271 CHECK_STRING (args[i]);
e7c1c20e 272
a2286b5c 273 for (i = 4; i < nargs; i++)
30d57b8e
RS
274 if (STRING_MULTIBYTE (args[i]))
275 must_encode = 1;
276
beacaab3
KH
277 if (!NILP (Vcoding_system_for_write))
278 val = Vcoding_system_for_write;
30d57b8e 279 else if (! must_encode)
fcaf8878 280 val = Qraw_text;
beacaab3 281 else
32d08644 282 {
0065d054 283 SAFE_NALLOCA (args2, 1, nargs + 1);
32d08644
KH
284 args2[0] = Qcall_process;
285 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
08ee4e87 286 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
fcaf8878 287 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
32d08644 288 }
fcaf8878 289 val = complement_process_encoding_system (val);
32d08644 290 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
6e50da0a
KH
291 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
292 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
293 {
294 /* We should not use an ASCII incompatible coding system. */
295 val = raw_text_coding_system (val);
296 setup_coding_system (val, &argument_coding);
297 }
32d08644 298 }
32d08644
KH
299 }
300
e576cab4
JB
301 if (nargs >= 2 && ! NILP (args[1]))
302 {
4b4deea2 303 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
b7826503 304 CHECK_STRING (infile);
e576cab4 305 }
80856e74 306 else
5437e9f9 307 infile = build_string (NULL_DEVICE);
80856e74 308
e576cab4
JB
309 if (nargs >= 3)
310 {
39eaa782
RS
311 buffer = args[2];
312
1ef14cb4
LMI
313 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
314 FILE-FOR-STDERR), unless the first element is :file, in which case see
315 the next paragraph. */
19ed11ba
AS
316 if (CONSP (buffer)
317 && (! SYMBOLP (XCAR (buffer))
318 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
39eaa782 319 {
70949dac 320 if (CONSP (XCDR (buffer)))
45be8a1e 321 {
a9d4f28a 322 Lisp_Object stderr_file;
70949dac 323 stderr_file = XCAR (XCDR (buffer));
45be8a1e
RS
324
325 if (NILP (stderr_file) || EQ (Qt, stderr_file))
326 error_file = stderr_file;
327 else
328 error_file = Fexpand_file_name (stderr_file, Qnil);
329 }
330
70949dac 331 buffer = XCAR (buffer);
39eaa782 332 }
044512ed 333
1ef14cb4 334 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
19ed11ba
AS
335 if (CONSP (buffer)
336 && SYMBOLP (XCAR (buffer))
337 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
1ef14cb4
LMI
338 {
339 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
340 BVAR (current_buffer, directory));
341 CHECK_STRING (output_file);
342 buffer = Qnil;
343 }
344
39eaa782
RS
345 if (!(EQ (buffer, Qnil)
346 || EQ (buffer, Qt)
3ffde7d6 347 || INTEGERP (buffer)))
e576cab4 348 {
39eaa782
RS
349 Lisp_Object spec_buffer;
350 spec_buffer = buffer;
50fe359b 351 buffer = Fget_buffer_create (buffer);
39eaa782
RS
352 /* Mention the buffer name for a better error message. */
353 if (NILP (buffer))
b7826503
PJ
354 CHECK_BUFFER (spec_buffer);
355 CHECK_BUFFER (buffer);
e576cab4
JB
356 }
357 }
177c0ea7 358 else
e576cab4 359 buffer = Qnil;
80856e74 360
58616e67
JB
361 /* Make sure that the child will be able to chdir to the current
362 buffer's current directory, or its unhandled equivalent. We
363 can't just have the child check for an error when it does the
364 chdir, since it's in a vfork.
365
366 We have to GCPRO around this because Fexpand_file_name,
367 Funhandled_file_name_directory, and Ffile_accessible_directory_p
368 might call a file name handling function. The argument list is
369 protected by the caller, so all we really have to worry about is
370 buffer. */
371 {
1ef14cb4 372 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
58616e67 373
4b4deea2 374 current_dir = BVAR (current_buffer, directory);
58616e67 375
1ef14cb4 376 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
58616e67 377
ca319910
SM
378 current_dir = Funhandled_file_name_directory (current_dir);
379 if (NILP (current_dir))
380 /* If the file name handler says that current_dir is unreachable, use
381 a sensible default. */
382 current_dir = build_string ("~/");
383 current_dir = expand_and_dir_to_file (current_dir, Qnil);
db8454b0
CY
384 current_dir = Ffile_name_as_directory (current_dir);
385
58616e67
JB
386 if (NILP (Ffile_accessible_directory_p (current_dir)))
387 report_file_error ("Setting current directory",
4b4deea2 388 Fcons (BVAR (current_buffer, directory), Qnil));
58616e67 389
34b87689
KH
390 if (STRING_MULTIBYTE (infile))
391 infile = ENCODE_FILE (infile);
392 if (STRING_MULTIBYTE (current_dir))
393 current_dir = ENCODE_FILE (current_dir);
394 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
395 error_file = ENCODE_FILE (error_file);
1ef14cb4
LMI
396 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
397 output_file = ENCODE_FILE (output_file);
58616e67
JB
398 UNGCPRO;
399 }
400
d311d28c 401 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
80856e74 402
42a5b22f 403 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
80856e74 404 if (filefd < 0)
b0728617
EZ
405 report_file_error ("Opening process input file",
406 Fcons (DECODE_FILE (infile), Qnil));
1ef14cb4
LMI
407
408 if (STRINGP (output_file))
409 {
410#ifdef DOS_NT
411 fd_output = emacs_open (SSDATA (output_file),
412 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
413 S_IREAD | S_IWRITE);
414#else /* not DOS_NT */
415 fd_output = creat (SSDATA (output_file), 0666);
416#endif /* not DOS_NT */
417 if (fd_output < 0)
418 {
419 output_file = DECODE_FILE (output_file);
420 report_file_error ("Opening process output file",
421 Fcons (output_file, Qnil));
19ed11ba 422 }
1ef14cb4 423 if (STRINGP (error_file) || NILP (error_file))
19ed11ba 424 output_to_buffer = 0;
1ef14cb4
LMI
425 }
426
80856e74 427 /* Search for program; barf if not found. */
c52b0b34 428 {
ad3aaf33 429 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
c52b0b34 430
ad3aaf33 431 GCPRO4 (infile, buffer, current_dir, error_file);
5c150961 432 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
c52b0b34
KH
433 UNGCPRO;
434 }
012c6fcb 435 if (NILP (path))
80856e74 436 {
68c45bf0 437 emacs_close (filefd);
80856e74
JB
438 report_file_error ("Searching for program", Fcons (args[0], Qnil));
439 }
8ee8f447
RS
440
441 /* If program file name starts with /: for quoting a magic name,
442 discard that. */
443 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
444 && SREF (path, 1) == ':')
445 path = Fsubstring (path, make_number (2), Qnil);
446
98c6f1e3 447 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
c364e618 448
e7c3fb06
EZ
449 {
450 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
451
452 GCPRO5 (infile, buffer, current_dir, path, error_file);
453 if (nargs > 4)
454 {
455 ptrdiff_t i;
456
457 argument_coding.dst_multibyte = 0;
458 for (i = 4; i < nargs; i++)
459 {
460 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
461 if (CODING_REQUIRE_ENCODING (&argument_coding))
462 /* We must encode this argument. */
463 args[i] = encode_coding_string (&argument_coding, args[i], 1);
464 }
465 for (i = 4; i < nargs; i++)
94fbc901 466 new_argv[i - 3] = SSDATA (args[i]);
e7c3fb06
EZ
467 new_argv[i - 3] = 0;
468 }
469 else
470 new_argv[1] = 0;
471 if (STRING_MULTIBYTE (path))
472 path = ENCODE_FILE (path);
94fbc901 473 new_argv[0] = SSDATA (path);
e7c3fb06
EZ
474 UNGCPRO;
475 }
80856e74 476
7e6c2178 477#ifdef MSDOS /* MW, July 1993 */
7e6c2178 478
888c9e86
EZ
479 /* If we're redirecting STDOUT to a file, that file is already open
480 on fd_output. */
1ef14cb4 481 if (fd_output < 0)
7e6c2178 482 {
888c9e86
EZ
483 if ((outf = egetenv ("TMPDIR")))
484 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
485 else
486 {
487 tempfile = alloca (20);
488 *tempfile = '\0';
489 }
e7ac588e 490 dostounix_filename (tempfile, 0);
888c9e86
EZ
491 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
492 strcat (tempfile, "/");
493 strcat (tempfile, "detmp.XXX");
494 mktemp (tempfile);
1ef14cb4
LMI
495 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
496 if (outfilefd < 0) {
497 emacs_close (filefd);
498 report_file_error ("Opening process output file",
499 Fcons (build_string (tempfile), Qnil));
500 }
7e6c2178 501 }
1ef14cb4
LMI
502 else
503 outfilefd = fd_output;
60aeceb8
PE
504 fd0 = filefd;
505 fd1 = outfilefd;
6f89d28a 506#endif /* MSDOS */
7e6c2178 507
d50d3dc8 508 if (INTEGERP (buffer))
60aeceb8
PE
509 {
510 fd0 = -1;
511 fd1 = emacs_open (NULL_DEVICE, O_WRONLY, 0);
512 }
80856e74
JB
513 else
514 {
7e6c2178 515#ifndef MSDOS
60aeceb8 516 int fd[2];
db92b288
GM
517 if (pipe (fd) == -1)
518 {
60aeceb8 519 int pipe_errno = errno;
db92b288 520 emacs_close (filefd);
60aeceb8 521 errno = pipe_errno;
db92b288
GM
522 report_file_error ("Creating process pipe", Qnil);
523 }
60aeceb8
PE
524 fd0 = fd[0];
525 fd1 = fd[1];
80856e74
JB
526#endif
527 }
528
529 {
39eaa782 530 int fd_error = fd1;
80856e74 531
1ef14cb4
LMI
532 if (fd_output >= 0)
533 fd1 = fd_output;
80856e74 534
39eaa782 535 if (NILP (error_file))
68c45bf0 536 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
39eaa782
RS
537 else if (STRINGP (error_file))
538 {
539#ifdef DOS_NT
42a5b22f 540 fd_error = emacs_open (SSDATA (error_file),
68c45bf0
PE
541 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
542 S_IREAD | S_IWRITE);
39eaa782 543#else /* not DOS_NT */
42a5b22f 544 fd_error = creat (SSDATA (error_file), 0666);
39eaa782
RS
545#endif /* not DOS_NT */
546 }
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
1ddc85a4 1040#ifdef HAVE_MKSTEMP
3c59b4c9
PE
1041 {
1042 int fd;
1043
4d7e6e51 1044 block_input ();
3c59b4c9 1045 fd = mkstemp (tempfile);
4d7e6e51 1046 unblock_input ();
3c59b4c9
PE
1047 if (fd == -1)
1048 report_file_error ("Failed to open temporary file",
baac5bc7 1049 Fcons (build_string (tempfile), Qnil));
3c59b4c9
PE
1050 else
1051 close (fd);
1052 }
1ddc85a4 1053#else
d3cefd13 1054 errno = 0;
3c59b4c9 1055 mktemp (tempfile);
d3cefd13
EZ
1056 if (!*tempfile)
1057 {
1058 if (!errno)
1059 errno = EEXIST;
1060 report_file_error ("Failed to open temporary file using pattern",
1061 Fcons (pattern, Qnil));
1062 }
1ddc85a4 1063#endif
80856e74 1064
3c59b4c9
PE
1065 filename_string = build_string (tempfile);
1066 GCPRO1 (filename_string);
1067 SAFE_FREE ();
1068 }
1069
80856e74
JB
1070 start = args[0];
1071 end = args[1];
32d08644 1072 /* Decide coding-system of the contents of the temporary file. */
91489411
RS
1073 if (!NILP (Vcoding_system_for_write))
1074 val = Vcoding_system_for_write;
4b4deea2 1075 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
fcaf8878 1076 val = Qraw_text;
32d08644 1077 else
beacaab3 1078 {
3c59b4c9 1079 USE_SAFE_ALLOCA;
0065d054 1080 SAFE_NALLOCA (args2, 1, nargs + 1);
91489411
RS
1081 args2[0] = Qcall_process_region;
1082 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1083 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
fcaf8878 1084 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
3c59b4c9 1085 SAFE_FREE ();
beacaab3 1086 }
fcaf8878 1087 val = complement_process_encoding_system (val);
32d08644 1088
168afdaa 1089 {
d311d28c 1090 ptrdiff_t count1 = SPECPDL_INDEX ();
168afdaa
RS
1091
1092 specbind (intern ("coding-system-for-write"), val);
bb951f0e
KR
1093 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1094 happen to get a ".Z" suffix. */
1095 specbind (intern ("file-name-handler-alist"), Qnil);
168afdaa
RS
1096 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1097
1098 unbind_to (count1, Qnil);
1099 }
91489411 1100
177c0ea7 1101 /* Note that Fcall_process takes care of binding
91489411 1102 coding-system-for-read. */
093650fe 1103
80856e74
JB
1104 record_unwind_protect (delete_temp_file, filename_string);
1105
edf496dd 1106 if (nargs > 3 && !NILP (args[3]))
80856e74
JB
1107 Fdelete_region (start, end);
1108
edf496dd
KH
1109 if (nargs > 3)
1110 {
1111 args += 2;
1112 nargs -= 2;
1113 }
1114 else
1115 {
1116 args[0] = args[2];
1117 nargs = 2;
1118 }
1119 args[1] = filename_string;
80856e74 1120
edf496dd 1121 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
80856e74
JB
1122}
1123\f
361358ea 1124#ifndef WINDOWSNT
971de7fb 1125static int relocate_fd (int fd, int minfd);
361358ea 1126#endif
dfcf069d 1127
5990851d
KL
1128static char **
1129add_env (char **env, char **new_env, char *string)
1130{
1131 char **ep;
2f221583 1132 bool ok = 1;
5990851d
KL
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)
19ed11ba
AS
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 }
5990851d
KL
1156 }
1157 if (ok)
1158 *new_env++ = string;
1159 return new_env;
1160}
1161
80856e74
JB
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
2f221583 1168 If SET_PGRP, put the subprocess into a separate process group.
e576cab4
JB
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. */
80856e74 1174
dfcf069d 1175int
2f221583
PE
1176child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1177 Lisp_Object current_dir)
80856e74 1178{
e576cab4 1179 char **env;
7fcf7f05 1180 char *pwd_var;
bad95d8f
RS
1181#ifdef WINDOWSNT
1182 int cpid;
4252a4bd 1183 HANDLE handles[3];
bad95d8f 1184#endif /* WINDOWSNT */
e576cab4 1185
d311d28c 1186 pid_t pid = getpid ();
80856e74 1187
80856e74
JB
1188 /* Close Emacs's descriptors that this process should not have. */
1189 close_process_descs ();
ded80a25 1190
c17c4250
EZ
1191 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1192 we will lose if we call close_load_descs here. */
1193#ifndef DOS_NT
4458cebe 1194 close_load_descs ();
c17c4250 1195#endif
80856e74
JB
1196
1197 /* Note that use of alloca is always safe here. It's obvious for systems
1198 that do not have true vfork or that have true (stack) alloca.
caa01fe0
GM
1199 If using vfork and C_ALLOCA (when Emacs used to include
1200 src/alloca.c) it is safe because that changes the superior's
1201 static variables as if the superior had done alloca and will be
1202 cleaned up in the usual way. */
e576cab4 1203 {
7fcf7f05 1204 register char *temp;
0065d054 1205 size_t i; /* size_t, because ptrdiff_t might overflow here! */
77d78be1 1206
d5db4077 1207 i = SBYTES (current_dir);
16425c4a
EZ
1208#ifdef MSDOS
1209 /* MSDOS must have all environment variables malloc'ed, because
1210 low-level libc functions that launch subsidiary processes rely
1211 on that. */
23f86fce 1212 pwd_var = xmalloc (i + 6);
16425c4a 1213#else
38182d90 1214 pwd_var = alloca (i + 6);
16425c4a 1215#endif
7fcf7f05 1216 temp = pwd_var + 4;
72af86bd
AS
1217 memcpy (pwd_var, "PWD=", 4);
1218 memcpy (temp, SDATA (current_dir), i);
bad95d8f 1219 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
e576cab4
JB
1220 temp[i] = 0;
1221
c17c4250 1222#ifndef DOS_NT
e576cab4
JB
1223 /* We can't signal an Elisp error here; we're in a vfork. Since
1224 the callers check the current directory before forking, this
1225 should only return an error if the directory's permissions
1226 are changed between the check and this chdir, but we should
1227 at least check. */
1228 if (chdir (temp) < 0)
20b25e46 1229 _exit (errno);
f8d23104 1230#else /* DOS_NT */
c17c4250
EZ
1231 /* Get past the drive letter, so that d:/ is left alone. */
1232 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1233 {
1234 temp += 2;
1235 i -= 2;
1236 }
f8d23104 1237#endif /* DOS_NT */
c17c4250 1238
7fcf7f05 1239 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
bad95d8f 1240 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
7fcf7f05 1241 temp[--i] = 0;
e576cab4 1242 }
80856e74 1243
5990851d 1244 /* Set `env' to a vector of the strings in the environment. */
80856e74
JB
1245 {
1246 register Lisp_Object tem;
1247 register char **new_env;
5990851d 1248 char **p, **q;
80856e74 1249 register int new_length;
d2bb6598 1250 Lisp_Object display = Qnil;
361358ea 1251
80856e74 1252 new_length = 0;
f105f403 1253
80856e74 1254 for (tem = Vprocess_environment;
19ed11ba
AS
1255 CONSP (tem) && STRINGP (XCAR (tem));
1256 tem = XCDR (tem))
d2bb6598 1257 {
42a5b22f 1258 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
d2bb6598
SM
1259 && (SDATA (XCAR (tem)) [7] == '\0'
1260 || SDATA (XCAR (tem)) [7] == '='))
1261 /* DISPLAY is specified in process-environment. */
1262 display = Qt;
1263 new_length++;
1264 }
de87fb59 1265
d2bb6598
SM
1266 /* If not provided yet, use the frame's DISPLAY. */
1267 if (NILP (display))
1268 {
1269 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1270 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1271 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1272 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1273 Vinitial_environment);
1274 if (STRINGP (tmp))
1275 {
1276 display = tmp;
1277 new_length++;
1278 }
1279 }
80856e74 1280
7fcf7f05 1281 /* new_length + 2 to include PWD and terminating 0. */
38182d90 1282 env = new_env = alloca ((new_length + 2) * sizeof *env);
7fcf7f05
RS
1283 /* If we have a PWD envvar, pass one down,
1284 but with corrected value. */
a13f8f50 1285 if (egetenv ("PWD"))
7fcf7f05 1286 *new_env++ = pwd_var;
361358ea 1287
6b8e474c 1288 if (STRINGP (display))
de87fb59 1289 {
38182d90 1290 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
de87fb59 1291 strcpy (vdata, "DISPLAY=");
42a5b22f 1292 strcat (vdata, SSDATA (display));
de87fb59
DN
1293 new_env = add_env (env, new_env, vdata);
1294 }
80856e74 1295
5990851d 1296 /* Overrides. */
80856e74 1297 for (tem = Vprocess_environment;
70949dac
KR
1298 CONSP (tem) && STRINGP (XCAR (tem));
1299 tem = XCDR (tem))
42a5b22f 1300 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
d2bb6598 1301
5990851d
KL
1302 *new_env = 0;
1303
1304 /* Remove variable names without values. */
1305 p = q = env;
1306 while (*p != 0)
cd9565ba 1307 {
19ed11ba
AS
1308 while (*q != 0 && strchr (*q, '=') == NULL)
1309 q++;
1310 *p = *q++;
1311 if (*p != 0)
1312 p++;
cd9565ba 1313 }
80856e74 1314 }
de87fb59 1315
361358ea 1316
bad95d8f
RS
1317#ifdef WINDOWSNT
1318 prepare_standard_handles (in, out, err, handles);
d5db4077 1319 set_process_dir (SDATA (current_dir));
d3d14b40 1320 /* Spawn the child. (See w32proc.c:sys_spawnve). */
67802943
DN
1321 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1322 reset_standard_handles (in, out, err, handles);
1323 if (cpid == -1)
1324 /* An error occurred while trying to spawn the process. */
1325 report_file_error ("Spawning child process", Qnil);
1326 return cpid;
1327
bad95d8f 1328#else /* not WINDOWSNT */
426b37ae
JB
1329 /* Make sure that in, out, and err are not actually already in
1330 descriptors zero, one, or two; this could happen if Emacs is
7e6c2178 1331 started with its standard in, out, or error closed, as might
426b37ae 1332 happen under X. */
f29f9e4a
RS
1333 {
1334 int oin = in, oout = out;
1335
1336 /* We have to avoid relocating the same descriptor twice! */
1337
1338 in = relocate_fd (in, 3);
1339
1340 if (out == oin)
1341 out = in;
1342 else
3e9367e7 1343 out = relocate_fd (out, 3);
f29f9e4a
RS
1344
1345 if (err == oin)
1346 err = in;
1347 else if (err == oout)
1348 err = out;
1349 else
3e9367e7 1350 err = relocate_fd (err, 3);
f29f9e4a 1351 }
426b37ae 1352
c17c4250 1353#ifndef MSDOS
68c45bf0
PE
1354 emacs_close (0);
1355 emacs_close (1);
1356 emacs_close (2);
80856e74
JB
1357
1358 dup2 (in, 0);
1359 dup2 (out, 1);
1360 dup2 (err, 2);
68c45bf0 1361 emacs_close (in);
ce8f5a9a
AS
1362 if (out != in)
1363 emacs_close (out);
1364 if (err != in && err != out)
1365 emacs_close (err);
80856e74 1366
dd0333b6 1367 setpgid (0, 0);
12e610e8 1368 tcsetpgrp (0, pid);
a7ebc409 1369
21e54a94 1370 execve (new_argv[0], new_argv, env);
80856e74 1371
68c45bf0
PE
1372 emacs_write (1, "Can't exec program: ", 20);
1373 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1374 emacs_write (1, "\n", 1);
80856e74 1375 _exit (1);
67802943
DN
1376
1377#else /* MSDOS */
1378 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1379 xfree (pwd_var);
1380 if (pid == -1)
1381 /* An error occurred while trying to run the subprocess. */
1382 report_file_error ("Spawning child process", Qnil);
1383 return pid;
1384#endif /* MSDOS */
ae76d9e1 1385#endif /* not WINDOWSNT */
80856e74
JB
1386}
1387
361358ea 1388#ifndef WINDOWSNT
a3833dfe 1389/* Move the file descriptor FD so that its number is not less than MINFD.
426b37ae 1390 If the file descriptor is moved at all, the original is freed. */
dfcf069d 1391static int
971de7fb 1392relocate_fd (int fd, int minfd)
426b37ae 1393{
a3833dfe 1394 if (fd >= minfd)
426b37ae
JB
1395 return fd;
1396 else
1397 {
49cdacda 1398 int new = fcntl (fd, F_DUPFD, minfd);
426b37ae
JB
1399 if (new == -1)
1400 {
cb1d0ef7 1401 const char *message_1 = "Error while setting up child: ";
a8fe7202 1402 const char *errmessage = strerror (errno);
cb1d0ef7
PE
1403 const char *message_2 = "\n";
1404 emacs_write (2, message_1, strlen (message_1));
68c45bf0 1405 emacs_write (2, errmessage, strlen (errmessage));
cb1d0ef7 1406 emacs_write (2, message_2, strlen (message_2));
426b37ae
JB
1407 _exit (1);
1408 }
68c45bf0 1409 emacs_close (fd);
426b37ae
JB
1410 return new;
1411 }
1412}
361358ea 1413#endif /* not WINDOWSNT */
426b37ae 1414
2f221583 1415static bool
989f33ba
PE
1416getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1417 ptrdiff_t *valuelen, Lisp_Object env)
012c6fcb 1418{
db699fc6 1419 for (; CONSP (env); env = XCDR (env))
012c6fcb 1420 {
db699fc6 1421 Lisp_Object entry = XCAR (env);
d50d3dc8 1422 if (STRINGP (entry)
db699fc6 1423 && SBYTES (entry) >= varlen
bad95d8f
RS
1424#ifdef WINDOWSNT
1425 /* NT environment variables are case insensitive. */
d5db4077 1426 && ! strnicmp (SDATA (entry), var, varlen)
bad95d8f 1427#else /* not WINDOWSNT */
72af86bd 1428 && ! memcmp (SDATA (entry), var, varlen)
bad95d8f 1429#endif /* not WINDOWSNT */
a9971c6d 1430 )
012c6fcb 1431 {
db699fc6
SM
1432 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1433 {
51b59d79 1434 *value = SSDATA (entry) + (varlen + 1);
db699fc6
SM
1435 *valuelen = SBYTES (entry) - (varlen + 1);
1436 return 1;
1437 }
1438 else if (SBYTES (entry) == varlen)
1439 {
1440 /* Lone variable names in Vprocess_environment mean that
1441 variable should be removed from the environment. */
1442 *value = NULL;
1443 return 1;
1444 }
1445 }
1446 }
1447 return 0;
1448}
1449
2f221583 1450static bool
989f33ba
PE
1451getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1452 ptrdiff_t *valuelen, Lisp_Object frame)
012c6fcb 1453{
d2bb6598
SM
1454 /* Try to find VAR in Vprocess_environment first. */
1455 if (getenv_internal_1 (var, varlen, value, valuelen,
1456 Vprocess_environment))
1457 return *value ? 1 : 0;
f105f403 1458
d2bb6598 1459 /* For DISPLAY try to get the values from the frame or the initial env. */
de87fb59 1460 if (strcmp (var, "DISPLAY") == 0)
d2bb6598
SM
1461 {
1462 Lisp_Object display
1463 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1464 if (STRINGP (display))
1465 {
51b59d79 1466 *value = SSDATA (display);
de87fb59 1467 *valuelen = SBYTES (display);
012c6fcb
JA
1468 return 1;
1469 }
d2bb6598
SM
1470 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1471 if (getenv_internal_1 (var, varlen, value, valuelen,
1472 Vinitial_environment))
1473 return *value ? 1 : 0;
012c6fcb
JA
1474 }
1475
1476 return 0;
1477}
1478
f105f403 1479DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
5990851d
KL
1480 doc: /* Get the value of environment variable VARIABLE.
1481VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1482the environment. Otherwise, value is a string.
f105f403 1483
acf20901 1484This function searches `process-environment' for VARIABLE.
5990851d 1485
db699fc6 1486If optional parameter ENV is a list, then search this list instead of
acf20901
JB
1487`process-environment', and return t when encountering a negative entry
1488\(an entry for a variable with no value). */)
5842a27b 1489 (Lisp_Object variable, Lisp_Object env)
012c6fcb
JA
1490{
1491 char *value;
989f33ba 1492 ptrdiff_t valuelen;
012c6fcb 1493
5990851d 1494 CHECK_STRING (variable);
db699fc6
SM
1495 if (CONSP (env))
1496 {
42a5b22f 1497 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
db699fc6
SM
1498 &value, &valuelen, env))
1499 return value ? make_string (value, valuelen) : Qt;
1500 else
1501 return Qnil;
1502 }
42a5b22f 1503 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
d2bb6598 1504 &value, &valuelen, env))
012c6fcb
JA
1505 return make_string (value, valuelen);
1506 else
1507 return Qnil;
1508}
1509
5990851d
KL
1510/* A version of getenv that consults the Lisp environment lists,
1511 easily callable from C. */
012c6fcb 1512char *
a8fe7202 1513egetenv (const char *var)
012c6fcb
JA
1514{
1515 char *value;
25c7e41f 1516 ptrdiff_t valuelen;
012c6fcb 1517
f105f403 1518 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
012c6fcb
JA
1519 return value;
1520 else
1521 return 0;
1522}
1523
80856e74 1524\f
8de15d69 1525/* This is run before init_cmdargs. */
177c0ea7 1526
dfcf069d 1527void
971de7fb 1528init_callproc_1 (void)
8de15d69 1529{
d01ba2f1
GM
1530#ifdef HAVE_NS
1531 const char *etc_dir = ns_etc_directory ();
cbb31951 1532 const char *path_exec = ns_exec_path ();
d01ba2f1 1533#endif
35a2f4b8 1534
76151e2c 1535 Vdata_directory = decode_env_path ("EMACSDATA",
d01ba2f1 1536#ifdef HAVE_NS
76151e2c 1537 etc_dir ? etc_dir :
d01ba2f1 1538#endif
76151e2c
EZ
1539 PATH_DATA);
1540 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1541
1542 Vdoc_directory = decode_env_path ("EMACSDOC",
d01ba2f1 1543#ifdef HAVE_NS
76151e2c 1544 etc_dir ? etc_dir :
d01ba2f1 1545#endif
76151e2c
EZ
1546 PATH_DOC);
1547 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
9453ea7b 1548
e576cab4 1549 /* Check the EMACSPATH environment variable, defaulting to the
57bda87a 1550 PATH_EXEC path from epaths.h. */
cbb31951
GM
1551 Vexec_path = decode_env_path ("EMACSPATH",
1552#ifdef HAVE_NS
1553 path_exec ? path_exec :
1554#endif
1555 PATH_EXEC);
80856e74 1556 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
cbb31951 1557 /* FIXME? For ns, path_exec should go at the front? */
80856e74 1558 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
8de15d69
RS
1559}
1560
e17f7533 1561/* This is run after init_cmdargs, when Vinstallation_directory is valid. */
8de15d69 1562
dfcf069d 1563void
971de7fb 1564init_callproc (void)
8de15d69
RS
1565{
1566 char *data_dir = egetenv ("EMACSDATA");
177c0ea7 1567
8de15d69
RS
1568 register char * sh;
1569 Lisp_Object tempdir;
d01ba2f1
GM
1570#ifdef HAVE_NS
1571 if (data_dir == 0)
1572 {
1573 const char *etc_dir = ns_etc_directory ();
1574 if (etc_dir)
1575 {
1576 data_dir = alloca (strlen (etc_dir) + 1);
1577 strcpy (data_dir, etc_dir);
1578 }
1579 }
1580#endif
8de15d69 1581
9cc4fad5 1582 if (!NILP (Vinstallation_directory))
8de15d69 1583 {
05630743
RS
1584 /* Add to the path the lib-src subdir of the installation dir. */
1585 Lisp_Object tem;
1586 tem = Fexpand_file_name (build_string ("lib-src"),
1587 Vinstallation_directory);
76151e2c 1588#ifndef MSDOS
1a6640ec 1589 /* MSDOS uses wrapped binaries, so don't do this. */
0fa248bc 1590 if (NILP (Fmember (tem, Vexec_path)))
70ec1377 1591 {
cbb31951
GM
1592#ifdef HAVE_NS
1593 const char *path_exec = ns_exec_path ();
1594#endif
1595 Vexec_path = decode_env_path ("EMACSPATH",
1596#ifdef HAVE_NS
1597 path_exec ? path_exec :
1598#endif
1599 PATH_EXEC);
70ec1377
RS
1600 Vexec_path = Fcons (tem, Vexec_path);
1601 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1602 }
177c0ea7 1603
0fa248bc 1604 Vexec_directory = Ffile_name_as_directory (tem);
76151e2c 1605#endif /* not MSDOS */
8de15d69 1606
e17f7533
RS
1607 /* Maybe use ../etc as well as ../lib-src. */
1608 if (data_dir == 0)
1609 {
1610 tem = Fexpand_file_name (build_string ("etc"),
1611 Vinstallation_directory);
1612 Vdoc_directory = Ffile_name_as_directory (tem);
8de15d69
RS
1613 }
1614 }
7e933683
RS
1615
1616 /* Look for the files that should be in etc. We don't use
1617 Vinstallation_directory, because these files are never installed
e17f7533 1618 near the executable, and they are never in the build
7e933683
RS
1619 directory when that's different from the source directory.
1620
1621 Instead, if these files are not in the nominal place, we try the
1622 source directory. */
1623 if (data_dir == 0)
1624 {
70ec1377 1625 Lisp_Object tem, tem1, srcdir;
7e933683 1626
70ec1377
RS
1627 srcdir = Fexpand_file_name (build_string ("../src/"),
1628 build_string (PATH_DUMPLOADSEARCH));
7e933683
RS
1629 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1630 tem1 = Ffile_exists_p (tem);
70ec1377 1631 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
7e933683 1632 {
70ec1377 1633 Lisp_Object newdir;
7e933683
RS
1634 newdir = Fexpand_file_name (build_string ("../etc/"),
1635 build_string (PATH_DUMPLOADSEARCH));
1636 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1637 tem1 = Ffile_exists_p (tem);
1638 if (!NILP (tem1))
1639 Vdata_directory = newdir;
1640 }
1641 }
80856e74 1642
d883eb62
RS
1643#ifndef CANNOT_DUMP
1644 if (initialized)
1645#endif
1646 {
1647 tempdir = Fdirectory_file_name (Vexec_directory);
73dcdb9f
PE
1648 if (! file_accessible_directory_p (SSDATA (tempdir)))
1649 dir_warning ("arch-dependent data dir", Vexec_directory);
d883eb62 1650 }
80856e74 1651
e576cab4 1652 tempdir = Fdirectory_file_name (Vdata_directory);
73dcdb9f
PE
1653 if (! file_accessible_directory_p (SSDATA (tempdir)))
1654 dir_warning ("arch-independent data dir", Vdata_directory);
e576cab4 1655
83be8524 1656 sh = getenv ("SHELL");
80856e74 1657 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
8abd035b 1658
40b49d4b
JB
1659#ifdef DOS_NT
1660 Vshared_game_score_directory = Qnil;
1661#else
63789758 1662 Vshared_game_score_directory = build_string (PATH_GAME);
73dcdb9f 1663 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
63789758 1664 Vshared_game_score_directory = Qnil;
40b49d4b 1665#endif
9fefd2ba
JB
1666}
1667
dfcf069d 1668void
971de7fb 1669set_initial_environment (void)
9fefd2ba 1670{
738db178
DN
1671 char **envp;
1672 for (envp = environ; *envp; envp++)
1673 Vprocess_environment = Fcons (build_string (*envp),
1674 Vprocess_environment);
1675 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1676 to use `delete' and friends on process-environment. */
1677 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
80856e74
JB
1678}
1679
dfcf069d 1680void
971de7fb 1681syms_of_callproc (void)
80856e74 1682{
f92d51d8
CY
1683#ifndef DOS_NT
1684 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1685#elif defined (WINDOWSNT)
1686 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1687#else
1688 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1689#endif
1690 staticpro (&Vtemp_file_name_pattern);
1691
29208e82 1692 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
fb7ada5f 1693 doc: /* File name to load inferior shells from.
b20b29be
EZ
1694Initialized from the SHELL environment variable, or to a system-dependent
1695default if SHELL is not set. */);
80856e74 1696
29208e82 1697 DEFVAR_LISP ("exec-path", Vexec_path,
fb7ada5f 1698 doc: /* List of directories to search programs to run in subprocesses.
fdb82f93 1699Each element is a string (directory name) or nil (try default directory). */);
80856e74 1700
29208e82 1701 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
fb7ada5f 1702 doc: /* List of suffixes to try to find executable file names.
fdb82f93 1703Each element is a string. */);
33d5af99 1704 Vexec_suffixes = Qnil;
b81a1b72 1705
29208e82 1706 DEFVAR_LISP ("exec-directory", Vexec_directory,
fdb82f93
PJ
1707 doc: /* Directory for executables for Emacs to invoke.
1708More generally, this includes any architecture-dependent files
1709that are built and installed from the Emacs distribution. */);
e576cab4 1710
29208e82 1711 DEFVAR_LISP ("data-directory", Vdata_directory,
fdb82f93
PJ
1712 doc: /* Directory of machine-independent files that come with GNU Emacs.
1713These are files intended for Emacs to use while it runs. */);
80856e74 1714
29208e82 1715 DEFVAR_LISP ("doc-directory", Vdoc_directory,
fdb82f93 1716 doc: /* Directory containing the DOC file that comes with GNU Emacs.
ebf24b59 1717This is usually the same as `data-directory'. */);
35a2f4b8 1718
29208e82 1719 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
fdb82f93
PJ
1720 doc: /* For internal use by the build procedure only.
1721This is the name of the directory in which the build procedure installed
ebf24b59 1722Emacs's info files; the default value for `Info-default-directory-list'
fdb82f93 1723includes this. */);
ed61592a
JB
1724 Vconfigure_info_directory = build_string (PATH_INFO);
1725
29208e82 1726 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
b065672a
CW
1727 doc: /* Directory of score files for games which come with GNU Emacs.
1728If this variable is nil, then Emacs is unable to use a shared directory. */);
40b49d4b
JB
1729#ifdef DOS_NT
1730 Vshared_game_score_directory = Qnil;
1731#else
63789758 1732 Vshared_game_score_directory = build_string (PATH_GAME);
40b49d4b 1733#endif
b065672a 1734
29208e82 1735 DEFVAR_LISP ("initial-environment", Vinitial_environment,
6b8e474c
SM
1736 doc: /* List of environment variables inherited from the parent process.
1737Each element should be a string of the form ENVVARNAME=VALUE.
1738The elements must normally be decoded (using `locale-coding-system') for use. */);
1739 Vinitial_environment = Qnil;
1740
29208e82 1741 DEFVAR_LISP ("process-environment", Vprocess_environment,
5990851d 1742 doc: /* List of overridden environment variables for subprocesses to inherit.
fdb82f93 1743Each element should be a string of the form ENVVARNAME=VALUE.
5990851d 1744
a13f8f50
KL
1745Entries in this list take precedence to those in the frame-local
1746environments. Therefore, let-binding `process-environment' is an easy
1747way to temporarily change the value of an environment variable,
1748irrespective of where it comes from. To use `process-environment' to
1749remove an environment variable, include only its name in the list,
1750without "=VALUE".
5990851d
KL
1751
1752This variable is set to nil when Emacs starts.
1753
fdb82f93
PJ
1754If multiple entries define the same variable, the first one always
1755takes precedence.
5990851d 1756
776a24a1 1757Non-ASCII characters are encoded according to the initial value of
5990851d
KL
1758`locale-coding-system', i.e. the elements must normally be decoded for
1759use.
1760
776a24a1 1761See `setenv' and `getenv'. */);
86f5ca04 1762 Vprocess_environment = Qnil;
80856e74 1763
80856e74 1764 defsubr (&Scall_process);
83fa009c 1765 defsubr (&Sgetenv_internal);
e576cab4 1766 defsubr (&Scall_process_region);
80856e74 1767}