1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 /* Define SIGCHLD as an alias for SIGCLD. */
30 #if !defined (SIGCHLD) && defined (SIGCLD)
31 #define SIGCHLD SIGCLD
34 #include <sys/types.h>
48 #include <stdlib.h> /* for proper declaration of environ */
51 #define _P_NOWAIT 1 /* from process.h */
54 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
57 #include <sys/param.h>
71 #include "character.h"
74 #include "composite.h"
77 #include "syssignal.h"
79 #include "blockinput.h"
81 #include "termhooks.h"
88 extern char **environ
;
94 #define setpgrp setpgid
98 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
99 Lisp_Object Vdata_directory
, Vdoc_directory
;
100 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
102 /* Pattern used by call-process-region to make temp files. */
103 static Lisp_Object Vtemp_file_name_pattern
;
105 extern Lisp_Object Vtemporary_file_directory
;
107 Lisp_Object Vshell_file_name
;
109 Lisp_Object Vprocess_environment
, Vinitial_environment
;
112 Lisp_Object Qbuffer_file_type
;
115 /* True if we are about to fork off a synchronous process or if we
116 are waiting for it. */
117 int synch_process_alive
;
119 /* Nonzero => this is a string explaining death of synchronous subprocess. */
120 char *synch_process_death
;
122 /* Nonzero => this is the signal number that terminated the subprocess. */
123 int synch_process_termsig
;
125 /* If synch_process_death is zero,
126 this is exit code of synchronous subprocess. */
127 int synch_process_retcode
;
130 /* Clean up when exiting Fcall_process.
131 On MSDOS, delete the temporary file on any kind of termination.
132 On Unix, kill the process and any children on termination by signal. */
134 /* Nonzero if this is termination due to exit. */
135 static int call_process_exited
;
137 EXFUN (Fgetenv_internal
, 2);
140 call_process_kill (Lisp_Object fdpid
)
142 emacs_close (XFASTINT (Fcar (fdpid
)));
143 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
144 synch_process_alive
= 0;
149 call_process_cleanup (Lisp_Object arg
)
151 Lisp_Object fdpid
= Fcdr (arg
);
158 Fset_buffer (Fcar (arg
));
161 /* for MSDOS fdpid is really (fd . tempfile) */
163 emacs_close (XFASTINT (Fcar (fdpid
)));
164 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
165 unlink (SDATA (file
));
166 #else /* not MSDOS */
167 pid
= XFASTINT (Fcdr (fdpid
));
169 if (call_process_exited
)
171 emacs_close (XFASTINT (Fcar (fdpid
)));
175 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
177 int count
= SPECPDL_INDEX ();
178 record_unwind_protect (call_process_kill
, fdpid
);
179 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
182 wait_for_termination (pid
);
184 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
185 message1 ("Waiting for process to die...done");
187 synch_process_alive
= 0;
188 emacs_close (XFASTINT (Fcar (fdpid
)));
189 #endif /* not MSDOS */
193 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
194 doc
: /* Call PROGRAM synchronously in separate process.
195 The remaining arguments are optional.
196 The program's input comes from file INFILE (nil means `/dev/null').
197 Insert output in BUFFER before point; t means current buffer;
198 nil for BUFFER means discard it; 0 means discard and don't wait.
199 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
200 REAL-BUFFER says what to do with standard output, as above,
201 while STDERR-FILE says what to do with standard error in the child.
202 STDERR-FILE may be nil (discard standard error output),
203 t (mix it with ordinary output), or a file name string.
205 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
206 Remaining arguments are strings passed as command arguments to PROGRAM.
208 If executable PROGRAM can't be found as an executable, `call-process'
209 signals a Lisp error. `call-process' reports errors in execution of
210 the program only through its return and output.
212 If BUFFER is 0, `call-process' returns immediately with value nil.
213 Otherwise it waits for PROGRAM to terminate
214 and returns a numeric exit status or a signal description string.
215 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
217 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
218 (int nargs
, register Lisp_Object
*args
)
220 Lisp_Object infile
, buffer
, current_dir
, path
;
225 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
226 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
227 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
228 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
229 int count
= SPECPDL_INDEX ();
231 register const unsigned char **new_argv
;
232 /* File to use for stderr in the child.
233 t means use same as standard output. */
234 Lisp_Object error_file
;
235 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
236 char *outf
, *tempfile
;
239 struct coding_system process_coding
; /* coding-system of process output */
240 struct coding_system argument_coding
; /* coding-system of arguments */
241 /* Set to the return value of Ffind_operation_coding_system. */
242 Lisp_Object coding_systems
;
244 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
247 CHECK_STRING (args
[0]);
252 /* Without asynchronous processes we cannot have BUFFER == 0. */
254 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
255 error ("Operating system cannot handle asynchronous subprocesses");
256 #endif /* subprocesses */
258 /* Decide the coding-system for giving arguments. */
260 Lisp_Object val
, *args2
;
263 /* If arguments are supplied, we may have to encode them. */
267 Lisp_Object coding_attrs
;
269 for (i
= 4; i
< nargs
; i
++)
270 CHECK_STRING (args
[i
]);
272 for (i
= 4; i
< nargs
; i
++)
273 if (STRING_MULTIBYTE (args
[i
]))
276 if (!NILP (Vcoding_system_for_write
))
277 val
= Vcoding_system_for_write
;
278 else if (! must_encode
)
282 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
283 args2
[0] = Qcall_process
;
284 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
285 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
286 if (CONSP (coding_systems
))
287 val
= XCDR (coding_systems
);
288 else if (CONSP (Vdefault_process_coding_system
))
289 val
= XCDR (Vdefault_process_coding_system
);
293 val
= coding_inherit_eol_type (val
, Qnil
);
294 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
295 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
296 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
298 /* We should not use an ASCII incompatible coding system. */
299 val
= raw_text_coding_system (val
);
300 setup_coding_system (val
, &argument_coding
);
305 if (nargs
>= 2 && ! NILP (args
[1]))
307 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
308 CHECK_STRING (infile
);
311 infile
= build_string (NULL_DEVICE
);
317 /* If BUFFER is a list, its meaning is
318 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
321 if (CONSP (XCDR (buffer
)))
323 Lisp_Object stderr_file
;
324 stderr_file
= XCAR (XCDR (buffer
));
326 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
327 error_file
= stderr_file
;
329 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
332 buffer
= XCAR (buffer
);
335 if (!(EQ (buffer
, Qnil
)
337 || INTEGERP (buffer
)))
339 Lisp_Object spec_buffer
;
340 spec_buffer
= buffer
;
341 buffer
= Fget_buffer_create (buffer
);
342 /* Mention the buffer name for a better error message. */
344 CHECK_BUFFER (spec_buffer
);
345 CHECK_BUFFER (buffer
);
351 /* Make sure that the child will be able to chdir to the current
352 buffer's current directory, or its unhandled equivalent. We
353 can't just have the child check for an error when it does the
354 chdir, since it's in a vfork.
356 We have to GCPRO around this because Fexpand_file_name,
357 Funhandled_file_name_directory, and Ffile_accessible_directory_p
358 might call a file name handling function. The argument list is
359 protected by the caller, so all we really have to worry about is
362 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
364 current_dir
= current_buffer
->directory
;
366 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
368 current_dir
= Funhandled_file_name_directory (current_dir
);
369 if (NILP (current_dir
))
370 /* If the file name handler says that current_dir is unreachable, use
371 a sensible default. */
372 current_dir
= build_string ("~/");
373 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
374 current_dir
= Ffile_name_as_directory (current_dir
);
376 if (NILP (Ffile_accessible_directory_p (current_dir
)))
377 report_file_error ("Setting current directory",
378 Fcons (current_buffer
->directory
, Qnil
));
380 if (STRING_MULTIBYTE (infile
))
381 infile
= ENCODE_FILE (infile
);
382 if (STRING_MULTIBYTE (current_dir
))
383 current_dir
= ENCODE_FILE (current_dir
);
384 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
385 error_file
= ENCODE_FILE (error_file
);
389 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
391 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
394 infile
= DECODE_FILE (infile
);
395 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
397 /* Search for program; barf if not found. */
399 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
401 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
402 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
407 emacs_close (filefd
);
408 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
411 /* If program file name starts with /: for quoting a magic name,
413 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
414 && SREF (path
, 1) == ':')
415 path
= Fsubstring (path
, make_number (2), Qnil
);
417 new_argv
= (const unsigned char **)
418 alloca (max (2, nargs
- 2) * sizeof (char *));
422 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
424 GCPRO5 (infile
, buffer
, current_dir
, path
, error_file
);
425 argument_coding
.dst_multibyte
= 0;
426 for (i
= 4; i
< nargs
; i
++)
428 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
429 if (CODING_REQUIRE_ENCODING (&argument_coding
))
430 /* We must encode this argument. */
431 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
434 for (i
= 4; i
< nargs
; i
++)
435 new_argv
[i
- 3] = SDATA (args
[i
]);
440 new_argv
[0] = SDATA (path
);
442 #ifdef MSDOS /* MW, July 1993 */
443 if ((outf
= egetenv ("TMPDIR")))
444 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
447 tempfile
= alloca (20);
450 dostounix_filename (tempfile
);
451 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
452 strcat (tempfile
, "/");
453 strcat (tempfile
, "detmp.XXX");
456 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
459 emacs_close (filefd
);
460 report_file_error ("Opening process output file",
461 Fcons (build_string (tempfile
), Qnil
));
467 if (INTEGERP (buffer
))
468 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
475 emacs_close (filefd
);
476 report_file_error ("Creating process pipe", Qnil
);
482 /* child_setup must clobber environ in systems with true vfork.
483 Protect it from permanent change. */
484 register char **save_environ
= environ
;
485 register int fd1
= fd
[1];
488 #if 0 /* Some systems don't have sigblock. */
489 mask
= sigblock (sigmask (SIGCHLD
));
492 /* Record that we're about to create a synchronous process. */
493 synch_process_alive
= 1;
495 /* These vars record information from process termination.
496 Clear them now before process can possibly terminate,
497 to avoid timing error if process terminates soon. */
498 synch_process_death
= 0;
499 synch_process_retcode
= 0;
500 synch_process_termsig
= 0;
502 if (NILP (error_file
))
503 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
504 else if (STRINGP (error_file
))
507 fd_error
= emacs_open (SDATA (error_file
),
508 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
510 #else /* not DOS_NT */
511 fd_error
= creat (SDATA (error_file
), 0666);
512 #endif /* not DOS_NT */
517 emacs_close (filefd
);
525 if (NILP (error_file
))
526 error_file
= build_string (NULL_DEVICE
);
527 else if (STRINGP (error_file
))
528 error_file
= DECODE_FILE (error_file
);
529 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
532 #ifdef MSDOS /* MW, July 1993 */
533 /* Note that on MSDOS `child_setup' actually returns the child process
534 exit status, not its PID, so we assign it to `synch_process_retcode'
536 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
539 /* Record that the synchronous process exited and note its
540 termination status. */
541 synch_process_alive
= 0;
542 synch_process_retcode
= pid
;
543 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
545 synchronize_system_messages_locale ();
546 synch_process_death
= strerror (errno
);
549 emacs_close (outfilefd
);
550 if (fd_error
!= outfilefd
)
551 emacs_close (fd_error
);
552 fd1
= -1; /* No harm in closing that one! */
553 /* Since CRLF is converted to LF within `decode_coding', we can
554 always open a file with binary mode. */
555 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
559 emacs_close (filefd
);
560 report_file_error ("Cannot re-open temporary file", Qnil
);
562 #else /* not MSDOS */
564 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
566 #else /* not WINDOWSNT */
583 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
588 #endif /* not WINDOWSNT */
590 /* The MSDOS case did this already. */
592 emacs_close (fd_error
);
593 #endif /* not MSDOS */
595 environ
= save_environ
;
597 /* Close most of our fd's, but not fd[0]
598 since we will use that to read input from. */
599 emacs_close (filefd
);
600 if (fd1
>= 0 && fd1
!= fd_error
)
608 report_file_error ("Doing vfork", Qnil
);
611 if (INTEGERP (buffer
))
616 /* If Emacs has been built with asynchronous subprocess support,
617 we don't need to do this, I think because it will then have
618 the facilities for handling SIGCHLD. */
619 wait_without_blocking ();
620 #endif /* subprocesses */
624 /* Enable sending signal if user quits below. */
625 call_process_exited
= 0;
628 /* MSDOS needs different cleanup information. */
629 record_unwind_protect (call_process_cleanup
,
630 Fcons (Fcurrent_buffer (),
631 Fcons (make_number (fd
[0]),
632 build_string (tempfile
))));
634 record_unwind_protect (call_process_cleanup
,
635 Fcons (Fcurrent_buffer (),
636 Fcons (make_number (fd
[0]), make_number (pid
))));
637 #endif /* not MSDOS */
640 if (BUFFERP (buffer
))
641 Fset_buffer (buffer
);
645 /* If BUFFER is nil, we must read process output once and then
646 discard it, so setup coding system but with nil. */
647 setup_coding_system (Qnil
, &process_coding
);
651 Lisp_Object val
, *args2
;
654 if (!NILP (Vcoding_system_for_read
))
655 val
= Vcoding_system_for_read
;
658 if (EQ (coding_systems
, Qt
))
662 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
663 args2
[0] = Qcall_process
;
664 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
666 = Ffind_operation_coding_system (nargs
+ 1, args2
);
668 if (CONSP (coding_systems
))
669 val
= XCAR (coding_systems
);
670 else if (CONSP (Vdefault_process_coding_system
))
671 val
= XCAR (Vdefault_process_coding_system
);
675 Fcheck_coding_system (val
);
676 /* In unibyte mode, character code conversion should not take
677 place but EOL conversion should. So, setup raw-text or one
678 of the subsidiary according to the information just setup. */
679 if (NILP (current_buffer
->enable_multibyte_characters
)
681 val
= raw_text_coding_system (val
);
682 setup_coding_system (val
, &process_coding
);
693 int display_on_the_fly
= display_p
;
694 struct coding_system saved_coding
;
696 saved_coding
= process_coding
;
699 /* Repeatedly read until we've filled as much as possible
700 of the buffer size we have. But don't read
701 less than 1024--save that for the next bufferful. */
703 while (nread
< bufsize
- 1024)
705 int this_read
= emacs_read (fd
[0], buf
+ nread
,
713 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
718 total_read
+= this_read
;
720 if (display_on_the_fly
)
724 /* Now NREAD is the total amount of data in the buffer. */
729 if (NILP (current_buffer
->enable_multibyte_characters
)
730 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
731 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
733 { /* We have to decode the input. */
735 int count1
= SPECPDL_INDEX ();
737 XSETBUFFER (curbuf
, current_buffer
);
738 /* We cannot allow after-change-functions be run
739 during decoding, because that might modify the
740 buffer, while we rely on process_coding.produced to
741 faithfully reflect inserted text until we
742 TEMP_SET_PT_BOTH below. */
743 specbind (Qinhibit_modification_hooks
, Qt
);
744 decode_coding_c_string (&process_coding
, buf
, nread
,
746 unbind_to (count1
, Qnil
);
747 if (display_on_the_fly
748 && CODING_REQUIRE_DETECTION (&saved_coding
)
749 && ! CODING_REQUIRE_DETECTION (&process_coding
))
751 /* We have detected some coding system. But,
752 there's a possibility that the detection was
753 done by insufficient data. So, we give up
754 displaying on the fly. */
755 if (process_coding
.produced
> 0)
756 del_range_2 (process_coding
.dst_pos
,
757 process_coding
.dst_pos_byte
,
758 process_coding
.dst_pos
759 + process_coding
.produced_char
,
760 process_coding
.dst_pos_byte
761 + process_coding
.produced
, 0);
762 display_on_the_fly
= 0;
763 process_coding
= saved_coding
;
765 /* This is to make the above condition always
766 fails in the future. */
767 saved_coding
.common_flags
768 &= ~CODING_REQUIRE_DETECTION_MASK
;
772 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
773 PT_BYTE
+ process_coding
.produced
);
774 carryover
= process_coding
.carryover_bytes
;
776 memcpy (buf
, process_coding
.carryover
,
777 process_coding
.carryover_bytes
);
781 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
784 /* Make the buffer bigger as we continue to read more data,
785 but not past CALLPROC_BUFFER_SIZE_MAX. */
786 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
787 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
788 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
793 prepare_menu_bars ();
795 redisplay_preserve_echo_area (1);
796 /* This variable might have been set to 0 for code
797 detection. In that case, we set it back to 1 because
798 we should have already detected a coding system. */
799 display_on_the_fly
= 1;
806 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
807 /* If the caller required, let the buffer inherit the
808 coding-system used to decode the process output. */
809 if (inherit_process_coding_system
)
810 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
811 make_number (total_read
));
814 /* Wait for it to terminate, unless it already has. */
815 wait_for_termination (pid
);
819 /* Don't kill any children that the subprocess may have left behind
821 call_process_exited
= 1;
823 unbind_to (count
, Qnil
);
825 if (synch_process_termsig
)
829 synchronize_system_messages_locale ();
830 signame
= strsignal (synch_process_termsig
);
835 synch_process_death
= signame
;
838 if (synch_process_death
)
839 return code_convert_string_norecord (build_string (synch_process_death
),
840 Vlocale_coding_system
, 0);
841 return make_number (synch_process_retcode
);
845 delete_temp_file (Lisp_Object name
)
847 /* Suppress jka-compr handling, etc. */
848 int count
= SPECPDL_INDEX ();
849 specbind (intern ("file-name-handler-alist"), Qnil
);
850 internal_delete_file (name
);
851 unbind_to (count
, Qnil
);
855 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
857 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
858 The remaining arguments are optional.
859 Delete the text if fourth arg DELETE is non-nil.
861 Insert output in BUFFER before point; t means current buffer;
862 nil for BUFFER means discard it; 0 means discard and don't wait.
863 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
864 REAL-BUFFER says what to do with standard output, as above,
865 while STDERR-FILE says what to do with standard error in the child.
866 STDERR-FILE may be nil (discard standard error output),
867 t (mix it with ordinary output), or a file name string.
869 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
870 Remaining args are passed to PROGRAM at startup as command args.
872 If BUFFER is 0, `call-process-region' returns immediately with value nil.
873 Otherwise it waits for PROGRAM to terminate
874 and returns a numeric exit status or a signal description string.
875 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
877 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
878 (int nargs
, register Lisp_Object
*args
)
881 Lisp_Object filename_string
;
882 register Lisp_Object start
, end
;
883 int count
= SPECPDL_INDEX ();
884 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
885 Lisp_Object coding_systems
;
886 Lisp_Object val
, *args2
;
889 Lisp_Object tmpdir
, pattern
;
891 if (STRINGP (Vtemporary_file_directory
))
892 tmpdir
= Vtemporary_file_directory
;
896 if (getenv ("TMPDIR"))
897 tmpdir
= build_string (getenv ("TMPDIR"));
899 tmpdir
= build_string ("/tmp/");
902 if ((outf
= egetenv ("TMPDIR"))
903 || (outf
= egetenv ("TMP"))
904 || (outf
= egetenv ("TEMP")))
905 tmpdir
= build_string (outf
);
907 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
911 pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
912 tempfile
= (char *) alloca (SBYTES (pattern
) + 1);
913 memcpy (tempfile
, SDATA (pattern
), SBYTES (pattern
) + 1);
921 fd
= mkstemp (tempfile
);
924 report_file_error ("Failed to open temporary file",
925 Fcons (Vtemp_file_name_pattern
, Qnil
));
933 filename_string
= build_string (tempfile
);
934 GCPRO1 (filename_string
);
937 /* Decide coding-system of the contents of the temporary file. */
938 if (!NILP (Vcoding_system_for_write
))
939 val
= Vcoding_system_for_write
;
940 else if (NILP (current_buffer
->enable_multibyte_characters
))
944 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
945 args2
[0] = Qcall_process_region
;
946 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
947 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
948 if (CONSP (coding_systems
))
949 val
= XCDR (coding_systems
);
950 else if (CONSP (Vdefault_process_coding_system
))
951 val
= XCDR (Vdefault_process_coding_system
);
957 int count1
= SPECPDL_INDEX ();
959 specbind (intern ("coding-system-for-write"), val
);
960 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
961 happen to get a ".Z" suffix. */
962 specbind (intern ("file-name-handler-alist"), Qnil
);
963 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
965 unbind_to (count1
, Qnil
);
968 /* Note that Fcall_process takes care of binding
969 coding-system-for-read. */
971 record_unwind_protect (delete_temp_file
, filename_string
);
973 if (nargs
> 3 && !NILP (args
[3]))
974 Fdelete_region (start
, end
);
986 args
[1] = filename_string
;
988 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
991 static int relocate_fd (int fd
, int minfd
);
994 add_env (char **env
, char **new_env
, char *string
)
1001 /* See if this string duplicates any string already in the env.
1002 If so, don't put it in.
1003 When an env var has multiple definitions,
1004 we keep the definition that comes first in process-environment. */
1005 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1007 char *p
= *ep
, *q
= string
;
1013 /* The string is a lone variable name; keep it for now, we
1014 will remove it later. It is a placeholder for a
1015 variable that is not to be included in the environment. */
1023 *new_env
++ = string
;
1027 /* This is the last thing run in a newly forked inferior
1028 either synchronous or asynchronous.
1029 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1030 Initialize inferior's priority, pgrp, connected dir and environment.
1031 then exec another program based on new_argv.
1033 This function may change environ for the superior process.
1034 Therefore, the superior process must save and restore the value
1035 of environ around the vfork and the call to this function.
1037 SET_PGRP is nonzero if we should put the subprocess into a separate
1040 CURRENT_DIR is an elisp string giving the path of the current
1041 directory the subprocess should have. Since we can't really signal
1042 a decent error from within the child, this should be verified as an
1043 executable directory by the parent. */
1046 child_setup (int in
, int out
, int err
, register char **new_argv
, int set_pgrp
, Lisp_Object current_dir
)
1053 #endif /* WINDOWSNT */
1055 int pid
= getpid ();
1057 /* Close Emacs's descriptors that this process should not have. */
1058 close_process_descs ();
1060 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1061 we will lose if we call close_load_descs here. */
1063 close_load_descs ();
1066 /* Note that use of alloca is always safe here. It's obvious for systems
1067 that do not have true vfork or that have true (stack) alloca.
1068 If using vfork and C_ALLOCA (when Emacs used to include
1069 src/alloca.c) it is safe because that changes the superior's
1070 static variables as if the superior had done alloca and will be
1071 cleaned up in the usual way. */
1073 register char *temp
;
1076 i
= SBYTES (current_dir
);
1078 /* MSDOS must have all environment variables malloc'ed, because
1079 low-level libc functions that launch subsidiary processes rely
1081 pwd_var
= (char *) xmalloc (i
+ 6);
1083 pwd_var
= (char *) alloca (i
+ 6);
1086 memcpy (pwd_var
, "PWD=", 4);
1087 memcpy (temp
, SDATA (current_dir
), i
);
1088 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1092 /* We can't signal an Elisp error here; we're in a vfork. Since
1093 the callers check the current directory before forking, this
1094 should only return an error if the directory's permissions
1095 are changed between the check and this chdir, but we should
1097 if (chdir (temp
) < 0)
1100 /* Get past the drive letter, so that d:/ is left alone. */
1101 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1108 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1109 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1113 /* Set `env' to a vector of the strings in the environment. */
1115 register Lisp_Object tem
;
1116 register char **new_env
;
1118 register int new_length
;
1119 Lisp_Object display
= Qnil
;
1123 for (tem
= Vprocess_environment
;
1124 CONSP (tem
) && STRINGP (XCAR (tem
));
1127 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1128 && (SDATA (XCAR (tem
)) [7] == '\0'
1129 || SDATA (XCAR (tem
)) [7] == '='))
1130 /* DISPLAY is specified in process-environment. */
1135 /* If not provided yet, use the frame's DISPLAY. */
1138 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1139 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1140 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1141 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1142 Vinitial_environment
);
1150 /* new_length + 2 to include PWD and terminating 0. */
1151 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1152 /* If we have a PWD envvar, pass one down,
1153 but with corrected value. */
1154 if (egetenv ("PWD"))
1155 *new_env
++ = pwd_var
;
1157 if (STRINGP (display
))
1159 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1160 char *vdata
= (char *) alloca (vlen
);
1161 strcpy (vdata
, "DISPLAY=");
1162 strcat (vdata
, SDATA (display
));
1163 new_env
= add_env (env
, new_env
, vdata
);
1167 for (tem
= Vprocess_environment
;
1168 CONSP (tem
) && STRINGP (XCAR (tem
));
1170 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1174 /* Remove variable names without values. */
1178 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1188 prepare_standard_handles (in
, out
, err
, handles
);
1189 set_process_dir (SDATA (current_dir
));
1190 #else /* not WINDOWSNT */
1191 /* Make sure that in, out, and err are not actually already in
1192 descriptors zero, one, or two; this could happen if Emacs is
1193 started with its standard in, out, or error closed, as might
1196 int oin
= in
, oout
= out
;
1198 /* We have to avoid relocating the same descriptor twice! */
1200 in
= relocate_fd (in
, 3);
1205 out
= relocate_fd (out
, 3);
1209 else if (err
== oout
)
1212 err
= relocate_fd (err
, 3);
1226 if (err
!= in
&& err
!= out
)
1228 #endif /* not MSDOS */
1229 #endif /* not WINDOWSNT */
1232 #ifndef SETPGRP_RELEASES_CTTY
1233 setpgrp (); /* No arguments but equivalent in this case */
1238 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1239 EMACS_SET_TTY_PGRP (0, &pid
);
1242 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1245 /* An error occurred while trying to run the subprocess. */
1246 report_file_error ("Spawning child process", Qnil
);
1248 #else /* not MSDOS */
1250 /* Spawn the child. (See ntproc.c:Spawnve). */
1251 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1252 reset_standard_handles (in
, out
, err
, handles
);
1254 /* An error occurred while trying to spawn the process. */
1255 report_file_error ("Spawning child process", Qnil
);
1257 #else /* not WINDOWSNT */
1258 /* execvp does not accept an environment arg so the only way
1259 to pass this environment is to set environ. Our caller
1260 is responsible for restoring the ambient value of environ. */
1262 execvp (new_argv
[0], new_argv
);
1264 emacs_write (1, "Can't exec program: ", 20);
1265 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1266 emacs_write (1, "\n", 1);
1268 #endif /* not WINDOWSNT */
1269 #endif /* not MSDOS */
1272 /* Move the file descriptor FD so that its number is not less than MINFD.
1273 If the file descriptor is moved at all, the original is freed. */
1275 relocate_fd (int fd
, int minfd
)
1283 new = fcntl (fd
, F_DUPFD
, minfd
);
1287 /* Note that we hold the original FD open while we recurse,
1288 to guarantee we'll get a new FD if we need it. */
1289 new = relocate_fd (new, minfd
);
1293 const char *message1
= "Error while setting up child: ";
1294 const char *errmessage
= strerror (errno
);
1295 const char *message2
= "\n";
1296 emacs_write (2, message1
, strlen (message1
));
1297 emacs_write (2, errmessage
, strlen (errmessage
));
1298 emacs_write (2, message2
, strlen (message2
));
1307 getenv_internal_1 (const char *var
, int varlen
, char **value
, int *valuelen
,
1310 for (; CONSP (env
); env
= XCDR (env
))
1312 Lisp_Object entry
= XCAR (env
);
1314 && SBYTES (entry
) >= varlen
1316 /* NT environment variables are case insensitive. */
1317 && ! strnicmp (SDATA (entry
), var
, varlen
)
1318 #else /* not WINDOWSNT */
1319 && ! memcmp (SDATA (entry
), var
, varlen
)
1320 #endif /* not WINDOWSNT */
1323 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1325 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1326 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1329 else if (SBYTES (entry
) == varlen
)
1331 /* Lone variable names in Vprocess_environment mean that
1332 variable should be removed from the environment. */
1342 getenv_internal (const char *var
, int varlen
, char **value
, int *valuelen
,
1345 /* Try to find VAR in Vprocess_environment first. */
1346 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1347 Vprocess_environment
))
1348 return *value
? 1 : 0;
1350 /* For DISPLAY try to get the values from the frame or the initial env. */
1351 if (strcmp (var
, "DISPLAY") == 0)
1354 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1355 if (STRINGP (display
))
1357 *value
= (char *) SDATA (display
);
1358 *valuelen
= SBYTES (display
);
1361 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1362 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1363 Vinitial_environment
))
1364 return *value
? 1 : 0;
1370 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1371 doc
: /* Get the value of environment variable VARIABLE.
1372 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1373 the environment. Otherwise, value is a string.
1375 This function searches `process-environment' for VARIABLE.
1377 If optional parameter ENV is a list, then search this list instead of
1378 `process-environment', and return t when encountering a negative entry
1379 \(an entry for a variable with no value). */)
1380 (Lisp_Object variable
, Lisp_Object env
)
1385 CHECK_STRING (variable
);
1388 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1389 &value
, &valuelen
, env
))
1390 return value
? make_string (value
, valuelen
) : Qt
;
1394 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1395 &value
, &valuelen
, env
))
1396 return make_string (value
, valuelen
);
1401 /* A version of getenv that consults the Lisp environment lists,
1402 easily callable from C. */
1404 egetenv (const char *var
)
1409 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1416 /* This is run before init_cmdargs. */
1419 init_callproc_1 (void)
1421 char *data_dir
= egetenv ("EMACSDATA");
1422 char *doc_dir
= egetenv ("EMACSDOC");
1425 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1428 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1431 /* Check the EMACSPATH environment variable, defaulting to the
1432 PATH_EXEC path from epaths.h. */
1433 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1434 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1435 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1438 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1441 init_callproc (void)
1443 char *data_dir
= egetenv ("EMACSDATA");
1446 Lisp_Object tempdir
;
1448 if (!NILP (Vinstallation_directory
))
1450 /* Add to the path the lib-src subdir of the installation dir. */
1452 tem
= Fexpand_file_name (build_string ("lib-src"),
1453 Vinstallation_directory
);
1455 /* MSDOS uses wrapped binaries, so don't do this. */
1456 if (NILP (Fmember (tem
, Vexec_path
)))
1458 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1459 Vexec_path
= Fcons (tem
, Vexec_path
);
1460 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1463 Vexec_directory
= Ffile_name_as_directory (tem
);
1464 #endif /* not DOS_NT */
1466 /* Maybe use ../etc as well as ../lib-src. */
1469 tem
= Fexpand_file_name (build_string ("etc"),
1470 Vinstallation_directory
);
1471 Vdoc_directory
= Ffile_name_as_directory (tem
);
1475 /* Look for the files that should be in etc. We don't use
1476 Vinstallation_directory, because these files are never installed
1477 near the executable, and they are never in the build
1478 directory when that's different from the source directory.
1480 Instead, if these files are not in the nominal place, we try the
1481 source directory. */
1484 Lisp_Object tem
, tem1
, srcdir
;
1486 srcdir
= Fexpand_file_name (build_string ("../src/"),
1487 build_string (PATH_DUMPLOADSEARCH
));
1488 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1489 tem1
= Ffile_exists_p (tem
);
1490 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1493 newdir
= Fexpand_file_name (build_string ("../etc/"),
1494 build_string (PATH_DUMPLOADSEARCH
));
1495 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1496 tem1
= Ffile_exists_p (tem
);
1498 Vdata_directory
= newdir
;
1506 tempdir
= Fdirectory_file_name (Vexec_directory
);
1507 if (access (SDATA (tempdir
), 0) < 0)
1508 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1512 tempdir
= Fdirectory_file_name (Vdata_directory
);
1513 if (access (SDATA (tempdir
), 0) < 0)
1514 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1517 sh
= (char *) getenv ("SHELL");
1518 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1521 Vshared_game_score_directory
= Qnil
;
1523 Vshared_game_score_directory
= build_string (PATH_GAME
);
1524 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1525 Vshared_game_score_directory
= Qnil
;
1530 set_initial_environment (void)
1532 register char **envp
;
1538 Vprocess_environment
= Qnil
;
1540 for (envp
= environ
; *envp
; envp
++)
1541 Vprocess_environment
= Fcons (build_string (*envp
),
1542 Vprocess_environment
);
1543 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1544 to use `delete' and friends on process-environment. */
1545 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1550 syms_of_callproc (void)
1553 Qbuffer_file_type
= intern ("buffer-file-type");
1554 staticpro (&Qbuffer_file_type
);
1558 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1559 #elif defined (WINDOWSNT)
1560 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1562 Vtemp_file_name_pattern
= build_string ("detmp.XXX");
1564 staticpro (&Vtemp_file_name_pattern
);
1566 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1567 doc
: /* *File name to load inferior shells from.
1568 Initialized from the SHELL environment variable, or to a system-dependent
1569 default if SHELL is not set. */);
1571 DEFVAR_LISP ("exec-path", &Vexec_path
,
1572 doc
: /* *List of directories to search programs to run in subprocesses.
1573 Each element is a string (directory name) or nil (try default directory). */);
1575 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1576 doc
: /* *List of suffixes to try to find executable file names.
1577 Each element is a string. */);
1578 Vexec_suffixes
= Qnil
;
1580 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1581 doc
: /* Directory for executables for Emacs to invoke.
1582 More generally, this includes any architecture-dependent files
1583 that are built and installed from the Emacs distribution. */);
1585 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1586 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1587 These are files intended for Emacs to use while it runs. */);
1589 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1590 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1591 This is usually the same as `data-directory'. */);
1593 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1594 doc
: /* For internal use by the build procedure only.
1595 This is the name of the directory in which the build procedure installed
1596 Emacs's info files; the default value for `Info-default-directory-list'
1598 Vconfigure_info_directory
= build_string (PATH_INFO
);
1600 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1601 doc
: /* Directory of score files for games which come with GNU Emacs.
1602 If this variable is nil, then Emacs is unable to use a shared directory. */);
1604 Vshared_game_score_directory
= Qnil
;
1606 Vshared_game_score_directory
= build_string (PATH_GAME
);
1609 DEFVAR_LISP ("initial-environment", &Vinitial_environment
,
1610 doc
: /* List of environment variables inherited from the parent process.
1611 Each element should be a string of the form ENVVARNAME=VALUE.
1612 The elements must normally be decoded (using `locale-coding-system') for use. */);
1613 Vinitial_environment
= Qnil
;
1615 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1616 doc
: /* List of overridden environment variables for subprocesses to inherit.
1617 Each element should be a string of the form ENVVARNAME=VALUE.
1619 Entries in this list take precedence to those in the frame-local
1620 environments. Therefore, let-binding `process-environment' is an easy
1621 way to temporarily change the value of an environment variable,
1622 irrespective of where it comes from. To use `process-environment' to
1623 remove an environment variable, include only its name in the list,
1626 This variable is set to nil when Emacs starts.
1628 If multiple entries define the same variable, the first one always
1631 Non-ASCII characters are encoded according to the initial value of
1632 `locale-coding-system', i.e. the elements must normally be decoded for
1635 See `setenv' and `getenv'. */);
1636 Vprocess_environment
= Qnil
;
1638 defsubr (&Scall_process
);
1639 defsubr (&Sgetenv_internal
);
1640 defsubr (&Scall_process_region
);
1643 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1644 (do not change this comment) */