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., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
32 /* Define SIGCHLD as an alias for SIGCLD. */
34 #if !defined (SIGCHLD) && defined (SIGCLD)
35 #define SIGCHLD SIGCLD
38 #include <sys/types.h>
46 #define INCLUDED_FCNTL
53 #include <stdlib.h> /* for proper declaration of environ */
56 #define _P_NOWAIT 1 /* from process.h */
59 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
60 #define INCLUDED_FCNTL
63 #include <sys/param.h>
81 #include "composite.h"
84 #include "syssignal.h"
86 #include "blockinput.h"
93 extern noshare
char **environ
;
96 extern char **environ
;
101 #if !defined (USG) || defined (BSD_PGRPS)
103 #define setpgrp setpgid
107 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
108 Lisp_Object Vdata_directory
, Vdoc_directory
;
109 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
110 Lisp_Object Vtemp_file_name_pattern
;
112 Lisp_Object Vshell_file_name
;
114 Lisp_Object Vprocess_environment
;
117 Lisp_Object Qbuffer_file_type
;
120 /* True iff we are about to fork off a synchronous process or if we
121 are waiting for it. */
122 int synch_process_alive
;
124 /* Nonzero => this is a string explaining death of synchronous subprocess. */
125 char *synch_process_death
;
127 /* Nonzero => this is the signal number that terminated the subprocess. */
128 int synch_process_termsig
;
130 /* If synch_process_death is zero,
131 this is exit code of synchronous subprocess. */
132 int synch_process_retcode
;
134 /* Clean up when exiting Fcall_process.
135 On MSDOS, delete the temporary file on any kind of termination.
136 On Unix, kill the process and any children on termination by signal. */
138 /* Nonzero if this is termination due to exit. */
139 static int call_process_exited
;
141 #ifndef VMS /* VMS version is in vmsproc.c. */
144 call_process_kill (fdpid
)
147 emacs_close (XFASTINT (Fcar (fdpid
)));
148 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
149 synch_process_alive
= 0;
154 call_process_cleanup (fdpid
)
157 #if defined (MSDOS) || defined (MAC_OS8)
158 /* for MSDOS fdpid is really (fd . tempfile) */
159 register Lisp_Object file
;
161 emacs_close (XFASTINT (Fcar (fdpid
)));
162 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
163 unlink (SDATA (file
));
164 #else /* not MSDOS and not MAC_OS8 */
165 register int pid
= XFASTINT (Fcdr (fdpid
));
167 if (call_process_exited
)
169 emacs_close (XFASTINT (Fcar (fdpid
)));
173 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
175 int count
= SPECPDL_INDEX ();
176 record_unwind_protect (call_process_kill
, fdpid
);
177 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
180 wait_for_termination (pid
);
182 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
183 message1 ("Waiting for process to die...done");
185 synch_process_alive
= 0;
186 emacs_close (XFASTINT (Fcar (fdpid
)));
187 #endif /* not MSDOS */
191 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
192 doc
: /* Call PROGRAM synchronously in separate process.
193 The remaining arguments are optional.
194 The program's input comes from file INFILE (nil means `/dev/null').
195 Insert output in BUFFER before point; t means current buffer;
196 nil for BUFFER means discard it; 0 means discard and don't wait.
197 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
198 REAL-BUFFER says what to do with standard output, as above,
199 while STDERR-FILE says what to do with standard error in the child.
200 STDERR-FILE may be nil (discard standard error output),
201 t (mix it with ordinary output), or a file name string.
203 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
204 Remaining arguments are strings passed as command arguments to PROGRAM.
206 If BUFFER is 0, `call-process' returns immediately with value nil.
207 Otherwise it waits for PROGRAM to terminate
208 and returns a numeric exit status or a signal description string.
209 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
211 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
214 register Lisp_Object
*args
;
216 Lisp_Object infile
, buffer
, current_dir
, path
;
221 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
222 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
223 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
224 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
225 int count
= SPECPDL_INDEX ();
227 register const unsigned char **new_argv
228 = (const unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
229 struct buffer
*old
= current_buffer
;
230 /* File to use for stderr in the child.
231 t means use same as standard output. */
232 Lisp_Object error_file
;
233 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
234 char *outf
, *tempfile
;
244 struct coding_system process_coding
; /* coding-system of process output */
245 struct coding_system argument_coding
; /* coding-system of arguments */
246 /* Set to the return value of Ffind_operation_coding_system. */
247 Lisp_Object coding_systems
;
249 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
252 CHECK_STRING (args
[0]);
257 /* Without asynchronous processes we cannot have BUFFER == 0. */
259 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
260 error ("Operating system cannot handle asynchronous subprocesses");
261 #endif /* subprocesses */
263 /* Decide the coding-system for giving arguments. */
265 Lisp_Object val
, *args2
;
268 /* If arguments are supplied, we may have to encode them. */
273 for (i
= 4; i
< nargs
; i
++)
274 CHECK_STRING (args
[i
]);
276 for (i
= 4; i
< nargs
; i
++)
277 if (STRING_MULTIBYTE (args
[i
]))
280 if (!NILP (Vcoding_system_for_write
))
281 val
= Vcoding_system_for_write
;
282 else if (! must_encode
)
286 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
287 args2
[0] = Qcall_process
;
288 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
289 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
290 if (CONSP (coding_systems
))
291 val
= XCDR (coding_systems
);
292 else if (CONSP (Vdefault_process_coding_system
))
293 val
= XCDR (Vdefault_process_coding_system
);
297 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
301 if (nargs
>= 2 && ! NILP (args
[1]))
303 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
304 CHECK_STRING (infile
);
307 infile
= build_string (NULL_DEVICE
);
313 /* If BUFFER is a list, its meaning is
314 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
317 if (CONSP (XCDR (buffer
)))
319 Lisp_Object stderr_file
;
320 stderr_file
= XCAR (XCDR (buffer
));
322 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
323 error_file
= stderr_file
;
325 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
328 buffer
= XCAR (buffer
);
331 if (!(EQ (buffer
, Qnil
)
333 || INTEGERP (buffer
)))
335 Lisp_Object spec_buffer
;
336 spec_buffer
= buffer
;
337 buffer
= Fget_buffer_create (buffer
);
338 /* Mention the buffer name for a better error message. */
340 CHECK_BUFFER (spec_buffer
);
341 CHECK_BUFFER (buffer
);
347 /* Make sure that the child will be able to chdir to the current
348 buffer's current directory, or its unhandled equivalent. We
349 can't just have the child check for an error when it does the
350 chdir, since it's in a vfork.
352 We have to GCPRO around this because Fexpand_file_name,
353 Funhandled_file_name_directory, and Ffile_accessible_directory_p
354 might call a file name handling function. The argument list is
355 protected by the caller, so all we really have to worry about is
358 struct gcpro gcpro1
, gcpro2
, gcpro3
;
360 current_dir
= current_buffer
->directory
;
362 GCPRO3 (infile
, buffer
, current_dir
);
365 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir
),
367 if (NILP (Ffile_accessible_directory_p (current_dir
)))
368 report_file_error ("Setting current directory",
369 Fcons (current_buffer
->directory
, Qnil
));
374 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
376 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
379 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
381 /* Search for program; barf if not found. */
385 GCPRO1 (current_dir
);
386 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
391 emacs_close (filefd
);
392 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
395 /* If program file name starts with /: for quoting a magic name,
397 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
398 && SREF (path
, 1) == ':')
399 path
= Fsubstring (path
, make_number (2), Qnil
);
401 new_argv
[0] = SDATA (path
);
405 struct gcpro gcpro1
, gcpro2
, gcpro3
;
407 GCPRO3 (infile
, buffer
, current_dir
);
408 argument_coding
.dst_multibyte
= 0;
409 for (i
= 4; i
< nargs
; i
++)
411 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
412 if (CODING_REQUIRE_ENCODING (&argument_coding
))
414 /* We must encode this argument. */
415 args
[i
] = encode_coding_string (args
[i
], &argument_coding
, 1);
416 if (argument_coding
.type
== coding_type_ccl
)
417 setup_ccl_program (&(argument_coding
.spec
.ccl
.encoder
), Qnil
);
419 new_argv
[i
- 3] = SDATA (args
[i
]);
422 new_argv
[nargs
- 3] = 0;
427 #ifdef MSDOS /* MW, July 1993 */
428 if ((outf
= egetenv ("TMPDIR")))
429 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
432 tempfile
= alloca (20);
435 dostounix_filename (tempfile
);
436 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
437 strcat (tempfile
, "/");
438 strcat (tempfile
, "detmp.XXX");
441 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
444 emacs_close (filefd
);
445 report_file_error ("Opening process output file",
446 Fcons (build_string (tempfile
), Qnil
));
453 /* Since we don't have pipes on the Mac, create a temporary file to
454 hold the output of the subprocess. */
455 tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
456 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
457 SBYTES (Vtemp_file_name_pattern
) + 1);
461 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
465 report_file_error ("Opening process output file",
466 Fcons (build_string (tempfile
), Qnil
));
472 if (INTEGERP (buffer
))
473 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
481 emacs_close (filefd
);
482 report_file_error ("Creating process pipe", Qnil
);
487 /* Replaced by close_process_descs */
488 set_exclusive_use (fd
[0]);
493 /* child_setup must clobber environ in systems with true vfork.
494 Protect it from permanent change. */
495 register char **save_environ
= environ
;
496 register int fd1
= fd
[1];
499 #if 0 /* Some systems don't have sigblock. */
500 mask
= sigblock (sigmask (SIGCHLD
));
503 /* Record that we're about to create a synchronous process. */
504 synch_process_alive
= 1;
506 /* These vars record information from process termination.
507 Clear them now before process can possibly terminate,
508 to avoid timing error if process terminates soon. */
509 synch_process_death
= 0;
510 synch_process_retcode
= 0;
511 synch_process_termsig
= 0;
513 if (NILP (error_file
))
514 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
515 else if (STRINGP (error_file
))
518 fd_error
= emacs_open (SDATA (error_file
),
519 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
521 #else /* not DOS_NT */
522 fd_error
= creat (SDATA (error_file
), 0666);
523 #endif /* not DOS_NT */
528 emacs_close (filefd
);
536 report_file_error ("Cannot redirect stderr",
537 Fcons ((NILP (error_file
)
538 ? build_string (NULL_DEVICE
) : error_file
),
542 current_dir
= ENCODE_FILE (current_dir
);
546 /* Call run_mac_command in sysdep.c here directly instead of doing
547 a child_setup as for MSDOS and other platforms. Note that this
548 code does not handle passing the environment to the synchronous
550 char *infn
, *outfn
, *errfn
, *currdn
;
552 /* close these files so subprocess can write to them */
554 if (fd_error
!= outfilefd
)
556 fd1
= -1; /* No harm in closing that one! */
558 infn
= SDATA (infile
);
560 if (NILP (error_file
))
562 else if (EQ (Qt
, error_file
))
565 errfn
= SDATA (error_file
);
566 currdn
= SDATA (current_dir
);
567 pid
= run_mac_command (new_argv
, currdn
, infn
, outfn
, errfn
);
569 /* Record that the synchronous process exited and note its
570 termination status. */
571 synch_process_alive
= 0;
572 synch_process_retcode
= pid
;
573 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
575 synchronize_system_messages_locale ();
576 synch_process_death
= strerror (errno
);
579 /* Since CRLF is converted to LF within `decode_coding', we can
580 always open a file with binary mode. */
581 fd
[0] = open (tempfile
, O_BINARY
);
586 report_file_error ("Cannot re-open temporary file", Qnil
);
589 #else /* not MAC_OS8 */
590 #ifdef MSDOS /* MW, July 1993 */
591 /* Note that on MSDOS `child_setup' actually returns the child process
592 exit status, not its PID, so we assign it to `synch_process_retcode'
594 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
597 /* Record that the synchronous process exited and note its
598 termination status. */
599 synch_process_alive
= 0;
600 synch_process_retcode
= pid
;
601 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
603 synchronize_system_messages_locale ();
604 synch_process_death
= strerror (errno
);
607 emacs_close (outfilefd
);
608 if (fd_error
!= outfilefd
)
609 emacs_close (fd_error
);
610 fd1
= -1; /* No harm in closing that one! */
611 /* Since CRLF is converted to LF within `decode_coding', we can
612 always open a file with binary mode. */
613 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
617 emacs_close (filefd
);
618 report_file_error ("Cannot re-open temporary file", Qnil
);
620 #else /* not MSDOS */
622 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
624 #else /* not WINDOWSNT */
636 #if defined (USG) && !defined (BSD_PGRPS)
641 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
646 #endif /* not WINDOWSNT */
648 /* The MSDOS case did this already. */
650 emacs_close (fd_error
);
651 #endif /* not MSDOS */
652 #endif /* not MAC_OS8 */
654 environ
= save_environ
;
656 /* Close most of our fd's, but not fd[0]
657 since we will use that to read input from. */
658 emacs_close (filefd
);
659 if (fd1
>= 0 && fd1
!= fd_error
)
667 report_file_error ("Doing vfork", Qnil
);
670 if (INTEGERP (buffer
))
675 /* If Emacs has been built with asynchronous subprocess support,
676 we don't need to do this, I think because it will then have
677 the facilities for handling SIGCHLD. */
678 wait_without_blocking ();
679 #endif /* subprocesses */
683 /* Enable sending signal if user quits below. */
684 call_process_exited
= 0;
686 #if defined(MSDOS) || defined(MAC_OS8)
687 /* MSDOS needs different cleanup information. */
688 record_unwind_protect (call_process_cleanup
,
689 Fcons (make_number (fd
[0]), build_string (tempfile
)));
691 record_unwind_protect (call_process_cleanup
,
692 Fcons (make_number (fd
[0]), make_number (pid
)));
693 #endif /* not MSDOS and not MAC_OS8 */
696 if (BUFFERP (buffer
))
697 Fset_buffer (buffer
);
701 /* If BUFFER is nil, we must read process output once and then
702 discard it, so setup coding system but with nil. */
703 setup_coding_system (Qnil
, &process_coding
);
707 Lisp_Object val
, *args2
;
710 if (!NILP (Vcoding_system_for_read
))
711 val
= Vcoding_system_for_read
;
714 if (EQ (coding_systems
, Qt
))
718 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
719 args2
[0] = Qcall_process
;
720 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
722 = Ffind_operation_coding_system (nargs
+ 1, args2
);
724 if (CONSP (coding_systems
))
725 val
= XCAR (coding_systems
);
726 else if (CONSP (Vdefault_process_coding_system
))
727 val
= XCAR (Vdefault_process_coding_system
);
731 setup_coding_system (Fcheck_coding_system (val
), &process_coding
);
732 /* In unibyte mode, character code conversion should not take
733 place but EOL conversion should. So, setup raw-text or one
734 of the subsidiary according to the information just setup. */
735 if (NILP (current_buffer
->enable_multibyte_characters
)
737 setup_raw_text_coding_system (&process_coding
);
739 process_coding
.src_multibyte
= 0;
740 process_coding
.dst_multibyte
742 ? ! NILP (XBUFFER (buffer
)->enable_multibyte_characters
)
743 : ! NILP (current_buffer
->enable_multibyte_characters
));
753 int display_on_the_fly
= display_p
;
754 struct coding_system saved_coding
;
755 int pt_orig
= PT
, pt_byte_orig
= PT_BYTE
;
758 saved_coding
= process_coding
;
759 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
760 coding_allocate_composition_data (&process_coding
, PT
);
763 /* Repeatedly read until we've filled as much as possible
764 of the buffer size we have. But don't read
765 less than 1024--save that for the next bufferful. */
767 while (nread
< bufsize
- 1024)
769 int this_read
= emacs_read (fd
[0], buf
+ nread
,
777 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
782 total_read
+= this_read
;
784 if (display_on_the_fly
)
788 /* Now NREAD is the total amount of data in the buffer. */
793 if (! CODING_MAY_REQUIRE_DECODING (&process_coding
))
794 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
796 { /* We have to decode the input. */
801 size
= decoding_buffer_size (&process_coding
, nread
);
802 decoding_buf
= (char *) xmalloc (size
);
804 /* We can't use the macro CODING_REQUIRE_DETECTION
805 because it always returns nonzero if the coding
806 system requires EOL detection. Here, we have to
807 check only whether or not the coding system
808 requires text-encoding detection. */
809 if (process_coding
.type
== coding_type_undecided
)
811 detect_coding (&process_coding
, buf
, nread
);
812 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
813 /* We have not yet allocated the composition
814 data because the coding type was undecided. */
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
, buf
, 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 try the code
830 detection again with more data. */
831 xfree (decoding_buf
);
832 display_on_the_fly
= 0;
833 process_coding
= saved_coding
;
835 /* This is to make the above condition always
836 fails in the future. */
837 saved_coding
.type
= coding_type_no_conversion
;
841 if (process_coding
.produced
> 0)
842 insert_1_both (decoding_buf
, process_coding
.produced_char
,
843 process_coding
.produced
, 0, 1, 0);
844 xfree (decoding_buf
);
846 if (process_coding
.result
== CODING_FINISH_INCONSISTENT_EOL
)
848 Lisp_Object eol_type
, coding
;
850 if (process_coding
.eol_type
== CODING_EOL_CR
)
852 /* CRs have been replaced with LFs. Undo
853 that in the text inserted above. */
856 move_gap_both (PT
, PT_BYTE
);
858 p
= BYTE_POS_ADDR (pt_byte_orig
);
859 for (; p
< GPT_ADDR
; ++p
)
863 else if (process_coding
.eol_type
== CODING_EOL_CRLF
)
865 /* CR LFs have been replaced with LFs. Undo
866 that by inserting CRs in front of LFs in
867 the text inserted above. */
868 EMACS_INT bytepos
, old_pt
, old_pt_byte
, nCR
;
871 old_pt_byte
= PT_BYTE
;
874 for (bytepos
= PT_BYTE
- 1;
875 bytepos
>= pt_byte_orig
;
877 if (FETCH_BYTE (bytepos
) == '\n')
879 EMACS_INT charpos
= BYTE_TO_CHAR (bytepos
);
880 TEMP_SET_PT_BOTH (charpos
, bytepos
);
881 insert_1_both ("\r", 1, 1, 0, 1, 0);
885 TEMP_SET_PT_BOTH (old_pt
+ nCR
, old_pt_byte
+ nCR
);
888 /* Set the coding system symbol to that for
890 eol_type
= Fget (saved_coding
.symbol
, Qeol_type
);
891 if (VECTORP (eol_type
)
892 && ASIZE (eol_type
) == 3
893 && SYMBOLP (AREF (eol_type
, CODING_EOL_LF
)))
894 coding
= AREF (eol_type
, CODING_EOL_LF
);
896 coding
= saved_coding
.symbol
;
898 process_coding
.symbol
= coding
;
899 process_coding
.eol_type
= CODING_EOL_LF
;
901 &= ~CODING_MODE_INHIBIT_INCONSISTENT_EOL
;
904 nread
-= process_coding
.consumed
;
907 /* As CARRYOVER should not be that large, we had
908 better avoid overhead of bcopy. */
909 BCOPY_SHORT (buf
+ process_coding
.consumed
, buf
,
911 if (process_coding
.result
== CODING_FINISH_INSUFFICIENT_CMP
)
913 /* The decoding ended because of insufficient data
914 area to record information about composition.
915 We must try decoding with additional data area
916 before reading more output for the process. */
917 coding_allocate_composition_data (&process_coding
, PT
);
918 goto repeat_decoding
;
923 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
926 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
927 /* Make the buffer bigger as we continue to read more data,
928 but not past CALLPROC_BUFFER_SIZE_MAX. */
929 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
930 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
931 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
937 prepare_menu_bars ();
939 redisplay_preserve_echo_area (1);
940 /* This variable might have been set to 0 for code
941 detection. In that case, we set it back to 1 because
942 we should have already detected a coding system. */
943 display_on_the_fly
= 1;
951 && process_coding
.cmp_data
)
953 coding_restore_composition (&process_coding
, Fcurrent_buffer ());
954 coding_free_composition_data (&process_coding
);
958 int post_read_count
= SPECPDL_INDEX ();
960 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
961 inserted
= PT
- pt_orig
;
962 TEMP_SET_PT_BOTH (pt_orig
, pt_byte_orig
);
963 if (SYMBOLP (process_coding
.post_read_conversion
)
964 && !NILP (Ffboundp (process_coding
.post_read_conversion
)))
965 call1 (process_coding
.post_read_conversion
, make_number (inserted
));
967 Vlast_coding_system_used
= process_coding
.symbol
;
969 /* If the caller required, let the buffer inherit the
970 coding-system used to decode the process output. */
971 if (inherit_process_coding_system
)
972 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
973 make_number (total_read
));
975 unbind_to (post_read_count
, Qnil
);
979 /* Wait for it to terminate, unless it already has. */
980 wait_for_termination (pid
);
984 set_buffer_internal (old
);
986 /* Don't kill any children that the subprocess may have left behind
988 call_process_exited
= 1;
990 unbind_to (count
, Qnil
);
992 if (synch_process_termsig
)
996 synchronize_system_messages_locale ();
997 signame
= strsignal (synch_process_termsig
);
1000 signame
= "unknown";
1002 synch_process_death
= signame
;
1005 if (synch_process_death
)
1006 return code_convert_string_norecord (build_string (synch_process_death
),
1007 Vlocale_coding_system
, 0);
1008 return make_number (synch_process_retcode
);
1013 delete_temp_file (name
)
1016 /* Use Fdelete_file (indirectly) because that runs a file name handler.
1017 We did that when writing the file, so we should do so when deleting. */
1018 internal_delete_file (name
);
1022 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
1024 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
1025 The remaining arguments are optional.
1026 Delete the text if fourth arg DELETE is non-nil.
1028 Insert output in BUFFER before point; t means current buffer;
1029 nil for BUFFER means discard it; 0 means discard and don't wait.
1030 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1031 REAL-BUFFER says what to do with standard output, as above,
1032 while STDERR-FILE says what to do with standard error in the child.
1033 STDERR-FILE may be nil (discard standard error output),
1034 t (mix it with ordinary output), or a file name string.
1036 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1037 Remaining args are passed to PROGRAM at startup as command args.
1039 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1040 Otherwise it waits for PROGRAM to terminate
1041 and returns a numeric exit status or a signal description string.
1042 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1044 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1047 register Lisp_Object
*args
;
1049 struct gcpro gcpro1
;
1050 Lisp_Object filename_string
;
1051 register Lisp_Object start
, end
;
1052 int count
= SPECPDL_INDEX ();
1053 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1054 Lisp_Object coding_systems
;
1055 Lisp_Object val
, *args2
;
1061 if ((outf
= egetenv ("TMPDIR"))
1062 || (outf
= egetenv ("TMP"))
1063 || (outf
= egetenv ("TEMP")))
1064 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
1067 tempfile
= alloca (20);
1070 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
1071 strcat (tempfile
, "/");
1072 if ('/' == DIRECTORY_SEP
)
1073 dostounix_filename (tempfile
);
1075 unixtodos_filename (tempfile
);
1077 strcat (tempfile
, "emXXXXXX");
1079 strcat (tempfile
, "detmp.XXX");
1081 #else /* not DOS_NT */
1082 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
1083 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
1084 SBYTES (Vtemp_file_name_pattern
) + 1);
1085 #endif /* not DOS_NT */
1087 coding_systems
= Qt
;
1091 int fd
= mkstemp (tempfile
);
1093 report_file_error ("Failed to open temporary file",
1094 Fcons (Vtemp_file_name_pattern
, Qnil
));
1102 filename_string
= build_string (tempfile
);
1103 GCPRO1 (filename_string
);
1106 /* Decide coding-system of the contents of the temporary file. */
1107 if (!NILP (Vcoding_system_for_write
))
1108 val
= Vcoding_system_for_write
;
1109 else if (NILP (current_buffer
->enable_multibyte_characters
))
1113 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
1114 args2
[0] = Qcall_process_region
;
1115 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
1116 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1117 if (CONSP (coding_systems
))
1118 val
= XCDR (coding_systems
);
1119 else if (CONSP (Vdefault_process_coding_system
))
1120 val
= XCDR (Vdefault_process_coding_system
);
1126 int count1
= SPECPDL_INDEX ();
1128 specbind (intern ("coding-system-for-write"), val
);
1129 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1130 happen to get a ".Z" suffix. */
1131 specbind (intern ("file-name-handler-alist"), Qnil
);
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) */