Update FSF's address.
[bpt/emacs.git] / src / callproc.c
CommitLineData
80856e74 1/* Synchronous subprocess invocation for GNU Emacs.
fe12847a
SM
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
80856e74
JB
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
826c56ac 9the Free Software Foundation; either version 2, or (at your option)
80856e74
JB
10any later version.
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
18along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
80856e74
JB
21
22
68c45bf0 23#include <config.h>
80856e74 24#include <signal.h>
e576cab4 25#include <errno.h>
565620a5 26#include <stdio.h>
80856e74 27
03695ace 28#ifndef USE_CRT_DLL
426b37ae 29extern int errno;
03695ace 30#endif
426b37ae 31
80856e74
JB
32/* Define SIGCHLD as an alias for SIGCLD. */
33
34#if !defined (SIGCHLD) && defined (SIGCLD)
35#define SIGCHLD SIGCLD
36#endif /* SIGCLD */
37
38#include <sys/types.h>
88a64fef 39
3cbd6585
GM
40#ifdef HAVE_UNISTD_H
41#include <unistd.h>
42#endif
43
80856e74 44#include <sys/file.h>
776a24a1 45#ifdef HAVE_FCNTL_H
472e83fe 46#define INCLUDED_FCNTL
80856e74
JB
47#include <fcntl.h>
48#endif
49
bad95d8f
RS
50#ifdef WINDOWSNT
51#define NOMINMAX
52#include <windows.h>
53#include <stdlib.h> /* for proper declaration of environ */
54#include <fcntl.h>
489f9371 55#include "w32.h"
bad95d8f
RS
56#define _P_NOWAIT 1 /* from process.h */
57#endif
58
7e6c2178 59#ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
472e83fe 60#define INCLUDED_FCNTL
7e6c2178
RS
61#include <fcntl.h>
62#include <sys/stat.h>
63#include <sys/param.h>
64#include <errno.h>
65#endif /* MSDOS */
66
80856e74
JB
67#ifndef O_RDONLY
68#define O_RDONLY 0
69#endif
70
71#ifndef O_WRONLY
72#define O_WRONLY 1
73#endif
74
75#include "lisp.h"
76#include "commands.h"
77#include "buffer.h"
32d08644 78#include "charset.h"
edf496dd 79#include "ccl.h"
32d08644 80#include "coding.h"
f0b950cf 81#include "composite.h"
57bda87a 82#include <epaths.h>
80856e74 83#include "process.h"
d177f194 84#include "syssignal.h"
a129418f 85#include "systty.h"
aba637ec 86#include "blockinput.h"
80856e74 87
5f027cea
EZ
88#ifdef MSDOS
89#include "msdos.h"
90#endif
91
80856e74
JB
92#ifdef VMS
93extern noshare char **environ;
94#else
03695ace 95#ifndef USE_CRT_DLL
80856e74
JB
96extern char **environ;
97#endif
03695ace 98#endif
80856e74 99
f95c3f91 100#ifdef HAVE_SETPGID
2b7e8799 101#if !defined (USG) || defined (BSD_PGRPS)
320695d8 102#undef setpgrp
f95c3f91
GM
103#define setpgrp setpgid
104#endif
2b7e8799 105#endif
f95c3f91 106
b81a1b72
SM
107Lisp_Object Vexec_path, Vexec_directory, Vexec_suffixes;
108Lisp_Object Vdata_directory, Vdoc_directory;
1e7ce61b 109Lisp_Object Vconfigure_info_directory, Vshared_game_score_directory;
8abd035b 110Lisp_Object Vtemp_file_name_pattern;
80856e74
JB
111
112Lisp_Object Vshell_file_name;
113
80856e74 114Lisp_Object Vprocess_environment;
80856e74 115
bad95d8f 116#ifdef DOS_NT
093650fe 117Lisp_Object Qbuffer_file_type;
bad95d8f 118#endif /* DOS_NT */
093650fe 119
80856e74
JB
120/* True iff we are about to fork off a synchronous process or if we
121 are waiting for it. */
122int synch_process_alive;
123
124/* Nonzero => this is a string explaining death of synchronous subprocess. */
125char *synch_process_death;
126
ca498128
JD
127/* Nonzero => this is the signal number that terminated the subprocess. */
128int synch_process_termsig;
129
80856e74
JB
130/* If synch_process_death is zero,
131 this is exit code of synchronous subprocess. */
132int synch_process_retcode;
133\f
37d54121
RS
134/* Clean up when exiting Fcall_process.
135 On MSDOS, delete the temporary file on any kind of termination.
136 On Unix, kill the process and any children on termination by signal. */
137
138/* Nonzero if this is termination due to exit. */
139static int call_process_exited;
140
80856e74
JB
141#ifndef VMS /* VMS version is in vmsproc.c. */
142
d177f194
JB
143static Lisp_Object
144call_process_kill (fdpid)
145 Lisp_Object fdpid;
146{
68c45bf0 147 emacs_close (XFASTINT (Fcar (fdpid)));
d177f194
JB
148 EMACS_KILLPG (XFASTINT (Fcdr (fdpid)), SIGKILL);
149 synch_process_alive = 0;
150 return Qnil;
151}
152
80856e74
JB
153Lisp_Object
154call_process_cleanup (fdpid)
155 Lisp_Object fdpid;
156{
e0f712ba 157#if defined (MSDOS) || defined (MAC_OS8)
7e6c2178 158 /* for MSDOS fdpid is really (fd . tempfile) */
c1350752
KH
159 register Lisp_Object file;
160 file = Fcdr (fdpid);
68c45bf0 161 emacs_close (XFASTINT (Fcar (fdpid)));
d5db4077
KR
162 if (strcmp (SDATA (file), NULL_DEVICE) != 0)
163 unlink (SDATA (file));
e0f712ba 164#else /* not MSDOS and not MAC_OS8 */
d177f194
JB
165 register int pid = XFASTINT (Fcdr (fdpid));
166
37d54121 167 if (call_process_exited)
6b6e798b 168 {
68c45bf0 169 emacs_close (XFASTINT (Fcar (fdpid)));
6b6e798b
RS
170 return Qnil;
171 }
37d54121 172
d177f194
JB
173 if (EMACS_KILLPG (pid, SIGINT) == 0)
174 {
aed13378 175 int count = SPECPDL_INDEX ();
d177f194
JB
176 record_unwind_protect (call_process_kill, fdpid);
177 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
178 immediate_quit = 1;
179 QUIT;
180 wait_for_termination (pid);
181 immediate_quit = 0;
182 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
183 message1 ("Waiting for process to die...done");
184 }
80856e74 185 synch_process_alive = 0;
68c45bf0 186 emacs_close (XFASTINT (Fcar (fdpid)));
7e6c2178 187#endif /* not MSDOS */
80856e74
JB
188 return Qnil;
189}
190
191DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
fdb82f93
PJ
192 doc: /* Call PROGRAM synchronously in separate process.
193The remaining arguments are optional.
194The program's input comes from file INFILE (nil means `/dev/null').
195Insert output in BUFFER before point; t means current buffer;
196 nil for BUFFER means discard it; 0 means discard and don't wait.
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
206If BUFFER is 0, `call-process' returns immediately with value nil.
207Otherwise it waits for PROGRAM to terminate
208and returns a numeric exit status or a signal description string.
d98b59b5
MB
209If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
210
211usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
fdb82f93 212 (nargs, args)
80856e74
JB
213 int nargs;
214 register Lisp_Object *args;
215{
0aa2630f
KS
216 Lisp_Object infile, buffer, current_dir, path;
217 int display_p;
80856e74
JB
218 int fd[2];
219 int filefd;
220 register int pid;
4da256b1
KS
221#define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
222#define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
223 char buf[CALLPROC_BUFFER_SIZE_MAX];
224 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
aed13378 225 int count = SPECPDL_INDEX ();
2d607244 226
4d3b07fd
KR
227 register const unsigned char **new_argv
228 = (const unsigned char **) alloca ((max (2, nargs - 2)) * sizeof (char *));
80856e74 229 struct buffer *old = current_buffer;
39eaa782
RS
230 /* File to use for stderr in the child.
231 t means use same as standard output. */
232 Lisp_Object error_file;
7e6c2178
RS
233#ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
234 char *outf, *tempfile;
235 int outfilefd;
236#endif
e0f712ba 237#ifdef MAC_OS8
052062e0
RS
238 char *tempfile;
239 int outfilefd;
240#endif
80856e74
JB
241#if 0
242 int mask;
243#endif
32d08644
KH
244 struct coding_system process_coding; /* coding-system of process output */
245 struct coding_system argument_coding; /* coding-system of arguments */
09494912
RS
246 /* Set to the return value of Ffind_operation_coding_system. */
247 Lisp_Object coding_systems;
248
249 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
250 coding_systems = Qt;
32d08644 251
b7826503 252 CHECK_STRING (args[0]);
80856e74 253
39eaa782
RS
254 error_file = Qt;
255
7e6c2178
RS
256#ifndef subprocesses
257 /* Without asynchronous processes we cannot have BUFFER == 0. */
177c0ea7 258 if (nargs >= 3
09ffb8b5 259 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
7e6c2178
RS
260 error ("Operating system cannot handle asynchronous subprocesses");
261#endif /* subprocesses */
262
09494912 263 /* Decide the coding-system for giving arguments. */
32d08644
KH
264 {
265 Lisp_Object val, *args2;
32d08644
KH
266 int i;
267
268 /* If arguments are supplied, we may have to encode them. */
269 if (nargs >= 5)
270 {
30d57b8e
RS
271 int must_encode = 0;
272
e7c1c20e 273 for (i = 4; i < nargs; i++)
b7826503 274 CHECK_STRING (args[i]);
e7c1c20e 275
a2286b5c 276 for (i = 4; i < nargs; i++)
30d57b8e
RS
277 if (STRING_MULTIBYTE (args[i]))
278 must_encode = 1;
279
beacaab3
KH
280 if (!NILP (Vcoding_system_for_write))
281 val = Vcoding_system_for_write;
30d57b8e 282 else if (! must_encode)
beacaab3
KH
283 val = Qnil;
284 else
32d08644
KH
285 {
286 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
287 args2[0] = Qcall_process;
288 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
08ee4e87 289 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
776b95cb 290 if (CONSP (coding_systems))
70949dac 291 val = XCDR (coding_systems);
776b95cb 292 else if (CONSP (Vdefault_process_coding_system))
70949dac 293 val = XCDR (Vdefault_process_coding_system);
beacaab3
KH
294 else
295 val = Qnil;
32d08644
KH
296 }
297 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
298 }
32d08644
KH
299 }
300
e576cab4
JB
301 if (nargs >= 2 && ! NILP (args[1]))
302 {
303 infile = Fexpand_file_name (args[1], 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
313 /* If BUFFER is a list, its meaning is
314 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
315 if (CONSP (buffer))
316 {
70949dac 317 if (CONSP (XCDR (buffer)))
45be8a1e 318 {
a9d4f28a 319 Lisp_Object stderr_file;
70949dac 320 stderr_file = XCAR (XCDR (buffer));
45be8a1e
RS
321
322 if (NILP (stderr_file) || EQ (Qt, stderr_file))
323 error_file = stderr_file;
324 else
325 error_file = Fexpand_file_name (stderr_file, Qnil);
326 }
327
70949dac 328 buffer = XCAR (buffer);
39eaa782 329 }
044512ed 330
39eaa782
RS
331 if (!(EQ (buffer, Qnil)
332 || EQ (buffer, Qt)
3ffde7d6 333 || INTEGERP (buffer)))
e576cab4 334 {
39eaa782
RS
335 Lisp_Object spec_buffer;
336 spec_buffer = buffer;
50fe359b 337 buffer = Fget_buffer_create (buffer);
39eaa782
RS
338 /* Mention the buffer name for a better error message. */
339 if (NILP (buffer))
b7826503
PJ
340 CHECK_BUFFER (spec_buffer);
341 CHECK_BUFFER (buffer);
e576cab4
JB
342 }
343 }
177c0ea7 344 else
e576cab4 345 buffer = Qnil;
80856e74 346
58616e67
JB
347 /* Make sure that the child will be able to chdir to the current
348 buffer's current directory, or its unhandled equivalent. We
349 can't just have the child check for an error when it does the
350 chdir, since it's in a vfork.
351
352 We have to GCPRO around this because Fexpand_file_name,
353 Funhandled_file_name_directory, and Ffile_accessible_directory_p
354 might call a file name handling function. The argument list is
355 protected by the caller, so all we really have to worry about is
356 buffer. */
357 {
358 struct gcpro gcpro1, gcpro2, gcpro3;
359
360 current_dir = current_buffer->directory;
361
362 GCPRO3 (infile, buffer, current_dir);
363
c52b0b34
KH
364 current_dir
365 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir),
366 Qnil);
58616e67
JB
367 if (NILP (Ffile_accessible_directory_p (current_dir)))
368 report_file_error ("Setting current directory",
369 Fcons (current_buffer->directory, Qnil));
370
371 UNGCPRO;
372 }
373
0aa2630f 374 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
80856e74 375
d5db4077 376 filefd = emacs_open (SDATA (infile), O_RDONLY, 0);
80856e74
JB
377 if (filefd < 0)
378 {
e576cab4 379 report_file_error ("Opening process input file", Fcons (infile, Qnil));
80856e74
JB
380 }
381 /* Search for program; barf if not found. */
c52b0b34
KH
382 {
383 struct gcpro gcpro1;
384
385 GCPRO1 (current_dir);
5c150961 386 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
c52b0b34
KH
387 UNGCPRO;
388 }
012c6fcb 389 if (NILP (path))
80856e74 390 {
68c45bf0 391 emacs_close (filefd);
80856e74
JB
392 report_file_error ("Searching for program", Fcons (args[0], Qnil));
393 }
8ee8f447
RS
394
395 /* If program file name starts with /: for quoting a magic name,
396 discard that. */
397 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
398 && SREF (path, 1) == ':')
399 path = Fsubstring (path, make_number (2), Qnil);
400
d5db4077 401 new_argv[0] = SDATA (path);
c364e618
KH
402 if (nargs > 4)
403 {
404 register int i;
c5bfa12b 405 struct gcpro gcpro1, gcpro2, gcpro3;
c364e618 406
c5bfa12b
KH
407 GCPRO3 (infile, buffer, current_dir);
408 argument_coding.dst_multibyte = 0;
409 for (i = 4; i < nargs; i++)
c364e618 410 {
c5bfa12b
KH
411 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
412 if (CODING_REQUIRE_ENCODING (&argument_coding))
c364e618 413 {
c5bfa12b
KH
414 /* We must encode this argument. */
415 args[i] = encode_coding_string (args[i], &argument_coding, 1);
416 if (argument_coding.type == coding_type_ccl)
417 setup_ccl_program (&(argument_coding.spec.ccl.encoder), Qnil);
c364e618 418 }
d5db4077 419 new_argv[i - 3] = SDATA (args[i]);
c364e618 420 }
c5bfa12b 421 UNGCPRO;
db54baaa 422 new_argv[nargs - 3] = 0;
c364e618 423 }
db54baaa
KH
424 else
425 new_argv[1] = 0;
80856e74 426
7e6c2178 427#ifdef MSDOS /* MW, July 1993 */
8a52365c 428 if ((outf = egetenv ("TMPDIR")))
7e6c2178
RS
429 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
430 else
431 {
432 tempfile = alloca (20);
433 *tempfile = '\0';
434 }
435 dostounix_filename (tempfile);
177c0ea7 436 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
7e6c2178
RS
437 strcat (tempfile, "/");
438 strcat (tempfile, "detmp.XXX");
439 mktemp (tempfile);
440
441 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
442 if (outfilefd < 0)
443 {
68c45bf0 444 emacs_close (filefd);
6f89d28a
MB
445 report_file_error ("Opening process output file",
446 Fcons (build_string (tempfile), Qnil));
7e6c2178 447 }
6f89d28a 448 fd[0] = filefd;
2610078a 449 fd[1] = outfilefd;
6f89d28a 450#endif /* MSDOS */
7e6c2178 451
e0f712ba 452#ifdef MAC_OS8
052062e0
RS
453 /* Since we don't have pipes on the Mac, create a temporary file to
454 hold the output of the subprocess. */
d5db4077
KR
455 tempfile = (char *) alloca (SBYTES (Vtemp_file_name_pattern) + 1);
456 bcopy (SDATA (Vtemp_file_name_pattern), tempfile,
457 SBYTES (Vtemp_file_name_pattern) + 1);
052062e0
RS
458
459 mktemp (tempfile);
460
461 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
462 if (outfilefd < 0)
463 {
464 close (filefd);
465 report_file_error ("Opening process output file",
466 Fcons (build_string (tempfile), Qnil));
467 }
468 fd[0] = filefd;
469 fd[1] = outfilefd;
e0f712ba 470#endif /* MAC_OS8 */
052062e0 471
d50d3dc8 472 if (INTEGERP (buffer))
68c45bf0 473 fd[1] = emacs_open (NULL_DEVICE, O_WRONLY, 0), fd[0] = -1;
80856e74
JB
474 else
475 {
7e6c2178 476#ifndef MSDOS
e0f712ba 477#ifndef MAC_OS8
db92b288
GM
478 errno = 0;
479 if (pipe (fd) == -1)
480 {
481 emacs_close (filefd);
482 report_file_error ("Creating process pipe", Qnil);
483 }
7e6c2178 484#endif
052062e0 485#endif
80856e74
JB
486#if 0
487 /* Replaced by close_process_descs */
488 set_exclusive_use (fd[0]);
489#endif
490 }
491
492 {
493 /* child_setup must clobber environ in systems with true vfork.
494 Protect it from permanent change. */
495 register char **save_environ = environ;
496 register int fd1 = fd[1];
39eaa782 497 int fd_error = fd1;
80856e74
JB
498
499#if 0 /* Some systems don't have sigblock. */
e065a56e 500 mask = sigblock (sigmask (SIGCHLD));
80856e74
JB
501#endif
502
503 /* Record that we're about to create a synchronous process. */
504 synch_process_alive = 1;
505
5c03767e
RS
506 /* These vars record information from process termination.
507 Clear them now before process can possibly terminate,
508 to avoid timing error if process terminates soon. */
509 synch_process_death = 0;
510 synch_process_retcode = 0;
ca498128 511 synch_process_termsig = 0;
5c03767e 512
39eaa782 513 if (NILP (error_file))
68c45bf0 514 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
39eaa782
RS
515 else if (STRINGP (error_file))
516 {
517#ifdef DOS_NT
d5db4077 518 fd_error = emacs_open (SDATA (error_file),
68c45bf0
PE
519 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
520 S_IREAD | S_IWRITE);
39eaa782 521#else /* not DOS_NT */
d5db4077 522 fd_error = creat (SDATA (error_file), 0666);
39eaa782
RS
523#endif /* not DOS_NT */
524 }
525
526 if (fd_error < 0)
527 {
68c45bf0 528 emacs_close (filefd);
6f89d28a 529 if (fd[0] != filefd)
68c45bf0 530 emacs_close (fd[0]);
39eaa782 531 if (fd1 >= 0)
68c45bf0 532 emacs_close (fd1);
6f89d28a
MB
533#ifdef MSDOS
534 unlink (tempfile);
535#endif
536 report_file_error ("Cannot redirect stderr",
537 Fcons ((NILP (error_file)
538 ? build_string (NULL_DEVICE) : error_file),
539 Qnil));
39eaa782 540 }
89e1ec1d 541
8d024345 542 current_dir = ENCODE_FILE (current_dir);
89e1ec1d 543
e0f712ba 544#ifdef MAC_OS8
052062e0
RS
545 {
546 /* Call run_mac_command in sysdep.c here directly instead of doing
547 a child_setup as for MSDOS and other platforms. Note that this
548 code does not handle passing the environment to the synchronous
549 Mac subprocess. */
550 char *infn, *outfn, *errfn, *currdn;
177c0ea7 551
052062e0
RS
552 /* close these files so subprocess can write to them */
553 close (outfilefd);
554 if (fd_error != outfilefd)
555 close (fd_error);
556 fd1 = -1; /* No harm in closing that one! */
557
d5db4077 558 infn = SDATA (infile);
052062e0
RS
559 outfn = tempfile;
560 if (NILP (error_file))
561 errfn = NULL_DEVICE;
562 else if (EQ (Qt, error_file))
563 errfn = outfn;
564 else
d5db4077
KR
565 errfn = SDATA (error_file);
566 currdn = SDATA (current_dir);
052062e0
RS
567 pid = run_mac_command (new_argv, currdn, infn, outfn, errfn);
568
569 /* Record that the synchronous process exited and note its
570 termination status. */
571 synch_process_alive = 0;
572 synch_process_retcode = pid;
573 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
68c45bf0 574 {
ca9c0567 575 synchronize_system_messages_locale ();
68c45bf0
PE
576 synch_process_death = strerror (errno);
577 }
052062e0
RS
578
579 /* Since CRLF is converted to LF within `decode_coding', we can
580 always open a file with binary mode. */
581 fd[0] = open (tempfile, O_BINARY);
582 if (fd[0] < 0)
583 {
584 unlink (tempfile);
585 close (filefd);
586 report_file_error ("Cannot re-open temporary file", Qnil);
587 }
588 }
e0f712ba 589#else /* not MAC_OS8 */
2610078a 590#ifdef MSDOS /* MW, July 1993 */
c17c4250 591 /* Note that on MSDOS `child_setup' actually returns the child process
2610078a
KH
592 exit status, not its PID, so we assign it to `synch_process_retcode'
593 below. */
c17c4250
EZ
594 pid = child_setup (filefd, outfilefd, fd_error, (char **) new_argv,
595 0, current_dir);
39eaa782 596
2610078a
KH
597 /* Record that the synchronous process exited and note its
598 termination status. */
599 synch_process_alive = 0;
600 synch_process_retcode = pid;
601 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
68c45bf0 602 {
ca9c0567 603 synchronize_system_messages_locale ();
68c45bf0
PE
604 synch_process_death = strerror (errno);
605 }
2610078a 606
68c45bf0 607 emacs_close (outfilefd);
2610078a 608 if (fd_error != outfilefd)
68c45bf0 609 emacs_close (fd_error);
2610078a 610 fd1 = -1; /* No harm in closing that one! */
32d08644
KH
611 /* Since CRLF is converted to LF within `decode_coding', we can
612 always open a file with binary mode. */
68c45bf0 613 fd[0] = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
2610078a
KH
614 if (fd[0] < 0)
615 {
616 unlink (tempfile);
68c45bf0 617 emacs_close (filefd);
2610078a
KH
618 report_file_error ("Cannot re-open temporary file", Qnil);
619 }
620#else /* not MSDOS */
bad95d8f 621#ifdef WINDOWSNT
2d607244
RS
622 pid = child_setup (filefd, fd1, fd_error, (char **) new_argv,
623 0, current_dir);
bad95d8f 624#else /* not WINDOWSNT */
aba637ec
KS
625 BLOCK_INPUT;
626
80856e74
JB
627 pid = vfork ();
628
629 if (pid == 0)
630 {
631 if (fd[0] >= 0)
68c45bf0 632 emacs_close (fd[0]);
1e7963c7
RS
633#ifdef HAVE_SETSID
634 setsid ();
635#endif
636#if defined (USG) && !defined (BSD_PGRPS)
80856e74
JB
637 setpgrp ();
638#else
639 setpgrp (pid, pid);
640#endif /* USG */
2d607244
RS
641 child_setup (filefd, fd1, fd_error, (char **) new_argv,
642 0, current_dir);
80856e74 643 }
aba637ec
KS
644
645 UNBLOCK_INPUT;
bad95d8f 646#endif /* not WINDOWSNT */
cd5f8f60
RS
647
648 /* The MSDOS case did this already. */
649 if (fd_error >= 0)
68c45bf0 650 emacs_close (fd_error);
2610078a 651#endif /* not MSDOS */
e0f712ba 652#endif /* not MAC_OS8 */
80856e74 653
80856e74
JB
654 environ = save_environ;
655
6b6e798b
RS
656 /* Close most of our fd's, but not fd[0]
657 since we will use that to read input from. */
68c45bf0 658 emacs_close (filefd);
799abb26 659 if (fd1 >= 0 && fd1 != fd_error)
68c45bf0 660 emacs_close (fd1);
80856e74
JB
661 }
662
663 if (pid < 0)
664 {
6b6e798b 665 if (fd[0] >= 0)
68c45bf0 666 emacs_close (fd[0]);
80856e74
JB
667 report_file_error ("Doing vfork", Qnil);
668 }
669
d50d3dc8 670 if (INTEGERP (buffer))
80856e74 671 {
6b6e798b 672 if (fd[0] >= 0)
68c45bf0 673 emacs_close (fd[0]);
80856e74 674#ifndef subprocesses
e576cab4
JB
675 /* If Emacs has been built with asynchronous subprocess support,
676 we don't need to do this, I think because it will then have
677 the facilities for handling SIGCHLD. */
80856e74
JB
678 wait_without_blocking ();
679#endif /* subprocesses */
80856e74
JB
680 return Qnil;
681 }
682
6b6e798b 683 /* Enable sending signal if user quits below. */
37d54121
RS
684 call_process_exited = 0;
685
e0f712ba 686#if defined(MSDOS) || defined(MAC_OS8)
7e6c2178
RS
687 /* MSDOS needs different cleanup information. */
688 record_unwind_protect (call_process_cleanup,
689 Fcons (make_number (fd[0]), build_string (tempfile)));
690#else
80856e74
JB
691 record_unwind_protect (call_process_cleanup,
692 Fcons (make_number (fd[0]), make_number (pid)));
e0f712ba 693#endif /* not MSDOS and not MAC_OS8 */
80856e74
JB
694
695
d50d3dc8 696 if (BUFFERP (buffer))
80856e74
JB
697 Fset_buffer (buffer);
698
09494912
RS
699 if (NILP (buffer))
700 {
701 /* If BUFFER is nil, we must read process output once and then
702 discard it, so setup coding system but with nil. */
703 setup_coding_system (Qnil, &process_coding);
704 }
705 else
706 {
707 Lisp_Object val, *args2;
708
709 val = Qnil;
710 if (!NILP (Vcoding_system_for_read))
711 val = Vcoding_system_for_read;
712 else
713 {
714 if (EQ (coding_systems, Qt))
715 {
716 int i;
717
718 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
719 args2[0] = Qcall_process;
720 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
721 coding_systems
722 = Ffind_operation_coding_system (nargs + 1, args2);
723 }
724 if (CONSP (coding_systems))
70949dac 725 val = XCAR (coding_systems);
09494912 726 else if (CONSP (Vdefault_process_coding_system))
70949dac 727 val = XCAR (Vdefault_process_coding_system);
09494912
RS
728 else
729 val = Qnil;
730 }
731 setup_coding_system (Fcheck_coding_system (val), &process_coding);
732 /* In unibyte mode, character code conversion should not take
733 place but EOL conversion should. So, setup raw-text or one
734 of the subsidiary according to the information just setup. */
735 if (NILP (current_buffer->enable_multibyte_characters)
736 && !NILP (val))
737 setup_raw_text_coding_system (&process_coding);
738 }
c5bfa12b
KH
739 process_coding.src_multibyte = 0;
740 process_coding.dst_multibyte
741 = (BUFFERP (buffer)
742 ? ! NILP (XBUFFER (buffer)->enable_multibyte_characters)
743 : ! NILP (current_buffer->enable_multibyte_characters));
09494912 744
80856e74
JB
745 immediate_quit = 1;
746 QUIT;
747
748 {
749 register int nread;
0ad477db 750 int first = 1;
6e3bfbb2 751 int total_read = 0;
321fecde 752 int carryover = 0;
0aa2630f 753 int display_on_the_fly = display_p;
05b44e90 754 struct coding_system saved_coding;
f778b157
KH
755 int pt_orig = PT, pt_byte_orig = PT_BYTE;
756 int inserted;
05b44e90
KH
757
758 saved_coding = process_coding;
f0b950cf
KH
759 if (process_coding.composing != COMPOSITION_DISABLED)
760 coding_allocate_composition_data (&process_coding, PT);
60558b19 761 while (1)
80856e74 762 {
60558b19
RS
763 /* Repeatedly read until we've filled as much as possible
764 of the buffer size we have. But don't read
8e6208c5 765 less than 1024--save that for the next bufferful. */
321fecde 766 nread = carryover;
60558b19 767 while (nread < bufsize - 1024)
00fb3e95 768 {
4da256b1 769 int this_read = emacs_read (fd[0], buf + nread,
68c45bf0 770 bufsize - nread);
60558b19
RS
771
772 if (this_read < 0)
773 goto give_up;
774
775 if (this_read == 0)
7a7ab107
KH
776 {
777 process_coding.mode |= CODING_MODE_LAST_BLOCK;
778 break;
779 }
60558b19
RS
780
781 nread += this_read;
7a7ab107 782 total_read += this_read;
60558b19 783
7a7ab107
KH
784 if (display_on_the_fly)
785 break;
786 }
60558b19
RS
787
788 /* Now NREAD is the total amount of data in the buffer. */
80856e74 789 immediate_quit = 0;
177c0ea7 790
012c6fcb 791 if (!NILP (buffer))
32d08644 792 {
c5bfa12b 793 if (! CODING_MAY_REQUIRE_DECODING (&process_coding))
4da256b1 794 insert_1_both (buf, nread, nread, 0, 1, 0);
32d08644
KH
795 else
796 { /* We have to decode the input. */
f0b950cf
KH
797 int size;
798 char *decoding_buf;
32d08644 799
f0b950cf
KH
800 repeat_decoding:
801 size = decoding_buffer_size (&process_coding, nread);
802 decoding_buf = (char *) xmalloc (size);
177c0ea7 803
b252f801
KH
804 /* We can't use the macro CODING_REQUIRE_DETECTION
805 because it always returns nonzero if the coding
806 system requires EOL detection. Here, we have to
807 check only whether or not the coding system
808 requires text-encoding detection. */
809 if (process_coding.type == coding_type_undecided)
950a45d0 810 {
4da256b1 811 detect_coding (&process_coding, buf, nread);
950a45d0 812 if (process_coding.composing != COMPOSITION_DISABLED)
07c381ad
KH
813 /* We have not yet allocated the composition
814 data because the coding type was undecided. */
950a45d0
KH
815 coding_allocate_composition_data (&process_coding, PT);
816 }
2d892150
KH
817 if (process_coding.cmp_data)
818 process_coding.cmp_data->char_offset = PT;
177c0ea7 819
4da256b1 820 decode_coding (&process_coding, buf, decoding_buf,
321fecde 821 nread, size);
177c0ea7 822
7a7ab107
KH
823 if (display_on_the_fly
824 && saved_coding.type == coding_type_undecided
825 && process_coding.type != coding_type_undecided)
826 {
827 /* We have detected some coding system. But,
828 there's a possibility that the detection was
0aa2630f
KS
829 done by insufficient data. So, we try the code
830 detection again with more data. */
a871dd58 831 xfree (decoding_buf);
7a7ab107
KH
832 display_on_the_fly = 0;
833 process_coding = saved_coding;
834 carryover = nread;
0aa2630f
KS
835 /* This is to make the above condition always
836 fails in the future. */
837 saved_coding.type = coding_type_no_conversion;
7a7ab107
KH
838 continue;
839 }
177c0ea7 840
321fecde 841 if (process_coding.produced > 0)
2d892150
KH
842 insert_1_both (decoding_buf, process_coding.produced_char,
843 process_coding.produced, 0, 1, 0);
a871dd58 844 xfree (decoding_buf);
7bdba03c
GM
845
846 if (process_coding.result == CODING_FINISH_INCONSISTENT_EOL)
847 {
848 Lisp_Object eol_type, coding;
849
850 if (process_coding.eol_type == CODING_EOL_CR)
851 {
852 /* CRs have been replaced with LFs. Undo
853 that in the text inserted above. */
854 unsigned char *p;
177c0ea7 855
7bdba03c 856 move_gap_both (PT, PT_BYTE);
177c0ea7 857
7bdba03c
GM
858 p = BYTE_POS_ADDR (pt_byte_orig);
859 for (; p < GPT_ADDR; ++p)
860 if (*p == '\n')
861 *p = '\r';
862 }
863 else if (process_coding.eol_type == CODING_EOL_CRLF)
864 {
865 /* CR LFs have been replaced with LFs. Undo
866 that by inserting CRs in front of LFs in
867 the text inserted above. */
868 EMACS_INT bytepos, old_pt, old_pt_byte, nCR;
869
870 old_pt = PT;
871 old_pt_byte = PT_BYTE;
872 nCR = 0;
177c0ea7 873
7bdba03c
GM
874 for (bytepos = PT_BYTE - 1;
875 bytepos >= pt_byte_orig;
876 --bytepos)
877 if (FETCH_BYTE (bytepos) == '\n')
878 {
879 EMACS_INT charpos = BYTE_TO_CHAR (bytepos);
880 TEMP_SET_PT_BOTH (charpos, bytepos);
881 insert_1_both ("\r", 1, 1, 0, 1, 0);
882 ++nCR;
883 }
884
885 TEMP_SET_PT_BOTH (old_pt + nCR, old_pt_byte + nCR);
886 }
887
888 /* Set the coding system symbol to that for
889 Unix-like EOL. */
890 eol_type = Fget (saved_coding.symbol, Qeol_type);
891 if (VECTORP (eol_type)
892 && ASIZE (eol_type) == 3
893 && SYMBOLP (AREF (eol_type, CODING_EOL_LF)))
894 coding = AREF (eol_type, CODING_EOL_LF);
895 else
896 coding = saved_coding.symbol;
177c0ea7 897
7bdba03c
GM
898 process_coding.symbol = coding;
899 process_coding.eol_type = CODING_EOL_LF;
900 process_coding.mode
901 &= ~CODING_MODE_INHIBIT_INCONSISTENT_EOL;
902 }
177c0ea7 903
f0b950cf
KH
904 nread -= process_coding.consumed;
905 carryover = nread;
321fecde 906 if (carryover > 0)
c5bfa12b
KH
907 /* As CARRYOVER should not be that large, we had
908 better avoid overhead of bcopy. */
4da256b1 909 BCOPY_SHORT (buf + process_coding.consumed, buf,
c5bfa12b 910 carryover);
f0b950cf
KH
911 if (process_coding.result == CODING_FINISH_INSUFFICIENT_CMP)
912 {
913 /* The decoding ended because of insufficient data
914 area to record information about composition.
915 We must try decoding with additional data area
2d892150 916 before reading more output for the process. */
f0b950cf
KH
917 coding_allocate_composition_data (&process_coding, PT);
918 goto repeat_decoding;
919 }
32d08644
KH
920 }
921 }
c5bfa12b 922
321fecde 923 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
c5bfa12b 924 break;
6e3bfbb2 925
4da256b1 926#if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
6e3bfbb2 927 /* Make the buffer bigger as we continue to read more data,
4da256b1
KS
928 but not past CALLPROC_BUFFER_SIZE_MAX. */
929 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
930 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
931 bufsize = CALLPROC_BUFFER_SIZE_MAX;
932#endif
6e3bfbb2 933
0aa2630f 934 if (display_p)
0ad477db
RS
935 {
936 if (first)
937 prepare_menu_bars ();
938 first = 0;
3007ebfb 939 redisplay_preserve_echo_area (1);
0aa2630f
KS
940 /* This variable might have been set to 0 for code
941 detection. In that case, we set it back to 1 because
942 we should have already detected a coding system. */
943 display_on_the_fly = 1;
0ad477db 944 }
80856e74
JB
945 immediate_quit = 1;
946 QUIT;
947 }
60558b19 948 give_up: ;
80856e74 949
2d892150
KH
950 if (!NILP (buffer)
951 && process_coding.cmp_data)
952 {
953 coding_restore_composition (&process_coding, Fcurrent_buffer ());
954 coding_free_composition_data (&process_coding);
955 }
f0b950cf 956
838c9726 957 {
aed13378 958 int post_read_count = SPECPDL_INDEX ();
838c9726
KH
959
960 record_unwind_protect (save_excursion_restore, save_excursion_save ());
961 inserted = PT - pt_orig;
962 TEMP_SET_PT_BOTH (pt_orig, pt_byte_orig);
963 if (SYMBOLP (process_coding.post_read_conversion)
964 && !NILP (Ffboundp (process_coding.post_read_conversion)))
965 call1 (process_coding.post_read_conversion, make_number (inserted));
f778b157 966
838c9726 967 Vlast_coding_system_used = process_coding.symbol;
bbd29cfe 968
838c9726
KH
969 /* If the caller required, let the buffer inherit the
970 coding-system used to decode the process output. */
971 if (inherit_process_coding_system)
972 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
973 make_number (total_read));
974
975 unbind_to (post_read_count, Qnil);
976 }
3b440bb5
EZ
977 }
978
80856e74
JB
979 /* Wait for it to terminate, unless it already has. */
980 wait_for_termination (pid);
981
982 immediate_quit = 0;
983
984 set_buffer_internal (old);
985
37d54121
RS
986 /* Don't kill any children that the subprocess may have left behind
987 when exiting. */
988 call_process_exited = 1;
989
80856e74
JB
990 unbind_to (count, Qnil);
991
ca498128
JD
992 if (synch_process_termsig)
993 {
994 char *signame;
995
996 synchronize_system_messages_locale ();
997 signame = strsignal (synch_process_termsig);
998
999 if (signame == 0)
1000 signame = "unknown";
1001
1002 synch_process_death = signame;
1003 }
1004
80856e74 1005 if (synch_process_death)
68c45bf0
PE
1006 return code_convert_string_norecord (build_string (synch_process_death),
1007 Vlocale_coding_system, 0);
80856e74
JB
1008 return make_number (synch_process_retcode);
1009}
1010#endif
1011\f
9fefd2ba 1012static Lisp_Object
80856e74
JB
1013delete_temp_file (name)
1014 Lisp_Object name;
1015{
2e3dc201 1016 /* Use Fdelete_file (indirectly) because that runs a file name handler.
59750d69 1017 We did that when writing the file, so we should do so when deleting. */
2e3dc201 1018 internal_delete_file (name);
320695d8 1019 return Qnil;
80856e74
JB
1020}
1021
1022DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
fdb82f93
PJ
1023 3, MANY, 0,
1024 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1025The remaining arguments are optional.
1026Delete the text if fourth arg DELETE is non-nil.
1027
1028Insert output in BUFFER before point; t means current buffer;
1029 nil for BUFFER means discard it; 0 means discard and don't wait.
1030BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1031REAL-BUFFER says what to do with standard output, as above,
1032while STDERR-FILE says what to do with standard error in the child.
1033STDERR-FILE may be nil (discard standard error output),
1034t (mix it with ordinary output), or a file name string.
1035
1036Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1037Remaining args are passed to PROGRAM at startup as command args.
1038
ba9a5174 1039If BUFFER is 0, `call-process-region' returns immediately with value nil.
fdb82f93
PJ
1040Otherwise it waits for PROGRAM to terminate
1041and returns a numeric exit status or a signal description string.
d98b59b5
MB
1042If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1043
1044usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
fdb82f93 1045 (nargs, args)
80856e74
JB
1046 int nargs;
1047 register Lisp_Object *args;
1048{
39323a7e
KH
1049 struct gcpro gcpro1;
1050 Lisp_Object filename_string;
1051 register Lisp_Object start, end;
aed13378 1052 int count = SPECPDL_INDEX ();
08ee4e87 1053 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
09494912 1054 Lisp_Object coding_systems;
32d08644
KH
1055 Lisp_Object val, *args2;
1056 int i;
bad95d8f 1057#ifdef DOS_NT
7e6c2178 1058 char *tempfile;
7e6c2178
RS
1059 char *outf = '\0';
1060
8a52365c
EZ
1061 if ((outf = egetenv ("TMPDIR"))
1062 || (outf = egetenv ("TMP"))
1063 || (outf = egetenv ("TEMP")))
7e6c2178
RS
1064 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
1065 else
1066 {
1067 tempfile = alloca (20);
1068 *tempfile = '\0';
1069 }
0774fcf8 1070 if (!IS_DIRECTORY_SEP (tempfile[strlen (tempfile) - 1]))
7e6c2178 1071 strcat (tempfile, "/");
5711b547
RS
1072 if ('/' == DIRECTORY_SEP)
1073 dostounix_filename (tempfile);
1074 else
1075 unixtodos_filename (tempfile);
0774fcf8
RS
1076#ifdef WINDOWSNT
1077 strcat (tempfile, "emXXXXXX");
1078#else
7e6c2178 1079 strcat (tempfile, "detmp.XXX");
0774fcf8 1080#endif
bad95d8f 1081#else /* not DOS_NT */
d5db4077
KR
1082 char *tempfile = (char *) alloca (SBYTES (Vtemp_file_name_pattern) + 1);
1083 bcopy (SDATA (Vtemp_file_name_pattern), tempfile,
1084 SBYTES (Vtemp_file_name_pattern) + 1);
bad95d8f 1085#endif /* not DOS_NT */
7e6c2178 1086
09494912
RS
1087 coding_systems = Qt;
1088
1ddc85a4
DL
1089#ifdef HAVE_MKSTEMP
1090 {
1091 int fd = mkstemp (tempfile);
1092 if (fd == -1)
1093 report_file_error ("Failed to open temporary file",
1094 Fcons (Vtemp_file_name_pattern, Qnil));
1095 else
1096 close (fd);
1097 }
1098#else
80856e74 1099 mktemp (tempfile);
1ddc85a4 1100#endif
80856e74
JB
1101
1102 filename_string = build_string (tempfile);
39323a7e 1103 GCPRO1 (filename_string);
80856e74
JB
1104 start = args[0];
1105 end = args[1];
32d08644 1106 /* Decide coding-system of the contents of the temporary file. */
91489411
RS
1107 if (!NILP (Vcoding_system_for_write))
1108 val = Vcoding_system_for_write;
1109 else if (NILP (current_buffer->enable_multibyte_characters))
32d08644
KH
1110 val = Qnil;
1111 else
beacaab3 1112 {
91489411
RS
1113 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
1114 args2[0] = Qcall_process_region;
1115 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1116 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1117 if (CONSP (coding_systems))
70949dac 1118 val = XCDR (coding_systems);
91489411 1119 else if (CONSP (Vdefault_process_coding_system))
70949dac 1120 val = XCDR (Vdefault_process_coding_system);
beacaab3 1121 else
91489411 1122 val = Qnil;
beacaab3 1123 }
32d08644 1124
168afdaa 1125 {
aed13378 1126 int count1 = SPECPDL_INDEX ();
168afdaa
RS
1127
1128 specbind (intern ("coding-system-for-write"), val);
1129 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1130
1131 unbind_to (count1, Qnil);
1132 }
91489411 1133
177c0ea7 1134 /* Note that Fcall_process takes care of binding
91489411 1135 coding-system-for-read. */
093650fe 1136
80856e74
JB
1137 record_unwind_protect (delete_temp_file, filename_string);
1138
edf496dd 1139 if (nargs > 3 && !NILP (args[3]))
80856e74
JB
1140 Fdelete_region (start, end);
1141
edf496dd
KH
1142 if (nargs > 3)
1143 {
1144 args += 2;
1145 nargs -= 2;
1146 }
1147 else
1148 {
1149 args[0] = args[2];
1150 nargs = 2;
1151 }
1152 args[1] = filename_string;
80856e74 1153
edf496dd 1154 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
80856e74
JB
1155}
1156\f
1157#ifndef VMS /* VMS version is in vmsproc.c. */
1158
dfcf069d
AS
1159static int relocate_fd ();
1160
80856e74
JB
1161/* This is the last thing run in a newly forked inferior
1162 either synchronous or asynchronous.
1163 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1164 Initialize inferior's priority, pgrp, connected dir and environment.
1165 then exec another program based on new_argv.
1166
1167 This function may change environ for the superior process.
1168 Therefore, the superior process must save and restore the value
1169 of environ around the vfork and the call to this function.
1170
80856e74 1171 SET_PGRP is nonzero if we should put the subprocess into a separate
177c0ea7 1172 process group.
e576cab4
JB
1173
1174 CURRENT_DIR is an elisp string giving the path of the current
1175 directory the subprocess should have. Since we can't really signal
1176 a decent error from within the child, this should be verified as an
1177 executable directory by the parent. */
80856e74 1178
dfcf069d 1179int
e576cab4 1180child_setup (in, out, err, new_argv, set_pgrp, current_dir)
80856e74
JB
1181 int in, out, err;
1182 register char **new_argv;
80856e74 1183 int set_pgrp;
e576cab4 1184 Lisp_Object current_dir;
80856e74 1185{
e576cab4 1186 char **env;
7fcf7f05 1187 char *pwd_var;
bad95d8f
RS
1188#ifdef WINDOWSNT
1189 int cpid;
4252a4bd 1190 HANDLE handles[3];
bad95d8f 1191#endif /* WINDOWSNT */
e576cab4 1192
33abe2d9 1193 int pid = getpid ();
80856e74 1194
68d10241 1195#ifdef SET_EMACS_PRIORITY
4f0b9d49 1196 {
31ade731 1197 extern EMACS_INT emacs_priority;
4f0b9d49 1198
68d10241
RS
1199 if (emacs_priority < 0)
1200 nice (- emacs_priority);
4f0b9d49 1201 }
5b633aeb 1202#endif
80856e74
JB
1203
1204#ifdef subprocesses
1205 /* Close Emacs's descriptors that this process should not have. */
1206 close_process_descs ();
1207#endif
c17c4250
EZ
1208 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1209 we will lose if we call close_load_descs here. */
1210#ifndef DOS_NT
4458cebe 1211 close_load_descs ();
c17c4250 1212#endif
80856e74
JB
1213
1214 /* Note that use of alloca is always safe here. It's obvious for systems
1215 that do not have true vfork or that have true (stack) alloca.
1216 If using vfork and C_ALLOCA it is safe because that changes
1217 the superior's static variables as if the superior had done alloca
1218 and will be cleaned up in the usual way. */
e576cab4 1219 {
7fcf7f05 1220 register char *temp;
e576cab4 1221 register int i;
77d78be1 1222
d5db4077 1223 i = SBYTES (current_dir);
16425c4a
EZ
1224#ifdef MSDOS
1225 /* MSDOS must have all environment variables malloc'ed, because
1226 low-level libc functions that launch subsidiary processes rely
1227 on that. */
1228 pwd_var = (char *) xmalloc (i + 6);
1229#else
7fcf7f05 1230 pwd_var = (char *) alloca (i + 6);
16425c4a 1231#endif
7fcf7f05
RS
1232 temp = pwd_var + 4;
1233 bcopy ("PWD=", pwd_var, 4);
d5db4077 1234 bcopy (SDATA (current_dir), temp, i);
bad95d8f 1235 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
e576cab4
JB
1236 temp[i] = 0;
1237
c17c4250 1238#ifndef DOS_NT
e576cab4
JB
1239 /* We can't signal an Elisp error here; we're in a vfork. Since
1240 the callers check the current directory before forking, this
1241 should only return an error if the directory's permissions
1242 are changed between the check and this chdir, but we should
1243 at least check. */
1244 if (chdir (temp) < 0)
20b25e46 1245 _exit (errno);
b4c7684c 1246#endif
7fcf7f05 1247
c17c4250
EZ
1248#ifdef DOS_NT
1249 /* Get past the drive letter, so that d:/ is left alone. */
1250 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1251 {
1252 temp += 2;
1253 i -= 2;
1254 }
1255#endif
1256
7fcf7f05 1257 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
bad95d8f 1258 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
7fcf7f05 1259 temp[--i] = 0;
e576cab4 1260 }
80856e74 1261
80856e74
JB
1262 /* Set `env' to a vector of the strings in Vprocess_environment. */
1263 {
1264 register Lisp_Object tem;
1265 register char **new_env;
1266 register int new_length;
1267
1268 new_length = 0;
1269 for (tem = Vprocess_environment;
70949dac
KR
1270 CONSP (tem) && STRINGP (XCAR (tem));
1271 tem = XCDR (tem))
80856e74
JB
1272 new_length++;
1273
7fcf7f05
RS
1274 /* new_length + 2 to include PWD and terminating 0. */
1275 env = new_env = (char **) alloca ((new_length + 2) * sizeof (char *));
1276
1277 /* If we have a PWD envvar, pass one down,
1278 but with corrected value. */
1279 if (getenv ("PWD"))
1280 *new_env++ = pwd_var;
80856e74 1281
cd9565ba 1282 /* Copy the Vprocess_environment strings into new_env. */
80856e74 1283 for (tem = Vprocess_environment;
70949dac
KR
1284 CONSP (tem) && STRINGP (XCAR (tem));
1285 tem = XCDR (tem))
cd9565ba
RS
1286 {
1287 char **ep = env;
d5db4077 1288 char *string = (char *) SDATA (XCAR (tem));
cd9565ba
RS
1289 /* See if this string duplicates any string already in the env.
1290 If so, don't put it in.
1291 When an env var has multiple definitions,
1292 we keep the definition that comes first in process-environment. */
1293 for (; ep != new_env; ep++)
1294 {
1295 char *p = *ep, *q = string;
1296 while (1)
1297 {
1298 if (*q == 0)
1299 /* The string is malformed; might as well drop it. */
1300 goto duplicate;
1301 if (*q != *p)
1302 break;
1303 if (*q == '=')
1304 goto duplicate;
1305 p++, q++;
1306 }
1307 }
1308 *new_env++ = string;
1309 duplicate: ;
1310 }
80856e74
JB
1311 *new_env = 0;
1312 }
bad95d8f
RS
1313#ifdef WINDOWSNT
1314 prepare_standard_handles (in, out, err, handles);
d5db4077 1315 set_process_dir (SDATA (current_dir));
bad95d8f 1316#else /* not WINDOWSNT */
426b37ae
JB
1317 /* Make sure that in, out, and err are not actually already in
1318 descriptors zero, one, or two; this could happen if Emacs is
7e6c2178 1319 started with its standard in, out, or error closed, as might
426b37ae 1320 happen under X. */
f29f9e4a
RS
1321 {
1322 int oin = in, oout = out;
1323
1324 /* We have to avoid relocating the same descriptor twice! */
1325
1326 in = relocate_fd (in, 3);
1327
1328 if (out == oin)
1329 out = in;
1330 else
3e9367e7 1331 out = relocate_fd (out, 3);
f29f9e4a
RS
1332
1333 if (err == oin)
1334 err = in;
1335 else if (err == oout)
1336 err = out;
1337 else
3e9367e7 1338 err = relocate_fd (err, 3);
f29f9e4a 1339 }
426b37ae 1340
c17c4250 1341#ifndef MSDOS
68c45bf0
PE
1342 emacs_close (0);
1343 emacs_close (1);
1344 emacs_close (2);
80856e74
JB
1345
1346 dup2 (in, 0);
1347 dup2 (out, 1);
1348 dup2 (err, 2);
68c45bf0
PE
1349 emacs_close (in);
1350 emacs_close (out);
1351 emacs_close (err);
c17c4250 1352#endif /* not MSDOS */
bad95d8f 1353#endif /* not WINDOWSNT */
80856e74 1354
6b2cd868 1355#if defined(USG) && !defined(BSD_PGRPS)
fdba8590 1356#ifndef SETPGRP_RELEASES_CTTY
e576cab4 1357 setpgrp (); /* No arguments but equivalent in this case */
fdba8590 1358#endif
e576cab4
JB
1359#else
1360 setpgrp (pid, pid);
1361#endif /* USG */
a129418f
RS
1362 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1363 EMACS_SET_TTY_PGRP (0, &pid);
80856e74 1364
c17c4250
EZ
1365#ifdef MSDOS
1366 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
a3f0666f 1367 xfree (pwd_var);
c17c4250
EZ
1368 if (pid == -1)
1369 /* An error occurred while trying to run the subprocess. */
1370 report_file_error ("Spawning child process", Qnil);
1371 return pid;
1372#else /* not MSDOS */
bad95d8f
RS
1373#ifdef WINDOWSNT
1374 /* Spawn the child. (See ntproc.c:Spawnve). */
1375 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
db77d785 1376 reset_standard_handles (in, out, err, handles);
ff27bfbe
KH
1377 if (cpid == -1)
1378 /* An error occurred while trying to spawn the process. */
1379 report_file_error ("Spawning child process", Qnil);
bad95d8f
RS
1380 return cpid;
1381#else /* not WINDOWSNT */
80856e74
JB
1382 /* execvp does not accept an environment arg so the only way
1383 to pass this environment is to set environ. Our caller
1384 is responsible for restoring the ambient value of environ. */
1385 environ = env;
1386 execvp (new_argv[0], new_argv);
1387
68c45bf0
PE
1388 emacs_write (1, "Can't exec program: ", 20);
1389 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1390 emacs_write (1, "\n", 1);
80856e74 1391 _exit (1);
bad95d8f 1392#endif /* not WINDOWSNT */
7e6c2178 1393#endif /* not MSDOS */
80856e74
JB
1394}
1395
a3833dfe 1396/* Move the file descriptor FD so that its number is not less than MINFD.
426b37ae 1397 If the file descriptor is moved at all, the original is freed. */
dfcf069d 1398static int
a3833dfe
KH
1399relocate_fd (fd, minfd)
1400 int fd, minfd;
426b37ae 1401{
a3833dfe 1402 if (fd >= minfd)
426b37ae
JB
1403 return fd;
1404 else
1405 {
1406 int new = dup (fd);
1407 if (new == -1)
1408 {
20c018a0 1409 char *message1 = "Error while setting up child: ";
826c56ac 1410 char *errmessage = strerror (errno);
20c018a0 1411 char *message2 = "\n";
68c45bf0
PE
1412 emacs_write (2, message1, strlen (message1));
1413 emacs_write (2, errmessage, strlen (errmessage));
1414 emacs_write (2, message2, strlen (message2));
426b37ae
JB
1415 _exit (1);
1416 }
1417 /* Note that we hold the original FD open while we recurse,
1418 to guarantee we'll get a new FD if we need it. */
a3833dfe 1419 new = relocate_fd (new, minfd);
68c45bf0 1420 emacs_close (fd);
426b37ae
JB
1421 return new;
1422 }
1423}
1424
012c6fcb
JA
1425static int
1426getenv_internal (var, varlen, value, valuelen)
1427 char *var;
1428 int varlen;
1429 char **value;
1430 int *valuelen;
1431{
1432 Lisp_Object scan;
1433
70949dac 1434 for (scan = Vprocess_environment; CONSP (scan); scan = XCDR (scan))
012c6fcb 1435 {
c1350752
KH
1436 Lisp_Object entry;
1437
70949dac 1438 entry = XCAR (scan);
d50d3dc8 1439 if (STRINGP (entry)
d5db4077
KR
1440 && SBYTES (entry) > varlen
1441 && SREF (entry, varlen) == '='
bad95d8f
RS
1442#ifdef WINDOWSNT
1443 /* NT environment variables are case insensitive. */
d5db4077 1444 && ! strnicmp (SDATA (entry), var, varlen)
bad95d8f 1445#else /* not WINDOWSNT */
d5db4077 1446 && ! bcmp (SDATA (entry), var, varlen)
bad95d8f 1447#endif /* not WINDOWSNT */
a9971c6d 1448 )
012c6fcb 1449 {
d5db4077
KR
1450 *value = (char *) SDATA (entry) + (varlen + 1);
1451 *valuelen = SBYTES (entry) - (varlen + 1);
012c6fcb
JA
1452 return 1;
1453 }
1454 }
1455
1456 return 0;
1457}
1458
83fa009c 1459DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 1, 0,
fdb82f93
PJ
1460 doc: /* Return the value of environment variable VAR, as a string.
1461VAR should be a string. Value is nil if VAR is undefined in the environment.
1462This function consults the variable ``process-environment'' for its value. */)
1463 (var)
012c6fcb
JA
1464 Lisp_Object var;
1465{
1466 char *value;
1467 int valuelen;
1468
b7826503 1469 CHECK_STRING (var);
d5db4077 1470 if (getenv_internal (SDATA (var), SBYTES (var),
012c6fcb
JA
1471 &value, &valuelen))
1472 return make_string (value, valuelen);
1473 else
1474 return Qnil;
1475}
1476
1477/* A version of getenv that consults process_environment, easily
e576cab4 1478 callable from C. */
012c6fcb
JA
1479char *
1480egetenv (var)
e576cab4 1481 char *var;
012c6fcb
JA
1482{
1483 char *value;
1484 int valuelen;
1485
1486 if (getenv_internal (var, strlen (var), &value, &valuelen))
1487 return value;
1488 else
1489 return 0;
1490}
1491
80856e74
JB
1492#endif /* not VMS */
1493\f
8de15d69 1494/* This is run before init_cmdargs. */
177c0ea7 1495
dfcf069d 1496void
8de15d69
RS
1497init_callproc_1 ()
1498{
1499 char *data_dir = egetenv ("EMACSDATA");
35a2f4b8
KH
1500 char *doc_dir = egetenv ("EMACSDOC");
1501
8de15d69 1502 Vdata_directory
177c0ea7 1503 = Ffile_name_as_directory (build_string (data_dir ? data_dir
8de15d69 1504 : PATH_DATA));
35a2f4b8
KH
1505 Vdoc_directory
1506 = Ffile_name_as_directory (build_string (doc_dir ? doc_dir
1507 : PATH_DOC));
9453ea7b 1508
e576cab4 1509 /* Check the EMACSPATH environment variable, defaulting to the
57bda87a 1510 PATH_EXEC path from epaths.h. */
e576cab4 1511 Vexec_path = decode_env_path ("EMACSPATH", PATH_EXEC);
80856e74
JB
1512 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1513 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
8de15d69
RS
1514}
1515
e17f7533 1516/* This is run after init_cmdargs, when Vinstallation_directory is valid. */
8de15d69 1517
dfcf069d 1518void
8de15d69
RS
1519init_callproc ()
1520{
1521 char *data_dir = egetenv ("EMACSDATA");
177c0ea7 1522
8de15d69
RS
1523 register char * sh;
1524 Lisp_Object tempdir;
1525
9cc4fad5 1526 if (!NILP (Vinstallation_directory))
8de15d69 1527 {
05630743
RS
1528 /* Add to the path the lib-src subdir of the installation dir. */
1529 Lisp_Object tem;
1530 tem = Fexpand_file_name (build_string ("lib-src"),
1531 Vinstallation_directory);
bad95d8f 1532#ifndef DOS_NT
1a6640ec 1533 /* MSDOS uses wrapped binaries, so don't do this. */
0fa248bc 1534 if (NILP (Fmember (tem, Vexec_path)))
70ec1377
RS
1535 {
1536 Vexec_path = decode_env_path ("EMACSPATH", PATH_EXEC);
1537 Vexec_path = Fcons (tem, Vexec_path);
1538 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1539 }
177c0ea7 1540
0fa248bc 1541 Vexec_directory = Ffile_name_as_directory (tem);
bad95d8f 1542#endif /* not DOS_NT */
8de15d69 1543
e17f7533
RS
1544 /* Maybe use ../etc as well as ../lib-src. */
1545 if (data_dir == 0)
1546 {
1547 tem = Fexpand_file_name (build_string ("etc"),
1548 Vinstallation_directory);
1549 Vdoc_directory = Ffile_name_as_directory (tem);
8de15d69
RS
1550 }
1551 }
7e933683
RS
1552
1553 /* Look for the files that should be in etc. We don't use
1554 Vinstallation_directory, because these files are never installed
e17f7533 1555 near the executable, and they are never in the build
7e933683
RS
1556 directory when that's different from the source directory.
1557
1558 Instead, if these files are not in the nominal place, we try the
1559 source directory. */
1560 if (data_dir == 0)
1561 {
70ec1377 1562 Lisp_Object tem, tem1, srcdir;
7e933683 1563
70ec1377
RS
1564 srcdir = Fexpand_file_name (build_string ("../src/"),
1565 build_string (PATH_DUMPLOADSEARCH));
7e933683
RS
1566 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1567 tem1 = Ffile_exists_p (tem);
70ec1377 1568 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
7e933683 1569 {
70ec1377 1570 Lisp_Object newdir;
7e933683
RS
1571 newdir = Fexpand_file_name (build_string ("../etc/"),
1572 build_string (PATH_DUMPLOADSEARCH));
1573 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1574 tem1 = Ffile_exists_p (tem);
1575 if (!NILP (tem1))
1576 Vdata_directory = newdir;
1577 }
1578 }
80856e74 1579
d883eb62
RS
1580#ifndef CANNOT_DUMP
1581 if (initialized)
1582#endif
1583 {
1584 tempdir = Fdirectory_file_name (Vexec_directory);
d5db4077 1585 if (access (SDATA (tempdir), 0) < 0)
d883eb62
RS
1586 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1587 Vexec_directory);
1588 }
80856e74 1589
e576cab4 1590 tempdir = Fdirectory_file_name (Vdata_directory);
d5db4077 1591 if (access (SDATA (tempdir), 0) < 0)
76d5c6cf
RS
1592 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1593 Vdata_directory);
e576cab4 1594
80856e74
JB
1595#ifdef VMS
1596 Vshell_file_name = build_string ("*dcl*");
1597#else
e576cab4 1598 sh = (char *) getenv ("SHELL");
80856e74
JB
1599 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1600#endif
8abd035b
RS
1601
1602#ifdef VMS
1603 Vtemp_file_name_pattern = build_string ("tmp:emacsXXXXXX.");
1604#else
1605 if (getenv ("TMPDIR"))
1606 {
1607 char *dir = getenv ("TMPDIR");
1608 Vtemp_file_name_pattern
1609 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1610 build_string (dir));
1611 }
1612 else
1613 Vtemp_file_name_pattern = build_string ("/tmp/emacsXXXXXX");
1614#endif
63789758 1615
40b49d4b
JB
1616#ifdef DOS_NT
1617 Vshared_game_score_directory = Qnil;
1618#else
63789758
RS
1619 Vshared_game_score_directory = build_string (PATH_GAME);
1620 if (NILP (Ffile_directory_p (Vshared_game_score_directory)))
1621 Vshared_game_score_directory = Qnil;
40b49d4b 1622#endif
9fefd2ba
JB
1623}
1624
dfcf069d 1625void
9fefd2ba
JB
1626set_process_environment ()
1627{
1628 register char **envp;
80856e74 1629
80856e74
JB
1630 Vprocess_environment = Qnil;
1631#ifndef CANNOT_DUMP
1632 if (initialized)
1633#endif
1634 for (envp = environ; *envp; envp++)
1635 Vprocess_environment = Fcons (build_string (*envp),
1636 Vprocess_environment);
80856e74
JB
1637}
1638
dfcf069d 1639void
80856e74
JB
1640syms_of_callproc ()
1641{
bad95d8f 1642#ifdef DOS_NT
093650fe
RS
1643 Qbuffer_file_type = intern ("buffer-file-type");
1644 staticpro (&Qbuffer_file_type);
bad95d8f 1645#endif /* DOS_NT */
7e6c2178 1646
80856e74 1647 DEFVAR_LISP ("shell-file-name", &Vshell_file_name,
fdb82f93
PJ
1648 doc: /* *File name to load inferior shells from.
1649Initialized from the SHELL environment variable. */);
80856e74
JB
1650
1651 DEFVAR_LISP ("exec-path", &Vexec_path,
fdb82f93
PJ
1652 doc: /* *List of directories to search programs to run in subprocesses.
1653Each element is a string (directory name) or nil (try default directory). */);
80856e74 1654
b81a1b72 1655 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes,
fdb82f93
PJ
1656 doc: /* *List of suffixes to try to find executable file names.
1657Each element is a string. */);
33d5af99 1658 Vexec_suffixes = Qnil;
b81a1b72 1659
80856e74 1660 DEFVAR_LISP ("exec-directory", &Vexec_directory,
fdb82f93
PJ
1661 doc: /* Directory for executables for Emacs to invoke.
1662More generally, this includes any architecture-dependent files
1663that are built and installed from the Emacs distribution. */);
e576cab4
JB
1664
1665 DEFVAR_LISP ("data-directory", &Vdata_directory,
fdb82f93
PJ
1666 doc: /* Directory of machine-independent files that come with GNU Emacs.
1667These are files intended for Emacs to use while it runs. */);
80856e74 1668
35a2f4b8 1669 DEFVAR_LISP ("doc-directory", &Vdoc_directory,
fdb82f93
PJ
1670 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1671This is usually the same as data-directory. */);
35a2f4b8 1672
ed61592a 1673 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory,
fdb82f93
PJ
1674 doc: /* For internal use by the build procedure only.
1675This is the name of the directory in which the build procedure installed
1676Emacs's info files; the default value for Info-default-directory-list
1677includes this. */);
ed61592a
JB
1678 Vconfigure_info_directory = build_string (PATH_INFO);
1679
1e7ce61b 1680 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory,
b065672a
CW
1681 doc: /* Directory of score files for games which come with GNU Emacs.
1682If this variable is nil, then Emacs is unable to use a shared directory. */);
40b49d4b
JB
1683#ifdef DOS_NT
1684 Vshared_game_score_directory = Qnil;
1685#else
63789758 1686 Vshared_game_score_directory = build_string (PATH_GAME);
40b49d4b 1687#endif
b065672a 1688
8abd035b 1689 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern,
fdb82f93
PJ
1690 doc: /* Pattern for making names for temporary files.
1691This is used by `call-process-region'. */);
0537ec48 1692 /* This variable is initialized in init_callproc. */
8abd035b 1693
80856e74 1694 DEFVAR_LISP ("process-environment", &Vprocess_environment,
fdb82f93
PJ
1695 doc: /* List of environment variables for subprocesses to inherit.
1696Each element should be a string of the form ENVVARNAME=VALUE.
1697If multiple entries define the same variable, the first one always
1698takes precedence.
1699The environment which Emacs inherits is placed in this variable
776a24a1
DL
1700when Emacs starts.
1701Non-ASCII characters are encoded according to the initial value of
1702`locale-coding-system', i.e. the elements must normally be decoded for use.
1703See `setenv' and `getenv'. */);
80856e74
JB
1704
1705#ifndef VMS
1706 defsubr (&Scall_process);
83fa009c 1707 defsubr (&Sgetenv_internal);
986ffb24 1708#endif
e576cab4 1709 defsubr (&Scall_process_region);
80856e74 1710}
ab5796a9
MB
1711
1712/* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1713 (do not change this comment) */