1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2011
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
26 #include <sys/types.h>
36 #define _P_NOWAIT 1 /* from process.h */
39 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
41 #include <sys/param.h>
47 #include "character.h"
50 #include "composite.h"
53 #include "syssignal.h"
55 #include "blockinput.h"
57 #include "termhooks.h"
64 extern char **environ
;
70 #define setpgrp setpgid
74 /* Pattern used by call-process-region to make temp files. */
75 static Lisp_Object Vtemp_file_name_pattern
;
78 Lisp_Object Qbuffer_file_type
;
81 /* True if we are about to fork off a synchronous process or if we
82 are waiting for it. */
83 int synch_process_alive
;
85 /* Nonzero => this is a string explaining death of synchronous subprocess. */
86 const char *synch_process_death
;
88 /* Nonzero => this is the signal number that terminated the subprocess. */
89 int synch_process_termsig
;
91 /* If synch_process_death is zero,
92 this is exit code of synchronous subprocess. */
93 int synch_process_retcode
;
96 /* Clean up when exiting Fcall_process.
97 On MSDOS, delete the temporary file on any kind of termination.
98 On Unix, kill the process and any children on termination by signal. */
100 /* Nonzero if this is termination due to exit. */
101 static int call_process_exited
;
103 EXFUN (Fgetenv_internal
, 2);
106 call_process_kill (Lisp_Object fdpid
)
108 emacs_close (XFASTINT (Fcar (fdpid
)));
109 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
110 synch_process_alive
= 0;
115 call_process_cleanup (Lisp_Object arg
)
117 Lisp_Object fdpid
= Fcdr (arg
);
124 Fset_buffer (Fcar (arg
));
127 /* for MSDOS fdpid is really (fd . tempfile) */
129 emacs_close (XFASTINT (Fcar (fdpid
)));
130 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
131 unlink (SDATA (file
));
132 #else /* not MSDOS */
133 pid
= XFASTINT (Fcdr (fdpid
));
135 if (call_process_exited
)
137 emacs_close (XFASTINT (Fcar (fdpid
)));
141 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
143 int count
= SPECPDL_INDEX ();
144 record_unwind_protect (call_process_kill
, fdpid
);
145 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
148 wait_for_termination (pid
);
150 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
151 message1 ("Waiting for process to die...done");
153 synch_process_alive
= 0;
154 emacs_close (XFASTINT (Fcar (fdpid
)));
155 #endif /* not MSDOS */
159 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
160 doc
: /* Call PROGRAM synchronously in separate process.
161 The remaining arguments are optional.
162 The program's input comes from file INFILE (nil means `/dev/null').
163 Insert output in BUFFER before point; t means current buffer;
164 nil for BUFFER means discard it; 0 means discard and don't wait.
165 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
166 REAL-BUFFER says what to do with standard output, as above,
167 while STDERR-FILE says what to do with standard error in the child.
168 STDERR-FILE may be nil (discard standard error output),
169 t (mix it with ordinary output), or a file name string.
171 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
172 Remaining arguments are strings passed as command arguments to PROGRAM.
174 If executable PROGRAM can't be found as an executable, `call-process'
175 signals a Lisp error. `call-process' reports errors in execution of
176 the program only through its return and output.
178 If BUFFER is 0, `call-process' returns immediately with value nil.
179 Otherwise it waits for PROGRAM to terminate
180 and returns a numeric exit status or a signal description string.
181 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
183 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
184 (int nargs
, register Lisp_Object
*args
)
186 Lisp_Object infile
, buffer
, current_dir
, path
;
191 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
192 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
193 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
194 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
195 int count
= SPECPDL_INDEX ();
197 register const unsigned char **new_argv
;
198 /* File to use for stderr in the child.
199 t means use same as standard output. */
200 Lisp_Object error_file
;
201 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
202 char *outf
, *tempfile
;
205 struct coding_system process_coding
; /* coding-system of process output */
206 struct coding_system argument_coding
; /* coding-system of arguments */
207 /* Set to the return value of Ffind_operation_coding_system. */
208 Lisp_Object coding_systems
;
210 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
213 CHECK_STRING (args
[0]);
218 /* Without asynchronous processes we cannot have BUFFER == 0. */
220 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
221 error ("Operating system cannot handle asynchronous subprocesses");
222 #endif /* subprocesses */
224 /* Decide the coding-system for giving arguments. */
226 Lisp_Object val
, *args2
;
229 /* If arguments are supplied, we may have to encode them. */
233 Lisp_Object coding_attrs
;
235 for (i
= 4; i
< nargs
; i
++)
236 CHECK_STRING (args
[i
]);
238 for (i
= 4; i
< nargs
; i
++)
239 if (STRING_MULTIBYTE (args
[i
]))
242 if (!NILP (Vcoding_system_for_write
))
243 val
= Vcoding_system_for_write
;
244 else if (! must_encode
)
248 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
249 args2
[0] = Qcall_process
;
250 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
251 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
252 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
254 val
= complement_process_encoding_system (val
);
255 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
256 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
257 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
259 /* We should not use an ASCII incompatible coding system. */
260 val
= raw_text_coding_system (val
);
261 setup_coding_system (val
, &argument_coding
);
266 if (nargs
>= 2 && ! NILP (args
[1]))
268 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
269 CHECK_STRING (infile
);
272 infile
= build_string (NULL_DEVICE
);
278 /* If BUFFER is a list, its meaning is
279 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
282 if (CONSP (XCDR (buffer
)))
284 Lisp_Object stderr_file
;
285 stderr_file
= XCAR (XCDR (buffer
));
287 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
288 error_file
= stderr_file
;
290 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
293 buffer
= XCAR (buffer
);
296 if (!(EQ (buffer
, Qnil
)
298 || INTEGERP (buffer
)))
300 Lisp_Object spec_buffer
;
301 spec_buffer
= buffer
;
302 buffer
= Fget_buffer_create (buffer
);
303 /* Mention the buffer name for a better error message. */
305 CHECK_BUFFER (spec_buffer
);
306 CHECK_BUFFER (buffer
);
312 /* Make sure that the child will be able to chdir to the current
313 buffer's current directory, or its unhandled equivalent. We
314 can't just have the child check for an error when it does the
315 chdir, since it's in a vfork.
317 We have to GCPRO around this because Fexpand_file_name,
318 Funhandled_file_name_directory, and Ffile_accessible_directory_p
319 might call a file name handling function. The argument list is
320 protected by the caller, so all we really have to worry about is
323 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
325 current_dir
= current_buffer
->directory
;
327 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
329 current_dir
= Funhandled_file_name_directory (current_dir
);
330 if (NILP (current_dir
))
331 /* If the file name handler says that current_dir is unreachable, use
332 a sensible default. */
333 current_dir
= build_string ("~/");
334 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
335 current_dir
= Ffile_name_as_directory (current_dir
);
337 if (NILP (Ffile_accessible_directory_p (current_dir
)))
338 report_file_error ("Setting current directory",
339 Fcons (current_buffer
->directory
, Qnil
));
341 if (STRING_MULTIBYTE (infile
))
342 infile
= ENCODE_FILE (infile
);
343 if (STRING_MULTIBYTE (current_dir
))
344 current_dir
= ENCODE_FILE (current_dir
);
345 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
346 error_file
= ENCODE_FILE (error_file
);
350 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
352 filefd
= emacs_open (SSDATA (infile
), O_RDONLY
, 0);
355 infile
= DECODE_FILE (infile
);
356 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
358 /* Search for program; barf if not found. */
360 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
362 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
363 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
368 emacs_close (filefd
);
369 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
372 /* If program file name starts with /: for quoting a magic name,
374 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
375 && SREF (path
, 1) == ':')
376 path
= Fsubstring (path
, make_number (2), Qnil
);
378 new_argv
= (const unsigned char **)
379 alloca (max (2, nargs
- 2) * sizeof (char *));
383 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
385 GCPRO5 (infile
, buffer
, current_dir
, path
, error_file
);
386 argument_coding
.dst_multibyte
= 0;
387 for (i
= 4; i
< nargs
; i
++)
389 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
390 if (CODING_REQUIRE_ENCODING (&argument_coding
))
391 /* We must encode this argument. */
392 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
395 for (i
= 4; i
< nargs
; i
++)
396 new_argv
[i
- 3] = SDATA (args
[i
]);
401 new_argv
[0] = SDATA (path
);
403 #ifdef MSDOS /* MW, July 1993 */
404 if ((outf
= egetenv ("TMPDIR")))
405 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
408 tempfile
= alloca (20);
411 dostounix_filename (tempfile
);
412 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
413 strcat (tempfile
, "/");
414 strcat (tempfile
, "detmp.XXX");
417 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
420 emacs_close (filefd
);
421 report_file_error ("Opening process output file",
422 Fcons (build_string (tempfile
), Qnil
));
428 if (INTEGERP (buffer
))
429 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
436 emacs_close (filefd
);
437 report_file_error ("Creating process pipe", Qnil
);
443 /* child_setup must clobber environ in systems with true vfork.
444 Protect it from permanent change. */
445 register char **save_environ
= environ
;
446 register int fd1
= fd
[1];
449 #if 0 /* Some systems don't have sigblock. */
450 mask
= sigblock (sigmask (SIGCHLD
));
453 /* Record that we're about to create a synchronous process. */
454 synch_process_alive
= 1;
456 /* These vars record information from process termination.
457 Clear them now before process can possibly terminate,
458 to avoid timing error if process terminates soon. */
459 synch_process_death
= 0;
460 synch_process_retcode
= 0;
461 synch_process_termsig
= 0;
463 if (NILP (error_file
))
464 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
465 else if (STRINGP (error_file
))
468 fd_error
= emacs_open (SSDATA (error_file
),
469 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
471 #else /* not DOS_NT */
472 fd_error
= creat (SSDATA (error_file
), 0666);
473 #endif /* not DOS_NT */
478 emacs_close (filefd
);
486 if (NILP (error_file
))
487 error_file
= build_string (NULL_DEVICE
);
488 else if (STRINGP (error_file
))
489 error_file
= DECODE_FILE (error_file
);
490 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
493 #ifdef MSDOS /* MW, July 1993 */
494 /* Note that on MSDOS `child_setup' actually returns the child process
495 exit status, not its PID, so we assign it to `synch_process_retcode'
497 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
500 /* Record that the synchronous process exited and note its
501 termination status. */
502 synch_process_alive
= 0;
503 synch_process_retcode
= pid
;
504 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
506 synchronize_system_messages_locale ();
507 synch_process_death
= strerror (errno
);
510 emacs_close (outfilefd
);
511 if (fd_error
!= outfilefd
)
512 emacs_close (fd_error
);
513 fd1
= -1; /* No harm in closing that one! */
514 /* Since CRLF is converted to LF within `decode_coding', we can
515 always open a file with binary mode. */
516 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
520 emacs_close (filefd
);
521 report_file_error ("Cannot re-open temporary file", Qnil
);
523 #else /* not MSDOS */
525 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
527 #else /* not WINDOWSNT */
544 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
549 #endif /* not WINDOWSNT */
551 /* The MSDOS case did this already. */
553 emacs_close (fd_error
);
554 #endif /* not MSDOS */
556 environ
= save_environ
;
558 /* Close most of our fd's, but not fd[0]
559 since we will use that to read input from. */
560 emacs_close (filefd
);
561 if (fd1
>= 0 && fd1
!= fd_error
)
569 report_file_error ("Doing vfork", Qnil
);
572 if (INTEGERP (buffer
))
579 /* Enable sending signal if user quits below. */
580 call_process_exited
= 0;
583 /* MSDOS needs different cleanup information. */
584 record_unwind_protect (call_process_cleanup
,
585 Fcons (Fcurrent_buffer (),
586 Fcons (make_number (fd
[0]),
587 build_string (tempfile
))));
589 record_unwind_protect (call_process_cleanup
,
590 Fcons (Fcurrent_buffer (),
591 Fcons (make_number (fd
[0]), make_number (pid
))));
592 #endif /* not MSDOS */
595 if (BUFFERP (buffer
))
596 Fset_buffer (buffer
);
600 /* If BUFFER is nil, we must read process output once and then
601 discard it, so setup coding system but with nil. */
602 setup_coding_system (Qnil
, &process_coding
);
606 Lisp_Object val
, *args2
;
609 if (!NILP (Vcoding_system_for_read
))
610 val
= Vcoding_system_for_read
;
613 if (EQ (coding_systems
, Qt
))
617 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
618 args2
[0] = Qcall_process
;
619 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
621 = Ffind_operation_coding_system (nargs
+ 1, args2
);
623 if (CONSP (coding_systems
))
624 val
= XCAR (coding_systems
);
625 else if (CONSP (Vdefault_process_coding_system
))
626 val
= XCAR (Vdefault_process_coding_system
);
630 Fcheck_coding_system (val
);
631 /* In unibyte mode, character code conversion should not take
632 place but EOL conversion should. So, setup raw-text or one
633 of the subsidiary according to the information just setup. */
634 if (NILP (current_buffer
->enable_multibyte_characters
)
636 val
= raw_text_coding_system (val
);
637 setup_coding_system (val
, &process_coding
);
644 register EMACS_INT nread
;
646 EMACS_INT total_read
= 0;
648 int display_on_the_fly
= display_p
;
649 struct coding_system saved_coding
;
651 saved_coding
= process_coding
;
654 /* Repeatedly read until we've filled as much as possible
655 of the buffer size we have. But don't read
656 less than 1024--save that for the next bufferful. */
658 while (nread
< bufsize
- 1024)
660 int this_read
= emacs_read (fd
[0], buf
+ nread
,
668 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
673 total_read
+= this_read
;
675 if (display_on_the_fly
)
679 /* Now NREAD is the total amount of data in the buffer. */
684 if (NILP (current_buffer
->enable_multibyte_characters
)
685 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
686 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
688 { /* We have to decode the input. */
690 int count1
= SPECPDL_INDEX ();
692 XSETBUFFER (curbuf
, current_buffer
);
693 /* We cannot allow after-change-functions be run
694 during decoding, because that might modify the
695 buffer, while we rely on process_coding.produced to
696 faithfully reflect inserted text until we
697 TEMP_SET_PT_BOTH below. */
698 specbind (Qinhibit_modification_hooks
, Qt
);
699 decode_coding_c_string (&process_coding
, buf
, nread
,
701 unbind_to (count1
, Qnil
);
702 if (display_on_the_fly
703 && CODING_REQUIRE_DETECTION (&saved_coding
)
704 && ! CODING_REQUIRE_DETECTION (&process_coding
))
706 /* We have detected some coding system. But,
707 there's a possibility that the detection was
708 done by insufficient data. So, we give up
709 displaying on the fly. */
710 if (process_coding
.produced
> 0)
711 del_range_2 (process_coding
.dst_pos
,
712 process_coding
.dst_pos_byte
,
713 process_coding
.dst_pos
714 + process_coding
.produced_char
,
715 process_coding
.dst_pos_byte
716 + process_coding
.produced
, 0);
717 display_on_the_fly
= 0;
718 process_coding
= saved_coding
;
720 /* This is to make the above condition always
721 fails in the future. */
722 saved_coding
.common_flags
723 &= ~CODING_REQUIRE_DETECTION_MASK
;
727 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
728 PT_BYTE
+ process_coding
.produced
);
729 carryover
= process_coding
.carryover_bytes
;
731 memcpy (buf
, process_coding
.carryover
,
732 process_coding
.carryover_bytes
);
736 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
739 /* Make the buffer bigger as we continue to read more data,
740 but not past CALLPROC_BUFFER_SIZE_MAX. */
741 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
742 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
743 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
748 prepare_menu_bars ();
750 redisplay_preserve_echo_area (1);
751 /* This variable might have been set to 0 for code
752 detection. In that case, we set it back to 1 because
753 we should have already detected a coding system. */
754 display_on_the_fly
= 1;
761 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
762 /* If the caller required, let the buffer inherit the
763 coding-system used to decode the process output. */
764 if (inherit_process_coding_system
)
765 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
766 make_number (total_read
));
770 /* Wait for it to terminate, unless it already has. */
771 wait_for_termination (pid
);
776 /* Don't kill any children that the subprocess may have left behind
778 call_process_exited
= 1;
780 unbind_to (count
, Qnil
);
782 if (synch_process_termsig
)
786 synchronize_system_messages_locale ();
787 signame
= strsignal (synch_process_termsig
);
792 synch_process_death
= signame
;
795 if (synch_process_death
)
796 return code_convert_string_norecord (build_string (synch_process_death
),
797 Vlocale_coding_system
, 0);
798 return make_number (synch_process_retcode
);
802 delete_temp_file (Lisp_Object name
)
804 /* Suppress jka-compr handling, etc. */
805 int count
= SPECPDL_INDEX ();
806 specbind (intern ("file-name-handler-alist"), Qnil
);
807 internal_delete_file (name
);
808 unbind_to (count
, Qnil
);
812 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
814 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
815 The remaining arguments are optional.
816 Delete the text if fourth arg DELETE is non-nil.
818 Insert output in BUFFER before point; t means current buffer;
819 nil for BUFFER means discard it; 0 means discard and don't wait.
820 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
821 REAL-BUFFER says what to do with standard output, as above,
822 while STDERR-FILE says what to do with standard error in the child.
823 STDERR-FILE may be nil (discard standard error output),
824 t (mix it with ordinary output), or a file name string.
826 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
827 Remaining args are passed to PROGRAM at startup as command args.
829 If BUFFER is 0, `call-process-region' returns immediately with value nil.
830 Otherwise it waits for PROGRAM to terminate
831 and returns a numeric exit status or a signal description string.
832 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
834 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
835 (int nargs
, register Lisp_Object
*args
)
838 Lisp_Object filename_string
;
839 register Lisp_Object start
, end
;
840 int count
= SPECPDL_INDEX ();
841 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
842 Lisp_Object coding_systems
;
843 Lisp_Object val
, *args2
;
846 Lisp_Object tmpdir
, pattern
;
848 if (STRINGP (Vtemporary_file_directory
))
849 tmpdir
= Vtemporary_file_directory
;
853 if (getenv ("TMPDIR"))
854 tmpdir
= build_string (getenv ("TMPDIR"));
856 tmpdir
= build_string ("/tmp/");
859 if ((outf
= egetenv ("TMPDIR"))
860 || (outf
= egetenv ("TMP"))
861 || (outf
= egetenv ("TEMP")))
862 tmpdir
= build_string (outf
);
864 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
868 pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
869 tempfile
= (char *) alloca (SBYTES (pattern
) + 1);
870 memcpy (tempfile
, SDATA (pattern
), SBYTES (pattern
) + 1);
878 fd
= mkstemp (tempfile
);
881 report_file_error ("Failed to open temporary file",
882 Fcons (Vtemp_file_name_pattern
, Qnil
));
890 filename_string
= build_string (tempfile
);
891 GCPRO1 (filename_string
);
894 /* Decide coding-system of the contents of the temporary file. */
895 if (!NILP (Vcoding_system_for_write
))
896 val
= Vcoding_system_for_write
;
897 else if (NILP (current_buffer
->enable_multibyte_characters
))
901 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
902 args2
[0] = Qcall_process_region
;
903 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
904 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
905 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
907 val
= complement_process_encoding_system (val
);
910 int count1
= SPECPDL_INDEX ();
912 specbind (intern ("coding-system-for-write"), val
);
913 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
914 happen to get a ".Z" suffix. */
915 specbind (intern ("file-name-handler-alist"), Qnil
);
916 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
918 unbind_to (count1
, Qnil
);
921 /* Note that Fcall_process takes care of binding
922 coding-system-for-read. */
924 record_unwind_protect (delete_temp_file
, filename_string
);
926 if (nargs
> 3 && !NILP (args
[3]))
927 Fdelete_region (start
, end
);
939 args
[1] = filename_string
;
941 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
945 static int relocate_fd (int fd
, int minfd
);
949 add_env (char **env
, char **new_env
, char *string
)
956 /* See if this string duplicates any string already in the env.
957 If so, don't put it in.
958 When an env var has multiple definitions,
959 we keep the definition that comes first in process-environment. */
960 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
962 char *p
= *ep
, *q
= string
;
968 /* The string is a lone variable name; keep it for now, we
969 will remove it later. It is a placeholder for a
970 variable that is not to be included in the environment. */
982 /* This is the last thing run in a newly forked inferior
983 either synchronous or asynchronous.
984 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
985 Initialize inferior's priority, pgrp, connected dir and environment.
986 then exec another program based on new_argv.
988 This function may change environ for the superior process.
989 Therefore, the superior process must save and restore the value
990 of environ around the vfork and the call to this function.
992 SET_PGRP is nonzero if we should put the subprocess into a separate
995 CURRENT_DIR is an elisp string giving the path of the current
996 directory the subprocess should have. Since we can't really signal
997 a decent error from within the child, this should be verified as an
998 executable directory by the parent. */
1001 child_setup (int in
, int out
, int err
, register char **new_argv
, int set_pgrp
, Lisp_Object current_dir
)
1008 #endif /* WINDOWSNT */
1010 int pid
= getpid ();
1012 /* Close Emacs's descriptors that this process should not have. */
1013 close_process_descs ();
1015 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1016 we will lose if we call close_load_descs here. */
1018 close_load_descs ();
1021 /* Note that use of alloca is always safe here. It's obvious for systems
1022 that do not have true vfork or that have true (stack) alloca.
1023 If using vfork and C_ALLOCA (when Emacs used to include
1024 src/alloca.c) it is safe because that changes the superior's
1025 static variables as if the superior had done alloca and will be
1026 cleaned up in the usual way. */
1028 register char *temp
;
1031 i
= SBYTES (current_dir
);
1033 /* MSDOS must have all environment variables malloc'ed, because
1034 low-level libc functions that launch subsidiary processes rely
1036 pwd_var
= (char *) xmalloc (i
+ 6);
1038 pwd_var
= (char *) alloca (i
+ 6);
1041 memcpy (pwd_var
, "PWD=", 4);
1042 memcpy (temp
, SDATA (current_dir
), i
);
1043 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1047 /* We can't signal an Elisp error here; we're in a vfork. Since
1048 the callers check the current directory before forking, this
1049 should only return an error if the directory's permissions
1050 are changed between the check and this chdir, but we should
1052 if (chdir (temp
) < 0)
1055 /* Get past the drive letter, so that d:/ is left alone. */
1056 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1063 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1064 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1068 /* Set `env' to a vector of the strings in the environment. */
1070 register Lisp_Object tem
;
1071 register char **new_env
;
1073 register int new_length
;
1074 Lisp_Object display
= Qnil
;
1078 for (tem
= Vprocess_environment
;
1079 CONSP (tem
) && STRINGP (XCAR (tem
));
1082 if (strncmp (SSDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1083 && (SDATA (XCAR (tem
)) [7] == '\0'
1084 || SDATA (XCAR (tem
)) [7] == '='))
1085 /* DISPLAY is specified in process-environment. */
1090 /* If not provided yet, use the frame's DISPLAY. */
1093 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1094 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1095 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1096 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1097 Vinitial_environment
);
1105 /* new_length + 2 to include PWD and terminating 0. */
1106 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1107 /* If we have a PWD envvar, pass one down,
1108 but with corrected value. */
1109 if (egetenv ("PWD"))
1110 *new_env
++ = pwd_var
;
1112 if (STRINGP (display
))
1114 int vlen
= strlen ("DISPLAY=") + strlen (SSDATA (display
)) + 1;
1115 char *vdata
= (char *) alloca (vlen
);
1116 strcpy (vdata
, "DISPLAY=");
1117 strcat (vdata
, SSDATA (display
));
1118 new_env
= add_env (env
, new_env
, vdata
);
1122 for (tem
= Vprocess_environment
;
1123 CONSP (tem
) && STRINGP (XCAR (tem
));
1125 new_env
= add_env (env
, new_env
, SSDATA (XCAR (tem
)));
1129 /* Remove variable names without values. */
1133 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1143 prepare_standard_handles (in
, out
, err
, handles
);
1144 set_process_dir (SDATA (current_dir
));
1145 /* Spawn the child. (See ntproc.c:Spawnve). */
1146 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1147 reset_standard_handles (in
, out
, err
, handles
);
1149 /* An error occurred while trying to spawn the process. */
1150 report_file_error ("Spawning child process", Qnil
);
1153 #else /* not WINDOWSNT */
1154 /* Make sure that in, out, and err are not actually already in
1155 descriptors zero, one, or two; this could happen if Emacs is
1156 started with its standard in, out, or error closed, as might
1159 int oin
= in
, oout
= out
;
1161 /* We have to avoid relocating the same descriptor twice! */
1163 in
= relocate_fd (in
, 3);
1168 out
= relocate_fd (out
, 3);
1172 else if (err
== oout
)
1175 err
= relocate_fd (err
, 3);
1189 if (err
!= in
&& err
!= out
)
1193 #ifndef SETPGRP_RELEASES_CTTY
1194 setpgrp (); /* No arguments but equivalent in this case */
1198 #endif /* not USG */
1200 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1203 /* execvp does not accept an environment arg so the only way
1204 to pass this environment is to set environ. Our caller
1205 is responsible for restoring the ambient value of environ. */
1207 execvp (new_argv
[0], new_argv
);
1209 emacs_write (1, "Can't exec program: ", 20);
1210 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1211 emacs_write (1, "\n", 1);
1215 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1218 /* An error occurred while trying to run the subprocess. */
1219 report_file_error ("Spawning child process", Qnil
);
1222 #endif /* not WINDOWSNT */
1226 /* Move the file descriptor FD so that its number is not less than MINFD.
1227 If the file descriptor is moved at all, the original is freed. */
1229 relocate_fd (int fd
, int minfd
)
1237 new = fcntl (fd
, F_DUPFD
, minfd
);
1241 /* Note that we hold the original FD open while we recurse,
1242 to guarantee we'll get a new FD if we need it. */
1243 new = relocate_fd (new, minfd
);
1247 const char *message1
= "Error while setting up child: ";
1248 const char *errmessage
= strerror (errno
);
1249 const char *message2
= "\n";
1250 emacs_write (2, message1
, strlen (message1
));
1251 emacs_write (2, errmessage
, strlen (errmessage
));
1252 emacs_write (2, message2
, strlen (message2
));
1259 #endif /* not WINDOWSNT */
1262 getenv_internal_1 (const char *var
, int varlen
, char **value
, int *valuelen
,
1265 for (; CONSP (env
); env
= XCDR (env
))
1267 Lisp_Object entry
= XCAR (env
);
1269 && SBYTES (entry
) >= varlen
1271 /* NT environment variables are case insensitive. */
1272 && ! strnicmp (SDATA (entry
), var
, varlen
)
1273 #else /* not WINDOWSNT */
1274 && ! memcmp (SDATA (entry
), var
, varlen
)
1275 #endif /* not WINDOWSNT */
1278 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1280 *value
= SSDATA (entry
) + (varlen
+ 1);
1281 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1284 else if (SBYTES (entry
) == varlen
)
1286 /* Lone variable names in Vprocess_environment mean that
1287 variable should be removed from the environment. */
1297 getenv_internal (const char *var
, int varlen
, char **value
, int *valuelen
,
1300 /* Try to find VAR in Vprocess_environment first. */
1301 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1302 Vprocess_environment
))
1303 return *value
? 1 : 0;
1305 /* For DISPLAY try to get the values from the frame or the initial env. */
1306 if (strcmp (var
, "DISPLAY") == 0)
1309 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1310 if (STRINGP (display
))
1312 *value
= SSDATA (display
);
1313 *valuelen
= SBYTES (display
);
1316 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1317 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1318 Vinitial_environment
))
1319 return *value
? 1 : 0;
1325 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1326 doc
: /* Get the value of environment variable VARIABLE.
1327 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1328 the environment. Otherwise, value is a string.
1330 This function searches `process-environment' for VARIABLE.
1332 If optional parameter ENV is a list, then search this list instead of
1333 `process-environment', and return t when encountering a negative entry
1334 \(an entry for a variable with no value). */)
1335 (Lisp_Object variable
, Lisp_Object env
)
1340 CHECK_STRING (variable
);
1343 if (getenv_internal_1 (SSDATA (variable
), SBYTES (variable
),
1344 &value
, &valuelen
, env
))
1345 return value
? make_string (value
, valuelen
) : Qt
;
1349 else if (getenv_internal (SSDATA (variable
), SBYTES (variable
),
1350 &value
, &valuelen
, env
))
1351 return make_string (value
, valuelen
);
1356 /* A version of getenv that consults the Lisp environment lists,
1357 easily callable from C. */
1359 egetenv (const char *var
)
1364 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1371 /* This is run before init_cmdargs. */
1374 init_callproc_1 (void)
1376 char *data_dir
= egetenv ("EMACSDATA");
1377 char *doc_dir
= egetenv ("EMACSDOC");
1380 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1383 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1386 /* Check the EMACSPATH environment variable, defaulting to the
1387 PATH_EXEC path from epaths.h. */
1388 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1389 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1390 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1393 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1396 init_callproc (void)
1398 char *data_dir
= egetenv ("EMACSDATA");
1401 Lisp_Object tempdir
;
1403 if (!NILP (Vinstallation_directory
))
1405 /* Add to the path the lib-src subdir of the installation dir. */
1407 tem
= Fexpand_file_name (build_string ("lib-src"),
1408 Vinstallation_directory
);
1410 /* MSDOS uses wrapped binaries, so don't do this. */
1411 if (NILP (Fmember (tem
, Vexec_path
)))
1413 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1414 Vexec_path
= Fcons (tem
, Vexec_path
);
1415 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1418 Vexec_directory
= Ffile_name_as_directory (tem
);
1419 #endif /* not DOS_NT */
1421 /* Maybe use ../etc as well as ../lib-src. */
1424 tem
= Fexpand_file_name (build_string ("etc"),
1425 Vinstallation_directory
);
1426 Vdoc_directory
= Ffile_name_as_directory (tem
);
1430 /* Look for the files that should be in etc. We don't use
1431 Vinstallation_directory, because these files are never installed
1432 near the executable, and they are never in the build
1433 directory when that's different from the source directory.
1435 Instead, if these files are not in the nominal place, we try the
1436 source directory. */
1439 Lisp_Object tem
, tem1
, srcdir
;
1441 srcdir
= Fexpand_file_name (build_string ("../src/"),
1442 build_string (PATH_DUMPLOADSEARCH
));
1443 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1444 tem1
= Ffile_exists_p (tem
);
1445 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1448 newdir
= Fexpand_file_name (build_string ("../etc/"),
1449 build_string (PATH_DUMPLOADSEARCH
));
1450 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1451 tem1
= Ffile_exists_p (tem
);
1453 Vdata_directory
= newdir
;
1461 tempdir
= Fdirectory_file_name (Vexec_directory
);
1462 if (access (SSDATA (tempdir
), 0) < 0)
1463 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1467 tempdir
= Fdirectory_file_name (Vdata_directory
);
1468 if (access (SSDATA (tempdir
), 0) < 0)
1469 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1472 sh
= (char *) getenv ("SHELL");
1473 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1476 Vshared_game_score_directory
= Qnil
;
1478 Vshared_game_score_directory
= build_string (PATH_GAME
);
1479 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1480 Vshared_game_score_directory
= Qnil
;
1485 set_initial_environment (void)
1487 register char **envp
;
1489 Vprocess_environment
= Qnil
;
1494 for (envp
= environ
; *envp
; envp
++)
1495 Vprocess_environment
= Fcons (build_string (*envp
),
1496 Vprocess_environment
);
1497 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1498 to use `delete' and friends on process-environment. */
1499 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1504 syms_of_callproc (void)
1507 Qbuffer_file_type
= intern_c_string ("buffer-file-type");
1508 staticpro (&Qbuffer_file_type
);
1512 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1513 #elif defined (WINDOWSNT)
1514 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1516 Vtemp_file_name_pattern
= build_string ("detmp.XXX");
1518 staticpro (&Vtemp_file_name_pattern
);
1520 DEFVAR_LISP ("shell-file-name", Vshell_file_name
,
1521 doc
: /* *File name to load inferior shells from.
1522 Initialized from the SHELL environment variable, or to a system-dependent
1523 default if SHELL is not set. */);
1525 DEFVAR_LISP ("exec-path", Vexec_path
,
1526 doc
: /* *List of directories to search programs to run in subprocesses.
1527 Each element is a string (directory name) or nil (try default directory). */);
1529 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes
,
1530 doc
: /* *List of suffixes to try to find executable file names.
1531 Each element is a string. */);
1532 Vexec_suffixes
= Qnil
;
1534 DEFVAR_LISP ("exec-directory", Vexec_directory
,
1535 doc
: /* Directory for executables for Emacs to invoke.
1536 More generally, this includes any architecture-dependent files
1537 that are built and installed from the Emacs distribution. */);
1539 DEFVAR_LISP ("data-directory", Vdata_directory
,
1540 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1541 These are files intended for Emacs to use while it runs. */);
1543 DEFVAR_LISP ("doc-directory", Vdoc_directory
,
1544 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1545 This is usually the same as `data-directory'. */);
1547 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory
,
1548 doc
: /* For internal use by the build procedure only.
1549 This is the name of the directory in which the build procedure installed
1550 Emacs's info files; the default value for `Info-default-directory-list'
1552 Vconfigure_info_directory
= build_string (PATH_INFO
);
1554 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory
,
1555 doc
: /* Directory of score files for games which come with GNU Emacs.
1556 If this variable is nil, then Emacs is unable to use a shared directory. */);
1558 Vshared_game_score_directory
= Qnil
;
1560 Vshared_game_score_directory
= build_string (PATH_GAME
);
1563 DEFVAR_LISP ("initial-environment", Vinitial_environment
,
1564 doc
: /* List of environment variables inherited from the parent process.
1565 Each element should be a string of the form ENVVARNAME=VALUE.
1566 The elements must normally be decoded (using `locale-coding-system') for use. */);
1567 Vinitial_environment
= Qnil
;
1569 DEFVAR_LISP ("process-environment", Vprocess_environment
,
1570 doc
: /* List of overridden environment variables for subprocesses to inherit.
1571 Each element should be a string of the form ENVVARNAME=VALUE.
1573 Entries in this list take precedence to those in the frame-local
1574 environments. Therefore, let-binding `process-environment' is an easy
1575 way to temporarily change the value of an environment variable,
1576 irrespective of where it comes from. To use `process-environment' to
1577 remove an environment variable, include only its name in the list,
1580 This variable is set to nil when Emacs starts.
1582 If multiple entries define the same variable, the first one always
1585 Non-ASCII characters are encoded according to the initial value of
1586 `locale-coding-system', i.e. the elements must normally be decoded for
1589 See `setenv' and `getenv'. */);
1590 Vprocess_environment
= Qnil
;
1592 defsubr (&Scall_process
);
1593 defsubr (&Sgetenv_internal
);
1594 defsubr (&Scall_process_region
);