1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
32 /* Define SIGCHLD as an alias for SIGCLD. */
34 #if !defined (SIGCHLD) && defined (SIGCLD)
35 #define SIGCHLD SIGCLD
38 #include <sys/types.h>
46 #define INCLUDED_FCNTL
53 #include <stdlib.h> /* for proper declaration of environ */
56 #define _P_NOWAIT 1 /* from process.h */
59 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
60 #define INCLUDED_FCNTL
63 #include <sys/param.h>
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
;
223 int bufsize
= sizeof buf
;
224 int count
= SPECPDL_INDEX ();
226 register const unsigned char **new_argv
227 = (const unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
228 struct buffer
*old
= current_buffer
;
229 /* File to use for stderr in the child.
230 t means use same as standard output. */
231 Lisp_Object error_file
;
232 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
233 char *outf
, *tempfile
;
243 struct coding_system process_coding
; /* coding-system of process output */
244 struct coding_system argument_coding
; /* coding-system of arguments */
245 /* Set to the return value of Ffind_operation_coding_system. */
246 Lisp_Object coding_systems
;
248 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
251 CHECK_STRING (args
[0]);
256 /* Without asynchronous processes we cannot have BUFFER == 0. */
258 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
259 error ("Operating system cannot handle asynchronous subprocesses");
260 #endif /* subprocesses */
262 /* Decide the coding-system for giving arguments. */
264 Lisp_Object val
, *args2
;
267 /* If arguments are supplied, we may have to encode them. */
272 for (i
= 4; i
< nargs
; i
++)
273 CHECK_STRING (args
[i
]);
275 for (i
= 4; i
< nargs
; i
++)
276 if (STRING_MULTIBYTE (args
[i
]))
279 if (!NILP (Vcoding_system_for_write
))
280 val
= Vcoding_system_for_write
;
281 else if (! must_encode
)
285 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
286 args2
[0] = Qcall_process
;
287 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
288 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
289 if (CONSP (coding_systems
))
290 val
= XCDR (coding_systems
);
291 else if (CONSP (Vdefault_process_coding_system
))
292 val
= XCDR (Vdefault_process_coding_system
);
296 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
300 if (nargs
>= 2 && ! NILP (args
[1]))
302 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
303 CHECK_STRING (infile
);
306 infile
= build_string (NULL_DEVICE
);
312 /* If BUFFER is a list, its meaning is
313 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
316 if (CONSP (XCDR (buffer
)))
318 Lisp_Object stderr_file
;
319 stderr_file
= XCAR (XCDR (buffer
));
321 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
322 error_file
= stderr_file
;
324 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
327 buffer
= XCAR (buffer
);
330 if (!(EQ (buffer
, Qnil
)
332 || INTEGERP (buffer
)))
334 Lisp_Object spec_buffer
;
335 spec_buffer
= buffer
;
336 buffer
= Fget_buffer_create (buffer
);
337 /* Mention the buffer name for a better error message. */
339 CHECK_BUFFER (spec_buffer
);
340 CHECK_BUFFER (buffer
);
346 /* Make sure that the child will be able to chdir to the current
347 buffer's current directory, or its unhandled equivalent. We
348 can't just have the child check for an error when it does the
349 chdir, since it's in a vfork.
351 We have to GCPRO around this because Fexpand_file_name,
352 Funhandled_file_name_directory, and Ffile_accessible_directory_p
353 might call a file name handling function. The argument list is
354 protected by the caller, so all we really have to worry about is
357 struct gcpro gcpro1
, gcpro2
, gcpro3
;
359 current_dir
= current_buffer
->directory
;
361 GCPRO3 (infile
, buffer
, current_dir
);
364 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir
),
366 if (NILP (Ffile_accessible_directory_p (current_dir
)))
367 report_file_error ("Setting current directory",
368 Fcons (current_buffer
->directory
, Qnil
));
373 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
375 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
378 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
380 /* Search for program; barf if not found. */
384 GCPRO1 (current_dir
);
385 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
390 emacs_close (filefd
);
391 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
394 /* If program file name starts with /: for quoting a magic name,
396 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
397 && SREF (path
, 1) == ':')
398 path
= Fsubstring (path
, make_number (2), Qnil
);
400 new_argv
[0] = SDATA (path
);
404 struct gcpro gcpro1
, gcpro2
, gcpro3
;
406 GCPRO3 (infile
, buffer
, current_dir
);
407 argument_coding
.dst_multibyte
= 0;
408 for (i
= 4; i
< nargs
; i
++)
410 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
411 if (CODING_REQUIRE_ENCODING (&argument_coding
))
413 /* We must encode this argument. */
414 args
[i
] = encode_coding_string (args
[i
], &argument_coding
, 1);
415 if (argument_coding
.type
== coding_type_ccl
)
416 setup_ccl_program (&(argument_coding
.spec
.ccl
.encoder
), Qnil
);
418 new_argv
[i
- 3] = SDATA (args
[i
]);
421 new_argv
[nargs
- 3] = 0;
426 #ifdef MSDOS /* MW, July 1993 */
427 if ((outf
= egetenv ("TMPDIR")))
428 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
431 tempfile
= alloca (20);
434 dostounix_filename (tempfile
);
435 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
436 strcat (tempfile
, "/");
437 strcat (tempfile
, "detmp.XXX");
440 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
443 emacs_close (filefd
);
444 report_file_error ("Opening process output file",
445 Fcons (build_string (tempfile
), Qnil
));
452 /* Since we don't have pipes on the Mac, create a temporary file to
453 hold the output of the subprocess. */
454 tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
455 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
456 SBYTES (Vtemp_file_name_pattern
) + 1);
460 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
464 report_file_error ("Opening process output file",
465 Fcons (build_string (tempfile
), Qnil
));
471 if (INTEGERP (buffer
))
472 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
480 emacs_close (filefd
);
481 report_file_error ("Creating process pipe", Qnil
);
486 /* Replaced by close_process_descs */
487 set_exclusive_use (fd
[0]);
492 /* child_setup must clobber environ in systems with true vfork.
493 Protect it from permanent change. */
494 register char **save_environ
= environ
;
495 register int fd1
= fd
[1];
498 #if 0 /* Some systems don't have sigblock. */
499 mask
= sigblock (sigmask (SIGCHLD
));
502 /* Record that we're about to create a synchronous process. */
503 synch_process_alive
= 1;
505 /* These vars record information from process termination.
506 Clear them now before process can possibly terminate,
507 to avoid timing error if process terminates soon. */
508 synch_process_death
= 0;
509 synch_process_retcode
= 0;
510 synch_process_termsig
= 0;
512 if (NILP (error_file
))
513 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
514 else if (STRINGP (error_file
))
517 fd_error
= emacs_open (SDATA (error_file
),
518 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
520 #else /* not DOS_NT */
521 fd_error
= creat (SDATA (error_file
), 0666);
522 #endif /* not DOS_NT */
527 emacs_close (filefd
);
535 report_file_error ("Cannot redirect stderr",
536 Fcons ((NILP (error_file
)
537 ? build_string (NULL_DEVICE
) : error_file
),
541 current_dir
= ENCODE_FILE (current_dir
);
545 /* Call run_mac_command in sysdep.c here directly instead of doing
546 a child_setup as for MSDOS and other platforms. Note that this
547 code does not handle passing the environment to the synchronous
549 char *infn
, *outfn
, *errfn
, *currdn
;
551 /* close these files so subprocess can write to them */
553 if (fd_error
!= outfilefd
)
555 fd1
= -1; /* No harm in closing that one! */
557 infn
= SDATA (infile
);
559 if (NILP (error_file
))
561 else if (EQ (Qt
, error_file
))
564 errfn
= SDATA (error_file
);
565 currdn
= SDATA (current_dir
);
566 pid
= run_mac_command (new_argv
, currdn
, infn
, outfn
, errfn
);
568 /* Record that the synchronous process exited and note its
569 termination status. */
570 synch_process_alive
= 0;
571 synch_process_retcode
= pid
;
572 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
574 synchronize_system_messages_locale ();
575 synch_process_death
= strerror (errno
);
578 /* Since CRLF is converted to LF within `decode_coding', we can
579 always open a file with binary mode. */
580 fd
[0] = open (tempfile
, O_BINARY
);
585 report_file_error ("Cannot re-open temporary file", Qnil
);
588 #else /* not MAC_OS8 */
589 #ifdef MSDOS /* MW, July 1993 */
590 /* Note that on MSDOS `child_setup' actually returns the child process
591 exit status, not its PID, so we assign it to `synch_process_retcode'
593 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
596 /* Record that the synchronous process exited and note its
597 termination status. */
598 synch_process_alive
= 0;
599 synch_process_retcode
= pid
;
600 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
602 synchronize_system_messages_locale ();
603 synch_process_death
= strerror (errno
);
606 emacs_close (outfilefd
);
607 if (fd_error
!= outfilefd
)
608 emacs_close (fd_error
);
609 fd1
= -1; /* No harm in closing that one! */
610 /* Since CRLF is converted to LF within `decode_coding', we can
611 always open a file with binary mode. */
612 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
616 emacs_close (filefd
);
617 report_file_error ("Cannot re-open temporary file", Qnil
);
619 #else /* not MSDOS */
621 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
623 #else /* not WINDOWSNT */
635 #if defined (USG) && !defined (BSD_PGRPS)
640 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
= display_p
;
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 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
781 total_read
+= this_read
;
783 if (display_on_the_fly
)
787 /* Now NREAD is the total amount of data in the buffer. */
792 if (! CODING_MAY_REQUIRE_DECODING (&process_coding
))
793 insert_1_both (bufptr
, nread
, nread
, 0, 1, 0);
795 { /* We have to decode the input. */
800 size
= decoding_buffer_size (&process_coding
, nread
);
801 decoding_buf
= (char *) xmalloc (size
);
803 /* We can't use the macro CODING_REQUIRE_DETECTION
804 because it always returns nonzero if the coding
805 system requires EOL detection. Here, we have to
806 check only whether or not the coding system
807 requires text-encoding detection. */
808 if (process_coding
.type
== coding_type_undecided
)
810 detect_coding (&process_coding
, bufptr
, nread
);
811 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
812 /* We have not yet allocated the composition
813 data because the coding type was undecided. */
814 coding_allocate_composition_data (&process_coding
, PT
);
816 if (process_coding
.cmp_data
)
817 process_coding
.cmp_data
->char_offset
= PT
;
819 decode_coding (&process_coding
, bufptr
, decoding_buf
,
822 if (display_on_the_fly
823 && saved_coding
.type
== coding_type_undecided
824 && process_coding
.type
!= coding_type_undecided
)
826 /* We have detected some coding system. But,
827 there's a possibility that the detection was
828 done by insufficient data. So, we try the code
829 detection again with more data. */
830 xfree (decoding_buf
);
831 display_on_the_fly
= 0;
832 process_coding
= saved_coding
;
834 /* This is to make the above condition always
835 fails in the future. */
836 saved_coding
.type
= coding_type_no_conversion
;
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);
940 prepare_menu_bars ();
942 redisplay_preserve_echo_area (1);
943 /* This variable might have been set to 0 for code
944 detection. In that case, we set it back to 1 because
945 we should have already detected a coding system. */
946 display_on_the_fly
= 1;
954 && process_coding
.cmp_data
)
956 coding_restore_composition (&process_coding
, Fcurrent_buffer ());
957 coding_free_composition_data (&process_coding
);
961 int post_read_count
= SPECPDL_INDEX ();
963 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
964 inserted
= PT
- pt_orig
;
965 TEMP_SET_PT_BOTH (pt_orig
, pt_byte_orig
);
966 if (SYMBOLP (process_coding
.post_read_conversion
)
967 && !NILP (Ffboundp (process_coding
.post_read_conversion
)))
968 call1 (process_coding
.post_read_conversion
, make_number (inserted
));
970 Vlast_coding_system_used
= process_coding
.symbol
;
972 /* If the caller required, let the buffer inherit the
973 coding-system used to decode the process output. */
974 if (inherit_process_coding_system
)
975 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
976 make_number (total_read
));
978 unbind_to (post_read_count
, Qnil
);
982 /* Wait for it to terminate, unless it already has. */
983 wait_for_termination (pid
);
987 set_buffer_internal (old
);
989 /* Don't kill any children that the subprocess may have left behind
991 call_process_exited
= 1;
993 unbind_to (count
, Qnil
);
995 if (synch_process_termsig
)
999 synchronize_system_messages_locale ();
1000 signame
= strsignal (synch_process_termsig
);
1003 signame
= "unknown";
1005 synch_process_death
= signame
;
1008 if (synch_process_death
)
1009 return code_convert_string_norecord (build_string (synch_process_death
),
1010 Vlocale_coding_system
, 0);
1011 return make_number (synch_process_retcode
);
1016 delete_temp_file (name
)
1019 /* Use Fdelete_file (indirectly) because that runs a file name handler.
1020 We did that when writing the file, so we should do so when deleting. */
1021 internal_delete_file (name
);
1025 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
1027 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
1028 The remaining arguments are optional.
1029 Delete the text if fourth arg DELETE is non-nil.
1031 Insert output in BUFFER before point; t means current buffer;
1032 nil for BUFFER means discard it; 0 means discard and don't wait.
1033 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1034 REAL-BUFFER says what to do with standard output, as above,
1035 while STDERR-FILE says what to do with standard error in the child.
1036 STDERR-FILE may be nil (discard standard error output),
1037 t (mix it with ordinary output), or a file name string.
1039 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1040 Remaining args are passed to PROGRAM at startup as command args.
1042 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1043 Otherwise it waits for PROGRAM to terminate
1044 and returns a numeric exit status or a signal description string.
1045 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1047 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1050 register Lisp_Object
*args
;
1052 struct gcpro gcpro1
;
1053 Lisp_Object filename_string
;
1054 register Lisp_Object start
, end
;
1055 int count
= SPECPDL_INDEX ();
1056 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1057 Lisp_Object coding_systems
;
1058 Lisp_Object val
, *args2
;
1064 if ((outf
= egetenv ("TMPDIR"))
1065 || (outf
= egetenv ("TMP"))
1066 || (outf
= egetenv ("TEMP")))
1067 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
1070 tempfile
= alloca (20);
1073 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
1074 strcat (tempfile
, "/");
1075 if ('/' == DIRECTORY_SEP
)
1076 dostounix_filename (tempfile
);
1078 unixtodos_filename (tempfile
);
1080 strcat (tempfile
, "emXXXXXX");
1082 strcat (tempfile
, "detmp.XXX");
1084 #else /* not DOS_NT */
1085 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
1086 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
1087 SBYTES (Vtemp_file_name_pattern
) + 1);
1088 #endif /* not DOS_NT */
1090 coding_systems
= Qt
;
1094 int fd
= mkstemp (tempfile
);
1096 report_file_error ("Failed to open temporary file",
1097 Fcons (Vtemp_file_name_pattern
, Qnil
));
1105 filename_string
= build_string (tempfile
);
1106 GCPRO1 (filename_string
);
1109 /* Decide coding-system of the contents of the temporary file. */
1110 if (!NILP (Vcoding_system_for_write
))
1111 val
= Vcoding_system_for_write
;
1112 else if (NILP (current_buffer
->enable_multibyte_characters
))
1116 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
1117 args2
[0] = Qcall_process_region
;
1118 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
1119 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1120 if (CONSP (coding_systems
))
1121 val
= XCDR (coding_systems
);
1122 else if (CONSP (Vdefault_process_coding_system
))
1123 val
= XCDR (Vdefault_process_coding_system
);
1129 int count1
= SPECPDL_INDEX ();
1131 specbind (intern ("coding-system-for-write"), val
);
1132 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
1134 unbind_to (count1
, Qnil
);
1137 /* Note that Fcall_process takes care of binding
1138 coding-system-for-read. */
1140 record_unwind_protect (delete_temp_file
, filename_string
);
1142 if (nargs
> 3 && !NILP (args
[3]))
1143 Fdelete_region (start
, end
);
1155 args
[1] = filename_string
;
1157 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1160 #ifndef VMS /* VMS version is in vmsproc.c. */
1162 static int relocate_fd ();
1164 /* This is the last thing run in a newly forked inferior
1165 either synchronous or asynchronous.
1166 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1167 Initialize inferior's priority, pgrp, connected dir and environment.
1168 then exec another program based on new_argv.
1170 This function may change environ for the superior process.
1171 Therefore, the superior process must save and restore the value
1172 of environ around the vfork and the call to this function.
1174 SET_PGRP is nonzero if we should put the subprocess into a separate
1177 CURRENT_DIR is an elisp string giving the path of the current
1178 directory the subprocess should have. Since we can't really signal
1179 a decent error from within the child, this should be verified as an
1180 executable directory by the parent. */
1183 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1185 register char **new_argv
;
1187 Lisp_Object current_dir
;
1194 #endif /* WINDOWSNT */
1196 int pid
= getpid ();
1198 #ifdef SET_EMACS_PRIORITY
1200 extern EMACS_INT emacs_priority
;
1202 if (emacs_priority
< 0)
1203 nice (- emacs_priority
);
1208 /* Close Emacs's descriptors that this process should not have. */
1209 close_process_descs ();
1211 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1212 we will lose if we call close_load_descs here. */
1214 close_load_descs ();
1217 /* Note that use of alloca is always safe here. It's obvious for systems
1218 that do not have true vfork or that have true (stack) alloca.
1219 If using vfork and C_ALLOCA it is safe because that changes
1220 the superior's static variables as if the superior had done alloca
1221 and will be cleaned up in the usual way. */
1223 register char *temp
;
1226 i
= SBYTES (current_dir
);
1228 /* MSDOS must have all environment variables malloc'ed, because
1229 low-level libc functions that launch subsidiary processes rely
1231 pwd_var
= (char *) xmalloc (i
+ 6);
1233 pwd_var
= (char *) alloca (i
+ 6);
1236 bcopy ("PWD=", pwd_var
, 4);
1237 bcopy (SDATA (current_dir
), temp
, i
);
1238 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1242 /* We can't signal an Elisp error here; we're in a vfork. Since
1243 the callers check the current directory before forking, this
1244 should only return an error if the directory's permissions
1245 are changed between the check and this chdir, but we should
1247 if (chdir (temp
) < 0)
1252 /* Get past the drive letter, so that d:/ is left alone. */
1253 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1260 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1261 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1265 /* Set `env' to a vector of the strings in Vprocess_environment. */
1267 register Lisp_Object tem
;
1268 register char **new_env
;
1269 register int new_length
;
1272 for (tem
= Vprocess_environment
;
1273 CONSP (tem
) && STRINGP (XCAR (tem
));
1277 /* new_length + 2 to include PWD and terminating 0. */
1278 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1280 /* If we have a PWD envvar, pass one down,
1281 but with corrected value. */
1283 *new_env
++ = pwd_var
;
1285 /* Copy the Vprocess_environment strings into new_env. */
1286 for (tem
= Vprocess_environment
;
1287 CONSP (tem
) && STRINGP (XCAR (tem
));
1291 char *string
= (char *) SDATA (XCAR (tem
));
1292 /* See if this string duplicates any string already in the env.
1293 If so, don't put it in.
1294 When an env var has multiple definitions,
1295 we keep the definition that comes first in process-environment. */
1296 for (; ep
!= new_env
; ep
++)
1298 char *p
= *ep
, *q
= string
;
1302 /* The string is malformed; might as well drop it. */
1311 *new_env
++ = string
;
1317 prepare_standard_handles (in
, out
, err
, handles
);
1318 set_process_dir (SDATA (current_dir
));
1319 #else /* not WINDOWSNT */
1320 /* Make sure that in, out, and err are not actually already in
1321 descriptors zero, one, or two; this could happen if Emacs is
1322 started with its standard in, out, or error closed, as might
1325 int oin
= in
, oout
= out
;
1327 /* We have to avoid relocating the same descriptor twice! */
1329 in
= relocate_fd (in
, 3);
1334 out
= relocate_fd (out
, 3);
1338 else if (err
== oout
)
1341 err
= relocate_fd (err
, 3);
1355 #endif /* not MSDOS */
1356 #endif /* not WINDOWSNT */
1358 #if defined(USG) && !defined(BSD_PGRPS)
1359 #ifndef SETPGRP_RELEASES_CTTY
1360 setpgrp (); /* No arguments but equivalent in this case */
1365 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1366 EMACS_SET_TTY_PGRP (0, &pid
);
1369 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1372 /* An error occurred while trying to run the subprocess. */
1373 report_file_error ("Spawning child process", Qnil
);
1375 #else /* not MSDOS */
1377 /* Spawn the child. (See ntproc.c:Spawnve). */
1378 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1379 reset_standard_handles (in
, out
, err
, handles
);
1381 /* An error occurred while trying to spawn the process. */
1382 report_file_error ("Spawning child process", Qnil
);
1384 #else /* not WINDOWSNT */
1385 /* execvp does not accept an environment arg so the only way
1386 to pass this environment is to set environ. Our caller
1387 is responsible for restoring the ambient value of environ. */
1389 execvp (new_argv
[0], new_argv
);
1391 emacs_write (1, "Can't exec program: ", 20);
1392 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1393 emacs_write (1, "\n", 1);
1395 #endif /* not WINDOWSNT */
1396 #endif /* not MSDOS */
1399 /* Move the file descriptor FD so that its number is not less than MINFD.
1400 If the file descriptor is moved at all, the original is freed. */
1402 relocate_fd (fd
, minfd
)
1412 char *message1
= "Error while setting up child: ";
1413 char *errmessage
= strerror (errno
);
1414 char *message2
= "\n";
1415 emacs_write (2, message1
, strlen (message1
));
1416 emacs_write (2, errmessage
, strlen (errmessage
));
1417 emacs_write (2, message2
, strlen (message2
));
1420 /* Note that we hold the original FD open while we recurse,
1421 to guarantee we'll get a new FD if we need it. */
1422 new = relocate_fd (new, minfd
);
1429 getenv_internal (var
, varlen
, value
, valuelen
)
1437 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCDR (scan
))
1441 entry
= XCAR (scan
);
1443 && SBYTES (entry
) > varlen
1444 && SREF (entry
, varlen
) == '='
1446 /* NT environment variables are case insensitive. */
1447 && ! strnicmp (SDATA (entry
), var
, varlen
)
1448 #else /* not WINDOWSNT */
1449 && ! bcmp (SDATA (entry
), var
, varlen
)
1450 #endif /* not WINDOWSNT */
1453 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1454 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1462 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 1, 0,
1463 doc
: /* Return the value of environment variable VAR, as a string.
1464 VAR should be a string. Value is nil if VAR is undefined in the environment.
1465 This function consults the variable ``process-environment'' for its value. */)
1473 if (getenv_internal (SDATA (var
), SBYTES (var
),
1475 return make_string (value
, valuelen
);
1480 /* A version of getenv that consults process_environment, easily
1489 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
1495 #endif /* not VMS */
1497 /* This is run before init_cmdargs. */
1502 char *data_dir
= egetenv ("EMACSDATA");
1503 char *doc_dir
= egetenv ("EMACSDOC");
1506 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1509 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1512 /* Check the EMACSPATH environment variable, defaulting to the
1513 PATH_EXEC path from epaths.h. */
1514 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1515 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1516 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1519 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1524 char *data_dir
= egetenv ("EMACSDATA");
1527 Lisp_Object tempdir
;
1529 if (!NILP (Vinstallation_directory
))
1531 /* Add to the path the lib-src subdir of the installation dir. */
1533 tem
= Fexpand_file_name (build_string ("lib-src"),
1534 Vinstallation_directory
);
1536 /* MSDOS uses wrapped binaries, so don't do this. */
1537 if (NILP (Fmember (tem
, Vexec_path
)))
1539 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1540 Vexec_path
= Fcons (tem
, Vexec_path
);
1541 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1544 Vexec_directory
= Ffile_name_as_directory (tem
);
1545 #endif /* not DOS_NT */
1547 /* Maybe use ../etc as well as ../lib-src. */
1550 tem
= Fexpand_file_name (build_string ("etc"),
1551 Vinstallation_directory
);
1552 Vdoc_directory
= Ffile_name_as_directory (tem
);
1556 /* Look for the files that should be in etc. We don't use
1557 Vinstallation_directory, because these files are never installed
1558 near the executable, and they are never in the build
1559 directory when that's different from the source directory.
1561 Instead, if these files are not in the nominal place, we try the
1562 source directory. */
1565 Lisp_Object tem
, tem1
, srcdir
;
1567 srcdir
= Fexpand_file_name (build_string ("../src/"),
1568 build_string (PATH_DUMPLOADSEARCH
));
1569 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1570 tem1
= Ffile_exists_p (tem
);
1571 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1574 newdir
= Fexpand_file_name (build_string ("../etc/"),
1575 build_string (PATH_DUMPLOADSEARCH
));
1576 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1577 tem1
= Ffile_exists_p (tem
);
1579 Vdata_directory
= newdir
;
1587 tempdir
= Fdirectory_file_name (Vexec_directory
);
1588 if (access (SDATA (tempdir
), 0) < 0)
1589 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1593 tempdir
= Fdirectory_file_name (Vdata_directory
);
1594 if (access (SDATA (tempdir
), 0) < 0)
1595 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1599 Vshell_file_name
= build_string ("*dcl*");
1601 sh
= (char *) getenv ("SHELL");
1602 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1606 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1608 if (getenv ("TMPDIR"))
1610 char *dir
= getenv ("TMPDIR");
1611 Vtemp_file_name_pattern
1612 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1613 build_string (dir
));
1616 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1620 Vshared_game_score_directory
= Qnil
;
1622 Vshared_game_score_directory
= build_string (PATH_GAME
);
1623 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1624 Vshared_game_score_directory
= Qnil
;
1629 set_process_environment ()
1631 register char **envp
;
1633 Vprocess_environment
= Qnil
;
1637 for (envp
= environ
; *envp
; envp
++)
1638 Vprocess_environment
= Fcons (build_string (*envp
),
1639 Vprocess_environment
);
1646 Qbuffer_file_type
= intern ("buffer-file-type");
1647 staticpro (&Qbuffer_file_type
);
1650 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1651 doc
: /* *File name to load inferior shells from.
1652 Initialized from the SHELL environment variable. */);
1654 DEFVAR_LISP ("exec-path", &Vexec_path
,
1655 doc
: /* *List of directories to search programs to run in subprocesses.
1656 Each element is a string (directory name) or nil (try default directory). */);
1658 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1659 doc
: /* *List of suffixes to try to find executable file names.
1660 Each element is a string. */);
1661 Vexec_suffixes
= Qnil
;
1663 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1664 doc
: /* Directory for executables for Emacs to invoke.
1665 More generally, this includes any architecture-dependent files
1666 that are built and installed from the Emacs distribution. */);
1668 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1669 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1670 These are files intended for Emacs to use while it runs. */);
1672 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1673 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1674 This is usually the same as data-directory. */);
1676 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1677 doc
: /* For internal use by the build procedure only.
1678 This is the name of the directory in which the build procedure installed
1679 Emacs's info files; the default value for Info-default-directory-list
1681 Vconfigure_info_directory
= build_string (PATH_INFO
);
1683 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1684 doc
: /* Directory of score files for games which come with GNU Emacs.
1685 If this variable is nil, then Emacs is unable to use a shared directory. */);
1687 Vshared_game_score_directory
= Qnil
;
1689 Vshared_game_score_directory
= build_string (PATH_GAME
);
1692 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1693 doc
: /* Pattern for making names for temporary files.
1694 This is used by `call-process-region'. */);
1695 /* This variable is initialized in init_callproc. */
1697 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1698 doc
: /* List of environment variables for subprocesses to inherit.
1699 Each element should be a string of the form ENVVARNAME=VALUE.
1700 If multiple entries define the same variable, the first one always
1702 The environment which Emacs inherits is placed in this variable
1704 Non-ASCII characters are encoded according to the initial value of
1705 `locale-coding-system', i.e. the elements must normally be decoded for use.
1706 See `setenv' and `getenv'. */);
1709 defsubr (&Scall_process
);
1710 defsubr (&Sgetenv_internal
);
1712 defsubr (&Scall_process_region
);
1715 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1716 (do not change this comment) */