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., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, 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
;
360 current_dir
= current_buffer
->directory
;
362 GCPRO3 (infile
, buffer
, current_dir
);
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
));
374 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
376 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
379 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
381 /* Search for program; barf if not found. */
385 GCPRO1 (current_dir
);
386 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
391 emacs_close (filefd
);
392 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
395 /* If program file name starts with /: for quoting a magic name,
397 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
398 && SREF (path
, 1) == ':')
399 path
= Fsubstring (path
, make_number (2), Qnil
);
401 new_argv
[0] = SDATA (path
);
405 struct gcpro gcpro1
, gcpro2
, gcpro3
;
407 GCPRO3 (infile
, buffer
, current_dir
);
408 argument_coding
.dst_multibyte
= 0;
409 for (i
= 4; i
< nargs
; i
++)
411 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
412 if (CODING_REQUIRE_ENCODING (&argument_coding
))
413 /* We must encode this argument. */
414 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
415 new_argv
[i
- 3] = SDATA (args
[i
]);
418 new_argv
[nargs
- 3] = 0;
423 #ifdef MSDOS /* MW, July 1993 */
424 if ((outf
= egetenv ("TMPDIR")))
425 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
428 tempfile
= alloca (20);
431 dostounix_filename (tempfile
);
432 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
433 strcat (tempfile
, "/");
434 strcat (tempfile
, "detmp.XXX");
437 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
440 emacs_close (filefd
);
441 report_file_error ("Opening process output file",
442 Fcons (build_string (tempfile
), Qnil
));
449 /* Since we don't have pipes on the Mac, create a temporary file to
450 hold the output of the subprocess. */
451 tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
452 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
453 SBYTES (Vtemp_file_name_pattern
) + 1);
457 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
461 report_file_error ("Opening process output file",
462 Fcons (build_string (tempfile
), Qnil
));
468 if (INTEGERP (buffer
))
469 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
477 emacs_close (filefd
);
478 report_file_error ("Creating process pipe", Qnil
);
483 /* Replaced by close_process_descs */
484 set_exclusive_use (fd
[0]);
489 /* child_setup must clobber environ in systems with true vfork.
490 Protect it from permanent change. */
491 register char **save_environ
= environ
;
492 register int fd1
= fd
[1];
495 #if 0 /* Some systems don't have sigblock. */
496 mask
= sigblock (sigmask (SIGCHLD
));
499 /* Record that we're about to create a synchronous process. */
500 synch_process_alive
= 1;
502 /* These vars record information from process termination.
503 Clear them now before process can possibly terminate,
504 to avoid timing error if process terminates soon. */
505 synch_process_death
= 0;
506 synch_process_retcode
= 0;
507 synch_process_termsig
= 0;
509 if (NILP (error_file
))
510 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
511 else if (STRINGP (error_file
))
514 fd_error
= emacs_open (SDATA (error_file
),
515 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
517 #else /* not DOS_NT */
518 fd_error
= creat (SDATA (error_file
), 0666);
519 #endif /* not DOS_NT */
524 emacs_close (filefd
);
532 report_file_error ("Cannot redirect stderr",
533 Fcons ((NILP (error_file
)
534 ? build_string (NULL_DEVICE
) : error_file
),
538 current_dir
= ENCODE_FILE (current_dir
);
542 /* Call run_mac_command in sysdep.c here directly instead of doing
543 a child_setup as for MSDOS and other platforms. Note that this
544 code does not handle passing the environment to the synchronous
546 char *infn
, *outfn
, *errfn
, *currdn
;
548 /* close these files so subprocess can write to them */
550 if (fd_error
!= outfilefd
)
552 fd1
= -1; /* No harm in closing that one! */
554 infn
= SDATA (infile
);
556 if (NILP (error_file
))
558 else if (EQ (Qt
, error_file
))
561 errfn
= SDATA (error_file
);
562 currdn
= SDATA (current_dir
);
563 pid
= run_mac_command (new_argv
, currdn
, infn
, outfn
, errfn
);
565 /* Record that the synchronous process exited and note its
566 termination status. */
567 synch_process_alive
= 0;
568 synch_process_retcode
= pid
;
569 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
571 synchronize_system_messages_locale ();
572 synch_process_death
= strerror (errno
);
575 /* Since CRLF is converted to LF within `decode_coding', we can
576 always open a file with binary mode. */
577 fd
[0] = open (tempfile
, O_BINARY
);
582 report_file_error ("Cannot re-open temporary file", Qnil
);
585 #else /* not MAC_OS8 */
586 #ifdef MSDOS /* MW, July 1993 */
587 /* Note that on MSDOS `child_setup' actually returns the child process
588 exit status, not its PID, so we assign it to `synch_process_retcode'
590 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
593 /* Record that the synchronous process exited and note its
594 termination status. */
595 synch_process_alive
= 0;
596 synch_process_retcode
= pid
;
597 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
599 synchronize_system_messages_locale ();
600 synch_process_death
= strerror (errno
);
603 emacs_close (outfilefd
);
604 if (fd_error
!= outfilefd
)
605 emacs_close (fd_error
);
606 fd1
= -1; /* No harm in closing that one! */
607 /* Since CRLF is converted to LF within `decode_coding', we can
608 always open a file with binary mode. */
609 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
613 emacs_close (filefd
);
614 report_file_error ("Cannot re-open temporary file", Qnil
);
616 #else /* not MSDOS */
618 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
620 #else /* not WINDOWSNT */
632 #if defined (USG) && !defined (BSD_PGRPS)
637 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
642 #endif /* not WINDOWSNT */
644 /* The MSDOS case did this already. */
646 emacs_close (fd_error
);
647 #endif /* not MSDOS */
648 #endif /* not MAC_OS8 */
650 environ
= save_environ
;
652 /* Close most of our fd's, but not fd[0]
653 since we will use that to read input from. */
654 emacs_close (filefd
);
655 if (fd1
>= 0 && fd1
!= fd_error
)
663 report_file_error ("Doing vfork", Qnil
);
666 if (INTEGERP (buffer
))
671 /* If Emacs has been built with asynchronous subprocess support,
672 we don't need to do this, I think because it will then have
673 the facilities for handling SIGCHLD. */
674 wait_without_blocking ();
675 #endif /* subprocesses */
679 /* Enable sending signal if user quits below. */
680 call_process_exited
= 0;
682 #if defined(MSDOS) || defined(MAC_OS8)
683 /* MSDOS needs different cleanup information. */
684 record_unwind_protect (call_process_cleanup
,
685 Fcons (make_number (fd
[0]), build_string (tempfile
)));
687 record_unwind_protect (call_process_cleanup
,
688 Fcons (make_number (fd
[0]), make_number (pid
)));
689 #endif /* not MSDOS and not MAC_OS8 */
692 if (BUFFERP (buffer
))
693 Fset_buffer (buffer
);
697 /* If BUFFER is nil, we must read process output once and then
698 discard it, so setup coding system but with nil. */
699 setup_coding_system (Qnil
, &process_coding
);
703 Lisp_Object val
, *args2
;
706 if (!NILP (Vcoding_system_for_read
))
707 val
= Vcoding_system_for_read
;
710 if (EQ (coding_systems
, Qt
))
714 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
715 args2
[0] = Qcall_process
;
716 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
718 = Ffind_operation_coding_system (nargs
+ 1, args2
);
720 if (CONSP (coding_systems
))
721 val
= XCAR (coding_systems
);
722 else if (CONSP (Vdefault_process_coding_system
))
723 val
= XCAR (Vdefault_process_coding_system
);
727 Fcheck_coding_system (val
);
728 /* In unibyte mode, character code conversion should not take
729 place but EOL conversion should. So, setup raw-text or one
730 of the subsidiary according to the information just setup. */
731 if (NILP (current_buffer
->enable_multibyte_characters
)
733 val
= raw_text_coding_system (val
);
734 setup_coding_system (val
, &process_coding
);
745 int display_on_the_fly
= display_p
;
746 struct coding_system saved_coding
;
748 saved_coding
= process_coding
;
751 /* Repeatedly read until we've filled as much as possible
752 of the buffer size we have. But don't read
753 less than 1024--save that for the next bufferful. */
755 while (nread
< bufsize
- 1024)
757 int this_read
= emacs_read (fd
[0], buf
+ nread
,
765 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
770 total_read
+= this_read
;
772 if (display_on_the_fly
)
776 /* Now NREAD is the total amount of data in the buffer. */
781 if (NILP (current_buffer
->enable_multibyte_characters
)
782 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
783 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
785 { /* We have to decode the input. */
788 XSETBUFFER (buf
, current_buffer
);
789 decode_coding_c_string (&process_coding
, bufptr
, nread
,
791 if (display_on_the_fly
792 && CODING_REQUIRE_DETECTION (&saved_coding
)
793 && ! CODING_REQUIRE_DETECTION (&process_coding
))
795 /* We have detected some coding system. But,
796 there's a possibility that the detection was
797 done by insufficient data. So, we give up
798 displaying on the fly. */
799 if (process_coding
.produced
> 0)
800 del_range_2 (process_coding
.dst_pos
,
801 process_coding
.dst_pos_byte
,
802 process_coding
.dst_pos
803 + process_coding
.produced_char
,
804 process_coding
.dst_pos_byte
805 + process_coding
.produced
, 0);
806 display_on_the_fly
= 0;
807 process_coding
= saved_coding
;
809 /* This is to make the above condition always
810 fails in the future. */
811 saved_coding
.common_flags
812 &= ~CODING_REQUIRE_DETECTION_MASK
;
816 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
817 PT_BYTE
+ process_coding
.produced
);
818 carryover
= process_coding
.carryover_bytes
;
820 /* As CARRYOVER should not be that large, we had
821 better avoid overhead of bcopy. */
822 BCOPY_SHORT (process_coding
.carryover
, bufptr
,
823 process_coding
.carryover_bytes
);
827 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
830 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
831 /* Make the buffer bigger as we continue to read more data,
832 but not past CALLPROC_BUFFER_SIZE_MAX. */
833 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
834 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
835 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
841 prepare_menu_bars ();
843 redisplay_preserve_echo_area (1);
844 /* This variable might have been set to 0 for code
845 detection. In that case, we set it back to 1 because
846 we should have already detected a coding system. */
847 display_on_the_fly
= 1;
854 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
855 /* If the caller required, let the buffer inherit the
856 coding-system used to decode the process output. */
857 if (inherit_process_coding_system
)
858 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
859 make_number (total_read
));
862 /* Wait for it to terminate, unless it already has. */
863 wait_for_termination (pid
);
867 set_buffer_internal (old
);
869 /* Don't kill any children that the subprocess may have left behind
871 call_process_exited
= 1;
873 unbind_to (count
, Qnil
);
875 if (synch_process_termsig
)
879 synchronize_system_messages_locale ();
880 signame
= strsignal (synch_process_termsig
);
885 synch_process_death
= signame
;
888 if (synch_process_death
)
889 return code_convert_string_norecord (build_string (synch_process_death
),
890 Vlocale_coding_system
, 0);
891 return make_number (synch_process_retcode
);
896 delete_temp_file (name
)
899 /* Use Fdelete_file (indirectly) because that runs a file name handler.
900 We did that when writing the file, so we should do so when deleting. */
901 internal_delete_file (name
);
905 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
907 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
908 The remaining arguments are optional.
909 Delete the text if fourth arg DELETE is non-nil.
911 Insert output in BUFFER before point; t means current buffer;
912 nil for BUFFER means discard it; 0 means discard and don't wait.
913 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
914 REAL-BUFFER says what to do with standard output, as above,
915 while STDERR-FILE says what to do with standard error in the child.
916 STDERR-FILE may be nil (discard standard error output),
917 t (mix it with ordinary output), or a file name string.
919 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
920 Remaining args are passed to PROGRAM at startup as command args.
922 If BUFFER is 0, `call-process-region' returns immediately with value nil.
923 Otherwise it waits for PROGRAM to terminate
924 and returns a numeric exit status or a signal description string.
925 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
927 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
930 register Lisp_Object
*args
;
933 Lisp_Object filename_string
;
934 register Lisp_Object start
, end
;
935 int count
= SPECPDL_INDEX ();
936 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
937 Lisp_Object coding_systems
;
938 Lisp_Object val
, *args2
;
944 if ((outf
= egetenv ("TMPDIR"))
945 || (outf
= egetenv ("TMP"))
946 || (outf
= egetenv ("TEMP")))
947 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
950 tempfile
= alloca (20);
953 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
954 strcat (tempfile
, "/");
955 if ('/' == DIRECTORY_SEP
)
956 dostounix_filename (tempfile
);
958 unixtodos_filename (tempfile
);
960 strcat (tempfile
, "emXXXXXX");
962 strcat (tempfile
, "detmp.XXX");
964 #else /* not DOS_NT */
965 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
966 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
967 SBYTES (Vtemp_file_name_pattern
) + 1);
968 #endif /* not DOS_NT */
974 int fd
= mkstemp (tempfile
);
976 report_file_error ("Failed to open temporary file",
977 Fcons (Vtemp_file_name_pattern
, Qnil
));
985 filename_string
= build_string (tempfile
);
986 GCPRO1 (filename_string
);
989 /* Decide coding-system of the contents of the temporary file. */
990 if (!NILP (Vcoding_system_for_write
))
991 val
= Vcoding_system_for_write
;
992 else if (NILP (current_buffer
->enable_multibyte_characters
))
996 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
997 args2
[0] = Qcall_process_region
;
998 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
999 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1000 if (CONSP (coding_systems
))
1001 val
= XCDR (coding_systems
);
1002 else if (CONSP (Vdefault_process_coding_system
))
1003 val
= XCDR (Vdefault_process_coding_system
);
1009 int count1
= SPECPDL_INDEX ();
1011 specbind (intern ("coding-system-for-write"), val
);
1012 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
1014 unbind_to (count1
, Qnil
);
1017 /* Note that Fcall_process takes care of binding
1018 coding-system-for-read. */
1020 record_unwind_protect (delete_temp_file
, filename_string
);
1022 if (nargs
> 3 && !NILP (args
[3]))
1023 Fdelete_region (start
, end
);
1035 args
[1] = filename_string
;
1037 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1040 #ifndef VMS /* VMS version is in vmsproc.c. */
1042 static int relocate_fd ();
1044 /* This is the last thing run in a newly forked inferior
1045 either synchronous or asynchronous.
1046 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1047 Initialize inferior's priority, pgrp, connected dir and environment.
1048 then exec another program based on new_argv.
1050 This function may change environ for the superior process.
1051 Therefore, the superior process must save and restore the value
1052 of environ around the vfork and the call to this function.
1054 SET_PGRP is nonzero if we should put the subprocess into a separate
1057 CURRENT_DIR is an elisp string giving the path of the current
1058 directory the subprocess should have. Since we can't really signal
1059 a decent error from within the child, this should be verified as an
1060 executable directory by the parent. */
1063 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1065 register char **new_argv
;
1067 Lisp_Object current_dir
;
1074 #endif /* WINDOWSNT */
1076 int pid
= getpid ();
1078 #ifdef SET_EMACS_PRIORITY
1080 extern EMACS_INT emacs_priority
;
1082 if (emacs_priority
< 0)
1083 nice (- emacs_priority
);
1088 /* Close Emacs's descriptors that this process should not have. */
1089 close_process_descs ();
1091 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1092 we will lose if we call close_load_descs here. */
1094 close_load_descs ();
1097 /* Note that use of alloca is always safe here. It's obvious for systems
1098 that do not have true vfork or that have true (stack) alloca.
1099 If using vfork and C_ALLOCA it is safe because that changes
1100 the superior's static variables as if the superior had done alloca
1101 and will be cleaned up in the usual way. */
1103 register char *temp
;
1106 i
= SBYTES (current_dir
);
1108 /* MSDOS must have all environment variables malloc'ed, because
1109 low-level libc functions that launch subsidiary processes rely
1111 pwd_var
= (char *) xmalloc (i
+ 6);
1113 pwd_var
= (char *) alloca (i
+ 6);
1116 bcopy ("PWD=", pwd_var
, 4);
1117 bcopy (SDATA (current_dir
), temp
, i
);
1118 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1122 /* We can't signal an Elisp error here; we're in a vfork. Since
1123 the callers check the current directory before forking, this
1124 should only return an error if the directory's permissions
1125 are changed between the check and this chdir, but we should
1127 if (chdir (temp
) < 0)
1132 /* Get past the drive letter, so that d:/ is left alone. */
1133 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1140 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1141 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1145 /* Set `env' to a vector of the strings in Vprocess_environment. */
1147 register Lisp_Object tem
;
1148 register char **new_env
;
1149 register int new_length
;
1152 for (tem
= Vprocess_environment
;
1153 CONSP (tem
) && STRINGP (XCAR (tem
));
1157 /* new_length + 2 to include PWD and terminating 0. */
1158 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1160 /* If we have a PWD envvar, pass one down,
1161 but with corrected value. */
1163 *new_env
++ = pwd_var
;
1165 /* Copy the Vprocess_environment strings into new_env. */
1166 for (tem
= Vprocess_environment
;
1167 CONSP (tem
) && STRINGP (XCAR (tem
));
1171 char *string
= (char *) SDATA (XCAR (tem
));
1172 /* See if this string duplicates any string already in the env.
1173 If so, don't put it in.
1174 When an env var has multiple definitions,
1175 we keep the definition that comes first in process-environment. */
1176 for (; ep
!= new_env
; ep
++)
1178 char *p
= *ep
, *q
= string
;
1182 /* The string is malformed; might as well drop it. */
1191 *new_env
++ = string
;
1197 prepare_standard_handles (in
, out
, err
, handles
);
1198 set_process_dir (SDATA (current_dir
));
1199 #else /* not WINDOWSNT */
1200 /* Make sure that in, out, and err are not actually already in
1201 descriptors zero, one, or two; this could happen if Emacs is
1202 started with its standard in, out, or error closed, as might
1205 int oin
= in
, oout
= out
;
1207 /* We have to avoid relocating the same descriptor twice! */
1209 in
= relocate_fd (in
, 3);
1214 out
= relocate_fd (out
, 3);
1218 else if (err
== oout
)
1221 err
= relocate_fd (err
, 3);
1235 #endif /* not MSDOS */
1236 #endif /* not WINDOWSNT */
1238 #if defined(USG) && !defined(BSD_PGRPS)
1239 #ifndef SETPGRP_RELEASES_CTTY
1240 setpgrp (); /* No arguments but equivalent in this case */
1245 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1246 EMACS_SET_TTY_PGRP (0, &pid
);
1249 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1252 /* An error occurred while trying to run the subprocess. */
1253 report_file_error ("Spawning child process", Qnil
);
1255 #else /* not MSDOS */
1257 /* Spawn the child. (See ntproc.c:Spawnve). */
1258 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1259 reset_standard_handles (in
, out
, err
, handles
);
1261 /* An error occurred while trying to spawn the process. */
1262 report_file_error ("Spawning child process", Qnil
);
1264 #else /* not WINDOWSNT */
1265 /* execvp does not accept an environment arg so the only way
1266 to pass this environment is to set environ. Our caller
1267 is responsible for restoring the ambient value of environ. */
1269 execvp (new_argv
[0], new_argv
);
1271 emacs_write (1, "Can't exec program: ", 20);
1272 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1273 emacs_write (1, "\n", 1);
1275 #endif /* not WINDOWSNT */
1276 #endif /* not MSDOS */
1279 /* Move the file descriptor FD so that its number is not less than MINFD.
1280 If the file descriptor is moved at all, the original is freed. */
1282 relocate_fd (fd
, minfd
)
1292 char *message1
= "Error while setting up child: ";
1293 char *errmessage
= strerror (errno
);
1294 char *message2
= "\n";
1295 emacs_write (2, message1
, strlen (message1
));
1296 emacs_write (2, errmessage
, strlen (errmessage
));
1297 emacs_write (2, message2
, strlen (message2
));
1300 /* Note that we hold the original FD open while we recurse,
1301 to guarantee we'll get a new FD if we need it. */
1302 new = relocate_fd (new, minfd
);
1309 getenv_internal (var
, varlen
, value
, valuelen
)
1317 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCDR (scan
))
1321 entry
= XCAR (scan
);
1323 && SBYTES (entry
) > varlen
1324 && SREF (entry
, varlen
) == '='
1326 /* NT environment variables are case insensitive. */
1327 && ! strnicmp (SDATA (entry
), var
, varlen
)
1328 #else /* not WINDOWSNT */
1329 && ! bcmp (SDATA (entry
), var
, varlen
)
1330 #endif /* not WINDOWSNT */
1333 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1334 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1342 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 1, 0,
1343 doc
: /* Return the value of environment variable VAR, as a string.
1344 VAR should be a string. Value is nil if VAR is undefined in the environment.
1345 This function consults the variable ``process-environment'' for its value. */)
1353 if (getenv_internal (SDATA (var
), SBYTES (var
),
1355 return make_string (value
, valuelen
);
1360 /* A version of getenv that consults process_environment, easily
1369 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
1375 #endif /* not VMS */
1377 /* This is run before init_cmdargs. */
1382 char *data_dir
= egetenv ("EMACSDATA");
1383 char *doc_dir
= egetenv ("EMACSDOC");
1386 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1389 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1392 /* Check the EMACSPATH environment variable, defaulting to the
1393 PATH_EXEC path from epaths.h. */
1394 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1395 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1396 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1399 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1404 char *data_dir
= egetenv ("EMACSDATA");
1407 Lisp_Object tempdir
;
1409 if (!NILP (Vinstallation_directory
))
1411 /* Add to the path the lib-src subdir of the installation dir. */
1413 tem
= Fexpand_file_name (build_string ("lib-src"),
1414 Vinstallation_directory
);
1416 /* MSDOS uses wrapped binaries, so don't do this. */
1417 if (NILP (Fmember (tem
, Vexec_path
)))
1419 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1420 Vexec_path
= Fcons (tem
, Vexec_path
);
1421 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1424 Vexec_directory
= Ffile_name_as_directory (tem
);
1425 #endif /* not DOS_NT */
1427 /* Maybe use ../etc as well as ../lib-src. */
1430 tem
= Fexpand_file_name (build_string ("etc"),
1431 Vinstallation_directory
);
1432 Vdoc_directory
= Ffile_name_as_directory (tem
);
1436 /* Look for the files that should be in etc. We don't use
1437 Vinstallation_directory, because these files are never installed
1438 near the executable, and they are never in the build
1439 directory when that's different from the source directory.
1441 Instead, if these files are not in the nominal place, we try the
1442 source directory. */
1445 Lisp_Object tem
, tem1
, srcdir
;
1447 srcdir
= Fexpand_file_name (build_string ("../src/"),
1448 build_string (PATH_DUMPLOADSEARCH
));
1449 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1450 tem1
= Ffile_exists_p (tem
);
1451 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1454 newdir
= Fexpand_file_name (build_string ("../etc/"),
1455 build_string (PATH_DUMPLOADSEARCH
));
1456 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1457 tem1
= Ffile_exists_p (tem
);
1459 Vdata_directory
= newdir
;
1467 tempdir
= Fdirectory_file_name (Vexec_directory
);
1468 if (access (SDATA (tempdir
), 0) < 0)
1469 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1473 tempdir
= Fdirectory_file_name (Vdata_directory
);
1474 if (access (SDATA (tempdir
), 0) < 0)
1475 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1479 Vshell_file_name
= build_string ("*dcl*");
1481 sh
= (char *) getenv ("SHELL");
1482 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1486 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1488 if (getenv ("TMPDIR"))
1490 char *dir
= getenv ("TMPDIR");
1491 Vtemp_file_name_pattern
1492 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1493 build_string (dir
));
1496 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1500 Vshared_game_score_directory
= Qnil
;
1502 Vshared_game_score_directory
= build_string (PATH_GAME
);
1503 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1504 Vshared_game_score_directory
= Qnil
;
1509 set_process_environment ()
1511 register char **envp
;
1513 Vprocess_environment
= Qnil
;
1517 for (envp
= environ
; *envp
; envp
++)
1518 Vprocess_environment
= Fcons (build_string (*envp
),
1519 Vprocess_environment
);
1526 Qbuffer_file_type
= intern ("buffer-file-type");
1527 staticpro (&Qbuffer_file_type
);
1530 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1531 doc
: /* *File name to load inferior shells from.
1532 Initialized from the SHELL environment variable. */);
1534 DEFVAR_LISP ("exec-path", &Vexec_path
,
1535 doc
: /* *List of directories to search programs to run in subprocesses.
1536 Each element is a string (directory name) or nil (try default directory). */);
1538 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1539 doc
: /* *List of suffixes to try to find executable file names.
1540 Each element is a string. */);
1541 Vexec_suffixes
= Qnil
;
1543 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1544 doc
: /* Directory for executables for Emacs to invoke.
1545 More generally, this includes any architecture-dependent files
1546 that are built and installed from the Emacs distribution. */);
1548 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1549 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1550 These are files intended for Emacs to use while it runs. */);
1552 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1553 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1554 This is usually the same as data-directory. */);
1556 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1557 doc
: /* For internal use by the build procedure only.
1558 This is the name of the directory in which the build procedure installed
1559 Emacs's info files; the default value for Info-default-directory-list
1561 Vconfigure_info_directory
= build_string (PATH_INFO
);
1563 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1564 doc
: /* Directory of score files for games which come with GNU Emacs.
1565 If this variable is nil, then Emacs is unable to use a shared directory. */);
1567 Vshared_game_score_directory
= Qnil
;
1569 Vshared_game_score_directory
= build_string (PATH_GAME
);
1572 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1573 doc
: /* Pattern for making names for temporary files.
1574 This is used by `call-process-region'. */);
1575 /* This variable is initialized in init_callproc. */
1577 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1578 doc
: /* List of environment variables for subprocesses to inherit.
1579 Each element should be a string of the form ENVVARNAME=VALUE.
1580 If multiple entries define the same variable, the first one always
1582 The environment which Emacs inherits is placed in this variable
1584 Non-ASCII characters are encoded according to the initial value of
1585 `locale-coding-system', i.e. the elements must normally be decoded for use.
1586 See `setenv' and `getenv'. */);
1589 defsubr (&Scall_process
);
1590 defsubr (&Sgetenv_internal
);
1592 defsubr (&Scall_process_region
);
1595 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1596 (do not change this comment) */