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 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
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"
93 extern noshare
char **environ
;
96 extern char **environ
;
101 #if !defined (USG) || defined (BSD_PGRPS)
103 #define setpgrp setpgid
107 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
108 Lisp_Object Vdata_directory
, Vdoc_directory
;
109 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
110 Lisp_Object Vtemp_file_name_pattern
;
112 Lisp_Object Vshell_file_name
;
114 Lisp_Object Vprocess_environment
;
117 Lisp_Object Qbuffer_file_type
;
120 /* True iff we are about to fork off a synchronous process or if we
121 are waiting for it. */
122 int synch_process_alive
;
124 /* Nonzero => this is a string explaining death of synchronous subprocess. */
125 char *synch_process_death
;
127 /* Nonzero => this is the signal number that terminated the subprocess. */
128 int synch_process_termsig
;
130 /* If synch_process_death is zero,
131 this is exit code of synchronous subprocess. */
132 int synch_process_retcode
;
134 /* Clean up when exiting Fcall_process.
135 On MSDOS, delete the temporary file on any kind of termination.
136 On Unix, kill the process and any children on termination by signal. */
138 /* Nonzero if this is termination due to exit. */
139 static int call_process_exited
;
141 #ifndef VMS /* VMS version is in vmsproc.c. */
144 call_process_kill (fdpid
)
147 emacs_close (XFASTINT (Fcar (fdpid
)));
148 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
149 synch_process_alive
= 0;
154 call_process_cleanup (fdpid
)
157 #if defined (MSDOS) || defined (MAC_OS8)
158 /* for MSDOS fdpid is really (fd . tempfile) */
159 register Lisp_Object file
;
161 emacs_close (XFASTINT (Fcar (fdpid
)));
162 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
163 unlink (SDATA (file
));
164 #else /* not MSDOS and not MAC_OS8 */
165 register int pid
= XFASTINT (Fcdr (fdpid
));
167 if (call_process_exited
)
169 emacs_close (XFASTINT (Fcar (fdpid
)));
173 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
175 int count
= SPECPDL_INDEX ();
176 record_unwind_protect (call_process_kill
, fdpid
);
177 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
180 wait_for_termination (pid
);
182 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
183 message1 ("Waiting for process to die...done");
185 synch_process_alive
= 0;
186 emacs_close (XFASTINT (Fcar (fdpid
)));
187 #endif /* not MSDOS */
191 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
192 doc
: /* Call PROGRAM synchronously in separate process.
193 The remaining arguments are optional.
194 The program's input comes from file INFILE (nil means `/dev/null').
195 Insert output in BUFFER before point; t means current buffer;
196 nil for BUFFER means discard it; 0 means discard and don't wait.
197 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
198 REAL-BUFFER says what to do with standard output, as above,
199 while STDERR-FILE says what to do with standard error in the child.
200 STDERR-FILE may be nil (discard standard error output),
201 t (mix it with ordinary output), or a file name string.
203 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
204 Remaining arguments are strings passed as command arguments to PROGRAM.
206 If BUFFER is 0, `call-process' returns immediately with value nil.
207 Otherwise it waits for PROGRAM to terminate
208 and returns a numeric exit status or a signal description string.
209 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
211 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
214 register Lisp_Object
*args
;
216 Lisp_Object infile
, buffer
, current_dir
, path
;
221 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
222 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
223 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
224 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
225 int count
= SPECPDL_INDEX ();
227 register const unsigned char **new_argv
228 = (const unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
229 struct buffer
*old
= current_buffer
;
230 /* File to use for stderr in the child.
231 t means use same as standard output. */
232 Lisp_Object error_file
;
233 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
234 char *outf
, *tempfile
;
244 struct coding_system process_coding
; /* coding-system of process output */
245 struct coding_system argument_coding
; /* coding-system of arguments */
246 /* Set to the return value of Ffind_operation_coding_system. */
247 Lisp_Object coding_systems
;
249 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
252 CHECK_STRING (args
[0]);
257 /* Without asynchronous processes we cannot have BUFFER == 0. */
259 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
260 error ("Operating system cannot handle asynchronous subprocesses");
261 #endif /* subprocesses */
263 /* Decide the coding-system for giving arguments. */
265 Lisp_Object val
, *args2
;
268 /* If arguments are supplied, we may have to encode them. */
273 for (i
= 4; i
< nargs
; i
++)
274 CHECK_STRING (args
[i
]);
276 for (i
= 4; i
< nargs
; i
++)
277 if (STRING_MULTIBYTE (args
[i
]))
280 if (!NILP (Vcoding_system_for_write
))
281 val
= Vcoding_system_for_write
;
282 else if (! must_encode
)
286 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
287 args2
[0] = Qcall_process
;
288 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
289 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
290 if (CONSP (coding_systems
))
291 val
= XCDR (coding_systems
);
292 else if (CONSP (Vdefault_process_coding_system
))
293 val
= XCDR (Vdefault_process_coding_system
);
297 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
301 if (nargs
>= 2 && ! NILP (args
[1]))
303 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
304 CHECK_STRING (infile
);
307 infile
= build_string (NULL_DEVICE
);
313 /* If BUFFER is a list, its meaning is
314 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
317 if (CONSP (XCDR (buffer
)))
319 Lisp_Object stderr_file
;
320 stderr_file
= XCAR (XCDR (buffer
));
322 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
323 error_file
= stderr_file
;
325 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
328 buffer
= XCAR (buffer
);
331 if (!(EQ (buffer
, Qnil
)
333 || INTEGERP (buffer
)))
335 Lisp_Object spec_buffer
;
336 spec_buffer
= buffer
;
337 buffer
= Fget_buffer_create (buffer
);
338 /* Mention the buffer name for a better error message. */
340 CHECK_BUFFER (spec_buffer
);
341 CHECK_BUFFER (buffer
);
347 /* Make sure that the child will be able to chdir to the current
348 buffer's current directory, or its unhandled equivalent. We
349 can't just have the child check for an error when it does the
350 chdir, since it's in a vfork.
352 We have to GCPRO around this because Fexpand_file_name,
353 Funhandled_file_name_directory, and Ffile_accessible_directory_p
354 might call a file name handling function. The argument list is
355 protected by the caller, so all we really have to worry about is
358 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
360 current_dir
= current_buffer
->directory
;
362 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
365 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir
),
367 if (NILP (Ffile_accessible_directory_p (current_dir
)))
368 report_file_error ("Setting current directory",
369 Fcons (current_buffer
->directory
, Qnil
));
371 if (STRING_MULTIBYTE (infile
))
372 infile
= ENCODE_FILE (infile
);
373 if (STRING_MULTIBYTE (current_dir
))
374 current_dir
= ENCODE_FILE (current_dir
);
375 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
376 error_file
= ENCODE_FILE (error_file
);
380 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
382 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
385 infile
= DECODE_FILE (infile
);
386 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
388 /* Search for program; barf if not found. */
392 GCPRO1 (current_dir
);
393 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
398 emacs_close (filefd
);
399 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
402 /* If program file name starts with /: for quoting a magic name,
404 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
405 && SREF (path
, 1) == ':')
406 path
= Fsubstring (path
, make_number (2), Qnil
);
408 new_argv
[0] = SDATA (path
);
412 struct gcpro gcpro1
, gcpro2
, gcpro3
;
414 GCPRO3 (infile
, buffer
, current_dir
);
415 argument_coding
.dst_multibyte
= 0;
416 for (i
= 4; i
< nargs
; i
++)
418 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
419 if (CODING_REQUIRE_ENCODING (&argument_coding
))
420 /* We must encode this argument. */
421 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
422 new_argv
[i
- 3] = SDATA (args
[i
]);
425 new_argv
[nargs
- 3] = 0;
430 #ifdef MSDOS /* MW, July 1993 */
431 if ((outf
= egetenv ("TMPDIR")))
432 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
435 tempfile
= alloca (20);
438 dostounix_filename (tempfile
);
439 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
440 strcat (tempfile
, "/");
441 strcat (tempfile
, "detmp.XXX");
444 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
447 emacs_close (filefd
);
448 report_file_error ("Opening process output file",
449 Fcons (build_string (tempfile
), Qnil
));
456 /* Since we don't have pipes on the Mac, create a temporary file to
457 hold the output of the subprocess. */
458 tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
459 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
460 SBYTES (Vtemp_file_name_pattern
) + 1);
464 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
468 report_file_error ("Opening process output file",
469 Fcons (build_string (tempfile
), Qnil
));
475 if (INTEGERP (buffer
))
476 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
484 emacs_close (filefd
);
485 report_file_error ("Creating process pipe", Qnil
);
490 /* Replaced by close_process_descs */
491 set_exclusive_use (fd
[0]);
496 /* child_setup must clobber environ in systems with true vfork.
497 Protect it from permanent change. */
498 register char **save_environ
= environ
;
499 register int fd1
= fd
[1];
502 #if 0 /* Some systems don't have sigblock. */
503 mask
= sigblock (sigmask (SIGCHLD
));
506 /* Record that we're about to create a synchronous process. */
507 synch_process_alive
= 1;
509 /* These vars record information from process termination.
510 Clear them now before process can possibly terminate,
511 to avoid timing error if process terminates soon. */
512 synch_process_death
= 0;
513 synch_process_retcode
= 0;
514 synch_process_termsig
= 0;
516 if (NILP (error_file
))
517 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
518 else if (STRINGP (error_file
))
521 fd_error
= emacs_open (SDATA (error_file
),
522 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
524 #else /* not DOS_NT */
525 fd_error
= creat (SDATA (error_file
), 0666);
526 #endif /* not DOS_NT */
531 emacs_close (filefd
);
539 if (NILP (error_file
))
540 error_file
= build_string (NULL_DEVICE
);
541 else if (STRINGP (error_file
))
542 error_file
= DECODE_FILE (error_file
);
543 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
548 /* Call run_mac_command in sysdep.c here directly instead of doing
549 a child_setup as for MSDOS and other platforms. Note that this
550 code does not handle passing the environment to the synchronous
552 char *infn
, *outfn
, *errfn
, *currdn
;
554 /* close these files so subprocess can write to them */
556 if (fd_error
!= outfilefd
)
558 fd1
= -1; /* No harm in closing that one! */
560 infn
= SDATA (infile
);
562 if (NILP (error_file
))
564 else if (EQ (Qt
, error_file
))
567 errfn
= SDATA (error_file
);
568 currdn
= SDATA (current_dir
);
569 pid
= run_mac_command (new_argv
, currdn
, infn
, outfn
, errfn
);
571 /* Record that the synchronous process exited and note its
572 termination status. */
573 synch_process_alive
= 0;
574 synch_process_retcode
= pid
;
575 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
577 synchronize_system_messages_locale ();
578 synch_process_death
= strerror (errno
);
581 /* Since CRLF is converted to LF within `decode_coding', we can
582 always open a file with binary mode. */
583 fd
[0] = open (tempfile
, O_BINARY
);
588 report_file_error ("Cannot re-open temporary file", Qnil
);
591 #else /* not MAC_OS8 */
592 #ifdef MSDOS /* MW, July 1993 */
593 /* Note that on MSDOS `child_setup' actually returns the child process
594 exit status, not its PID, so we assign it to `synch_process_retcode'
596 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
599 /* Record that the synchronous process exited and note its
600 termination status. */
601 synch_process_alive
= 0;
602 synch_process_retcode
= pid
;
603 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
605 synchronize_system_messages_locale ();
606 synch_process_death
= strerror (errno
);
609 emacs_close (outfilefd
);
610 if (fd_error
!= outfilefd
)
611 emacs_close (fd_error
);
612 fd1
= -1; /* No harm in closing that one! */
613 /* Since CRLF is converted to LF within `decode_coding', we can
614 always open a file with binary mode. */
615 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
619 emacs_close (filefd
);
620 report_file_error ("Cannot re-open temporary file", Qnil
);
622 #else /* not MSDOS */
624 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
626 #else /* not WINDOWSNT */
638 #if defined (USG) && !defined (BSD_PGRPS)
643 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
648 #endif /* not WINDOWSNT */
650 /* The MSDOS case did this already. */
652 emacs_close (fd_error
);
653 #endif /* not MSDOS */
654 #endif /* not MAC_OS8 */
656 environ
= save_environ
;
658 /* Close most of our fd's, but not fd[0]
659 since we will use that to read input from. */
660 emacs_close (filefd
);
661 if (fd1
>= 0 && fd1
!= fd_error
)
669 report_file_error ("Doing vfork", Qnil
);
672 if (INTEGERP (buffer
))
677 /* If Emacs has been built with asynchronous subprocess support,
678 we don't need to do this, I think because it will then have
679 the facilities for handling SIGCHLD. */
680 wait_without_blocking ();
681 #endif /* subprocesses */
685 /* Enable sending signal if user quits below. */
686 call_process_exited
= 0;
688 #if defined(MSDOS) || defined(MAC_OS8)
689 /* MSDOS needs different cleanup information. */
690 record_unwind_protect (call_process_cleanup
,
691 Fcons (make_number (fd
[0]), build_string (tempfile
)));
693 record_unwind_protect (call_process_cleanup
,
694 Fcons (make_number (fd
[0]), make_number (pid
)));
695 #endif /* not MSDOS and not MAC_OS8 */
698 if (BUFFERP (buffer
))
699 Fset_buffer (buffer
);
703 /* If BUFFER is nil, we must read process output once and then
704 discard it, so setup coding system but with nil. */
705 setup_coding_system (Qnil
, &process_coding
);
709 Lisp_Object val
, *args2
;
712 if (!NILP (Vcoding_system_for_read
))
713 val
= Vcoding_system_for_read
;
716 if (EQ (coding_systems
, Qt
))
720 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
721 args2
[0] = Qcall_process
;
722 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
724 = Ffind_operation_coding_system (nargs
+ 1, args2
);
726 if (CONSP (coding_systems
))
727 val
= XCAR (coding_systems
);
728 else if (CONSP (Vdefault_process_coding_system
))
729 val
= XCAR (Vdefault_process_coding_system
);
733 Fcheck_coding_system (val
);
734 /* In unibyte mode, character code conversion should not take
735 place but EOL conversion should. So, setup raw-text or one
736 of the subsidiary according to the information just setup. */
737 if (NILP (current_buffer
->enable_multibyte_characters
)
739 val
= raw_text_coding_system (val
);
740 setup_coding_system (val
, &process_coding
);
751 int display_on_the_fly
= display_p
;
752 struct coding_system saved_coding
;
754 saved_coding
= process_coding
;
757 /* Repeatedly read until we've filled as much as possible
758 of the buffer size we have. But don't read
759 less than 1024--save that for the next bufferful. */
761 while (nread
< bufsize
- 1024)
763 int this_read
= emacs_read (fd
[0], buf
+ nread
,
771 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
776 total_read
+= this_read
;
778 if (display_on_the_fly
)
782 /* Now NREAD is the total amount of data in the buffer. */
787 if (NILP (current_buffer
->enable_multibyte_characters
)
788 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
789 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
791 { /* We have to decode the input. */
794 XSETBUFFER (curbuf
, current_buffer
);
795 decode_coding_c_string (&process_coding
, buf
, nread
,
797 if (display_on_the_fly
798 && CODING_REQUIRE_DETECTION (&saved_coding
)
799 && ! CODING_REQUIRE_DETECTION (&process_coding
))
801 /* We have detected some coding system. But,
802 there's a possibility that the detection was
803 done by insufficient data. So, we give up
804 displaying on the fly. */
805 if (process_coding
.produced
> 0)
806 del_range_2 (process_coding
.dst_pos
,
807 process_coding
.dst_pos_byte
,
808 process_coding
.dst_pos
809 + process_coding
.produced_char
,
810 process_coding
.dst_pos_byte
811 + process_coding
.produced
, 0);
812 display_on_the_fly
= 0;
813 process_coding
= saved_coding
;
815 /* This is to make the above condition always
816 fails in the future. */
817 saved_coding
.common_flags
818 &= ~CODING_REQUIRE_DETECTION_MASK
;
822 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
823 PT_BYTE
+ process_coding
.produced
);
824 carryover
= process_coding
.carryover_bytes
;
826 /* As CARRYOVER should not be that large, we had
827 better avoid overhead of bcopy. */
828 BCOPY_SHORT (process_coding
.carryover
, buf
,
829 process_coding
.carryover_bytes
);
833 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
836 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
837 /* Make the buffer bigger as we continue to read more data,
838 but not past CALLPROC_BUFFER_SIZE_MAX. */
839 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
840 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
841 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
847 prepare_menu_bars ();
849 redisplay_preserve_echo_area (1);
850 /* This variable might have been set to 0 for code
851 detection. In that case, we set it back to 1 because
852 we should have already detected a coding system. */
853 display_on_the_fly
= 1;
860 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
861 /* If the caller required, let the buffer inherit the
862 coding-system used to decode the process output. */
863 if (inherit_process_coding_system
)
864 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
865 make_number (total_read
));
868 /* Wait for it to terminate, unless it already has. */
869 wait_for_termination (pid
);
873 set_buffer_internal (old
);
875 /* Don't kill any children that the subprocess may have left behind
877 call_process_exited
= 1;
879 unbind_to (count
, Qnil
);
881 if (synch_process_termsig
)
885 synchronize_system_messages_locale ();
886 signame
= strsignal (synch_process_termsig
);
891 synch_process_death
= signame
;
894 if (synch_process_death
)
895 return code_convert_string_norecord (build_string (synch_process_death
),
896 Vlocale_coding_system
, 0);
897 return make_number (synch_process_retcode
);
902 delete_temp_file (name
)
905 /* Suppress jka-compr handling, etc. */
906 int count
= SPECPDL_INDEX ();
907 specbind (intern ("file-name-handler-alist"), Qnil
);
908 internal_delete_file (name
);
909 unbind_to (count
, Qnil
);
913 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
915 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
916 The remaining arguments are optional.
917 Delete the text if fourth arg DELETE is non-nil.
919 Insert output in BUFFER before point; t means current buffer;
920 nil for BUFFER means discard it; 0 means discard and don't wait.
921 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
922 REAL-BUFFER says what to do with standard output, as above,
923 while STDERR-FILE says what to do with standard error in the child.
924 STDERR-FILE may be nil (discard standard error output),
925 t (mix it with ordinary output), or a file name string.
927 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
928 Remaining args are passed to PROGRAM at startup as command args.
930 If BUFFER is 0, `call-process-region' returns immediately with value nil.
931 Otherwise it waits for PROGRAM to terminate
932 and returns a numeric exit status or a signal description string.
933 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
935 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
938 register Lisp_Object
*args
;
941 Lisp_Object filename_string
;
942 register Lisp_Object start
, end
;
943 int count
= SPECPDL_INDEX ();
944 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
945 Lisp_Object coding_systems
;
946 Lisp_Object val
, *args2
;
952 if ((outf
= egetenv ("TMPDIR"))
953 || (outf
= egetenv ("TMP"))
954 || (outf
= egetenv ("TEMP")))
955 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
958 tempfile
= alloca (20);
961 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
962 strcat (tempfile
, "/");
963 if ('/' == DIRECTORY_SEP
)
964 dostounix_filename (tempfile
);
966 unixtodos_filename (tempfile
);
968 strcat (tempfile
, "emXXXXXX");
970 strcat (tempfile
, "detmp.XXX");
972 #else /* not DOS_NT */
973 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
974 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
975 SBYTES (Vtemp_file_name_pattern
) + 1);
976 #endif /* not DOS_NT */
982 int fd
= mkstemp (tempfile
);
984 report_file_error ("Failed to open temporary file",
985 Fcons (Vtemp_file_name_pattern
, Qnil
));
993 filename_string
= build_string (tempfile
);
994 GCPRO1 (filename_string
);
997 /* Decide coding-system of the contents of the temporary file. */
998 if (!NILP (Vcoding_system_for_write
))
999 val
= Vcoding_system_for_write
;
1000 else if (NILP (current_buffer
->enable_multibyte_characters
))
1004 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
1005 args2
[0] = Qcall_process_region
;
1006 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
1007 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1008 if (CONSP (coding_systems
))
1009 val
= XCDR (coding_systems
);
1010 else if (CONSP (Vdefault_process_coding_system
))
1011 val
= XCDR (Vdefault_process_coding_system
);
1017 int count1
= SPECPDL_INDEX ();
1019 specbind (intern ("coding-system-for-write"), val
);
1020 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1021 happen to get a ".Z" suffix. */
1022 specbind (intern ("file-name-handler-alist"), Qnil
);
1023 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
1025 unbind_to (count1
, Qnil
);
1028 /* Note that Fcall_process takes care of binding
1029 coding-system-for-read. */
1031 record_unwind_protect (delete_temp_file
, filename_string
);
1033 if (nargs
> 3 && !NILP (args
[3]))
1034 Fdelete_region (start
, end
);
1046 args
[1] = filename_string
;
1048 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1051 #ifndef VMS /* VMS version is in vmsproc.c. */
1053 static int relocate_fd ();
1055 /* This is the last thing run in a newly forked inferior
1056 either synchronous or asynchronous.
1057 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1058 Initialize inferior's priority, pgrp, connected dir and environment.
1059 then exec another program based on new_argv.
1061 This function may change environ for the superior process.
1062 Therefore, the superior process must save and restore the value
1063 of environ around the vfork and the call to this function.
1065 SET_PGRP is nonzero if we should put the subprocess into a separate
1068 CURRENT_DIR is an elisp string giving the path of the current
1069 directory the subprocess should have. Since we can't really signal
1070 a decent error from within the child, this should be verified as an
1071 executable directory by the parent. */
1074 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1076 register char **new_argv
;
1078 Lisp_Object current_dir
;
1085 #endif /* WINDOWSNT */
1087 int pid
= getpid ();
1089 #ifdef SET_EMACS_PRIORITY
1091 extern EMACS_INT emacs_priority
;
1093 if (emacs_priority
< 0)
1094 nice (- emacs_priority
);
1099 /* Close Emacs's descriptors that this process should not have. */
1100 close_process_descs ();
1102 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1103 we will lose if we call close_load_descs here. */
1105 close_load_descs ();
1108 /* Note that use of alloca is always safe here. It's obvious for systems
1109 that do not have true vfork or that have true (stack) alloca.
1110 If using vfork and C_ALLOCA it is safe because that changes
1111 the superior's static variables as if the superior had done alloca
1112 and will be cleaned up in the usual way. */
1114 register char *temp
;
1117 i
= SBYTES (current_dir
);
1119 /* MSDOS must have all environment variables malloc'ed, because
1120 low-level libc functions that launch subsidiary processes rely
1122 pwd_var
= (char *) xmalloc (i
+ 6);
1124 pwd_var
= (char *) alloca (i
+ 6);
1127 bcopy ("PWD=", pwd_var
, 4);
1128 bcopy (SDATA (current_dir
), temp
, i
);
1129 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1133 /* We can't signal an Elisp error here; we're in a vfork. Since
1134 the callers check the current directory before forking, this
1135 should only return an error if the directory's permissions
1136 are changed between the check and this chdir, but we should
1138 if (chdir (temp
) < 0)
1143 /* Get past the drive letter, so that d:/ is left alone. */
1144 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1151 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1152 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1156 /* Set `env' to a vector of the strings in Vprocess_environment. */
1158 register Lisp_Object tem
;
1159 register char **new_env
;
1160 register int new_length
;
1163 for (tem
= Vprocess_environment
;
1164 CONSP (tem
) && STRINGP (XCAR (tem
));
1168 /* new_length + 2 to include PWD and terminating 0. */
1169 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1171 /* If we have a PWD envvar, pass one down,
1172 but with corrected value. */
1174 *new_env
++ = pwd_var
;
1176 /* Copy the Vprocess_environment strings into new_env. */
1177 for (tem
= Vprocess_environment
;
1178 CONSP (tem
) && STRINGP (XCAR (tem
));
1182 char *string
= (char *) SDATA (XCAR (tem
));
1183 /* See if this string duplicates any string already in the env.
1184 If so, don't put it in.
1185 When an env var has multiple definitions,
1186 we keep the definition that comes first in process-environment. */
1187 for (; ep
!= new_env
; ep
++)
1189 char *p
= *ep
, *q
= string
;
1193 /* The string is malformed; might as well drop it. */
1202 *new_env
++ = string
;
1208 prepare_standard_handles (in
, out
, err
, handles
);
1209 set_process_dir (SDATA (current_dir
));
1210 #else /* not WINDOWSNT */
1211 /* Make sure that in, out, and err are not actually already in
1212 descriptors zero, one, or two; this could happen if Emacs is
1213 started with its standard in, out, or error closed, as might
1216 int oin
= in
, oout
= out
;
1218 /* We have to avoid relocating the same descriptor twice! */
1220 in
= relocate_fd (in
, 3);
1225 out
= relocate_fd (out
, 3);
1229 else if (err
== oout
)
1232 err
= relocate_fd (err
, 3);
1246 #endif /* not MSDOS */
1247 #endif /* not WINDOWSNT */
1249 #if defined(USG) && !defined(BSD_PGRPS)
1250 #ifndef SETPGRP_RELEASES_CTTY
1251 setpgrp (); /* No arguments but equivalent in this case */
1256 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1257 EMACS_SET_TTY_PGRP (0, &pid
);
1260 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1263 /* An error occurred while trying to run the subprocess. */
1264 report_file_error ("Spawning child process", Qnil
);
1266 #else /* not MSDOS */
1268 /* Spawn the child. (See ntproc.c:Spawnve). */
1269 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1270 reset_standard_handles (in
, out
, err
, handles
);
1272 /* An error occurred while trying to spawn the process. */
1273 report_file_error ("Spawning child process", Qnil
);
1275 #else /* not WINDOWSNT */
1276 /* execvp does not accept an environment arg so the only way
1277 to pass this environment is to set environ. Our caller
1278 is responsible for restoring the ambient value of environ. */
1280 execvp (new_argv
[0], new_argv
);
1282 emacs_write (1, "Can't exec program: ", 20);
1283 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1284 emacs_write (1, "\n", 1);
1286 #endif /* not WINDOWSNT */
1287 #endif /* not MSDOS */
1290 /* Move the file descriptor FD so that its number is not less than MINFD.
1291 If the file descriptor is moved at all, the original is freed. */
1293 relocate_fd (fd
, minfd
)
1303 char *message1
= "Error while setting up child: ";
1304 char *errmessage
= strerror (errno
);
1305 char *message2
= "\n";
1306 emacs_write (2, message1
, strlen (message1
));
1307 emacs_write (2, errmessage
, strlen (errmessage
));
1308 emacs_write (2, message2
, strlen (message2
));
1311 /* Note that we hold the original FD open while we recurse,
1312 to guarantee we'll get a new FD if we need it. */
1313 new = relocate_fd (new, minfd
);
1320 getenv_internal (var
, varlen
, value
, valuelen
)
1328 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCDR (scan
))
1332 entry
= XCAR (scan
);
1334 && SBYTES (entry
) > varlen
1335 && SREF (entry
, varlen
) == '='
1337 /* NT environment variables are case insensitive. */
1338 && ! strnicmp (SDATA (entry
), var
, varlen
)
1339 #else /* not WINDOWSNT */
1340 && ! bcmp (SDATA (entry
), var
, varlen
)
1341 #endif /* not WINDOWSNT */
1344 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1345 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1353 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 1, 0,
1354 doc
: /* Return the value of environment variable VAR, as a string.
1355 VAR should be a string. Value is nil if VAR is undefined in the environment.
1356 This function consults the variable ``process-environment'' for its value. */)
1364 if (getenv_internal (SDATA (var
), SBYTES (var
),
1366 return make_string (value
, valuelen
);
1371 /* A version of getenv that consults process_environment, easily
1380 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
1386 #endif /* not VMS */
1388 /* This is run before init_cmdargs. */
1393 char *data_dir
= egetenv ("EMACSDATA");
1394 char *doc_dir
= egetenv ("EMACSDOC");
1397 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1400 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1403 /* Check the EMACSPATH environment variable, defaulting to the
1404 PATH_EXEC path from epaths.h. */
1405 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1406 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1407 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1410 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1415 char *data_dir
= egetenv ("EMACSDATA");
1418 Lisp_Object tempdir
;
1420 if (!NILP (Vinstallation_directory
))
1422 /* Add to the path the lib-src subdir of the installation dir. */
1424 tem
= Fexpand_file_name (build_string ("lib-src"),
1425 Vinstallation_directory
);
1427 /* MSDOS uses wrapped binaries, so don't do this. */
1428 if (NILP (Fmember (tem
, Vexec_path
)))
1430 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1431 Vexec_path
= Fcons (tem
, Vexec_path
);
1432 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1435 Vexec_directory
= Ffile_name_as_directory (tem
);
1436 #endif /* not DOS_NT */
1438 /* Maybe use ../etc as well as ../lib-src. */
1441 tem
= Fexpand_file_name (build_string ("etc"),
1442 Vinstallation_directory
);
1443 Vdoc_directory
= Ffile_name_as_directory (tem
);
1447 /* Look for the files that should be in etc. We don't use
1448 Vinstallation_directory, because these files are never installed
1449 near the executable, and they are never in the build
1450 directory when that's different from the source directory.
1452 Instead, if these files are not in the nominal place, we try the
1453 source directory. */
1456 Lisp_Object tem
, tem1
, srcdir
;
1458 srcdir
= Fexpand_file_name (build_string ("../src/"),
1459 build_string (PATH_DUMPLOADSEARCH
));
1460 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1461 tem1
= Ffile_exists_p (tem
);
1462 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1465 newdir
= Fexpand_file_name (build_string ("../etc/"),
1466 build_string (PATH_DUMPLOADSEARCH
));
1467 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1468 tem1
= Ffile_exists_p (tem
);
1470 Vdata_directory
= newdir
;
1478 tempdir
= Fdirectory_file_name (Vexec_directory
);
1479 if (access (SDATA (tempdir
), 0) < 0)
1480 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1484 tempdir
= Fdirectory_file_name (Vdata_directory
);
1485 if (access (SDATA (tempdir
), 0) < 0)
1486 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1490 Vshell_file_name
= build_string ("*dcl*");
1492 sh
= (char *) getenv ("SHELL");
1493 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1497 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1499 if (getenv ("TMPDIR"))
1501 char *dir
= getenv ("TMPDIR");
1502 Vtemp_file_name_pattern
1503 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1504 build_string (dir
));
1507 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1511 Vshared_game_score_directory
= Qnil
;
1513 Vshared_game_score_directory
= build_string (PATH_GAME
);
1514 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1515 Vshared_game_score_directory
= Qnil
;
1520 set_process_environment ()
1522 register char **envp
;
1524 Vprocess_environment
= Qnil
;
1528 for (envp
= environ
; *envp
; envp
++)
1529 Vprocess_environment
= Fcons (build_string (*envp
),
1530 Vprocess_environment
);
1537 Qbuffer_file_type
= intern ("buffer-file-type");
1538 staticpro (&Qbuffer_file_type
);
1541 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1542 doc
: /* *File name to load inferior shells from.
1543 Initialized from the SHELL environment variable. */);
1545 DEFVAR_LISP ("exec-path", &Vexec_path
,
1546 doc
: /* *List of directories to search programs to run in subprocesses.
1547 Each element is a string (directory name) or nil (try default directory). */);
1549 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1550 doc
: /* *List of suffixes to try to find executable file names.
1551 Each element is a string. */);
1552 Vexec_suffixes
= Qnil
;
1554 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1555 doc
: /* Directory for executables for Emacs to invoke.
1556 More generally, this includes any architecture-dependent files
1557 that are built and installed from the Emacs distribution. */);
1559 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1560 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1561 These are files intended for Emacs to use while it runs. */);
1563 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1564 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1565 This is usually the same as data-directory. */);
1567 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1568 doc
: /* For internal use by the build procedure only.
1569 This is the name of the directory in which the build procedure installed
1570 Emacs's info files; the default value for Info-default-directory-list
1572 Vconfigure_info_directory
= build_string (PATH_INFO
);
1574 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1575 doc
: /* Directory of score files for games which come with GNU Emacs.
1576 If this variable is nil, then Emacs is unable to use a shared directory. */);
1578 Vshared_game_score_directory
= Qnil
;
1580 Vshared_game_score_directory
= build_string (PATH_GAME
);
1583 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1584 doc
: /* Pattern for making names for temporary files.
1585 This is used by `call-process-region'. */);
1586 /* This variable is initialized in init_callproc. */
1588 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1589 doc
: /* List of environment variables for subprocesses to inherit.
1590 Each element should be a string of the form ENVVARNAME=VALUE.
1591 If multiple entries define the same variable, the first one always
1593 The environment which Emacs inherits is placed in this variable
1595 Non-ASCII characters are encoded according to the initial value of
1596 `locale-coding-system', i.e. the elements must normally be decoded for use.
1597 See `setenv' and `getenv'. */);
1600 defsubr (&Scall_process
);
1601 defsubr (&Sgetenv_internal
);
1603 defsubr (&Scall_process_region
);
1606 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1607 (do not change this comment) */