1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
32 /* Define SIGCHLD as an alias for SIGCLD. */
34 #if !defined (SIGCHLD) && defined (SIGCLD)
35 #define SIGCHLD SIGCLD
38 #include <sys/types.h>
46 #define INCLUDED_FCNTL
53 #include <stdlib.h> /* for proper declaration of environ */
56 #define _P_NOWAIT 1 /* from process.h */
59 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
60 #define INCLUDED_FCNTL
63 #include <sys/param.h>
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
);
298 if (argument_coding
.common_flags
& CODING_ASCII_INCOMPATIBLE_MASK
)
299 setup_coding_system (Qraw_text
, &argument_coding
);
300 if (argument_coding
.eol_type
== CODING_EOL_UNDECIDED
)
301 argument_coding
.eol_type
= system_eol_type
;
305 if (nargs
>= 2 && ! NILP (args
[1]))
307 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
308 CHECK_STRING (infile
);
311 infile
= build_string (NULL_DEVICE
);
317 /* If BUFFER is a list, its meaning is
318 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
321 if (CONSP (XCDR (buffer
)))
323 Lisp_Object stderr_file
;
324 stderr_file
= XCAR (XCDR (buffer
));
326 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
327 error_file
= stderr_file
;
329 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
332 buffer
= XCAR (buffer
);
335 if (!(EQ (buffer
, Qnil
)
337 || INTEGERP (buffer
)))
339 Lisp_Object spec_buffer
;
340 spec_buffer
= buffer
;
341 buffer
= Fget_buffer_create (buffer
);
342 /* Mention the buffer name for a better error message. */
344 CHECK_BUFFER (spec_buffer
);
345 CHECK_BUFFER (buffer
);
351 /* Make sure that the child will be able to chdir to the current
352 buffer's current directory, or its unhandled equivalent. We
353 can't just have the child check for an error when it does the
354 chdir, since it's in a vfork.
356 We have to GCPRO around this because Fexpand_file_name,
357 Funhandled_file_name_directory, and Ffile_accessible_directory_p
358 might call a file name handling function. The argument list is
359 protected by the caller, so all we really have to worry about is
362 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
364 current_dir
= current_buffer
->directory
;
366 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
369 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir
),
371 if (NILP (Ffile_accessible_directory_p (current_dir
)))
372 report_file_error ("Setting current directory",
373 Fcons (current_buffer
->directory
, Qnil
));
375 if (STRING_MULTIBYTE (infile
))
376 infile
= ENCODE_FILE (infile
);
377 if (STRING_MULTIBYTE (current_dir
))
378 current_dir
= ENCODE_FILE (current_dir
);
379 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
380 error_file
= ENCODE_FILE (error_file
);
384 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
386 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
389 infile
= DECODE_FILE (infile
);
390 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
392 /* Search for program; barf if not found. */
396 GCPRO1 (current_dir
);
397 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
402 emacs_close (filefd
);
403 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
406 /* If program file name starts with /: for quoting a magic name,
408 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
409 && SREF (path
, 1) == ':')
410 path
= Fsubstring (path
, make_number (2), Qnil
);
412 new_argv
[0] = SDATA (path
);
416 struct gcpro gcpro1
, gcpro2
, gcpro3
;
418 GCPRO3 (infile
, buffer
, current_dir
);
419 argument_coding
.dst_multibyte
= 0;
420 for (i
= 4; i
< nargs
; i
++)
422 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
423 if (CODING_REQUIRE_ENCODING (&argument_coding
))
425 /* We must encode this argument. */
426 args
[i
] = encode_coding_string (args
[i
], &argument_coding
, 1);
427 if (argument_coding
.type
== coding_type_ccl
)
428 setup_ccl_program (&(argument_coding
.spec
.ccl
.encoder
), Qnil
);
430 new_argv
[i
- 3] = SDATA (args
[i
]);
433 new_argv
[nargs
- 3] = 0;
438 #ifdef MSDOS /* MW, July 1993 */
439 if ((outf
= egetenv ("TMPDIR")))
440 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
443 tempfile
= alloca (20);
446 dostounix_filename (tempfile
);
447 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
448 strcat (tempfile
, "/");
449 strcat (tempfile
, "detmp.XXX");
452 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
455 emacs_close (filefd
);
456 report_file_error ("Opening process output file",
457 Fcons (build_string (tempfile
), Qnil
));
464 /* Since we don't have pipes on the Mac, create a temporary file to
465 hold the output of the subprocess. */
466 tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
467 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
468 SBYTES (Vtemp_file_name_pattern
) + 1);
472 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
476 report_file_error ("Opening process output file",
477 Fcons (build_string (tempfile
), Qnil
));
483 if (INTEGERP (buffer
))
484 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
492 emacs_close (filefd
);
493 report_file_error ("Creating process pipe", Qnil
);
498 /* Replaced by close_process_descs */
499 set_exclusive_use (fd
[0]);
504 /* child_setup must clobber environ in systems with true vfork.
505 Protect it from permanent change. */
506 register char **save_environ
= environ
;
507 register int fd1
= fd
[1];
510 #if 0 /* Some systems don't have sigblock. */
511 mask
= sigblock (sigmask (SIGCHLD
));
514 /* Record that we're about to create a synchronous process. */
515 synch_process_alive
= 1;
517 /* These vars record information from process termination.
518 Clear them now before process can possibly terminate,
519 to avoid timing error if process terminates soon. */
520 synch_process_death
= 0;
521 synch_process_retcode
= 0;
522 synch_process_termsig
= 0;
524 if (NILP (error_file
))
525 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
526 else if (STRINGP (error_file
))
529 fd_error
= emacs_open (SDATA (error_file
),
530 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
532 #else /* not DOS_NT */
533 fd_error
= creat (SDATA (error_file
), 0666);
534 #endif /* not DOS_NT */
539 emacs_close (filefd
);
547 if (NILP (error_file
))
548 error_file
= build_string (NULL_DEVICE
);
549 else if (STRINGP (error_file
))
550 error_file
= DECODE_FILE (error_file
);
551 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
556 /* Call run_mac_command in sysdep.c here directly instead of doing
557 a child_setup as for MSDOS and other platforms. Note that this
558 code does not handle passing the environment to the synchronous
560 char *infn
, *outfn
, *errfn
, *currdn
;
562 /* close these files so subprocess can write to them */
564 if (fd_error
!= outfilefd
)
566 fd1
= -1; /* No harm in closing that one! */
568 infn
= SDATA (infile
);
570 if (NILP (error_file
))
572 else if (EQ (Qt
, error_file
))
575 errfn
= SDATA (error_file
);
576 currdn
= SDATA (current_dir
);
577 pid
= run_mac_command (new_argv
, currdn
, infn
, outfn
, errfn
);
579 /* Record that the synchronous process exited and note its
580 termination status. */
581 synch_process_alive
= 0;
582 synch_process_retcode
= pid
;
583 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
585 synchronize_system_messages_locale ();
586 synch_process_death
= strerror (errno
);
589 /* Since CRLF is converted to LF within `decode_coding', we can
590 always open a file with binary mode. */
591 fd
[0] = open (tempfile
, O_BINARY
);
596 report_file_error ("Cannot re-open temporary file", Qnil
);
599 #else /* not MAC_OS8 */
600 #ifdef MSDOS /* MW, July 1993 */
601 /* Note that on MSDOS `child_setup' actually returns the child process
602 exit status, not its PID, so we assign it to `synch_process_retcode'
604 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
607 /* Record that the synchronous process exited and note its
608 termination status. */
609 synch_process_alive
= 0;
610 synch_process_retcode
= pid
;
611 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
613 synchronize_system_messages_locale ();
614 synch_process_death
= strerror (errno
);
617 emacs_close (outfilefd
);
618 if (fd_error
!= outfilefd
)
619 emacs_close (fd_error
);
620 fd1
= -1; /* No harm in closing that one! */
621 /* Since CRLF is converted to LF within `decode_coding', we can
622 always open a file with binary mode. */
623 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
627 emacs_close (filefd
);
628 report_file_error ("Cannot re-open temporary file", Qnil
);
630 #else /* not MSDOS */
632 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
634 #else /* not WINDOWSNT */
646 #if defined (USG) && !defined (BSD_PGRPS)
651 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
656 #endif /* not WINDOWSNT */
658 /* The MSDOS case did this already. */
660 emacs_close (fd_error
);
661 #endif /* not MSDOS */
662 #endif /* not MAC_OS8 */
664 environ
= save_environ
;
666 /* Close most of our fd's, but not fd[0]
667 since we will use that to read input from. */
668 emacs_close (filefd
);
669 if (fd1
>= 0 && fd1
!= fd_error
)
677 report_file_error ("Doing vfork", Qnil
);
680 if (INTEGERP (buffer
))
685 /* If Emacs has been built with asynchronous subprocess support,
686 we don't need to do this, I think because it will then have
687 the facilities for handling SIGCHLD. */
688 wait_without_blocking ();
689 #endif /* subprocesses */
693 /* Enable sending signal if user quits below. */
694 call_process_exited
= 0;
696 #if defined(MSDOS) || defined(MAC_OS8)
697 /* MSDOS needs different cleanup information. */
698 record_unwind_protect (call_process_cleanup
,
699 Fcons (make_number (fd
[0]), build_string (tempfile
)));
701 record_unwind_protect (call_process_cleanup
,
702 Fcons (make_number (fd
[0]), make_number (pid
)));
703 #endif /* not MSDOS and not MAC_OS8 */
706 if (BUFFERP (buffer
))
707 Fset_buffer (buffer
);
711 /* If BUFFER is nil, we must read process output once and then
712 discard it, so setup coding system but with nil. */
713 setup_coding_system (Qnil
, &process_coding
);
717 Lisp_Object val
, *args2
;
720 if (!NILP (Vcoding_system_for_read
))
721 val
= Vcoding_system_for_read
;
724 if (EQ (coding_systems
, Qt
))
728 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
729 args2
[0] = Qcall_process
;
730 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
732 = Ffind_operation_coding_system (nargs
+ 1, args2
);
734 if (CONSP (coding_systems
))
735 val
= XCAR (coding_systems
);
736 else if (CONSP (Vdefault_process_coding_system
))
737 val
= XCAR (Vdefault_process_coding_system
);
741 setup_coding_system (Fcheck_coding_system (val
), &process_coding
);
742 /* In unibyte mode, character code conversion should not take
743 place but EOL conversion should. So, setup raw-text or one
744 of the subsidiary according to the information just setup. */
745 if (NILP (current_buffer
->enable_multibyte_characters
)
747 setup_raw_text_coding_system (&process_coding
);
749 process_coding
.src_multibyte
= 0;
750 process_coding
.dst_multibyte
752 ? ! NILP (XBUFFER (buffer
)->enable_multibyte_characters
)
753 : ! NILP (current_buffer
->enable_multibyte_characters
));
763 int display_on_the_fly
= display_p
;
764 struct coding_system saved_coding
;
765 int pt_orig
= PT
, pt_byte_orig
= PT_BYTE
;
768 saved_coding
= process_coding
;
769 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
770 coding_allocate_composition_data (&process_coding
, PT
);
773 /* Repeatedly read until we've filled as much as possible
774 of the buffer size we have. But don't read
775 less than 1024--save that for the next bufferful. */
777 while (nread
< bufsize
- 1024)
779 int this_read
= emacs_read (fd
[0], buf
+ nread
,
787 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
792 total_read
+= this_read
;
794 if (display_on_the_fly
)
798 /* Now NREAD is the total amount of data in the buffer. */
803 if (! CODING_MAY_REQUIRE_DECODING (&process_coding
))
804 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
806 { /* We have to decode the input. */
811 size
= decoding_buffer_size (&process_coding
, nread
);
812 decoding_buf
= (char *) xmalloc (size
);
814 /* We can't use the macro CODING_REQUIRE_DETECTION
815 because it always returns nonzero if the coding
816 system requires EOL detection. Here, we have to
817 check only whether or not the coding system
818 requires text-encoding detection. */
819 if (process_coding
.type
== coding_type_undecided
)
821 detect_coding (&process_coding
, buf
, nread
);
822 if (process_coding
.composing
!= COMPOSITION_DISABLED
)
823 /* We have not yet allocated the composition
824 data because the coding type was undecided. */
825 coding_allocate_composition_data (&process_coding
, PT
);
827 if (process_coding
.cmp_data
)
828 process_coding
.cmp_data
->char_offset
= PT
;
830 decode_coding (&process_coding
, buf
, decoding_buf
,
833 if (display_on_the_fly
834 && saved_coding
.type
== coding_type_undecided
835 && process_coding
.type
!= coding_type_undecided
)
837 /* We have detected some coding system. But,
838 there's a possibility that the detection was
839 done by insufficient data. So, we try the code
840 detection again with more data. */
841 xfree (decoding_buf
);
842 display_on_the_fly
= 0;
843 process_coding
= saved_coding
;
845 /* This is to make the above condition always
846 fails in the future. */
847 saved_coding
.type
= coding_type_no_conversion
;
851 if (process_coding
.produced
> 0)
852 insert_1_both (decoding_buf
, process_coding
.produced_char
,
853 process_coding
.produced
, 0, 1, 0);
854 xfree (decoding_buf
);
856 if (process_coding
.result
== CODING_FINISH_INCONSISTENT_EOL
)
858 Lisp_Object eol_type
, coding
;
860 if (process_coding
.eol_type
== CODING_EOL_CR
)
862 /* CRs have been replaced with LFs. Undo
863 that in the text inserted above. */
866 move_gap_both (PT
, PT_BYTE
);
868 p
= BYTE_POS_ADDR (pt_byte_orig
);
869 for (; p
< GPT_ADDR
; ++p
)
873 else if (process_coding
.eol_type
== CODING_EOL_CRLF
)
875 /* CR LFs have been replaced with LFs. Undo
876 that by inserting CRs in front of LFs in
877 the text inserted above. */
878 EMACS_INT bytepos
, old_pt
, old_pt_byte
, nCR
;
881 old_pt_byte
= PT_BYTE
;
884 for (bytepos
= PT_BYTE
- 1;
885 bytepos
>= pt_byte_orig
;
887 if (FETCH_BYTE (bytepos
) == '\n')
889 EMACS_INT charpos
= BYTE_TO_CHAR (bytepos
);
890 TEMP_SET_PT_BOTH (charpos
, bytepos
);
891 insert_1_both ("\r", 1, 1, 0, 1, 0);
895 TEMP_SET_PT_BOTH (old_pt
+ nCR
, old_pt_byte
+ nCR
);
898 /* Set the coding system symbol to that for
900 eol_type
= Fget (saved_coding
.symbol
, Qeol_type
);
901 if (VECTORP (eol_type
)
902 && ASIZE (eol_type
) == 3
903 && SYMBOLP (AREF (eol_type
, CODING_EOL_LF
)))
904 coding
= AREF (eol_type
, CODING_EOL_LF
);
906 coding
= saved_coding
.symbol
;
908 process_coding
.symbol
= coding
;
909 process_coding
.eol_type
= CODING_EOL_LF
;
911 &= ~CODING_MODE_INHIBIT_INCONSISTENT_EOL
;
914 nread
-= process_coding
.consumed
;
917 /* As CARRYOVER should not be that large, we had
918 better avoid overhead of bcopy. */
919 BCOPY_SHORT (buf
+ process_coding
.consumed
, buf
,
921 if (process_coding
.result
== CODING_FINISH_INSUFFICIENT_CMP
)
923 /* The decoding ended because of insufficient data
924 area to record information about composition.
925 We must try decoding with additional data area
926 before reading more output for the process. */
927 coding_allocate_composition_data (&process_coding
, PT
);
928 goto repeat_decoding
;
933 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
936 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
937 /* Make the buffer bigger as we continue to read more data,
938 but not past CALLPROC_BUFFER_SIZE_MAX. */
939 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
940 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
941 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
947 prepare_menu_bars ();
949 redisplay_preserve_echo_area (1);
950 /* This variable might have been set to 0 for code
951 detection. In that case, we set it back to 1 because
952 we should have already detected a coding system. */
953 display_on_the_fly
= 1;
961 && process_coding
.cmp_data
)
963 coding_restore_composition (&process_coding
, Fcurrent_buffer ());
964 coding_free_composition_data (&process_coding
);
968 int post_read_count
= SPECPDL_INDEX ();
970 record_unwind_protect (save_excursion_restore
, save_excursion_save ());
971 inserted
= PT
- pt_orig
;
972 TEMP_SET_PT_BOTH (pt_orig
, pt_byte_orig
);
973 if (SYMBOLP (process_coding
.post_read_conversion
)
974 && !NILP (Ffboundp (process_coding
.post_read_conversion
)))
975 call1 (process_coding
.post_read_conversion
, make_number (inserted
));
977 Vlast_coding_system_used
= process_coding
.symbol
;
979 /* If the caller required, let the buffer inherit the
980 coding-system used to decode the process output. */
981 if (inherit_process_coding_system
)
982 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
983 make_number (total_read
));
985 unbind_to (post_read_count
, Qnil
);
989 /* Wait for it to terminate, unless it already has. */
990 wait_for_termination (pid
);
994 set_buffer_internal (old
);
996 /* Don't kill any children that the subprocess may have left behind
998 call_process_exited
= 1;
1000 unbind_to (count
, Qnil
);
1002 if (synch_process_termsig
)
1006 synchronize_system_messages_locale ();
1007 signame
= strsignal (synch_process_termsig
);
1010 signame
= "unknown";
1012 synch_process_death
= signame
;
1015 if (synch_process_death
)
1016 return code_convert_string_norecord (build_string (synch_process_death
),
1017 Vlocale_coding_system
, 0);
1018 return make_number (synch_process_retcode
);
1023 delete_temp_file (name
)
1026 /* Suppress jka-compr handling, etc. */
1027 int count
= SPECPDL_INDEX ();
1028 specbind (intern ("file-name-handler-alist"), Qnil
);
1029 internal_delete_file (name
);
1030 unbind_to (count
, Qnil
);
1034 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
1036 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
1037 The remaining arguments are optional.
1038 Delete the text if fourth arg DELETE is non-nil.
1040 Insert output in BUFFER before point; t means current buffer;
1041 nil for BUFFER means discard it; 0 means discard and don't wait.
1042 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1043 REAL-BUFFER says what to do with standard output, as above,
1044 while STDERR-FILE says what to do with standard error in the child.
1045 STDERR-FILE may be nil (discard standard error output),
1046 t (mix it with ordinary output), or a file name string.
1048 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1049 Remaining args are passed to PROGRAM at startup as command args.
1051 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1052 Otherwise it waits for PROGRAM to terminate
1053 and returns a numeric exit status or a signal description string.
1054 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1056 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1059 register Lisp_Object
*args
;
1061 struct gcpro gcpro1
;
1062 Lisp_Object filename_string
;
1063 register Lisp_Object start
, end
;
1064 int count
= SPECPDL_INDEX ();
1065 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1066 Lisp_Object coding_systems
;
1067 Lisp_Object val
, *args2
;
1073 if ((outf
= egetenv ("TMPDIR"))
1074 || (outf
= egetenv ("TMP"))
1075 || (outf
= egetenv ("TEMP")))
1076 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
1079 tempfile
= alloca (20);
1082 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
1083 strcat (tempfile
, "/");
1084 if ('/' == DIRECTORY_SEP
)
1085 dostounix_filename (tempfile
);
1087 unixtodos_filename (tempfile
);
1089 strcat (tempfile
, "emXXXXXX");
1091 strcat (tempfile
, "detmp.XXX");
1093 #else /* not DOS_NT */
1094 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
1095 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
1096 SBYTES (Vtemp_file_name_pattern
) + 1);
1097 #endif /* not DOS_NT */
1099 coding_systems
= Qt
;
1103 int fd
= mkstemp (tempfile
);
1105 report_file_error ("Failed to open temporary file",
1106 Fcons (Vtemp_file_name_pattern
, Qnil
));
1114 filename_string
= build_string (tempfile
);
1115 GCPRO1 (filename_string
);
1118 /* Decide coding-system of the contents of the temporary file. */
1119 if (!NILP (Vcoding_system_for_write
))
1120 val
= Vcoding_system_for_write
;
1121 else if (NILP (current_buffer
->enable_multibyte_characters
))
1125 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
1126 args2
[0] = Qcall_process_region
;
1127 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
1128 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1129 if (CONSP (coding_systems
))
1130 val
= XCDR (coding_systems
);
1131 else if (CONSP (Vdefault_process_coding_system
))
1132 val
= XCDR (Vdefault_process_coding_system
);
1138 int count1
= SPECPDL_INDEX ();
1140 specbind (intern ("coding-system-for-write"), val
);
1141 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1142 happen to get a ".Z" suffix. */
1143 specbind (intern ("file-name-handler-alist"), Qnil
);
1144 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
1146 unbind_to (count1
, Qnil
);
1149 /* Note that Fcall_process takes care of binding
1150 coding-system-for-read. */
1152 record_unwind_protect (delete_temp_file
, filename_string
);
1154 if (nargs
> 3 && !NILP (args
[3]))
1155 Fdelete_region (start
, end
);
1167 args
[1] = filename_string
;
1169 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1172 #ifndef VMS /* VMS version is in vmsproc.c. */
1174 static int relocate_fd ();
1176 /* This is the last thing run in a newly forked inferior
1177 either synchronous or asynchronous.
1178 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1179 Initialize inferior's priority, pgrp, connected dir and environment.
1180 then exec another program based on new_argv.
1182 This function may change environ for the superior process.
1183 Therefore, the superior process must save and restore the value
1184 of environ around the vfork and the call to this function.
1186 SET_PGRP is nonzero if we should put the subprocess into a separate
1189 CURRENT_DIR is an elisp string giving the path of the current
1190 directory the subprocess should have. Since we can't really signal
1191 a decent error from within the child, this should be verified as an
1192 executable directory by the parent. */
1195 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1197 register char **new_argv
;
1199 Lisp_Object current_dir
;
1206 #endif /* WINDOWSNT */
1208 int pid
= getpid ();
1210 #ifdef SET_EMACS_PRIORITY
1212 extern EMACS_INT emacs_priority
;
1214 if (emacs_priority
< 0)
1215 nice (- emacs_priority
);
1220 /* Close Emacs's descriptors that this process should not have. */
1221 close_process_descs ();
1223 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1224 we will lose if we call close_load_descs here. */
1226 close_load_descs ();
1229 /* Note that use of alloca is always safe here. It's obvious for systems
1230 that do not have true vfork or that have true (stack) alloca.
1231 If using vfork and C_ALLOCA it is safe because that changes
1232 the superior's static variables as if the superior had done alloca
1233 and will be cleaned up in the usual way. */
1235 register char *temp
;
1238 i
= SBYTES (current_dir
);
1240 /* MSDOS must have all environment variables malloc'ed, because
1241 low-level libc functions that launch subsidiary processes rely
1243 pwd_var
= (char *) xmalloc (i
+ 6);
1245 pwd_var
= (char *) alloca (i
+ 6);
1248 bcopy ("PWD=", pwd_var
, 4);
1249 bcopy (SDATA (current_dir
), temp
, i
);
1250 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1254 /* We can't signal an Elisp error here; we're in a vfork. Since
1255 the callers check the current directory before forking, this
1256 should only return an error if the directory's permissions
1257 are changed between the check and this chdir, but we should
1259 if (chdir (temp
) < 0)
1264 /* Get past the drive letter, so that d:/ is left alone. */
1265 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1272 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1273 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1277 /* Set `env' to a vector of the strings in Vprocess_environment. */
1279 register Lisp_Object tem
;
1280 register char **new_env
;
1281 register int new_length
;
1284 for (tem
= Vprocess_environment
;
1285 CONSP (tem
) && STRINGP (XCAR (tem
));
1289 /* new_length + 2 to include PWD and terminating 0. */
1290 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1292 /* If we have a PWD envvar, pass one down,
1293 but with corrected value. */
1295 *new_env
++ = pwd_var
;
1297 /* Copy the Vprocess_environment strings into new_env. */
1298 for (tem
= Vprocess_environment
;
1299 CONSP (tem
) && STRINGP (XCAR (tem
));
1303 char *string
= (char *) SDATA (XCAR (tem
));
1304 /* See if this string duplicates any string already in the env.
1305 If so, don't put it in.
1306 When an env var has multiple definitions,
1307 we keep the definition that comes first in process-environment. */
1308 for (; ep
!= new_env
; ep
++)
1310 char *p
= *ep
, *q
= string
;
1314 /* The string is malformed; might as well drop it. */
1323 *new_env
++ = string
;
1329 prepare_standard_handles (in
, out
, err
, handles
);
1330 set_process_dir (SDATA (current_dir
));
1331 #else /* not WINDOWSNT */
1332 /* Make sure that in, out, and err are not actually already in
1333 descriptors zero, one, or two; this could happen if Emacs is
1334 started with its standard in, out, or error closed, as might
1337 int oin
= in
, oout
= out
;
1339 /* We have to avoid relocating the same descriptor twice! */
1341 in
= relocate_fd (in
, 3);
1346 out
= relocate_fd (out
, 3);
1350 else if (err
== oout
)
1353 err
= relocate_fd (err
, 3);
1367 #endif /* not MSDOS */
1368 #endif /* not WINDOWSNT */
1370 #if defined(USG) && !defined(BSD_PGRPS)
1371 #ifndef SETPGRP_RELEASES_CTTY
1372 setpgrp (); /* No arguments but equivalent in this case */
1377 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1378 EMACS_SET_TTY_PGRP (0, &pid
);
1381 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1384 /* An error occurred while trying to run the subprocess. */
1385 report_file_error ("Spawning child process", Qnil
);
1387 #else /* not MSDOS */
1389 /* Spawn the child. (See ntproc.c:Spawnve). */
1390 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1391 reset_standard_handles (in
, out
, err
, handles
);
1393 /* An error occurred while trying to spawn the process. */
1394 report_file_error ("Spawning child process", Qnil
);
1396 #else /* not WINDOWSNT */
1397 /* execvp does not accept an environment arg so the only way
1398 to pass this environment is to set environ. Our caller
1399 is responsible for restoring the ambient value of environ. */
1401 execvp (new_argv
[0], new_argv
);
1403 emacs_write (1, "Can't exec program: ", 20);
1404 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1405 emacs_write (1, "\n", 1);
1407 #endif /* not WINDOWSNT */
1408 #endif /* not MSDOS */
1411 /* Move the file descriptor FD so that its number is not less than MINFD.
1412 If the file descriptor is moved at all, the original is freed. */
1414 relocate_fd (fd
, minfd
)
1424 char *message1
= "Error while setting up child: ";
1425 char *errmessage
= strerror (errno
);
1426 char *message2
= "\n";
1427 emacs_write (2, message1
, strlen (message1
));
1428 emacs_write (2, errmessage
, strlen (errmessage
));
1429 emacs_write (2, message2
, strlen (message2
));
1432 /* Note that we hold the original FD open while we recurse,
1433 to guarantee we'll get a new FD if we need it. */
1434 new = relocate_fd (new, minfd
);
1441 getenv_internal (var
, varlen
, value
, valuelen
)
1449 for (scan
= Vprocess_environment
; CONSP (scan
); scan
= XCDR (scan
))
1453 entry
= XCAR (scan
);
1455 && SBYTES (entry
) > varlen
1456 && SREF (entry
, varlen
) == '='
1458 /* NT environment variables are case insensitive. */
1459 && ! strnicmp (SDATA (entry
), var
, varlen
)
1460 #else /* not WINDOWSNT */
1461 && ! bcmp (SDATA (entry
), var
, varlen
)
1462 #endif /* not WINDOWSNT */
1465 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1466 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1474 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 1, 0,
1475 doc
: /* Return the value of environment variable VAR, as a string.
1476 VAR should be a string. Value is nil if VAR is undefined in the environment.
1477 This function consults the variable ``process-environment'' for its value. */)
1485 if (getenv_internal (SDATA (var
), SBYTES (var
),
1487 return make_string (value
, valuelen
);
1492 /* A version of getenv that consults process_environment, easily
1501 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
))
1507 #endif /* not VMS */
1509 /* This is run before init_cmdargs. */
1514 char *data_dir
= egetenv ("EMACSDATA");
1515 char *doc_dir
= egetenv ("EMACSDOC");
1518 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1521 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1524 /* Check the EMACSPATH environment variable, defaulting to the
1525 PATH_EXEC path from epaths.h. */
1526 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1527 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1528 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1531 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1536 char *data_dir
= egetenv ("EMACSDATA");
1539 Lisp_Object tempdir
;
1541 if (!NILP (Vinstallation_directory
))
1543 /* Add to the path the lib-src subdir of the installation dir. */
1545 tem
= Fexpand_file_name (build_string ("lib-src"),
1546 Vinstallation_directory
);
1548 /* MSDOS uses wrapped binaries, so don't do this. */
1549 if (NILP (Fmember (tem
, Vexec_path
)))
1551 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1552 Vexec_path
= Fcons (tem
, Vexec_path
);
1553 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1556 Vexec_directory
= Ffile_name_as_directory (tem
);
1557 #endif /* not DOS_NT */
1559 /* Maybe use ../etc as well as ../lib-src. */
1562 tem
= Fexpand_file_name (build_string ("etc"),
1563 Vinstallation_directory
);
1564 Vdoc_directory
= Ffile_name_as_directory (tem
);
1568 /* Look for the files that should be in etc. We don't use
1569 Vinstallation_directory, because these files are never installed
1570 near the executable, and they are never in the build
1571 directory when that's different from the source directory.
1573 Instead, if these files are not in the nominal place, we try the
1574 source directory. */
1577 Lisp_Object tem
, tem1
, srcdir
;
1579 srcdir
= Fexpand_file_name (build_string ("../src/"),
1580 build_string (PATH_DUMPLOADSEARCH
));
1581 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1582 tem1
= Ffile_exists_p (tem
);
1583 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1586 newdir
= Fexpand_file_name (build_string ("../etc/"),
1587 build_string (PATH_DUMPLOADSEARCH
));
1588 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1589 tem1
= Ffile_exists_p (tem
);
1591 Vdata_directory
= newdir
;
1599 tempdir
= Fdirectory_file_name (Vexec_directory
);
1600 if (access (SDATA (tempdir
), 0) < 0)
1601 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1605 tempdir
= Fdirectory_file_name (Vdata_directory
);
1606 if (access (SDATA (tempdir
), 0) < 0)
1607 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1611 Vshell_file_name
= build_string ("*dcl*");
1613 sh
= (char *) getenv ("SHELL");
1614 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1618 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1620 if (getenv ("TMPDIR"))
1622 char *dir
= getenv ("TMPDIR");
1623 Vtemp_file_name_pattern
1624 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1625 build_string (dir
));
1628 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1632 Vshared_game_score_directory
= Qnil
;
1634 Vshared_game_score_directory
= build_string (PATH_GAME
);
1635 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1636 Vshared_game_score_directory
= Qnil
;
1641 set_process_environment ()
1643 register char **envp
;
1645 Vprocess_environment
= Qnil
;
1649 for (envp
= environ
; *envp
; envp
++)
1650 Vprocess_environment
= Fcons (build_string (*envp
),
1651 Vprocess_environment
);
1658 Qbuffer_file_type
= intern ("buffer-file-type");
1659 staticpro (&Qbuffer_file_type
);
1662 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1663 doc
: /* *File name to load inferior shells from.
1664 Initialized from the SHELL environment variable. */);
1666 DEFVAR_LISP ("exec-path", &Vexec_path
,
1667 doc
: /* *List of directories to search programs to run in subprocesses.
1668 Each element is a string (directory name) or nil (try default directory). */);
1670 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1671 doc
: /* *List of suffixes to try to find executable file names.
1672 Each element is a string. */);
1673 Vexec_suffixes
= Qnil
;
1675 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1676 doc
: /* Directory for executables for Emacs to invoke.
1677 More generally, this includes any architecture-dependent files
1678 that are built and installed from the Emacs distribution. */);
1680 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1681 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1682 These are files intended for Emacs to use while it runs. */);
1684 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1685 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1686 This is usually the same as data-directory. */);
1688 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1689 doc
: /* For internal use by the build procedure only.
1690 This is the name of the directory in which the build procedure installed
1691 Emacs's info files; the default value for Info-default-directory-list
1693 Vconfigure_info_directory
= build_string (PATH_INFO
);
1695 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1696 doc
: /* Directory of score files for games which come with GNU Emacs.
1697 If this variable is nil, then Emacs is unable to use a shared directory. */);
1699 Vshared_game_score_directory
= Qnil
;
1701 Vshared_game_score_directory
= build_string (PATH_GAME
);
1704 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1705 doc
: /* Pattern for making names for temporary files.
1706 This is used by `call-process-region'. */);
1707 /* This variable is initialized in init_callproc. */
1709 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1710 doc
: /* List of environment variables for subprocesses to inherit.
1711 Each element should be a string of the form ENVVARNAME=VALUE.
1712 If multiple entries define the same variable, the first one always
1714 The environment which Emacs inherits is placed in this variable
1716 Non-ASCII characters are encoded according to the initial value of
1717 `locale-coding-system', i.e. the elements must normally be decoded for use.
1718 See `setenv' and `getenv'. */);
1721 defsubr (&Scall_process
);
1722 defsubr (&Sgetenv_internal
);
1724 defsubr (&Scall_process_region
);
1727 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1728 (do not change this comment) */