* doc/misc/auth.texi (Help for users): Break long lines.
[emacs.git] / src / callproc.c
blobd152da19f7b34a1d079f12d07a3a677e685c296c
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2012
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/>. */
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <sys/types.h>
25 #include <unistd.h>
27 #include <sys/file.h>
28 #include <fcntl.h>
30 #include "lisp.h"
32 #ifdef WINDOWSNT
33 #define NOMINMAX
34 #include <windows.h>
35 #include "w32.h"
36 #define _P_NOWAIT 1 /* from process.h */
37 #endif
39 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
40 #include <sys/stat.h>
41 #include <sys/param.h>
42 #endif /* MSDOS */
44 #include "commands.h"
45 #include "character.h"
46 #include "buffer.h"
47 #include "ccl.h"
48 #include "coding.h"
49 #include "composite.h"
50 #include <epaths.h>
51 #include "process.h"
52 #include "syssignal.h"
53 #include "systty.h"
54 #include "syswait.h"
55 #include "blockinput.h"
56 #include "frame.h"
57 #include "termhooks.h"
59 #ifdef MSDOS
60 #include "msdos.h"
61 #endif
63 #ifdef HAVE_NS
64 #include "nsterm.h"
65 #endif
67 /* Pattern used by call-process-region to make temp files. */
68 static Lisp_Object Vtemp_file_name_pattern;
70 /* True if we are about to fork off a synchronous process or if we
71 are waiting for it. */
72 bool synch_process_alive;
74 /* Nonzero => this is a string explaining death of synchronous subprocess. */
75 const char *synch_process_death;
77 /* Nonzero => this is the signal number that terminated the subprocess. */
78 int synch_process_termsig;
80 /* If synch_process_death is zero,
81 this is exit code of synchronous subprocess. */
82 int synch_process_retcode;
85 /* Clean up when exiting Fcall_process.
86 On MSDOS, delete the temporary file on any kind of termination.
87 On Unix, kill the process and any children on termination by signal. */
89 /* True if this is termination due to exit. */
90 static bool call_process_exited;
92 static Lisp_Object
93 call_process_kill (Lisp_Object fdpid)
95 int fd;
96 pid_t pid;
97 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
98 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
99 emacs_close (fd);
100 EMACS_KILLPG (pid, SIGKILL);
101 synch_process_alive = 0;
102 return Qnil;
105 static Lisp_Object
106 call_process_cleanup (Lisp_Object arg)
108 Lisp_Object fdpid = Fcdr (arg);
109 int fd;
110 #if defined (MSDOS)
111 Lisp_Object file;
112 #else
113 pid_t pid;
114 #endif
116 Fset_buffer (Fcar (arg));
117 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
119 #if defined (MSDOS)
120 /* for MSDOS fdpid is really (fd . tempfile) */
121 file = Fcdr (fdpid);
122 /* FD is -1 and FILE is "" when we didn't actually create a
123 temporary file in call-process. */
124 if (fd >= 0)
125 emacs_close (fd);
126 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
127 unlink (SDATA (file));
128 #else /* not MSDOS */
129 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
131 if (call_process_exited)
133 emacs_close (fd);
134 return Qnil;
137 if (EMACS_KILLPG (pid, SIGINT) == 0)
139 ptrdiff_t count = SPECPDL_INDEX ();
140 record_unwind_protect (call_process_kill, fdpid);
141 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
142 immediate_quit = 1;
143 QUIT;
144 wait_for_termination (pid);
145 immediate_quit = 0;
146 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
147 message1 ("Waiting for process to die...done");
149 synch_process_alive = 0;
150 emacs_close (fd);
151 #endif /* not MSDOS */
152 return Qnil;
155 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
156 doc: /* Call PROGRAM synchronously in separate process.
157 The remaining arguments are optional.
158 The program's input comes from file INFILE (nil means `/dev/null').
159 Insert output in BUFFER before point; t means current buffer; nil for BUFFER
160 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
161 FILE is a file name string, means that it should be written to that file
162 \(if the file already exists it is overwritten).
163 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
164 REAL-BUFFER says what to do with standard output, as above,
165 while STDERR-FILE says what to do with standard error in the child.
166 STDERR-FILE may be nil (discard standard error output),
167 t (mix it with ordinary output), or a file name string.
169 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
170 Remaining arguments are strings passed as command arguments to PROGRAM.
172 If executable PROGRAM can't be found as an executable, `call-process'
173 signals a Lisp error. `call-process' reports errors in execution of
174 the program only through its return and output.
176 If BUFFER is 0, `call-process' returns immediately with value nil.
177 Otherwise it waits for PROGRAM to terminate
178 and returns a numeric exit status or a signal description string.
179 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
181 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
182 (ptrdiff_t nargs, Lisp_Object *args)
184 Lisp_Object infile, buffer, current_dir, path, cleanup_info_tail;
185 bool display_p;
186 int fd[2];
187 int filefd;
188 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
189 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
190 char buf[CALLPROC_BUFFER_SIZE_MAX];
191 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
192 ptrdiff_t count = SPECPDL_INDEX ();
193 USE_SAFE_ALLOCA;
195 register const unsigned char **new_argv;
196 /* File to use for stderr in the child.
197 t means use same as standard output. */
198 Lisp_Object error_file;
199 Lisp_Object output_file = Qnil;
200 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
201 char *outf, *tempfile = NULL;
202 int outfilefd;
203 int pid;
204 #else
205 pid_t pid;
206 #endif
207 int fd_output = -1;
208 struct coding_system process_coding; /* coding-system of process output */
209 struct coding_system argument_coding; /* coding-system of arguments */
210 /* Set to the return value of Ffind_operation_coding_system. */
211 Lisp_Object coding_systems;
212 bool output_to_buffer = 1;
214 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
215 coding_systems = Qt;
217 CHECK_STRING (args[0]);
219 error_file = Qt;
221 #ifndef subprocesses
222 /* Without asynchronous processes we cannot have BUFFER == 0. */
223 if (nargs >= 3
224 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
225 error ("Operating system cannot handle asynchronous subprocesses");
226 #endif /* subprocesses */
228 /* Decide the coding-system for giving arguments. */
230 Lisp_Object val, *args2;
231 ptrdiff_t i;
233 /* If arguments are supplied, we may have to encode them. */
234 if (nargs >= 5)
236 bool must_encode = 0;
237 Lisp_Object coding_attrs;
239 for (i = 4; i < nargs; i++)
240 CHECK_STRING (args[i]);
242 for (i = 4; i < nargs; i++)
243 if (STRING_MULTIBYTE (args[i]))
244 must_encode = 1;
246 if (!NILP (Vcoding_system_for_write))
247 val = Vcoding_system_for_write;
248 else if (! must_encode)
249 val = Qraw_text;
250 else
252 SAFE_NALLOCA (args2, 1, nargs + 1);
253 args2[0] = Qcall_process;
254 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
255 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
256 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
258 val = complement_process_encoding_system (val);
259 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
260 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
261 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
263 /* We should not use an ASCII incompatible coding system. */
264 val = raw_text_coding_system (val);
265 setup_coding_system (val, &argument_coding);
270 if (nargs >= 2 && ! NILP (args[1]))
272 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
273 CHECK_STRING (infile);
275 else
276 infile = build_string (NULL_DEVICE);
278 if (nargs >= 3)
280 buffer = args[2];
282 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
283 FILE-FOR-STDERR), unless the first element is :file, in which case see
284 the next paragraph. */
285 if (CONSP (buffer)
286 && (! SYMBOLP (XCAR (buffer))
287 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
289 if (CONSP (XCDR (buffer)))
291 Lisp_Object stderr_file;
292 stderr_file = XCAR (XCDR (buffer));
294 if (NILP (stderr_file) || EQ (Qt, stderr_file))
295 error_file = stderr_file;
296 else
297 error_file = Fexpand_file_name (stderr_file, Qnil);
300 buffer = XCAR (buffer);
303 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
304 if (CONSP (buffer)
305 && SYMBOLP (XCAR (buffer))
306 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
308 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
309 BVAR (current_buffer, directory));
310 CHECK_STRING (output_file);
311 buffer = Qnil;
314 if (!(EQ (buffer, Qnil)
315 || EQ (buffer, Qt)
316 || INTEGERP (buffer)))
318 Lisp_Object spec_buffer;
319 spec_buffer = buffer;
320 buffer = Fget_buffer_create (buffer);
321 /* Mention the buffer name for a better error message. */
322 if (NILP (buffer))
323 CHECK_BUFFER (spec_buffer);
324 CHECK_BUFFER (buffer);
327 else
328 buffer = Qnil;
330 /* Make sure that the child will be able to chdir to the current
331 buffer's current directory, or its unhandled equivalent. We
332 can't just have the child check for an error when it does the
333 chdir, since it's in a vfork.
335 We have to GCPRO around this because Fexpand_file_name,
336 Funhandled_file_name_directory, and Ffile_accessible_directory_p
337 might call a file name handling function. The argument list is
338 protected by the caller, so all we really have to worry about is
339 buffer. */
341 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
343 current_dir = BVAR (current_buffer, directory);
345 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
347 current_dir = Funhandled_file_name_directory (current_dir);
348 if (NILP (current_dir))
349 /* If the file name handler says that current_dir is unreachable, use
350 a sensible default. */
351 current_dir = build_string ("~/");
352 current_dir = expand_and_dir_to_file (current_dir, Qnil);
353 current_dir = Ffile_name_as_directory (current_dir);
355 if (NILP (Ffile_accessible_directory_p (current_dir)))
356 report_file_error ("Setting current directory",
357 Fcons (BVAR (current_buffer, directory), Qnil));
359 if (STRING_MULTIBYTE (infile))
360 infile = ENCODE_FILE (infile);
361 if (STRING_MULTIBYTE (current_dir))
362 current_dir = ENCODE_FILE (current_dir);
363 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
364 error_file = ENCODE_FILE (error_file);
365 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
366 output_file = ENCODE_FILE (output_file);
367 UNGCPRO;
370 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
372 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
373 if (filefd < 0)
375 infile = DECODE_FILE (infile);
376 report_file_error ("Opening process input file", Fcons (infile, Qnil));
379 if (STRINGP (output_file))
381 #ifdef DOS_NT
382 fd_output = emacs_open (SSDATA (output_file),
383 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
384 S_IREAD | S_IWRITE);
385 #else /* not DOS_NT */
386 fd_output = creat (SSDATA (output_file), 0666);
387 #endif /* not DOS_NT */
388 if (fd_output < 0)
390 output_file = DECODE_FILE (output_file);
391 report_file_error ("Opening process output file",
392 Fcons (output_file, Qnil));
394 if (STRINGP (error_file) || NILP (error_file))
395 output_to_buffer = 0;
398 /* Search for program; barf if not found. */
400 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
402 GCPRO4 (infile, buffer, current_dir, error_file);
403 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
404 UNGCPRO;
406 if (NILP (path))
408 emacs_close (filefd);
409 report_file_error ("Searching for program", Fcons (args[0], Qnil));
412 /* If program file name starts with /: for quoting a magic name,
413 discard that. */
414 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
415 && SREF (path, 1) == ':')
416 path = Fsubstring (path, make_number (2), Qnil);
418 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
419 if (nargs > 4)
421 ptrdiff_t i;
422 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
424 GCPRO5 (infile, buffer, current_dir, path, error_file);
425 argument_coding.dst_multibyte = 0;
426 for (i = 4; i < nargs; i++)
428 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
429 if (CODING_REQUIRE_ENCODING (&argument_coding))
430 /* We must encode this argument. */
431 args[i] = encode_coding_string (&argument_coding, args[i], 1);
433 UNGCPRO;
434 for (i = 4; i < nargs; i++)
435 new_argv[i - 3] = SDATA (args[i]);
436 new_argv[i - 3] = 0;
438 else
439 new_argv[1] = 0;
440 new_argv[0] = SDATA (path);
442 #ifdef MSDOS /* MW, July 1993 */
444 /* If we're redirecting STDOUT to a file, that file is already open
445 on fd_output. */
446 if (fd_output < 0)
448 if ((outf = egetenv ("TMPDIR")))
449 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
450 else
452 tempfile = alloca (20);
453 *tempfile = '\0';
455 dostounix_filename (tempfile);
456 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
457 strcat (tempfile, "/");
458 strcat (tempfile, "detmp.XXX");
459 mktemp (tempfile);
460 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
461 if (outfilefd < 0) {
462 emacs_close (filefd);
463 report_file_error ("Opening process output file",
464 Fcons (build_string (tempfile), Qnil));
467 else
468 outfilefd = fd_output;
469 fd[0] = filefd;
470 fd[1] = outfilefd;
471 #endif /* MSDOS */
473 if (INTEGERP (buffer))
474 fd[1] = emacs_open (NULL_DEVICE, O_WRONLY, 0), fd[0] = -1;
475 else
477 #ifndef MSDOS
478 errno = 0;
479 if (pipe (fd) == -1)
481 emacs_close (filefd);
482 report_file_error ("Creating process pipe", Qnil);
484 #endif
488 /* child_setup must clobber environ in systems with true vfork.
489 Protect it from permanent change. */
490 register char **save_environ = environ;
491 register int fd1 = fd[1];
492 int fd_error = fd1;
494 if (fd_output >= 0)
495 fd1 = fd_output;
497 /* Record that we're about to create a synchronous process. */
498 synch_process_alive = 1;
500 /* These vars record information from process termination.
501 Clear them now before process can possibly terminate,
502 to avoid timing error if process terminates soon. */
503 synch_process_death = 0;
504 synch_process_retcode = 0;
505 synch_process_termsig = 0;
507 if (NILP (error_file))
508 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
509 else if (STRINGP (error_file))
511 #ifdef DOS_NT
512 fd_error = emacs_open (SSDATA (error_file),
513 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
514 S_IREAD | S_IWRITE);
515 #else /* not DOS_NT */
516 fd_error = creat (SSDATA (error_file), 0666);
517 #endif /* not DOS_NT */
520 if (fd_error < 0)
522 emacs_close (filefd);
523 if (fd[0] != filefd)
524 emacs_close (fd[0]);
525 if (fd1 >= 0)
526 emacs_close (fd1);
527 #ifdef MSDOS
528 unlink (tempfile);
529 #endif
530 if (NILP (error_file))
531 error_file = build_string (NULL_DEVICE);
532 else if (STRINGP (error_file))
533 error_file = DECODE_FILE (error_file);
534 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
537 #ifdef MSDOS /* MW, July 1993 */
538 /* Note that on MSDOS `child_setup' actually returns the child process
539 exit status, not its PID, so we assign it to `synch_process_retcode'
540 below. */
541 pid = child_setup (filefd, outfilefd, fd_error, (char **) new_argv,
542 0, current_dir);
544 /* Record that the synchronous process exited and note its
545 termination status. */
546 synch_process_alive = 0;
547 synch_process_retcode = pid;
548 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
550 synchronize_system_messages_locale ();
551 synch_process_death = strerror (errno);
554 emacs_close (outfilefd);
555 if (fd_error != outfilefd)
556 emacs_close (fd_error);
557 fd1 = -1; /* No harm in closing that one! */
558 if (tempfile)
560 /* Since CRLF is converted to LF within `decode_coding', we
561 can always open a file with binary mode. */
562 fd[0] = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
563 if (fd[0] < 0)
565 unlink (tempfile);
566 emacs_close (filefd);
567 report_file_error ("Cannot re-open temporary file",
568 Fcons (build_string (tempfile), Qnil));
571 else
572 fd[0] = -1; /* We are not going to read from tempfile. */
573 #else /* not MSDOS */
574 #ifdef WINDOWSNT
575 pid = child_setup (filefd, fd1, fd_error, (char **) new_argv,
576 0, current_dir);
577 #else /* not WINDOWSNT */
579 block_input ();
581 /* vfork, and prevent local vars from being clobbered by the vfork. */
583 Lisp_Object volatile buffer_volatile = buffer;
584 Lisp_Object volatile coding_systems_volatile = coding_systems;
585 Lisp_Object volatile current_dir_volatile = current_dir;
586 bool volatile display_p_volatile = display_p;
587 bool volatile output_to_buffer_volatile = output_to_buffer;
588 bool volatile sa_must_free_volatile = sa_must_free;
589 int volatile fd1_volatile = fd1;
590 int volatile fd_error_volatile = fd_error;
591 int volatile fd_output_volatile = fd_output;
592 ptrdiff_t volatile sa_count_volatile = sa_count;
593 unsigned char const **volatile new_argv_volatile = new_argv;
595 pid = vfork ();
597 buffer = buffer_volatile;
598 coding_systems = coding_systems_volatile;
599 current_dir = current_dir_volatile;
600 display_p = display_p_volatile;
601 fd1 = fd1_volatile;
602 fd_error = fd_error_volatile;
603 fd_output = fd_output_volatile;
604 output_to_buffer = output_to_buffer_volatile;
605 sa_must_free = sa_must_free_volatile;
606 sa_count = sa_count_volatile;
607 new_argv = new_argv_volatile;
610 if (pid == 0)
612 if (fd[0] >= 0)
613 emacs_close (fd[0]);
615 #ifdef HAVE_SETSID
616 setsid ();
617 #else
618 setpgid (0, 0);
619 #endif
621 /* Emacs ignores SIGPIPE, but the child should not. */
622 signal (SIGPIPE, SIG_DFL);
624 child_setup (filefd, fd1, fd_error, (char **) new_argv,
625 0, current_dir);
628 unblock_input ();
630 #endif /* not WINDOWSNT */
632 /* The MSDOS case did this already. */
633 if (fd_error >= 0)
634 emacs_close (fd_error);
635 #endif /* not MSDOS */
637 environ = save_environ;
639 /* Close most of our fd's, but not fd[0]
640 since we will use that to read input from. */
641 emacs_close (filefd);
642 if (fd_output >= 0)
643 emacs_close (fd_output);
644 if (fd1 >= 0 && fd1 != fd_error)
645 emacs_close (fd1);
648 if (pid < 0)
650 if (fd[0] >= 0)
651 emacs_close (fd[0]);
652 report_file_error ("Doing vfork", Qnil);
655 if (INTEGERP (buffer))
657 if (fd[0] >= 0)
658 emacs_close (fd[0]);
659 return Qnil;
662 /* Enable sending signal if user quits below. */
663 call_process_exited = 0;
665 #if defined (MSDOS)
666 /* MSDOS needs different cleanup information. */
667 cleanup_info_tail = build_string (tempfile ? tempfile : "");
668 #else
669 cleanup_info_tail = INTEGER_TO_CONS (pid);
670 #endif /* not MSDOS */
671 record_unwind_protect (call_process_cleanup,
672 Fcons (Fcurrent_buffer (),
673 Fcons (INTEGER_TO_CONS (fd[0]),
674 cleanup_info_tail)));
676 if (BUFFERP (buffer))
677 Fset_buffer (buffer);
679 if (NILP (buffer))
681 /* If BUFFER is nil, we must read process output once and then
682 discard it, so setup coding system but with nil. */
683 setup_coding_system (Qnil, &process_coding);
684 process_coding.dst_multibyte = 0;
686 else
688 Lisp_Object val, *args2;
690 val = Qnil;
691 if (!NILP (Vcoding_system_for_read))
692 val = Vcoding_system_for_read;
693 else
695 if (EQ (coding_systems, Qt))
697 ptrdiff_t i;
699 SAFE_NALLOCA (args2, 1, nargs + 1);
700 args2[0] = Qcall_process;
701 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
702 coding_systems
703 = Ffind_operation_coding_system (nargs + 1, args2);
705 if (CONSP (coding_systems))
706 val = XCAR (coding_systems);
707 else if (CONSP (Vdefault_process_coding_system))
708 val = XCAR (Vdefault_process_coding_system);
709 else
710 val = Qnil;
712 Fcheck_coding_system (val);
713 /* In unibyte mode, character code conversion should not take
714 place but EOL conversion should. So, setup raw-text or one
715 of the subsidiary according to the information just setup. */
716 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
717 && !NILP (val))
718 val = raw_text_coding_system (val);
719 setup_coding_system (val, &process_coding);
720 process_coding.dst_multibyte
721 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
723 process_coding.src_multibyte = 0;
725 immediate_quit = 1;
726 QUIT;
728 if (output_to_buffer)
730 int nread;
731 bool first = 1;
732 EMACS_INT total_read = 0;
733 int carryover = 0;
734 bool display_on_the_fly = display_p;
735 struct coding_system saved_coding;
737 saved_coding = process_coding;
738 while (1)
740 /* Repeatedly read until we've filled as much as possible
741 of the buffer size we have. But don't read
742 less than 1024--save that for the next bufferful. */
743 nread = carryover;
744 while (nread < bufsize - 1024)
746 int this_read = emacs_read (fd[0], buf + nread,
747 bufsize - nread);
749 if (this_read < 0)
750 goto give_up;
752 if (this_read == 0)
754 process_coding.mode |= CODING_MODE_LAST_BLOCK;
755 break;
758 nread += this_read;
759 total_read += this_read;
761 if (display_on_the_fly)
762 break;
765 /* Now NREAD is the total amount of data in the buffer. */
766 immediate_quit = 0;
768 if (!NILP (buffer))
770 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
771 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
772 insert_1_both (buf, nread, nread, 0, 1, 0);
773 else
774 { /* We have to decode the input. */
775 Lisp_Object curbuf;
776 ptrdiff_t count1 = SPECPDL_INDEX ();
778 XSETBUFFER (curbuf, current_buffer);
779 /* We cannot allow after-change-functions be run
780 during decoding, because that might modify the
781 buffer, while we rely on process_coding.produced to
782 faithfully reflect inserted text until we
783 TEMP_SET_PT_BOTH below. */
784 specbind (Qinhibit_modification_hooks, Qt);
785 decode_coding_c_string (&process_coding,
786 (unsigned char *) buf, nread, curbuf);
787 unbind_to (count1, Qnil);
788 if (display_on_the_fly
789 && CODING_REQUIRE_DETECTION (&saved_coding)
790 && ! CODING_REQUIRE_DETECTION (&process_coding))
792 /* We have detected some coding system. But,
793 there's a possibility that the detection was
794 done by insufficient data. So, we give up
795 displaying on the fly. */
796 if (process_coding.produced > 0)
797 del_range_2 (process_coding.dst_pos,
798 process_coding.dst_pos_byte,
799 process_coding.dst_pos
800 + process_coding.produced_char,
801 process_coding.dst_pos_byte
802 + process_coding.produced, 0);
803 display_on_the_fly = 0;
804 process_coding = saved_coding;
805 carryover = nread;
806 /* This is to make the above condition always
807 fails in the future. */
808 saved_coding.common_flags
809 &= ~CODING_REQUIRE_DETECTION_MASK;
810 continue;
813 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
814 PT_BYTE + process_coding.produced);
815 carryover = process_coding.carryover_bytes;
816 if (carryover > 0)
817 memcpy (buf, process_coding.carryover,
818 process_coding.carryover_bytes);
822 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
823 break;
825 /* Make the buffer bigger as we continue to read more data,
826 but not past CALLPROC_BUFFER_SIZE_MAX. */
827 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
828 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
829 bufsize = CALLPROC_BUFFER_SIZE_MAX;
831 if (display_p)
833 if (first)
834 prepare_menu_bars ();
835 first = 0;
836 redisplay_preserve_echo_area (1);
837 /* This variable might have been set to 0 for code
838 detection. In that case, we set it back to 1 because
839 we should have already detected a coding system. */
840 display_on_the_fly = 1;
842 immediate_quit = 1;
843 QUIT;
845 give_up: ;
847 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
848 /* If the caller required, let the buffer inherit the
849 coding-system used to decode the process output. */
850 if (inherit_process_coding_system)
851 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
852 make_number (total_read));
855 #ifndef MSDOS
856 /* Wait for it to terminate, unless it already has. */
857 if (output_to_buffer)
858 wait_for_termination (pid);
859 else
860 interruptible_wait_for_termination (pid);
861 #endif
863 immediate_quit = 0;
865 /* Don't kill any children that the subprocess may have left behind
866 when exiting. */
867 call_process_exited = 1;
869 SAFE_FREE ();
870 unbind_to (count, Qnil);
872 if (synch_process_termsig)
874 const char *signame;
876 synchronize_system_messages_locale ();
877 signame = strsignal (synch_process_termsig);
879 if (signame == 0)
880 signame = "unknown";
882 synch_process_death = signame;
885 if (synch_process_death)
886 return code_convert_string_norecord (build_string (synch_process_death),
887 Vlocale_coding_system, 0);
888 return make_number (synch_process_retcode);
891 static Lisp_Object
892 delete_temp_file (Lisp_Object name)
894 /* Suppress jka-compr handling, etc. */
895 ptrdiff_t count = SPECPDL_INDEX ();
896 specbind (intern ("file-name-handler-alist"), Qnil);
897 internal_delete_file (name);
898 unbind_to (count, Qnil);
899 return Qnil;
902 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
903 3, MANY, 0,
904 doc: /* Send text from START to END to a synchronous process running PROGRAM.
905 The remaining arguments are optional.
906 Delete the text if fourth arg DELETE is non-nil.
908 Insert output in BUFFER before point; t means current buffer; nil for
909 BUFFER means discard it; 0 means discard and don't wait; and `(:file
910 FILE)', where FILE is a file name string, means that it should be
911 written to that file (if the file already exists it is overwritten).
912 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
913 REAL-BUFFER says what to do with standard output, as above,
914 while STDERR-FILE says what to do with standard error in the child.
915 STDERR-FILE may be nil (discard standard error output),
916 t (mix it with ordinary output), or a file name string.
918 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
919 Remaining args are passed to PROGRAM at startup as command args.
921 If BUFFER is 0, `call-process-region' returns immediately with value nil.
922 Otherwise it waits for PROGRAM to terminate
923 and returns a numeric exit status or a signal description string.
924 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
926 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
927 (ptrdiff_t nargs, Lisp_Object *args)
929 struct gcpro gcpro1;
930 Lisp_Object filename_string;
931 register Lisp_Object start, end;
932 ptrdiff_t count = SPECPDL_INDEX ();
933 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
934 Lisp_Object coding_systems;
935 Lisp_Object val, *args2;
936 ptrdiff_t i;
937 Lisp_Object tmpdir;
939 if (STRINGP (Vtemporary_file_directory))
940 tmpdir = Vtemporary_file_directory;
941 else
943 #ifndef DOS_NT
944 if (getenv ("TMPDIR"))
945 tmpdir = build_string (getenv ("TMPDIR"));
946 else
947 tmpdir = build_string ("/tmp/");
948 #else /* DOS_NT */
949 char *outf;
950 if ((outf = egetenv ("TMPDIR"))
951 || (outf = egetenv ("TMP"))
952 || (outf = egetenv ("TEMP")))
953 tmpdir = build_string (outf);
954 else
955 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
956 #endif
960 USE_SAFE_ALLOCA;
961 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
962 Lisp_Object encoded_tem = ENCODE_FILE (pattern);
963 char *tempfile = SAFE_ALLOCA (SBYTES (encoded_tem) + 1);
964 memcpy (tempfile, SDATA (encoded_tem), SBYTES (encoded_tem) + 1);
965 coding_systems = Qt;
967 #ifdef HAVE_MKSTEMP
969 int fd;
971 block_input ();
972 fd = mkstemp (tempfile);
973 unblock_input ();
974 if (fd == -1)
975 report_file_error ("Failed to open temporary file",
976 Fcons (build_string (tempfile), Qnil));
977 else
978 close (fd);
980 #else
981 errno = 0;
982 mktemp (tempfile);
983 if (!*tempfile)
985 if (!errno)
986 errno = EEXIST;
987 report_file_error ("Failed to open temporary file using pattern",
988 Fcons (pattern, Qnil));
990 #endif
992 filename_string = build_string (tempfile);
993 GCPRO1 (filename_string);
994 SAFE_FREE ();
997 start = args[0];
998 end = args[1];
999 /* Decide coding-system of the contents of the temporary file. */
1000 if (!NILP (Vcoding_system_for_write))
1001 val = Vcoding_system_for_write;
1002 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1003 val = Qraw_text;
1004 else
1006 USE_SAFE_ALLOCA;
1007 SAFE_NALLOCA (args2, 1, nargs + 1);
1008 args2[0] = Qcall_process_region;
1009 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1010 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1011 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1012 SAFE_FREE ();
1014 val = complement_process_encoding_system (val);
1017 ptrdiff_t count1 = SPECPDL_INDEX ();
1019 specbind (intern ("coding-system-for-write"), val);
1020 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1021 happen to get a ".Z" suffix. */
1022 specbind (intern ("file-name-handler-alist"), Qnil);
1023 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1025 unbind_to (count1, Qnil);
1028 /* Note that Fcall_process takes care of binding
1029 coding-system-for-read. */
1031 record_unwind_protect (delete_temp_file, filename_string);
1033 if (nargs > 3 && !NILP (args[3]))
1034 Fdelete_region (start, end);
1036 if (nargs > 3)
1038 args += 2;
1039 nargs -= 2;
1041 else
1043 args[0] = args[2];
1044 nargs = 2;
1046 args[1] = filename_string;
1048 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1051 #ifndef WINDOWSNT
1052 static int relocate_fd (int fd, int minfd);
1053 #endif
1055 static char **
1056 add_env (char **env, char **new_env, char *string)
1058 char **ep;
1059 bool ok = 1;
1060 if (string == NULL)
1061 return new_env;
1063 /* See if this string duplicates any string already in the env.
1064 If so, don't put it in.
1065 When an env var has multiple definitions,
1066 we keep the definition that comes first in process-environment. */
1067 for (ep = env; ok && ep != new_env; ep++)
1069 char *p = *ep, *q = string;
1070 while (ok)
1072 if (*q != *p)
1073 break;
1074 if (*q == 0)
1075 /* The string is a lone variable name; keep it for now, we
1076 will remove it later. It is a placeholder for a
1077 variable that is not to be included in the environment. */
1078 break;
1079 if (*q == '=')
1080 ok = 0;
1081 p++, q++;
1084 if (ok)
1085 *new_env++ = string;
1086 return new_env;
1089 /* This is the last thing run in a newly forked inferior
1090 either synchronous or asynchronous.
1091 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1092 Initialize inferior's priority, pgrp, connected dir and environment.
1093 then exec another program based on new_argv.
1095 This function may change environ for the superior process.
1096 Therefore, the superior process must save and restore the value
1097 of environ around the vfork and the call to this function.
1099 If SET_PGRP, put the subprocess into a separate process group.
1101 CURRENT_DIR is an elisp string giving the path of the current
1102 directory the subprocess should have. Since we can't really signal
1103 a decent error from within the child, this should be verified as an
1104 executable directory by the parent. */
1107 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1108 Lisp_Object current_dir)
1110 char **env;
1111 char *pwd_var;
1112 #ifdef WINDOWSNT
1113 int cpid;
1114 HANDLE handles[3];
1115 #endif /* WINDOWSNT */
1117 pid_t pid = getpid ();
1119 /* Close Emacs's descriptors that this process should not have. */
1120 close_process_descs ();
1122 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1123 we will lose if we call close_load_descs here. */
1124 #ifndef DOS_NT
1125 close_load_descs ();
1126 #endif
1128 /* Note that use of alloca is always safe here. It's obvious for systems
1129 that do not have true vfork or that have true (stack) alloca.
1130 If using vfork and C_ALLOCA (when Emacs used to include
1131 src/alloca.c) it is safe because that changes the superior's
1132 static variables as if the superior had done alloca and will be
1133 cleaned up in the usual way. */
1135 register char *temp;
1136 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1138 i = SBYTES (current_dir);
1139 #ifdef MSDOS
1140 /* MSDOS must have all environment variables malloc'ed, because
1141 low-level libc functions that launch subsidiary processes rely
1142 on that. */
1143 pwd_var = xmalloc (i + 6);
1144 #else
1145 pwd_var = alloca (i + 6);
1146 #endif
1147 temp = pwd_var + 4;
1148 memcpy (pwd_var, "PWD=", 4);
1149 memcpy (temp, SDATA (current_dir), i);
1150 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1151 temp[i] = 0;
1153 #ifndef DOS_NT
1154 /* We can't signal an Elisp error here; we're in a vfork. Since
1155 the callers check the current directory before forking, this
1156 should only return an error if the directory's permissions
1157 are changed between the check and this chdir, but we should
1158 at least check. */
1159 if (chdir (temp) < 0)
1160 _exit (errno);
1161 #else /* DOS_NT */
1162 /* Get past the drive letter, so that d:/ is left alone. */
1163 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1165 temp += 2;
1166 i -= 2;
1168 #endif /* DOS_NT */
1170 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1171 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1172 temp[--i] = 0;
1175 /* Set `env' to a vector of the strings in the environment. */
1177 register Lisp_Object tem;
1178 register char **new_env;
1179 char **p, **q;
1180 register int new_length;
1181 Lisp_Object display = Qnil;
1183 new_length = 0;
1185 for (tem = Vprocess_environment;
1186 CONSP (tem) && STRINGP (XCAR (tem));
1187 tem = XCDR (tem))
1189 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1190 && (SDATA (XCAR (tem)) [7] == '\0'
1191 || SDATA (XCAR (tem)) [7] == '='))
1192 /* DISPLAY is specified in process-environment. */
1193 display = Qt;
1194 new_length++;
1197 /* If not provided yet, use the frame's DISPLAY. */
1198 if (NILP (display))
1200 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1201 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1202 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1203 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1204 Vinitial_environment);
1205 if (STRINGP (tmp))
1207 display = tmp;
1208 new_length++;
1212 /* new_length + 2 to include PWD and terminating 0. */
1213 env = new_env = alloca ((new_length + 2) * sizeof *env);
1214 /* If we have a PWD envvar, pass one down,
1215 but with corrected value. */
1216 if (egetenv ("PWD"))
1217 *new_env++ = pwd_var;
1219 if (STRINGP (display))
1221 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1222 strcpy (vdata, "DISPLAY=");
1223 strcat (vdata, SSDATA (display));
1224 new_env = add_env (env, new_env, vdata);
1227 /* Overrides. */
1228 for (tem = Vprocess_environment;
1229 CONSP (tem) && STRINGP (XCAR (tem));
1230 tem = XCDR (tem))
1231 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1233 *new_env = 0;
1235 /* Remove variable names without values. */
1236 p = q = env;
1237 while (*p != 0)
1239 while (*q != 0 && strchr (*q, '=') == NULL)
1240 q++;
1241 *p = *q++;
1242 if (*p != 0)
1243 p++;
1248 #ifdef WINDOWSNT
1249 prepare_standard_handles (in, out, err, handles);
1250 set_process_dir (SDATA (current_dir));
1251 /* Spawn the child. (See ntproc.c:Spawnve). */
1252 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1253 reset_standard_handles (in, out, err, handles);
1254 if (cpid == -1)
1255 /* An error occurred while trying to spawn the process. */
1256 report_file_error ("Spawning child process", Qnil);
1257 return cpid;
1259 #else /* not WINDOWSNT */
1260 /* Make sure that in, out, and err are not actually already in
1261 descriptors zero, one, or two; this could happen if Emacs is
1262 started with its standard in, out, or error closed, as might
1263 happen under X. */
1265 int oin = in, oout = out;
1267 /* We have to avoid relocating the same descriptor twice! */
1269 in = relocate_fd (in, 3);
1271 if (out == oin)
1272 out = in;
1273 else
1274 out = relocate_fd (out, 3);
1276 if (err == oin)
1277 err = in;
1278 else if (err == oout)
1279 err = out;
1280 else
1281 err = relocate_fd (err, 3);
1284 #ifndef MSDOS
1285 emacs_close (0);
1286 emacs_close (1);
1287 emacs_close (2);
1289 dup2 (in, 0);
1290 dup2 (out, 1);
1291 dup2 (err, 2);
1292 emacs_close (in);
1293 if (out != in)
1294 emacs_close (out);
1295 if (err != in && err != out)
1296 emacs_close (err);
1298 #if defined HAVE_SETPGID || ! (defined USG && defined SETPGRP_RELEASES_CTTY)
1299 setpgid (pid, pid);
1300 #endif
1302 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1303 tcsetpgrp (0, pid);
1305 /* execvp does not accept an environment arg so the only way
1306 to pass this environment is to set environ. Our caller
1307 is responsible for restoring the ambient value of environ. */
1308 environ = env;
1309 execvp (new_argv[0], new_argv);
1311 emacs_write (1, "Can't exec program: ", 20);
1312 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1313 emacs_write (1, "\n", 1);
1314 _exit (1);
1316 #else /* MSDOS */
1317 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1318 xfree (pwd_var);
1319 if (pid == -1)
1320 /* An error occurred while trying to run the subprocess. */
1321 report_file_error ("Spawning child process", Qnil);
1322 return pid;
1323 #endif /* MSDOS */
1324 #endif /* not WINDOWSNT */
1327 #ifndef WINDOWSNT
1328 /* Move the file descriptor FD so that its number is not less than MINFD.
1329 If the file descriptor is moved at all, the original is freed. */
1330 static int
1331 relocate_fd (int fd, int minfd)
1333 if (fd >= minfd)
1334 return fd;
1335 else
1337 int new;
1338 #ifdef F_DUPFD
1339 new = fcntl (fd, F_DUPFD, minfd);
1340 #else
1341 new = dup (fd);
1342 if (new != -1)
1343 /* Note that we hold the original FD open while we recurse,
1344 to guarantee we'll get a new FD if we need it. */
1345 new = relocate_fd (new, minfd);
1346 #endif
1347 if (new == -1)
1349 const char *message_1 = "Error while setting up child: ";
1350 const char *errmessage = strerror (errno);
1351 const char *message_2 = "\n";
1352 emacs_write (2, message_1, strlen (message_1));
1353 emacs_write (2, errmessage, strlen (errmessage));
1354 emacs_write (2, message_2, strlen (message_2));
1355 _exit (1);
1357 emacs_close (fd);
1358 return new;
1361 #endif /* not WINDOWSNT */
1363 static bool
1364 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1365 ptrdiff_t *valuelen, Lisp_Object env)
1367 for (; CONSP (env); env = XCDR (env))
1369 Lisp_Object entry = XCAR (env);
1370 if (STRINGP (entry)
1371 && SBYTES (entry) >= varlen
1372 #ifdef WINDOWSNT
1373 /* NT environment variables are case insensitive. */
1374 && ! strnicmp (SDATA (entry), var, varlen)
1375 #else /* not WINDOWSNT */
1376 && ! memcmp (SDATA (entry), var, varlen)
1377 #endif /* not WINDOWSNT */
1380 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1382 *value = SSDATA (entry) + (varlen + 1);
1383 *valuelen = SBYTES (entry) - (varlen + 1);
1384 return 1;
1386 else if (SBYTES (entry) == varlen)
1388 /* Lone variable names in Vprocess_environment mean that
1389 variable should be removed from the environment. */
1390 *value = NULL;
1391 return 1;
1395 return 0;
1398 static bool
1399 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1400 ptrdiff_t *valuelen, Lisp_Object frame)
1402 /* Try to find VAR in Vprocess_environment first. */
1403 if (getenv_internal_1 (var, varlen, value, valuelen,
1404 Vprocess_environment))
1405 return *value ? 1 : 0;
1407 /* For DISPLAY try to get the values from the frame or the initial env. */
1408 if (strcmp (var, "DISPLAY") == 0)
1410 Lisp_Object display
1411 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1412 if (STRINGP (display))
1414 *value = SSDATA (display);
1415 *valuelen = SBYTES (display);
1416 return 1;
1418 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1419 if (getenv_internal_1 (var, varlen, value, valuelen,
1420 Vinitial_environment))
1421 return *value ? 1 : 0;
1424 return 0;
1427 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1428 doc: /* Get the value of environment variable VARIABLE.
1429 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1430 the environment. Otherwise, value is a string.
1432 This function searches `process-environment' for VARIABLE.
1434 If optional parameter ENV is a list, then search this list instead of
1435 `process-environment', and return t when encountering a negative entry
1436 \(an entry for a variable with no value). */)
1437 (Lisp_Object variable, Lisp_Object env)
1439 char *value;
1440 ptrdiff_t valuelen;
1442 CHECK_STRING (variable);
1443 if (CONSP (env))
1445 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1446 &value, &valuelen, env))
1447 return value ? make_string (value, valuelen) : Qt;
1448 else
1449 return Qnil;
1451 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1452 &value, &valuelen, env))
1453 return make_string (value, valuelen);
1454 else
1455 return Qnil;
1458 /* A version of getenv that consults the Lisp environment lists,
1459 easily callable from C. */
1460 char *
1461 egetenv (const char *var)
1463 char *value;
1464 ptrdiff_t valuelen;
1466 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1467 return value;
1468 else
1469 return 0;
1473 /* This is run before init_cmdargs. */
1475 void
1476 init_callproc_1 (void)
1478 #ifdef HAVE_NS
1479 const char *etc_dir = ns_etc_directory ();
1480 const char *path_exec = ns_exec_path ();
1481 #endif
1483 Vdata_directory = decode_env_path ("EMACSDATA",
1484 #ifdef HAVE_NS
1485 etc_dir ? etc_dir :
1486 #endif
1487 PATH_DATA);
1488 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1490 Vdoc_directory = decode_env_path ("EMACSDOC",
1491 #ifdef HAVE_NS
1492 etc_dir ? etc_dir :
1493 #endif
1494 PATH_DOC);
1495 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1497 /* Check the EMACSPATH environment variable, defaulting to the
1498 PATH_EXEC path from epaths.h. */
1499 Vexec_path = decode_env_path ("EMACSPATH",
1500 #ifdef HAVE_NS
1501 path_exec ? path_exec :
1502 #endif
1503 PATH_EXEC);
1504 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1505 /* FIXME? For ns, path_exec should go at the front? */
1506 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1509 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1511 void
1512 init_callproc (void)
1514 char *data_dir = egetenv ("EMACSDATA");
1516 register char * sh;
1517 Lisp_Object tempdir;
1518 #ifdef HAVE_NS
1519 if (data_dir == 0)
1521 const char *etc_dir = ns_etc_directory ();
1522 if (etc_dir)
1524 data_dir = alloca (strlen (etc_dir) + 1);
1525 strcpy (data_dir, etc_dir);
1528 #endif
1530 if (!NILP (Vinstallation_directory))
1532 /* Add to the path the lib-src subdir of the installation dir. */
1533 Lisp_Object tem;
1534 tem = Fexpand_file_name (build_string ("lib-src"),
1535 Vinstallation_directory);
1536 #ifndef MSDOS
1537 /* MSDOS uses wrapped binaries, so don't do this. */
1538 if (NILP (Fmember (tem, Vexec_path)))
1540 #ifdef HAVE_NS
1541 const char *path_exec = ns_exec_path ();
1542 #endif
1543 Vexec_path = decode_env_path ("EMACSPATH",
1544 #ifdef HAVE_NS
1545 path_exec ? path_exec :
1546 #endif
1547 PATH_EXEC);
1548 Vexec_path = Fcons (tem, Vexec_path);
1549 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1552 Vexec_directory = Ffile_name_as_directory (tem);
1553 #endif /* not MSDOS */
1555 /* Maybe use ../etc as well as ../lib-src. */
1556 if (data_dir == 0)
1558 tem = Fexpand_file_name (build_string ("etc"),
1559 Vinstallation_directory);
1560 Vdoc_directory = Ffile_name_as_directory (tem);
1564 /* Look for the files that should be in etc. We don't use
1565 Vinstallation_directory, because these files are never installed
1566 near the executable, and they are never in the build
1567 directory when that's different from the source directory.
1569 Instead, if these files are not in the nominal place, we try the
1570 source directory. */
1571 if (data_dir == 0)
1573 Lisp_Object tem, tem1, srcdir;
1575 srcdir = Fexpand_file_name (build_string ("../src/"),
1576 build_string (PATH_DUMPLOADSEARCH));
1577 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1578 tem1 = Ffile_exists_p (tem);
1579 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1581 Lisp_Object newdir;
1582 newdir = Fexpand_file_name (build_string ("../etc/"),
1583 build_string (PATH_DUMPLOADSEARCH));
1584 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1585 tem1 = Ffile_exists_p (tem);
1586 if (!NILP (tem1))
1587 Vdata_directory = newdir;
1591 #ifndef CANNOT_DUMP
1592 if (initialized)
1593 #endif
1595 tempdir = Fdirectory_file_name (Vexec_directory);
1596 if (access (SSDATA (tempdir), 0) < 0)
1597 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1598 Vexec_directory);
1601 tempdir = Fdirectory_file_name (Vdata_directory);
1602 if (access (SSDATA (tempdir), 0) < 0)
1603 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1604 Vdata_directory);
1606 sh = (char *) getenv ("SHELL");
1607 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1609 #ifdef DOS_NT
1610 Vshared_game_score_directory = Qnil;
1611 #else
1612 Vshared_game_score_directory = build_string (PATH_GAME);
1613 if (NILP (Ffile_directory_p (Vshared_game_score_directory)))
1614 Vshared_game_score_directory = Qnil;
1615 #endif
1618 void
1619 set_initial_environment (void)
1621 char **envp;
1622 for (envp = environ; *envp; envp++)
1623 Vprocess_environment = Fcons (build_string (*envp),
1624 Vprocess_environment);
1625 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1626 to use `delete' and friends on process-environment. */
1627 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1630 void
1631 syms_of_callproc (void)
1633 #ifndef DOS_NT
1634 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1635 #elif defined (WINDOWSNT)
1636 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1637 #else
1638 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1639 #endif
1640 staticpro (&Vtemp_file_name_pattern);
1642 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1643 doc: /* File name to load inferior shells from.
1644 Initialized from the SHELL environment variable, or to a system-dependent
1645 default if SHELL is not set. */);
1647 DEFVAR_LISP ("exec-path", Vexec_path,
1648 doc: /* List of directories to search programs to run in subprocesses.
1649 Each element is a string (directory name) or nil (try default directory). */);
1651 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1652 doc: /* List of suffixes to try to find executable file names.
1653 Each element is a string. */);
1654 Vexec_suffixes = Qnil;
1656 DEFVAR_LISP ("exec-directory", Vexec_directory,
1657 doc: /* Directory for executables for Emacs to invoke.
1658 More generally, this includes any architecture-dependent files
1659 that are built and installed from the Emacs distribution. */);
1661 DEFVAR_LISP ("data-directory", Vdata_directory,
1662 doc: /* Directory of machine-independent files that come with GNU Emacs.
1663 These are files intended for Emacs to use while it runs. */);
1665 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1666 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1667 This is usually the same as `data-directory'. */);
1669 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1670 doc: /* For internal use by the build procedure only.
1671 This is the name of the directory in which the build procedure installed
1672 Emacs's info files; the default value for `Info-default-directory-list'
1673 includes this. */);
1674 Vconfigure_info_directory = build_string (PATH_INFO);
1676 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1677 doc: /* Directory of score files for games which come with GNU Emacs.
1678 If this variable is nil, then Emacs is unable to use a shared directory. */);
1679 #ifdef DOS_NT
1680 Vshared_game_score_directory = Qnil;
1681 #else
1682 Vshared_game_score_directory = build_string (PATH_GAME);
1683 #endif
1685 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1686 doc: /* List of environment variables inherited from the parent process.
1687 Each element should be a string of the form ENVVARNAME=VALUE.
1688 The elements must normally be decoded (using `locale-coding-system') for use. */);
1689 Vinitial_environment = Qnil;
1691 DEFVAR_LISP ("process-environment", Vprocess_environment,
1692 doc: /* List of overridden environment variables for subprocesses to inherit.
1693 Each element should be a string of the form ENVVARNAME=VALUE.
1695 Entries in this list take precedence to those in the frame-local
1696 environments. Therefore, let-binding `process-environment' is an easy
1697 way to temporarily change the value of an environment variable,
1698 irrespective of where it comes from. To use `process-environment' to
1699 remove an environment variable, include only its name in the list,
1700 without "=VALUE".
1702 This variable is set to nil when Emacs starts.
1704 If multiple entries define the same variable, the first one always
1705 takes precedence.
1707 Non-ASCII characters are encoded according to the initial value of
1708 `locale-coding-system', i.e. the elements must normally be decoded for
1709 use.
1711 See `setenv' and `getenv'. */);
1712 Vprocess_environment = Qnil;
1714 defsubr (&Scall_process);
1715 defsubr (&Sgetenv_internal);
1716 defsubr (&Scall_process_region);