(Fcall_process): Use setsid to disconnect child
[bpt/emacs.git] / src / callproc.c
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985, 86, 87, 88, 93, 94, 95 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
20
21
22 #include <signal.h>
23 #include <errno.h>
24
25 #include <config.h>
26 #include <stdio.h>
27
28 extern int errno;
29 extern char *strerror ();
30
31 /* Define SIGCHLD as an alias for SIGCLD. */
32
33 #if !defined (SIGCHLD) && defined (SIGCLD)
34 #define SIGCHLD SIGCLD
35 #endif /* SIGCLD */
36
37 #include <sys/types.h>
38
39 #include <sys/file.h>
40 #ifdef USG5
41 #define INCLUDED_FCNTL
42 #include <fcntl.h>
43 #endif
44
45 #ifdef WINDOWSNT
46 #define NOMINMAX
47 #include <windows.h>
48 #include <stdlib.h> /* for proper declaration of environ */
49 #include <fcntl.h>
50 #include "w32.h"
51 #define _P_NOWAIT 1 /* from process.h */
52 #endif
53
54 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
55 #include "msdos.h"
56 #define INCLUDED_FCNTL
57 #include <fcntl.h>
58 #include <sys/stat.h>
59 #include <sys/param.h>
60 #include <errno.h>
61 #endif /* MSDOS */
62
63 #ifndef O_RDONLY
64 #define O_RDONLY 0
65 #endif
66
67 #ifndef O_WRONLY
68 #define O_WRONLY 1
69 #endif
70
71 #include "lisp.h"
72 #include "commands.h"
73 #include "buffer.h"
74 #include "charset.h"
75 #include "coding.h"
76 #include <paths.h>
77 #include "process.h"
78 #include "syssignal.h"
79 #include "systty.h"
80
81 #ifdef VMS
82 extern noshare char **environ;
83 #else
84 extern char **environ;
85 #endif
86
87 #define max(a, b) ((a) > (b) ? (a) : (b))
88
89 #ifdef DOS_NT
90 /* When we are starting external processes we need to know whether they
91 take binary input (no conversion) or text input (\n is converted to
92 \r\n). Similar for output: if newlines are written as \r\n then it's
93 text process output, otherwise it's binary. */
94 Lisp_Object Vbinary_process_input;
95 Lisp_Object Vbinary_process_output;
96 #endif /* DOS_NT */
97
98 Lisp_Object Vexec_path, Vexec_directory, Vdata_directory, Vdoc_directory;
99 Lisp_Object Vconfigure_info_directory;
100 Lisp_Object Vtemp_file_name_pattern;
101
102 Lisp_Object Vshell_file_name;
103
104 Lisp_Object Vprocess_environment;
105
106 #ifdef DOS_NT
107 Lisp_Object Qbuffer_file_type;
108 #endif /* DOS_NT */
109
110 /* True iff we are about to fork off a synchronous process or if we
111 are waiting for it. */
112 int synch_process_alive;
113
114 /* Nonzero => this is a string explaining death of synchronous subprocess. */
115 char *synch_process_death;
116
117 /* If synch_process_death is zero,
118 this is exit code of synchronous subprocess. */
119 int synch_process_retcode;
120
121 extern Lisp_Object Vdoc_file_name;
122 \f
123 /* Clean up when exiting Fcall_process.
124 On MSDOS, delete the temporary file on any kind of termination.
125 On Unix, kill the process and any children on termination by signal. */
126
127 /* Nonzero if this is termination due to exit. */
128 static int call_process_exited;
129
130 #ifndef VMS /* VMS version is in vmsproc.c. */
131
132 static Lisp_Object
133 call_process_kill (fdpid)
134 Lisp_Object fdpid;
135 {
136 close (XFASTINT (Fcar (fdpid)));
137 EMACS_KILLPG (XFASTINT (Fcdr (fdpid)), SIGKILL);
138 synch_process_alive = 0;
139 return Qnil;
140 }
141
142 Lisp_Object
143 call_process_cleanup (fdpid)
144 Lisp_Object fdpid;
145 {
146 #ifdef MSDOS
147 /* for MSDOS fdpid is really (fd . tempfile) */
148 register Lisp_Object file;
149 file = Fcdr (fdpid);
150 close (XFASTINT (Fcar (fdpid)));
151 if (strcmp (XSTRING (file)-> data, NULL_DEVICE) != 0)
152 unlink (XSTRING (file)->data);
153 #else /* not MSDOS */
154 register int pid = XFASTINT (Fcdr (fdpid));
155
156
157 if (call_process_exited)
158 {
159 close (XFASTINT (Fcar (fdpid)));
160 return Qnil;
161 }
162
163 if (EMACS_KILLPG (pid, SIGINT) == 0)
164 {
165 int count = specpdl_ptr - specpdl;
166 record_unwind_protect (call_process_kill, fdpid);
167 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
168 immediate_quit = 1;
169 QUIT;
170 wait_for_termination (pid);
171 immediate_quit = 0;
172 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
173 message1 ("Waiting for process to die...done");
174 }
175 synch_process_alive = 0;
176 close (XFASTINT (Fcar (fdpid)));
177 #endif /* not MSDOS */
178 return Qnil;
179 }
180
181 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
182 "Call PROGRAM synchronously in separate process.\n\
183 The program's input comes from file INFILE (nil means `/dev/null').\n\
184 Insert output in BUFFER before point; t means current buffer;\n\
185 nil for BUFFER means discard it; 0 means discard and don't wait.\n\
186 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,\n\
187 REAL-BUFFER says what to do with standard output, as above,\n\
188 while STDERR-FILE says what to do with standard error in the child.\n\
189 STDERR-FILE may be nil (discard standard error output),\n\
190 t (mix it with ordinary output), or a file name string.\n\
191 \n\
192 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.\n\
193 Remaining arguments are strings passed as command arguments to PROGRAM.\n\
194 \n\
195 If BUFFER is 0, `call-process' returns immediately with value nil.\n\
196 Otherwise it waits for PROGRAM to terminate\n\
197 and returns a numeric exit status or a signal description string.\n\
198 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.")
199 (nargs, args)
200 int nargs;
201 register Lisp_Object *args;
202 {
203 Lisp_Object infile, buffer, current_dir, display, path;
204 int fd[2];
205 int filefd;
206 register int pid;
207 char buf[16384];
208 char *bufptr = buf;
209 int bufsize = 16384;
210 int count = specpdl_ptr - specpdl;
211 register unsigned char **new_argv
212 = (unsigned char **) alloca ((max (2, nargs - 2)) * sizeof (char *));
213 struct buffer *old = current_buffer;
214 /* File to use for stderr in the child.
215 t means use same as standard output. */
216 Lisp_Object error_file;
217 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
218 char *outf, *tempfile;
219 int outfilefd;
220 #endif
221 #if 0
222 int mask;
223 #endif
224 struct coding_system process_coding; /* coding-system of process output */
225 struct coding_system argument_coding; /* coding-system of arguments */
226
227 CHECK_STRING (args[0], 0);
228
229 error_file = Qt;
230
231 #ifndef subprocesses
232 /* Without asynchronous processes we cannot have BUFFER == 0. */
233 if (nargs >= 3 && INTEGERP (args[2]))
234 error ("Operating system cannot handle asynchronous subprocesses");
235 #endif /* subprocesses */
236
237 /* Decide the coding-system for giving arguments and reading process
238 output. */
239 {
240 Lisp_Object val, *args2;
241 /* Qt denotes that we have not yet called Ffind_coding_system. */
242 Lisp_Object coding_systems = Qt;
243 int i;
244
245 /* If arguments are supplied, we may have to encode them. */
246 if (nargs >= 5)
247 {
248 if (NILP (val = Vcoding_system_for_write))
249 {
250 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
251 args2[0] = Qcall_process;
252 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
253 coding_systems = Ffind_coding_system (nargs + 1, args2);
254 if (CONSP (coding_systems))
255 val = XCONS (coding_systems)->cdr;
256 else if (CONSP (Vdefault_process_coding_system))
257 val = XCONS (Vdefault_process_coding_system)->cdr;
258 }
259 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
260 }
261
262 /* If BUFFER is nil, we must read process output once and then
263 discard it, so setup coding system but with nil. If BUFFER is
264 an integer, we can discard it without reading. */
265 if (nargs < 3 || NILP (args[2]))
266 setup_coding_system (Qnil, &process_coding);
267 else if (!INTEGERP (args[2]))
268 {
269 if (NILP (val = Vcoding_system_for_read))
270 {
271 if (!EQ (coding_systems, Qt))
272 {
273 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
274 args2[0] = Qcall_process;
275 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
276 coding_systems = Ffind_coding_system (nargs + 1, args2);
277 }
278 if (CONSP (coding_systems))
279 val = XCONS (coding_systems)->car;
280 else if (CONSP (Vdefault_process_coding_system))
281 val = XCONS (Vdefault_process_coding_system)->car;
282 }
283 setup_coding_system (Fcheck_coding_system (val), &process_coding);
284 }
285 }
286
287 if (nargs >= 2 && ! NILP (args[1]))
288 {
289 infile = Fexpand_file_name (args[1], current_buffer->directory);
290 CHECK_STRING (infile, 1);
291 }
292 else
293 infile = build_string (NULL_DEVICE);
294
295 if (nargs >= 3)
296 {
297 buffer = args[2];
298
299 /* If BUFFER is a list, its meaning is
300 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
301 if (CONSP (buffer))
302 {
303 if (CONSP (XCONS (buffer)->cdr))
304 {
305 Lisp_Object stderr_file;
306 stderr_file = XCONS (XCONS (buffer)->cdr)->car;
307
308 if (NILP (stderr_file) || EQ (Qt, stderr_file))
309 error_file = stderr_file;
310 else
311 error_file = Fexpand_file_name (stderr_file, Qnil);
312 }
313
314 buffer = XCONS (buffer)->car;
315 }
316
317 if (!(EQ (buffer, Qnil)
318 || EQ (buffer, Qt)
319 || XFASTINT (buffer) == 0))
320 {
321 Lisp_Object spec_buffer;
322 spec_buffer = buffer;
323 buffer = Fget_buffer (buffer);
324 /* Mention the buffer name for a better error message. */
325 if (NILP (buffer))
326 CHECK_BUFFER (spec_buffer, 2);
327 CHECK_BUFFER (buffer, 2);
328 }
329 }
330 else
331 buffer = Qnil;
332
333 /* Make sure that the child will be able to chdir to the current
334 buffer's current directory, or its unhandled equivalent. We
335 can't just have the child check for an error when it does the
336 chdir, since it's in a vfork.
337
338 We have to GCPRO around this because Fexpand_file_name,
339 Funhandled_file_name_directory, and Ffile_accessible_directory_p
340 might call a file name handling function. The argument list is
341 protected by the caller, so all we really have to worry about is
342 buffer. */
343 {
344 struct gcpro gcpro1, gcpro2, gcpro3;
345
346 current_dir = current_buffer->directory;
347
348 GCPRO3 (infile, buffer, current_dir);
349
350 current_dir
351 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir),
352 Qnil);
353 if (NILP (Ffile_accessible_directory_p (current_dir)))
354 report_file_error ("Setting current directory",
355 Fcons (current_buffer->directory, Qnil));
356
357 UNGCPRO;
358 }
359
360 display = nargs >= 4 ? args[3] : Qnil;
361
362 filefd = open (XSTRING (infile)->data, O_RDONLY, 0);
363 if (filefd < 0)
364 {
365 report_file_error ("Opening process input file", Fcons (infile, Qnil));
366 }
367 /* Search for program; barf if not found. */
368 {
369 struct gcpro gcpro1;
370
371 GCPRO1 (current_dir);
372 openp (Vexec_path, args[0], EXEC_SUFFIXES, &path, 1);
373 UNGCPRO;
374 }
375 if (NILP (path))
376 {
377 close (filefd);
378 report_file_error ("Searching for program", Fcons (args[0], Qnil));
379 }
380 new_argv[0] = XSTRING (path)->data;
381 {
382 register int i;
383 for (i = 4; i < nargs; i++)
384 {
385 CHECK_STRING (args[i], i);
386 if (argument_coding.type == coding_type_no_conversion)
387 new_argv[i - 3] = XSTRING (args[i])->data;
388 else
389 {
390 /* We must encode the arguments. */
391 int size = encoding_buffer_size (&argument_coding,
392 XSTRING (args[i])->size);
393 int produced, dummy;
394
395 new_argv[i - 3] = (unsigned char *) alloca (size);
396 produced = encode_coding (&argument_coding,
397 XSTRING (args[i])->data, new_argv[i - 3],
398 XSTRING (args[i])->size, size, &dummy);
399 new_argv[i - 3][produced] = 0;
400 }
401 }
402 new_argv[i - 3] = 0;
403 }
404
405 #ifdef MSDOS /* MW, July 1993 */
406 if ((outf = egetenv ("TMP")) || (outf = egetenv ("TEMP")))
407 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
408 else
409 {
410 tempfile = alloca (20);
411 *tempfile = '\0';
412 }
413 dostounix_filename (tempfile);
414 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
415 strcat (tempfile, "/");
416 strcat (tempfile, "detmp.XXX");
417 mktemp (tempfile);
418
419 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
420 if (outfilefd < 0)
421 {
422 close (filefd);
423 report_file_error ("Opening process output file",
424 Fcons (build_string (tempfile), Qnil));
425 }
426 fd[0] = filefd;
427 fd[1] = outfilefd;
428 #endif /* MSDOS */
429
430 if (INTEGERP (buffer))
431 fd[1] = open (NULL_DEVICE, O_WRONLY), fd[0] = -1;
432 else
433 {
434 #ifndef MSDOS
435 pipe (fd);
436 #endif
437 #if 0
438 /* Replaced by close_process_descs */
439 set_exclusive_use (fd[0]);
440 #endif
441 }
442
443 {
444 /* child_setup must clobber environ in systems with true vfork.
445 Protect it from permanent change. */
446 register char **save_environ = environ;
447 register int fd1 = fd[1];
448 int fd_error = fd1;
449
450 #if 0 /* Some systems don't have sigblock. */
451 mask = sigblock (sigmask (SIGCHLD));
452 #endif
453
454 /* Record that we're about to create a synchronous process. */
455 synch_process_alive = 1;
456
457 /* These vars record information from process termination.
458 Clear them now before process can possibly terminate,
459 to avoid timing error if process terminates soon. */
460 synch_process_death = 0;
461 synch_process_retcode = 0;
462
463 if (NILP (error_file))
464 fd_error = open (NULL_DEVICE, O_WRONLY);
465 else if (STRINGP (error_file))
466 {
467 #ifdef DOS_NT
468 fd_error = open (XSTRING (error_file)->data,
469 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
470 S_IREAD | S_IWRITE);
471 #else /* not DOS_NT */
472 fd_error = creat (XSTRING (error_file)->data, 0666);
473 #endif /* not DOS_NT */
474 }
475
476 if (fd_error < 0)
477 {
478 close (filefd);
479 if (fd[0] != filefd)
480 close (fd[0]);
481 if (fd1 >= 0)
482 close (fd1);
483 #ifdef MSDOS
484 unlink (tempfile);
485 #endif
486 report_file_error ("Cannot redirect stderr",
487 Fcons ((NILP (error_file)
488 ? build_string (NULL_DEVICE) : error_file),
489 Qnil));
490 }
491 #ifdef MSDOS /* MW, July 1993 */
492 /* ??? Someone who knows MSDOG needs to check whether this properly
493 closes all descriptors that it opens.
494
495 Note that run_msdos_command() actually returns the child process
496 exit status, not its PID, so we assign it to `synch_process_retcode'
497 below. */
498 pid = run_msdos_command (new_argv, current_dir,
499 filefd, outfilefd, fd_error);
500
501 /* Record that the synchronous process exited and note its
502 termination status. */
503 synch_process_alive = 0;
504 synch_process_retcode = pid;
505 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
506 synch_process_death = strerror(errno);
507
508 close (outfilefd);
509 if (fd_error != outfilefd)
510 close (fd_error);
511 fd1 = -1; /* No harm in closing that one! */
512 /* Since CRLF is converted to LF within `decode_coding', we can
513 always open a file with binary mode. */
514 fd[0] = open (tempfile, O_BINARY);
515 if (fd[0] < 0)
516 {
517 unlink (tempfile);
518 close (filefd);
519 report_file_error ("Cannot re-open temporary file", Qnil);
520 }
521 #else /* not MSDOS */
522 #ifdef WINDOWSNT
523 pid = child_setup (filefd, fd1, fd_error, new_argv, 0, current_dir);
524 #else /* not WINDOWSNT */
525 pid = vfork ();
526
527 if (pid == 0)
528 {
529 if (fd[0] >= 0)
530 close (fd[0]);
531 #ifdef HAVE_SETSID
532 setsid ();
533 #endif
534 #if defined (USG) && !defined (BSD_PGRPS)
535 setpgrp ();
536 #else
537 setpgrp (pid, pid);
538 #endif /* USG */
539 child_setup (filefd, fd1, fd_error, new_argv, 0, current_dir);
540 }
541 #endif /* not WINDOWSNT */
542
543 /* The MSDOS case did this already. */
544 if (fd_error >= 0)
545 close (fd_error);
546 #endif /* not MSDOS */
547
548 environ = save_environ;
549
550 /* Close most of our fd's, but not fd[0]
551 since we will use that to read input from. */
552 close (filefd);
553 if (fd1 >= 0 && fd1 != fd_error)
554 close (fd1);
555 }
556
557 if (pid < 0)
558 {
559 if (fd[0] >= 0)
560 close (fd[0]);
561 report_file_error ("Doing vfork", Qnil);
562 }
563
564 if (INTEGERP (buffer))
565 {
566 if (fd[0] >= 0)
567 close (fd[0]);
568 #ifndef subprocesses
569 /* If Emacs has been built with asynchronous subprocess support,
570 we don't need to do this, I think because it will then have
571 the facilities for handling SIGCHLD. */
572 wait_without_blocking ();
573 #endif /* subprocesses */
574 return Qnil;
575 }
576
577 /* Enable sending signal if user quits below. */
578 call_process_exited = 0;
579
580 #ifdef MSDOS
581 /* MSDOS needs different cleanup information. */
582 record_unwind_protect (call_process_cleanup,
583 Fcons (make_number (fd[0]), build_string (tempfile)));
584 #else
585 record_unwind_protect (call_process_cleanup,
586 Fcons (make_number (fd[0]), make_number (pid)));
587 #endif /* not MSDOS */
588
589
590 if (BUFFERP (buffer))
591 Fset_buffer (buffer);
592
593 immediate_quit = 1;
594 QUIT;
595
596 {
597 register int nread;
598 int first = 1;
599 int total_read = 0;
600
601 while (1)
602 {
603 /* Repeatedly read until we've filled as much as possible
604 of the buffer size we have. But don't read
605 less than 1024--save that for the next bufferful. */
606
607 nread = process_coding.carryover_size; /* This value is initially 0. */
608 while (nread < bufsize - 1024)
609 {
610 int this_read
611 = read (fd[0], bufptr + nread, bufsize - nread);
612
613 if (this_read < 0)
614 goto give_up;
615
616 if (this_read == 0)
617 goto give_up_1;
618
619 nread += this_read;
620 }
621
622 give_up_1:
623
624 /* Now NREAD is the total amount of data in the buffer. */
625 if (nread == 0)
626 /* Here, just tell decode_coding that we are processing the
627 last block. We break the loop after decoding. */
628 process_coding.last_block = 1;
629
630 immediate_quit = 0;
631 total_read += nread;
632
633 if (!NILP (buffer))
634 {
635 if (process_coding.type == coding_type_no_conversion)
636 insert (bufptr, nread);
637 else
638 { /* We have to decode the input. */
639 int size = decoding_buffer_size (&process_coding, bufsize);
640 char *decoding_buf = get_conversion_buffer (size);
641 int dummy;
642
643 nread = decode_coding (&process_coding, bufptr, decoding_buf,
644 nread, size, &dummy);
645 if (nread > 0)
646 insert (decoding_buf, nread);
647 }
648 }
649
650 if (process_coding.last_block)
651 break;
652
653 /* Make the buffer bigger as we continue to read more data,
654 but not past 64k. */
655 if (bufsize < 64 * 1024 && total_read > 32 * bufsize)
656 {
657 bufsize *= 2;
658 bufptr = (char *) alloca (bufsize);
659 }
660
661 if (!NILP (buffer) && process_coding.carryover_size > 0)
662 /* We have carryover in the last decoding. It should be
663 processed again after reading more data. */
664 bcopy (process_coding.carryover, bufptr,
665 process_coding.carryover_size);
666
667 if (!NILP (display) && INTERACTIVE)
668 {
669 if (first)
670 prepare_menu_bars ();
671 first = 0;
672 redisplay_preserve_echo_area ();
673 }
674 immediate_quit = 1;
675 QUIT;
676 }
677 give_up: ;
678 }
679
680 /* Wait for it to terminate, unless it already has. */
681 wait_for_termination (pid);
682
683 immediate_quit = 0;
684
685 set_buffer_internal (old);
686
687 /* Don't kill any children that the subprocess may have left behind
688 when exiting. */
689 call_process_exited = 1;
690
691 unbind_to (count, Qnil);
692
693 if (synch_process_death)
694 return build_string (synch_process_death);
695 return make_number (synch_process_retcode);
696 }
697 #endif
698 \f
699 static Lisp_Object
700 delete_temp_file (name)
701 Lisp_Object name;
702 {
703 /* Use Fdelete_file (indirectly) because that runs a file name handler.
704 We did that when writing the file, so we should do so when deleting. */
705 internal_delete_file (name);
706 }
707
708 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
709 3, MANY, 0,
710 "Send text from START to END to a synchronous process running PROGRAM.\n\
711 Delete the text if fourth arg DELETE is non-nil.\n\
712 \n\
713 Insert output in BUFFER before point; t means current buffer;\n\
714 nil for BUFFER means discard it; 0 means discard and don't wait.\n\
715 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,\n\
716 REAL-BUFFER says what to do with standard output, as above,\n\
717 while STDERR-FILE says what to do with standard error in the child.\n\
718 STDERR-FILE may be nil (discard standard error output),\n\
719 t (mix it with ordinary output), or a file name string.\n\
720 \n\
721 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.\n\
722 Remaining args are passed to PROGRAM at startup as command args.\n\
723 \n\
724 If BUFFER is nil, `call-process-region' returns immediately with value nil.\n\
725 Otherwise it waits for PROGRAM to terminate\n\
726 and returns a numeric exit status or a signal description string.\n\
727 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.")
728 (nargs, args)
729 int nargs;
730 register Lisp_Object *args;
731 {
732 struct gcpro gcpro1;
733 Lisp_Object filename_string;
734 register Lisp_Object start, end;
735 int count = specpdl_ptr - specpdl;
736 /* Qt denotes that we have not yet called Ffind_coding_system. */
737 Lisp_Object coding_systems = Qt;
738 Lisp_Object val, *args2;
739 int i;
740 #ifdef DOS_NT
741 char *tempfile;
742 char *outf = '\0';
743
744 if ((outf = egetenv ("TMP")) || (outf = egetenv ("TEMP")))
745 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
746 else
747 {
748 tempfile = alloca (20);
749 *tempfile = '\0';
750 }
751 if (!IS_DIRECTORY_SEP (tempfile[strlen (tempfile) - 1]))
752 strcat (tempfile, "/");
753 if ('/' == DIRECTORY_SEP)
754 dostounix_filename (tempfile);
755 else
756 unixtodos_filename (tempfile);
757 #ifdef WINDOWSNT
758 strcat (tempfile, "emXXXXXX");
759 #else
760 strcat (tempfile, "detmp.XXX");
761 #endif
762 #else /* not DOS_NT */
763 char *tempfile = (char *) alloca (XSTRING (Vtemp_file_name_pattern)->size + 1);
764 bcopy (XSTRING (Vtemp_file_name_pattern)->data, tempfile,
765 XSTRING (Vtemp_file_name_pattern)->size + 1);
766 #endif /* not DOS_NT */
767
768 mktemp (tempfile);
769
770 filename_string = build_string (tempfile);
771 GCPRO1 (filename_string);
772 start = args[0];
773 end = args[1];
774 /* Decide coding-system of the contents of the temporary file. */
775 #ifdef DOS_NT
776 specbind (Qbuffer_file_type, Vbinary_process_input);
777 if (NILP (Vbinary_process_input))
778 val = Qnil;
779 else
780 #endif
781 if (NILP (val = Vcoding_system_for_write))
782 {
783 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
784 args2[0] = Qcall_process_region;
785 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
786 coding_systems = Ffind_coding_system (nargs + 1, args2);
787 if (CONSP (coding_systems))
788 val = XCONS (coding_systems)->cdr;
789 else if (CONSP (Vdefault_process_coding_system))
790 val = XCONS (Vdefault_process_coding_system)->car;
791 }
792 specbind (intern ("coding-system-for-write"), val);
793 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil);
794
795 #ifdef DOS_NT
796 if (NILP (Vbinary_process_input))
797 val = Qnil;
798 else
799 #endif
800 if (NILP (val = Vcoding_system_for_read))
801 {
802 if (EQ (coding_systems, Qt))
803 {
804 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
805 args2[0] = Qcall_process_region;
806 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
807 coding_systems = Ffind_coding_system (nargs + 1, args2);
808 }
809 val = CONSP (coding_systems) ? XCONS (coding_systems)->car : Qnil;
810 }
811 specbind (intern ("coding-system-for-read"), val);
812
813 record_unwind_protect (delete_temp_file, filename_string);
814
815 if (!NILP (args[3]))
816 Fdelete_region (start, end);
817
818 args[3] = filename_string;
819
820 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs - 2, args + 2)));
821 }
822 \f
823 #ifndef VMS /* VMS version is in vmsproc.c. */
824
825 /* This is the last thing run in a newly forked inferior
826 either synchronous or asynchronous.
827 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
828 Initialize inferior's priority, pgrp, connected dir and environment.
829 then exec another program based on new_argv.
830
831 This function may change environ for the superior process.
832 Therefore, the superior process must save and restore the value
833 of environ around the vfork and the call to this function.
834
835 ENV is the environment for the subprocess.
836
837 SET_PGRP is nonzero if we should put the subprocess into a separate
838 process group.
839
840 CURRENT_DIR is an elisp string giving the path of the current
841 directory the subprocess should have. Since we can't really signal
842 a decent error from within the child, this should be verified as an
843 executable directory by the parent. */
844
845 child_setup (in, out, err, new_argv, set_pgrp, current_dir)
846 int in, out, err;
847 register char **new_argv;
848 int set_pgrp;
849 Lisp_Object current_dir;
850 {
851 #ifdef MSDOS
852 /* The MSDOS port of gcc cannot fork, vfork, ... so we must call system
853 instead. */
854 #else /* not MSDOS */
855 char **env;
856 char *pwd_var;
857 #ifdef WINDOWSNT
858 int cpid;
859 HANDLE handles[3];
860 #endif /* WINDOWSNT */
861
862 int pid = getpid ();
863
864 #ifdef SET_EMACS_PRIORITY
865 {
866 extern int emacs_priority;
867
868 if (emacs_priority < 0)
869 nice (- emacs_priority);
870 }
871 #endif
872
873 #ifdef subprocesses
874 /* Close Emacs's descriptors that this process should not have. */
875 close_process_descs ();
876 #endif
877 close_load_descs ();
878
879 /* Note that use of alloca is always safe here. It's obvious for systems
880 that do not have true vfork or that have true (stack) alloca.
881 If using vfork and C_ALLOCA it is safe because that changes
882 the superior's static variables as if the superior had done alloca
883 and will be cleaned up in the usual way. */
884 {
885 register char *temp;
886 register int i;
887
888 i = XSTRING (current_dir)->size;
889 pwd_var = (char *) alloca (i + 6);
890 temp = pwd_var + 4;
891 bcopy ("PWD=", pwd_var, 4);
892 bcopy (XSTRING (current_dir)->data, temp, i);
893 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
894 temp[i] = 0;
895
896 /* We can't signal an Elisp error here; we're in a vfork. Since
897 the callers check the current directory before forking, this
898 should only return an error if the directory's permissions
899 are changed between the check and this chdir, but we should
900 at least check. */
901 if (chdir (temp) < 0)
902 _exit (errno);
903
904 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
905 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
906 temp[--i] = 0;
907 }
908
909 /* Set `env' to a vector of the strings in Vprocess_environment. */
910 {
911 register Lisp_Object tem;
912 register char **new_env;
913 register int new_length;
914
915 new_length = 0;
916 for (tem = Vprocess_environment;
917 CONSP (tem) && STRINGP (XCONS (tem)->car);
918 tem = XCONS (tem)->cdr)
919 new_length++;
920
921 /* new_length + 2 to include PWD and terminating 0. */
922 env = new_env = (char **) alloca ((new_length + 2) * sizeof (char *));
923
924 /* If we have a PWD envvar, pass one down,
925 but with corrected value. */
926 if (getenv ("PWD"))
927 *new_env++ = pwd_var;
928
929 /* Copy the Vprocess_environment strings into new_env. */
930 for (tem = Vprocess_environment;
931 CONSP (tem) && STRINGP (XCONS (tem)->car);
932 tem = XCONS (tem)->cdr)
933 {
934 char **ep = env;
935 char *string = (char *) XSTRING (XCONS (tem)->car)->data;
936 /* See if this string duplicates any string already in the env.
937 If so, don't put it in.
938 When an env var has multiple definitions,
939 we keep the definition that comes first in process-environment. */
940 for (; ep != new_env; ep++)
941 {
942 char *p = *ep, *q = string;
943 while (1)
944 {
945 if (*q == 0)
946 /* The string is malformed; might as well drop it. */
947 goto duplicate;
948 if (*q != *p)
949 break;
950 if (*q == '=')
951 goto duplicate;
952 p++, q++;
953 }
954 }
955 *new_env++ = string;
956 duplicate: ;
957 }
958 *new_env = 0;
959 }
960 #ifdef WINDOWSNT
961 prepare_standard_handles (in, out, err, handles);
962 #else /* not WINDOWSNT */
963 /* Make sure that in, out, and err are not actually already in
964 descriptors zero, one, or two; this could happen if Emacs is
965 started with its standard in, out, or error closed, as might
966 happen under X. */
967 {
968 int oin = in, oout = out;
969
970 /* We have to avoid relocating the same descriptor twice! */
971
972 in = relocate_fd (in, 3);
973
974 if (out == oin)
975 out = in;
976 else
977 out = relocate_fd (out, 3);
978
979 if (err == oin)
980 err = in;
981 else if (err == oout)
982 err = out;
983 else
984 err = relocate_fd (err, 3);
985 }
986
987 close (0);
988 close (1);
989 close (2);
990
991 dup2 (in, 0);
992 dup2 (out, 1);
993 dup2 (err, 2);
994 close (in);
995 close (out);
996 close (err);
997 #endif /* not WINDOWSNT */
998
999 #if defined(USG) && !defined(BSD_PGRPS)
1000 #ifndef SETPGRP_RELEASES_CTTY
1001 setpgrp (); /* No arguments but equivalent in this case */
1002 #endif
1003 #else
1004 setpgrp (pid, pid);
1005 #endif /* USG */
1006 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1007 EMACS_SET_TTY_PGRP (0, &pid);
1008
1009 #ifdef vipc
1010 something missing here;
1011 #endif /* vipc */
1012
1013 #ifdef WINDOWSNT
1014 /* Spawn the child. (See ntproc.c:Spawnve). */
1015 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1016 if (cpid == -1)
1017 /* An error occurred while trying to spawn the process. */
1018 report_file_error ("Spawning child process", Qnil);
1019 reset_standard_handles (in, out, err, handles);
1020 return cpid;
1021 #else /* not WINDOWSNT */
1022 /* execvp does not accept an environment arg so the only way
1023 to pass this environment is to set environ. Our caller
1024 is responsible for restoring the ambient value of environ. */
1025 environ = env;
1026 execvp (new_argv[0], new_argv);
1027
1028 write (1, "Can't exec program: ", 20);
1029 write (1, new_argv[0], strlen (new_argv[0]));
1030 write (1, "\n", 1);
1031 _exit (1);
1032 #endif /* not WINDOWSNT */
1033 #endif /* not MSDOS */
1034 }
1035
1036 /* Move the file descriptor FD so that its number is not less than MIN.
1037 If the file descriptor is moved at all, the original is freed. */
1038 int
1039 relocate_fd (fd, min)
1040 int fd, min;
1041 {
1042 if (fd >= min)
1043 return fd;
1044 else
1045 {
1046 int new = dup (fd);
1047 if (new == -1)
1048 {
1049 char *message1 = "Error while setting up child: ";
1050 char *errmessage = strerror (errno);
1051 char *message2 = "\n";
1052 write (2, message1, strlen (message1));
1053 write (2, errmessage, strlen (errmessage));
1054 write (2, message2, strlen (message2));
1055 _exit (1);
1056 }
1057 /* Note that we hold the original FD open while we recurse,
1058 to guarantee we'll get a new FD if we need it. */
1059 new = relocate_fd (new, min);
1060 close (fd);
1061 return new;
1062 }
1063 }
1064
1065 static int
1066 getenv_internal (var, varlen, value, valuelen)
1067 char *var;
1068 int varlen;
1069 char **value;
1070 int *valuelen;
1071 {
1072 Lisp_Object scan;
1073
1074 for (scan = Vprocess_environment; CONSP (scan); scan = XCONS (scan)->cdr)
1075 {
1076 Lisp_Object entry;
1077
1078 entry = XCONS (scan)->car;
1079 if (STRINGP (entry)
1080 && XSTRING (entry)->size > varlen
1081 && XSTRING (entry)->data[varlen] == '='
1082 #ifdef WINDOWSNT
1083 /* NT environment variables are case insensitive. */
1084 && ! strnicmp (XSTRING (entry)->data, var, varlen)
1085 #else /* not WINDOWSNT */
1086 && ! bcmp (XSTRING (entry)->data, var, varlen)
1087 #endif /* not WINDOWSNT */
1088 )
1089 {
1090 *value = (char *) XSTRING (entry)->data + (varlen + 1);
1091 *valuelen = XSTRING (entry)->size - (varlen + 1);
1092 return 1;
1093 }
1094 }
1095
1096 return 0;
1097 }
1098
1099 DEFUN ("getenv", Fgetenv, Sgetenv, 1, 1, 0,
1100 "Return the value of environment variable VAR, as a string.\n\
1101 VAR should be a string. Value is nil if VAR is undefined in the environment.\n\
1102 This function consults the variable ``process-environment'' for its value.")
1103 (var)
1104 Lisp_Object var;
1105 {
1106 char *value;
1107 int valuelen;
1108
1109 CHECK_STRING (var, 0);
1110 if (getenv_internal (XSTRING (var)->data, XSTRING (var)->size,
1111 &value, &valuelen))
1112 return make_string (value, valuelen);
1113 else
1114 return Qnil;
1115 }
1116
1117 /* A version of getenv that consults process_environment, easily
1118 callable from C. */
1119 char *
1120 egetenv (var)
1121 char *var;
1122 {
1123 char *value;
1124 int valuelen;
1125
1126 if (getenv_internal (var, strlen (var), &value, &valuelen))
1127 return value;
1128 else
1129 return 0;
1130 }
1131
1132 #endif /* not VMS */
1133 \f
1134 /* This is run before init_cmdargs. */
1135
1136 init_callproc_1 ()
1137 {
1138 char *data_dir = egetenv ("EMACSDATA");
1139 char *doc_dir = egetenv ("EMACSDOC");
1140
1141 Vdata_directory
1142 = Ffile_name_as_directory (build_string (data_dir ? data_dir
1143 : PATH_DATA));
1144 Vdoc_directory
1145 = Ffile_name_as_directory (build_string (doc_dir ? doc_dir
1146 : PATH_DOC));
1147
1148 /* Check the EMACSPATH environment variable, defaulting to the
1149 PATH_EXEC path from paths.h. */
1150 Vexec_path = decode_env_path ("EMACSPATH", PATH_EXEC);
1151 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1152 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1153 }
1154
1155 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1156
1157 init_callproc ()
1158 {
1159 char *data_dir = egetenv ("EMACSDATA");
1160
1161 register char * sh;
1162 Lisp_Object tempdir;
1163
1164 if (initialized && !NILP (Vinstallation_directory))
1165 {
1166 /* Add to the path the lib-src subdir of the installation dir. */
1167 Lisp_Object tem;
1168 tem = Fexpand_file_name (build_string ("lib-src"),
1169 Vinstallation_directory);
1170 if (NILP (Fmember (tem, Vexec_path)))
1171 {
1172 #ifndef DOS_NT
1173 /* MSDOS uses wrapped binaries, so don't do this. */
1174 Vexec_path = nconc2 (Vexec_path, Fcons (tem, Qnil));
1175 Vexec_directory = Ffile_name_as_directory (tem);
1176 #endif /* not DOS_NT */
1177 }
1178
1179 /* Maybe use ../etc as well as ../lib-src. */
1180 if (data_dir == 0)
1181 {
1182 tem = Fexpand_file_name (build_string ("etc"),
1183 Vinstallation_directory);
1184 Vdoc_directory = Ffile_name_as_directory (tem);
1185 }
1186 }
1187
1188 /* Look for the files that should be in etc. We don't use
1189 Vinstallation_directory, because these files are never installed
1190 near the executable, and they are never in the build
1191 directory when that's different from the source directory.
1192
1193 Instead, if these files are not in the nominal place, we try the
1194 source directory. */
1195 if (data_dir == 0)
1196 {
1197 Lisp_Object tem, tem1, newdir;
1198
1199 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1200 tem1 = Ffile_exists_p (tem);
1201 if (NILP (tem1))
1202 {
1203 newdir = Fexpand_file_name (build_string ("../etc/"),
1204 build_string (PATH_DUMPLOADSEARCH));
1205 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1206 tem1 = Ffile_exists_p (tem);
1207 if (!NILP (tem1))
1208 Vdata_directory = newdir;
1209 }
1210 }
1211
1212 tempdir = Fdirectory_file_name (Vexec_directory);
1213 if (access (XSTRING (tempdir)->data, 0) < 0)
1214 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1215 Vexec_directory);
1216
1217 tempdir = Fdirectory_file_name (Vdata_directory);
1218 if (access (XSTRING (tempdir)->data, 0) < 0)
1219 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1220 Vdata_directory);
1221
1222 #ifdef VMS
1223 Vshell_file_name = build_string ("*dcl*");
1224 #else
1225 sh = (char *) getenv ("SHELL");
1226 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1227 #endif
1228
1229 #ifdef VMS
1230 Vtemp_file_name_pattern = build_string ("tmp:emacsXXXXXX.");
1231 #else
1232 if (getenv ("TMPDIR"))
1233 {
1234 char *dir = getenv ("TMPDIR");
1235 Vtemp_file_name_pattern
1236 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1237 build_string (dir));
1238 }
1239 else
1240 Vtemp_file_name_pattern = build_string ("/tmp/emacsXXXXXX");
1241 #endif
1242 }
1243
1244 set_process_environment ()
1245 {
1246 register char **envp;
1247
1248 Vprocess_environment = Qnil;
1249 #ifndef CANNOT_DUMP
1250 if (initialized)
1251 #endif
1252 for (envp = environ; *envp; envp++)
1253 Vprocess_environment = Fcons (build_string (*envp),
1254 Vprocess_environment);
1255 }
1256
1257 syms_of_callproc ()
1258 {
1259 #ifdef DOS_NT
1260 Qbuffer_file_type = intern ("buffer-file-type");
1261 staticpro (&Qbuffer_file_type);
1262
1263 DEFVAR_LISP ("binary-process-input", &Vbinary_process_input,
1264 "*If non-nil then new subprocesses are assumed to take binary input.");
1265 Vbinary_process_input = Qnil;
1266
1267 DEFVAR_LISP ("binary-process-output", &Vbinary_process_output,
1268 "*If non-nil then new subprocesses are assumed to produce binary output.");
1269 Vbinary_process_output = Qnil;
1270 #endif /* DOS_NT */
1271
1272 DEFVAR_LISP ("shell-file-name", &Vshell_file_name,
1273 "*File name to load inferior shells from.\n\
1274 Initialized from the SHELL environment variable.");
1275
1276 DEFVAR_LISP ("exec-path", &Vexec_path,
1277 "*List of directories to search programs to run in subprocesses.\n\
1278 Each element is a string (directory name) or nil (try default directory).");
1279
1280 DEFVAR_LISP ("exec-directory", &Vexec_directory,
1281 "Directory of architecture-dependent files that come with GNU Emacs,\n\
1282 especially executable programs intended for Emacs to invoke.");
1283
1284 DEFVAR_LISP ("data-directory", &Vdata_directory,
1285 "Directory of architecture-independent files that come with GNU Emacs,\n\
1286 intended for Emacs to use.");
1287
1288 DEFVAR_LISP ("doc-directory", &Vdoc_directory,
1289 "Directory containing the DOC file that comes with GNU Emacs.\n\
1290 This is usually the same as data-directory.");
1291
1292 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory,
1293 "For internal use by the build procedure only.\n\
1294 This is the name of the directory in which the build procedure installed\n\
1295 Emacs's info files; the default value for Info-default-directory-list\n\
1296 includes this.");
1297 Vconfigure_info_directory = build_string (PATH_INFO);
1298
1299 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern,
1300 "Pattern for making names for temporary files.\n\
1301 This is used by `call-process-region'.");
1302 /* The real initialization is when we start again. */
1303 Vtemp_file_name_pattern = Qnil;
1304
1305 DEFVAR_LISP ("process-environment", &Vprocess_environment,
1306 "List of environment variables for subprocesses to inherit.\n\
1307 Each element should be a string of the form ENVVARNAME=VALUE.\n\
1308 The environment which Emacs inherits is placed in this variable\n\
1309 when Emacs starts.");
1310
1311 #ifndef VMS
1312 defsubr (&Scall_process);
1313 defsubr (&Sgetenv);
1314 #endif
1315 defsubr (&Scall_process_region);
1316 }