1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985,86,87,88,93,94,95,99, 2000,01,02,03,04
3 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>
81 #include "composite.h"
84 #include "syssignal.h"
92 extern noshare
char **environ
;
95 extern char **environ
;
100 #if !defined (USG) || defined (BSD_PGRPS)
102 #define setpgrp setpgid
106 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
107 Lisp_Object Vdata_directory
, Vdoc_directory
;
108 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
109 Lisp_Object Vtemp_file_name_pattern
;
111 Lisp_Object Vshell_file_name
;
113 Lisp_Object Vprocess_environment
;
116 Lisp_Object Qbuffer_file_type
;
119 /* True iff we are about to fork off a synchronous process or if we
120 are waiting for it. */
121 int synch_process_alive
;
123 /* Nonzero => this is a string explaining death of synchronous subprocess. */
124 char *synch_process_death
;
126 /* Nonzero => this is the signal number that terminated the subprocess. */
127 int synch_process_termsig
;
129 /* If synch_process_death is zero,
130 this is exit code of synchronous subprocess. */
131 int synch_process_retcode
;
133 extern Lisp_Object Qredisplay_dont_pause
;
135 extern Lisp_Object Vdoc_file_name
;
137 extern Lisp_Object Vfile_name_coding_system
, Vdefault_file_name_coding_system
;
139 /* Clean up when exiting Fcall_process.
140 On MSDOS, delete the temporary file on any kind of termination.
141 On Unix, kill the process and any children on termination by signal. */
143 /* Nonzero if this is termination due to exit. */
144 static int call_process_exited
;
146 #ifndef VMS /* VMS version is in vmsproc.c. */
149 call_process_kill (fdpid
)
152 emacs_close (XFASTINT (Fcar (fdpid
)));
153 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
154 synch_process_alive
= 0;
159 call_process_cleanup (fdpid
)
162 #if defined (MSDOS) || defined (MAC_OS8)
163 /* for MSDOS fdpid is really (fd . tempfile) */
164 register Lisp_Object file
;
166 emacs_close (XFASTINT (Fcar (fdpid
)));
167 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
168 unlink (SDATA (file
));
169 #else /* not MSDOS and not MAC_OS8 */
170 register int pid
= XFASTINT (Fcdr (fdpid
));
172 if (call_process_exited
)
174 emacs_close (XFASTINT (Fcar (fdpid
)));
178 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
180 int count
= SPECPDL_INDEX ();
181 record_unwind_protect (call_process_kill
, fdpid
);
182 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
185 wait_for_termination (pid
);
187 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
188 message1 ("Waiting for process to die...done");
190 synch_process_alive
= 0;
191 emacs_close (XFASTINT (Fcar (fdpid
)));
192 #endif /* not MSDOS */
196 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
197 doc
: /* Call PROGRAM synchronously in separate process.
198 The remaining arguments are optional.
199 The program's input comes from file INFILE (nil means `/dev/null').
200 Insert output in BUFFER before point; t means current buffer;
201 nil for BUFFER means discard it; 0 means discard and don't wait.
202 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
203 REAL-BUFFER says what to do with standard output, as above,
204 while STDERR-FILE says what to do with standard error in the child.
205 STDERR-FILE may be nil (discard standard error output),
206 t (mix it with ordinary output), or a file name string.
208 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
209 Remaining arguments are strings passed as command arguments to PROGRAM.
211 If BUFFER is 0, `call-process' returns immediately with value nil.
212 Otherwise it waits for PROGRAM to terminate
213 and returns a numeric exit status or a signal description string.
214 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
216 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
219 register Lisp_Object
*args
;
221 Lisp_Object infile
, buffer
, current_dir
, display
, path
;
227 int bufsize
= sizeof buf
;
228 int count
= SPECPDL_INDEX ();
230 register const unsigned char **new_argv
231 = (const unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
232 struct buffer
*old
= current_buffer
;
233 /* File to use for stderr in the child.
234 t means use same as standard output. */
235 Lisp_Object error_file
;
236 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
237 char *outf
, *tempfile
;
247 struct coding_system process_coding
; /* coding-system of process output */
248 struct coding_system argument_coding
; /* coding-system of arguments */
249 /* Set to the return value of Ffind_operation_coding_system. */
250 Lisp_Object coding_systems
;
252 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
255 CHECK_STRING (args
[0]);
260 /* Without asynchronous processes we cannot have BUFFER == 0. */
262 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
263 error ("Operating system cannot handle asynchronous subprocesses");
264 #endif /* subprocesses */
266 /* Decide the coding-system for giving arguments. */
268 Lisp_Object val
, *args2
;
271 /* If arguments are supplied, we may have to encode them. */
276 for (i
= 4; i
< nargs
; i
++)
277 CHECK_STRING (args
[i
]);
279 for (i
= 4; i
< nargs
; i
++)
280 if (STRING_MULTIBYTE (args
[i
]))
283 if (!NILP (Vcoding_system_for_write
))
284 val
= Vcoding_system_for_write
;
285 else if (! must_encode
)
289 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
290 args2
[0] = Qcall_process
;
291 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
292 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
293 if (CONSP (coding_systems
))
294 val
= XCDR (coding_systems
);
295 else if (CONSP (Vdefault_process_coding_system
))
296 val
= XCDR (Vdefault_process_coding_system
);
300 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
304 if (nargs
>= 2 && ! NILP (args
[1]))
306 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
307 CHECK_STRING (infile
);
310 infile
= build_string (NULL_DEVICE
);
316 /* If BUFFER is a list, its meaning is
317 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
320 if (CONSP (XCDR (buffer
)))
322 Lisp_Object stderr_file
;
323 stderr_file
= XCAR (XCDR (buffer
));
325 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
326 error_file
= stderr_file
;
328 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
331 buffer
= XCAR (buffer
);
334 if (!(EQ (buffer
, Qnil
)
336 || INTEGERP (buffer
)))
338 Lisp_Object spec_buffer
;
339 spec_buffer
= buffer
;
340 buffer
= Fget_buffer_create (buffer
);
341 /* Mention the buffer name for a better error message. */
343 CHECK_BUFFER (spec_buffer
);
344 CHECK_BUFFER (buffer
);
350 /* Make sure that the child will be able to chdir to the current
351 buffer's current directory, or its unhandled equivalent. We
352 can't just have the child check for an error when it does the
353 chdir, since it's in a vfork.
355 We have to GCPRO around this because Fexpand_file_name,
356 Funhandled_file_name_directory, and Ffile_accessible_directory_p
357 might call a file name handling function. The argument list is
358 protected by the caller, so all we really have to worry about is
361 struct gcpro gcpro1
, gcpro2
, gcpro3
;
363 current_dir
= current_buffer
->directory
;
365 GCPRO3 (infile
, buffer
, current_dir
);
368 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir
),
370 if (NILP (Ffile_accessible_directory_p (current_dir
)))
371 report_file_error ("Setting current directory",
372 Fcons (current_buffer
->directory
, Qnil
));
377 display
= nargs
>= 4 ? args
[3] : Qnil
;
379 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
382 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
384 /* Search for program; barf if not found. */
388 GCPRO1 (current_dir
);
389 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
394 emacs_close (filefd
);
395 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
398 /* If program file name starts with /: for quoting a magic name,
400 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
401 && SREF (path
, 1) == ':')
402 path
= Fsubstring (path
, make_number (2), Qnil
);
404 new_argv
[0] = SDATA (path
);
408 struct gcpro gcpro1
, gcpro2
, gcpro3
;
410 GCPRO3 (infile
, buffer
, current_dir
);
411 argument_coding
.dst_multibyte
= 0;
412 for (i
= 4; i
< nargs
; i
++)
414 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
415 if (CODING_REQUIRE_ENCODING (&argument_coding
))
417 /* We must encode this argument. */
418 args
[i
] = encode_coding_string (args
[i
], &argument_coding
, 1);
419 if (argument_coding
.type
== coding_type_ccl
)
420 setup_ccl_program (&(argument_coding
.spec
.ccl
.encoder
), Qnil
);
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 report_file_error ("Cannot redirect stderr",
540 Fcons ((NILP (error_file
)
541 ? build_string (NULL_DEVICE
) : error_file
),
545 current_dir
= ENCODE_FILE (current_dir
);
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 */
637 #if defined (USG) && !defined (BSD_PGRPS)
642 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
645 #endif /* not WINDOWSNT */
647 /* The MSDOS case did this already. */
649 emacs_close (fd_error
);
650 #endif /* not MSDOS */
651 #endif /* not MAC_OS8 */
653 environ
= save_environ
;
655 /* Close most of our fd's, but not fd[0]
656 since we will use that to read input from. */
657 emacs_close (filefd
);
658 if (fd1
>= 0 && fd1
!= fd_error
)
666 report_file_error ("Doing vfork", Qnil
);
669 if (INTEGERP (buffer
))
674 /* If Emacs has been built with asynchronous subprocess support,
675 we don't need to do this, I think because it will then have
676 the facilities for handling SIGCHLD. */
677 wait_without_blocking ();
678 #endif /* subprocesses */
682 /* Enable sending signal if user quits below. */
683 call_process_exited
= 0;
685 #if defined(MSDOS) || defined(MAC_OS8)
686 /* MSDOS needs different cleanup information. */
687 record_unwind_protect (call_process_cleanup
,
688 Fcons (make_number (fd
[0]), build_string (tempfile
)));
690 record_unwind_protect (call_process_cleanup
,
691 Fcons (make_number (fd
[0]), make_number (pid
)));
692 #endif /* not MSDOS and not MAC_OS8 */
695 if (BUFFERP (buffer
))
696 Fset_buffer (buffer
);
700 /* If BUFFER is nil, we must read process output once and then
701 discard it, so setup coding system but with nil. */
702 setup_coding_system (Qnil
, &process_coding
);
706 Lisp_Object val
, *args2
;
709 if (!NILP (Vcoding_system_for_read
))
710 val
= Vcoding_system_for_read
;
713 if (EQ (coding_systems
, Qt
))
717 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
718 args2
[0] = Qcall_process
;
719 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
721 = Ffind_operation_coding_system (nargs
+ 1, args2
);
723 if (CONSP (coding_systems
))
724 val
= XCAR (coding_systems
);
725 else if (CONSP (Vdefault_process_coding_system
))
726 val
= XCAR (Vdefault_process_coding_system
);
730 setup_coding_system (Fcheck_coding_system (val
), &process_coding
);
731 /* In unibyte mode, character code conversion should not take
732 place but EOL conversion should. So, setup raw-text or one
733 of the subsidiary according to the information just setup. */
734 if (NILP (current_buffer
->enable_multibyte_characters
)
736 setup_raw_text_coding_system (&process_coding
);
738 process_coding
.src_multibyte
= 0;
739 process_coding
.dst_multibyte
741 ? ! NILP (XBUFFER (buffer
)->enable_multibyte_characters
)
742 : ! NILP (current_buffer
->enable_multibyte_characters
));
752 int display_on_the_fly
= !NILP (display
) && INTERACTIVE
;
753 struct coding_system saved_coding
;
754 int pt_orig
= PT
, pt_byte_orig
= PT_BYTE
;
757 saved_coding
= process_coding
;
758 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
759 coding_allocate_composition_data (&process_coding
, PT
);
762 /* Repeatedly read until we've filled as much as possible
763 of the buffer size we have. But don't read
764 less than 1024--save that for the next bufferful. */
766 while (nread
< bufsize
- 1024)
768 int this_read
= emacs_read (fd
[0], bufptr
+ nread
,
776 // fprintf(stderr, "read 0, total=%d\n", total_read);
777 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
782 total_read
+= this_read
;
784 // fprintf(stderr, "read %d+%d of %d, total=%d\n", nread, this_read, bufsize, total_read);
786 if (display_on_the_fly
)
790 /* Now NREAD is the total amount of data in the buffer. */
795 if (! CODING_MAY_REQUIRE_DECODING (&process_coding
))
796 insert_1_both (bufptr
, nread
, nread
, 0, 1, 0);
798 { /* We have to decode the input. */
803 size
= decoding_buffer_size (&process_coding
, nread
);
804 decoding_buf
= (char *) xmalloc (size
);
806 /* We can't use the macro CODING_REQUIRE_DETECTION
807 because it always returns nonzero if the coding
808 system requires EOL detection. Here, we have to
809 check only whether or not the coding system
810 requires text-encoding detection. */
811 if (process_coding
.type
== coding_type_undecided
)
813 detect_coding (&process_coding
, bufptr
, nread
);
814 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
815 coding_allocate_composition_data (&process_coding
, PT
);
817 if (process_coding
.cmp_data
)
818 process_coding
.cmp_data
->char_offset
= PT
;
820 decode_coding (&process_coding
, bufptr
, decoding_buf
,
823 if (display_on_the_fly
824 && saved_coding
.type
== coding_type_undecided
825 && process_coding
.type
!= coding_type_undecided
)
827 /* We have detected some coding system. But,
828 there's a possibility that the detection was
829 done by insufficient data. So, we give up
830 displaying on the fly. */
831 xfree (decoding_buf
);
832 display_on_the_fly
= 0;
833 process_coding
= saved_coding
;
838 // fprintf(stderr, "produced %d\n", process_coding.produced);
840 if (process_coding
.produced
> 0)
841 insert_1_both (decoding_buf
, process_coding
.produced_char
,
842 process_coding
.produced
, 0, 1, 0);
843 xfree (decoding_buf
);
845 if (process_coding
.result
== CODING_FINISH_INCONSISTENT_EOL
)
847 Lisp_Object eol_type
, coding
;
849 if (process_coding
.eol_type
== CODING_EOL_CR
)
851 /* CRs have been replaced with LFs. Undo
852 that in the text inserted above. */
855 move_gap_both (PT
, PT_BYTE
);
857 p
= BYTE_POS_ADDR (pt_byte_orig
);
858 for (; p
< GPT_ADDR
; ++p
)
862 else if (process_coding
.eol_type
== CODING_EOL_CRLF
)
864 /* CR LFs have been replaced with LFs. Undo
865 that by inserting CRs in front of LFs in
866 the text inserted above. */
867 EMACS_INT bytepos
, old_pt
, old_pt_byte
, nCR
;
870 old_pt_byte
= PT_BYTE
;
873 for (bytepos
= PT_BYTE
- 1;
874 bytepos
>= pt_byte_orig
;
876 if (FETCH_BYTE (bytepos
) == '\n')
878 EMACS_INT charpos
= BYTE_TO_CHAR (bytepos
);
879 TEMP_SET_PT_BOTH (charpos
, bytepos
);
880 insert_1_both ("\r", 1, 1, 0, 1, 0);
884 TEMP_SET_PT_BOTH (old_pt
+ nCR
, old_pt_byte
+ nCR
);
887 /* Set the coding system symbol to that for
889 eol_type
= Fget (saved_coding
.symbol
, Qeol_type
);
890 if (VECTORP (eol_type
)
891 && ASIZE (eol_type
) == 3
892 && SYMBOLP (AREF (eol_type
, CODING_EOL_LF
)))
893 coding
= AREF (eol_type
, CODING_EOL_LF
);
895 coding
= saved_coding
.symbol
;
897 process_coding
.symbol
= coding
;
898 process_coding
.eol_type
= CODING_EOL_LF
;
900 &= ~CODING_MODE_INHIBIT_INCONSISTENT_EOL
;
903 nread
-= process_coding
.consumed
;
906 /* As CARRYOVER should not be that large, we had
907 better avoid overhead of bcopy. */
908 BCOPY_SHORT (bufptr
+ process_coding
.consumed
, bufptr
,
910 if (process_coding
.result
== CODING_FINISH_INSUFFICIENT_CMP
)
912 /* The decoding ended because of insufficient data
913 area to record information about composition.
914 We must try decoding with additional data area
915 before reading more output for the process. */
916 coding_allocate_composition_data (&process_coding
, PT
);
917 goto repeat_decoding
;
922 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
925 /* Make the buffer bigger as we continue to read more data,
927 if (bufsize
< 64 * 1024 && total_read
> 32 * bufsize
)
932 tempptr
= (char *) alloca (bufsize
);
933 bcopy (bufptr
, tempptr
, bufsize
/ 2);
937 if (!NILP (display
) && INTERACTIVE
)
939 extern int windows_or_buffers_changed
;
940 int count
= SPECPDL_INDEX ();
943 prepare_menu_bars ();
945 specbind (Qredisplay_dont_pause
, Qt
);
946 redisplay_preserve_echo_area (1);
947 unbind_to (count
, Qnil
);
955 && process_coding
.cmp_data
)
957 coding_restore_composition (&process_coding
, Fcurrent_buffer ());
958 coding_free_composition_data (&process_coding
);
962 int post_read_count
= SPECPDL_INDEX ();
964 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
965 inserted
= PT
- pt_orig
;
966 TEMP_SET_PT_BOTH (pt_orig
, pt_byte_orig
);
967 if (SYMBOLP (process_coding
.post_read_conversion
)
968 && !NILP (Ffboundp (process_coding
.post_read_conversion
)))
969 call1 (process_coding
.post_read_conversion
, make_number (inserted
));
971 Vlast_coding_system_used
= process_coding
.symbol
;
973 /* If the caller required, let the buffer inherit the
974 coding-system used to decode the process output. */
975 if (inherit_process_coding_system
)
976 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
977 make_number (total_read
));
979 unbind_to (post_read_count
, Qnil
);
983 /* Wait for it to terminate, unless it already has. */
984 wait_for_termination (pid
);
988 set_buffer_internal (old
);
990 /* Don't kill any children that the subprocess may have left behind
992 call_process_exited
= 1;
994 unbind_to (count
, Qnil
);
996 if (synch_process_termsig
)
1000 synchronize_system_messages_locale ();
1001 signame
= strsignal (synch_process_termsig
);
1004 signame
= "unknown";
1006 synch_process_death
= signame
;
1009 if (synch_process_death
)
1010 return code_convert_string_norecord (build_string (synch_process_death
),
1011 Vlocale_coding_system
, 0);
1012 return make_number (synch_process_retcode
);
1017 delete_temp_file (name
)
1020 /* Use Fdelete_file (indirectly) because that runs a file name handler.
1021 We did that when writing the file, so we should do so when deleting. */
1022 internal_delete_file (name
);
1026 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
1028 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
1029 The remaining arguments are optional.
1030 Delete the text if fourth arg DELETE is non-nil.
1032 Insert output in BUFFER before point; t means current buffer;
1033 nil for BUFFER means discard it; 0 means discard and don't wait.
1034 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1035 REAL-BUFFER says what to do with standard output, as above,
1036 while STDERR-FILE says what to do with standard error in the child.
1037 STDERR-FILE may be nil (discard standard error output),
1038 t (mix it with ordinary output), or a file name string.
1040 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1041 Remaining args are passed to PROGRAM at startup as command args.
1043 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1044 Otherwise it waits for PROGRAM to terminate
1045 and returns a numeric exit status or a signal description string.
1046 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1048 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1051 register Lisp_Object
*args
;
1053 struct gcpro gcpro1
;
1054 Lisp_Object filename_string
;
1055 register Lisp_Object start
, end
;
1056 int count
= SPECPDL_INDEX ();
1057 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1058 Lisp_Object coding_systems
;
1059 Lisp_Object val
, *args2
;
1065 if ((outf
= egetenv ("TMPDIR"))
1066 || (outf
= egetenv ("TMP"))
1067 || (outf
= egetenv ("TEMP")))
1068 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
1071 tempfile
= alloca (20);
1074 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
1075 strcat (tempfile
, "/");
1076 if ('/' == DIRECTORY_SEP
)
1077 dostounix_filename (tempfile
);
1079 unixtodos_filename (tempfile
);
1081 strcat (tempfile
, "emXXXXXX");
1083 strcat (tempfile
, "detmp.XXX");
1085 #else /* not DOS_NT */
1086 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
1087 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
1088 SBYTES (Vtemp_file_name_pattern
) + 1);
1089 #endif /* not DOS_NT */
1091 coding_systems
= Qt
;
1095 int fd
= mkstemp (tempfile
);
1097 report_file_error ("Failed to open temporary file",
1098 Fcons (Vtemp_file_name_pattern
, Qnil
));
1106 filename_string
= build_string (tempfile
);
1107 GCPRO1 (filename_string
);
1110 /* Decide coding-system of the contents of the temporary file. */
1111 if (!NILP (Vcoding_system_for_write
))
1112 val
= Vcoding_system_for_write
;
1113 else if (NILP (current_buffer
->enable_multibyte_characters
))
1117 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
1118 args2
[0] = Qcall_process_region
;
1119 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
1120 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1121 if (CONSP (coding_systems
))
1122 val
= XCDR (coding_systems
);
1123 else if (CONSP (Vdefault_process_coding_system
))
1124 val
= XCDR (Vdefault_process_coding_system
);
1130 int count1
= SPECPDL_INDEX ();
1132 specbind (intern ("coding-system-for-write"), val
);
1133 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
1135 unbind_to (count1
, Qnil
);
1138 /* Note that Fcall_process takes care of binding
1139 coding-system-for-read. */
1141 record_unwind_protect (delete_temp_file
, filename_string
);
1143 if (nargs
> 3 && !NILP (args
[3]))
1144 Fdelete_region (start
, end
);
1156 args
[1] = filename_string
;
1158 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1161 #ifndef VMS /* VMS version is in vmsproc.c. */
1163 static int relocate_fd ();
1165 /* This is the last thing run in a newly forked inferior
1166 either synchronous or asynchronous.
1167 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1168 Initialize inferior's priority, pgrp, connected dir and environment.
1169 then exec another program based on new_argv.
1171 This function may change environ for the superior process.
1172 Therefore, the superior process must save and restore the value
1173 of environ around the vfork and the call to this function.
1175 SET_PGRP is nonzero if we should put the subprocess into a separate
1178 CURRENT_DIR is an elisp string giving the path of the current
1179 directory the subprocess should have. Since we can't really signal
1180 a decent error from within the child, this should be verified as an
1181 executable directory by the parent. */
1184 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1186 register char **new_argv
;
1188 Lisp_Object current_dir
;
1195 #endif /* WINDOWSNT */
1197 int pid
= getpid ();
1199 #ifdef SET_EMACS_PRIORITY
1201 extern EMACS_INT emacs_priority
;
1203 if (emacs_priority
< 0)
1204 nice (- emacs_priority
);
1209 /* Close Emacs's descriptors that this process should not have. */
1210 close_process_descs ();
1212 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1213 we will lose if we call close_load_descs here. */
1215 close_load_descs ();
1218 /* Note that use of alloca is always safe here. It's obvious for systems
1219 that do not have true vfork or that have true (stack) alloca.
1220 If using vfork and C_ALLOCA it is safe because that changes
1221 the superior's static variables as if the superior had done alloca
1222 and will be cleaned up in the usual way. */
1224 register char *temp
;
1227 i
= SBYTES (current_dir
);
1229 /* MSDOS must have all environment variables malloc'ed, because
1230 low-level libc functions that launch subsidiary processes rely
1232 pwd_var
= (char *) xmalloc (i
+ 6);
1234 pwd_var
= (char *) alloca (i
+ 6);
1237 bcopy ("PWD=", pwd_var
, 4);
1238 bcopy (SDATA (current_dir
), temp
, i
);
1239 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1243 /* We can't signal an Elisp error here; we're in a vfork. Since
1244 the callers check the current directory before forking, this
1245 should only return an error if the directory's permissions
1246 are changed between the check and this chdir, but we should
1248 if (chdir (temp
) < 0)
1253 /* Get past the drive letter, so that d:/ is left alone. */
1254 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1261 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1262 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1266 /* Set `env' to a vector of the strings in Vprocess_environment. */
1268 register Lisp_Object tem
;
1269 register char **new_env
;
1270 register int new_length
;
1273 for (tem
= Vprocess_environment
;
1274 CONSP (tem
) && STRINGP (XCAR (tem
));
1278 /* new_length + 2 to include PWD and terminating 0. */
1279 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1281 /* If we have a PWD envvar, pass one down,
1282 but with corrected value. */
1284 *new_env
++ = pwd_var
;
1286 /* Copy the Vprocess_environment strings into new_env. */
1287 for (tem
= Vprocess_environment
;
1288 CONSP (tem
) && STRINGP (XCAR (tem
));
1292 char *string
= (char *) SDATA (XCAR (tem
));
1293 /* See if this string duplicates any string already in the env.
1294 If so, don't put it in.
1295 When an env var has multiple definitions,
1296 we keep the definition that comes first in process-environment. */
1297 for (; ep
!= new_env
; ep
++)
1299 char *p
= *ep
, *q
= string
;
1303 /* The string is malformed; might as well drop it. */
1312 *new_env
++ = string
;
1318 prepare_standard_handles (in
, out
, err
, handles
);
1319 set_process_dir (SDATA (current_dir
));
1320 #else /* not WINDOWSNT */
1321 /* Make sure that in, out, and err are not actually already in
1322 descriptors zero, one, or two; this could happen if Emacs is
1323 started with its standard in, out, or error closed, as might
1326 int oin
= in
, oout
= out
;
1328 /* We have to avoid relocating the same descriptor twice! */
1330 in
= relocate_fd (in
, 3);
1335 out
= relocate_fd (out
, 3);
1339 else if (err
== oout
)
1342 err
= relocate_fd (err
, 3);
1356 #endif /* not MSDOS */
1357 #endif /* not WINDOWSNT */
1359 #if defined(USG) && !defined(BSD_PGRPS)
1360 #ifndef SETPGRP_RELEASES_CTTY
1361 setpgrp (); /* No arguments but equivalent in this case */
1366 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1367 EMACS_SET_TTY_PGRP (0, &pid
);
1370 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1373 /* An error occurred while trying to run the subprocess. */
1374 report_file_error ("Spawning child process", Qnil
);
1376 #else /* not MSDOS */
1378 /* Spawn the child. (See ntproc.c:Spawnve). */
1379 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1380 reset_standard_handles (in
, out
, err
, handles
);
1382 /* An error occurred while trying to spawn the process. */
1383 report_file_error ("Spawning child process", Qnil
);
1385 #else /* not WINDOWSNT */
1386 /* execvp does not accept an environment arg so the only way
1387 to pass this environment is to set environ. Our caller
1388 is responsible for restoring the ambient value of environ. */
1390 execvp (new_argv
[0], new_argv
);
1392 emacs_write (1, "Can't exec program: ", 20);
1393 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1394 emacs_write (1, "\n", 1);
1396 #endif /* not WINDOWSNT */
1397 #endif /* not MSDOS */
1400 /* Move the file descriptor FD so that its number is not less than MINFD.
1401 If the file descriptor is moved at all, the original is freed. */
1403 relocate_fd (fd
, minfd
)
1413 char *message1
= "Error while setting up child: ";
1414 char *errmessage
= strerror (errno
);
1415 char *message2
= "\n";
1416 emacs_write (2, message1
, strlen (message1
));
1417 emacs_write (2, errmessage
, strlen (errmessage
));
1418 emacs_write (2, message2
, strlen (message2
));
1421 /* Note that we hold the original FD open while we recurse,
1422 to guarantee we'll get a new FD if we need it. */
1423 new = relocate_fd (new, minfd
);
1430 getenv_internal (var
, varlen
, value
, valuelen
)
1438 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCDR (scan
))
1442 entry
= XCAR (scan
);
1444 && SBYTES (entry
) > varlen
1445 && SREF (entry
, varlen
) == '='
1447 /* NT environment variables are case insensitive. */
1448 && ! strnicmp (SDATA (entry
), var
, varlen
)
1449 #else /* not WINDOWSNT */
1450 && ! bcmp (SDATA (entry
), var
, varlen
)
1451 #endif /* not WINDOWSNT */
1454 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1455 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1463 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 1, 0,
1464 doc
: /* Return the value of environment variable VAR, as a string.
1465 VAR should be a string. Value is nil if VAR is undefined in the environment.
1466 This function consults the variable ``process-environment'' for its value. */)
1474 if (getenv_internal (SDATA (var
), SBYTES (var
),
1476 return make_string (value
, valuelen
);
1481 /* A version of getenv that consults process_environment, easily
1490 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
1496 #endif /* not VMS */
1498 /* This is run before init_cmdargs. */
1503 char *data_dir
= egetenv ("EMACSDATA");
1504 char *doc_dir
= egetenv ("EMACSDOC");
1507 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1510 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1513 /* Check the EMACSPATH environment variable, defaulting to the
1514 PATH_EXEC path from epaths.h. */
1515 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1516 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1517 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1520 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1525 char *data_dir
= egetenv ("EMACSDATA");
1528 Lisp_Object tempdir
;
1530 if (!NILP (Vinstallation_directory
))
1532 /* Add to the path the lib-src subdir of the installation dir. */
1534 tem
= Fexpand_file_name (build_string ("lib-src"),
1535 Vinstallation_directory
);
1537 /* MSDOS uses wrapped binaries, so don't do this. */
1538 if (NILP (Fmember (tem
, Vexec_path
)))
1540 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1541 Vexec_path
= Fcons (tem
, Vexec_path
);
1542 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1545 Vexec_directory
= Ffile_name_as_directory (tem
);
1546 #endif /* not DOS_NT */
1548 /* Maybe use ../etc as well as ../lib-src. */
1551 tem
= Fexpand_file_name (build_string ("etc"),
1552 Vinstallation_directory
);
1553 Vdoc_directory
= Ffile_name_as_directory (tem
);
1557 /* Look for the files that should be in etc. We don't use
1558 Vinstallation_directory, because these files are never installed
1559 near the executable, and they are never in the build
1560 directory when that's different from the source directory.
1562 Instead, if these files are not in the nominal place, we try the
1563 source directory. */
1566 Lisp_Object tem
, tem1
, srcdir
;
1568 srcdir
= Fexpand_file_name (build_string ("../src/"),
1569 build_string (PATH_DUMPLOADSEARCH
));
1570 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1571 tem1
= Ffile_exists_p (tem
);
1572 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1575 newdir
= Fexpand_file_name (build_string ("../etc/"),
1576 build_string (PATH_DUMPLOADSEARCH
));
1577 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1578 tem1
= Ffile_exists_p (tem
);
1580 Vdata_directory
= newdir
;
1588 tempdir
= Fdirectory_file_name (Vexec_directory
);
1589 if (access (SDATA (tempdir
), 0) < 0)
1590 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1594 tempdir
= Fdirectory_file_name (Vdata_directory
);
1595 if (access (SDATA (tempdir
), 0) < 0)
1596 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1600 Vshell_file_name
= build_string ("*dcl*");
1602 sh
= (char *) getenv ("SHELL");
1603 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1607 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1609 if (getenv ("TMPDIR"))
1611 char *dir
= getenv ("TMPDIR");
1612 Vtemp_file_name_pattern
1613 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1614 build_string (dir
));
1617 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1621 Vshared_game_score_directory
= Qnil
;
1623 Vshared_game_score_directory
= build_string (PATH_GAME
);
1624 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1625 Vshared_game_score_directory
= Qnil
;
1630 set_process_environment ()
1632 register char **envp
;
1634 Vprocess_environment
= Qnil
;
1638 for (envp
= environ
; *envp
; envp
++)
1639 Vprocess_environment
= Fcons (build_string (*envp
),
1640 Vprocess_environment
);
1647 Qbuffer_file_type
= intern ("buffer-file-type");
1648 staticpro (&Qbuffer_file_type
);
1651 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1652 doc
: /* *File name to load inferior shells from.
1653 Initialized from the SHELL environment variable. */);
1655 DEFVAR_LISP ("exec-path", &Vexec_path
,
1656 doc
: /* *List of directories to search programs to run in subprocesses.
1657 Each element is a string (directory name) or nil (try default directory). */);
1659 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1660 doc
: /* *List of suffixes to try to find executable file names.
1661 Each element is a string. */);
1662 Vexec_suffixes
= Qnil
;
1664 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1665 doc
: /* Directory for executables for Emacs to invoke.
1666 More generally, this includes any architecture-dependent files
1667 that are built and installed from the Emacs distribution. */);
1669 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1670 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1671 These are files intended for Emacs to use while it runs. */);
1673 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1674 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1675 This is usually the same as data-directory. */);
1677 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1678 doc
: /* For internal use by the build procedure only.
1679 This is the name of the directory in which the build procedure installed
1680 Emacs's info files; the default value for Info-default-directory-list
1682 Vconfigure_info_directory
= build_string (PATH_INFO
);
1684 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1685 doc
: /* Directory of score files for games which come with GNU Emacs.
1686 If this variable is nil, then Emacs is unable to use a shared directory. */);
1688 Vshared_game_score_directory
= Qnil
;
1690 Vshared_game_score_directory
= build_string (PATH_GAME
);
1693 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1694 doc
: /* Pattern for making names for temporary files.
1695 This is used by `call-process-region'. */);
1696 /* This variable is initialized in init_callproc. */
1698 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1699 doc
: /* List of environment variables for subprocesses to inherit.
1700 Each element should be a string of the form ENVVARNAME=VALUE.
1701 If multiple entries define the same variable, the first one always
1703 The environment which Emacs inherits is placed in this variable
1705 Non-ASCII characters are encoded according to the initial value of
1706 `locale-coding-system', i.e. the elements must normally be decoded for use.
1707 See `setenv' and `getenv'. */);
1710 defsubr (&Scall_process
);
1711 defsubr (&Sgetenv_internal
);
1713 defsubr (&Scall_process_region
);
1716 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1717 (do not change this comment) */