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 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 val
= coding_inherit_eol_type (val
, Qnil
);
298 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
302 if (nargs
>= 2 && ! NILP (args
[1]))
304 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
305 CHECK_STRING (infile
);
308 infile
= build_string (NULL_DEVICE
);
314 /* If BUFFER is a list, its meaning is
315 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
318 if (CONSP (XCDR (buffer
)))
320 Lisp_Object stderr_file
;
321 stderr_file
= XCAR (XCDR (buffer
));
323 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
324 error_file
= stderr_file
;
326 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
329 buffer
= XCAR (buffer
);
332 if (!(EQ (buffer
, Qnil
)
334 || INTEGERP (buffer
)))
336 Lisp_Object spec_buffer
;
337 spec_buffer
= buffer
;
338 buffer
= Fget_buffer_create (buffer
);
339 /* Mention the buffer name for a better error message. */
341 CHECK_BUFFER (spec_buffer
);
342 CHECK_BUFFER (buffer
);
348 /* Make sure that the child will be able to chdir to the current
349 buffer's current directory, or its unhandled equivalent. We
350 can't just have the child check for an error when it does the
351 chdir, since it's in a vfork.
353 We have to GCPRO around this because Fexpand_file_name,
354 Funhandled_file_name_directory, and Ffile_accessible_directory_p
355 might call a file name handling function. The argument list is
356 protected by the caller, so all we really have to worry about is
359 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
361 current_dir
= current_buffer
->directory
;
363 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
366 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir
),
368 if (NILP (Ffile_accessible_directory_p (current_dir
)))
369 report_file_error ("Setting current directory",
370 Fcons (current_buffer
->directory
, Qnil
));
372 if (STRING_MULTIBYTE (infile
))
373 infile
= ENCODE_FILE (infile
);
374 if (STRING_MULTIBYTE (current_dir
))
375 current_dir
= ENCODE_FILE (current_dir
);
376 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
377 error_file
= ENCODE_FILE (error_file
);
381 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
383 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
386 infile
= DECODE_FILE (infile
);
387 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
389 /* Search for program; barf if not found. */
393 GCPRO1 (current_dir
);
394 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
399 emacs_close (filefd
);
400 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
403 /* If program file name starts with /: for quoting a magic name,
405 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
406 && SREF (path
, 1) == ':')
407 path
= Fsubstring (path
, make_number (2), Qnil
);
409 new_argv
[0] = SDATA (path
);
413 struct gcpro gcpro1
, gcpro2
, gcpro3
;
415 GCPRO3 (infile
, buffer
, current_dir
);
416 argument_coding
.dst_multibyte
= 0;
417 for (i
= 4; i
< nargs
; i
++)
419 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
420 if (CODING_REQUIRE_ENCODING (&argument_coding
))
421 /* We must encode this argument. */
422 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
423 new_argv
[i
- 3] = SDATA (args
[i
]);
426 new_argv
[nargs
- 3] = 0;
431 #ifdef MSDOS /* MW, July 1993 */
432 if ((outf
= egetenv ("TMPDIR")))
433 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
436 tempfile
= alloca (20);
439 dostounix_filename (tempfile
);
440 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
441 strcat (tempfile
, "/");
442 strcat (tempfile
, "detmp.XXX");
445 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
448 emacs_close (filefd
);
449 report_file_error ("Opening process output file",
450 Fcons (build_string (tempfile
), Qnil
));
457 /* Since we don't have pipes on the Mac, create a temporary file to
458 hold the output of the subprocess. */
459 tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
460 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
461 SBYTES (Vtemp_file_name_pattern
) + 1);
465 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
469 report_file_error ("Opening process output file",
470 Fcons (build_string (tempfile
), Qnil
));
476 if (INTEGERP (buffer
))
477 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
485 emacs_close (filefd
);
486 report_file_error ("Creating process pipe", Qnil
);
491 /* Replaced by close_process_descs */
492 set_exclusive_use (fd
[0]);
497 /* child_setup must clobber environ in systems with true vfork.
498 Protect it from permanent change. */
499 register char **save_environ
= environ
;
500 register int fd1
= fd
[1];
503 #if 0 /* Some systems don't have sigblock. */
504 mask
= sigblock (sigmask (SIGCHLD
));
507 /* Record that we're about to create a synchronous process. */
508 synch_process_alive
= 1;
510 /* These vars record information from process termination.
511 Clear them now before process can possibly terminate,
512 to avoid timing error if process terminates soon. */
513 synch_process_death
= 0;
514 synch_process_retcode
= 0;
515 synch_process_termsig
= 0;
517 if (NILP (error_file
))
518 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
519 else if (STRINGP (error_file
))
522 fd_error
= emacs_open (SDATA (error_file
),
523 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
525 #else /* not DOS_NT */
526 fd_error
= creat (SDATA (error_file
), 0666);
527 #endif /* not DOS_NT */
532 emacs_close (filefd
);
540 if (NILP (error_file
))
541 error_file
= build_string (NULL_DEVICE
);
542 else if (STRINGP (error_file
))
543 error_file
= DECODE_FILE (error_file
);
544 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
549 /* Call run_mac_command in sysdep.c here directly instead of doing
550 a child_setup as for MSDOS and other platforms. Note that this
551 code does not handle passing the environment to the synchronous
553 char *infn
, *outfn
, *errfn
, *currdn
;
555 /* close these files so subprocess can write to them */
557 if (fd_error
!= outfilefd
)
559 fd1
= -1; /* No harm in closing that one! */
561 infn
= SDATA (infile
);
563 if (NILP (error_file
))
565 else if (EQ (Qt
, error_file
))
568 errfn
= SDATA (error_file
);
569 currdn
= SDATA (current_dir
);
570 pid
= run_mac_command (new_argv
, currdn
, infn
, outfn
, errfn
);
572 /* Record that the synchronous process exited and note its
573 termination status. */
574 synch_process_alive
= 0;
575 synch_process_retcode
= pid
;
576 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
578 synchronize_system_messages_locale ();
579 synch_process_death
= strerror (errno
);
582 /* Since CRLF is converted to LF within `decode_coding', we can
583 always open a file with binary mode. */
584 fd
[0] = open (tempfile
, O_BINARY
);
589 report_file_error ("Cannot re-open temporary file", Qnil
);
592 #else /* not MAC_OS8 */
593 #ifdef MSDOS /* MW, July 1993 */
594 /* Note that on MSDOS `child_setup' actually returns the child process
595 exit status, not its PID, so we assign it to `synch_process_retcode'
597 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
600 /* Record that the synchronous process exited and note its
601 termination status. */
602 synch_process_alive
= 0;
603 synch_process_retcode
= pid
;
604 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
606 synchronize_system_messages_locale ();
607 synch_process_death
= strerror (errno
);
610 emacs_close (outfilefd
);
611 if (fd_error
!= outfilefd
)
612 emacs_close (fd_error
);
613 fd1
= -1; /* No harm in closing that one! */
614 /* Since CRLF is converted to LF within `decode_coding', we can
615 always open a file with binary mode. */
616 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
620 emacs_close (filefd
);
621 report_file_error ("Cannot re-open temporary file", Qnil
);
623 #else /* not MSDOS */
625 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
627 #else /* not WINDOWSNT */
639 #if defined (USG) && !defined (BSD_PGRPS)
644 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
649 #endif /* not WINDOWSNT */
651 /* The MSDOS case did this already. */
653 emacs_close (fd_error
);
654 #endif /* not MSDOS */
655 #endif /* not MAC_OS8 */
657 environ
= save_environ
;
659 /* Close most of our fd's, but not fd[0]
660 since we will use that to read input from. */
661 emacs_close (filefd
);
662 if (fd1
>= 0 && fd1
!= fd_error
)
670 report_file_error ("Doing vfork", Qnil
);
673 if (INTEGERP (buffer
))
678 /* If Emacs has been built with asynchronous subprocess support,
679 we don't need to do this, I think because it will then have
680 the facilities for handling SIGCHLD. */
681 wait_without_blocking ();
682 #endif /* subprocesses */
686 /* Enable sending signal if user quits below. */
687 call_process_exited
= 0;
689 #if defined(MSDOS) || defined(MAC_OS8)
690 /* MSDOS needs different cleanup information. */
691 record_unwind_protect (call_process_cleanup
,
692 Fcons (make_number (fd
[0]), build_string (tempfile
)));
694 record_unwind_protect (call_process_cleanup
,
695 Fcons (make_number (fd
[0]), make_number (pid
)));
696 #endif /* not MSDOS and not MAC_OS8 */
699 if (BUFFERP (buffer
))
700 Fset_buffer (buffer
);
704 /* If BUFFER is nil, we must read process output once and then
705 discard it, so setup coding system but with nil. */
706 setup_coding_system (Qnil
, &process_coding
);
710 Lisp_Object val
, *args2
;
713 if (!NILP (Vcoding_system_for_read
))
714 val
= Vcoding_system_for_read
;
717 if (EQ (coding_systems
, Qt
))
721 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
722 args2
[0] = Qcall_process
;
723 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
725 = Ffind_operation_coding_system (nargs
+ 1, args2
);
727 if (CONSP (coding_systems
))
728 val
= XCAR (coding_systems
);
729 else if (CONSP (Vdefault_process_coding_system
))
730 val
= XCAR (Vdefault_process_coding_system
);
734 Fcheck_coding_system (val
);
735 /* In unibyte mode, character code conversion should not take
736 place but EOL conversion should. So, setup raw-text or one
737 of the subsidiary according to the information just setup. */
738 if (NILP (current_buffer
->enable_multibyte_characters
)
740 val
= raw_text_coding_system (val
);
741 setup_coding_system (val
, &process_coding
);
752 int display_on_the_fly
= display_p
;
753 struct coding_system saved_coding
;
755 saved_coding
= process_coding
;
758 /* Repeatedly read until we've filled as much as possible
759 of the buffer size we have. But don't read
760 less than 1024--save that for the next bufferful. */
762 while (nread
< bufsize
- 1024)
764 int this_read
= emacs_read (fd
[0], buf
+ nread
,
772 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
777 total_read
+= this_read
;
779 if (display_on_the_fly
)
783 /* Now NREAD is the total amount of data in the buffer. */
788 if (NILP (current_buffer
->enable_multibyte_characters
)
789 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
790 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
792 { /* We have to decode the input. */
795 XSETBUFFER (curbuf
, current_buffer
);
796 decode_coding_c_string (&process_coding
, buf
, nread
,
798 if (display_on_the_fly
799 && CODING_REQUIRE_DETECTION (&saved_coding
)
800 && ! CODING_REQUIRE_DETECTION (&process_coding
))
802 /* We have detected some coding system. But,
803 there's a possibility that the detection was
804 done by insufficient data. So, we give up
805 displaying on the fly. */
806 if (process_coding
.produced
> 0)
807 del_range_2 (process_coding
.dst_pos
,
808 process_coding
.dst_pos_byte
,
809 process_coding
.dst_pos
810 + process_coding
.produced_char
,
811 process_coding
.dst_pos_byte
812 + process_coding
.produced
, 0);
813 display_on_the_fly
= 0;
814 process_coding
= saved_coding
;
816 /* This is to make the above condition always
817 fails in the future. */
818 saved_coding
.common_flags
819 &= ~CODING_REQUIRE_DETECTION_MASK
;
823 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
824 PT_BYTE
+ process_coding
.produced
);
825 carryover
= process_coding
.carryover_bytes
;
827 /* As CARRYOVER should not be that large, we had
828 better avoid overhead of bcopy. */
829 BCOPY_SHORT (process_coding
.carryover
, buf
,
830 process_coding
.carryover_bytes
);
834 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
837 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
838 /* Make the buffer bigger as we continue to read more data,
839 but not past CALLPROC_BUFFER_SIZE_MAX. */
840 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
841 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
842 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
848 prepare_menu_bars ();
850 redisplay_preserve_echo_area (1);
851 /* This variable might have been set to 0 for code
852 detection. In that case, we set it back to 1 because
853 we should have already detected a coding system. */
854 display_on_the_fly
= 1;
861 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
862 /* If the caller required, let the buffer inherit the
863 coding-system used to decode the process output. */
864 if (inherit_process_coding_system
)
865 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
866 make_number (total_read
));
869 /* Wait for it to terminate, unless it already has. */
870 wait_for_termination (pid
);
874 set_buffer_internal (old
);
876 /* Don't kill any children that the subprocess may have left behind
878 call_process_exited
= 1;
880 unbind_to (count
, Qnil
);
882 if (synch_process_termsig
)
886 synchronize_system_messages_locale ();
887 signame
= strsignal (synch_process_termsig
);
892 synch_process_death
= signame
;
895 if (synch_process_death
)
896 return code_convert_string_norecord (build_string (synch_process_death
),
897 Vlocale_coding_system
, 0);
898 return make_number (synch_process_retcode
);
903 delete_temp_file (name
)
906 /* Suppress jka-compr handling, etc. */
907 int count
= SPECPDL_INDEX ();
908 specbind (intern ("file-name-handler-alist"), Qnil
);
909 internal_delete_file (name
);
910 unbind_to (count
, Qnil
);
914 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
916 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
917 The remaining arguments are optional.
918 Delete the text if fourth arg DELETE is non-nil.
920 Insert output in BUFFER before point; t means current buffer;
921 nil for BUFFER means discard it; 0 means discard and don't wait.
922 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
923 REAL-BUFFER says what to do with standard output, as above,
924 while STDERR-FILE says what to do with standard error in the child.
925 STDERR-FILE may be nil (discard standard error output),
926 t (mix it with ordinary output), or a file name string.
928 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
929 Remaining args are passed to PROGRAM at startup as command args.
931 If BUFFER is 0, `call-process-region' returns immediately with value nil.
932 Otherwise it waits for PROGRAM to terminate
933 and returns a numeric exit status or a signal description string.
934 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
936 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
939 register Lisp_Object
*args
;
942 Lisp_Object filename_string
;
943 register Lisp_Object start
, end
;
944 int count
= SPECPDL_INDEX ();
945 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
946 Lisp_Object coding_systems
;
947 Lisp_Object val
, *args2
;
953 if ((outf
= egetenv ("TMPDIR"))
954 || (outf
= egetenv ("TMP"))
955 || (outf
= egetenv ("TEMP")))
956 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
959 tempfile
= alloca (20);
962 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
963 strcat (tempfile
, "/");
964 if ('/' == DIRECTORY_SEP
)
965 dostounix_filename (tempfile
);
967 unixtodos_filename (tempfile
);
969 strcat (tempfile
, "emXXXXXX");
971 strcat (tempfile
, "detmp.XXX");
973 #else /* not DOS_NT */
974 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
975 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
976 SBYTES (Vtemp_file_name_pattern
) + 1);
977 #endif /* not DOS_NT */
983 int fd
= mkstemp (tempfile
);
985 report_file_error ("Failed to open temporary file",
986 Fcons (Vtemp_file_name_pattern
, Qnil
));
994 filename_string
= build_string (tempfile
);
995 GCPRO1 (filename_string
);
998 /* Decide coding-system of the contents of the temporary file. */
999 if (!NILP (Vcoding_system_for_write
))
1000 val
= Vcoding_system_for_write
;
1001 else if (NILP (current_buffer
->enable_multibyte_characters
))
1005 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
1006 args2
[0] = Qcall_process_region
;
1007 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
1008 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1009 if (CONSP (coding_systems
))
1010 val
= XCDR (coding_systems
);
1011 else if (CONSP (Vdefault_process_coding_system
))
1012 val
= XCDR (Vdefault_process_coding_system
);
1018 int count1
= SPECPDL_INDEX ();
1020 specbind (intern ("coding-system-for-write"), val
);
1021 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1022 happen to get a ".Z" suffix. */
1023 specbind (intern ("file-name-handler-alist"), Qnil
);
1024 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
1026 unbind_to (count1
, Qnil
);
1029 /* Note that Fcall_process takes care of binding
1030 coding-system-for-read. */
1032 record_unwind_protect (delete_temp_file
, filename_string
);
1034 if (nargs
> 3 && !NILP (args
[3]))
1035 Fdelete_region (start
, end
);
1047 args
[1] = filename_string
;
1049 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1052 #ifndef VMS /* VMS version is in vmsproc.c. */
1054 static int relocate_fd ();
1056 /* This is the last thing run in a newly forked inferior
1057 either synchronous or asynchronous.
1058 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1059 Initialize inferior's priority, pgrp, connected dir and environment.
1060 then exec another program based on new_argv.
1062 This function may change environ for the superior process.
1063 Therefore, the superior process must save and restore the value
1064 of environ around the vfork and the call to this function.
1066 SET_PGRP is nonzero if we should put the subprocess into a separate
1069 CURRENT_DIR is an elisp string giving the path of the current
1070 directory the subprocess should have. Since we can't really signal
1071 a decent error from within the child, this should be verified as an
1072 executable directory by the parent. */
1075 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1077 register char **new_argv
;
1079 Lisp_Object current_dir
;
1086 #endif /* WINDOWSNT */
1088 int pid
= getpid ();
1090 #ifdef SET_EMACS_PRIORITY
1092 extern EMACS_INT emacs_priority
;
1094 if (emacs_priority
< 0)
1095 nice (- emacs_priority
);
1100 /* Close Emacs's descriptors that this process should not have. */
1101 close_process_descs ();
1103 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1104 we will lose if we call close_load_descs here. */
1106 close_load_descs ();
1109 /* Note that use of alloca is always safe here. It's obvious for systems
1110 that do not have true vfork or that have true (stack) alloca.
1111 If using vfork and C_ALLOCA it is safe because that changes
1112 the superior's static variables as if the superior had done alloca
1113 and will be cleaned up in the usual way. */
1115 register char *temp
;
1118 i
= SBYTES (current_dir
);
1120 /* MSDOS must have all environment variables malloc'ed, because
1121 low-level libc functions that launch subsidiary processes rely
1123 pwd_var
= (char *) xmalloc (i
+ 6);
1125 pwd_var
= (char *) alloca (i
+ 6);
1128 bcopy ("PWD=", pwd_var
, 4);
1129 bcopy (SDATA (current_dir
), temp
, i
);
1130 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1134 /* We can't signal an Elisp error here; we're in a vfork. Since
1135 the callers check the current directory before forking, this
1136 should only return an error if the directory's permissions
1137 are changed between the check and this chdir, but we should
1139 if (chdir (temp
) < 0)
1144 /* Get past the drive letter, so that d:/ is left alone. */
1145 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1152 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1153 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1157 /* Set `env' to a vector of the strings in Vprocess_environment. */
1159 register Lisp_Object tem
;
1160 register char **new_env
;
1161 register int new_length
;
1164 for (tem
= Vprocess_environment
;
1165 CONSP (tem
) && STRINGP (XCAR (tem
));
1169 /* new_length + 2 to include PWD and terminating 0. */
1170 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1172 /* If we have a PWD envvar, pass one down,
1173 but with corrected value. */
1175 *new_env
++ = pwd_var
;
1177 /* Copy the Vprocess_environment strings into new_env. */
1178 for (tem
= Vprocess_environment
;
1179 CONSP (tem
) && STRINGP (XCAR (tem
));
1183 char *string
= (char *) SDATA (XCAR (tem
));
1184 /* See if this string duplicates any string already in the env.
1185 If so, don't put it in.
1186 When an env var has multiple definitions,
1187 we keep the definition that comes first in process-environment. */
1188 for (; ep
!= new_env
; ep
++)
1190 char *p
= *ep
, *q
= string
;
1194 /* The string is malformed; might as well drop it. */
1203 *new_env
++ = string
;
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 (var
, varlen
, value
, valuelen
)
1329 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCDR (scan
))
1333 entry
= XCAR (scan
);
1335 && SBYTES (entry
) > varlen
1336 && SREF (entry
, varlen
) == '='
1338 /* NT environment variables are case insensitive. */
1339 && ! strnicmp (SDATA (entry
), var
, varlen
)
1340 #else /* not WINDOWSNT */
1341 && ! bcmp (SDATA (entry
), var
, varlen
)
1342 #endif /* not WINDOWSNT */
1345 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1346 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1354 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 1, 0,
1355 doc
: /* Return the value of environment variable VAR, as a string.
1356 VAR should be a string. Value is nil if VAR is undefined in the environment.
1357 This function consults the variable ``process-environment'' for its value. */)
1365 if (getenv_internal (SDATA (var
), SBYTES (var
),
1367 return make_string (value
, valuelen
);
1372 /* A version of getenv that consults process_environment, easily
1381 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
1387 #endif /* not VMS */
1389 /* This is run before init_cmdargs. */
1394 char *data_dir
= egetenv ("EMACSDATA");
1395 char *doc_dir
= egetenv ("EMACSDOC");
1398 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1401 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1404 /* Check the EMACSPATH environment variable, defaulting to the
1405 PATH_EXEC path from epaths.h. */
1406 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1407 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1408 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1411 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1416 char *data_dir
= egetenv ("EMACSDATA");
1419 Lisp_Object tempdir
;
1421 if (!NILP (Vinstallation_directory
))
1423 /* Add to the path the lib-src subdir of the installation dir. */
1425 tem
= Fexpand_file_name (build_string ("lib-src"),
1426 Vinstallation_directory
);
1428 /* MSDOS uses wrapped binaries, so don't do this. */
1429 if (NILP (Fmember (tem
, Vexec_path
)))
1431 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1432 Vexec_path
= Fcons (tem
, Vexec_path
);
1433 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1436 Vexec_directory
= Ffile_name_as_directory (tem
);
1437 #endif /* not DOS_NT */
1439 /* Maybe use ../etc as well as ../lib-src. */
1442 tem
= Fexpand_file_name (build_string ("etc"),
1443 Vinstallation_directory
);
1444 Vdoc_directory
= Ffile_name_as_directory (tem
);
1448 /* Look for the files that should be in etc. We don't use
1449 Vinstallation_directory, because these files are never installed
1450 near the executable, and they are never in the build
1451 directory when that's different from the source directory.
1453 Instead, if these files are not in the nominal place, we try the
1454 source directory. */
1457 Lisp_Object tem
, tem1
, srcdir
;
1459 srcdir
= Fexpand_file_name (build_string ("../src/"),
1460 build_string (PATH_DUMPLOADSEARCH
));
1461 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1462 tem1
= Ffile_exists_p (tem
);
1463 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1466 newdir
= Fexpand_file_name (build_string ("../etc/"),
1467 build_string (PATH_DUMPLOADSEARCH
));
1468 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1469 tem1
= Ffile_exists_p (tem
);
1471 Vdata_directory
= newdir
;
1479 tempdir
= Fdirectory_file_name (Vexec_directory
);
1480 if (access (SDATA (tempdir
), 0) < 0)
1481 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1485 tempdir
= Fdirectory_file_name (Vdata_directory
);
1486 if (access (SDATA (tempdir
), 0) < 0)
1487 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1491 Vshell_file_name
= build_string ("*dcl*");
1493 sh
= (char *) getenv ("SHELL");
1494 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1498 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1500 if (getenv ("TMPDIR"))
1502 char *dir
= getenv ("TMPDIR");
1503 Vtemp_file_name_pattern
1504 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1505 build_string (dir
));
1508 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1512 Vshared_game_score_directory
= Qnil
;
1514 Vshared_game_score_directory
= build_string (PATH_GAME
);
1515 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1516 Vshared_game_score_directory
= Qnil
;
1521 set_process_environment ()
1523 register char **envp
;
1525 Vprocess_environment
= Qnil
;
1529 for (envp
= environ
; *envp
; envp
++)
1530 Vprocess_environment
= Fcons (build_string (*envp
),
1531 Vprocess_environment
);
1538 Qbuffer_file_type
= intern ("buffer-file-type");
1539 staticpro (&Qbuffer_file_type
);
1542 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1543 doc
: /* *File name to load inferior shells from.
1544 Initialized from the SHELL environment variable. */);
1546 DEFVAR_LISP ("exec-path", &Vexec_path
,
1547 doc
: /* *List of directories to search programs to run in subprocesses.
1548 Each element is a string (directory name) or nil (try default directory). */);
1550 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1551 doc
: /* *List of suffixes to try to find executable file names.
1552 Each element is a string. */);
1553 Vexec_suffixes
= Qnil
;
1555 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1556 doc
: /* Directory for executables for Emacs to invoke.
1557 More generally, this includes any architecture-dependent files
1558 that are built and installed from the Emacs distribution. */);
1560 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1561 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1562 These are files intended for Emacs to use while it runs. */);
1564 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1565 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1566 This is usually the same as data-directory. */);
1568 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1569 doc
: /* For internal use by the build procedure only.
1570 This is the name of the directory in which the build procedure installed
1571 Emacs's info files; the default value for Info-default-directory-list
1573 Vconfigure_info_directory
= build_string (PATH_INFO
);
1575 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1576 doc
: /* Directory of score files for games which come with GNU Emacs.
1577 If this variable is nil, then Emacs is unable to use a shared directory. */);
1579 Vshared_game_score_directory
= Qnil
;
1581 Vshared_game_score_directory
= build_string (PATH_GAME
);
1584 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1585 doc
: /* Pattern for making names for temporary files.
1586 This is used by `call-process-region'. */);
1587 /* This variable is initialized in init_callproc. */
1589 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1590 doc
: /* List of environment variables for subprocesses to inherit.
1591 Each element should be a string of the form ENVVARNAME=VALUE.
1592 If multiple entries define the same variable, the first one always
1594 The environment which Emacs inherits is placed in this variable
1596 Non-ASCII characters are encoded according to the initial value of
1597 `locale-coding-system', i.e. the elements must normally be decoded for use.
1598 See `setenv' and `getenv'. */);
1601 defsubr (&Scall_process
);
1602 defsubr (&Sgetenv_internal
);
1604 defsubr (&Scall_process_region
);
1607 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1608 (do not change this comment) */