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
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/>. */
31 /* Define SIGCHLD as an alias for SIGCLD. */
33 #if !defined (SIGCHLD) && defined (SIGCLD)
34 #define SIGCHLD SIGCLD
37 #include <sys/types.h>
45 #define INCLUDED_FCNTL
52 #include <stdlib.h> /* for proper declaration of environ */
55 #define _P_NOWAIT 1 /* from process.h */
58 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
59 #define INCLUDED_FCNTL
62 #include <sys/param.h>
77 #include "character.h"
80 #include "composite.h"
83 #include "syssignal.h"
85 #include "blockinput.h"
87 #include "termhooks.h"
94 extern char **environ
;
98 #if !defined (USG) || defined (BSD_PGRPS)
100 #define setpgrp setpgid
104 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
105 Lisp_Object Vdata_directory
, Vdoc_directory
;
106 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
108 /* Pattern used by call-process-region to make temp files. */
109 static Lisp_Object Vtemp_file_name_pattern
;
111 extern Lisp_Object Vtemporary_file_directory
;
113 Lisp_Object Vshell_file_name
;
115 Lisp_Object Vprocess_environment
, Vinitial_environment
;
118 Lisp_Object Qbuffer_file_type
;
121 /* True if we are about to fork off a synchronous process or if we
122 are waiting for it. */
123 int synch_process_alive
;
125 /* Nonzero => this is a string explaining death of synchronous subprocess. */
126 char *synch_process_death
;
128 /* Nonzero => this is the signal number that terminated the subprocess. */
129 int synch_process_termsig
;
131 /* If synch_process_death is zero,
132 this is exit code of synchronous subprocess. */
133 int synch_process_retcode
;
136 /* Clean up when exiting Fcall_process.
137 On MSDOS, delete the temporary file on any kind of termination.
138 On Unix, kill the process and any children on termination by signal. */
140 /* Nonzero if this is termination due to exit. */
141 static int call_process_exited
;
143 EXFUN (Fgetenv_internal
, 2);
146 call_process_kill (fdpid
)
149 emacs_close (XFASTINT (Fcar (fdpid
)));
150 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
151 synch_process_alive
= 0;
156 call_process_cleanup (fdpid
)
160 /* for MSDOS fdpid is really (fd . tempfile) */
161 register Lisp_Object file
;
163 emacs_close (XFASTINT (Fcar (fdpid
)));
164 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
165 unlink (SDATA (file
));
166 #else /* not MSDOS */
167 register int 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) */)
220 register Lisp_Object
*args
;
222 Lisp_Object infile
, buffer
, current_dir
, path
;
227 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
228 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
229 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
230 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
231 int count
= SPECPDL_INDEX ();
233 register const unsigned char **new_argv
;
234 struct buffer
*old
= current_buffer
;
235 /* File to use for stderr in the child.
236 t means use same as standard output. */
237 Lisp_Object error_file
;
238 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
239 char *outf
, *tempfile
;
242 struct coding_system process_coding
; /* coding-system of process output */
243 struct coding_system argument_coding
; /* coding-system of arguments */
244 /* Set to the return value of Ffind_operation_coding_system. */
245 Lisp_Object coding_systems
;
247 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
250 CHECK_STRING (args
[0]);
255 /* Without asynchronous processes we cannot have BUFFER == 0. */
257 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
258 error ("Operating system cannot handle asynchronous subprocesses");
259 #endif /* subprocesses */
261 /* Decide the coding-system for giving arguments. */
263 Lisp_Object val
, *args2
;
266 /* If arguments are supplied, we may have to encode them. */
270 Lisp_Object coding_attrs
;
272 for (i
= 4; i
< nargs
; i
++)
273 CHECK_STRING (args
[i
]);
275 for (i
= 4; i
< nargs
; i
++)
276 if (STRING_MULTIBYTE (args
[i
]))
279 if (!NILP (Vcoding_system_for_write
))
280 val
= Vcoding_system_for_write
;
281 else if (! must_encode
)
285 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
286 args2
[0] = Qcall_process
;
287 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
288 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
289 if (CONSP (coding_systems
))
290 val
= XCDR (coding_systems
);
291 else if (CONSP (Vdefault_process_coding_system
))
292 val
= XCDR (Vdefault_process_coding_system
);
296 val
= coding_inherit_eol_type (val
, Qnil
);
297 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
298 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
299 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
301 /* We should not use an ASCII incompatible coding system. */
302 val
= raw_text_coding_system (val
);
303 setup_coding_system (val
, &argument_coding
);
308 if (nargs
>= 2 && ! NILP (args
[1]))
310 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
311 CHECK_STRING (infile
);
314 infile
= build_string (NULL_DEVICE
);
320 /* If BUFFER is a list, its meaning is
321 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
324 if (CONSP (XCDR (buffer
)))
326 Lisp_Object stderr_file
;
327 stderr_file
= XCAR (XCDR (buffer
));
329 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
330 error_file
= stderr_file
;
332 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
335 buffer
= XCAR (buffer
);
338 if (!(EQ (buffer
, Qnil
)
340 || INTEGERP (buffer
)))
342 Lisp_Object spec_buffer
;
343 spec_buffer
= buffer
;
344 buffer
= Fget_buffer_create (buffer
);
345 /* Mention the buffer name for a better error message. */
347 CHECK_BUFFER (spec_buffer
);
348 CHECK_BUFFER (buffer
);
354 /* Make sure that the child will be able to chdir to the current
355 buffer's current directory, or its unhandled equivalent. We
356 can't just have the child check for an error when it does the
357 chdir, since it's in a vfork.
359 We have to GCPRO around this because Fexpand_file_name,
360 Funhandled_file_name_directory, and Ffile_accessible_directory_p
361 might call a file name handling function. The argument list is
362 protected by the caller, so all we really have to worry about is
365 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
367 current_dir
= current_buffer
->directory
;
369 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
371 current_dir
= Funhandled_file_name_directory (current_dir
);
372 if (NILP (current_dir
))
373 /* If the file name handler says that current_dir is unreachable, use
374 a sensible default. */
375 current_dir
= build_string ("~/");
376 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
377 current_dir
= Ffile_name_as_directory (current_dir
);
379 if (NILP (Ffile_accessible_directory_p (current_dir
)))
380 report_file_error ("Setting current directory",
381 Fcons (current_buffer
->directory
, Qnil
));
383 if (STRING_MULTIBYTE (infile
))
384 infile
= ENCODE_FILE (infile
);
385 if (STRING_MULTIBYTE (current_dir
))
386 current_dir
= ENCODE_FILE (current_dir
);
387 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
388 error_file
= ENCODE_FILE (error_file
);
392 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
394 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
397 infile
= DECODE_FILE (infile
);
398 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
400 /* Search for program; barf if not found. */
404 GCPRO1 (current_dir
);
405 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
410 emacs_close (filefd
);
411 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
414 /* If program file name starts with /: for quoting a magic name,
416 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
417 && SREF (path
, 1) == ':')
418 path
= Fsubstring (path
, make_number (2), Qnil
);
420 new_argv
= (const unsigned char **)
421 alloca (max (2, nargs
- 2) * sizeof (char *));
425 struct gcpro gcpro1
, gcpro2
, gcpro3
;
427 GCPRO3 (infile
, buffer
, current_dir
);
428 argument_coding
.dst_multibyte
= 0;
429 for (i
= 4; i
< nargs
; i
++)
431 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
432 if (CODING_REQUIRE_ENCODING (&argument_coding
))
433 /* We must encode this argument. */
434 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
437 for (i
= 4; i
< nargs
; i
++)
438 new_argv
[i
- 3] = SDATA (args
[i
]);
443 new_argv
[0] = SDATA (path
);
445 #ifdef MSDOS /* MW, July 1993 */
446 if ((outf
= egetenv ("TMPDIR")))
447 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
450 tempfile
= alloca (20);
453 dostounix_filename (tempfile
);
454 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
455 strcat (tempfile
, "/");
456 strcat (tempfile
, "detmp.XXX");
459 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
462 emacs_close (filefd
);
463 report_file_error ("Opening process output file",
464 Fcons (build_string (tempfile
), Qnil
));
470 if (INTEGERP (buffer
))
471 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
478 emacs_close (filefd
);
479 report_file_error ("Creating process pipe", Qnil
);
485 /* child_setup must clobber environ in systems with true vfork.
486 Protect it from permanent change. */
487 register char **save_environ
= environ
;
488 register int fd1
= fd
[1];
491 #if 0 /* Some systems don't have sigblock. */
492 mask
= sigblock (sigmask (SIGCHLD
));
495 /* Record that we're about to create a synchronous process. */
496 synch_process_alive
= 1;
498 /* These vars record information from process termination.
499 Clear them now before process can possibly terminate,
500 to avoid timing error if process terminates soon. */
501 synch_process_death
= 0;
502 synch_process_retcode
= 0;
503 synch_process_termsig
= 0;
505 if (NILP (error_file
))
506 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
507 else if (STRINGP (error_file
))
510 fd_error
= emacs_open (SDATA (error_file
),
511 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
513 #else /* not DOS_NT */
514 fd_error
= creat (SDATA (error_file
), 0666);
515 #endif /* not DOS_NT */
520 emacs_close (filefd
);
528 if (NILP (error_file
))
529 error_file
= build_string (NULL_DEVICE
);
530 else if (STRINGP (error_file
))
531 error_file
= DECODE_FILE (error_file
);
532 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
535 #ifdef MSDOS /* MW, July 1993 */
536 /* Note that on MSDOS `child_setup' actually returns the child process
537 exit status, not its PID, so we assign it to `synch_process_retcode'
539 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
542 /* Record that the synchronous process exited and note its
543 termination status. */
544 synch_process_alive
= 0;
545 synch_process_retcode
= pid
;
546 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
548 synchronize_system_messages_locale ();
549 synch_process_death
= strerror (errno
);
552 emacs_close (outfilefd
);
553 if (fd_error
!= outfilefd
)
554 emacs_close (fd_error
);
555 fd1
= -1; /* No harm in closing that one! */
556 /* Since CRLF is converted to LF within `decode_coding', we can
557 always open a file with binary mode. */
558 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
562 emacs_close (filefd
);
563 report_file_error ("Cannot re-open temporary file", Qnil
);
565 #else /* not MSDOS */
567 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
569 #else /* not WINDOWSNT */
581 #if defined (USG) && !defined (BSD_PGRPS)
586 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
591 #endif /* not WINDOWSNT */
593 /* The MSDOS case did this already. */
595 emacs_close (fd_error
);
596 #endif /* not MSDOS */
598 environ
= save_environ
;
600 /* Close most of our fd's, but not fd[0]
601 since we will use that to read input from. */
602 emacs_close (filefd
);
603 if (fd1
>= 0 && fd1
!= fd_error
)
611 report_file_error ("Doing vfork", Qnil
);
614 if (INTEGERP (buffer
))
619 /* If Emacs has been built with asynchronous subprocess support,
620 we don't need to do this, I think because it will then have
621 the facilities for handling SIGCHLD. */
622 wait_without_blocking ();
623 #endif /* subprocesses */
627 /* Enable sending signal if user quits below. */
628 call_process_exited
= 0;
631 /* MSDOS needs different cleanup information. */
632 record_unwind_protect (call_process_cleanup
,
633 Fcons (make_number (fd
[0]), build_string (tempfile
)));
635 record_unwind_protect (call_process_cleanup
,
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 /* As CARRYOVER should not be that large, we had
777 better avoid overhead of bcopy. */
778 BCOPY_SHORT (process_coding
.carryover
, buf
,
779 process_coding
.carryover_bytes
);
783 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
786 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
787 /* Make the buffer bigger as we continue to read more data,
788 but not past CALLPROC_BUFFER_SIZE_MAX. */
789 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
790 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
791 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
797 prepare_menu_bars ();
799 redisplay_preserve_echo_area (1);
800 /* This variable might have been set to 0 for code
801 detection. In that case, we set it back to 1 because
802 we should have already detected a coding system. */
803 display_on_the_fly
= 1;
810 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
811 /* If the caller required, let the buffer inherit the
812 coding-system used to decode the process output. */
813 if (inherit_process_coding_system
)
814 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
815 make_number (total_read
));
818 /* Wait for it to terminate, unless it already has. */
819 wait_for_termination (pid
);
823 set_buffer_internal (old
);
825 /* Don't kill any children that the subprocess may have left behind
827 call_process_exited
= 1;
829 unbind_to (count
, Qnil
);
831 if (synch_process_termsig
)
835 synchronize_system_messages_locale ();
836 signame
= strsignal (synch_process_termsig
);
841 synch_process_death
= signame
;
844 if (synch_process_death
)
845 return code_convert_string_norecord (build_string (synch_process_death
),
846 Vlocale_coding_system
, 0);
847 return make_number (synch_process_retcode
);
851 delete_temp_file (name
)
854 /* Suppress jka-compr handling, etc. */
855 int count
= SPECPDL_INDEX ();
856 specbind (intern ("file-name-handler-alist"), Qnil
);
857 internal_delete_file (name
);
858 unbind_to (count
, Qnil
);
862 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
864 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
865 The remaining arguments are optional.
866 Delete the text if fourth arg DELETE is non-nil.
868 Insert output in BUFFER before point; t means current buffer;
869 nil for BUFFER means discard it; 0 means discard and don't wait.
870 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
871 REAL-BUFFER says what to do with standard output, as above,
872 while STDERR-FILE says what to do with standard error in the child.
873 STDERR-FILE may be nil (discard standard error output),
874 t (mix it with ordinary output), or a file name string.
876 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
877 Remaining args are passed to PROGRAM at startup as command args.
879 If BUFFER is 0, `call-process-region' returns immediately with value nil.
880 Otherwise it waits for PROGRAM to terminate
881 and returns a numeric exit status or a signal description string.
882 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
884 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
887 register Lisp_Object
*args
;
890 Lisp_Object filename_string
;
891 register Lisp_Object start
, end
;
892 int count
= SPECPDL_INDEX ();
893 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
894 Lisp_Object coding_systems
;
895 Lisp_Object val
, *args2
;
898 Lisp_Object tmpdir
, pattern
;
900 if (STRINGP (Vtemporary_file_directory
))
901 tmpdir
= Vtemporary_file_directory
;
905 if (getenv ("TMPDIR"))
906 tmpdir
= build_string (getenv ("TMPDIR"));
908 tmpdir
= build_string ("/tmp/");
911 if ((outf
= egetenv ("TMPDIR"))
912 || (outf
= egetenv ("TMP"))
913 || (outf
= egetenv ("TEMP")))
914 tmpdir
= build_string (outf
);
916 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
920 pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
921 tempfile
= (char *) alloca (SBYTES (pattern
) + 1);
922 bcopy (SDATA (pattern
), tempfile
, SBYTES (pattern
) + 1);
930 fd
= mkstemp (tempfile
);
933 report_file_error ("Failed to open temporary file",
934 Fcons (Vtemp_file_name_pattern
, Qnil
));
942 filename_string
= build_string (tempfile
);
943 GCPRO1 (filename_string
);
946 /* Decide coding-system of the contents of the temporary file. */
947 if (!NILP (Vcoding_system_for_write
))
948 val
= Vcoding_system_for_write
;
949 else if (NILP (current_buffer
->enable_multibyte_characters
))
953 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
954 args2
[0] = Qcall_process_region
;
955 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
956 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
957 if (CONSP (coding_systems
))
958 val
= XCDR (coding_systems
);
959 else if (CONSP (Vdefault_process_coding_system
))
960 val
= XCDR (Vdefault_process_coding_system
);
966 int count1
= SPECPDL_INDEX ();
968 specbind (intern ("coding-system-for-write"), val
);
969 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
970 happen to get a ".Z" suffix. */
971 specbind (intern ("file-name-handler-alist"), Qnil
);
972 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
974 unbind_to (count1
, Qnil
);
977 /* Note that Fcall_process takes care of binding
978 coding-system-for-read. */
980 record_unwind_protect (delete_temp_file
, filename_string
);
982 if (nargs
> 3 && !NILP (args
[3]))
983 Fdelete_region (start
, end
);
995 args
[1] = filename_string
;
997 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1000 static int relocate_fd ();
1003 add_env (char **env
, char **new_env
, char *string
)
1010 /* See if this string duplicates any string already in the env.
1011 If so, don't put it in.
1012 When an env var has multiple definitions,
1013 we keep the definition that comes first in process-environment. */
1014 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1016 char *p
= *ep
, *q
= string
;
1022 /* The string is a lone variable name; keep it for now, we
1023 will remove it later. It is a placeholder for a
1024 variable that is not to be included in the environment. */
1032 *new_env
++ = string
;
1036 /* This is the last thing run in a newly forked inferior
1037 either synchronous or asynchronous.
1038 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1039 Initialize inferior's priority, pgrp, connected dir and environment.
1040 then exec another program based on new_argv.
1042 This function may change environ for the superior process.
1043 Therefore, the superior process must save and restore the value
1044 of environ around the vfork and the call to this function.
1046 SET_PGRP is nonzero if we should put the subprocess into a separate
1049 CURRENT_DIR is an elisp string giving the path of the current
1050 directory the subprocess should have. Since we can't really signal
1051 a decent error from within the child, this should be verified as an
1052 executable directory by the parent. */
1055 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1057 register char **new_argv
;
1059 Lisp_Object current_dir
;
1066 #endif /* WINDOWSNT */
1068 int pid
= getpid ();
1070 #ifdef SET_EMACS_PRIORITY
1072 extern EMACS_INT emacs_priority
;
1074 if (emacs_priority
< 0)
1075 nice (- emacs_priority
);
1080 /* Close Emacs's descriptors that this process should not have. */
1081 close_process_descs ();
1083 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1084 we will lose if we call close_load_descs here. */
1086 close_load_descs ();
1089 /* Note that use of alloca is always safe here. It's obvious for systems
1090 that do not have true vfork or that have true (stack) alloca.
1091 If using vfork and C_ALLOCA (when Emacs used to include
1092 src/alloca.c) it is safe because that changes the superior's
1093 static variables as if the superior had done alloca and will be
1094 cleaned up in the usual way. */
1096 register char *temp
;
1099 i
= SBYTES (current_dir
);
1101 /* MSDOS must have all environment variables malloc'ed, because
1102 low-level libc functions that launch subsidiary processes rely
1104 pwd_var
= (char *) xmalloc (i
+ 6);
1106 pwd_var
= (char *) alloca (i
+ 6);
1109 bcopy ("PWD=", pwd_var
, 4);
1110 bcopy (SDATA (current_dir
), temp
, i
);
1111 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1115 /* We can't signal an Elisp error here; we're in a vfork. Since
1116 the callers check the current directory before forking, this
1117 should only return an error if the directory's permissions
1118 are changed between the check and this chdir, but we should
1120 if (chdir (temp
) < 0)
1125 /* Get past the drive letter, so that d:/ is left alone. */
1126 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1133 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1134 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1138 /* Set `env' to a vector of the strings in the environment. */
1140 register Lisp_Object tem
;
1141 register char **new_env
;
1143 register int new_length
;
1144 Lisp_Object display
= Qnil
;
1148 for (tem
= Vprocess_environment
;
1149 CONSP (tem
) && STRINGP (XCAR (tem
));
1152 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1153 && (SDATA (XCAR (tem
)) [7] == '\0'
1154 || SDATA (XCAR (tem
)) [7] == '='))
1155 /* DISPLAY is specified in process-environment. */
1160 /* If not provided yet, use the frame's DISPLAY. */
1163 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1164 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1165 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1166 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1167 Vinitial_environment
);
1175 /* new_length + 2 to include PWD and terminating 0. */
1176 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1177 /* If we have a PWD envvar, pass one down,
1178 but with corrected value. */
1179 if (egetenv ("PWD"))
1180 *new_env
++ = pwd_var
;
1182 if (STRINGP (display
))
1184 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1185 char *vdata
= (char *) alloca (vlen
);
1186 strcpy (vdata
, "DISPLAY=");
1187 strcat (vdata
, SDATA (display
));
1188 new_env
= add_env (env
, new_env
, vdata
);
1192 for (tem
= Vprocess_environment
;
1193 CONSP (tem
) && STRINGP (XCAR (tem
));
1195 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1199 /* Remove variable names without values. */
1203 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1213 prepare_standard_handles (in
, out
, err
, handles
);
1214 set_process_dir (SDATA (current_dir
));
1215 #else /* not WINDOWSNT */
1216 /* Make sure that in, out, and err are not actually already in
1217 descriptors zero, one, or two; this could happen if Emacs is
1218 started with its standard in, out, or error closed, as might
1221 int oin
= in
, oout
= out
;
1223 /* We have to avoid relocating the same descriptor twice! */
1225 in
= relocate_fd (in
, 3);
1230 out
= relocate_fd (out
, 3);
1234 else if (err
== oout
)
1237 err
= relocate_fd (err
, 3);
1251 #endif /* not MSDOS */
1252 #endif /* not WINDOWSNT */
1254 #if defined(USG) && !defined(BSD_PGRPS)
1255 #ifndef SETPGRP_RELEASES_CTTY
1256 setpgrp (); /* No arguments but equivalent in this case */
1261 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1262 EMACS_SET_TTY_PGRP (0, &pid
);
1265 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1268 /* An error occurred while trying to run the subprocess. */
1269 report_file_error ("Spawning child process", Qnil
);
1271 #else /* not MSDOS */
1273 /* Spawn the child. (See ntproc.c:Spawnve). */
1274 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1275 reset_standard_handles (in
, out
, err
, handles
);
1277 /* An error occurred while trying to spawn the process. */
1278 report_file_error ("Spawning child process", Qnil
);
1280 #else /* not WINDOWSNT */
1281 /* execvp does not accept an environment arg so the only way
1282 to pass this environment is to set environ. Our caller
1283 is responsible for restoring the ambient value of environ. */
1285 execvp (new_argv
[0], new_argv
);
1287 emacs_write (1, "Can't exec program: ", 20);
1288 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1289 emacs_write (1, "\n", 1);
1291 #endif /* not WINDOWSNT */
1292 #endif /* not MSDOS */
1295 /* Move the file descriptor FD so that its number is not less than MINFD.
1296 If the file descriptor is moved at all, the original is freed. */
1298 relocate_fd (fd
, minfd
)
1308 char *message1
= "Error while setting up child: ";
1309 char *errmessage
= strerror (errno
);
1310 char *message2
= "\n";
1311 emacs_write (2, message1
, strlen (message1
));
1312 emacs_write (2, errmessage
, strlen (errmessage
));
1313 emacs_write (2, message2
, strlen (message2
));
1316 /* Note that we hold the original FD open while we recurse,
1317 to guarantee we'll get a new FD if we need it. */
1318 new = relocate_fd (new, minfd
);
1325 getenv_internal_1 (var
, varlen
, value
, valuelen
, env
)
1332 for (; CONSP (env
); env
= XCDR (env
))
1334 Lisp_Object entry
= XCAR (env
);
1336 && SBYTES (entry
) >= varlen
1338 /* NT environment variables are case insensitive. */
1339 && ! strnicmp (SDATA (entry
), var
, varlen
)
1340 #else /* not WINDOWSNT */
1341 && ! bcmp (SDATA (entry
), var
, varlen
)
1342 #endif /* not WINDOWSNT */
1345 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1347 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1348 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1351 else if (SBYTES (entry
) == varlen
)
1353 /* Lone variable names in Vprocess_environment mean that
1354 variable should be removed from the environment. */
1364 getenv_internal (var
, varlen
, value
, valuelen
, frame
)
1371 /* Try to find VAR in Vprocess_environment first. */
1372 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1373 Vprocess_environment
))
1374 return *value
? 1 : 0;
1376 /* For DISPLAY try to get the values from the frame or the initial env. */
1377 if (strcmp (var
, "DISPLAY") == 0)
1380 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1381 if (STRINGP (display
))
1383 *value
= (char *) SDATA (display
);
1384 *valuelen
= SBYTES (display
);
1387 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1388 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1389 Vinitial_environment
))
1390 return *value
? 1 : 0;
1396 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1397 doc
: /* Get the value of environment variable VARIABLE.
1398 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1399 the environment. Otherwise, value is a string.
1401 This function searches `process-environment' for VARIABLE.
1403 If optional parameter ENV is a list, then search this list instead of
1404 `process-environment', and return t when encountering a negative entry
1405 \(an entry for a variable with no value). */)
1407 Lisp_Object variable
, env
;
1412 CHECK_STRING (variable
);
1415 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1416 &value
, &valuelen
, env
))
1417 return value
? make_string (value
, valuelen
) : Qt
;
1421 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1422 &value
, &valuelen
, env
))
1423 return make_string (value
, valuelen
);
1428 /* A version of getenv that consults the Lisp environment lists,
1429 easily callable from C. */
1437 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1444 /* This is run before init_cmdargs. */
1449 char *data_dir
= egetenv ("EMACSDATA");
1450 char *doc_dir
= egetenv ("EMACSDOC");
1453 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1456 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1459 /* Check the EMACSPATH environment variable, defaulting to the
1460 PATH_EXEC path from epaths.h. */
1461 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1462 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1463 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1466 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1471 char *data_dir
= egetenv ("EMACSDATA");
1474 Lisp_Object tempdir
;
1476 if (!NILP (Vinstallation_directory
))
1478 /* Add to the path the lib-src subdir of the installation dir. */
1480 tem
= Fexpand_file_name (build_string ("lib-src"),
1481 Vinstallation_directory
);
1483 /* MSDOS uses wrapped binaries, so don't do this. */
1484 if (NILP (Fmember (tem
, Vexec_path
)))
1486 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1487 Vexec_path
= Fcons (tem
, Vexec_path
);
1488 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1491 Vexec_directory
= Ffile_name_as_directory (tem
);
1492 #endif /* not DOS_NT */
1494 /* Maybe use ../etc as well as ../lib-src. */
1497 tem
= Fexpand_file_name (build_string ("etc"),
1498 Vinstallation_directory
);
1499 Vdoc_directory
= Ffile_name_as_directory (tem
);
1503 /* Look for the files that should be in etc. We don't use
1504 Vinstallation_directory, because these files are never installed
1505 near the executable, and they are never in the build
1506 directory when that's different from the source directory.
1508 Instead, if these files are not in the nominal place, we try the
1509 source directory. */
1512 Lisp_Object tem
, tem1
, srcdir
;
1514 srcdir
= Fexpand_file_name (build_string ("../src/"),
1515 build_string (PATH_DUMPLOADSEARCH
));
1516 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1517 tem1
= Ffile_exists_p (tem
);
1518 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1521 newdir
= Fexpand_file_name (build_string ("../etc/"),
1522 build_string (PATH_DUMPLOADSEARCH
));
1523 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1524 tem1
= Ffile_exists_p (tem
);
1526 Vdata_directory
= newdir
;
1534 tempdir
= Fdirectory_file_name (Vexec_directory
);
1535 if (access (SDATA (tempdir
), 0) < 0)
1536 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1540 tempdir
= Fdirectory_file_name (Vdata_directory
);
1541 if (access (SDATA (tempdir
), 0) < 0)
1542 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1545 sh
= (char *) getenv ("SHELL");
1546 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1549 Vshared_game_score_directory
= Qnil
;
1551 Vshared_game_score_directory
= build_string (PATH_GAME
);
1552 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1553 Vshared_game_score_directory
= Qnil
;
1558 set_initial_environment ()
1560 register char **envp
;
1566 Vprocess_environment
= Qnil
;
1568 for (envp
= environ
; *envp
; envp
++)
1569 Vprocess_environment
= Fcons (build_string (*envp
),
1570 Vprocess_environment
);
1571 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1572 to use `delete' and friends on process-environment. */
1573 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1581 Qbuffer_file_type
= intern ("buffer-file-type");
1582 staticpro (&Qbuffer_file_type
);
1586 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1587 #elif defined (WINDOWSNT)
1588 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1590 Vtemp_file_name_pattern
= build_string ("detmp.XXX");
1592 staticpro (&Vtemp_file_name_pattern
);
1594 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1595 doc
: /* *File name to load inferior shells from.
1596 Initialized from the SHELL environment variable, or to a system-dependent
1597 default if SHELL is not set. */);
1599 DEFVAR_LISP ("exec-path", &Vexec_path
,
1600 doc
: /* *List of directories to search programs to run in subprocesses.
1601 Each element is a string (directory name) or nil (try default directory). */);
1603 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1604 doc
: /* *List of suffixes to try to find executable file names.
1605 Each element is a string. */);
1606 Vexec_suffixes
= Qnil
;
1608 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1609 doc
: /* Directory for executables for Emacs to invoke.
1610 More generally, this includes any architecture-dependent files
1611 that are built and installed from the Emacs distribution. */);
1613 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1614 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1615 These are files intended for Emacs to use while it runs. */);
1617 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1618 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1619 This is usually the same as `data-directory'. */);
1621 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1622 doc
: /* For internal use by the build procedure only.
1623 This is the name of the directory in which the build procedure installed
1624 Emacs's info files; the default value for `Info-default-directory-list'
1626 Vconfigure_info_directory
= build_string (PATH_INFO
);
1628 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1629 doc
: /* Directory of score files for games which come with GNU Emacs.
1630 If this variable is nil, then Emacs is unable to use a shared directory. */);
1632 Vshared_game_score_directory
= Qnil
;
1634 Vshared_game_score_directory
= build_string (PATH_GAME
);
1637 DEFVAR_LISP ("initial-environment", &Vinitial_environment
,
1638 doc
: /* List of environment variables inherited from the parent process.
1639 Each element should be a string of the form ENVVARNAME=VALUE.
1640 The elements must normally be decoded (using `locale-coding-system') for use. */);
1641 Vinitial_environment
= Qnil
;
1643 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1644 doc
: /* List of overridden environment variables for subprocesses to inherit.
1645 Each element should be a string of the form ENVVARNAME=VALUE.
1647 Entries in this list take precedence to those in the frame-local
1648 environments. Therefore, let-binding `process-environment' is an easy
1649 way to temporarily change the value of an environment variable,
1650 irrespective of where it comes from. To use `process-environment' to
1651 remove an environment variable, include only its name in the list,
1654 This variable is set to nil when Emacs starts.
1656 If multiple entries define the same variable, the first one always
1659 Non-ASCII characters are encoded according to the initial value of
1660 `locale-coding-system', i.e. the elements must normally be decoded for
1663 See `setenv' and `getenv'. */);
1664 Vprocess_environment
= Qnil
;
1666 defsubr (&Scall_process
);
1667 defsubr (&Sgetenv_internal
);
1668 defsubr (&Scall_process_region
);
1671 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1672 (do not change this comment) */