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