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"
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 extern Lisp_Object Vdoc_file_name
;
136 extern Lisp_Object Vfile_name_coding_system
, Vdefault_file_name_coding_system
;
138 /* Clean up when exiting Fcall_process.
139 On MSDOS, delete the temporary file on any kind of termination.
140 On Unix, kill the process and any children on termination by signal. */
142 /* Nonzero if this is termination due to exit. */
143 static int call_process_exited
;
145 #ifndef VMS /* VMS version is in vmsproc.c. */
148 call_process_kill (fdpid
)
151 emacs_close (XFASTINT (Fcar (fdpid
)));
152 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
153 synch_process_alive
= 0;
158 call_process_cleanup (fdpid
)
161 #if defined (MSDOS) || defined (MAC_OS8)
162 /* for MSDOS fdpid is really (fd . tempfile) */
163 register Lisp_Object file
;
165 emacs_close (XFASTINT (Fcar (fdpid
)));
166 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
167 unlink (SDATA (file
));
168 #else /* not MSDOS and not MAC_OS8 */
169 register int pid
= XFASTINT (Fcdr (fdpid
));
171 if (call_process_exited
)
173 emacs_close (XFASTINT (Fcar (fdpid
)));
177 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
179 int count
= SPECPDL_INDEX ();
180 record_unwind_protect (call_process_kill
, fdpid
);
181 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
184 wait_for_termination (pid
);
186 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
187 message1 ("Waiting for process to die...done");
189 synch_process_alive
= 0;
190 emacs_close (XFASTINT (Fcar (fdpid
)));
191 #endif /* not MSDOS */
195 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
196 doc
: /* Call PROGRAM synchronously in separate process.
197 The remaining arguments are optional.
198 The program's input comes from file INFILE (nil means `/dev/null').
199 Insert output in BUFFER before point; t means current buffer;
200 nil for BUFFER means discard it; 0 means discard and don't wait.
201 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
202 REAL-BUFFER says what to do with standard output, as above,
203 while STDERR-FILE says what to do with standard error in the child.
204 STDERR-FILE may be nil (discard standard error output),
205 t (mix it with ordinary output), or a file name string.
207 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
208 Remaining arguments are strings passed as command arguments to PROGRAM.
210 If BUFFER is 0, `call-process' returns immediately with value nil.
211 Otherwise it waits for PROGRAM to terminate
212 and returns a numeric exit status or a signal description string.
213 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
215 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
218 register Lisp_Object
*args
;
220 Lisp_Object infile
, buffer
, current_dir
, 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_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
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 */
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 setup_coding_system (Fcheck_coding_system (val
), &process_coding
);
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 setup_raw_text_coding_system (&process_coding
);
742 process_coding
.src_multibyte
= 0;
743 process_coding
.dst_multibyte
745 ? ! NILP (XBUFFER (buffer
)->enable_multibyte_characters
)
746 : ! NILP (current_buffer
->enable_multibyte_characters
));
756 int display_on_the_fly
= display_p
;
757 struct coding_system saved_coding
;
758 int pt_orig
= PT
, pt_byte_orig
= PT_BYTE
;
761 saved_coding
= process_coding
;
762 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
763 coding_allocate_composition_data (&process_coding
, PT
);
766 /* Repeatedly read until we've filled as much as possible
767 of the buffer size we have. But don't read
768 less than 1024--save that for the next bufferful. */
770 while (nread
< bufsize
- 1024)
772 int this_read
= emacs_read (fd
[0], bufptr
+ nread
,
780 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
785 total_read
+= this_read
;
787 if (display_on_the_fly
)
791 /* Now NREAD is the total amount of data in the buffer. */
796 if (! CODING_MAY_REQUIRE_DECODING (&process_coding
))
797 insert_1_both (bufptr
, nread
, nread
, 0, 1, 0);
799 { /* We have to decode the input. */
804 size
= decoding_buffer_size (&process_coding
, nread
);
805 decoding_buf
= (char *) xmalloc (size
);
807 /* We can't use the macro CODING_REQUIRE_DETECTION
808 because it always returns nonzero if the coding
809 system requires EOL detection. Here, we have to
810 check only whether or not the coding system
811 requires text-encoding detection. */
812 if (process_coding
.type
== coding_type_undecided
)
814 detect_coding (&process_coding
, bufptr
, nread
);
815 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
816 /* We have not yet allocated the composition
817 data because the coding type was undecided. */
818 coding_allocate_composition_data (&process_coding
, PT
);
820 if (process_coding
.cmp_data
)
821 process_coding
.cmp_data
->char_offset
= PT
;
823 decode_coding (&process_coding
, bufptr
, decoding_buf
,
826 if (display_on_the_fly
827 && saved_coding
.type
== coding_type_undecided
828 && process_coding
.type
!= coding_type_undecided
)
830 /* We have detected some coding system. But,
831 there's a possibility that the detection was
832 done by insufficient data. So, we try the code
833 detection again with more data. */
834 xfree (decoding_buf
);
835 display_on_the_fly
= 0;
836 process_coding
= saved_coding
;
838 /* This is to make the above condition always
839 fails in the future. */
840 saved_coding
.type
= coding_type_no_conversion
;
844 if (process_coding
.produced
> 0)
845 insert_1_both (decoding_buf
, process_coding
.produced_char
,
846 process_coding
.produced
, 0, 1, 0);
847 xfree (decoding_buf
);
849 if (process_coding
.result
== CODING_FINISH_INCONSISTENT_EOL
)
851 Lisp_Object eol_type
, coding
;
853 if (process_coding
.eol_type
== CODING_EOL_CR
)
855 /* CRs have been replaced with LFs. Undo
856 that in the text inserted above. */
859 move_gap_both (PT
, PT_BYTE
);
861 p
= BYTE_POS_ADDR (pt_byte_orig
);
862 for (; p
< GPT_ADDR
; ++p
)
866 else if (process_coding
.eol_type
== CODING_EOL_CRLF
)
868 /* CR LFs have been replaced with LFs. Undo
869 that by inserting CRs in front of LFs in
870 the text inserted above. */
871 EMACS_INT bytepos
, old_pt
, old_pt_byte
, nCR
;
874 old_pt_byte
= PT_BYTE
;
877 for (bytepos
= PT_BYTE
- 1;
878 bytepos
>= pt_byte_orig
;
880 if (FETCH_BYTE (bytepos
) == '\n')
882 EMACS_INT charpos
= BYTE_TO_CHAR (bytepos
);
883 TEMP_SET_PT_BOTH (charpos
, bytepos
);
884 insert_1_both ("\r", 1, 1, 0, 1, 0);
888 TEMP_SET_PT_BOTH (old_pt
+ nCR
, old_pt_byte
+ nCR
);
891 /* Set the coding system symbol to that for
893 eol_type
= Fget (saved_coding
.symbol
, Qeol_type
);
894 if (VECTORP (eol_type
)
895 && ASIZE (eol_type
) == 3
896 && SYMBOLP (AREF (eol_type
, CODING_EOL_LF
)))
897 coding
= AREF (eol_type
, CODING_EOL_LF
);
899 coding
= saved_coding
.symbol
;
901 process_coding
.symbol
= coding
;
902 process_coding
.eol_type
= CODING_EOL_LF
;
904 &= ~CODING_MODE_INHIBIT_INCONSISTENT_EOL
;
907 nread
-= process_coding
.consumed
;
910 /* As CARRYOVER should not be that large, we had
911 better avoid overhead of bcopy. */
912 BCOPY_SHORT (bufptr
+ process_coding
.consumed
, bufptr
,
914 if (process_coding
.result
== CODING_FINISH_INSUFFICIENT_CMP
)
916 /* The decoding ended because of insufficient data
917 area to record information about composition.
918 We must try decoding with additional data area
919 before reading more output for the process. */
920 coding_allocate_composition_data (&process_coding
, PT
);
921 goto repeat_decoding
;
926 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
929 /* Make the buffer bigger as we continue to read more data,
931 if (bufsize
< 64 * 1024 && total_read
> 32 * bufsize
)
936 tempptr
= (char *) alloca (bufsize
);
937 bcopy (bufptr
, tempptr
, bufsize
/ 2);
944 prepare_menu_bars ();
946 redisplay_preserve_echo_area (1);
947 /* This variable might have been set to 0 for code
948 detection. In that case, we set it back to 1 because
949 we should have already detected a coding system. */
950 display_on_the_fly
= 1;
958 && process_coding
.cmp_data
)
960 coding_restore_composition (&process_coding
, Fcurrent_buffer ());
961 coding_free_composition_data (&process_coding
);
965 int post_read_count
= SPECPDL_INDEX ();
967 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
968 inserted
= PT
- pt_orig
;
969 TEMP_SET_PT_BOTH (pt_orig
, pt_byte_orig
);
970 if (SYMBOLP (process_coding
.post_read_conversion
)
971 && !NILP (Ffboundp (process_coding
.post_read_conversion
)))
972 call1 (process_coding
.post_read_conversion
, make_number (inserted
));
974 Vlast_coding_system_used
= process_coding
.symbol
;
976 /* If the caller required, let the buffer inherit the
977 coding-system used to decode the process output. */
978 if (inherit_process_coding_system
)
979 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
980 make_number (total_read
));
982 unbind_to (post_read_count
, Qnil
);
986 /* Wait for it to terminate, unless it already has. */
987 wait_for_termination (pid
);
991 set_buffer_internal (old
);
993 /* Don't kill any children that the subprocess may have left behind
995 call_process_exited
= 1;
997 unbind_to (count
, Qnil
);
999 if (synch_process_termsig
)
1003 synchronize_system_messages_locale ();
1004 signame
= strsignal (synch_process_termsig
);
1007 signame
= "unknown";
1009 synch_process_death
= signame
;
1012 if (synch_process_death
)
1013 return code_convert_string_norecord (build_string (synch_process_death
),
1014 Vlocale_coding_system
, 0);
1015 return make_number (synch_process_retcode
);
1020 delete_temp_file (name
)
1023 /* Use Fdelete_file (indirectly) because that runs a file name handler.
1024 We did that when writing the file, so we should do so when deleting. */
1025 internal_delete_file (name
);
1029 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
1031 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
1032 The remaining arguments are optional.
1033 Delete the text if fourth arg DELETE is non-nil.
1035 Insert output in BUFFER before point; t means current buffer;
1036 nil for BUFFER means discard it; 0 means discard and don't wait.
1037 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1038 REAL-BUFFER says what to do with standard output, as above,
1039 while STDERR-FILE says what to do with standard error in the child.
1040 STDERR-FILE may be nil (discard standard error output),
1041 t (mix it with ordinary output), or a file name string.
1043 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1044 Remaining args are passed to PROGRAM at startup as command args.
1046 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1047 Otherwise it waits for PROGRAM to terminate
1048 and returns a numeric exit status or a signal description string.
1049 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1051 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1054 register Lisp_Object
*args
;
1056 struct gcpro gcpro1
;
1057 Lisp_Object filename_string
;
1058 register Lisp_Object start
, end
;
1059 int count
= SPECPDL_INDEX ();
1060 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1061 Lisp_Object coding_systems
;
1062 Lisp_Object val
, *args2
;
1068 if ((outf
= egetenv ("TMPDIR"))
1069 || (outf
= egetenv ("TMP"))
1070 || (outf
= egetenv ("TEMP")))
1071 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
1074 tempfile
= alloca (20);
1077 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
1078 strcat (tempfile
, "/");
1079 if ('/' == DIRECTORY_SEP
)
1080 dostounix_filename (tempfile
);
1082 unixtodos_filename (tempfile
);
1084 strcat (tempfile
, "emXXXXXX");
1086 strcat (tempfile
, "detmp.XXX");
1088 #else /* not DOS_NT */
1089 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
1090 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
1091 SBYTES (Vtemp_file_name_pattern
) + 1);
1092 #endif /* not DOS_NT */
1094 coding_systems
= Qt
;
1098 int fd
= mkstemp (tempfile
);
1100 report_file_error ("Failed to open temporary file",
1101 Fcons (Vtemp_file_name_pattern
, Qnil
));
1109 filename_string
= build_string (tempfile
);
1110 GCPRO1 (filename_string
);
1113 /* Decide coding-system of the contents of the temporary file. */
1114 if (!NILP (Vcoding_system_for_write
))
1115 val
= Vcoding_system_for_write
;
1116 else if (NILP (current_buffer
->enable_multibyte_characters
))
1120 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
1121 args2
[0] = Qcall_process_region
;
1122 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
1123 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1124 if (CONSP (coding_systems
))
1125 val
= XCDR (coding_systems
);
1126 else if (CONSP (Vdefault_process_coding_system
))
1127 val
= XCDR (Vdefault_process_coding_system
);
1133 int count1
= SPECPDL_INDEX ();
1135 specbind (intern ("coding-system-for-write"), val
);
1136 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
1138 unbind_to (count1
, Qnil
);
1141 /* Note that Fcall_process takes care of binding
1142 coding-system-for-read. */
1144 record_unwind_protect (delete_temp_file
, filename_string
);
1146 if (nargs
> 3 && !NILP (args
[3]))
1147 Fdelete_region (start
, end
);
1159 args
[1] = filename_string
;
1161 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1164 #ifndef VMS /* VMS version is in vmsproc.c. */
1166 static int relocate_fd ();
1168 /* This is the last thing run in a newly forked inferior
1169 either synchronous or asynchronous.
1170 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1171 Initialize inferior's priority, pgrp, connected dir and environment.
1172 then exec another program based on new_argv.
1174 This function may change environ for the superior process.
1175 Therefore, the superior process must save and restore the value
1176 of environ around the vfork and the call to this function.
1178 SET_PGRP is nonzero if we should put the subprocess into a separate
1181 CURRENT_DIR is an elisp string giving the path of the current
1182 directory the subprocess should have. Since we can't really signal
1183 a decent error from within the child, this should be verified as an
1184 executable directory by the parent. */
1187 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1189 register char **new_argv
;
1191 Lisp_Object current_dir
;
1198 #endif /* WINDOWSNT */
1200 int pid
= getpid ();
1202 #ifdef SET_EMACS_PRIORITY
1204 extern EMACS_INT emacs_priority
;
1206 if (emacs_priority
< 0)
1207 nice (- emacs_priority
);
1212 /* Close Emacs's descriptors that this process should not have. */
1213 close_process_descs ();
1215 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1216 we will lose if we call close_load_descs here. */
1218 close_load_descs ();
1221 /* Note that use of alloca is always safe here. It's obvious for systems
1222 that do not have true vfork or that have true (stack) alloca.
1223 If using vfork and C_ALLOCA it is safe because that changes
1224 the superior's static variables as if the superior had done alloca
1225 and will be cleaned up in the usual way. */
1227 register char *temp
;
1230 i
= SBYTES (current_dir
);
1232 /* MSDOS must have all environment variables malloc'ed, because
1233 low-level libc functions that launch subsidiary processes rely
1235 pwd_var
= (char *) xmalloc (i
+ 6);
1237 pwd_var
= (char *) alloca (i
+ 6);
1240 bcopy ("PWD=", pwd_var
, 4);
1241 bcopy (SDATA (current_dir
), temp
, i
);
1242 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1246 /* We can't signal an Elisp error here; we're in a vfork. Since
1247 the callers check the current directory before forking, this
1248 should only return an error if the directory's permissions
1249 are changed between the check and this chdir, but we should
1251 if (chdir (temp
) < 0)
1256 /* Get past the drive letter, so that d:/ is left alone. */
1257 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1264 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1265 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1269 /* Set `env' to a vector of the strings in Vprocess_environment. */
1271 register Lisp_Object tem
;
1272 register char **new_env
;
1273 register int new_length
;
1276 for (tem
= Vprocess_environment
;
1277 CONSP (tem
) && STRINGP (XCAR (tem
));
1281 /* new_length + 2 to include PWD and terminating 0. */
1282 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1284 /* If we have a PWD envvar, pass one down,
1285 but with corrected value. */
1287 *new_env
++ = pwd_var
;
1289 /* Copy the Vprocess_environment strings into new_env. */
1290 for (tem
= Vprocess_environment
;
1291 CONSP (tem
) && STRINGP (XCAR (tem
));
1295 char *string
= (char *) SDATA (XCAR (tem
));
1296 /* See if this string duplicates any string already in the env.
1297 If so, don't put it in.
1298 When an env var has multiple definitions,
1299 we keep the definition that comes first in process-environment. */
1300 for (; ep
!= new_env
; ep
++)
1302 char *p
= *ep
, *q
= string
;
1306 /* The string is malformed; might as well drop it. */
1315 *new_env
++ = string
;
1321 prepare_standard_handles (in
, out
, err
, handles
);
1322 set_process_dir (SDATA (current_dir
));
1323 #else /* not WINDOWSNT */
1324 /* Make sure that in, out, and err are not actually already in
1325 descriptors zero, one, or two; this could happen if Emacs is
1326 started with its standard in, out, or error closed, as might
1329 int oin
= in
, oout
= out
;
1331 /* We have to avoid relocating the same descriptor twice! */
1333 in
= relocate_fd (in
, 3);
1338 out
= relocate_fd (out
, 3);
1342 else if (err
== oout
)
1345 err
= relocate_fd (err
, 3);
1359 #endif /* not MSDOS */
1360 #endif /* not WINDOWSNT */
1362 #if defined(USG) && !defined(BSD_PGRPS)
1363 #ifndef SETPGRP_RELEASES_CTTY
1364 setpgrp (); /* No arguments but equivalent in this case */
1369 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1370 EMACS_SET_TTY_PGRP (0, &pid
);
1373 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1376 /* An error occurred while trying to run the subprocess. */
1377 report_file_error ("Spawning child process", Qnil
);
1379 #else /* not MSDOS */
1381 /* Spawn the child. (See ntproc.c:Spawnve). */
1382 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1383 reset_standard_handles (in
, out
, err
, handles
);
1385 /* An error occurred while trying to spawn the process. */
1386 report_file_error ("Spawning child process", Qnil
);
1388 #else /* not WINDOWSNT */
1389 /* execvp does not accept an environment arg so the only way
1390 to pass this environment is to set environ. Our caller
1391 is responsible for restoring the ambient value of environ. */
1393 execvp (new_argv
[0], new_argv
);
1395 emacs_write (1, "Can't exec program: ", 20);
1396 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1397 emacs_write (1, "\n", 1);
1399 #endif /* not WINDOWSNT */
1400 #endif /* not MSDOS */
1403 /* Move the file descriptor FD so that its number is not less than MINFD.
1404 If the file descriptor is moved at all, the original is freed. */
1406 relocate_fd (fd
, minfd
)
1416 char *message1
= "Error while setting up child: ";
1417 char *errmessage
= strerror (errno
);
1418 char *message2
= "\n";
1419 emacs_write (2, message1
, strlen (message1
));
1420 emacs_write (2, errmessage
, strlen (errmessage
));
1421 emacs_write (2, message2
, strlen (message2
));
1424 /* Note that we hold the original FD open while we recurse,
1425 to guarantee we'll get a new FD if we need it. */
1426 new = relocate_fd (new, minfd
);
1433 getenv_internal (var
, varlen
, value
, valuelen
)
1441 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCDR (scan
))
1445 entry
= XCAR (scan
);
1447 && SBYTES (entry
) > varlen
1448 && SREF (entry
, varlen
) == '='
1450 /* NT environment variables are case insensitive. */
1451 && ! strnicmp (SDATA (entry
), var
, varlen
)
1452 #else /* not WINDOWSNT */
1453 && ! bcmp (SDATA (entry
), var
, varlen
)
1454 #endif /* not WINDOWSNT */
1457 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1458 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1466 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 1, 0,
1467 doc
: /* Return the value of environment variable VAR, as a string.
1468 VAR should be a string. Value is nil if VAR is undefined in the environment.
1469 This function consults the variable ``process-environment'' for its value. */)
1477 if (getenv_internal (SDATA (var
), SBYTES (var
),
1479 return make_string (value
, valuelen
);
1484 /* A version of getenv that consults process_environment, easily
1493 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
1499 #endif /* not VMS */
1501 /* This is run before init_cmdargs. */
1506 char *data_dir
= egetenv ("EMACSDATA");
1507 char *doc_dir
= egetenv ("EMACSDOC");
1510 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1513 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1516 /* Check the EMACSPATH environment variable, defaulting to the
1517 PATH_EXEC path from epaths.h. */
1518 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1519 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1520 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1523 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1528 char *data_dir
= egetenv ("EMACSDATA");
1531 Lisp_Object tempdir
;
1533 if (!NILP (Vinstallation_directory
))
1535 /* Add to the path the lib-src subdir of the installation dir. */
1537 tem
= Fexpand_file_name (build_string ("lib-src"),
1538 Vinstallation_directory
);
1540 /* MSDOS uses wrapped binaries, so don't do this. */
1541 if (NILP (Fmember (tem
, Vexec_path
)))
1543 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1544 Vexec_path
= Fcons (tem
, Vexec_path
);
1545 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1548 Vexec_directory
= Ffile_name_as_directory (tem
);
1549 #endif /* not DOS_NT */
1551 /* Maybe use ../etc as well as ../lib-src. */
1554 tem
= Fexpand_file_name (build_string ("etc"),
1555 Vinstallation_directory
);
1556 Vdoc_directory
= Ffile_name_as_directory (tem
);
1560 /* Look for the files that should be in etc. We don't use
1561 Vinstallation_directory, because these files are never installed
1562 near the executable, and they are never in the build
1563 directory when that's different from the source directory.
1565 Instead, if these files are not in the nominal place, we try the
1566 source directory. */
1569 Lisp_Object tem
, tem1
, srcdir
;
1571 srcdir
= Fexpand_file_name (build_string ("../src/"),
1572 build_string (PATH_DUMPLOADSEARCH
));
1573 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1574 tem1
= Ffile_exists_p (tem
);
1575 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1578 newdir
= Fexpand_file_name (build_string ("../etc/"),
1579 build_string (PATH_DUMPLOADSEARCH
));
1580 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1581 tem1
= Ffile_exists_p (tem
);
1583 Vdata_directory
= newdir
;
1591 tempdir
= Fdirectory_file_name (Vexec_directory
);
1592 if (access (SDATA (tempdir
), 0) < 0)
1593 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1597 tempdir
= Fdirectory_file_name (Vdata_directory
);
1598 if (access (SDATA (tempdir
), 0) < 0)
1599 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1603 Vshell_file_name
= build_string ("*dcl*");
1605 sh
= (char *) getenv ("SHELL");
1606 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1610 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1612 if (getenv ("TMPDIR"))
1614 char *dir
= getenv ("TMPDIR");
1615 Vtemp_file_name_pattern
1616 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1617 build_string (dir
));
1620 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1624 Vshared_game_score_directory
= Qnil
;
1626 Vshared_game_score_directory
= build_string (PATH_GAME
);
1627 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1628 Vshared_game_score_directory
= Qnil
;
1633 set_process_environment ()
1635 register char **envp
;
1637 Vprocess_environment
= Qnil
;
1641 for (envp
= environ
; *envp
; envp
++)
1642 Vprocess_environment
= Fcons (build_string (*envp
),
1643 Vprocess_environment
);
1650 Qbuffer_file_type
= intern ("buffer-file-type");
1651 staticpro (&Qbuffer_file_type
);
1654 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1655 doc
: /* *File name to load inferior shells from.
1656 Initialized from the SHELL environment variable. */);
1658 DEFVAR_LISP ("exec-path", &Vexec_path
,
1659 doc
: /* *List of directories to search programs to run in subprocesses.
1660 Each element is a string (directory name) or nil (try default directory). */);
1662 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1663 doc
: /* *List of suffixes to try to find executable file names.
1664 Each element is a string. */);
1665 Vexec_suffixes
= Qnil
;
1667 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1668 doc
: /* Directory for executables for Emacs to invoke.
1669 More generally, this includes any architecture-dependent files
1670 that are built and installed from the Emacs distribution. */);
1672 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1673 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1674 These are files intended for Emacs to use while it runs. */);
1676 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1677 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1678 This is usually the same as data-directory. */);
1680 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1681 doc
: /* For internal use by the build procedure only.
1682 This is the name of the directory in which the build procedure installed
1683 Emacs's info files; the default value for Info-default-directory-list
1685 Vconfigure_info_directory
= build_string (PATH_INFO
);
1687 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1688 doc
: /* Directory of score files for games which come with GNU Emacs.
1689 If this variable is nil, then Emacs is unable to use a shared directory. */);
1691 Vshared_game_score_directory
= Qnil
;
1693 Vshared_game_score_directory
= build_string (PATH_GAME
);
1696 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1697 doc
: /* Pattern for making names for temporary files.
1698 This is used by `call-process-region'. */);
1699 /* This variable is initialized in init_callproc. */
1701 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1702 doc
: /* List of environment variables for subprocesses to inherit.
1703 Each element should be a string of the form ENVVARNAME=VALUE.
1704 If multiple entries define the same variable, the first one always
1706 The environment which Emacs inherits is placed in this variable
1708 Non-ASCII characters are encoded according to the initial value of
1709 `locale-coding-system', i.e. the elements must normally be decoded for use.
1710 See `setenv' and `getenv'. */);
1713 defsubr (&Scall_process
);
1714 defsubr (&Sgetenv_internal
);
1716 defsubr (&Scall_process_region
);
1719 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1720 (do not change this comment) */