]> code.delx.au - gnu-emacs/blob - src/callproc.c
Merge from origin/emacs-25
[gnu-emacs] / src / callproc.c
1 /* Synchronous subprocess invocation for GNU Emacs.
2
3 Copyright (C) 1985-1988, 1993-1995, 1999-2016 Free Software Foundation,
4 Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20
21
22 #include <config.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <sys/types.h>
26 #include <unistd.h>
27
28 #include <sys/file.h>
29 #include <fcntl.h>
30
31 #include "lisp.h"
32
33 #ifdef WINDOWSNT
34 #define NOMINMAX
35 #include <sys/socket.h> /* for fcntl */
36 #include <windows.h>
37 #include "w32.h"
38 #define _P_NOWAIT 1 /* from process.h */
39 #endif
40
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/stat.h>
43 #include <sys/param.h>
44 #endif /* MSDOS */
45
46 #include "commands.h"
47 #include "buffer.h"
48 #include "coding.h"
49 #include <epaths.h>
50 #include "process.h"
51 #include "syssignal.h"
52 #include "syswait.h"
53 #include "blockinput.h"
54 #include "frame.h"
55
56 #ifdef MSDOS
57 #include "msdos.h"
58 #endif
59
60 #ifdef HAVE_NS
61 #include "nsterm.h"
62 #endif
63
64 /* Pattern used by call-process-region to make temp files. */
65 static Lisp_Object Vtemp_file_name_pattern;
66
67 /* The next two variables are used while record-unwind-protect is in place
68 during call-process for a subprocess for which record_deleted_pid has
69 not yet been called. At other times, synch_process_pid is zero and
70 synch_process_tempfile's contents are irrelevant. Doing this via static
71 C variables is more convenient than putting them into the arguments
72 of record-unwind-protect, as they need to be updated at randomish
73 times in the code, and Lisp cannot always store these values as
74 Emacs integers. It's safe to use static variables here, as the
75 code is never invoked reentrantly. */
76
77 /* If nonzero, a process-ID that has not been reaped. */
78 static pid_t synch_process_pid;
79
80 /* If a string, the name of a temp file that has not been removed. */
81 #ifdef MSDOS
82 static Lisp_Object synch_process_tempfile;
83 #else
84 # define synch_process_tempfile make_number (0)
85 #endif
86
87 /* Indexes of file descriptors that need closing on call_process_kill. */
88 enum
89 {
90 /* The subsidiary process's stdout and stderr. stdin is handled
91 separately, in either Fcall_process_region or create_temp_file. */
92 CALLPROC_STDOUT, CALLPROC_STDERR,
93
94 /* How to read from a pipe (or substitute) from the subsidiary process. */
95 CALLPROC_PIPEREAD,
96
97 /* A bound on the number of file descriptors. */
98 CALLPROC_FDS
99 };
100
101 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
102 \f
103 /* Return the current buffer's working directory, or the home
104 directory if it's unreachable, as a string suitable for a system call.
105 Signal an error if the result would not be an accessible directory. */
106
107 Lisp_Object
108 encode_current_directory (void)
109 {
110 Lisp_Object dir;
111
112 dir = BVAR (current_buffer, directory);
113
114 dir = Funhandled_file_name_directory (dir);
115
116 /* If the file name handler says that dir is unreachable, use
117 a sensible default. */
118 if (NILP (dir))
119 dir = build_string ("~");
120
121 dir = expand_and_dir_to_file (dir, Qnil);
122
123 if (NILP (Ffile_accessible_directory_p (dir)))
124 report_file_error ("Setting current directory",
125 BVAR (current_buffer, directory));
126
127 /* Remove "/:" from DIR and encode it. */
128 dir = ENCODE_FILE (remove_slash_colon (dir));
129
130 if (! file_accessible_directory_p (dir))
131 report_file_error ("Setting current directory",
132 BVAR (current_buffer, directory));
133
134 return dir;
135 }
136
137 /* If P is reapable, record it as a deleted process and kill it.
138 Do this in a critical section. Unless PID is wedged it will be
139 reaped on receipt of the first SIGCHLD after the critical section. */
140
141 void
142 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
143 {
144 #ifndef MSDOS
145 sigset_t oldset;
146 block_child_signal (&oldset);
147
148 if (p->alive)
149 {
150 record_deleted_pid (p->pid, tempfile);
151 p->alive = 0;
152 kill (- p->pid, SIGKILL);
153 }
154
155 unblock_child_signal (&oldset);
156 #endif /* !MSDOS */
157 }
158
159 /* Clean up files, file descriptors and processes created by Fcall_process. */
160
161 static void
162 delete_temp_file (Lisp_Object name)
163 {
164 unlink (SSDATA (name));
165 }
166
167 static void
168 call_process_kill (void *ptr)
169 {
170 int *callproc_fd = ptr;
171 int i;
172 for (i = 0; i < CALLPROC_FDS; i++)
173 if (0 <= callproc_fd[i])
174 emacs_close (callproc_fd[i]);
175
176 if (synch_process_pid)
177 {
178 struct Lisp_Process proc;
179 proc.alive = 1;
180 proc.pid = synch_process_pid;
181 record_kill_process (&proc, synch_process_tempfile);
182 synch_process_pid = 0;
183 }
184 else if (STRINGP (synch_process_tempfile))
185 delete_temp_file (synch_process_tempfile);
186 }
187
188 /* Clean up when exiting Fcall_process: restore the buffer, and
189 kill the subsidiary process group if the process still exists. */
190
191 static void
192 call_process_cleanup (Lisp_Object buffer)
193 {
194 Fset_buffer (buffer);
195
196 #ifndef MSDOS
197 if (synch_process_pid)
198 {
199 kill (-synch_process_pid, SIGINT);
200 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
201 immediate_quit = 1;
202 QUIT;
203 wait_for_termination (synch_process_pid, 0, 1);
204 synch_process_pid = 0;
205 immediate_quit = 0;
206 message1 ("Waiting for process to die...done");
207 }
208 #endif /* !MSDOS */
209 }
210
211 #ifdef DOS_NT
212 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
213 #else
214 static mode_t const default_output_mode = 0666;
215 #endif
216
217 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
218 doc: /* Call PROGRAM synchronously in separate process.
219 The remaining arguments are optional.
220 The program's input comes from file INFILE (nil means `/dev/null').
221 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
222 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
223 FILE is a file name string, means that it should be written to that file
224 (if the file already exists it is overwritten).
225 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
226 REAL-BUFFER says what to do with standard output, as above,
227 while STDERR-FILE says what to do with standard error in the child.
228 STDERR-FILE may be nil (discard standard error output),
229 t (mix it with ordinary output), or a file name string.
230
231 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
232 Remaining arguments are strings passed as command arguments to PROGRAM.
233
234 If executable PROGRAM can't be found as an executable, `call-process'
235 signals a Lisp error. `call-process' reports errors in execution of
236 the program only through its return and output.
237
238 If DESTINATION is 0, `call-process' returns immediately with value nil.
239 Otherwise it waits for PROGRAM to terminate
240 and returns a numeric exit status or a signal description string.
241 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
242
243 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
244 (ptrdiff_t nargs, Lisp_Object *args)
245 {
246 Lisp_Object infile, encoded_infile;
247 int filefd;
248 ptrdiff_t count = SPECPDL_INDEX ();
249
250 if (nargs >= 2 && ! NILP (args[1]))
251 {
252 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
253 CHECK_STRING (infile);
254 }
255 else
256 infile = build_string (NULL_DEVICE);
257
258 encoded_infile = ENCODE_FILE (infile);
259
260 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
261 if (filefd < 0)
262 report_file_error ("Opening process input file", infile);
263 record_unwind_protect_int (close_file_unwind, filefd);
264 return unbind_to (count, call_process (nargs, args, filefd, -1));
265 }
266
267 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
268
269 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
270 unwinder that is intended to remove the input temporary file; in
271 this case NARGS must be at least 2 and ARGS[1] is the file's name.
272
273 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
274
275 static Lisp_Object
276 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
277 ptrdiff_t tempfile_index)
278 {
279 Lisp_Object buffer, current_dir, path;
280 bool display_p;
281 int fd0;
282 int callproc_fd[CALLPROC_FDS];
283 int status;
284 ptrdiff_t i;
285 ptrdiff_t count = SPECPDL_INDEX ();
286 USE_SAFE_ALLOCA;
287
288 char **new_argv;
289 /* File to use for stderr in the child.
290 t means use same as standard output. */
291 Lisp_Object error_file;
292 Lisp_Object output_file = Qnil;
293 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
294 char *tempfile = NULL;
295 int pid;
296 #else
297 sigset_t oldset;
298 pid_t pid;
299 #endif
300 int child_errno;
301 int fd_output, fd_error;
302 struct coding_system process_coding; /* coding-system of process output */
303 struct coding_system argument_coding; /* coding-system of arguments */
304 /* Set to the return value of Ffind_operation_coding_system. */
305 Lisp_Object coding_systems;
306 bool discard_output;
307
308 if (synch_process_pid)
309 error ("call-process invoked recursively");
310
311 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
312 coding_systems = Qt;
313
314 CHECK_STRING (args[0]);
315
316 error_file = Qt;
317
318 #ifndef subprocesses
319 /* Without asynchronous processes we cannot have BUFFER == 0. */
320 if (nargs >= 3
321 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
322 error ("Operating system cannot handle asynchronous subprocesses");
323 #endif /* subprocesses */
324
325 /* Decide the coding-system for giving arguments. */
326 {
327 Lisp_Object val, *args2;
328
329 /* If arguments are supplied, we may have to encode them. */
330 if (nargs >= 5)
331 {
332 bool must_encode = 0;
333 Lisp_Object coding_attrs;
334
335 for (i = 4; i < nargs; i++)
336 CHECK_STRING (args[i]);
337
338 for (i = 4; i < nargs; i++)
339 if (STRING_MULTIBYTE (args[i]))
340 must_encode = 1;
341
342 if (!NILP (Vcoding_system_for_write))
343 val = Vcoding_system_for_write;
344 else if (! must_encode)
345 val = Qraw_text;
346 else
347 {
348 SAFE_NALLOCA (args2, 1, nargs + 1);
349 args2[0] = Qcall_process;
350 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
351 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
352 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
353 }
354 val = complement_process_encoding_system (val);
355 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
356 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
357 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
358 {
359 /* We should not use an ASCII incompatible coding system. */
360 val = raw_text_coding_system (val);
361 setup_coding_system (val, &argument_coding);
362 }
363 }
364 }
365
366 if (nargs < 3)
367 buffer = Qnil;
368 else
369 {
370 buffer = args[2];
371
372 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
373 FILE-FOR-STDERR), unless the first element is :file, in which case see
374 the next paragraph. */
375 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
376 {
377 if (CONSP (XCDR (buffer)))
378 {
379 Lisp_Object stderr_file;
380 stderr_file = XCAR (XCDR (buffer));
381
382 if (NILP (stderr_file) || EQ (Qt, stderr_file))
383 error_file = stderr_file;
384 else
385 error_file = Fexpand_file_name (stderr_file, Qnil);
386 }
387
388 buffer = XCAR (buffer);
389 }
390
391 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
392 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
393 {
394 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
395 BVAR (current_buffer, directory));
396 CHECK_STRING (output_file);
397 buffer = Qnil;
398 }
399
400 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
401 {
402 Lisp_Object spec_buffer;
403 spec_buffer = buffer;
404 buffer = Fget_buffer_create (buffer);
405 /* Mention the buffer name for a better error message. */
406 if (NILP (buffer))
407 CHECK_BUFFER (spec_buffer);
408 CHECK_BUFFER (buffer);
409 }
410 }
411
412 /* Make sure that the child will be able to chdir to the current
413 buffer's current directory, or its unhandled equivalent. We
414 can't just have the child check for an error when it does the
415 chdir, since it's in a vfork. */
416 current_dir = encode_current_directory ();
417
418 if (STRINGP (error_file))
419 error_file = ENCODE_FILE (error_file);
420 if (STRINGP (output_file))
421 output_file = ENCODE_FILE (output_file);
422
423 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
424
425 for (i = 0; i < CALLPROC_FDS; i++)
426 callproc_fd[i] = -1;
427 #ifdef MSDOS
428 synch_process_tempfile = make_number (0);
429 #endif
430 record_unwind_protect_ptr (call_process_kill, callproc_fd);
431
432 /* Search for program; barf if not found. */
433 {
434 int ok;
435
436 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
437 make_number (X_OK), false);
438 if (ok < 0)
439 report_file_error ("Searching for program", args[0]);
440 }
441
442 /* Remove "/:" from PATH. */
443 path = remove_slash_colon (path);
444
445 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
446
447 if (nargs > 4)
448 {
449 ptrdiff_t i;
450
451 argument_coding.dst_multibyte = 0;
452 for (i = 4; i < nargs; i++)
453 {
454 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
455 if (CODING_REQUIRE_ENCODING (&argument_coding))
456 /* We must encode this argument. */
457 args[i] = encode_coding_string (&argument_coding, args[i], 1);
458 }
459 for (i = 4; i < nargs; i++)
460 new_argv[i - 3] = SSDATA (args[i]);
461 new_argv[i - 3] = 0;
462 }
463 else
464 new_argv[1] = 0;
465 path = ENCODE_FILE (path);
466 new_argv[0] = SSDATA (path);
467
468 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
469
470 #ifdef MSDOS
471 if (! discard_output && ! STRINGP (output_file))
472 {
473 char const *tmpdir = egetenv ("TMPDIR");
474 char const *outf = tmpdir ? tmpdir : "";
475 tempfile = alloca (strlen (outf) + 20);
476 strcpy (tempfile, outf);
477 dostounix_filename (tempfile);
478 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
479 strcat (tempfile, "/");
480 strcat (tempfile, "emXXXXXX");
481 mktemp (tempfile);
482 if (!*tempfile)
483 report_file_error ("Opening process output file", Qnil);
484 output_file = build_string (tempfile);
485 synch_process_tempfile = output_file;
486 }
487 #endif
488
489 if (discard_output)
490 {
491 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
492 if (fd_output < 0)
493 report_file_error ("Opening null device", Qnil);
494 }
495 else if (STRINGP (output_file))
496 {
497 fd_output = emacs_open (SSDATA (output_file),
498 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
499 default_output_mode);
500 if (fd_output < 0)
501 {
502 int open_errno = errno;
503 output_file = DECODE_FILE (output_file);
504 report_file_errno ("Opening process output file",
505 output_file, open_errno);
506 }
507 }
508 else
509 {
510 int fd[2];
511 if (emacs_pipe (fd) != 0)
512 report_file_error ("Creating process pipe", Qnil);
513 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
514 fd_output = fd[1];
515 }
516 callproc_fd[CALLPROC_STDOUT] = fd_output;
517
518 fd_error = fd_output;
519
520 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
521 {
522 fd_error = emacs_open ((STRINGP (error_file)
523 ? SSDATA (error_file)
524 : NULL_DEVICE),
525 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
526 default_output_mode);
527 if (fd_error < 0)
528 {
529 int open_errno = errno;
530 report_file_errno ("Cannot redirect stderr",
531 (STRINGP (error_file)
532 ? DECODE_FILE (error_file)
533 : build_string (NULL_DEVICE)),
534 open_errno);
535 }
536 callproc_fd[CALLPROC_STDERR] = fd_error;
537 }
538
539 #ifdef MSDOS /* MW, July 1993 */
540 /* Note that on MSDOS `child_setup' actually returns the child process
541 exit status, not its PID, so assign it to status below. */
542 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
543
544 if (pid < 0)
545 {
546 child_errno = errno;
547 unbind_to (count, Qnil);
548 synchronize_system_messages_locale ();
549 return
550 code_convert_string_norecord (build_string (strerror (child_errno)),
551 Vlocale_coding_system, 0);
552 }
553 status = pid;
554
555 for (i = 0; i < CALLPROC_FDS; i++)
556 if (0 <= callproc_fd[i])
557 {
558 emacs_close (callproc_fd[i]);
559 callproc_fd[i] = -1;
560 }
561 emacs_close (filefd);
562 clear_unwind_protect (count - 1);
563
564 if (tempfile)
565 {
566 /* Since CRLF is converted to LF within `decode_coding', we
567 can always open a file with binary mode. */
568 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile,
569 O_RDONLY | O_BINARY, 0);
570 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
571 {
572 int open_errno = errno;
573 report_file_errno ("Cannot re-open temporary file",
574 build_string (tempfile), open_errno);
575 }
576 }
577
578 #endif /* MSDOS */
579
580 /* Do the unwind-protect now, even though the pid is not known, so
581 that no storage allocation is done in the critical section.
582 The actual PID will be filled in during the critical section. */
583 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
584
585 #ifndef MSDOS
586
587 block_input ();
588 block_child_signal (&oldset);
589
590 #ifdef WINDOWSNT
591 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
592 #else /* not WINDOWSNT */
593
594 /* vfork, and prevent local vars from being clobbered by the vfork. */
595 {
596 Lisp_Object volatile buffer_volatile = buffer;
597 Lisp_Object volatile coding_systems_volatile = coding_systems;
598 Lisp_Object volatile current_dir_volatile = current_dir;
599 bool volatile display_p_volatile = display_p;
600 bool volatile sa_must_free_volatile = sa_must_free;
601 int volatile fd_error_volatile = fd_error;
602 int volatile filefd_volatile = filefd;
603 ptrdiff_t volatile count_volatile = count;
604 ptrdiff_t volatile sa_avail_volatile = sa_avail;
605 ptrdiff_t volatile sa_count_volatile = sa_count;
606 char **volatile new_argv_volatile = new_argv;
607 int volatile callproc_fd_volatile[CALLPROC_FDS];
608 for (i = 0; i < CALLPROC_FDS; i++)
609 callproc_fd_volatile[i] = callproc_fd[i];
610
611 pid = vfork ();
612
613 buffer = buffer_volatile;
614 coding_systems = coding_systems_volatile;
615 current_dir = current_dir_volatile;
616 display_p = display_p_volatile;
617 sa_must_free = sa_must_free_volatile;
618 fd_error = fd_error_volatile;
619 filefd = filefd_volatile;
620 count = count_volatile;
621 sa_avail = sa_avail_volatile;
622 sa_count = sa_count_volatile;
623 new_argv = new_argv_volatile;
624
625 for (i = 0; i < CALLPROC_FDS; i++)
626 callproc_fd[i] = callproc_fd_volatile[i];
627 fd_output = callproc_fd[CALLPROC_STDOUT];
628 }
629
630 if (pid == 0)
631 {
632 unblock_child_signal (&oldset);
633
634 setsid ();
635
636 /* Emacs ignores SIGPIPE, but the child should not. */
637 signal (SIGPIPE, SIG_DFL);
638 /* Likewise for SIGPROF. */
639 #ifdef SIGPROF
640 signal (SIGPROF, SIG_DFL);
641 #endif
642
643 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
644 }
645
646 #endif /* not WINDOWSNT */
647
648 child_errno = errno;
649
650 if (pid > 0)
651 {
652 synch_process_pid = pid;
653
654 if (INTEGERP (buffer))
655 {
656 if (tempfile_index < 0)
657 record_deleted_pid (pid, Qnil);
658 else
659 {
660 eassert (1 < nargs);
661 record_deleted_pid (pid, args[1]);
662 clear_unwind_protect (tempfile_index);
663 }
664 synch_process_pid = 0;
665 }
666 }
667
668 unblock_child_signal (&oldset);
669 unblock_input ();
670
671 if (pid < 0)
672 report_file_errno ("Doing vfork", Qnil, child_errno);
673
674 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
675 since we will use that to read input from. */
676 for (i = 0; i < CALLPROC_FDS; i++)
677 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
678 {
679 emacs_close (callproc_fd[i]);
680 callproc_fd[i] = -1;
681 }
682 emacs_close (filefd);
683 clear_unwind_protect (count - 1);
684
685 #endif /* not MSDOS */
686
687 if (INTEGERP (buffer))
688 return unbind_to (count, Qnil);
689
690 if (BUFFERP (buffer))
691 Fset_buffer (buffer);
692
693 fd0 = callproc_fd[CALLPROC_PIPEREAD];
694
695 if (0 <= fd0)
696 {
697 Lisp_Object val, *args2;
698
699 val = Qnil;
700 if (!NILP (Vcoding_system_for_read))
701 val = Vcoding_system_for_read;
702 else
703 {
704 if (EQ (coding_systems, Qt))
705 {
706 ptrdiff_t i;
707
708 SAFE_NALLOCA (args2, 1, nargs + 1);
709 args2[0] = Qcall_process;
710 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
711 coding_systems
712 = Ffind_operation_coding_system (nargs + 1, args2);
713 }
714 if (CONSP (coding_systems))
715 val = XCAR (coding_systems);
716 else if (CONSP (Vdefault_process_coding_system))
717 val = XCAR (Vdefault_process_coding_system);
718 else
719 val = Qnil;
720 }
721 Fcheck_coding_system (val);
722 /* In unibyte mode, character code conversion should not take
723 place but EOL conversion should. So, setup raw-text or one
724 of the subsidiary according to the information just setup. */
725 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
726 && !NILP (val))
727 val = raw_text_coding_system (val);
728 setup_coding_system (val, &process_coding);
729 process_coding.dst_multibyte
730 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
731 process_coding.src_multibyte = 0;
732 }
733
734 immediate_quit = 1;
735 QUIT;
736
737 if (0 <= fd0)
738 {
739 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
740 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
741 char buf[CALLPROC_BUFFER_SIZE_MAX];
742 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
743 int nread;
744 EMACS_INT total_read = 0;
745 int carryover = 0;
746 bool display_on_the_fly = display_p;
747 struct coding_system saved_coding = process_coding;
748
749 while (1)
750 {
751 /* Repeatedly read until we've filled as much as possible
752 of the buffer size we have. But don't read
753 less than 1024--save that for the next bufferful. */
754 nread = carryover;
755 while (nread < bufsize - 1024)
756 {
757 int this_read = emacs_read (fd0, buf + nread,
758 bufsize - nread);
759
760 if (this_read < 0)
761 goto give_up;
762
763 if (this_read == 0)
764 {
765 process_coding.mode |= CODING_MODE_LAST_BLOCK;
766 break;
767 }
768
769 nread += this_read;
770 total_read += this_read;
771
772 if (display_on_the_fly)
773 break;
774 }
775
776 /* Now NREAD is the total amount of data in the buffer. */
777 immediate_quit = 0;
778
779 if (!nread)
780 ;
781 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
782 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
783 insert_1_both (buf, nread, nread, 0, 1, 0);
784 else
785 { /* We have to decode the input. */
786 Lisp_Object curbuf;
787 ptrdiff_t count1 = SPECPDL_INDEX ();
788
789 XSETBUFFER (curbuf, current_buffer);
790 /* FIXME: Call signal_after_change! */
791 prepare_to_modify_buffer (PT, PT, NULL);
792 /* We cannot allow after-change-functions be run
793 during decoding, because that might modify the
794 buffer, while we rely on process_coding.produced to
795 faithfully reflect inserted text until we
796 TEMP_SET_PT_BOTH below. */
797 specbind (Qinhibit_modification_hooks, Qt);
798 decode_coding_c_string (&process_coding,
799 (unsigned char *) buf, nread, curbuf);
800 unbind_to (count1, Qnil);
801 if (display_on_the_fly
802 && CODING_REQUIRE_DETECTION (&saved_coding)
803 && ! CODING_REQUIRE_DETECTION (&process_coding))
804 {
805 /* We have detected some coding system, but the
806 detection may have been via insufficient data.
807 So give up displaying on the fly. */
808 if (process_coding.produced > 0)
809 del_range_2 (process_coding.dst_pos,
810 process_coding.dst_pos_byte,
811 (process_coding.dst_pos
812 + process_coding.produced_char),
813 (process_coding.dst_pos_byte
814 + process_coding.produced),
815 0);
816 display_on_the_fly = false;
817 process_coding = saved_coding;
818 carryover = nread;
819 /* Make the above condition always fail in the future. */
820 saved_coding.common_flags
821 &= ~CODING_REQUIRE_DETECTION_MASK;
822 continue;
823 }
824
825 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
826 PT_BYTE + process_coding.produced);
827 carryover = process_coding.carryover_bytes;
828 if (carryover > 0)
829 memcpy (buf, process_coding.carryover,
830 process_coding.carryover_bytes);
831 }
832
833 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
834 break;
835
836 /* Make the buffer bigger as we continue to read more data,
837 but not past CALLPROC_BUFFER_SIZE_MAX. */
838 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
839 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
840 bufsize = CALLPROC_BUFFER_SIZE_MAX;
841
842 if (display_p)
843 {
844 redisplay_preserve_echo_area (1);
845 /* This variable might have been set to 0 for code
846 detection. In that case, set it back to 1 because
847 we should have already detected a coding system. */
848 display_on_the_fly = true;
849 }
850 immediate_quit = true;
851 QUIT;
852 }
853 give_up: ;
854
855 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
856 /* If the caller required, let the buffer inherit the
857 coding-system used to decode the process output. */
858 if (inherit_process_coding_system)
859 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
860 make_number (total_read));
861 }
862
863 #ifndef MSDOS
864 /* Wait for it to terminate, unless it already has. */
865 wait_for_termination (pid, &status, fd0 < 0);
866 #endif
867
868 immediate_quit = 0;
869
870 /* Don't kill any children that the subprocess may have left behind
871 when exiting. */
872 synch_process_pid = 0;
873
874 SAFE_FREE ();
875 unbind_to (count, Qnil);
876
877 if (WIFSIGNALED (status))
878 {
879 const char *signame;
880
881 synchronize_system_messages_locale ();
882 signame = strsignal (WTERMSIG (status));
883
884 if (signame == 0)
885 signame = "unknown";
886
887 return code_convert_string_norecord (build_string (signame),
888 Vlocale_coding_system, 0);
889 }
890
891 eassert (WIFEXITED (status));
892 return make_number (WEXITSTATUS (status));
893 }
894 \f
895 /* Create a temporary file suitable for storing the input data of
896 call-process-region. NARGS and ARGS are the same as for
897 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
898 naming the file, and return a file descriptor for reading.
899 Unwind-protect the file, so that the file descriptor will be closed
900 and the file removed when the caller unwinds the specpdl stack. */
901
902 static int
903 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
904 Lisp_Object *filename_string_ptr)
905 {
906 int fd;
907 Lisp_Object filename_string;
908 Lisp_Object val, start, end;
909 Lisp_Object tmpdir;
910
911 if (STRINGP (Vtemporary_file_directory))
912 tmpdir = Vtemporary_file_directory;
913 else
914 {
915 char *outf;
916 #ifndef DOS_NT
917 outf = getenv ("TMPDIR");
918 tmpdir = build_string (outf ? outf : "/tmp/");
919 #else /* DOS_NT */
920 if ((outf = egetenv ("TMPDIR"))
921 || (outf = egetenv ("TMP"))
922 || (outf = egetenv ("TEMP")))
923 tmpdir = build_string (outf);
924 else
925 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
926 #endif
927 }
928
929 {
930 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
931 char *tempfile;
932 ptrdiff_t count;
933
934 #ifdef WINDOWSNT
935 /* Cannot use the result of Fexpand_file_name, because it
936 downcases the XXXXXX part of the pattern, and mktemp then
937 doesn't recognize it. */
938 if (!NILP (Vw32_downcase_file_names))
939 {
940 Lisp_Object dirname = Ffile_name_directory (pattern);
941
942 if (NILP (dirname))
943 pattern = Vtemp_file_name_pattern;
944 else
945 pattern = concat2 (dirname, Vtemp_file_name_pattern);
946 }
947 #endif
948
949 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
950 tempfile = SSDATA (filename_string);
951
952 count = SPECPDL_INDEX ();
953 record_unwind_protect_nothing ();
954 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
955 if (fd < 0)
956 report_file_error ("Failed to open temporary file using pattern",
957 pattern);
958 set_unwind_protect (count, delete_temp_file, filename_string);
959 record_unwind_protect_int (close_file_unwind, fd);
960 }
961
962 start = args[0];
963 end = args[1];
964 /* Decide coding-system of the contents of the temporary file. */
965 if (!NILP (Vcoding_system_for_write))
966 val = Vcoding_system_for_write;
967 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
968 val = Qraw_text;
969 else
970 {
971 Lisp_Object coding_systems;
972 Lisp_Object *args2;
973 USE_SAFE_ALLOCA;
974 SAFE_NALLOCA (args2, 1, nargs + 1);
975 args2[0] = Qcall_process_region;
976 memcpy (args2 + 1, args, nargs * sizeof *args);
977 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
978 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
979 SAFE_FREE ();
980 }
981 val = complement_process_encoding_system (val);
982
983 {
984 ptrdiff_t count1 = SPECPDL_INDEX ();
985
986 specbind (intern ("coding-system-for-write"), val);
987 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
988 happen to get a ".Z" suffix. */
989 specbind (Qfile_name_handler_alist, Qnil);
990 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
991
992 unbind_to (count1, Qnil);
993 }
994
995 if (lseek (fd, 0, SEEK_SET) < 0)
996 report_file_error ("Setting file position", filename_string);
997
998 /* Note that Fcall_process takes care of binding
999 coding-system-for-read. */
1000
1001 *filename_string_ptr = filename_string;
1002 return fd;
1003 }
1004
1005 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1006 3, MANY, 0,
1007 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1008 The remaining arguments are optional.
1009 Delete the text if fourth arg DELETE is non-nil.
1010
1011 Insert output in BUFFER before point; t means current buffer; nil for
1012 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1013 FILE)', where FILE is a file name string, means that it should be
1014 written to that file (if the file already exists it is overwritten).
1015 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1016 REAL-BUFFER says what to do with standard output, as above,
1017 while STDERR-FILE says what to do with standard error in the child.
1018 STDERR-FILE may be nil (discard standard error output),
1019 t (mix it with ordinary output), or a file name string.
1020
1021 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1022 Remaining args are passed to PROGRAM at startup as command args.
1023
1024 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1025 Otherwise it waits for PROGRAM to terminate
1026 and returns a numeric exit status or a signal description string.
1027 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1028
1029 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1030 (ptrdiff_t nargs, Lisp_Object *args)
1031 {
1032 Lisp_Object infile, val;
1033 ptrdiff_t count = SPECPDL_INDEX ();
1034 Lisp_Object start = args[0];
1035 Lisp_Object end = args[1];
1036 bool empty_input;
1037 int fd;
1038
1039 if (STRINGP (start))
1040 empty_input = SCHARS (start) == 0;
1041 else if (NILP (start))
1042 empty_input = BEG == Z;
1043 else
1044 {
1045 validate_region (&args[0], &args[1]);
1046 start = args[0];
1047 end = args[1];
1048 empty_input = XINT (start) == XINT (end);
1049 }
1050
1051 if (!empty_input)
1052 fd = create_temp_file (nargs, args, &infile);
1053 else
1054 {
1055 infile = Qnil;
1056 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1057 if (fd < 0)
1058 report_file_error ("Opening null device", Qnil);
1059 record_unwind_protect_int (close_file_unwind, fd);
1060 }
1061
1062 if (nargs > 3 && !NILP (args[3]))
1063 Fdelete_region (start, end);
1064
1065 if (nargs > 3)
1066 {
1067 args += 2;
1068 nargs -= 2;
1069 }
1070 else
1071 {
1072 args[0] = args[2];
1073 nargs = 2;
1074 }
1075 args[1] = infile;
1076
1077 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1078 return unbind_to (count, val);
1079 }
1080 \f
1081 static char **
1082 add_env (char **env, char **new_env, char *string)
1083 {
1084 char **ep;
1085 bool ok = 1;
1086 if (string == NULL)
1087 return new_env;
1088
1089 /* See if this string duplicates any string already in the env.
1090 If so, don't put it in.
1091 When an env var has multiple definitions,
1092 we keep the definition that comes first in process-environment. */
1093 for (ep = env; ok && ep != new_env; ep++)
1094 {
1095 char *p = *ep, *q = string;
1096 while (ok)
1097 {
1098 if (*q != *p)
1099 break;
1100 if (*q == 0)
1101 /* The string is a lone variable name; keep it for now, we
1102 will remove it later. It is a placeholder for a
1103 variable that is not to be included in the environment. */
1104 break;
1105 if (*q == '=')
1106 ok = 0;
1107 p++, q++;
1108 }
1109 }
1110 if (ok)
1111 *new_env++ = string;
1112 return new_env;
1113 }
1114
1115 #ifndef DOS_NT
1116
1117 /* 'exec' failed inside a child running NAME, with error number ERR.
1118 Possibly a vforked child needed to allocate a large vector on the
1119 stack; such a child cannot fall back on malloc because that might
1120 mess up the allocator's data structures in the parent.
1121 Report the error and exit the child. */
1122
1123 static _Noreturn void
1124 exec_failed (char const *name, int err)
1125 {
1126 /* Avoid deadlock if the child's perror writes to a full pipe; the
1127 pipe's reader is the parent, but with vfork the parent can't
1128 run until the child exits. Truncate the diagnostic instead. */
1129 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1130
1131 errno = err;
1132 emacs_perror (name);
1133 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1134 }
1135
1136 #else
1137
1138 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1139 fork and exec, and handle alloca exhaustion in a different way. */
1140
1141 static void
1142 exec_failed (char const *name, int err)
1143 {
1144 }
1145
1146 #endif
1147
1148 /* This is the last thing run in a newly forked inferior
1149 either synchronous or asynchronous.
1150 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1151 Initialize inferior's priority, pgrp, connected dir and environment.
1152 then exec another program based on new_argv.
1153
1154 If SET_PGRP, put the subprocess into a separate process group.
1155
1156 CURRENT_DIR is an elisp string giving the path of the current
1157 directory the subprocess should have. Since we can't really signal
1158 a decent error from within the child, this should be verified as an
1159 executable directory by the parent. */
1160
1161 int
1162 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1163 Lisp_Object current_dir)
1164 {
1165 char **env;
1166 char *pwd_var;
1167 #ifdef WINDOWSNT
1168 int cpid;
1169 HANDLE handles[3];
1170 #else
1171 pid_t pid = getpid ();
1172 #endif /* WINDOWSNT */
1173
1174 /* Note that use of alloca is always safe here. It's obvious for systems
1175 that do not have true vfork or that have true (stack) alloca.
1176 If using vfork and C_ALLOCA (when Emacs used to include
1177 src/alloca.c) it is safe because that changes the superior's
1178 static variables as if the superior had done alloca and will be
1179 cleaned up in the usual way. */
1180 {
1181 char *temp;
1182 ptrdiff_t i;
1183
1184 i = SBYTES (current_dir);
1185 #ifdef MSDOS
1186 /* MSDOS must have all environment variables malloc'ed, because
1187 low-level libc functions that launch subsidiary processes rely
1188 on that. */
1189 pwd_var = xmalloc (i + 5);
1190 #else
1191 if (MAX_ALLOCA - 5 < i)
1192 exec_failed (new_argv[0], ENOMEM);
1193 pwd_var = alloca (i + 5);
1194 #endif
1195 temp = pwd_var + 4;
1196 memcpy (pwd_var, "PWD=", 4);
1197 lispstpcpy (temp, current_dir);
1198
1199 #ifndef DOS_NT
1200 /* We can't signal an Elisp error here; we're in a vfork. Since
1201 the callers check the current directory before forking, this
1202 should only return an error if the directory's permissions
1203 are changed between the check and this chdir, but we should
1204 at least check. */
1205 if (chdir (temp) < 0)
1206 _exit (EXIT_CANCELED);
1207 #else /* DOS_NT */
1208 /* Get past the drive letter, so that d:/ is left alone. */
1209 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1210 {
1211 temp += 2;
1212 i -= 2;
1213 }
1214 #endif /* DOS_NT */
1215
1216 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1217 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1218 temp[--i] = 0;
1219 }
1220
1221 /* Set `env' to a vector of the strings in the environment. */
1222 {
1223 register Lisp_Object tem;
1224 register char **new_env;
1225 char **p, **q;
1226 register int new_length;
1227 Lisp_Object display = Qnil;
1228
1229 new_length = 0;
1230
1231 for (tem = Vprocess_environment;
1232 CONSP (tem) && STRINGP (XCAR (tem));
1233 tem = XCDR (tem))
1234 {
1235 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1236 && (SDATA (XCAR (tem)) [7] == '\0'
1237 || SDATA (XCAR (tem)) [7] == '='))
1238 /* DISPLAY is specified in process-environment. */
1239 display = Qt;
1240 new_length++;
1241 }
1242
1243 /* If not provided yet, use the frame's DISPLAY. */
1244 if (NILP (display))
1245 {
1246 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1247 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1248 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1249 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1250 Vinitial_environment);
1251 if (STRINGP (tmp))
1252 {
1253 display = tmp;
1254 new_length++;
1255 }
1256 }
1257
1258 /* new_length + 2 to include PWD and terminating 0. */
1259 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1260 exec_failed (new_argv[0], ENOMEM);
1261 env = new_env = alloca ((new_length + 2) * sizeof *env);
1262 /* If we have a PWD envvar, pass one down,
1263 but with corrected value. */
1264 if (egetenv ("PWD"))
1265 *new_env++ = pwd_var;
1266
1267 if (STRINGP (display))
1268 {
1269 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1270 exec_failed (new_argv[0], ENOMEM);
1271 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1272 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1273 new_env = add_env (env, new_env, vdata);
1274 }
1275
1276 /* Overrides. */
1277 for (tem = Vprocess_environment;
1278 CONSP (tem) && STRINGP (XCAR (tem));
1279 tem = XCDR (tem))
1280 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1281
1282 *new_env = 0;
1283
1284 /* Remove variable names without values. */
1285 p = q = env;
1286 while (*p != 0)
1287 {
1288 while (*q != 0 && strchr (*q, '=') == NULL)
1289 q++;
1290 *p = *q++;
1291 if (*p != 0)
1292 p++;
1293 }
1294 }
1295
1296
1297 #ifdef WINDOWSNT
1298 prepare_standard_handles (in, out, err, handles);
1299 set_process_dir (SDATA (current_dir));
1300 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1301 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1302 reset_standard_handles (in, out, err, handles);
1303 if (cpid == -1)
1304 /* An error occurred while trying to spawn the process. */
1305 report_file_error ("Spawning child process", Qnil);
1306 return cpid;
1307
1308 #else /* not WINDOWSNT */
1309
1310 #ifndef MSDOS
1311 /* Redirect file descriptors and clear the close-on-exec flag on the
1312 redirected ones. IN, OUT, and ERR are close-on-exec so they
1313 need not be closed explicitly. */
1314 dup2 (in, STDIN_FILENO);
1315 dup2 (out, STDOUT_FILENO);
1316 dup2 (err, STDERR_FILENO);
1317
1318 setpgid (0, 0);
1319 tcsetpgrp (0, pid);
1320
1321 execve (new_argv[0], new_argv, env);
1322 exec_failed (new_argv[0], errno);
1323
1324 #else /* MSDOS */
1325 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1326 xfree (pwd_var);
1327 if (pid == -1)
1328 /* An error occurred while trying to run the subprocess. */
1329 report_file_error ("Spawning child process", Qnil);
1330 return pid;
1331 #endif /* MSDOS */
1332 #endif /* not WINDOWSNT */
1333 }
1334
1335 static bool
1336 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1337 ptrdiff_t *valuelen, Lisp_Object env)
1338 {
1339 for (; CONSP (env); env = XCDR (env))
1340 {
1341 Lisp_Object entry = XCAR (env);
1342 if (STRINGP (entry)
1343 && SBYTES (entry) >= varlen
1344 #ifdef WINDOWSNT
1345 /* NT environment variables are case insensitive. */
1346 && ! strnicmp (SDATA (entry), var, varlen)
1347 #else /* not WINDOWSNT */
1348 && ! memcmp (SDATA (entry), var, varlen)
1349 #endif /* not WINDOWSNT */
1350 )
1351 {
1352 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1353 {
1354 *value = SSDATA (entry) + (varlen + 1);
1355 *valuelen = SBYTES (entry) - (varlen + 1);
1356 return 1;
1357 }
1358 else if (SBYTES (entry) == varlen)
1359 {
1360 /* Lone variable names in Vprocess_environment mean that
1361 variable should be removed from the environment. */
1362 *value = NULL;
1363 return 1;
1364 }
1365 }
1366 }
1367 return 0;
1368 }
1369
1370 static bool
1371 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1372 ptrdiff_t *valuelen, Lisp_Object frame)
1373 {
1374 /* Try to find VAR in Vprocess_environment first. */
1375 if (getenv_internal_1 (var, varlen, value, valuelen,
1376 Vprocess_environment))
1377 return *value ? 1 : 0;
1378
1379 /* For DISPLAY try to get the values from the frame or the initial env. */
1380 if (strcmp (var, "DISPLAY") == 0)
1381 {
1382 Lisp_Object display
1383 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1384 if (STRINGP (display))
1385 {
1386 *value = SSDATA (display);
1387 *valuelen = SBYTES (display);
1388 return 1;
1389 }
1390 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1391 if (getenv_internal_1 (var, varlen, value, valuelen,
1392 Vinitial_environment))
1393 return *value ? 1 : 0;
1394 }
1395
1396 return 0;
1397 }
1398
1399 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1400 doc: /* Get the value of environment variable VARIABLE.
1401 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1402 the environment. Otherwise, value is a string.
1403
1404 This function searches `process-environment' for VARIABLE.
1405
1406 If optional parameter ENV is a list, then search this list instead of
1407 `process-environment', and return t when encountering a negative entry
1408 \(an entry for a variable with no value). */)
1409 (Lisp_Object variable, Lisp_Object env)
1410 {
1411 char *value;
1412 ptrdiff_t valuelen;
1413
1414 CHECK_STRING (variable);
1415 if (CONSP (env))
1416 {
1417 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1418 &value, &valuelen, env))
1419 return value ? make_string (value, valuelen) : Qt;
1420 else
1421 return Qnil;
1422 }
1423 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1424 &value, &valuelen, env))
1425 return make_string (value, valuelen);
1426 else
1427 return Qnil;
1428 }
1429
1430 /* A version of getenv that consults the Lisp environment lists,
1431 easily callable from C. This is usually called from egetenv. */
1432 char *
1433 egetenv_internal (const char *var, ptrdiff_t len)
1434 {
1435 char *value;
1436 ptrdiff_t valuelen;
1437
1438 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1439 return value;
1440 else
1441 return 0;
1442 }
1443
1444 \f
1445 /* This is run before init_cmdargs. */
1446
1447 void
1448 init_callproc_1 (void)
1449 {
1450 #ifdef HAVE_NS
1451 const char *etc_dir = ns_etc_directory ();
1452 const char *path_exec = ns_exec_path ();
1453 #endif
1454
1455 Vdata_directory = decode_env_path ("EMACSDATA",
1456 #ifdef HAVE_NS
1457 etc_dir ? etc_dir :
1458 #endif
1459 PATH_DATA, 0);
1460 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1461
1462 Vdoc_directory = decode_env_path ("EMACSDOC",
1463 #ifdef HAVE_NS
1464 etc_dir ? etc_dir :
1465 #endif
1466 PATH_DOC, 0);
1467 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1468
1469 /* Check the EMACSPATH environment variable, defaulting to the
1470 PATH_EXEC path from epaths.h. */
1471 Vexec_path = decode_env_path ("EMACSPATH",
1472 #ifdef HAVE_NS
1473 path_exec ? path_exec :
1474 #endif
1475 PATH_EXEC, 0);
1476 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1477 /* FIXME? For ns, path_exec should go at the front? */
1478 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1479 }
1480
1481 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1482
1483 void
1484 init_callproc (void)
1485 {
1486 bool data_dir = egetenv ("EMACSDATA") != 0;
1487
1488 char *sh;
1489 Lisp_Object tempdir;
1490 #ifdef HAVE_NS
1491 if (data_dir == 0)
1492 data_dir = ns_etc_directory () != 0;
1493 #endif
1494
1495 if (!NILP (Vinstallation_directory))
1496 {
1497 /* Add to the path the lib-src subdir of the installation dir. */
1498 Lisp_Object tem;
1499 tem = Fexpand_file_name (build_string ("lib-src"),
1500 Vinstallation_directory);
1501 #ifndef MSDOS
1502 /* MSDOS uses wrapped binaries, so don't do this. */
1503 if (NILP (Fmember (tem, Vexec_path)))
1504 {
1505 #ifdef HAVE_NS
1506 const char *path_exec = ns_exec_path ();
1507 #endif
1508 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1509 Vexec_path = decode_env_path ("EMACSPATH",
1510 #ifdef HAVE_NS
1511 path_exec ? path_exec :
1512 #endif
1513 SSDATA (tem), 0);
1514 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1515 }
1516
1517 Vexec_directory = Ffile_name_as_directory (tem);
1518 #endif /* not MSDOS */
1519
1520 /* Maybe use ../etc as well as ../lib-src. */
1521 if (data_dir == 0)
1522 {
1523 tem = Fexpand_file_name (build_string ("etc"),
1524 Vinstallation_directory);
1525 Vdoc_directory = Ffile_name_as_directory (tem);
1526 }
1527 }
1528
1529 /* Look for the files that should be in etc. We don't use
1530 Vinstallation_directory, because these files are never installed
1531 near the executable, and they are never in the build
1532 directory when that's different from the source directory.
1533
1534 Instead, if these files are not in the nominal place, we try the
1535 source directory. */
1536 if (data_dir == 0)
1537 {
1538 Lisp_Object tem, tem1, srcdir;
1539 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1540
1541 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1542
1543 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1544 tem1 = Ffile_exists_p (tem);
1545 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1546 {
1547 Lisp_Object newdir;
1548 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1549 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1550 tem1 = Ffile_exists_p (tem);
1551 if (!NILP (tem1))
1552 Vdata_directory = newdir;
1553 }
1554 }
1555
1556 #ifndef CANNOT_DUMP
1557 if (initialized)
1558 #endif
1559 {
1560 tempdir = Fdirectory_file_name (Vexec_directory);
1561 if (! file_accessible_directory_p (tempdir))
1562 dir_warning ("arch-dependent data dir", Vexec_directory);
1563 }
1564
1565 tempdir = Fdirectory_file_name (Vdata_directory);
1566 if (! file_accessible_directory_p (tempdir))
1567 dir_warning ("arch-independent data dir", Vdata_directory);
1568
1569 sh = getenv ("SHELL");
1570 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1571
1572 #ifdef DOS_NT
1573 Vshared_game_score_directory = Qnil;
1574 #else
1575 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1576 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1577 Vshared_game_score_directory = Qnil;
1578 #endif
1579 }
1580
1581 void
1582 set_initial_environment (void)
1583 {
1584 char **envp;
1585 for (envp = environ; *envp; envp++)
1586 Vprocess_environment = Fcons (build_string (*envp),
1587 Vprocess_environment);
1588 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1589 to use `delete' and friends on process-environment. */
1590 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1591 }
1592
1593 void
1594 syms_of_callproc (void)
1595 {
1596 #ifndef DOS_NT
1597 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1598 #else /* DOS_NT */
1599 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1600 #endif
1601 staticpro (&Vtemp_file_name_pattern);
1602
1603 #ifdef MSDOS
1604 synch_process_tempfile = make_number (0);
1605 staticpro (&synch_process_tempfile);
1606 #endif
1607
1608 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1609 doc: /* File name to load inferior shells from.
1610 Initialized from the SHELL environment variable, or to a system-dependent
1611 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1612
1613 DEFVAR_LISP ("exec-path", Vexec_path,
1614 doc: /* List of directories to search programs to run in subprocesses.
1615 Each element is a string (directory name) or nil (try default directory).
1616
1617 By default the last element of this list is `exec-directory'. The
1618 last element is not always used, for example in shell completion
1619 \(`shell-dynamic-complete-command'). */);
1620
1621 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1622 doc: /* List of suffixes to try to find executable file names.
1623 Each element is a string. */);
1624 Vexec_suffixes = Qnil;
1625
1626 DEFVAR_LISP ("exec-directory", Vexec_directory,
1627 doc: /* Directory for executables for Emacs to invoke.
1628 More generally, this includes any architecture-dependent files
1629 that are built and installed from the Emacs distribution. */);
1630
1631 DEFVAR_LISP ("data-directory", Vdata_directory,
1632 doc: /* Directory of machine-independent files that come with GNU Emacs.
1633 These are files intended for Emacs to use while it runs. */);
1634
1635 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1636 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1637 This is usually the same as `data-directory'. */);
1638
1639 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1640 doc: /* For internal use by the build procedure only.
1641 This is the name of the directory in which the build procedure installed
1642 Emacs's info files; the default value for `Info-default-directory-list'
1643 includes this. */);
1644 Vconfigure_info_directory = build_string (PATH_INFO);
1645
1646 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1647 doc: /* Directory of score files for games which come with GNU Emacs.
1648 If this variable is nil, then Emacs is unable to use a shared directory. */);
1649 #ifdef DOS_NT
1650 Vshared_game_score_directory = Qnil;
1651 #else
1652 Vshared_game_score_directory = build_string (PATH_GAME);
1653 #endif
1654
1655 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1656 doc: /* List of environment variables inherited from the parent process.
1657 Each element should be a string of the form ENVVARNAME=VALUE.
1658 The elements must normally be decoded (using `locale-coding-system') for use. */);
1659 Vinitial_environment = Qnil;
1660
1661 DEFVAR_LISP ("process-environment", Vprocess_environment,
1662 doc: /* List of overridden environment variables for subprocesses to inherit.
1663 Each element should be a string of the form ENVVARNAME=VALUE.
1664
1665 Entries in this list take precedence to those in the frame-local
1666 environments. Therefore, let-binding `process-environment' is an easy
1667 way to temporarily change the value of an environment variable,
1668 irrespective of where it comes from. To use `process-environment' to
1669 remove an environment variable, include only its name in the list,
1670 without "=VALUE".
1671
1672 This variable is set to nil when Emacs starts.
1673
1674 If multiple entries define the same variable, the first one always
1675 takes precedence.
1676
1677 Non-ASCII characters are encoded according to the initial value of
1678 `locale-coding-system', i.e. the elements must normally be decoded for
1679 use.
1680
1681 See `setenv' and `getenv'. */);
1682 Vprocess_environment = Qnil;
1683
1684 defsubr (&Scall_process);
1685 defsubr (&Sgetenv_internal);
1686 defsubr (&Scall_process_region);
1687 }