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