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