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, 2011
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/>. */
32 /* Define SIGCHLD as an alias for SIGCLD. */
34 #if !defined (SIGCHLD) && defined (SIGCLD)
35 #define SIGCHLD SIGCLD
38 #include <sys/types.h>
46 #define INCLUDED_FCNTL
53 #include <stdlib.h> /* for proper declaration of environ */
56 #define _P_NOWAIT 1 /* from process.h */
59 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
60 #define INCLUDED_FCNTL
63 #include <sys/param.h>
78 #include "character.h"
81 #include "composite.h"
84 #include "syssignal.h"
86 #include "blockinput.h"
88 #include "termhooks.h"
95 extern char **environ
;
99 #if !defined (USG) || defined (BSD_PGRPS)
101 #define setpgrp setpgid
105 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
106 Lisp_Object Vdata_directory
, Vdoc_directory
;
107 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
109 /* Pattern used by call-process-region to make temp files. */
110 static Lisp_Object Vtemp_file_name_pattern
;
112 extern Lisp_Object Vtemporary_file_directory
;
114 Lisp_Object Vshell_file_name
;
116 Lisp_Object Vprocess_environment
, Vinitial_environment
;
119 Lisp_Object Qbuffer_file_type
;
122 /* True if we are about to fork off a synchronous process or if we
123 are waiting for it. */
124 int synch_process_alive
;
126 /* Nonzero => this is a string explaining death of synchronous subprocess. */
127 char *synch_process_death
;
129 /* Nonzero => this is the signal number that terminated the subprocess. */
130 int synch_process_termsig
;
132 /* If synch_process_death is zero,
133 this is exit code of synchronous subprocess. */
134 int synch_process_retcode
;
137 /* Clean up when exiting Fcall_process.
138 On MSDOS, delete the temporary file on any kind of termination.
139 On Unix, kill the process and any children on termination by signal. */
141 /* Nonzero if this is termination due to exit. */
142 static int call_process_exited
;
144 EXFUN (Fgetenv_internal
, 2);
147 call_process_kill (fdpid
)
150 emacs_close (XFASTINT (Fcar (fdpid
)));
151 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
152 synch_process_alive
= 0;
157 call_process_cleanup (arg
)
160 Lisp_Object fdpid
= Fcdr (arg
);
167 Fset_buffer (Fcar (arg
));
170 /* for MSDOS fdpid is really (fd . tempfile) */
172 emacs_close (XFASTINT (Fcar (fdpid
)));
173 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
174 unlink (SDATA (file
));
175 #else /* not MSDOS */
176 pid
= XFASTINT (Fcdr (fdpid
));
178 if (call_process_exited
)
180 emacs_close (XFASTINT (Fcar (fdpid
)));
184 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
186 int count
= SPECPDL_INDEX ();
187 record_unwind_protect (call_process_kill
, fdpid
);
188 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
191 wait_for_termination (pid
);
193 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
194 message1 ("Waiting for process to die...done");
196 synch_process_alive
= 0;
197 emacs_close (XFASTINT (Fcar (fdpid
)));
198 #endif /* not MSDOS */
202 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
203 doc
: /* Call PROGRAM synchronously in separate process.
204 The remaining arguments are optional.
205 The program's input comes from file INFILE (nil means `/dev/null').
206 Insert output in BUFFER before point; t means current buffer;
207 nil for BUFFER means discard it; 0 means discard and don't wait.
208 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
209 REAL-BUFFER says what to do with standard output, as above,
210 while STDERR-FILE says what to do with standard error in the child.
211 STDERR-FILE may be nil (discard standard error output),
212 t (mix it with ordinary output), or a file name string.
214 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
215 Remaining arguments are strings passed as command arguments to PROGRAM.
217 If executable PROGRAM can't be found as an executable, `call-process'
218 signals a Lisp error. `call-process' reports errors in execution of
219 the program only through its return and output.
221 If BUFFER is 0, `call-process' returns immediately with value nil.
222 Otherwise it waits for PROGRAM to terminate
223 and returns a numeric exit status or a signal description string.
224 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
226 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
229 register Lisp_Object
*args
;
231 Lisp_Object infile
, buffer
, current_dir
, path
;
236 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
237 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
238 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
239 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
240 int count
= SPECPDL_INDEX ();
242 register const unsigned char **new_argv
;
243 /* File to use for stderr in the child.
244 t means use same as standard output. */
245 Lisp_Object error_file
;
246 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
247 char *outf
, *tempfile
;
250 struct coding_system process_coding
; /* coding-system of process output */
251 struct coding_system argument_coding
; /* coding-system of arguments */
252 /* Set to the return value of Ffind_operation_coding_system. */
253 Lisp_Object coding_systems
;
255 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
258 CHECK_STRING (args
[0]);
263 /* Without asynchronous processes we cannot have BUFFER == 0. */
265 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
266 error ("Operating system cannot handle asynchronous subprocesses");
267 #endif /* subprocesses */
269 /* Decide the coding-system for giving arguments. */
271 Lisp_Object val
, *args2
;
274 /* If arguments are supplied, we may have to encode them. */
278 Lisp_Object coding_attrs
;
280 for (i
= 4; i
< nargs
; i
++)
281 CHECK_STRING (args
[i
]);
283 for (i
= 4; i
< nargs
; i
++)
284 if (STRING_MULTIBYTE (args
[i
]))
287 if (!NILP (Vcoding_system_for_write
))
288 val
= Vcoding_system_for_write
;
289 else if (! must_encode
)
293 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
294 args2
[0] = Qcall_process
;
295 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
296 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
297 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
299 val
= complement_process_encoding_system (val
);
300 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
301 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
302 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
304 /* We should not use an ASCII incompatible coding system. */
305 val
= raw_text_coding_system (val
);
306 setup_coding_system (val
, &argument_coding
);
311 if (nargs
>= 2 && ! NILP (args
[1]))
313 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
314 CHECK_STRING (infile
);
317 infile
= build_string (NULL_DEVICE
);
323 /* If BUFFER is a list, its meaning is
324 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
327 if (CONSP (XCDR (buffer
)))
329 Lisp_Object stderr_file
;
330 stderr_file
= XCAR (XCDR (buffer
));
332 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
333 error_file
= stderr_file
;
335 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
338 buffer
= XCAR (buffer
);
341 if (!(EQ (buffer
, Qnil
)
343 || INTEGERP (buffer
)))
345 Lisp_Object spec_buffer
;
346 spec_buffer
= buffer
;
347 buffer
= Fget_buffer_create (buffer
);
348 /* Mention the buffer name for a better error message. */
350 CHECK_BUFFER (spec_buffer
);
351 CHECK_BUFFER (buffer
);
357 /* Make sure that the child will be able to chdir to the current
358 buffer's current directory, or its unhandled equivalent. We
359 can't just have the child check for an error when it does the
360 chdir, since it's in a vfork.
362 We have to GCPRO around this because Fexpand_file_name,
363 Funhandled_file_name_directory, and Ffile_accessible_directory_p
364 might call a file name handling function. The argument list is
365 protected by the caller, so all we really have to worry about is
368 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
370 current_dir
= current_buffer
->directory
;
372 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
374 current_dir
= Funhandled_file_name_directory (current_dir
);
375 if (NILP (current_dir
))
376 /* If the file name handler says that current_dir is unreachable, use
377 a sensible default. */
378 current_dir
= build_string ("~/");
379 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
380 current_dir
= Ffile_name_as_directory (current_dir
);
382 if (NILP (Ffile_accessible_directory_p (current_dir
)))
383 report_file_error ("Setting current directory",
384 Fcons (current_buffer
->directory
, Qnil
));
386 if (STRING_MULTIBYTE (infile
))
387 infile
= ENCODE_FILE (infile
);
388 if (STRING_MULTIBYTE (current_dir
))
389 current_dir
= ENCODE_FILE (current_dir
);
390 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
391 error_file
= ENCODE_FILE (error_file
);
395 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
397 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
400 infile
= DECODE_FILE (infile
);
401 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
403 /* Search for program; barf if not found. */
405 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
407 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
408 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
413 emacs_close (filefd
);
414 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
417 /* If program file name starts with /: for quoting a magic name,
419 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
420 && SREF (path
, 1) == ':')
421 path
= Fsubstring (path
, make_number (2), Qnil
);
423 new_argv
= (const unsigned char **)
424 alloca (max (2, nargs
- 2) * sizeof (char *));
428 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
430 GCPRO5 (infile
, buffer
, current_dir
, path
, error_file
);
431 argument_coding
.dst_multibyte
= 0;
432 for (i
= 4; i
< nargs
; i
++)
434 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
435 if (CODING_REQUIRE_ENCODING (&argument_coding
))
436 /* We must encode this argument. */
437 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
440 for (i
= 4; i
< nargs
; i
++)
441 new_argv
[i
- 3] = SDATA (args
[i
]);
446 new_argv
[0] = SDATA (path
);
448 #ifdef MSDOS /* MW, July 1993 */
449 if ((outf
= egetenv ("TMPDIR")))
450 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
453 tempfile
= alloca (20);
456 dostounix_filename (tempfile
);
457 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
458 strcat (tempfile
, "/");
459 strcat (tempfile
, "detmp.XXX");
462 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
465 emacs_close (filefd
);
466 report_file_error ("Opening process output file",
467 Fcons (build_string (tempfile
), Qnil
));
473 if (INTEGERP (buffer
))
474 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
481 emacs_close (filefd
);
482 report_file_error ("Creating process pipe", Qnil
);
488 /* child_setup must clobber environ in systems with true vfork.
489 Protect it from permanent change. */
490 register char **save_environ
= environ
;
491 register int fd1
= fd
[1];
494 #if 0 /* Some systems don't have sigblock. */
495 mask
= sigblock (sigmask (SIGCHLD
));
498 /* Record that we're about to create a synchronous process. */
499 synch_process_alive
= 1;
501 /* These vars record information from process termination.
502 Clear them now before process can possibly terminate,
503 to avoid timing error if process terminates soon. */
504 synch_process_death
= 0;
505 synch_process_retcode
= 0;
506 synch_process_termsig
= 0;
508 if (NILP (error_file
))
509 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
510 else if (STRINGP (error_file
))
513 fd_error
= emacs_open (SDATA (error_file
),
514 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
516 #else /* not DOS_NT */
517 fd_error
= creat (SDATA (error_file
), 0666);
518 #endif /* not DOS_NT */
523 emacs_close (filefd
);
531 if (NILP (error_file
))
532 error_file
= build_string (NULL_DEVICE
);
533 else if (STRINGP (error_file
))
534 error_file
= DECODE_FILE (error_file
);
535 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
538 #ifdef MSDOS /* MW, July 1993 */
539 /* Note that on MSDOS `child_setup' actually returns the child process
540 exit status, not its PID, so we assign it to `synch_process_retcode'
542 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
545 /* Record that the synchronous process exited and note its
546 termination status. */
547 synch_process_alive
= 0;
548 synch_process_retcode
= pid
;
549 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
551 synchronize_system_messages_locale ();
552 synch_process_death
= strerror (errno
);
555 emacs_close (outfilefd
);
556 if (fd_error
!= outfilefd
)
557 emacs_close (fd_error
);
558 fd1
= -1; /* No harm in closing that one! */
559 /* Since CRLF is converted to LF within `decode_coding', we can
560 always open a file with binary mode. */
561 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
565 emacs_close (filefd
);
566 report_file_error ("Cannot re-open temporary file", Qnil
);
568 #else /* not MSDOS */
570 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
572 #else /* not WINDOWSNT */
584 #if defined (USG) && !defined (BSD_PGRPS)
589 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
594 #endif /* not WINDOWSNT */
596 /* The MSDOS case did this already. */
598 emacs_close (fd_error
);
599 #endif /* not MSDOS */
601 environ
= save_environ
;
603 /* Close most of our fd's, but not fd[0]
604 since we will use that to read input from. */
605 emacs_close (filefd
);
606 if (fd1
>= 0 && fd1
!= fd_error
)
614 report_file_error ("Doing vfork", Qnil
);
617 if (INTEGERP (buffer
))
622 /* If Emacs has been built with asynchronous subprocess support,
623 we don't need to do this, I think because it will then have
624 the facilities for handling SIGCHLD. */
625 wait_without_blocking ();
626 #endif /* subprocesses */
630 /* Enable sending signal if user quits below. */
631 call_process_exited
= 0;
634 /* MSDOS needs different cleanup information. */
635 record_unwind_protect (call_process_cleanup
,
636 Fcons (Fcurrent_buffer (),
637 Fcons (make_number (fd
[0]),
638 build_string (tempfile
))));
640 record_unwind_protect (call_process_cleanup
,
641 Fcons (Fcurrent_buffer (),
642 Fcons (make_number (fd
[0]), make_number (pid
))));
643 #endif /* not MSDOS */
646 if (BUFFERP (buffer
))
647 Fset_buffer (buffer
);
651 /* If BUFFER is nil, we must read process output once and then
652 discard it, so setup coding system but with nil. */
653 setup_coding_system (Qnil
, &process_coding
);
657 Lisp_Object val
, *args2
;
660 if (!NILP (Vcoding_system_for_read
))
661 val
= Vcoding_system_for_read
;
664 if (EQ (coding_systems
, Qt
))
668 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
669 args2
[0] = Qcall_process
;
670 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
672 = Ffind_operation_coding_system (nargs
+ 1, args2
);
674 if (CONSP (coding_systems
))
675 val
= XCAR (coding_systems
);
676 else if (CONSP (Vdefault_process_coding_system
))
677 val
= XCAR (Vdefault_process_coding_system
);
681 Fcheck_coding_system (val
);
682 /* In unibyte mode, character code conversion should not take
683 place but EOL conversion should. So, setup raw-text or one
684 of the subsidiary according to the information just setup. */
685 if (NILP (current_buffer
->enable_multibyte_characters
)
687 val
= raw_text_coding_system (val
);
688 setup_coding_system (val
, &process_coding
);
699 int display_on_the_fly
= display_p
;
700 struct coding_system saved_coding
;
702 saved_coding
= process_coding
;
705 /* Repeatedly read until we've filled as much as possible
706 of the buffer size we have. But don't read
707 less than 1024--save that for the next bufferful. */
709 while (nread
< bufsize
- 1024)
711 int this_read
= emacs_read (fd
[0], buf
+ nread
,
719 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
724 total_read
+= this_read
;
726 if (display_on_the_fly
)
730 /* Now NREAD is the total amount of data in the buffer. */
735 if (NILP (current_buffer
->enable_multibyte_characters
)
736 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
737 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
739 { /* We have to decode the input. */
741 int count1
= SPECPDL_INDEX ();
743 XSETBUFFER (curbuf
, current_buffer
);
744 /* We cannot allow after-change-functions be run
745 during decoding, because that might modify the
746 buffer, while we rely on process_coding.produced to
747 faithfully reflect inserted text until we
748 TEMP_SET_PT_BOTH below. */
749 specbind (Qinhibit_modification_hooks
, Qt
);
750 decode_coding_c_string (&process_coding
, buf
, nread
,
752 unbind_to (count1
, Qnil
);
753 if (display_on_the_fly
754 && CODING_REQUIRE_DETECTION (&saved_coding
)
755 && ! CODING_REQUIRE_DETECTION (&process_coding
))
757 /* We have detected some coding system. But,
758 there's a possibility that the detection was
759 done by insufficient data. So, we give up
760 displaying on the fly. */
761 if (process_coding
.produced
> 0)
762 del_range_2 (process_coding
.dst_pos
,
763 process_coding
.dst_pos_byte
,
764 process_coding
.dst_pos
765 + process_coding
.produced_char
,
766 process_coding
.dst_pos_byte
767 + process_coding
.produced
, 0);
768 display_on_the_fly
= 0;
769 process_coding
= saved_coding
;
771 /* This is to make the above condition always
772 fails in the future. */
773 saved_coding
.common_flags
774 &= ~CODING_REQUIRE_DETECTION_MASK
;
778 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
779 PT_BYTE
+ process_coding
.produced
);
780 carryover
= process_coding
.carryover_bytes
;
782 /* As CARRYOVER should not be that large, we had
783 better avoid overhead of bcopy. */
784 BCOPY_SHORT (process_coding
.carryover
, buf
,
785 process_coding
.carryover_bytes
);
789 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
792 /* Make the buffer bigger as we continue to read more data,
793 but not past CALLPROC_BUFFER_SIZE_MAX. */
794 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
795 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
796 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
801 prepare_menu_bars ();
803 redisplay_preserve_echo_area (1);
804 /* This variable might have been set to 0 for code
805 detection. In that case, we set it back to 1 because
806 we should have already detected a coding system. */
807 display_on_the_fly
= 1;
814 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
815 /* If the caller required, let the buffer inherit the
816 coding-system used to decode the process output. */
817 if (inherit_process_coding_system
)
818 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
819 make_number (total_read
));
822 /* Wait for it to terminate, unless it already has. */
823 wait_for_termination (pid
);
827 /* Don't kill any children that the subprocess may have left behind
829 call_process_exited
= 1;
831 unbind_to (count
, Qnil
);
833 if (synch_process_termsig
)
837 synchronize_system_messages_locale ();
838 signame
= strsignal (synch_process_termsig
);
843 synch_process_death
= signame
;
846 if (synch_process_death
)
847 return code_convert_string_norecord (build_string (synch_process_death
),
848 Vlocale_coding_system
, 0);
849 return make_number (synch_process_retcode
);
853 delete_temp_file (name
)
856 /* Suppress jka-compr handling, etc. */
857 int count
= SPECPDL_INDEX ();
858 specbind (intern ("file-name-handler-alist"), Qnil
);
859 internal_delete_file (name
);
860 unbind_to (count
, Qnil
);
864 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
866 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
867 The remaining arguments are optional.
868 Delete the text if fourth arg DELETE is non-nil.
870 Insert output in BUFFER before point; t means current buffer;
871 nil for BUFFER means discard it; 0 means discard and don't wait.
872 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
873 REAL-BUFFER says what to do with standard output, as above,
874 while STDERR-FILE says what to do with standard error in the child.
875 STDERR-FILE may be nil (discard standard error output),
876 t (mix it with ordinary output), or a file name string.
878 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
879 Remaining args are passed to PROGRAM at startup as command args.
881 If BUFFER is 0, `call-process-region' returns immediately with value nil.
882 Otherwise it waits for PROGRAM to terminate
883 and returns a numeric exit status or a signal description string.
884 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
886 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
889 register Lisp_Object
*args
;
892 Lisp_Object filename_string
;
893 register Lisp_Object start
, end
;
894 int count
= SPECPDL_INDEX ();
895 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
896 Lisp_Object coding_systems
;
897 Lisp_Object val
, *args2
;
900 Lisp_Object tmpdir
, pattern
;
902 if (STRINGP (Vtemporary_file_directory
))
903 tmpdir
= Vtemporary_file_directory
;
907 if (getenv ("TMPDIR"))
908 tmpdir
= build_string (getenv ("TMPDIR"));
910 tmpdir
= build_string ("/tmp/");
913 if ((outf
= egetenv ("TMPDIR"))
914 || (outf
= egetenv ("TMP"))
915 || (outf
= egetenv ("TEMP")))
916 tmpdir
= build_string (outf
);
918 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
922 pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
923 tempfile
= (char *) alloca (SBYTES (pattern
) + 1);
924 bcopy (SDATA (pattern
), tempfile
, SBYTES (pattern
) + 1);
932 fd
= mkstemp (tempfile
);
935 report_file_error ("Failed to open temporary file",
936 Fcons (Vtemp_file_name_pattern
, Qnil
));
944 filename_string
= build_string (tempfile
);
945 GCPRO1 (filename_string
);
948 /* Decide coding-system of the contents of the temporary file. */
949 if (!NILP (Vcoding_system_for_write
))
950 val
= Vcoding_system_for_write
;
951 else if (NILP (current_buffer
->enable_multibyte_characters
))
955 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
956 args2
[0] = Qcall_process_region
;
957 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
958 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
959 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
961 val
= complement_process_encoding_system (val
);
964 int count1
= SPECPDL_INDEX ();
966 specbind (intern ("coding-system-for-write"), val
);
967 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
968 happen to get a ".Z" suffix. */
969 specbind (intern ("file-name-handler-alist"), Qnil
);
970 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
972 unbind_to (count1
, Qnil
);
975 /* Note that Fcall_process takes care of binding
976 coding-system-for-read. */
978 record_unwind_protect (delete_temp_file
, filename_string
);
980 if (nargs
> 3 && !NILP (args
[3]))
981 Fdelete_region (start
, end
);
993 args
[1] = filename_string
;
995 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
998 static int relocate_fd ();
1001 add_env (char **env
, char **new_env
, char *string
)
1008 /* See if this string duplicates any string already in the env.
1009 If so, don't put it in.
1010 When an env var has multiple definitions,
1011 we keep the definition that comes first in process-environment. */
1012 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1014 char *p
= *ep
, *q
= string
;
1020 /* The string is a lone variable name; keep it for now, we
1021 will remove it later. It is a placeholder for a
1022 variable that is not to be included in the environment. */
1030 *new_env
++ = string
;
1034 /* This is the last thing run in a newly forked inferior
1035 either synchronous or asynchronous.
1036 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1037 Initialize inferior's priority, pgrp, connected dir and environment.
1038 then exec another program based on new_argv.
1040 This function may change environ for the superior process.
1041 Therefore, the superior process must save and restore the value
1042 of environ around the vfork and the call to this function.
1044 SET_PGRP is nonzero if we should put the subprocess into a separate
1047 CURRENT_DIR is an elisp string giving the path of the current
1048 directory the subprocess should have. Since we can't really signal
1049 a decent error from within the child, this should be verified as an
1050 executable directory by the parent. */
1053 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1055 register char **new_argv
;
1057 Lisp_Object current_dir
;
1064 #endif /* WINDOWSNT */
1066 int pid
= getpid ();
1068 #ifdef SET_EMACS_PRIORITY
1070 extern EMACS_INT emacs_priority
;
1072 if (emacs_priority
< 0)
1073 nice (- emacs_priority
);
1078 /* Close Emacs's descriptors that this process should not have. */
1079 close_process_descs ();
1081 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1082 we will lose if we call close_load_descs here. */
1084 close_load_descs ();
1087 /* Note that use of alloca is always safe here. It's obvious for systems
1088 that do not have true vfork or that have true (stack) alloca.
1089 If using vfork and C_ALLOCA (when Emacs used to include
1090 src/alloca.c) it is safe because that changes the superior's
1091 static variables as if the superior had done alloca and will be
1092 cleaned up in the usual way. */
1094 register char *temp
;
1097 i
= SBYTES (current_dir
);
1099 /* MSDOS must have all environment variables malloc'ed, because
1100 low-level libc functions that launch subsidiary processes rely
1102 pwd_var
= (char *) xmalloc (i
+ 6);
1104 pwd_var
= (char *) alloca (i
+ 6);
1107 bcopy ("PWD=", pwd_var
, 4);
1108 bcopy (SDATA (current_dir
), temp
, i
);
1109 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1113 /* We can't signal an Elisp error here; we're in a vfork. Since
1114 the callers check the current directory before forking, this
1115 should only return an error if the directory's permissions
1116 are changed between the check and this chdir, but we should
1118 if (chdir (temp
) < 0)
1121 /* Get past the drive letter, so that d:/ is left alone. */
1122 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1129 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1130 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1134 /* Set `env' to a vector of the strings in the environment. */
1136 register Lisp_Object tem
;
1137 register char **new_env
;
1139 register int new_length
;
1140 Lisp_Object display
= Qnil
;
1144 for (tem
= Vprocess_environment
;
1145 CONSP (tem
) && STRINGP (XCAR (tem
));
1148 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1149 && (SDATA (XCAR (tem
)) [7] == '\0'
1150 || SDATA (XCAR (tem
)) [7] == '='))
1151 /* DISPLAY is specified in process-environment. */
1156 /* If not provided yet, use the frame's DISPLAY. */
1159 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1160 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1161 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1162 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1163 Vinitial_environment
);
1171 /* new_length + 2 to include PWD and terminating 0. */
1172 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1173 /* If we have a PWD envvar, pass one down,
1174 but with corrected value. */
1175 if (egetenv ("PWD"))
1176 *new_env
++ = pwd_var
;
1178 if (STRINGP (display
))
1180 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1181 char *vdata
= (char *) alloca (vlen
);
1182 strcpy (vdata
, "DISPLAY=");
1183 strcat (vdata
, SDATA (display
));
1184 new_env
= add_env (env
, new_env
, vdata
);
1188 for (tem
= Vprocess_environment
;
1189 CONSP (tem
) && STRINGP (XCAR (tem
));
1191 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1195 /* Remove variable names without values. */
1199 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1209 prepare_standard_handles (in
, out
, err
, handles
);
1210 set_process_dir (SDATA (current_dir
));
1211 #else /* not WINDOWSNT */
1212 /* Make sure that in, out, and err are not actually already in
1213 descriptors zero, one, or two; this could happen if Emacs is
1214 started with its standard in, out, or error closed, as might
1217 int oin
= in
, oout
= out
;
1219 /* We have to avoid relocating the same descriptor twice! */
1221 in
= relocate_fd (in
, 3);
1226 out
= relocate_fd (out
, 3);
1230 else if (err
== oout
)
1233 err
= relocate_fd (err
, 3);
1247 #endif /* not MSDOS */
1248 #endif /* not WINDOWSNT */
1250 #if defined(USG) && !defined(BSD_PGRPS)
1251 #ifndef SETPGRP_RELEASES_CTTY
1252 setpgrp (); /* No arguments but equivalent in this case */
1257 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1258 EMACS_SET_TTY_PGRP (0, &pid
);
1261 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1264 /* An error occurred while trying to run the subprocess. */
1265 report_file_error ("Spawning child process", Qnil
);
1267 #else /* not MSDOS */
1269 /* Spawn the child. (See ntproc.c:Spawnve). */
1270 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1271 reset_standard_handles (in
, out
, err
, handles
);
1273 /* An error occurred while trying to spawn the process. */
1274 report_file_error ("Spawning child process", Qnil
);
1276 #else /* not WINDOWSNT */
1277 /* execvp does not accept an environment arg so the only way
1278 to pass this environment is to set environ. Our caller
1279 is responsible for restoring the ambient value of environ. */
1281 execvp (new_argv
[0], new_argv
);
1283 emacs_write (1, "Can't exec program: ", 20);
1284 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1285 emacs_write (1, "\n", 1);
1287 #endif /* not WINDOWSNT */
1288 #endif /* not MSDOS */
1291 /* Move the file descriptor FD so that its number is not less than MINFD.
1292 If the file descriptor is moved at all, the original is freed. */
1294 relocate_fd (fd
, minfd
)
1304 char *message1
= "Error while setting up child: ";
1305 char *errmessage
= strerror (errno
);
1306 char *message2
= "\n";
1307 emacs_write (2, message1
, strlen (message1
));
1308 emacs_write (2, errmessage
, strlen (errmessage
));
1309 emacs_write (2, message2
, strlen (message2
));
1312 /* Note that we hold the original FD open while we recurse,
1313 to guarantee we'll get a new FD if we need it. */
1314 new = relocate_fd (new, minfd
);
1321 getenv_internal_1 (var
, varlen
, value
, valuelen
, env
)
1328 for (; CONSP (env
); env
= XCDR (env
))
1330 Lisp_Object entry
= XCAR (env
);
1332 && SBYTES (entry
) >= varlen
1334 /* NT environment variables are case insensitive. */
1335 && ! strnicmp (SDATA (entry
), var
, varlen
)
1336 #else /* not WINDOWSNT */
1337 && ! bcmp (SDATA (entry
), var
, varlen
)
1338 #endif /* not WINDOWSNT */
1341 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1343 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1344 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1347 else if (SBYTES (entry
) == varlen
)
1349 /* Lone variable names in Vprocess_environment mean that
1350 variable should be removed from the environment. */
1360 getenv_internal (var
, varlen
, value
, valuelen
, frame
)
1367 /* Try to find VAR in Vprocess_environment first. */
1368 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1369 Vprocess_environment
))
1370 return *value
? 1 : 0;
1372 /* For DISPLAY try to get the values from the frame or the initial env. */
1373 if (strcmp (var
, "DISPLAY") == 0)
1376 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1377 if (STRINGP (display
))
1379 *value
= (char *) SDATA (display
);
1380 *valuelen
= SBYTES (display
);
1383 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1384 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1385 Vinitial_environment
))
1386 return *value
? 1 : 0;
1392 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1393 doc
: /* Get the value of environment variable VARIABLE.
1394 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1395 the environment. Otherwise, value is a string.
1397 This function searches `process-environment' for VARIABLE.
1399 If optional parameter ENV is a list, then search this list instead of
1400 `process-environment', and return t when encountering a negative entry
1401 \(an entry for a variable with no value). */)
1403 Lisp_Object variable
, env
;
1408 CHECK_STRING (variable
);
1411 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1412 &value
, &valuelen
, env
))
1413 return value
? make_string (value
, valuelen
) : Qt
;
1417 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1418 &value
, &valuelen
, env
))
1419 return make_string (value
, valuelen
);
1424 /* A version of getenv that consults the Lisp environment lists,
1425 easily callable from C. */
1433 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1440 /* This is run before init_cmdargs. */
1445 char *data_dir
= egetenv ("EMACSDATA");
1446 char *doc_dir
= egetenv ("EMACSDOC");
1449 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1452 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1455 /* Check the EMACSPATH environment variable, defaulting to the
1456 PATH_EXEC path from epaths.h. */
1457 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1458 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1459 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1462 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1467 char *data_dir
= egetenv ("EMACSDATA");
1470 Lisp_Object tempdir
;
1472 if (!NILP (Vinstallation_directory
))
1474 /* Add to the path the lib-src subdir of the installation dir. */
1476 tem
= Fexpand_file_name (build_string ("lib-src"),
1477 Vinstallation_directory
);
1479 /* MSDOS uses wrapped binaries, so don't do this. */
1480 if (NILP (Fmember (tem
, Vexec_path
)))
1482 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1483 Vexec_path
= Fcons (tem
, Vexec_path
);
1484 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1487 Vexec_directory
= Ffile_name_as_directory (tem
);
1488 #endif /* not DOS_NT */
1490 /* Maybe use ../etc as well as ../lib-src. */
1493 tem
= Fexpand_file_name (build_string ("etc"),
1494 Vinstallation_directory
);
1495 Vdoc_directory
= Ffile_name_as_directory (tem
);
1499 /* Look for the files that should be in etc. We don't use
1500 Vinstallation_directory, because these files are never installed
1501 near the executable, and they are never in the build
1502 directory when that's different from the source directory.
1504 Instead, if these files are not in the nominal place, we try the
1505 source directory. */
1508 Lisp_Object tem
, tem1
, srcdir
;
1510 srcdir
= Fexpand_file_name (build_string ("../src/"),
1511 build_string (PATH_DUMPLOADSEARCH
));
1512 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1513 tem1
= Ffile_exists_p (tem
);
1514 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1517 newdir
= Fexpand_file_name (build_string ("../etc/"),
1518 build_string (PATH_DUMPLOADSEARCH
));
1519 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1520 tem1
= Ffile_exists_p (tem
);
1522 Vdata_directory
= newdir
;
1530 tempdir
= Fdirectory_file_name (Vexec_directory
);
1531 if (access (SDATA (tempdir
), 0) < 0)
1532 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1536 tempdir
= Fdirectory_file_name (Vdata_directory
);
1537 if (access (SDATA (tempdir
), 0) < 0)
1538 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1541 sh
= (char *) getenv ("SHELL");
1542 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1545 Vshared_game_score_directory
= Qnil
;
1547 Vshared_game_score_directory
= build_string (PATH_GAME
);
1548 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1549 Vshared_game_score_directory
= Qnil
;
1554 set_initial_environment ()
1556 register char **envp
;
1562 Vprocess_environment
= Qnil
;
1564 for (envp
= environ
; *envp
; envp
++)
1565 Vprocess_environment
= Fcons (build_string (*envp
),
1566 Vprocess_environment
);
1567 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1568 to use `delete' and friends on process-environment. */
1569 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1577 Qbuffer_file_type
= intern ("buffer-file-type");
1578 staticpro (&Qbuffer_file_type
);
1582 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1583 #elif defined (WINDOWSNT)
1584 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1586 Vtemp_file_name_pattern
= build_string ("detmp.XXX");
1588 staticpro (&Vtemp_file_name_pattern
);
1590 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1591 doc
: /* *File name to load inferior shells from.
1592 Initialized from the SHELL environment variable, or to a system-dependent
1593 default if SHELL is not set. */);
1595 DEFVAR_LISP ("exec-path", &Vexec_path
,
1596 doc
: /* *List of directories to search programs to run in subprocesses.
1597 Each element is a string (directory name) or nil (try default directory). */);
1599 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1600 doc
: /* *List of suffixes to try to find executable file names.
1601 Each element is a string. */);
1602 Vexec_suffixes
= Qnil
;
1604 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1605 doc
: /* Directory for executables for Emacs to invoke.
1606 More generally, this includes any architecture-dependent files
1607 that are built and installed from the Emacs distribution. */);
1609 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1610 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1611 These are files intended for Emacs to use while it runs. */);
1613 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1614 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1615 This is usually the same as `data-directory'. */);
1617 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1618 doc
: /* For internal use by the build procedure only.
1619 This is the name of the directory in which the build procedure installed
1620 Emacs's info files; the default value for `Info-default-directory-list'
1622 Vconfigure_info_directory
= build_string (PATH_INFO
);
1624 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1625 doc
: /* Directory of score files for games which come with GNU Emacs.
1626 If this variable is nil, then Emacs is unable to use a shared directory. */);
1628 Vshared_game_score_directory
= Qnil
;
1630 Vshared_game_score_directory
= build_string (PATH_GAME
);
1633 DEFVAR_LISP ("initial-environment", &Vinitial_environment
,
1634 doc
: /* List of environment variables inherited from the parent process.
1635 Each element should be a string of the form ENVVARNAME=VALUE.
1636 The elements must normally be decoded (using `locale-coding-system') for use. */);
1637 Vinitial_environment
= Qnil
;
1639 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1640 doc
: /* List of overridden environment variables for subprocesses to inherit.
1641 Each element should be a string of the form ENVVARNAME=VALUE.
1643 Entries in this list take precedence to those in the frame-local
1644 environments. Therefore, let-binding `process-environment' is an easy
1645 way to temporarily change the value of an environment variable,
1646 irrespective of where it comes from. To use `process-environment' to
1647 remove an environment variable, include only its name in the list,
1650 This variable is set to nil when Emacs starts.
1652 If multiple entries define the same variable, the first one always
1655 Non-ASCII characters are encoded according to the initial value of
1656 `locale-coding-system', i.e. the elements must normally be decoded for
1659 See `setenv' and `getenv'. */);
1660 Vprocess_environment
= Qnil
;
1662 defsubr (&Scall_process
);
1663 defsubr (&Sgetenv_internal
);
1664 defsubr (&Scall_process_region
);
1667 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1668 (do not change this comment) */