Merge from emacs-24; up to 2012-12-19T13:01:16Z!michael.albinus@gmx.de
[emacs.git] / src / w32proc.c
blobce1474c732304506adb02f2039286b59a95a7afb
1 /* Process support for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1992, 1995, 1999-2013 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 Drew Bliss Oct 14, 1993
21 Adapted from alarm.c by Tim Fleehart
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <errno.h>
27 #include <ctype.h>
28 #include <io.h>
29 #include <fcntl.h>
30 #include <signal.h>
31 #include <sys/file.h>
33 /* must include CRT headers *before* config.h */
34 #include <config.h>
36 #undef signal
37 #undef wait
38 #undef spawnve
39 #undef select
40 #undef kill
42 #include <windows.h>
43 #ifdef __GNUC__
44 /* This definition is missing from mingw32 headers. */
45 extern BOOL WINAPI IsValidLocale (LCID, DWORD);
46 #endif
48 #ifdef HAVE_LANGINFO_CODESET
49 #include <nl_types.h>
50 #include <langinfo.h>
51 #endif
53 #include "lisp.h"
54 #include "w32.h"
55 #include "w32common.h"
56 #include "w32heap.h"
57 #include "systime.h"
58 #include "syswait.h"
59 #include "process.h"
60 #include "syssignal.h"
61 #include "w32term.h"
62 #include "dispextern.h" /* for xstrcasecmp */
63 #include "coding.h"
65 #define RVA_TO_PTR(var,section,filedata) \
66 ((void *)((section)->PointerToRawData \
67 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
68 + (filedata).file_base))
70 Lisp_Object Qhigh, Qlow;
72 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
73 static signal_handler sig_handlers[NSIG];
75 static sigset_t sig_mask;
77 static CRITICAL_SECTION crit_sig;
79 /* Improve on the CRT 'signal' implementation so that we could record
80 the SIGCHLD handler and fake interval timers. */
81 signal_handler
82 sys_signal (int sig, signal_handler handler)
84 signal_handler old;
86 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
87 below. SIGALRM and SIGPROF are used by setitimer. All the
88 others are the only ones supported by the MS runtime. */
89 if (!(sig == SIGCHLD || sig == SIGSEGV || sig == SIGILL
90 || sig == SIGFPE || sig == SIGABRT || sig == SIGTERM
91 || sig == SIGALRM || sig == SIGPROF))
93 errno = EINVAL;
94 return SIG_ERR;
96 old = sig_handlers[sig];
97 /* SIGABRT is treated specially because w32.c installs term_ntproc
98 as its handler, so we don't want to override that afterwards.
99 Aborting Emacs works specially anyway: either by calling
100 emacs_abort directly or through terminate_due_to_signal, which
101 calls emacs_abort through emacs_raise. */
102 if (!(sig == SIGABRT && old == term_ntproc))
104 sig_handlers[sig] = handler;
105 if (!(sig == SIGCHLD || sig == SIGALRM || sig == SIGPROF))
106 signal (sig, handler);
108 return old;
111 /* Emulate sigaction. */
113 sigaction (int sig, const struct sigaction *act, struct sigaction *oact)
115 signal_handler old = SIG_DFL;
116 int retval = 0;
118 if (act)
119 old = sys_signal (sig, act->sa_handler);
120 else if (oact)
121 old = sig_handlers[sig];
123 if (old == SIG_ERR)
125 errno = EINVAL;
126 retval = -1;
128 if (oact)
130 oact->sa_handler = old;
131 oact->sa_flags = 0;
132 oact->sa_mask = empty_mask;
134 return retval;
137 /* Emulate signal sets and blocking of signals used by timers. */
140 sigemptyset (sigset_t *set)
142 *set = 0;
143 return 0;
147 sigaddset (sigset_t *set, int signo)
149 if (!set)
151 errno = EINVAL;
152 return -1;
154 if (signo < 0 || signo >= NSIG)
156 errno = EINVAL;
157 return -1;
160 *set |= (1U << signo);
162 return 0;
166 sigfillset (sigset_t *set)
168 if (!set)
170 errno = EINVAL;
171 return -1;
174 *set = 0xFFFFFFFF;
175 return 0;
179 sigprocmask (int how, const sigset_t *set, sigset_t *oset)
181 if (!(how == SIG_BLOCK || how == SIG_UNBLOCK || how == SIG_SETMASK))
183 errno = EINVAL;
184 return -1;
187 if (oset)
188 *oset = sig_mask;
190 if (!set)
191 return 0;
193 switch (how)
195 case SIG_BLOCK:
196 sig_mask |= *set;
197 break;
198 case SIG_SETMASK:
199 sig_mask = *set;
200 break;
201 case SIG_UNBLOCK:
202 /* FIXME: Catch signals that are blocked and reissue them when
203 they are unblocked. Important for SIGALRM and SIGPROF only. */
204 sig_mask &= ~(*set);
205 break;
208 return 0;
212 pthread_sigmask (int how, const sigset_t *set, sigset_t *oset)
214 if (sigprocmask (how, set, oset) == -1)
215 return EINVAL;
216 return 0;
220 sigismember (const sigset_t *set, int signo)
222 if (signo < 0 || signo >= NSIG)
224 errno = EINVAL;
225 return -1;
227 if (signo > sizeof (*set) * BITS_PER_CHAR)
228 emacs_abort ();
230 return (*set & (1U << signo)) != 0;
233 pid_t
234 getpgrp (void)
236 return getpid ();
239 pid_t
240 tcgetpgrp (int fd)
242 return getpid ();
246 setpgid (pid_t pid, pid_t pgid)
248 return 0;
251 pid_t
252 setsid (void)
254 return getpid ();
257 /* Emulations of interval timers.
259 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
261 Implementation: a separate thread is started for each timer type,
262 the thread calls the appropriate signal handler when the timer
263 expires, after stopping the thread which installed the timer. */
265 struct itimer_data {
266 volatile ULONGLONG expire;
267 volatile ULONGLONG reload;
268 volatile int terminate;
269 int type;
270 HANDLE caller_thread;
271 HANDLE timer_thread;
274 static ULONGLONG ticks_now;
275 static struct itimer_data real_itimer, prof_itimer;
276 static ULONGLONG clocks_min;
277 /* If non-zero, itimers are disabled. Used during shutdown, when we
278 delete the critical sections used by the timer threads. */
279 static int disable_itimers;
281 static CRITICAL_SECTION crit_real, crit_prof;
283 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
284 typedef BOOL (WINAPI *GetThreadTimes_Proc) (
285 HANDLE hThread,
286 LPFILETIME lpCreationTime,
287 LPFILETIME lpExitTime,
288 LPFILETIME lpKernelTime,
289 LPFILETIME lpUserTime);
291 static GetThreadTimes_Proc s_pfn_Get_Thread_Times;
293 #define MAX_SINGLE_SLEEP 30
294 #define TIMER_TICKS_PER_SEC 1000
296 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
297 to a thread. If THREAD is NULL or an invalid handle, return the
298 current wall-clock time since January 1, 1601 (UTC). Otherwise,
299 return the sum of kernel and user times used by THREAD since it was
300 created, plus its creation time. */
301 static ULONGLONG
302 w32_get_timer_time (HANDLE thread)
304 ULONGLONG retval;
305 int use_system_time = 1;
306 /* The functions below return times in 100-ns units. */
307 const int tscale = 10 * TIMER_TICKS_PER_SEC;
309 if (thread && thread != INVALID_HANDLE_VALUE
310 && s_pfn_Get_Thread_Times != NULL)
312 FILETIME creation_ftime, exit_ftime, kernel_ftime, user_ftime;
313 ULARGE_INTEGER temp_creation, temp_kernel, temp_user;
315 if (s_pfn_Get_Thread_Times (thread, &creation_ftime, &exit_ftime,
316 &kernel_ftime, &user_ftime))
318 use_system_time = 0;
319 temp_creation.LowPart = creation_ftime.dwLowDateTime;
320 temp_creation.HighPart = creation_ftime.dwHighDateTime;
321 temp_kernel.LowPart = kernel_ftime.dwLowDateTime;
322 temp_kernel.HighPart = kernel_ftime.dwHighDateTime;
323 temp_user.LowPart = user_ftime.dwLowDateTime;
324 temp_user.HighPart = user_ftime.dwHighDateTime;
325 retval =
326 temp_creation.QuadPart / tscale + temp_kernel.QuadPart / tscale
327 + temp_user.QuadPart / tscale;
329 else
330 DebPrint (("GetThreadTimes failed with error code %lu\n",
331 GetLastError ()));
334 if (use_system_time)
336 FILETIME current_ftime;
337 ULARGE_INTEGER temp;
339 GetSystemTimeAsFileTime (&current_ftime);
341 temp.LowPart = current_ftime.dwLowDateTime;
342 temp.HighPart = current_ftime.dwHighDateTime;
344 retval = temp.QuadPart / tscale;
347 return retval;
350 /* Thread function for a timer thread. */
351 static DWORD WINAPI
352 timer_loop (LPVOID arg)
354 struct itimer_data *itimer = (struct itimer_data *)arg;
355 int which = itimer->type;
356 int sig = (which == ITIMER_REAL) ? SIGALRM : SIGPROF;
357 CRITICAL_SECTION *crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
358 const DWORD max_sleep = MAX_SINGLE_SLEEP * 1000 / TIMER_TICKS_PER_SEC;
359 HANDLE hth = (which == ITIMER_REAL) ? NULL : itimer->caller_thread;
361 while (1)
363 DWORD sleep_time;
364 signal_handler handler;
365 ULONGLONG now, expire, reload;
367 /* Load new values if requested by setitimer. */
368 EnterCriticalSection (crit);
369 expire = itimer->expire;
370 reload = itimer->reload;
371 LeaveCriticalSection (crit);
372 if (itimer->terminate)
373 return 0;
375 if (expire == 0)
377 /* We are idle. */
378 Sleep (max_sleep);
379 continue;
382 if (expire > (now = w32_get_timer_time (hth)))
383 sleep_time = expire - now;
384 else
385 sleep_time = 0;
386 /* Don't sleep too long at a time, to be able to see the
387 termination flag without too long a delay. */
388 while (sleep_time > max_sleep)
390 if (itimer->terminate)
391 return 0;
392 Sleep (max_sleep);
393 EnterCriticalSection (crit);
394 expire = itimer->expire;
395 LeaveCriticalSection (crit);
396 sleep_time =
397 (expire > (now = w32_get_timer_time (hth))) ? expire - now : 0;
399 if (itimer->terminate)
400 return 0;
401 if (sleep_time > 0)
403 Sleep (sleep_time * 1000 / TIMER_TICKS_PER_SEC);
404 /* Always sleep past the expiration time, to make sure we
405 never call the handler _before_ the expiration time,
406 always slightly after it. Sleep(5) makes sure we don't
407 hog the CPU by calling 'w32_get_timer_time' with high
408 frequency, and also let other threads work. */
409 while (w32_get_timer_time (hth) < expire)
410 Sleep (5);
413 EnterCriticalSection (crit);
414 expire = itimer->expire;
415 LeaveCriticalSection (crit);
416 if (expire == 0)
417 continue;
419 /* Time's up. */
420 handler = sig_handlers[sig];
421 if (!(handler == SIG_DFL || handler == SIG_IGN || handler == SIG_ERR)
422 /* FIXME: Don't ignore masked signals. Instead, record that
423 they happened and reissue them when the signal is
424 unblocked. */
425 && !sigismember (&sig_mask, sig)
426 /* Simulate masking of SIGALRM and SIGPROF when processing
427 fatal signals. */
428 && !fatal_error_in_progress
429 && itimer->caller_thread)
431 /* Simulate a signal delivered to the thread which installed
432 the timer, by suspending that thread while the handler
433 runs. */
434 HANDLE th = itimer->caller_thread;
435 DWORD result = SuspendThread (th);
437 if (result == (DWORD)-1)
438 return 2;
440 handler (sig);
441 ResumeThread (th);
444 /* Update expiration time and loop. */
445 EnterCriticalSection (crit);
446 expire = itimer->expire;
447 if (expire == 0)
449 LeaveCriticalSection (crit);
450 continue;
452 reload = itimer->reload;
453 if (reload > 0)
455 now = w32_get_timer_time (hth);
456 if (expire <= now)
458 ULONGLONG lag = now - expire;
460 /* If we missed some opportunities (presumably while
461 sleeping or while the signal handler ran), skip
462 them. */
463 if (lag > reload)
464 expire = now - (lag % reload);
466 expire += reload;
469 else
470 expire = 0; /* become idle */
471 itimer->expire = expire;
472 LeaveCriticalSection (crit);
474 return 0;
477 static void
478 stop_timer_thread (int which)
480 struct itimer_data *itimer =
481 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
482 int i;
483 DWORD err, exit_code = 255;
484 BOOL status;
486 /* Signal the thread that it should terminate. */
487 itimer->terminate = 1;
489 if (itimer->timer_thread == NULL)
490 return;
492 /* Wait for the timer thread to terminate voluntarily, then kill it
493 if it doesn't. This loop waits twice more than the maximum
494 amount of time a timer thread sleeps, see above. */
495 for (i = 0; i < MAX_SINGLE_SLEEP / 5; i++)
497 if (!((status = GetExitCodeThread (itimer->timer_thread, &exit_code))
498 && exit_code == STILL_ACTIVE))
499 break;
500 Sleep (10);
502 if ((status == FALSE && (err = GetLastError ()) == ERROR_INVALID_HANDLE)
503 || exit_code == STILL_ACTIVE)
505 if (!(status == FALSE && err == ERROR_INVALID_HANDLE))
506 TerminateThread (itimer->timer_thread, 0);
509 /* Clean up. */
510 CloseHandle (itimer->timer_thread);
511 itimer->timer_thread = NULL;
512 if (itimer->caller_thread)
514 CloseHandle (itimer->caller_thread);
515 itimer->caller_thread = NULL;
519 /* This is called at shutdown time from term_ntproc. */
520 void
521 term_timers (void)
523 if (real_itimer.timer_thread)
524 stop_timer_thread (ITIMER_REAL);
525 if (prof_itimer.timer_thread)
526 stop_timer_thread (ITIMER_PROF);
528 /* We are going to delete the critical sections, so timers cannot
529 work after this. */
530 disable_itimers = 1;
532 DeleteCriticalSection (&crit_real);
533 DeleteCriticalSection (&crit_prof);
534 DeleteCriticalSection (&crit_sig);
537 /* This is called at initialization time from init_ntproc. */
538 void
539 init_timers (void)
541 /* GetThreadTimes is not available on all versions of Windows, so
542 need to probe for its availability dynamically, and call it
543 through a pointer. */
544 s_pfn_Get_Thread_Times = NULL; /* in case dumped Emacs comes with a value */
545 if (os_subtype != OS_9X)
546 s_pfn_Get_Thread_Times =
547 (GetThreadTimes_Proc)GetProcAddress (GetModuleHandle ("kernel32.dll"),
548 "GetThreadTimes");
550 /* Make sure we start with zeroed out itimer structures, since
551 dumping may have left there traces of threads long dead. */
552 memset (&real_itimer, 0, sizeof real_itimer);
553 memset (&prof_itimer, 0, sizeof prof_itimer);
555 InitializeCriticalSection (&crit_real);
556 InitializeCriticalSection (&crit_prof);
557 InitializeCriticalSection (&crit_sig);
559 disable_itimers = 0;
562 static int
563 start_timer_thread (int which)
565 DWORD exit_code;
566 HANDLE th;
567 struct itimer_data *itimer =
568 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
570 if (itimer->timer_thread
571 && GetExitCodeThread (itimer->timer_thread, &exit_code)
572 && exit_code == STILL_ACTIVE)
573 return 0;
575 /* Clean up after possibly exited thread. */
576 if (itimer->timer_thread)
578 CloseHandle (itimer->timer_thread);
579 itimer->timer_thread = NULL;
581 if (itimer->caller_thread)
583 CloseHandle (itimer->caller_thread);
584 itimer->caller_thread = NULL;
587 /* Start a new thread. */
588 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
589 GetCurrentProcess (), &th, 0, FALSE,
590 DUPLICATE_SAME_ACCESS))
592 errno = ESRCH;
593 return -1;
595 itimer->terminate = 0;
596 itimer->type = which;
597 itimer->caller_thread = th;
598 /* Request that no more than 64KB of stack be reserved for this
599 thread, to avoid reserving too much memory, which would get in
600 the way of threads we start to wait for subprocesses. See also
601 new_child below. */
602 itimer->timer_thread = CreateThread (NULL, 64 * 1024, timer_loop,
603 (void *)itimer, 0x00010000, NULL);
605 if (!itimer->timer_thread)
607 CloseHandle (itimer->caller_thread);
608 itimer->caller_thread = NULL;
609 errno = EAGAIN;
610 return -1;
613 /* This is needed to make sure that the timer thread running for
614 profiling gets CPU as soon as the Sleep call terminates. */
615 if (which == ITIMER_PROF)
616 SetThreadPriority (itimer->timer_thread, THREAD_PRIORITY_TIME_CRITICAL);
618 return 0;
621 /* Most of the code of getitimer and setitimer (but not of their
622 subroutines) was shamelessly stolen from itimer.c in the DJGPP
623 library, see www.delorie.com/djgpp. */
625 getitimer (int which, struct itimerval *value)
627 volatile ULONGLONG *t_expire;
628 volatile ULONGLONG *t_reload;
629 ULONGLONG expire, reload;
630 __int64 usecs;
631 CRITICAL_SECTION *crit;
632 struct itimer_data *itimer;
634 if (disable_itimers)
635 return -1;
637 if (!value)
639 errno = EFAULT;
640 return -1;
643 if (which != ITIMER_REAL && which != ITIMER_PROF)
645 errno = EINVAL;
646 return -1;
649 itimer = (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
651 ticks_now = w32_get_timer_time ((which == ITIMER_REAL)
652 ? NULL
653 : GetCurrentThread ());
655 t_expire = &itimer->expire;
656 t_reload = &itimer->reload;
657 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
659 EnterCriticalSection (crit);
660 reload = *t_reload;
661 expire = *t_expire;
662 LeaveCriticalSection (crit);
664 if (expire)
665 expire -= ticks_now;
667 value->it_value.tv_sec = expire / TIMER_TICKS_PER_SEC;
668 usecs =
669 (expire % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
670 value->it_value.tv_usec = usecs;
671 value->it_interval.tv_sec = reload / TIMER_TICKS_PER_SEC;
672 usecs =
673 (reload % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
674 value->it_interval.tv_usec= usecs;
676 return 0;
680 setitimer(int which, struct itimerval *value, struct itimerval *ovalue)
682 volatile ULONGLONG *t_expire, *t_reload;
683 ULONGLONG expire, reload, expire_old, reload_old;
684 __int64 usecs;
685 CRITICAL_SECTION *crit;
686 struct itimerval tem, *ptem;
688 if (disable_itimers)
689 return -1;
691 /* Posix systems expect timer values smaller than the resolution of
692 the system clock be rounded up to the clock resolution. First
693 time we are called, measure the clock tick resolution. */
694 if (!clocks_min)
696 ULONGLONG t1, t2;
698 for (t1 = w32_get_timer_time (NULL);
699 (t2 = w32_get_timer_time (NULL)) == t1; )
701 clocks_min = t2 - t1;
704 if (ovalue)
705 ptem = ovalue;
706 else
707 ptem = &tem;
709 if (getitimer (which, ptem)) /* also sets ticks_now */
710 return -1; /* errno already set */
712 t_expire =
713 (which == ITIMER_REAL) ? &real_itimer.expire : &prof_itimer.expire;
714 t_reload =
715 (which == ITIMER_REAL) ? &real_itimer.reload : &prof_itimer.reload;
717 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
719 if (!value
720 || (value->it_value.tv_sec == 0 && value->it_value.tv_usec == 0))
722 EnterCriticalSection (crit);
723 /* Disable the timer. */
724 *t_expire = 0;
725 *t_reload = 0;
726 LeaveCriticalSection (crit);
727 return 0;
730 reload = value->it_interval.tv_sec * TIMER_TICKS_PER_SEC;
732 usecs = value->it_interval.tv_usec;
733 if (value->it_interval.tv_sec == 0
734 && usecs && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
735 reload = clocks_min;
736 else
738 usecs *= TIMER_TICKS_PER_SEC;
739 reload += usecs / 1000000;
742 expire = value->it_value.tv_sec * TIMER_TICKS_PER_SEC;
743 usecs = value->it_value.tv_usec;
744 if (value->it_value.tv_sec == 0
745 && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
746 expire = clocks_min;
747 else
749 usecs *= TIMER_TICKS_PER_SEC;
750 expire += usecs / 1000000;
753 expire += ticks_now;
755 EnterCriticalSection (crit);
756 expire_old = *t_expire;
757 reload_old = *t_reload;
758 if (!(expire == expire_old && reload == reload_old))
760 *t_reload = reload;
761 *t_expire = expire;
763 LeaveCriticalSection (crit);
765 return start_timer_thread (which);
769 alarm (int seconds)
771 #ifdef HAVE_SETITIMER
772 struct itimerval new_values, old_values;
774 new_values.it_value.tv_sec = seconds;
775 new_values.it_value.tv_usec = 0;
776 new_values.it_interval.tv_sec = new_values.it_interval.tv_usec = 0;
778 if (setitimer (ITIMER_REAL, &new_values, &old_values) < 0)
779 return 0;
780 return old_values.it_value.tv_sec;
781 #else
782 return seconds;
783 #endif
786 /* Defined in <process.h> which conflicts with the local copy */
787 #define _P_NOWAIT 1
789 /* Child process management list. */
790 int child_proc_count = 0;
791 child_process child_procs[ MAX_CHILDREN ];
793 static DWORD WINAPI reader_thread (void *arg);
795 /* Find an unused process slot. */
796 child_process *
797 new_child (void)
799 child_process *cp;
800 DWORD id;
802 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
803 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
804 goto Initialize;
805 if (child_proc_count == MAX_CHILDREN)
807 DebPrint (("new_child: No vacant slots, looking for dead processes\n"));
808 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
809 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
811 DWORD status = 0;
813 if (!GetExitCodeProcess (cp->procinfo.hProcess, &status))
815 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
816 GetLastError (), cp->procinfo.dwProcessId));
817 status = STILL_ACTIVE;
819 if (status != STILL_ACTIVE
820 || WaitForSingleObject (cp->procinfo.hProcess, 0) == WAIT_OBJECT_0)
822 DebPrint (("new_child: Freeing slot of dead process %d\n",
823 cp->procinfo.dwProcessId));
824 CloseHandle (cp->procinfo.hProcess);
825 cp->procinfo.hProcess = NULL;
826 CloseHandle (cp->procinfo.hThread);
827 cp->procinfo.hThread = NULL;
828 goto Initialize;
832 if (child_proc_count == MAX_CHILDREN)
833 return NULL;
834 cp = &child_procs[child_proc_count++];
836 Initialize:
837 memset (cp, 0, sizeof (*cp));
838 cp->fd = -1;
839 cp->pid = -1;
840 cp->procinfo.hProcess = NULL;
841 cp->status = STATUS_READ_ERROR;
842 cp->input_file = NULL;
843 cp->pending_deletion = 0;
845 /* use manual reset event so that select() will function properly */
846 cp->char_avail = CreateEvent (NULL, TRUE, FALSE, NULL);
847 if (cp->char_avail)
849 cp->char_consumed = CreateEvent (NULL, FALSE, FALSE, NULL);
850 if (cp->char_consumed)
852 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
853 It means that the 64K stack we are requesting in the 2nd
854 argument is how much memory should be reserved for the
855 stack. If we don't use this flag, the memory requested
856 by the 2nd argument is the amount actually _committed_,
857 but Windows reserves 8MB of memory for each thread's
858 stack. (The 8MB figure comes from the -stack
859 command-line argument we pass to the linker when building
860 Emacs, but that's because we need a large stack for
861 Emacs's main thread.) Since we request 2GB of reserved
862 memory at startup (see w32heap.c), which is close to the
863 maximum memory available for a 32-bit process on Windows,
864 the 8MB reservation for each thread causes failures in
865 starting subprocesses, because we create a thread running
866 reader_thread for each subprocess. As 8MB of stack is
867 way too much for reader_thread, forcing Windows to
868 reserve less wins the day. */
869 cp->thrd = CreateThread (NULL, 64 * 1024, reader_thread, cp,
870 0x00010000, &id);
871 if (cp->thrd)
872 return cp;
875 delete_child (cp);
876 return NULL;
879 void
880 delete_child (child_process *cp)
882 int i;
884 /* Should not be deleting a child that is still needed. */
885 for (i = 0; i < MAXDESC; i++)
886 if (fd_info[i].cp == cp)
887 emacs_abort ();
889 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
890 return;
892 /* Delete the child's temporary input file, if any, that is pending
893 deletion. */
894 if (cp->input_file)
896 if (cp->pending_deletion)
898 if (unlink (cp->input_file))
899 DebPrint (("delete_child.unlink (%s) failed, errno: %d\n",
900 cp->input_file, errno));
901 cp->pending_deletion = 0;
903 xfree (cp->input_file);
904 cp->input_file = NULL;
907 /* reap thread if necessary */
908 if (cp->thrd)
910 DWORD rc;
912 if (GetExitCodeThread (cp->thrd, &rc) && rc == STILL_ACTIVE)
914 /* let the thread exit cleanly if possible */
915 cp->status = STATUS_READ_ERROR;
916 SetEvent (cp->char_consumed);
917 #if 0
918 /* We used to forcibly terminate the thread here, but it
919 is normally unnecessary, and in abnormal cases, the worst that
920 will happen is we have an extra idle thread hanging around
921 waiting for the zombie process. */
922 if (WaitForSingleObject (cp->thrd, 1000) != WAIT_OBJECT_0)
924 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
925 "with %lu for fd %ld\n", GetLastError (), cp->fd));
926 TerminateThread (cp->thrd, 0);
928 #endif
930 CloseHandle (cp->thrd);
931 cp->thrd = NULL;
933 if (cp->char_avail)
935 CloseHandle (cp->char_avail);
936 cp->char_avail = NULL;
938 if (cp->char_consumed)
940 CloseHandle (cp->char_consumed);
941 cp->char_consumed = NULL;
944 /* update child_proc_count (highest numbered slot in use plus one) */
945 if (cp == child_procs + child_proc_count - 1)
947 for (i = child_proc_count-1; i >= 0; i--)
948 if (CHILD_ACTIVE (&child_procs[i])
949 || child_procs[i].procinfo.hProcess != NULL)
951 child_proc_count = i + 1;
952 break;
955 if (i < 0)
956 child_proc_count = 0;
959 /* Find a child by pid. */
960 static child_process *
961 find_child_pid (DWORD pid)
963 child_process *cp;
965 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
966 if ((CHILD_ACTIVE (cp) || cp->procinfo.hProcess != NULL)
967 && pid == cp->pid)
968 return cp;
969 return NULL;
973 /* Thread proc for child process and socket reader threads. Each thread
974 is normally blocked until woken by select() to check for input by
975 reading one char. When the read completes, char_avail is signaled
976 to wake up the select emulator and the thread blocks itself again. */
977 static DWORD WINAPI
978 reader_thread (void *arg)
980 child_process *cp;
982 /* Our identity */
983 cp = (child_process *)arg;
985 /* We have to wait for the go-ahead before we can start */
986 if (cp == NULL
987 || WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0
988 || cp->fd < 0)
989 return 1;
991 for (;;)
993 int rc;
995 if (cp->fd >= 0 && fd_info[cp->fd].flags & FILE_LISTEN)
996 rc = _sys_wait_accept (cp->fd);
997 else
998 rc = _sys_read_ahead (cp->fd);
1000 /* Don't bother waiting for the event if we already have been
1001 told to exit by delete_child. */
1002 if (cp->status == STATUS_READ_ERROR || !cp->char_avail)
1003 break;
1005 /* The name char_avail is a misnomer - it really just means the
1006 read-ahead has completed, whether successfully or not. */
1007 if (!SetEvent (cp->char_avail))
1009 DebPrint (("reader_thread.SetEvent failed with %lu for fd %ld\n",
1010 GetLastError (), cp->fd));
1011 return 1;
1014 if (rc == STATUS_READ_ERROR)
1015 return 1;
1017 /* If the read died, the child has died so let the thread die */
1018 if (rc == STATUS_READ_FAILED)
1019 break;
1021 /* Don't bother waiting for the acknowledge if we already have
1022 been told to exit by delete_child. */
1023 if (cp->status == STATUS_READ_ERROR || !cp->char_consumed)
1024 break;
1026 /* Wait until our input is acknowledged before reading again */
1027 if (WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
1029 DebPrint (("reader_thread.WaitForSingleObject failed with "
1030 "%lu for fd %ld\n", GetLastError (), cp->fd));
1031 break;
1033 /* delete_child sets status to STATUS_READ_ERROR when it wants
1034 us to exit. */
1035 if (cp->status == STATUS_READ_ERROR)
1036 break;
1038 return 0;
1041 /* To avoid Emacs changing directory, we just record here the directory
1042 the new process should start in. This is set just before calling
1043 sys_spawnve, and is not generally valid at any other time. */
1044 static char * process_dir;
1046 static BOOL
1047 create_child (char *exe, char *cmdline, char *env, int is_gui_app,
1048 int * pPid, child_process *cp)
1050 STARTUPINFO start;
1051 SECURITY_ATTRIBUTES sec_attrs;
1052 #if 0
1053 SECURITY_DESCRIPTOR sec_desc;
1054 #endif
1055 DWORD flags;
1056 char dir[ MAXPATHLEN ];
1058 if (cp == NULL) emacs_abort ();
1060 memset (&start, 0, sizeof (start));
1061 start.cb = sizeof (start);
1063 #ifdef HAVE_NTGUI
1064 if (NILP (Vw32_start_process_show_window) && !is_gui_app)
1065 start.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
1066 else
1067 start.dwFlags = STARTF_USESTDHANDLES;
1068 start.wShowWindow = SW_HIDE;
1070 start.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
1071 start.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
1072 start.hStdError = GetStdHandle (STD_ERROR_HANDLE);
1073 #endif /* HAVE_NTGUI */
1075 #if 0
1076 /* Explicitly specify no security */
1077 if (!InitializeSecurityDescriptor (&sec_desc, SECURITY_DESCRIPTOR_REVISION))
1078 goto EH_Fail;
1079 if (!SetSecurityDescriptorDacl (&sec_desc, TRUE, NULL, FALSE))
1080 goto EH_Fail;
1081 #endif
1082 sec_attrs.nLength = sizeof (sec_attrs);
1083 sec_attrs.lpSecurityDescriptor = NULL /* &sec_desc */;
1084 sec_attrs.bInheritHandle = FALSE;
1086 strcpy (dir, process_dir);
1087 unixtodos_filename (dir);
1089 flags = (!NILP (Vw32_start_process_share_console)
1090 ? CREATE_NEW_PROCESS_GROUP
1091 : CREATE_NEW_CONSOLE);
1092 if (NILP (Vw32_start_process_inherit_error_mode))
1093 flags |= CREATE_DEFAULT_ERROR_MODE;
1094 if (!CreateProcess (exe, cmdline, &sec_attrs, NULL, TRUE,
1095 flags, env, dir, &start, &cp->procinfo))
1096 goto EH_Fail;
1098 cp->pid = (int) cp->procinfo.dwProcessId;
1100 /* Hack for Windows 95, which assigns large (ie negative) pids */
1101 if (cp->pid < 0)
1102 cp->pid = -cp->pid;
1104 *pPid = cp->pid;
1106 return TRUE;
1108 EH_Fail:
1109 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1110 return FALSE;
1113 /* create_child doesn't know what emacs' file handle will be for waiting
1114 on output from the child, so we need to make this additional call
1115 to register the handle with the process
1116 This way the select emulator knows how to match file handles with
1117 entries in child_procs. */
1118 void
1119 register_child (pid_t pid, int fd)
1121 child_process *cp;
1123 cp = find_child_pid ((DWORD)pid);
1124 if (cp == NULL)
1126 DebPrint (("register_child unable to find pid %lu\n", pid));
1127 return;
1130 #ifdef FULL_DEBUG
1131 DebPrint (("register_child registered fd %d with pid %lu\n", fd, pid));
1132 #endif
1134 cp->fd = fd;
1136 /* thread is initially blocked until select is called; set status so
1137 that select will release thread */
1138 cp->status = STATUS_READ_ACKNOWLEDGED;
1140 /* attach child_process to fd_info */
1141 if (fd_info[fd].cp != NULL)
1143 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd));
1144 emacs_abort ();
1147 fd_info[fd].cp = cp;
1150 /* Record INFILE as an input file for process PID. */
1151 void
1152 record_infile (pid_t pid, char *infile)
1154 child_process *cp;
1156 /* INFILE should never be NULL, since xstrdup would have signaled
1157 memory full condition in that case, see callproc.c where this
1158 function is called. */
1159 eassert (infile);
1161 cp = find_child_pid ((DWORD)pid);
1162 if (cp == NULL)
1164 DebPrint (("record_infile is unable to find pid %lu\n", pid));
1165 return;
1168 cp->input_file = infile;
1171 /* Mark the input file INFILE of the corresponding subprocess as
1172 temporary, to be deleted when the subprocess exits. */
1173 void
1174 record_pending_deletion (char *infile)
1176 child_process *cp;
1178 eassert (infile);
1180 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1181 if (CHILD_ACTIVE (cp)
1182 && cp->input_file && xstrcasecmp (cp->input_file, infile) == 0)
1184 cp->pending_deletion = 1;
1185 break;
1189 /* Called from waitpid when a process exits. */
1190 static void
1191 reap_subprocess (child_process *cp)
1193 if (cp->procinfo.hProcess)
1195 /* Reap the process */
1196 #ifdef FULL_DEBUG
1197 /* Process should have already died before we are called. */
1198 if (WaitForSingleObject (cp->procinfo.hProcess, 0) != WAIT_OBJECT_0)
1199 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp->fd));
1200 #endif
1201 CloseHandle (cp->procinfo.hProcess);
1202 cp->procinfo.hProcess = NULL;
1203 CloseHandle (cp->procinfo.hThread);
1204 cp->procinfo.hThread = NULL;
1207 /* If cp->fd was not closed yet, we might be still reading the
1208 process output, so don't free its resources just yet. The call
1209 to delete_child on behalf of this subprocess will be made by
1210 sys_read when the subprocess output is fully read. */
1211 if (cp->fd < 0)
1212 delete_child (cp);
1215 /* Wait for a child process specified by PID, or for any of our
1216 existing child processes (if PID is nonpositive) to die. When it
1217 does, close its handle. Return the pid of the process that died
1218 and fill in STATUS if non-NULL. */
1220 pid_t
1221 waitpid (pid_t pid, int *status, int options)
1223 DWORD active, retval;
1224 int nh;
1225 child_process *cp, *cps[MAX_CHILDREN];
1226 HANDLE wait_hnd[MAX_CHILDREN];
1227 DWORD timeout_ms;
1228 int dont_wait = (options & WNOHANG) != 0;
1230 nh = 0;
1231 /* According to Posix:
1233 PID = -1 means status is requested for any child process.
1235 PID > 0 means status is requested for a single child process
1236 whose pid is PID.
1238 PID = 0 means status is requested for any child process whose
1239 process group ID is equal to that of the calling process. But
1240 since Windows has only a limited support for process groups (only
1241 for console processes and only for the purposes of passing
1242 Ctrl-BREAK signal to them), and since we have no documented way
1243 of determining whether a given process belongs to our group, we
1244 treat 0 as -1.
1246 PID < -1 means status is requested for any child process whose
1247 process group ID is equal to the absolute value of PID. Again,
1248 since we don't support process groups, we treat that as -1. */
1249 if (pid > 0)
1251 int our_child = 0;
1253 /* We are requested to wait for a specific child. */
1254 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1256 /* Some child_procs might be sockets; ignore them. Also
1257 ignore subprocesses whose output is not yet completely
1258 read. */
1259 if (CHILD_ACTIVE (cp)
1260 && cp->procinfo.hProcess
1261 && cp->pid == pid)
1263 our_child = 1;
1264 break;
1267 if (our_child)
1269 if (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1271 wait_hnd[nh] = cp->procinfo.hProcess;
1272 cps[nh] = cp;
1273 nh++;
1275 else if (dont_wait)
1277 /* PID specifies our subprocess, but its status is not
1278 yet available. */
1279 return 0;
1282 if (nh == 0)
1284 /* No such child process, or nothing to wait for, so fail. */
1285 errno = ECHILD;
1286 return -1;
1289 else
1291 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1293 if (CHILD_ACTIVE (cp)
1294 && cp->procinfo.hProcess
1295 && (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0))
1297 wait_hnd[nh] = cp->procinfo.hProcess;
1298 cps[nh] = cp;
1299 nh++;
1302 if (nh == 0)
1304 /* Nothing to wait on, so fail. */
1305 errno = ECHILD;
1306 return -1;
1310 if (dont_wait)
1311 timeout_ms = 0;
1312 else
1313 timeout_ms = 1000; /* check for quit about once a second. */
1317 QUIT;
1318 active = WaitForMultipleObjects (nh, wait_hnd, FALSE, timeout_ms);
1319 } while (active == WAIT_TIMEOUT && !dont_wait);
1321 if (active == WAIT_FAILED)
1323 errno = EBADF;
1324 return -1;
1326 else if (active == WAIT_TIMEOUT && dont_wait)
1328 /* PID specifies our subprocess, but it didn't exit yet, so its
1329 status is not yet available. */
1330 #ifdef FULL_DEBUG
1331 DebPrint (("Wait: PID %d not reap yet\n", cp->pid));
1332 #endif
1333 return 0;
1335 else if (active >= WAIT_OBJECT_0
1336 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1338 active -= WAIT_OBJECT_0;
1340 else if (active >= WAIT_ABANDONED_0
1341 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1343 active -= WAIT_ABANDONED_0;
1345 else
1346 emacs_abort ();
1348 if (!GetExitCodeProcess (wait_hnd[active], &retval))
1350 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1351 GetLastError ()));
1352 retval = 1;
1354 if (retval == STILL_ACTIVE)
1356 /* Should never happen. */
1357 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1358 if (pid > 0 && dont_wait)
1359 return 0;
1360 errno = EINVAL;
1361 return -1;
1364 /* Massage the exit code from the process to match the format expected
1365 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1366 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1368 if (retval == STATUS_CONTROL_C_EXIT)
1369 retval = SIGINT;
1370 else
1371 retval <<= 8;
1373 if (pid > 0 && active != 0)
1374 emacs_abort ();
1375 cp = cps[active];
1376 pid = cp->pid;
1377 #ifdef FULL_DEBUG
1378 DebPrint (("Wait signaled with process pid %d\n", cp->pid));
1379 #endif
1381 if (status)
1382 *status = retval;
1383 reap_subprocess (cp);
1385 return pid;
1388 /* Old versions of w32api headers don't have separate 32-bit and
1389 64-bit defines, but the one they have matches the 32-bit variety. */
1390 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1391 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1392 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1393 #endif
1395 static void
1396 w32_executable_type (char * filename,
1397 int * is_dos_app,
1398 int * is_cygnus_app,
1399 int * is_gui_app)
1401 file_data executable;
1402 char * p;
1404 /* Default values in case we can't tell for sure. */
1405 *is_dos_app = FALSE;
1406 *is_cygnus_app = FALSE;
1407 *is_gui_app = FALSE;
1409 if (!open_input_file (&executable, filename))
1410 return;
1412 p = strrchr (filename, '.');
1414 /* We can only identify DOS .com programs from the extension. */
1415 if (p && xstrcasecmp (p, ".com") == 0)
1416 *is_dos_app = TRUE;
1417 else if (p && (xstrcasecmp (p, ".bat") == 0
1418 || xstrcasecmp (p, ".cmd") == 0))
1420 /* A DOS shell script - it appears that CreateProcess is happy to
1421 accept this (somewhat surprisingly); presumably it looks at
1422 COMSPEC to determine what executable to actually invoke.
1423 Therefore, we have to do the same here as well. */
1424 /* Actually, I think it uses the program association for that
1425 extension, which is defined in the registry. */
1426 p = egetenv ("COMSPEC");
1427 if (p)
1428 w32_executable_type (p, is_dos_app, is_cygnus_app, is_gui_app);
1430 else
1432 /* Look for DOS .exe signature - if found, we must also check that
1433 it isn't really a 16- or 32-bit Windows exe, since both formats
1434 start with a DOS program stub. Note that 16-bit Windows
1435 executables use the OS/2 1.x format. */
1437 IMAGE_DOS_HEADER * dos_header;
1438 IMAGE_NT_HEADERS * nt_header;
1440 dos_header = (PIMAGE_DOS_HEADER) executable.file_base;
1441 if (dos_header->e_magic != IMAGE_DOS_SIGNATURE)
1442 goto unwind;
1444 nt_header = (PIMAGE_NT_HEADERS) ((unsigned char *) dos_header + dos_header->e_lfanew);
1446 if ((char *) nt_header > (char *) dos_header + executable.size)
1448 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1449 *is_dos_app = TRUE;
1451 else if (nt_header->Signature != IMAGE_NT_SIGNATURE
1452 && LOWORD (nt_header->Signature) != IMAGE_OS2_SIGNATURE)
1454 *is_dos_app = TRUE;
1456 else if (nt_header->Signature == IMAGE_NT_SIGNATURE)
1458 IMAGE_DATA_DIRECTORY *data_dir = NULL;
1459 if (nt_header->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)
1461 /* Ensure we are using the 32 bit structure. */
1462 IMAGE_OPTIONAL_HEADER32 *opt
1463 = (IMAGE_OPTIONAL_HEADER32*) &(nt_header->OptionalHeader);
1464 data_dir = opt->DataDirectory;
1465 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1467 /* MingW 3.12 has the required 64 bit structs, but in case older
1468 versions don't, only check 64 bit exes if we know how. */
1469 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1470 else if (nt_header->OptionalHeader.Magic
1471 == IMAGE_NT_OPTIONAL_HDR64_MAGIC)
1473 IMAGE_OPTIONAL_HEADER64 *opt
1474 = (IMAGE_OPTIONAL_HEADER64*) &(nt_header->OptionalHeader);
1475 data_dir = opt->DataDirectory;
1476 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1478 #endif
1479 if (data_dir)
1481 /* Look for cygwin.dll in DLL import list. */
1482 IMAGE_DATA_DIRECTORY import_dir =
1483 data_dir[IMAGE_DIRECTORY_ENTRY_IMPORT];
1484 IMAGE_IMPORT_DESCRIPTOR * imports;
1485 IMAGE_SECTION_HEADER * section;
1487 section = rva_to_section (import_dir.VirtualAddress, nt_header);
1488 imports = RVA_TO_PTR (import_dir.VirtualAddress, section,
1489 executable);
1491 for ( ; imports->Name; imports++)
1493 char * dllname = RVA_TO_PTR (imports->Name, section,
1494 executable);
1496 /* The exact name of the cygwin dll has changed with
1497 various releases, but hopefully this will be reasonably
1498 future proof. */
1499 if (strncmp (dllname, "cygwin", 6) == 0)
1501 *is_cygnus_app = TRUE;
1502 break;
1509 unwind:
1510 close_file_data (&executable);
1513 static int
1514 compare_env (const void *strp1, const void *strp2)
1516 const char *str1 = *(const char **)strp1, *str2 = *(const char **)strp2;
1518 while (*str1 && *str2 && *str1 != '=' && *str2 != '=')
1520 /* Sort order in command.com/cmd.exe is based on uppercasing
1521 names, so do the same here. */
1522 if (toupper (*str1) > toupper (*str2))
1523 return 1;
1524 else if (toupper (*str1) < toupper (*str2))
1525 return -1;
1526 str1++, str2++;
1529 if (*str1 == '=' && *str2 == '=')
1530 return 0;
1531 else if (*str1 == '=')
1532 return -1;
1533 else
1534 return 1;
1537 static void
1538 merge_and_sort_env (char **envp1, char **envp2, char **new_envp)
1540 char **optr, **nptr;
1541 int num;
1543 nptr = new_envp;
1544 optr = envp1;
1545 while (*optr)
1546 *nptr++ = *optr++;
1547 num = optr - envp1;
1549 optr = envp2;
1550 while (*optr)
1551 *nptr++ = *optr++;
1552 num += optr - envp2;
1554 qsort (new_envp, num, sizeof (char *), compare_env);
1556 *nptr = NULL;
1559 /* When a new child process is created we need to register it in our list,
1560 so intercept spawn requests. */
1562 sys_spawnve (int mode, char *cmdname, char **argv, char **envp)
1564 Lisp_Object program, full;
1565 char *cmdline, *env, *parg, **targ;
1566 int arglen, numenv;
1567 pid_t pid;
1568 child_process *cp;
1569 int is_dos_app, is_cygnus_app, is_gui_app;
1570 int do_quoting = 0;
1571 /* We pass our process ID to our children by setting up an environment
1572 variable in their environment. */
1573 char ppid_env_var_buffer[64];
1574 char *extra_env[] = {ppid_env_var_buffer, NULL};
1575 /* These are the characters that cause an argument to need quoting.
1576 Arguments with whitespace characters need quoting to prevent the
1577 argument being split into two or more. Arguments with wildcards
1578 are also quoted, for consistency with posix platforms, where wildcards
1579 are not expanded if we run the program directly without a shell.
1580 Some extra whitespace characters need quoting in Cygwin programs,
1581 so this list is conditionally modified below. */
1582 char *sepchars = " \t*?";
1583 /* This is for native w32 apps; modified below for Cygwin apps. */
1584 char escape_char = '\\';
1586 /* We don't care about the other modes */
1587 if (mode != _P_NOWAIT)
1589 errno = EINVAL;
1590 return -1;
1593 /* Handle executable names without an executable suffix. */
1594 program = build_string (cmdname);
1595 if (NILP (Ffile_executable_p (program)))
1597 struct gcpro gcpro1;
1599 full = Qnil;
1600 GCPRO1 (program);
1601 openp (Vexec_path, program, Vexec_suffixes, &full, make_number (X_OK));
1602 UNGCPRO;
1603 if (NILP (full))
1605 errno = EINVAL;
1606 return -1;
1608 program = full;
1611 /* make sure argv[0] and cmdname are both in DOS format */
1612 cmdname = SDATA (program);
1613 unixtodos_filename (cmdname);
1614 argv[0] = cmdname;
1616 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1617 executable that is implicitly linked to the Cygnus dll (implying it
1618 was compiled with the Cygnus GNU toolchain and hence relies on
1619 cygwin.dll to parse the command line - we use this to decide how to
1620 escape quote chars in command line args that must be quoted).
1622 Also determine whether it is a GUI app, so that we don't hide its
1623 initial window unless specifically requested. */
1624 w32_executable_type (cmdname, &is_dos_app, &is_cygnus_app, &is_gui_app);
1626 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1627 application to start it by specifying the helper app as cmdname,
1628 while leaving the real app name as argv[0]. */
1629 if (is_dos_app)
1631 cmdname = alloca (MAXPATHLEN);
1632 if (egetenv ("CMDPROXY"))
1633 strcpy (cmdname, egetenv ("CMDPROXY"));
1634 else
1636 strcpy (cmdname, SDATA (Vinvocation_directory));
1637 strcat (cmdname, "cmdproxy.exe");
1639 unixtodos_filename (cmdname);
1642 /* we have to do some conjuring here to put argv and envp into the
1643 form CreateProcess wants... argv needs to be a space separated/null
1644 terminated list of parameters, and envp is a null
1645 separated/double-null terminated list of parameters.
1647 Additionally, zero-length args and args containing whitespace or
1648 quote chars need to be wrapped in double quotes - for this to work,
1649 embedded quotes need to be escaped as well. The aim is to ensure
1650 the child process reconstructs the argv array we start with
1651 exactly, so we treat quotes at the beginning and end of arguments
1652 as embedded quotes.
1654 The w32 GNU-based library from Cygnus doubles quotes to escape
1655 them, while MSVC uses backslash for escaping. (Actually the MSVC
1656 startup code does attempt to recognize doubled quotes and accept
1657 them, but gets it wrong and ends up requiring three quotes to get a
1658 single embedded quote!) So by default we decide whether to use
1659 quote or backslash as the escape character based on whether the
1660 binary is apparently a Cygnus compiled app.
1662 Note that using backslash to escape embedded quotes requires
1663 additional special handling if an embedded quote is already
1664 preceded by backslash, or if an arg requiring quoting ends with
1665 backslash. In such cases, the run of escape characters needs to be
1666 doubled. For consistency, we apply this special handling as long
1667 as the escape character is not quote.
1669 Since we have no idea how large argv and envp are likely to be we
1670 figure out list lengths on the fly and allocate them. */
1672 if (!NILP (Vw32_quote_process_args))
1674 do_quoting = 1;
1675 /* Override escape char by binding w32-quote-process-args to
1676 desired character, or use t for auto-selection. */
1677 if (INTEGERP (Vw32_quote_process_args))
1678 escape_char = XINT (Vw32_quote_process_args);
1679 else
1680 escape_char = is_cygnus_app ? '"' : '\\';
1683 /* Cygwin apps needs quoting a bit more often. */
1684 if (escape_char == '"')
1685 sepchars = "\r\n\t\f '";
1687 /* do argv... */
1688 arglen = 0;
1689 targ = argv;
1690 while (*targ)
1692 char * p = *targ;
1693 int need_quotes = 0;
1694 int escape_char_run = 0;
1696 if (*p == 0)
1697 need_quotes = 1;
1698 for ( ; *p; p++)
1700 if (escape_char == '"' && *p == '\\')
1701 /* If it's a Cygwin app, \ needs to be escaped. */
1702 arglen++;
1703 else if (*p == '"')
1705 /* allow for embedded quotes to be escaped */
1706 arglen++;
1707 need_quotes = 1;
1708 /* handle the case where the embedded quote is already escaped */
1709 if (escape_char_run > 0)
1711 /* To preserve the arg exactly, we need to double the
1712 preceding escape characters (plus adding one to
1713 escape the quote character itself). */
1714 arglen += escape_char_run;
1717 else if (strchr (sepchars, *p) != NULL)
1719 need_quotes = 1;
1722 if (*p == escape_char && escape_char != '"')
1723 escape_char_run++;
1724 else
1725 escape_char_run = 0;
1727 if (need_quotes)
1729 arglen += 2;
1730 /* handle the case where the arg ends with an escape char - we
1731 must not let the enclosing quote be escaped. */
1732 if (escape_char_run > 0)
1733 arglen += escape_char_run;
1735 arglen += strlen (*targ++) + 1;
1737 cmdline = alloca (arglen);
1738 targ = argv;
1739 parg = cmdline;
1740 while (*targ)
1742 char * p = *targ;
1743 int need_quotes = 0;
1745 if (*p == 0)
1746 need_quotes = 1;
1748 if (do_quoting)
1750 for ( ; *p; p++)
1751 if ((strchr (sepchars, *p) != NULL) || *p == '"')
1752 need_quotes = 1;
1754 if (need_quotes)
1756 int escape_char_run = 0;
1757 char * first;
1758 char * last;
1760 p = *targ;
1761 first = p;
1762 last = p + strlen (p) - 1;
1763 *parg++ = '"';
1764 #if 0
1765 /* This version does not escape quotes if they occur at the
1766 beginning or end of the arg - this could lead to incorrect
1767 behavior when the arg itself represents a command line
1768 containing quoted args. I believe this was originally done
1769 as a hack to make some things work, before
1770 `w32-quote-process-args' was added. */
1771 while (*p)
1773 if (*p == '"' && p > first && p < last)
1774 *parg++ = escape_char; /* escape embedded quotes */
1775 *parg++ = *p++;
1777 #else
1778 for ( ; *p; p++)
1780 if (*p == '"')
1782 /* double preceding escape chars if any */
1783 while (escape_char_run > 0)
1785 *parg++ = escape_char;
1786 escape_char_run--;
1788 /* escape all quote chars, even at beginning or end */
1789 *parg++ = escape_char;
1791 else if (escape_char == '"' && *p == '\\')
1792 *parg++ = '\\';
1793 *parg++ = *p;
1795 if (*p == escape_char && escape_char != '"')
1796 escape_char_run++;
1797 else
1798 escape_char_run = 0;
1800 /* double escape chars before enclosing quote */
1801 while (escape_char_run > 0)
1803 *parg++ = escape_char;
1804 escape_char_run--;
1806 #endif
1807 *parg++ = '"';
1809 else
1811 strcpy (parg, *targ);
1812 parg += strlen (*targ);
1814 *parg++ = ' ';
1815 targ++;
1817 *--parg = '\0';
1819 /* and envp... */
1820 arglen = 1;
1821 targ = envp;
1822 numenv = 1; /* for end null */
1823 while (*targ)
1825 arglen += strlen (*targ++) + 1;
1826 numenv++;
1828 /* extra env vars... */
1829 sprintf (ppid_env_var_buffer, "EM_PARENT_PROCESS_ID=%lu",
1830 GetCurrentProcessId ());
1831 arglen += strlen (ppid_env_var_buffer) + 1;
1832 numenv++;
1834 /* merge env passed in and extra env into one, and sort it. */
1835 targ = (char **) alloca (numenv * sizeof (char *));
1836 merge_and_sort_env (envp, extra_env, targ);
1838 /* concatenate env entries. */
1839 env = alloca (arglen);
1840 parg = env;
1841 while (*targ)
1843 strcpy (parg, *targ);
1844 parg += strlen (*targ++);
1845 *parg++ = '\0';
1847 *parg++ = '\0';
1848 *parg = '\0';
1850 cp = new_child ();
1851 if (cp == NULL)
1853 errno = EAGAIN;
1854 return -1;
1857 /* Now create the process. */
1858 if (!create_child (cmdname, cmdline, env, is_gui_app, &pid, cp))
1860 delete_child (cp);
1861 errno = ENOEXEC;
1862 return -1;
1865 return pid;
1868 /* Emulate the select call
1869 Wait for available input on any of the given rfds, or timeout if
1870 a timeout is given and no input is detected
1871 wfds and efds are not supported and must be NULL.
1873 For simplicity, we detect the death of child processes here and
1874 synchronously call the SIGCHLD handler. Since it is possible for
1875 children to be created without a corresponding pipe handle from which
1876 to read output, we wait separately on the process handles as well as
1877 the char_avail events for each process pipe. We only call
1878 wait/reap_process when the process actually terminates.
1880 To reduce the number of places in which Emacs can be hung such that
1881 C-g is not able to interrupt it, we always wait on interrupt_handle
1882 (which is signaled by the input thread when C-g is detected). If we
1883 detect that we were woken up by C-g, we return -1 with errno set to
1884 EINTR as on Unix. */
1886 /* From w32console.c */
1887 extern HANDLE keyboard_handle;
1889 /* From w32xfns.c */
1890 extern HANDLE interrupt_handle;
1892 /* From process.c */
1893 extern int proc_buffered_char[];
1896 sys_select (int nfds, SELECT_TYPE *rfds, SELECT_TYPE *wfds, SELECT_TYPE *efds,
1897 EMACS_TIME *timeout, void *ignored)
1899 SELECT_TYPE orfds;
1900 DWORD timeout_ms, start_time;
1901 int i, nh, nc, nr;
1902 DWORD active;
1903 child_process *cp, *cps[MAX_CHILDREN];
1904 HANDLE wait_hnd[MAXDESC + MAX_CHILDREN];
1905 int fdindex[MAXDESC]; /* mapping from wait handles back to descriptors */
1907 timeout_ms =
1908 timeout ? (timeout->tv_sec * 1000 + timeout->tv_nsec / 1000000) : INFINITE;
1910 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1911 if (rfds == NULL && wfds == NULL && efds == NULL && timeout != NULL)
1913 Sleep (timeout_ms);
1914 return 0;
1917 /* Otherwise, we only handle rfds, so fail otherwise. */
1918 if (rfds == NULL || wfds != NULL || efds != NULL)
1920 errno = EINVAL;
1921 return -1;
1924 orfds = *rfds;
1925 FD_ZERO (rfds);
1926 nr = 0;
1928 /* Always wait on interrupt_handle, to detect C-g (quit). */
1929 wait_hnd[0] = interrupt_handle;
1930 fdindex[0] = -1;
1932 /* Build a list of pipe handles to wait on. */
1933 nh = 1;
1934 for (i = 0; i < nfds; i++)
1935 if (FD_ISSET (i, &orfds))
1937 if (i == 0)
1939 if (keyboard_handle)
1941 /* Handle stdin specially */
1942 wait_hnd[nh] = keyboard_handle;
1943 fdindex[nh] = i;
1944 nh++;
1947 /* Check for any emacs-generated input in the queue since
1948 it won't be detected in the wait */
1949 if (detect_input_pending ())
1951 FD_SET (i, rfds);
1952 return 1;
1955 else
1957 /* Child process and socket/comm port input. */
1958 cp = fd_info[i].cp;
1959 if (cp)
1961 int current_status = cp->status;
1963 if (current_status == STATUS_READ_ACKNOWLEDGED)
1965 /* Tell reader thread which file handle to use. */
1966 cp->fd = i;
1967 /* Wake up the reader thread for this process */
1968 cp->status = STATUS_READ_READY;
1969 if (!SetEvent (cp->char_consumed))
1970 DebPrint (("sys_select.SetEvent failed with "
1971 "%lu for fd %ld\n", GetLastError (), i));
1974 #ifdef CHECK_INTERLOCK
1975 /* slightly crude cross-checking of interlock between threads */
1977 current_status = cp->status;
1978 if (WaitForSingleObject (cp->char_avail, 0) == WAIT_OBJECT_0)
1980 /* char_avail has been signaled, so status (which may
1981 have changed) should indicate read has completed
1982 but has not been acknowledged. */
1983 current_status = cp->status;
1984 if (current_status != STATUS_READ_SUCCEEDED
1985 && current_status != STATUS_READ_FAILED)
1986 DebPrint (("char_avail set, but read not completed: status %d\n",
1987 current_status));
1989 else
1991 /* char_avail has not been signaled, so status should
1992 indicate that read is in progress; small possibility
1993 that read has completed but event wasn't yet signaled
1994 when we tested it (because a context switch occurred
1995 or if running on separate CPUs). */
1996 if (current_status != STATUS_READ_READY
1997 && current_status != STATUS_READ_IN_PROGRESS
1998 && current_status != STATUS_READ_SUCCEEDED
1999 && current_status != STATUS_READ_FAILED)
2000 DebPrint (("char_avail reset, but read status is bad: %d\n",
2001 current_status));
2003 #endif
2004 wait_hnd[nh] = cp->char_avail;
2005 fdindex[nh] = i;
2006 if (!wait_hnd[nh]) emacs_abort ();
2007 nh++;
2008 #ifdef FULL_DEBUG
2009 DebPrint (("select waiting on child %d fd %d\n",
2010 cp-child_procs, i));
2011 #endif
2013 else
2015 /* Unable to find something to wait on for this fd, skip */
2017 /* Note that this is not a fatal error, and can in fact
2018 happen in unusual circumstances. Specifically, if
2019 sys_spawnve fails, eg. because the program doesn't
2020 exist, and debug-on-error is t so Fsignal invokes a
2021 nested input loop, then the process output pipe is
2022 still included in input_wait_mask with no child_proc
2023 associated with it. (It is removed when the debugger
2024 exits the nested input loop and the error is thrown.) */
2026 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i));
2031 count_children:
2032 /* Add handles of child processes. */
2033 nc = 0;
2034 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
2035 /* Some child_procs might be sockets; ignore them. Also some
2036 children may have died already, but we haven't finished reading
2037 the process output; ignore them too. */
2038 if (CHILD_ACTIVE (cp) && cp->procinfo.hProcess
2039 && (cp->fd < 0
2040 || (fd_info[cp->fd].flags & FILE_SEND_SIGCHLD) == 0
2041 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
2044 wait_hnd[nh + nc] = cp->procinfo.hProcess;
2045 cps[nc] = cp;
2046 nc++;
2049 /* Nothing to look for, so we didn't find anything */
2050 if (nh + nc == 0)
2052 if (timeout)
2053 Sleep (timeout_ms);
2054 return 0;
2057 start_time = GetTickCount ();
2059 /* Wait for input or child death to be signaled. If user input is
2060 allowed, then also accept window messages. */
2061 if (FD_ISSET (0, &orfds))
2062 active = MsgWaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms,
2063 QS_ALLINPUT);
2064 else
2065 active = WaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms);
2067 if (active == WAIT_FAILED)
2069 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2070 nh + nc, timeout_ms, GetLastError ()));
2071 /* don't return EBADF - this causes wait_reading_process_output to
2072 abort; WAIT_FAILED is returned when single-stepping under
2073 Windows 95 after switching thread focus in debugger, and
2074 possibly at other times. */
2075 errno = EINTR;
2076 return -1;
2078 else if (active == WAIT_TIMEOUT)
2080 return 0;
2082 else if (active >= WAIT_OBJECT_0
2083 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
2085 active -= WAIT_OBJECT_0;
2087 else if (active >= WAIT_ABANDONED_0
2088 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
2090 active -= WAIT_ABANDONED_0;
2092 else
2093 emacs_abort ();
2095 /* Loop over all handles after active (now officially documented as
2096 being the first signaled handle in the array). We do this to
2097 ensure fairness, so that all channels with data available will be
2098 processed - otherwise higher numbered channels could be starved. */
2101 if (active == nh + nc)
2103 /* There are messages in the lisp thread's queue; we must
2104 drain the queue now to ensure they are processed promptly,
2105 because if we don't do so, we will not be woken again until
2106 further messages arrive.
2108 NB. If ever we allow window message procedures to callback
2109 into lisp, we will need to ensure messages are dispatched
2110 at a safe time for lisp code to be run (*), and we may also
2111 want to provide some hooks in the dispatch loop to cater
2112 for modeless dialogs created by lisp (ie. to register
2113 window handles to pass to IsDialogMessage).
2115 (*) Note that MsgWaitForMultipleObjects above is an
2116 internal dispatch point for messages that are sent to
2117 windows created by this thread. */
2118 if (drain_message_queue ()
2119 /* If drain_message_queue returns non-zero, that means
2120 we received a WM_EMACS_FILENOTIFY message. If this
2121 is a TTY frame, we must signal the caller that keyboard
2122 input is available, so that w32_console_read_socket
2123 will be called to pick up the notifications. If we
2124 don't do that, file notifications will only work when
2125 the Emacs TTY frame has focus. */
2126 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2127 /* they asked for stdin reads */
2128 && FD_ISSET (0, &orfds)
2129 /* the stdin handle is valid */
2130 && keyboard_handle)
2132 FD_SET (0, rfds);
2133 if (nr == 0)
2134 nr = 1;
2137 else if (active >= nh)
2139 cp = cps[active - nh];
2141 /* We cannot always signal SIGCHLD immediately; if we have not
2142 finished reading the process output, we must delay sending
2143 SIGCHLD until we do. */
2145 if (cp->fd >= 0 && (fd_info[cp->fd].flags & FILE_AT_EOF) == 0)
2146 fd_info[cp->fd].flags |= FILE_SEND_SIGCHLD;
2147 /* SIG_DFL for SIGCHLD is ignore */
2148 else if (sig_handlers[SIGCHLD] != SIG_DFL &&
2149 sig_handlers[SIGCHLD] != SIG_IGN)
2151 #ifdef FULL_DEBUG
2152 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2153 cp->pid));
2154 #endif
2155 sig_handlers[SIGCHLD] (SIGCHLD);
2158 else if (fdindex[active] == -1)
2160 /* Quit (C-g) was detected. */
2161 errno = EINTR;
2162 return -1;
2164 else if (fdindex[active] == 0)
2166 /* Keyboard input available */
2167 FD_SET (0, rfds);
2168 nr++;
2170 else
2172 /* must be a socket or pipe - read ahead should have
2173 completed, either succeeding or failing. */
2174 FD_SET (fdindex[active], rfds);
2175 nr++;
2178 /* Even though wait_reading_process_output only reads from at most
2179 one channel, we must process all channels here so that we reap
2180 all children that have died. */
2181 while (++active < nh + nc)
2182 if (WaitForSingleObject (wait_hnd[active], 0) == WAIT_OBJECT_0)
2183 break;
2184 } while (active < nh + nc);
2186 /* If no input has arrived and timeout hasn't expired, wait again. */
2187 if (nr == 0)
2189 DWORD elapsed = GetTickCount () - start_time;
2191 if (timeout_ms > elapsed) /* INFINITE is MAX_UINT */
2193 if (timeout_ms != INFINITE)
2194 timeout_ms -= elapsed;
2195 goto count_children;
2199 return nr;
2202 /* Substitute for certain kill () operations */
2204 static BOOL CALLBACK
2205 find_child_console (HWND hwnd, LPARAM arg)
2207 child_process * cp = (child_process *) arg;
2208 DWORD thread_id;
2209 DWORD process_id;
2211 thread_id = GetWindowThreadProcessId (hwnd, &process_id);
2212 if (process_id == cp->procinfo.dwProcessId)
2214 char window_class[32];
2216 GetClassName (hwnd, window_class, sizeof (window_class));
2217 if (strcmp (window_class,
2218 (os_subtype == OS_9X)
2219 ? "tty"
2220 : "ConsoleWindowClass") == 0)
2222 cp->hwnd = hwnd;
2223 return FALSE;
2226 /* keep looking */
2227 return TRUE;
2230 /* Emulate 'kill', but only for other processes. */
2232 sys_kill (pid_t pid, int sig)
2234 child_process *cp;
2235 HANDLE proc_hand;
2236 int need_to_free = 0;
2237 int rc = 0;
2239 /* Each process is in its own process group. */
2240 if (pid < 0)
2241 pid = -pid;
2243 /* Only handle signals that will result in the process dying */
2244 if (sig != SIGINT && sig != SIGKILL && sig != SIGQUIT && sig != SIGHUP)
2246 errno = EINVAL;
2247 return -1;
2250 cp = find_child_pid (pid);
2251 if (cp == NULL)
2253 /* We were passed a PID of something other than our subprocess.
2254 If that is our own PID, we will send to ourself a message to
2255 close the selected frame, which does not necessarily
2256 terminates Emacs. But then we are not supposed to call
2257 sys_kill with our own PID. */
2258 proc_hand = OpenProcess (PROCESS_TERMINATE, 0, pid);
2259 if (proc_hand == NULL)
2261 errno = EPERM;
2262 return -1;
2264 need_to_free = 1;
2266 else
2268 proc_hand = cp->procinfo.hProcess;
2269 pid = cp->procinfo.dwProcessId;
2271 /* Try to locate console window for process. */
2272 EnumWindows (find_child_console, (LPARAM) cp);
2275 if (sig == SIGINT || sig == SIGQUIT)
2277 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2279 BYTE control_scan_code = (BYTE) MapVirtualKey (VK_CONTROL, 0);
2280 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2281 BYTE vk_break_code = (sig == SIGINT) ? 'C' : VK_CANCEL;
2282 BYTE break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2283 HWND foreground_window;
2285 if (break_scan_code == 0)
2287 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2288 vk_break_code = 'C';
2289 break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2292 foreground_window = GetForegroundWindow ();
2293 if (foreground_window)
2295 /* NT 5.0, and apparently also Windows 98, will not allow
2296 a Window to be set to foreground directly without the
2297 user's involvement. The workaround is to attach
2298 ourselves to the thread that owns the foreground
2299 window, since that is the only thread that can set the
2300 foreground window. */
2301 DWORD foreground_thread, child_thread;
2302 foreground_thread =
2303 GetWindowThreadProcessId (foreground_window, NULL);
2304 if (foreground_thread == GetCurrentThreadId ()
2305 || !AttachThreadInput (GetCurrentThreadId (),
2306 foreground_thread, TRUE))
2307 foreground_thread = 0;
2309 child_thread = GetWindowThreadProcessId (cp->hwnd, NULL);
2310 if (child_thread == GetCurrentThreadId ()
2311 || !AttachThreadInput (GetCurrentThreadId (),
2312 child_thread, TRUE))
2313 child_thread = 0;
2315 /* Set the foreground window to the child. */
2316 if (SetForegroundWindow (cp->hwnd))
2318 /* Generate keystrokes as if user had typed Ctrl-Break or
2319 Ctrl-C. */
2320 keybd_event (VK_CONTROL, control_scan_code, 0, 0);
2321 keybd_event (vk_break_code, break_scan_code,
2322 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY), 0);
2323 keybd_event (vk_break_code, break_scan_code,
2324 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY)
2325 | KEYEVENTF_KEYUP, 0);
2326 keybd_event (VK_CONTROL, control_scan_code,
2327 KEYEVENTF_KEYUP, 0);
2329 /* Sleep for a bit to give time for Emacs frame to respond
2330 to focus change events (if Emacs was active app). */
2331 Sleep (100);
2333 SetForegroundWindow (foreground_window);
2335 /* Detach from the foreground and child threads now that
2336 the foreground switching is over. */
2337 if (foreground_thread)
2338 AttachThreadInput (GetCurrentThreadId (),
2339 foreground_thread, FALSE);
2340 if (child_thread)
2341 AttachThreadInput (GetCurrentThreadId (),
2342 child_thread, FALSE);
2345 /* Ctrl-Break is NT equivalent of SIGINT. */
2346 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT, pid))
2348 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2349 "for pid %lu\n", GetLastError (), pid));
2350 errno = EINVAL;
2351 rc = -1;
2354 else
2356 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2358 #if 1
2359 if (os_subtype == OS_9X)
2362 Another possibility is to try terminating the VDM out-right by
2363 calling the Shell VxD (id 0x17) V86 interface, function #4
2364 "SHELL_Destroy_VM", ie.
2366 mov edx,4
2367 mov ebx,vm_handle
2368 call shellapi
2370 First need to determine the current VM handle, and then arrange for
2371 the shellapi call to be made from the system vm (by using
2372 Switch_VM_and_callback).
2374 Could try to invoke DestroyVM through CallVxD.
2377 #if 0
2378 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2379 to hang when cmdproxy is used in conjunction with
2380 command.com for an interactive shell. Posting
2381 WM_CLOSE pops up a dialog that, when Yes is selected,
2382 does the same thing. TerminateProcess is also less
2383 than ideal in that subprocesses tend to stick around
2384 until the machine is shutdown, but at least it
2385 doesn't freeze the 16-bit subsystem. */
2386 PostMessage (cp->hwnd, WM_QUIT, 0xff, 0);
2387 #endif
2388 if (!TerminateProcess (proc_hand, 0xff))
2390 DebPrint (("sys_kill.TerminateProcess returned %d "
2391 "for pid %lu\n", GetLastError (), pid));
2392 errno = EINVAL;
2393 rc = -1;
2396 else
2397 #endif
2398 PostMessage (cp->hwnd, WM_CLOSE, 0, 0);
2400 /* Kill the process. On W32 this doesn't kill child processes
2401 so it doesn't work very well for shells which is why it's not
2402 used in every case. */
2403 else if (!TerminateProcess (proc_hand, 0xff))
2405 DebPrint (("sys_kill.TerminateProcess returned %d "
2406 "for pid %lu\n", GetLastError (), pid));
2407 errno = EINVAL;
2408 rc = -1;
2412 if (need_to_free)
2413 CloseHandle (proc_hand);
2415 return rc;
2418 /* The following two routines are used to manipulate stdin, stdout, and
2419 stderr of our child processes.
2421 Assuming that in, out, and err are *not* inheritable, we make them
2422 stdin, stdout, and stderr of the child as follows:
2424 - Save the parent's current standard handles.
2425 - Set the std handles to inheritable duplicates of the ones being passed in.
2426 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2427 NT file handle for a crt file descriptor.)
2428 - Spawn the child, which inherits in, out, and err as stdin,
2429 stdout, and stderr. (see Spawnve)
2430 - Close the std handles passed to the child.
2431 - Reset the parent's standard handles to the saved handles.
2432 (see reset_standard_handles)
2433 We assume that the caller closes in, out, and err after calling us. */
2435 void
2436 prepare_standard_handles (int in, int out, int err, HANDLE handles[3])
2438 HANDLE parent;
2439 HANDLE newstdin, newstdout, newstderr;
2441 parent = GetCurrentProcess ();
2443 handles[0] = GetStdHandle (STD_INPUT_HANDLE);
2444 handles[1] = GetStdHandle (STD_OUTPUT_HANDLE);
2445 handles[2] = GetStdHandle (STD_ERROR_HANDLE);
2447 /* make inheritable copies of the new handles */
2448 if (!DuplicateHandle (parent,
2449 (HANDLE) _get_osfhandle (in),
2450 parent,
2451 &newstdin,
2453 TRUE,
2454 DUPLICATE_SAME_ACCESS))
2455 report_file_error ("Duplicating input handle for child", Qnil);
2457 if (!DuplicateHandle (parent,
2458 (HANDLE) _get_osfhandle (out),
2459 parent,
2460 &newstdout,
2462 TRUE,
2463 DUPLICATE_SAME_ACCESS))
2464 report_file_error ("Duplicating output handle for child", Qnil);
2466 if (!DuplicateHandle (parent,
2467 (HANDLE) _get_osfhandle (err),
2468 parent,
2469 &newstderr,
2471 TRUE,
2472 DUPLICATE_SAME_ACCESS))
2473 report_file_error ("Duplicating error handle for child", Qnil);
2475 /* and store them as our std handles */
2476 if (!SetStdHandle (STD_INPUT_HANDLE, newstdin))
2477 report_file_error ("Changing stdin handle", Qnil);
2479 if (!SetStdHandle (STD_OUTPUT_HANDLE, newstdout))
2480 report_file_error ("Changing stdout handle", Qnil);
2482 if (!SetStdHandle (STD_ERROR_HANDLE, newstderr))
2483 report_file_error ("Changing stderr handle", Qnil);
2486 void
2487 reset_standard_handles (int in, int out, int err, HANDLE handles[3])
2489 /* close the duplicated handles passed to the child */
2490 CloseHandle (GetStdHandle (STD_INPUT_HANDLE));
2491 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE));
2492 CloseHandle (GetStdHandle (STD_ERROR_HANDLE));
2494 /* now restore parent's saved std handles */
2495 SetStdHandle (STD_INPUT_HANDLE, handles[0]);
2496 SetStdHandle (STD_OUTPUT_HANDLE, handles[1]);
2497 SetStdHandle (STD_ERROR_HANDLE, handles[2]);
2500 void
2501 set_process_dir (char * dir)
2503 process_dir = dir;
2506 /* To avoid problems with winsock implementations that work over dial-up
2507 connections causing or requiring a connection to exist while Emacs is
2508 running, Emacs no longer automatically loads winsock on startup if it
2509 is present. Instead, it will be loaded when open-network-stream is
2510 first called.
2512 To allow full control over when winsock is loaded, we provide these
2513 two functions to dynamically load and unload winsock. This allows
2514 dial-up users to only be connected when they actually need to use
2515 socket services. */
2517 /* From w32.c */
2518 extern HANDLE winsock_lib;
2519 extern BOOL term_winsock (void);
2520 extern BOOL init_winsock (int load_now);
2522 DEFUN ("w32-has-winsock", Fw32_has_winsock, Sw32_has_winsock, 0, 1, 0,
2523 doc: /* Test for presence of the Windows socket library `winsock'.
2524 Returns non-nil if winsock support is present, nil otherwise.
2526 If the optional argument LOAD-NOW is non-nil, the winsock library is
2527 also loaded immediately if not already loaded. If winsock is loaded,
2528 the winsock local hostname is returned (since this may be different from
2529 the value of `system-name' and should supplant it), otherwise t is
2530 returned to indicate winsock support is present. */)
2531 (Lisp_Object load_now)
2533 int have_winsock;
2535 have_winsock = init_winsock (!NILP (load_now));
2536 if (have_winsock)
2538 if (winsock_lib != NULL)
2540 /* Return new value for system-name. The best way to do this
2541 is to call init_system_name, saving and restoring the
2542 original value to avoid side-effects. */
2543 Lisp_Object orig_hostname = Vsystem_name;
2544 Lisp_Object hostname;
2546 init_system_name ();
2547 hostname = Vsystem_name;
2548 Vsystem_name = orig_hostname;
2549 return hostname;
2551 return Qt;
2553 return Qnil;
2556 DEFUN ("w32-unload-winsock", Fw32_unload_winsock, Sw32_unload_winsock,
2557 0, 0, 0,
2558 doc: /* Unload the Windows socket library `winsock' if loaded.
2559 This is provided to allow dial-up socket connections to be disconnected
2560 when no longer needed. Returns nil without unloading winsock if any
2561 socket connections still exist. */)
2562 (void)
2564 return term_winsock () ? Qt : Qnil;
2568 /* Some miscellaneous functions that are Windows specific, but not GUI
2569 specific (ie. are applicable in terminal or batch mode as well). */
2571 DEFUN ("w32-short-file-name", Fw32_short_file_name, Sw32_short_file_name, 1, 1, 0,
2572 doc: /* Return the short file name version (8.3) of the full path of FILENAME.
2573 If FILENAME does not exist, return nil.
2574 All path elements in FILENAME are converted to their short names. */)
2575 (Lisp_Object filename)
2577 char shortname[MAX_PATH];
2579 CHECK_STRING (filename);
2581 /* first expand it. */
2582 filename = Fexpand_file_name (filename, Qnil);
2584 /* luckily, this returns the short version of each element in the path. */
2585 if (GetShortPathName (SDATA (ENCODE_FILE (filename)), shortname, MAX_PATH) == 0)
2586 return Qnil;
2588 dostounix_filename (shortname, 0);
2590 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2591 return build_string (shortname);
2595 DEFUN ("w32-long-file-name", Fw32_long_file_name, Sw32_long_file_name,
2596 1, 1, 0,
2597 doc: /* Return the long file name version of the full path of FILENAME.
2598 If FILENAME does not exist, return nil.
2599 All path elements in FILENAME are converted to their long names. */)
2600 (Lisp_Object filename)
2602 char longname[ MAX_PATH ];
2603 int drive_only = 0;
2605 CHECK_STRING (filename);
2607 if (SBYTES (filename) == 2
2608 && *(SDATA (filename) + 1) == ':')
2609 drive_only = 1;
2611 /* first expand it. */
2612 filename = Fexpand_file_name (filename, Qnil);
2614 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename)), longname, MAX_PATH))
2615 return Qnil;
2617 dostounix_filename (longname, 0);
2619 /* If we were passed only a drive, make sure that a slash is not appended
2620 for consistency with directories. Allow for drive mapping via SUBST
2621 in case expand-file-name is ever changed to expand those. */
2622 if (drive_only && longname[1] == ':' && longname[2] == '/' && !longname[3])
2623 longname[2] = '\0';
2625 return DECODE_FILE (build_string (longname));
2628 DEFUN ("w32-set-process-priority", Fw32_set_process_priority,
2629 Sw32_set_process_priority, 2, 2, 0,
2630 doc: /* Set the priority of PROCESS to PRIORITY.
2631 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2632 priority of the process whose pid is PROCESS is changed.
2633 PRIORITY should be one of the symbols high, normal, or low;
2634 any other symbol will be interpreted as normal.
2636 If successful, the return value is t, otherwise nil. */)
2637 (Lisp_Object process, Lisp_Object priority)
2639 HANDLE proc_handle = GetCurrentProcess ();
2640 DWORD priority_class = NORMAL_PRIORITY_CLASS;
2641 Lisp_Object result = Qnil;
2643 CHECK_SYMBOL (priority);
2645 if (!NILP (process))
2647 DWORD pid;
2648 child_process *cp;
2650 CHECK_NUMBER (process);
2652 /* Allow pid to be an internally generated one, or one obtained
2653 externally. This is necessary because real pids on Windows 95 are
2654 negative. */
2656 pid = XINT (process);
2657 cp = find_child_pid (pid);
2658 if (cp != NULL)
2659 pid = cp->procinfo.dwProcessId;
2661 proc_handle = OpenProcess (PROCESS_SET_INFORMATION, FALSE, pid);
2664 if (EQ (priority, Qhigh))
2665 priority_class = HIGH_PRIORITY_CLASS;
2666 else if (EQ (priority, Qlow))
2667 priority_class = IDLE_PRIORITY_CLASS;
2669 if (proc_handle != NULL)
2671 if (SetPriorityClass (proc_handle, priority_class))
2672 result = Qt;
2673 if (!NILP (process))
2674 CloseHandle (proc_handle);
2677 return result;
2680 #ifdef HAVE_LANGINFO_CODESET
2681 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2682 char *
2683 nl_langinfo (nl_item item)
2685 /* Conversion of Posix item numbers to their Windows equivalents. */
2686 static const LCTYPE w32item[] = {
2687 LOCALE_IDEFAULTANSICODEPAGE,
2688 LOCALE_SDAYNAME1, LOCALE_SDAYNAME2, LOCALE_SDAYNAME3,
2689 LOCALE_SDAYNAME4, LOCALE_SDAYNAME5, LOCALE_SDAYNAME6, LOCALE_SDAYNAME7,
2690 LOCALE_SMONTHNAME1, LOCALE_SMONTHNAME2, LOCALE_SMONTHNAME3,
2691 LOCALE_SMONTHNAME4, LOCALE_SMONTHNAME5, LOCALE_SMONTHNAME6,
2692 LOCALE_SMONTHNAME7, LOCALE_SMONTHNAME8, LOCALE_SMONTHNAME9,
2693 LOCALE_SMONTHNAME10, LOCALE_SMONTHNAME11, LOCALE_SMONTHNAME12
2696 static char *nl_langinfo_buf = NULL;
2697 static int nl_langinfo_len = 0;
2699 if (nl_langinfo_len <= 0)
2700 nl_langinfo_buf = xmalloc (nl_langinfo_len = 1);
2702 if (item < 0 || item >= _NL_NUM)
2703 nl_langinfo_buf[0] = 0;
2704 else
2706 LCID cloc = GetThreadLocale ();
2707 int need_len = GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2708 NULL, 0);
2710 if (need_len <= 0)
2711 nl_langinfo_buf[0] = 0;
2712 else
2714 if (item == CODESET)
2716 need_len += 2; /* for the "cp" prefix */
2717 if (need_len < 8) /* for the case we call GetACP */
2718 need_len = 8;
2720 if (nl_langinfo_len <= need_len)
2721 nl_langinfo_buf = xrealloc (nl_langinfo_buf,
2722 nl_langinfo_len = need_len);
2723 if (!GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2724 nl_langinfo_buf, nl_langinfo_len))
2725 nl_langinfo_buf[0] = 0;
2726 else if (item == CODESET)
2728 if (strcmp (nl_langinfo_buf, "0") == 0 /* CP_ACP */
2729 || strcmp (nl_langinfo_buf, "1") == 0) /* CP_OEMCP */
2730 sprintf (nl_langinfo_buf, "cp%u", GetACP ());
2731 else
2733 memmove (nl_langinfo_buf + 2, nl_langinfo_buf,
2734 strlen (nl_langinfo_buf) + 1);
2735 nl_langinfo_buf[0] = 'c';
2736 nl_langinfo_buf[1] = 'p';
2741 return nl_langinfo_buf;
2743 #endif /* HAVE_LANGINFO_CODESET */
2745 DEFUN ("w32-get-locale-info", Fw32_get_locale_info,
2746 Sw32_get_locale_info, 1, 2, 0,
2747 doc: /* Return information about the Windows locale LCID.
2748 By default, return a three letter locale code which encodes the default
2749 language as the first two characters, and the country or regional variant
2750 as the third letter. For example, ENU refers to `English (United States)',
2751 while ENC means `English (Canadian)'.
2753 If the optional argument LONGFORM is t, the long form of the locale
2754 name is returned, e.g. `English (United States)' instead; if LONGFORM
2755 is a number, it is interpreted as an LCTYPE constant and the corresponding
2756 locale information is returned.
2758 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2759 (Lisp_Object lcid, Lisp_Object longform)
2761 int got_abbrev;
2762 int got_full;
2763 char abbrev_name[32] = { 0 };
2764 char full_name[256] = { 0 };
2766 CHECK_NUMBER (lcid);
2768 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2769 return Qnil;
2771 if (NILP (longform))
2773 got_abbrev = GetLocaleInfo (XINT (lcid),
2774 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
2775 abbrev_name, sizeof (abbrev_name));
2776 if (got_abbrev)
2777 return build_string (abbrev_name);
2779 else if (EQ (longform, Qt))
2781 got_full = GetLocaleInfo (XINT (lcid),
2782 LOCALE_SLANGUAGE | LOCALE_USE_CP_ACP,
2783 full_name, sizeof (full_name));
2784 if (got_full)
2785 return DECODE_SYSTEM (build_string (full_name));
2787 else if (NUMBERP (longform))
2789 got_full = GetLocaleInfo (XINT (lcid),
2790 XINT (longform),
2791 full_name, sizeof (full_name));
2792 /* GetLocaleInfo's return value includes the terminating null
2793 character, when the returned information is a string, whereas
2794 make_unibyte_string needs the string length without the
2795 terminating null. */
2796 if (got_full)
2797 return make_unibyte_string (full_name, got_full - 1);
2800 return Qnil;
2804 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id,
2805 Sw32_get_current_locale_id, 0, 0, 0,
2806 doc: /* Return Windows locale id for current locale setting.
2807 This is a numerical value; use `w32-get-locale-info' to convert to a
2808 human-readable form. */)
2809 (void)
2811 return make_number (GetThreadLocale ());
2814 static DWORD
2815 int_from_hex (char * s)
2817 DWORD val = 0;
2818 static char hex[] = "0123456789abcdefABCDEF";
2819 char * p;
2821 while (*s && (p = strchr (hex, *s)) != NULL)
2823 unsigned digit = p - hex;
2824 if (digit > 15)
2825 digit -= 6;
2826 val = val * 16 + digit;
2827 s++;
2829 return val;
2832 /* We need to build a global list, since the EnumSystemLocale callback
2833 function isn't given a context pointer. */
2834 Lisp_Object Vw32_valid_locale_ids;
2836 static BOOL CALLBACK
2837 enum_locale_fn (LPTSTR localeNum)
2839 DWORD id = int_from_hex (localeNum);
2840 Vw32_valid_locale_ids = Fcons (make_number (id), Vw32_valid_locale_ids);
2841 return TRUE;
2844 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids,
2845 Sw32_get_valid_locale_ids, 0, 0, 0,
2846 doc: /* Return list of all valid Windows locale ids.
2847 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2848 human-readable form. */)
2849 (void)
2851 Vw32_valid_locale_ids = Qnil;
2853 EnumSystemLocales (enum_locale_fn, LCID_SUPPORTED);
2855 Vw32_valid_locale_ids = Fnreverse (Vw32_valid_locale_ids);
2856 return Vw32_valid_locale_ids;
2860 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id, Sw32_get_default_locale_id, 0, 1, 0,
2861 doc: /* Return Windows locale id for default locale setting.
2862 By default, the system default locale setting is returned; if the optional
2863 parameter USERP is non-nil, the user default locale setting is returned.
2864 This is a numerical value; use `w32-get-locale-info' to convert to a
2865 human-readable form. */)
2866 (Lisp_Object userp)
2868 if (NILP (userp))
2869 return make_number (GetSystemDefaultLCID ());
2870 return make_number (GetUserDefaultLCID ());
2874 DEFUN ("w32-set-current-locale", Fw32_set_current_locale, Sw32_set_current_locale, 1, 1, 0,
2875 doc: /* Make Windows locale LCID be the current locale setting for Emacs.
2876 If successful, the new locale id is returned, otherwise nil. */)
2877 (Lisp_Object lcid)
2879 CHECK_NUMBER (lcid);
2881 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2882 return Qnil;
2884 if (!SetThreadLocale (XINT (lcid)))
2885 return Qnil;
2887 /* Need to set input thread locale if present. */
2888 if (dwWindowsThreadId)
2889 /* Reply is not needed. */
2890 PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETLOCALE, XINT (lcid), 0);
2892 return make_number (GetThreadLocale ());
2896 /* We need to build a global list, since the EnumCodePages callback
2897 function isn't given a context pointer. */
2898 Lisp_Object Vw32_valid_codepages;
2900 static BOOL CALLBACK
2901 enum_codepage_fn (LPTSTR codepageNum)
2903 DWORD id = atoi (codepageNum);
2904 Vw32_valid_codepages = Fcons (make_number (id), Vw32_valid_codepages);
2905 return TRUE;
2908 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages,
2909 Sw32_get_valid_codepages, 0, 0, 0,
2910 doc: /* Return list of all valid Windows codepages. */)
2911 (void)
2913 Vw32_valid_codepages = Qnil;
2915 EnumSystemCodePages (enum_codepage_fn, CP_SUPPORTED);
2917 Vw32_valid_codepages = Fnreverse (Vw32_valid_codepages);
2918 return Vw32_valid_codepages;
2922 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage,
2923 Sw32_get_console_codepage, 0, 0, 0,
2924 doc: /* Return current Windows codepage for console input. */)
2925 (void)
2927 return make_number (GetConsoleCP ());
2931 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage,
2932 Sw32_set_console_codepage, 1, 1, 0,
2933 doc: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2934 This codepage setting affects keyboard input in tty mode.
2935 If successful, the new CP is returned, otherwise nil. */)
2936 (Lisp_Object cp)
2938 CHECK_NUMBER (cp);
2940 if (!IsValidCodePage (XINT (cp)))
2941 return Qnil;
2943 if (!SetConsoleCP (XINT (cp)))
2944 return Qnil;
2946 return make_number (GetConsoleCP ());
2950 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage,
2951 Sw32_get_console_output_codepage, 0, 0, 0,
2952 doc: /* Return current Windows codepage for console output. */)
2953 (void)
2955 return make_number (GetConsoleOutputCP ());
2959 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage,
2960 Sw32_set_console_output_codepage, 1, 1, 0,
2961 doc: /* Make Windows codepage CP be the codepage for Emacs console output.
2962 This codepage setting affects display in tty mode.
2963 If successful, the new CP is returned, otherwise nil. */)
2964 (Lisp_Object cp)
2966 CHECK_NUMBER (cp);
2968 if (!IsValidCodePage (XINT (cp)))
2969 return Qnil;
2971 if (!SetConsoleOutputCP (XINT (cp)))
2972 return Qnil;
2974 return make_number (GetConsoleOutputCP ());
2978 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset,
2979 Sw32_get_codepage_charset, 1, 1, 0,
2980 doc: /* Return charset ID corresponding to codepage CP.
2981 Returns nil if the codepage is not valid. */)
2982 (Lisp_Object cp)
2984 CHARSETINFO info;
2986 CHECK_NUMBER (cp);
2988 if (!IsValidCodePage (XINT (cp)))
2989 return Qnil;
2991 if (TranslateCharsetInfo ((DWORD *) XINT (cp), &info, TCI_SRCCODEPAGE))
2992 return make_number (info.ciCharset);
2994 return Qnil;
2998 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts,
2999 Sw32_get_valid_keyboard_layouts, 0, 0, 0,
3000 doc: /* Return list of Windows keyboard languages and layouts.
3001 The return value is a list of pairs of language id and layout id. */)
3002 (void)
3004 int num_layouts = GetKeyboardLayoutList (0, NULL);
3005 HKL * layouts = (HKL *) alloca (num_layouts * sizeof (HKL));
3006 Lisp_Object obj = Qnil;
3008 if (GetKeyboardLayoutList (num_layouts, layouts) == num_layouts)
3010 while (--num_layouts >= 0)
3012 DWORD kl = (DWORD) layouts[num_layouts];
3014 obj = Fcons (Fcons (make_number (kl & 0xffff),
3015 make_number ((kl >> 16) & 0xffff)),
3016 obj);
3020 return obj;
3024 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout,
3025 Sw32_get_keyboard_layout, 0, 0, 0,
3026 doc: /* Return current Windows keyboard language and layout.
3027 The return value is the cons of the language id and the layout id. */)
3028 (void)
3030 DWORD kl = (DWORD) GetKeyboardLayout (dwWindowsThreadId);
3032 return Fcons (make_number (kl & 0xffff),
3033 make_number ((kl >> 16) & 0xffff));
3037 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout,
3038 Sw32_set_keyboard_layout, 1, 1, 0,
3039 doc: /* Make LAYOUT be the current keyboard layout for Emacs.
3040 The keyboard layout setting affects interpretation of keyboard input.
3041 If successful, the new layout id is returned, otherwise nil. */)
3042 (Lisp_Object layout)
3044 DWORD kl;
3046 CHECK_CONS (layout);
3047 CHECK_NUMBER_CAR (layout);
3048 CHECK_NUMBER_CDR (layout);
3050 kl = (XINT (XCAR (layout)) & 0xffff)
3051 | (XINT (XCDR (layout)) << 16);
3053 /* Synchronize layout with input thread. */
3054 if (dwWindowsThreadId)
3056 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETKEYBOARDLAYOUT,
3057 (WPARAM) kl, 0))
3059 MSG msg;
3060 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
3062 if (msg.wParam == 0)
3063 return Qnil;
3066 else if (!ActivateKeyboardLayout ((HKL) kl, 0))
3067 return Qnil;
3069 return Fw32_get_keyboard_layout ();
3073 void
3074 syms_of_ntproc (void)
3076 DEFSYM (Qhigh, "high");
3077 DEFSYM (Qlow, "low");
3079 defsubr (&Sw32_has_winsock);
3080 defsubr (&Sw32_unload_winsock);
3082 defsubr (&Sw32_short_file_name);
3083 defsubr (&Sw32_long_file_name);
3084 defsubr (&Sw32_set_process_priority);
3085 defsubr (&Sw32_get_locale_info);
3086 defsubr (&Sw32_get_current_locale_id);
3087 defsubr (&Sw32_get_default_locale_id);
3088 defsubr (&Sw32_get_valid_locale_ids);
3089 defsubr (&Sw32_set_current_locale);
3091 defsubr (&Sw32_get_console_codepage);
3092 defsubr (&Sw32_set_console_codepage);
3093 defsubr (&Sw32_get_console_output_codepage);
3094 defsubr (&Sw32_set_console_output_codepage);
3095 defsubr (&Sw32_get_valid_codepages);
3096 defsubr (&Sw32_get_codepage_charset);
3098 defsubr (&Sw32_get_valid_keyboard_layouts);
3099 defsubr (&Sw32_get_keyboard_layout);
3100 defsubr (&Sw32_set_keyboard_layout);
3102 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args,
3103 doc: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3104 Because Windows does not directly pass argv arrays to child processes,
3105 programs have to reconstruct the argv array by parsing the command
3106 line string. For an argument to contain a space, it must be enclosed
3107 in double quotes or it will be parsed as multiple arguments.
3109 If the value is a character, that character will be used to escape any
3110 quote characters that appear, otherwise a suitable escape character
3111 will be chosen based on the type of the program. */);
3112 Vw32_quote_process_args = Qt;
3114 DEFVAR_LISP ("w32-start-process-show-window",
3115 Vw32_start_process_show_window,
3116 doc: /* When nil, new child processes hide their windows.
3117 When non-nil, they show their window in the method of their choice.
3118 This variable doesn't affect GUI applications, which will never be hidden. */);
3119 Vw32_start_process_show_window = Qnil;
3121 DEFVAR_LISP ("w32-start-process-share-console",
3122 Vw32_start_process_share_console,
3123 doc: /* When nil, new child processes are given a new console.
3124 When non-nil, they share the Emacs console; this has the limitation of
3125 allowing only one DOS subprocess to run at a time (whether started directly
3126 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3127 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3128 otherwise respond to interrupts from Emacs. */);
3129 Vw32_start_process_share_console = Qnil;
3131 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3132 Vw32_start_process_inherit_error_mode,
3133 doc: /* When nil, new child processes revert to the default error mode.
3134 When non-nil, they inherit their error mode setting from Emacs, which stops
3135 them blocking when trying to access unmounted drives etc. */);
3136 Vw32_start_process_inherit_error_mode = Qt;
3138 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay,
3139 doc: /* Forced delay before reading subprocess output.
3140 This is done to improve the buffering of subprocess output, by
3141 avoiding the inefficiency of frequently reading small amounts of data.
3143 If positive, the value is the number of milliseconds to sleep before
3144 reading the subprocess output. If negative, the magnitude is the number
3145 of time slices to wait (effectively boosting the priority of the child
3146 process temporarily). A value of zero disables waiting entirely. */);
3147 w32_pipe_read_delay = 50;
3149 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names,
3150 doc: /* Non-nil means convert all-upper case file names to lower case.
3151 This applies when performing completions and file name expansion.
3152 Note that the value of this setting also affects remote file names,
3153 so you probably don't want to set to non-nil if you use case-sensitive
3154 filesystems via ange-ftp. */);
3155 Vw32_downcase_file_names = Qnil;
3157 #if 0
3158 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes,
3159 doc: /* Non-nil means attempt to fake realistic inode values.
3160 This works by hashing the truename of files, and should detect
3161 aliasing between long and short (8.3 DOS) names, but can have
3162 false positives because of hash collisions. Note that determining
3163 the truename of a file can be slow. */);
3164 Vw32_generate_fake_inodes = Qnil;
3165 #endif
3167 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes,
3168 doc: /* Non-nil means determine accurate file attributes in `file-attributes'.
3169 This option controls whether to issue additional system calls to determine
3170 accurate link counts, file type, and ownership information. It is more
3171 useful for files on NTFS volumes, where hard links and file security are
3172 supported, than on volumes of the FAT family.
3174 Without these system calls, link count will always be reported as 1 and file
3175 ownership will be attributed to the current user.
3176 The default value `local' means only issue these system calls for files
3177 on local fixed drives. A value of nil means never issue them.
3178 Any other non-nil value means do this even on remote and removable drives
3179 where the performance impact may be noticeable even on modern hardware. */);
3180 Vw32_get_true_file_attributes = Qlocal;
3182 staticpro (&Vw32_valid_locale_ids);
3183 staticpro (&Vw32_valid_codepages);
3185 /* end of w32proc.c */