1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2011
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
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 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
26 #include <sys/types.h>
36 #define _P_NOWAIT 1 /* from process.h */
39 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
41 #include <sys/param.h>
47 #include "character.h"
50 #include "composite.h"
53 #include "syssignal.h"
55 #include "blockinput.h"
57 #include "termhooks.h"
64 extern char **environ
;
70 #define setpgrp setpgid
74 /* Pattern used by call-process-region to make temp files. */
75 static Lisp_Object Vtemp_file_name_pattern
;
77 /* True if we are about to fork off a synchronous process or if we
78 are waiting for it. */
79 int synch_process_alive
;
81 /* Nonzero => this is a string explaining death of synchronous subprocess. */
82 const char *synch_process_death
;
84 /* Nonzero => this is the signal number that terminated the subprocess. */
85 int synch_process_termsig
;
87 /* If synch_process_death is zero,
88 this is exit code of synchronous subprocess. */
89 int synch_process_retcode
;
92 /* Clean up when exiting Fcall_process.
93 On MSDOS, delete the temporary file on any kind of termination.
94 On Unix, kill the process and any children on termination by signal. */
96 /* Nonzero if this is termination due to exit. */
97 static int call_process_exited
;
99 EXFUN (Fgetenv_internal
, 2);
102 call_process_kill (Lisp_Object fdpid
)
104 emacs_close (XFASTINT (Fcar (fdpid
)));
105 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
106 synch_process_alive
= 0;
111 call_process_cleanup (Lisp_Object arg
)
113 Lisp_Object fdpid
= Fcdr (arg
);
120 Fset_buffer (Fcar (arg
));
123 /* for MSDOS fdpid is really (fd . tempfile) */
125 emacs_close (XFASTINT (Fcar (fdpid
)));
126 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
127 unlink (SDATA (file
));
128 #else /* not MSDOS */
129 pid
= XFASTINT (Fcdr (fdpid
));
131 if (call_process_exited
)
133 emacs_close (XFASTINT (Fcar (fdpid
)));
137 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
139 int count
= SPECPDL_INDEX ();
140 record_unwind_protect (call_process_kill
, fdpid
);
141 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
144 wait_for_termination (pid
);
146 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
147 message1 ("Waiting for process to die...done");
149 synch_process_alive
= 0;
150 emacs_close (XFASTINT (Fcar (fdpid
)));
151 #endif /* not MSDOS */
155 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
156 doc
: /* Call PROGRAM synchronously in separate process.
157 The remaining arguments are optional.
158 The program's input comes from file INFILE (nil means `/dev/null').
159 Insert output in BUFFER before point; t means current buffer;
160 nil for BUFFER means discard it; 0 means discard and don't wait.
161 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
162 REAL-BUFFER says what to do with standard output, as above,
163 while STDERR-FILE says what to do with standard error in the child.
164 STDERR-FILE may be nil (discard standard error output),
165 t (mix it with ordinary output), or a file name string.
167 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
168 Remaining arguments are strings passed as command arguments to PROGRAM.
170 If executable PROGRAM can't be found as an executable, `call-process'
171 signals a Lisp error. `call-process' reports errors in execution of
172 the program only through its return and output.
174 If BUFFER is 0, `call-process' returns immediately with value nil.
175 Otherwise it waits for PROGRAM to terminate
176 and returns a numeric exit status or a signal description string.
177 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
179 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
180 (size_t nargs
, register Lisp_Object
*args
)
182 Lisp_Object infile
, buffer
, current_dir
, path
;
183 volatile int display_p_volatile
;
187 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
188 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
189 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
190 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
191 int count
= SPECPDL_INDEX ();
193 const unsigned char **volatile new_argv_volatile
;
194 register const unsigned char **new_argv
;
195 /* File to use for stderr in the child.
196 t means use same as standard output. */
197 Lisp_Object error_file
;
198 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
199 char *outf
, *tempfile
;
202 struct coding_system process_coding
; /* coding-system of process output */
203 struct coding_system argument_coding
; /* coding-system of arguments */
204 /* Set to the return value of Ffind_operation_coding_system. */
205 Lisp_Object coding_systems
;
207 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
210 CHECK_STRING (args
[0]);
215 /* Without asynchronous processes we cannot have BUFFER == 0. */
217 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
218 error ("Operating system cannot handle asynchronous subprocesses");
219 #endif /* subprocesses */
221 /* Decide the coding-system for giving arguments. */
223 Lisp_Object val
, *args2
;
226 /* If arguments are supplied, we may have to encode them. */
230 Lisp_Object coding_attrs
;
232 for (i
= 4; i
< nargs
; i
++)
233 CHECK_STRING (args
[i
]);
235 for (i
= 4; i
< nargs
; i
++)
236 if (STRING_MULTIBYTE (args
[i
]))
239 if (!NILP (Vcoding_system_for_write
))
240 val
= Vcoding_system_for_write
;
241 else if (! must_encode
)
245 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
246 args2
[0] = Qcall_process
;
247 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
248 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
249 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
251 val
= complement_process_encoding_system (val
);
252 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
253 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
254 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
256 /* We should not use an ASCII incompatible coding system. */
257 val
= raw_text_coding_system (val
);
258 setup_coding_system (val
, &argument_coding
);
263 if (nargs
>= 2 && ! NILP (args
[1]))
265 infile
= Fexpand_file_name (args
[1], BVAR (current_buffer
, directory
));
266 CHECK_STRING (infile
);
269 infile
= build_string (NULL_DEVICE
);
275 /* If BUFFER is a list, its meaning is
276 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
279 if (CONSP (XCDR (buffer
)))
281 Lisp_Object stderr_file
;
282 stderr_file
= XCAR (XCDR (buffer
));
284 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
285 error_file
= stderr_file
;
287 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
290 buffer
= XCAR (buffer
);
293 if (!(EQ (buffer
, Qnil
)
295 || INTEGERP (buffer
)))
297 Lisp_Object spec_buffer
;
298 spec_buffer
= buffer
;
299 buffer
= Fget_buffer_create (buffer
);
300 /* Mention the buffer name for a better error message. */
302 CHECK_BUFFER (spec_buffer
);
303 CHECK_BUFFER (buffer
);
309 /* Make sure that the child will be able to chdir to the current
310 buffer's current directory, or its unhandled equivalent. We
311 can't just have the child check for an error when it does the
312 chdir, since it's in a vfork.
314 We have to GCPRO around this because Fexpand_file_name,
315 Funhandled_file_name_directory, and Ffile_accessible_directory_p
316 might call a file name handling function. The argument list is
317 protected by the caller, so all we really have to worry about is
320 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
322 current_dir
= BVAR (current_buffer
, directory
);
324 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
326 current_dir
= Funhandled_file_name_directory (current_dir
);
327 if (NILP (current_dir
))
328 /* If the file name handler says that current_dir is unreachable, use
329 a sensible default. */
330 current_dir
= build_string ("~/");
331 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
332 current_dir
= Ffile_name_as_directory (current_dir
);
334 if (NILP (Ffile_accessible_directory_p (current_dir
)))
335 report_file_error ("Setting current directory",
336 Fcons (BVAR (current_buffer
, directory
), Qnil
));
338 if (STRING_MULTIBYTE (infile
))
339 infile
= ENCODE_FILE (infile
);
340 if (STRING_MULTIBYTE (current_dir
))
341 current_dir
= ENCODE_FILE (current_dir
);
342 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
343 error_file
= ENCODE_FILE (error_file
);
347 display_p_volatile
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
349 filefd
= emacs_open (SSDATA (infile
), O_RDONLY
, 0);
352 infile
= DECODE_FILE (infile
);
353 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
355 /* Search for program; barf if not found. */
357 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
359 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
360 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
365 emacs_close (filefd
);
366 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
369 /* If program file name starts with /: for quoting a magic name,
371 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
372 && SREF (path
, 1) == ':')
373 path
= Fsubstring (path
, make_number (2), Qnil
);
375 new_argv_volatile
= new_argv
= (const unsigned char **)
376 alloca ((nargs
> 4 ? nargs
- 2 : 2) * sizeof (char *));
380 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
382 GCPRO5 (infile
, buffer
, current_dir
, path
, error_file
);
383 argument_coding
.dst_multibyte
= 0;
384 for (i
= 4; i
< nargs
; i
++)
386 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
387 if (CODING_REQUIRE_ENCODING (&argument_coding
))
388 /* We must encode this argument. */
389 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
392 for (i
= 4; i
< nargs
; i
++)
393 new_argv
[i
- 3] = SDATA (args
[i
]);
398 new_argv
[0] = SDATA (path
);
400 #ifdef MSDOS /* MW, July 1993 */
401 if ((outf
= egetenv ("TMPDIR")))
402 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
405 tempfile
= alloca (20);
408 dostounix_filename (tempfile
);
409 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
410 strcat (tempfile
, "/");
411 strcat (tempfile
, "detmp.XXX");
414 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
417 emacs_close (filefd
);
418 report_file_error ("Opening process output file",
419 Fcons (build_string (tempfile
), Qnil
));
425 if (INTEGERP (buffer
))
426 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
433 emacs_close (filefd
);
434 report_file_error ("Creating process pipe", Qnil
);
440 /* child_setup must clobber environ in systems with true vfork.
441 Protect it from permanent change. */
442 register char **save_environ
= environ
;
443 register int fd1
= fd
[1];
445 #ifdef HAVE_WORKING_VFORK
448 struct sigaction sigpipe_action
;
451 #if 0 /* Some systems don't have sigblock. */
452 mask
= sigblock (sigmask (SIGCHLD
));
455 /* Record that we're about to create a synchronous process. */
456 synch_process_alive
= 1;
458 /* These vars record information from process termination.
459 Clear them now before process can possibly terminate,
460 to avoid timing error if process terminates soon. */
461 synch_process_death
= 0;
462 synch_process_retcode
= 0;
463 synch_process_termsig
= 0;
465 if (NILP (error_file
))
466 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
467 else if (STRINGP (error_file
))
470 fd_error
= emacs_open (SSDATA (error_file
),
471 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
473 #else /* not DOS_NT */
474 fd_error
= creat (SSDATA (error_file
), 0666);
475 #endif /* not DOS_NT */
480 emacs_close (filefd
);
488 if (NILP (error_file
))
489 error_file
= build_string (NULL_DEVICE
);
490 else if (STRINGP (error_file
))
491 error_file
= DECODE_FILE (error_file
);
492 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
495 #ifdef MSDOS /* MW, July 1993 */
496 /* Note that on MSDOS `child_setup' actually returns the child process
497 exit status, not its PID, so we assign it to `synch_process_retcode'
499 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
502 /* Record that the synchronous process exited and note its
503 termination status. */
504 synch_process_alive
= 0;
505 synch_process_retcode
= pid
;
506 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
508 synchronize_system_messages_locale ();
509 synch_process_death
= strerror (errno
);
512 emacs_close (outfilefd
);
513 if (fd_error
!= outfilefd
)
514 emacs_close (fd_error
);
515 fd1
= -1; /* No harm in closing that one! */
516 /* Since CRLF is converted to LF within `decode_coding', we can
517 always open a file with binary mode. */
518 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
522 emacs_close (filefd
);
523 report_file_error ("Cannot re-open temporary file", Qnil
);
525 #else /* not MSDOS */
527 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
529 #else /* not WINDOWSNT */
531 #ifdef HAVE_WORKING_VFORK
532 /* On many hosts (e.g. Solaris 2.4), if a vforked child calls `signal',
533 this sets the parent's signal handlers as well as the child's.
534 So delay all interrupts whose handlers the child might munge,
535 and record the current handlers so they can be restored later. */
536 sigemptyset (&blocked
);
537 sigaddset (&blocked
, SIGPIPE
);
538 sigaction (SIGPIPE
, 0, &sigpipe_action
);
539 sigprocmask (SIG_BLOCK
, &blocked
, &procmask
);
546 new_argv
= new_argv_volatile
;
561 /* GConf causes us to ignore SIGPIPE, make sure it is restored
563 //signal (SIGPIPE, SIG_DFL);
564 #ifdef HAVE_WORKING_VFORK
565 sigprocmask (SIG_SETMASK
, &procmask
, 0);
568 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
574 #ifdef HAVE_WORKING_VFORK
575 /* Restore the signal state. */
576 sigaction (SIGPIPE
, &sigpipe_action
, 0);
577 sigprocmask (SIG_SETMASK
, &procmask
, 0);
580 #endif /* not WINDOWSNT */
582 /* The MSDOS case did this already. */
584 emacs_close (fd_error
);
585 #endif /* not MSDOS */
587 environ
= save_environ
;
589 /* Close most of our fd's, but not fd[0]
590 since we will use that to read input from. */
591 emacs_close (filefd
);
592 if (fd1
>= 0 && fd1
!= fd_error
)
600 report_file_error ("Doing vfork", Qnil
);
603 if (INTEGERP (buffer
))
610 /* Enable sending signal if user quits below. */
611 call_process_exited
= 0;
614 /* MSDOS needs different cleanup information. */
615 record_unwind_protect (call_process_cleanup
,
616 Fcons (Fcurrent_buffer (),
617 Fcons (make_number (fd
[0]),
618 build_string (tempfile
))));
620 record_unwind_protect (call_process_cleanup
,
621 Fcons (Fcurrent_buffer (),
622 Fcons (make_number (fd
[0]), make_number (pid
))));
623 #endif /* not MSDOS */
626 if (BUFFERP (buffer
))
627 Fset_buffer (buffer
);
631 /* If BUFFER is nil, we must read process output once and then
632 discard it, so setup coding system but with nil. */
633 setup_coding_system (Qnil
, &process_coding
);
637 Lisp_Object val
, *args2
;
640 if (!NILP (Vcoding_system_for_read
))
641 val
= Vcoding_system_for_read
;
644 if (EQ (coding_systems
, Qt
))
648 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
649 args2
[0] = Qcall_process
;
650 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
652 = Ffind_operation_coding_system (nargs
+ 1, args2
);
654 if (CONSP (coding_systems
))
655 val
= XCAR (coding_systems
);
656 else if (CONSP (Vdefault_process_coding_system
))
657 val
= XCAR (Vdefault_process_coding_system
);
661 Fcheck_coding_system (val
);
662 /* In unibyte mode, character code conversion should not take
663 place but EOL conversion should. So, setup raw-text or one
664 of the subsidiary according to the information just setup. */
665 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
667 val
= raw_text_coding_system (val
);
668 setup_coding_system (val
, &process_coding
);
675 register EMACS_INT nread
;
677 EMACS_INT total_read
= 0;
679 int display_p
= display_p_volatile
;
680 int display_on_the_fly
= display_p
;
681 struct coding_system saved_coding
;
683 saved_coding
= process_coding
;
686 /* Repeatedly read until we've filled as much as possible
687 of the buffer size we have. But don't read
688 less than 1024--save that for the next bufferful. */
690 while (nread
< bufsize
- 1024)
692 int this_read
= emacs_read (fd
[0], buf
+ nread
,
700 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
705 total_read
+= this_read
;
707 if (display_on_the_fly
)
711 /* Now NREAD is the total amount of data in the buffer. */
716 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
717 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
718 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
720 { /* We have to decode the input. */
722 int count1
= SPECPDL_INDEX ();
724 XSETBUFFER (curbuf
, current_buffer
);
725 /* We cannot allow after-change-functions be run
726 during decoding, because that might modify the
727 buffer, while we rely on process_coding.produced to
728 faithfully reflect inserted text until we
729 TEMP_SET_PT_BOTH below. */
730 specbind (Qinhibit_modification_hooks
, Qt
);
731 decode_coding_c_string (&process_coding
, (unsigned char *) buf
,
733 unbind_to (count1
, Qnil
);
734 if (display_on_the_fly
735 && CODING_REQUIRE_DETECTION (&saved_coding
)
736 && ! CODING_REQUIRE_DETECTION (&process_coding
))
738 /* We have detected some coding system. But,
739 there's a possibility that the detection was
740 done by insufficient data. So, we give up
741 displaying on the fly. */
742 if (process_coding
.produced
> 0)
743 del_range_2 (process_coding
.dst_pos
,
744 process_coding
.dst_pos_byte
,
745 process_coding
.dst_pos
746 + process_coding
.produced_char
,
747 process_coding
.dst_pos_byte
748 + process_coding
.produced
, 0);
749 display_on_the_fly
= 0;
750 process_coding
= saved_coding
;
752 /* This is to make the above condition always
753 fails in the future. */
754 saved_coding
.common_flags
755 &= ~CODING_REQUIRE_DETECTION_MASK
;
759 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
760 PT_BYTE
+ process_coding
.produced
);
761 carryover
= process_coding
.carryover_bytes
;
763 memcpy (buf
, process_coding
.carryover
,
764 process_coding
.carryover_bytes
);
768 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
771 /* Make the buffer bigger as we continue to read more data,
772 but not past CALLPROC_BUFFER_SIZE_MAX. */
773 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
774 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
775 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
780 prepare_menu_bars ();
782 redisplay_preserve_echo_area (1);
783 /* This variable might have been set to 0 for code
784 detection. In that case, we set it back to 1 because
785 we should have already detected a coding system. */
786 display_on_the_fly
= 1;
793 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
794 /* If the caller required, let the buffer inherit the
795 coding-system used to decode the process output. */
796 if (inherit_process_coding_system
)
797 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
798 make_number (total_read
));
802 /* Wait for it to terminate, unless it already has. */
803 wait_for_termination (pid
);
808 /* Don't kill any children that the subprocess may have left behind
810 call_process_exited
= 1;
812 unbind_to (count
, Qnil
);
814 if (synch_process_termsig
)
818 synchronize_system_messages_locale ();
819 signame
= strsignal (synch_process_termsig
);
824 synch_process_death
= signame
;
827 if (synch_process_death
)
828 return code_convert_string_norecord (build_string (synch_process_death
),
829 Vlocale_coding_system
, 0);
830 return make_number (synch_process_retcode
);
834 delete_temp_file (Lisp_Object name
)
836 /* Suppress jka-compr handling, etc. */
837 int count
= SPECPDL_INDEX ();
838 specbind (intern ("file-name-handler-alist"), Qnil
);
839 internal_delete_file (name
);
840 unbind_to (count
, Qnil
);
844 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
846 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
847 The remaining arguments are optional.
848 Delete the text if fourth arg DELETE is non-nil.
850 Insert output in BUFFER before point; t means current buffer;
851 nil for BUFFER means discard it; 0 means discard and don't wait.
852 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
853 REAL-BUFFER says what to do with standard output, as above,
854 while STDERR-FILE says what to do with standard error in the child.
855 STDERR-FILE may be nil (discard standard error output),
856 t (mix it with ordinary output), or a file name string.
858 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
859 Remaining args are passed to PROGRAM at startup as command args.
861 If BUFFER is 0, `call-process-region' returns immediately with value nil.
862 Otherwise it waits for PROGRAM to terminate
863 and returns a numeric exit status or a signal description string.
864 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
866 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
867 (size_t nargs
, register Lisp_Object
*args
)
870 Lisp_Object filename_string
;
871 register Lisp_Object start
, end
;
872 int count
= SPECPDL_INDEX ();
873 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
874 Lisp_Object coding_systems
;
875 Lisp_Object val
, *args2
;
878 Lisp_Object tmpdir
, pattern
;
880 if (STRINGP (Vtemporary_file_directory
))
881 tmpdir
= Vtemporary_file_directory
;
885 if (getenv ("TMPDIR"))
886 tmpdir
= build_string (getenv ("TMPDIR"));
888 tmpdir
= build_string ("/tmp/");
891 if ((outf
= egetenv ("TMPDIR"))
892 || (outf
= egetenv ("TMP"))
893 || (outf
= egetenv ("TEMP")))
894 tmpdir
= build_string (outf
);
896 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
900 pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
901 tempfile
= (char *) alloca (SBYTES (pattern
) + 1);
902 memcpy (tempfile
, SDATA (pattern
), SBYTES (pattern
) + 1);
910 fd
= mkstemp (tempfile
);
913 report_file_error ("Failed to open temporary file",
914 Fcons (Vtemp_file_name_pattern
, Qnil
));
922 filename_string
= build_string (tempfile
);
923 GCPRO1 (filename_string
);
926 /* Decide coding-system of the contents of the temporary file. */
927 if (!NILP (Vcoding_system_for_write
))
928 val
= Vcoding_system_for_write
;
929 else if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
933 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
934 args2
[0] = Qcall_process_region
;
935 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
936 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
937 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
939 val
= complement_process_encoding_system (val
);
942 int count1
= SPECPDL_INDEX ();
944 specbind (intern ("coding-system-for-write"), val
);
945 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
946 happen to get a ".Z" suffix. */
947 specbind (intern ("file-name-handler-alist"), Qnil
);
948 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
950 unbind_to (count1
, Qnil
);
953 /* Note that Fcall_process takes care of binding
954 coding-system-for-read. */
956 record_unwind_protect (delete_temp_file
, filename_string
);
958 if (nargs
> 3 && !NILP (args
[3]))
959 Fdelete_region (start
, end
);
971 args
[1] = filename_string
;
973 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
977 static int relocate_fd (int fd
, int minfd
);
981 add_env (char **env
, char **new_env
, char *string
)
988 /* See if this string duplicates any string already in the env.
989 If so, don't put it in.
990 When an env var has multiple definitions,
991 we keep the definition that comes first in process-environment. */
992 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
994 char *p
= *ep
, *q
= string
;
1000 /* The string is a lone variable name; keep it for now, we
1001 will remove it later. It is a placeholder for a
1002 variable that is not to be included in the environment. */
1010 *new_env
++ = string
;
1014 /* This is the last thing run in a newly forked inferior
1015 either synchronous or asynchronous.
1016 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1017 Initialize inferior's priority, pgrp, connected dir and environment.
1018 then exec another program based on new_argv.
1020 This function may change environ for the superior process.
1021 Therefore, the superior process must save and restore the value
1022 of environ around the vfork and the call to this function.
1024 SET_PGRP is nonzero if we should put the subprocess into a separate
1027 CURRENT_DIR is an elisp string giving the path of the current
1028 directory the subprocess should have. Since we can't really signal
1029 a decent error from within the child, this should be verified as an
1030 executable directory by the parent. */
1033 child_setup (int in
, int out
, int err
, register char **new_argv
, int set_pgrp
, Lisp_Object current_dir
)
1040 #endif /* WINDOWSNT */
1042 int pid
= getpid ();
1044 /* Close Emacs's descriptors that this process should not have. */
1045 close_process_descs ();
1047 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1048 we will lose if we call close_load_descs here. */
1050 close_load_descs ();
1053 /* Note that use of alloca is always safe here. It's obvious for systems
1054 that do not have true vfork or that have true (stack) alloca.
1055 If using vfork and C_ALLOCA (when Emacs used to include
1056 src/alloca.c) it is safe because that changes the superior's
1057 static variables as if the superior had done alloca and will be
1058 cleaned up in the usual way. */
1060 register char *temp
;
1063 i
= SBYTES (current_dir
);
1065 /* MSDOS must have all environment variables malloc'ed, because
1066 low-level libc functions that launch subsidiary processes rely
1068 pwd_var
= (char *) xmalloc (i
+ 6);
1070 pwd_var
= (char *) alloca (i
+ 6);
1073 memcpy (pwd_var
, "PWD=", 4);
1074 memcpy (temp
, SDATA (current_dir
), i
);
1075 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1079 /* We can't signal an Elisp error here; we're in a vfork. Since
1080 the callers check the current directory before forking, this
1081 should only return an error if the directory's permissions
1082 are changed between the check and this chdir, but we should
1084 if (chdir (temp
) < 0)
1087 /* Get past the drive letter, so that d:/ is left alone. */
1088 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1095 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1096 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1100 /* Set `env' to a vector of the strings in the environment. */
1102 register Lisp_Object tem
;
1103 register char **new_env
;
1105 register int new_length
;
1106 Lisp_Object display
= Qnil
;
1110 for (tem
= Vprocess_environment
;
1111 CONSP (tem
) && STRINGP (XCAR (tem
));
1114 if (strncmp (SSDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1115 && (SDATA (XCAR (tem
)) [7] == '\0'
1116 || SDATA (XCAR (tem
)) [7] == '='))
1117 /* DISPLAY is specified in process-environment. */
1122 /* If not provided yet, use the frame's DISPLAY. */
1125 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1126 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1127 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1128 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1129 Vinitial_environment
);
1137 /* new_length + 2 to include PWD and terminating 0. */
1138 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1139 /* If we have a PWD envvar, pass one down,
1140 but with corrected value. */
1141 if (egetenv ("PWD"))
1142 *new_env
++ = pwd_var
;
1144 if (STRINGP (display
))
1146 int vlen
= strlen ("DISPLAY=") + strlen (SSDATA (display
)) + 1;
1147 char *vdata
= (char *) alloca (vlen
);
1148 strcpy (vdata
, "DISPLAY=");
1149 strcat (vdata
, SSDATA (display
));
1150 new_env
= add_env (env
, new_env
, vdata
);
1154 for (tem
= Vprocess_environment
;
1155 CONSP (tem
) && STRINGP (XCAR (tem
));
1157 new_env
= add_env (env
, new_env
, SSDATA (XCAR (tem
)));
1161 /* Remove variable names without values. */
1165 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1175 prepare_standard_handles (in
, out
, err
, handles
);
1176 set_process_dir (SDATA (current_dir
));
1177 /* Spawn the child. (See ntproc.c:Spawnve). */
1178 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1179 reset_standard_handles (in
, out
, err
, handles
);
1181 /* An error occurred while trying to spawn the process. */
1182 report_file_error ("Spawning child process", Qnil
);
1185 #else /* not WINDOWSNT */
1186 /* Make sure that in, out, and err are not actually already in
1187 descriptors zero, one, or two; this could happen if Emacs is
1188 started with its standard in, out, or error closed, as might
1191 int oin
= in
, oout
= out
;
1193 /* We have to avoid relocating the same descriptor twice! */
1195 in
= relocate_fd (in
, 3);
1200 out
= relocate_fd (out
, 3);
1204 else if (err
== oout
)
1207 err
= relocate_fd (err
, 3);
1221 if (err
!= in
&& err
!= out
)
1225 #ifndef SETPGRP_RELEASES_CTTY
1226 setpgrp (); /* No arguments but equivalent in this case */
1230 #endif /* not USG */
1232 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1235 /* execvp does not accept an environment arg so the only way
1236 to pass this environment is to set environ. Our caller
1237 is responsible for restoring the ambient value of environ. */
1239 execvp (new_argv
[0], new_argv
);
1241 emacs_write (1, "Can't exec program: ", 20);
1242 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1243 emacs_write (1, "\n", 1);
1247 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1250 /* An error occurred while trying to run the subprocess. */
1251 report_file_error ("Spawning child process", Qnil
);
1254 #endif /* not WINDOWSNT */
1258 /* Move the file descriptor FD so that its number is not less than MINFD.
1259 If the file descriptor is moved at all, the original is freed. */
1261 relocate_fd (int fd
, int minfd
)
1269 new = fcntl (fd
, F_DUPFD
, minfd
);
1273 /* Note that we hold the original FD open while we recurse,
1274 to guarantee we'll get a new FD if we need it. */
1275 new = relocate_fd (new, minfd
);
1279 const char *message_1
= "Error while setting up child: ";
1280 const char *errmessage
= strerror (errno
);
1281 const char *message_2
= "\n";
1282 emacs_write (2, message_1
, strlen (message_1
));
1283 emacs_write (2, errmessage
, strlen (errmessage
));
1284 emacs_write (2, message_2
, strlen (message_2
));
1291 #endif /* not WINDOWSNT */
1294 getenv_internal_1 (const char *var
, int varlen
, char **value
, int *valuelen
,
1297 for (; CONSP (env
); env
= XCDR (env
))
1299 Lisp_Object entry
= XCAR (env
);
1301 && SBYTES (entry
) >= varlen
1303 /* NT environment variables are case insensitive. */
1304 && ! strnicmp (SDATA (entry
), var
, varlen
)
1305 #else /* not WINDOWSNT */
1306 && ! memcmp (SDATA (entry
), var
, varlen
)
1307 #endif /* not WINDOWSNT */
1310 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1312 *value
= SSDATA (entry
) + (varlen
+ 1);
1313 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1316 else if (SBYTES (entry
) == varlen
)
1318 /* Lone variable names in Vprocess_environment mean that
1319 variable should be removed from the environment. */
1329 getenv_internal (const char *var
, int varlen
, char **value
, int *valuelen
,
1332 /* Try to find VAR in Vprocess_environment first. */
1333 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1334 Vprocess_environment
))
1335 return *value
? 1 : 0;
1337 /* For DISPLAY try to get the values from the frame or the initial env. */
1338 if (strcmp (var
, "DISPLAY") == 0)
1341 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1342 if (STRINGP (display
))
1344 *value
= SSDATA (display
);
1345 *valuelen
= SBYTES (display
);
1348 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1349 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1350 Vinitial_environment
))
1351 return *value
? 1 : 0;
1357 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1358 doc
: /* Get the value of environment variable VARIABLE.
1359 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1360 the environment. Otherwise, value is a string.
1362 This function searches `process-environment' for VARIABLE.
1364 If optional parameter ENV is a list, then search this list instead of
1365 `process-environment', and return t when encountering a negative entry
1366 \(an entry for a variable with no value). */)
1367 (Lisp_Object variable
, Lisp_Object env
)
1372 CHECK_STRING (variable
);
1375 if (getenv_internal_1 (SSDATA (variable
), SBYTES (variable
),
1376 &value
, &valuelen
, env
))
1377 return value
? make_string (value
, valuelen
) : Qt
;
1381 else if (getenv_internal (SSDATA (variable
), SBYTES (variable
),
1382 &value
, &valuelen
, env
))
1383 return make_string (value
, valuelen
);
1388 /* A version of getenv that consults the Lisp environment lists,
1389 easily callable from C. */
1391 egetenv (const char *var
)
1396 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1403 /* This is run before init_cmdargs. */
1406 init_callproc_1 (void)
1408 char *data_dir
= egetenv ("EMACSDATA");
1409 char *doc_dir
= egetenv ("EMACSDOC");
1412 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1415 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1418 /* Check the EMACSPATH environment variable, defaulting to the
1419 PATH_EXEC path from epaths.h. */
1420 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1421 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1422 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1425 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1428 init_callproc (void)
1430 char *data_dir
= egetenv ("EMACSDATA");
1433 Lisp_Object tempdir
;
1435 if (!NILP (Vinstallation_directory
))
1437 /* Add to the path the lib-src subdir of the installation dir. */
1439 tem
= Fexpand_file_name (build_string ("lib-src"),
1440 Vinstallation_directory
);
1442 /* MSDOS uses wrapped binaries, so don't do this. */
1443 if (NILP (Fmember (tem
, Vexec_path
)))
1445 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1446 Vexec_path
= Fcons (tem
, Vexec_path
);
1447 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1450 Vexec_directory
= Ffile_name_as_directory (tem
);
1451 #endif /* not DOS_NT */
1453 /* Maybe use ../etc as well as ../lib-src. */
1456 tem
= Fexpand_file_name (build_string ("etc"),
1457 Vinstallation_directory
);
1458 Vdoc_directory
= Ffile_name_as_directory (tem
);
1462 /* Look for the files that should be in etc. We don't use
1463 Vinstallation_directory, because these files are never installed
1464 near the executable, and they are never in the build
1465 directory when that's different from the source directory.
1467 Instead, if these files are not in the nominal place, we try the
1468 source directory. */
1471 Lisp_Object tem
, tem1
, srcdir
;
1473 srcdir
= Fexpand_file_name (build_string ("../src/"),
1474 build_string (PATH_DUMPLOADSEARCH
));
1475 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1476 tem1
= Ffile_exists_p (tem
);
1477 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1480 newdir
= Fexpand_file_name (build_string ("../etc/"),
1481 build_string (PATH_DUMPLOADSEARCH
));
1482 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1483 tem1
= Ffile_exists_p (tem
);
1485 Vdata_directory
= newdir
;
1493 tempdir
= Fdirectory_file_name (Vexec_directory
);
1494 if (access (SSDATA (tempdir
), 0) < 0)
1495 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1499 tempdir
= Fdirectory_file_name (Vdata_directory
);
1500 if (access (SSDATA (tempdir
), 0) < 0)
1501 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1504 sh
= (char *) getenv ("SHELL");
1505 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1508 Vshared_game_score_directory
= Qnil
;
1510 Vshared_game_score_directory
= build_string (PATH_GAME
);
1511 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1512 Vshared_game_score_directory
= Qnil
;
1517 set_initial_environment (void)
1519 register char **envp
;
1521 Vprocess_environment
= Qnil
;
1526 for (envp
= environ
; *envp
; envp
++)
1527 Vprocess_environment
= Fcons (build_string (*envp
),
1528 Vprocess_environment
);
1529 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1530 to use `delete' and friends on process-environment. */
1531 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1536 syms_of_callproc (void)
1539 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1540 #elif defined (WINDOWSNT)
1541 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1543 Vtemp_file_name_pattern
= build_string ("detmp.XXX");
1545 staticpro (&Vtemp_file_name_pattern
);
1547 DEFVAR_LISP ("shell-file-name", Vshell_file_name
,
1548 doc
: /* *File name to load inferior shells from.
1549 Initialized from the SHELL environment variable, or to a system-dependent
1550 default if SHELL is not set. */);
1552 DEFVAR_LISP ("exec-path", Vexec_path
,
1553 doc
: /* *List of directories to search programs to run in subprocesses.
1554 Each element is a string (directory name) or nil (try default directory). */);
1556 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes
,
1557 doc
: /* *List of suffixes to try to find executable file names.
1558 Each element is a string. */);
1559 Vexec_suffixes
= Qnil
;
1561 DEFVAR_LISP ("exec-directory", Vexec_directory
,
1562 doc
: /* Directory for executables for Emacs to invoke.
1563 More generally, this includes any architecture-dependent files
1564 that are built and installed from the Emacs distribution. */);
1566 DEFVAR_LISP ("data-directory", Vdata_directory
,
1567 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1568 These are files intended for Emacs to use while it runs. */);
1570 DEFVAR_LISP ("doc-directory", Vdoc_directory
,
1571 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1572 This is usually the same as `data-directory'. */);
1574 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory
,
1575 doc
: /* For internal use by the build procedure only.
1576 This is the name of the directory in which the build procedure installed
1577 Emacs's info files; the default value for `Info-default-directory-list'
1579 Vconfigure_info_directory
= build_string (PATH_INFO
);
1581 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory
,
1582 doc
: /* Directory of score files for games which come with GNU Emacs.
1583 If this variable is nil, then Emacs is unable to use a shared directory. */);
1585 Vshared_game_score_directory
= Qnil
;
1587 Vshared_game_score_directory
= build_string (PATH_GAME
);
1590 DEFVAR_LISP ("initial-environment", Vinitial_environment
,
1591 doc
: /* List of environment variables inherited from the parent process.
1592 Each element should be a string of the form ENVVARNAME=VALUE.
1593 The elements must normally be decoded (using `locale-coding-system') for use. */);
1594 Vinitial_environment
= Qnil
;
1596 DEFVAR_LISP ("process-environment", Vprocess_environment
,
1597 doc
: /* List of overridden environment variables for subprocesses to inherit.
1598 Each element should be a string of the form ENVVARNAME=VALUE.
1600 Entries in this list take precedence to those in the frame-local
1601 environments. Therefore, let-binding `process-environment' is an easy
1602 way to temporarily change the value of an environment variable,
1603 irrespective of where it comes from. To use `process-environment' to
1604 remove an environment variable, include only its name in the list,
1607 This variable is set to nil when Emacs starts.
1609 If multiple entries define the same variable, the first one always
1612 Non-ASCII characters are encoded according to the initial value of
1613 `locale-coding-system', i.e. the elements must normally be decoded for
1616 See `setenv' and `getenv'. */);
1617 Vprocess_environment
= Qnil
;
1619 defsubr (&Scall_process
);
1620 defsubr (&Sgetenv_internal
);
1621 defsubr (&Scall_process_region
);