Allow comma separated lists after Java "implements".
[emacs.git] / src / w32proc.c
blobea16f26a0ee4fcc4aaeefaf09a29e70d6c2256b7
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 <mingw_time.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <errno.h>
28 #include <ctype.h>
29 #include <io.h>
30 #include <fcntl.h>
31 #include <signal.h>
32 #include <sys/file.h>
34 /* must include CRT headers *before* config.h */
35 #include <config.h>
37 #undef signal
38 #undef wait
39 #undef spawnve
40 #undef select
41 #undef kill
43 #include <windows.h>
44 #ifdef __GNUC__
45 /* This definition is missing from mingw32 headers. */
46 extern BOOL WINAPI IsValidLocale (LCID, DWORD);
47 #endif
49 #ifdef HAVE_LANGINFO_CODESET
50 #include <nl_types.h>
51 #include <langinfo.h>
52 #endif
54 #include "lisp.h"
55 #include "w32.h"
56 #include "w32common.h"
57 #include "w32heap.h"
58 #include "systime.h"
59 #include "syswait.h"
60 #include "process.h"
61 #include "syssignal.h"
62 #include "w32term.h"
63 #include "dispextern.h" /* for xstrcasecmp */
64 #include "coding.h"
66 #define RVA_TO_PTR(var,section,filedata) \
67 ((void *)((section)->PointerToRawData \
68 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
69 + (filedata).file_base))
71 Lisp_Object Qhigh, Qlow;
73 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
74 static signal_handler sig_handlers[NSIG];
76 static sigset_t sig_mask;
78 static CRITICAL_SECTION crit_sig;
80 /* Improve on the CRT 'signal' implementation so that we could record
81 the SIGCHLD handler and fake interval timers. */
82 signal_handler
83 sys_signal (int sig, signal_handler handler)
85 signal_handler old;
87 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
88 below. SIGALRM and SIGPROF are used by setitimer. All the
89 others are the only ones supported by the MS runtime. */
90 if (!(sig == SIGCHLD || sig == SIGSEGV || sig == SIGILL
91 || sig == SIGFPE || sig == SIGABRT || sig == SIGTERM
92 || sig == SIGALRM || sig == SIGPROF))
94 errno = EINVAL;
95 return SIG_ERR;
97 old = sig_handlers[sig];
98 /* SIGABRT is treated specially because w32.c installs term_ntproc
99 as its handler, so we don't want to override that afterwards.
100 Aborting Emacs works specially anyway: either by calling
101 emacs_abort directly or through terminate_due_to_signal, which
102 calls emacs_abort through emacs_raise. */
103 if (!(sig == SIGABRT && old == term_ntproc))
105 sig_handlers[sig] = handler;
106 if (!(sig == SIGCHLD || sig == SIGALRM || sig == SIGPROF))
107 signal (sig, handler);
109 return old;
112 /* Emulate sigaction. */
114 sigaction (int sig, const struct sigaction *act, struct sigaction *oact)
116 signal_handler old = SIG_DFL;
117 int retval = 0;
119 if (act)
120 old = sys_signal (sig, act->sa_handler);
121 else if (oact)
122 old = sig_handlers[sig];
124 if (old == SIG_ERR)
126 errno = EINVAL;
127 retval = -1;
129 if (oact)
131 oact->sa_handler = old;
132 oact->sa_flags = 0;
133 oact->sa_mask = empty_mask;
135 return retval;
138 /* Emulate signal sets and blocking of signals used by timers. */
141 sigemptyset (sigset_t *set)
143 *set = 0;
144 return 0;
148 sigaddset (sigset_t *set, int signo)
150 if (!set)
152 errno = EINVAL;
153 return -1;
155 if (signo < 0 || signo >= NSIG)
157 errno = EINVAL;
158 return -1;
161 *set |= (1U << signo);
163 return 0;
167 sigfillset (sigset_t *set)
169 if (!set)
171 errno = EINVAL;
172 return -1;
175 *set = 0xFFFFFFFF;
176 return 0;
180 sigprocmask (int how, const sigset_t *set, sigset_t *oset)
182 if (!(how == SIG_BLOCK || how == SIG_UNBLOCK || how == SIG_SETMASK))
184 errno = EINVAL;
185 return -1;
188 if (oset)
189 *oset = sig_mask;
191 if (!set)
192 return 0;
194 switch (how)
196 case SIG_BLOCK:
197 sig_mask |= *set;
198 break;
199 case SIG_SETMASK:
200 sig_mask = *set;
201 break;
202 case SIG_UNBLOCK:
203 /* FIXME: Catch signals that are blocked and reissue them when
204 they are unblocked. Important for SIGALRM and SIGPROF only. */
205 sig_mask &= ~(*set);
206 break;
209 return 0;
213 pthread_sigmask (int how, const sigset_t *set, sigset_t *oset)
215 if (sigprocmask (how, set, oset) == -1)
216 return EINVAL;
217 return 0;
221 sigismember (const sigset_t *set, int signo)
223 if (signo < 0 || signo >= NSIG)
225 errno = EINVAL;
226 return -1;
228 if (signo > sizeof (*set) * BITS_PER_CHAR)
229 emacs_abort ();
231 return (*set & (1U << signo)) != 0;
234 pid_t
235 getpgrp (void)
237 return getpid ();
240 pid_t
241 tcgetpgrp (int fd)
243 return getpid ();
247 setpgid (pid_t pid, pid_t pgid)
249 return 0;
252 pid_t
253 setsid (void)
255 return getpid ();
258 /* Emulations of interval timers.
260 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
262 Implementation: a separate thread is started for each timer type,
263 the thread calls the appropriate signal handler when the timer
264 expires, after stopping the thread which installed the timer. */
266 struct itimer_data {
267 volatile ULONGLONG expire;
268 volatile ULONGLONG reload;
269 volatile int terminate;
270 int type;
271 HANDLE caller_thread;
272 HANDLE timer_thread;
275 static ULONGLONG ticks_now;
276 static struct itimer_data real_itimer, prof_itimer;
277 static ULONGLONG clocks_min;
278 /* If non-zero, itimers are disabled. Used during shutdown, when we
279 delete the critical sections used by the timer threads. */
280 static int disable_itimers;
282 static CRITICAL_SECTION crit_real, crit_prof;
284 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
285 typedef BOOL (WINAPI *GetThreadTimes_Proc) (
286 HANDLE hThread,
287 LPFILETIME lpCreationTime,
288 LPFILETIME lpExitTime,
289 LPFILETIME lpKernelTime,
290 LPFILETIME lpUserTime);
292 static GetThreadTimes_Proc s_pfn_Get_Thread_Times;
294 #define MAX_SINGLE_SLEEP 30
295 #define TIMER_TICKS_PER_SEC 1000
297 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
298 to a thread. If THREAD is NULL or an invalid handle, return the
299 current wall-clock time since January 1, 1601 (UTC). Otherwise,
300 return the sum of kernel and user times used by THREAD since it was
301 created, plus its creation time. */
302 static ULONGLONG
303 w32_get_timer_time (HANDLE thread)
305 ULONGLONG retval;
306 int use_system_time = 1;
307 /* The functions below return times in 100-ns units. */
308 const int tscale = 10 * TIMER_TICKS_PER_SEC;
310 if (thread && thread != INVALID_HANDLE_VALUE
311 && s_pfn_Get_Thread_Times != NULL)
313 FILETIME creation_ftime, exit_ftime, kernel_ftime, user_ftime;
314 ULARGE_INTEGER temp_creation, temp_kernel, temp_user;
316 if (s_pfn_Get_Thread_Times (thread, &creation_ftime, &exit_ftime,
317 &kernel_ftime, &user_ftime))
319 use_system_time = 0;
320 temp_creation.LowPart = creation_ftime.dwLowDateTime;
321 temp_creation.HighPart = creation_ftime.dwHighDateTime;
322 temp_kernel.LowPart = kernel_ftime.dwLowDateTime;
323 temp_kernel.HighPart = kernel_ftime.dwHighDateTime;
324 temp_user.LowPart = user_ftime.dwLowDateTime;
325 temp_user.HighPart = user_ftime.dwHighDateTime;
326 retval =
327 temp_creation.QuadPart / tscale + temp_kernel.QuadPart / tscale
328 + temp_user.QuadPart / tscale;
330 else
331 DebPrint (("GetThreadTimes failed with error code %lu\n",
332 GetLastError ()));
335 if (use_system_time)
337 FILETIME current_ftime;
338 ULARGE_INTEGER temp;
340 GetSystemTimeAsFileTime (&current_ftime);
342 temp.LowPart = current_ftime.dwLowDateTime;
343 temp.HighPart = current_ftime.dwHighDateTime;
345 retval = temp.QuadPart / tscale;
348 return retval;
351 /* Thread function for a timer thread. */
352 static DWORD WINAPI
353 timer_loop (LPVOID arg)
355 struct itimer_data *itimer = (struct itimer_data *)arg;
356 int which = itimer->type;
357 int sig = (which == ITIMER_REAL) ? SIGALRM : SIGPROF;
358 CRITICAL_SECTION *crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
359 const DWORD max_sleep = MAX_SINGLE_SLEEP * 1000 / TIMER_TICKS_PER_SEC;
360 HANDLE hth = (which == ITIMER_REAL) ? NULL : itimer->caller_thread;
362 while (1)
364 DWORD sleep_time;
365 signal_handler handler;
366 ULONGLONG now, expire, reload;
368 /* Load new values if requested by setitimer. */
369 EnterCriticalSection (crit);
370 expire = itimer->expire;
371 reload = itimer->reload;
372 LeaveCriticalSection (crit);
373 if (itimer->terminate)
374 return 0;
376 if (expire == 0)
378 /* We are idle. */
379 Sleep (max_sleep);
380 continue;
383 if (expire > (now = w32_get_timer_time (hth)))
384 sleep_time = expire - now;
385 else
386 sleep_time = 0;
387 /* Don't sleep too long at a time, to be able to see the
388 termination flag without too long a delay. */
389 while (sleep_time > max_sleep)
391 if (itimer->terminate)
392 return 0;
393 Sleep (max_sleep);
394 EnterCriticalSection (crit);
395 expire = itimer->expire;
396 LeaveCriticalSection (crit);
397 sleep_time =
398 (expire > (now = w32_get_timer_time (hth))) ? expire - now : 0;
400 if (itimer->terminate)
401 return 0;
402 if (sleep_time > 0)
404 Sleep (sleep_time * 1000 / TIMER_TICKS_PER_SEC);
405 /* Always sleep past the expiration time, to make sure we
406 never call the handler _before_ the expiration time,
407 always slightly after it. Sleep(5) makes sure we don't
408 hog the CPU by calling 'w32_get_timer_time' with high
409 frequency, and also let other threads work. */
410 while (w32_get_timer_time (hth) < expire)
411 Sleep (5);
414 EnterCriticalSection (crit);
415 expire = itimer->expire;
416 LeaveCriticalSection (crit);
417 if (expire == 0)
418 continue;
420 /* Time's up. */
421 handler = sig_handlers[sig];
422 if (!(handler == SIG_DFL || handler == SIG_IGN || handler == SIG_ERR)
423 /* FIXME: Don't ignore masked signals. Instead, record that
424 they happened and reissue them when the signal is
425 unblocked. */
426 && !sigismember (&sig_mask, sig)
427 /* Simulate masking of SIGALRM and SIGPROF when processing
428 fatal signals. */
429 && !fatal_error_in_progress
430 && itimer->caller_thread)
432 /* Simulate a signal delivered to the thread which installed
433 the timer, by suspending that thread while the handler
434 runs. */
435 HANDLE th = itimer->caller_thread;
436 DWORD result = SuspendThread (th);
438 if (result == (DWORD)-1)
439 return 2;
441 handler (sig);
442 ResumeThread (th);
445 /* Update expiration time and loop. */
446 EnterCriticalSection (crit);
447 expire = itimer->expire;
448 if (expire == 0)
450 LeaveCriticalSection (crit);
451 continue;
453 reload = itimer->reload;
454 if (reload > 0)
456 now = w32_get_timer_time (hth);
457 if (expire <= now)
459 ULONGLONG lag = now - expire;
461 /* If we missed some opportunities (presumably while
462 sleeping or while the signal handler ran), skip
463 them. */
464 if (lag > reload)
465 expire = now - (lag % reload);
467 expire += reload;
470 else
471 expire = 0; /* become idle */
472 itimer->expire = expire;
473 LeaveCriticalSection (crit);
475 return 0;
478 static void
479 stop_timer_thread (int which)
481 struct itimer_data *itimer =
482 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
483 int i;
484 DWORD err, exit_code = 255;
485 BOOL status;
487 /* Signal the thread that it should terminate. */
488 itimer->terminate = 1;
490 if (itimer->timer_thread == NULL)
491 return;
493 /* Wait for the timer thread to terminate voluntarily, then kill it
494 if it doesn't. This loop waits twice more than the maximum
495 amount of time a timer thread sleeps, see above. */
496 for (i = 0; i < MAX_SINGLE_SLEEP / 5; i++)
498 if (!((status = GetExitCodeThread (itimer->timer_thread, &exit_code))
499 && exit_code == STILL_ACTIVE))
500 break;
501 Sleep (10);
503 if ((status == FALSE && (err = GetLastError ()) == ERROR_INVALID_HANDLE)
504 || exit_code == STILL_ACTIVE)
506 if (!(status == FALSE && err == ERROR_INVALID_HANDLE))
507 TerminateThread (itimer->timer_thread, 0);
510 /* Clean up. */
511 CloseHandle (itimer->timer_thread);
512 itimer->timer_thread = NULL;
513 if (itimer->caller_thread)
515 CloseHandle (itimer->caller_thread);
516 itimer->caller_thread = NULL;
520 /* This is called at shutdown time from term_ntproc. */
521 void
522 term_timers (void)
524 if (real_itimer.timer_thread)
525 stop_timer_thread (ITIMER_REAL);
526 if (prof_itimer.timer_thread)
527 stop_timer_thread (ITIMER_PROF);
529 /* We are going to delete the critical sections, so timers cannot
530 work after this. */
531 disable_itimers = 1;
533 DeleteCriticalSection (&crit_real);
534 DeleteCriticalSection (&crit_prof);
535 DeleteCriticalSection (&crit_sig);
538 /* This is called at initialization time from init_ntproc. */
539 void
540 init_timers (void)
542 /* GetThreadTimes is not available on all versions of Windows, so
543 need to probe for its availability dynamically, and call it
544 through a pointer. */
545 s_pfn_Get_Thread_Times = NULL; /* in case dumped Emacs comes with a value */
546 if (os_subtype != OS_9X)
547 s_pfn_Get_Thread_Times =
548 (GetThreadTimes_Proc)GetProcAddress (GetModuleHandle ("kernel32.dll"),
549 "GetThreadTimes");
551 /* Make sure we start with zeroed out itimer structures, since
552 dumping may have left there traces of threads long dead. */
553 memset (&real_itimer, 0, sizeof real_itimer);
554 memset (&prof_itimer, 0, sizeof prof_itimer);
556 InitializeCriticalSection (&crit_real);
557 InitializeCriticalSection (&crit_prof);
558 InitializeCriticalSection (&crit_sig);
560 disable_itimers = 0;
563 static int
564 start_timer_thread (int which)
566 DWORD exit_code;
567 HANDLE th;
568 struct itimer_data *itimer =
569 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
571 if (itimer->timer_thread
572 && GetExitCodeThread (itimer->timer_thread, &exit_code)
573 && exit_code == STILL_ACTIVE)
574 return 0;
576 /* Clean up after possibly exited thread. */
577 if (itimer->timer_thread)
579 CloseHandle (itimer->timer_thread);
580 itimer->timer_thread = NULL;
582 if (itimer->caller_thread)
584 CloseHandle (itimer->caller_thread);
585 itimer->caller_thread = NULL;
588 /* Start a new thread. */
589 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
590 GetCurrentProcess (), &th, 0, FALSE,
591 DUPLICATE_SAME_ACCESS))
593 errno = ESRCH;
594 return -1;
596 itimer->terminate = 0;
597 itimer->type = which;
598 itimer->caller_thread = th;
599 /* Request that no more than 64KB of stack be reserved for this
600 thread, to avoid reserving too much memory, which would get in
601 the way of threads we start to wait for subprocesses. See also
602 new_child below. */
603 itimer->timer_thread = CreateThread (NULL, 64 * 1024, timer_loop,
604 (void *)itimer, 0x00010000, NULL);
606 if (!itimer->timer_thread)
608 CloseHandle (itimer->caller_thread);
609 itimer->caller_thread = NULL;
610 errno = EAGAIN;
611 return -1;
614 /* This is needed to make sure that the timer thread running for
615 profiling gets CPU as soon as the Sleep call terminates. */
616 if (which == ITIMER_PROF)
617 SetThreadPriority (itimer->timer_thread, THREAD_PRIORITY_TIME_CRITICAL);
619 return 0;
622 /* Most of the code of getitimer and setitimer (but not of their
623 subroutines) was shamelessly stolen from itimer.c in the DJGPP
624 library, see www.delorie.com/djgpp. */
626 getitimer (int which, struct itimerval *value)
628 volatile ULONGLONG *t_expire;
629 volatile ULONGLONG *t_reload;
630 ULONGLONG expire, reload;
631 __int64 usecs;
632 CRITICAL_SECTION *crit;
633 struct itimer_data *itimer;
635 if (disable_itimers)
636 return -1;
638 if (!value)
640 errno = EFAULT;
641 return -1;
644 if (which != ITIMER_REAL && which != ITIMER_PROF)
646 errno = EINVAL;
647 return -1;
650 itimer = (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
652 ticks_now = w32_get_timer_time ((which == ITIMER_REAL)
653 ? NULL
654 : GetCurrentThread ());
656 t_expire = &itimer->expire;
657 t_reload = &itimer->reload;
658 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
660 EnterCriticalSection (crit);
661 reload = *t_reload;
662 expire = *t_expire;
663 LeaveCriticalSection (crit);
665 if (expire)
666 expire -= ticks_now;
668 value->it_value.tv_sec = expire / TIMER_TICKS_PER_SEC;
669 usecs =
670 (expire % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
671 value->it_value.tv_usec = usecs;
672 value->it_interval.tv_sec = reload / TIMER_TICKS_PER_SEC;
673 usecs =
674 (reload % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
675 value->it_interval.tv_usec= usecs;
677 return 0;
681 setitimer(int which, struct itimerval *value, struct itimerval *ovalue)
683 volatile ULONGLONG *t_expire, *t_reload;
684 ULONGLONG expire, reload, expire_old, reload_old;
685 __int64 usecs;
686 CRITICAL_SECTION *crit;
687 struct itimerval tem, *ptem;
689 if (disable_itimers)
690 return -1;
692 /* Posix systems expect timer values smaller than the resolution of
693 the system clock be rounded up to the clock resolution. First
694 time we are called, measure the clock tick resolution. */
695 if (!clocks_min)
697 ULONGLONG t1, t2;
699 for (t1 = w32_get_timer_time (NULL);
700 (t2 = w32_get_timer_time (NULL)) == t1; )
702 clocks_min = t2 - t1;
705 if (ovalue)
706 ptem = ovalue;
707 else
708 ptem = &tem;
710 if (getitimer (which, ptem)) /* also sets ticks_now */
711 return -1; /* errno already set */
713 t_expire =
714 (which == ITIMER_REAL) ? &real_itimer.expire : &prof_itimer.expire;
715 t_reload =
716 (which == ITIMER_REAL) ? &real_itimer.reload : &prof_itimer.reload;
718 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
720 if (!value
721 || (value->it_value.tv_sec == 0 && value->it_value.tv_usec == 0))
723 EnterCriticalSection (crit);
724 /* Disable the timer. */
725 *t_expire = 0;
726 *t_reload = 0;
727 LeaveCriticalSection (crit);
728 return 0;
731 reload = value->it_interval.tv_sec * TIMER_TICKS_PER_SEC;
733 usecs = value->it_interval.tv_usec;
734 if (value->it_interval.tv_sec == 0
735 && usecs && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
736 reload = clocks_min;
737 else
739 usecs *= TIMER_TICKS_PER_SEC;
740 reload += usecs / 1000000;
743 expire = value->it_value.tv_sec * TIMER_TICKS_PER_SEC;
744 usecs = value->it_value.tv_usec;
745 if (value->it_value.tv_sec == 0
746 && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
747 expire = clocks_min;
748 else
750 usecs *= TIMER_TICKS_PER_SEC;
751 expire += usecs / 1000000;
754 expire += ticks_now;
756 EnterCriticalSection (crit);
757 expire_old = *t_expire;
758 reload_old = *t_reload;
759 if (!(expire == expire_old && reload == reload_old))
761 *t_reload = reload;
762 *t_expire = expire;
764 LeaveCriticalSection (crit);
766 return start_timer_thread (which);
770 alarm (int seconds)
772 #ifdef HAVE_SETITIMER
773 struct itimerval new_values, old_values;
775 new_values.it_value.tv_sec = seconds;
776 new_values.it_value.tv_usec = 0;
777 new_values.it_interval.tv_sec = new_values.it_interval.tv_usec = 0;
779 if (setitimer (ITIMER_REAL, &new_values, &old_values) < 0)
780 return 0;
781 return old_values.it_value.tv_sec;
782 #else
783 return seconds;
784 #endif
787 /* Defined in <process.h> which conflicts with the local copy */
788 #define _P_NOWAIT 1
790 /* Child process management list. */
791 int child_proc_count = 0;
792 child_process child_procs[ MAX_CHILDREN ];
794 static DWORD WINAPI reader_thread (void *arg);
796 /* Find an unused process slot. */
797 child_process *
798 new_child (void)
800 child_process *cp;
801 DWORD id;
803 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
804 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
805 goto Initialize;
806 if (child_proc_count == MAX_CHILDREN)
808 int i = 0;
809 child_process *dead_cp = NULL;
811 DebPrint (("new_child: No vacant slots, looking for dead processes\n"));
812 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
813 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
815 DWORD status = 0;
817 if (!GetExitCodeProcess (cp->procinfo.hProcess, &status))
819 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
820 GetLastError (), cp->procinfo.dwProcessId));
821 status = STILL_ACTIVE;
823 if (status != STILL_ACTIVE
824 || WaitForSingleObject (cp->procinfo.hProcess, 0) == WAIT_OBJECT_0)
826 DebPrint (("new_child: Freeing slot of dead process %d, fd %d\n",
827 cp->procinfo.dwProcessId, cp->fd));
828 CloseHandle (cp->procinfo.hProcess);
829 cp->procinfo.hProcess = NULL;
830 CloseHandle (cp->procinfo.hThread);
831 cp->procinfo.hThread = NULL;
832 /* Free up to 2 dead slots at a time, so that if we
833 have a lot of them, they will eventually all be
834 freed when the tornado ends. */
835 if (i == 0)
836 dead_cp = cp;
837 else
838 break;
839 i++;
842 if (dead_cp)
844 cp = dead_cp;
845 goto Initialize;
848 if (child_proc_count == MAX_CHILDREN)
849 return NULL;
850 cp = &child_procs[child_proc_count++];
852 Initialize:
853 /* Last opportunity to avoid leaking handles before we forget them
854 for good. */
855 if (cp->procinfo.hProcess)
856 CloseHandle (cp->procinfo.hProcess);
857 if (cp->procinfo.hThread)
858 CloseHandle (cp->procinfo.hThread);
859 memset (cp, 0, sizeof (*cp));
860 cp->fd = -1;
861 cp->pid = -1;
862 cp->procinfo.hProcess = NULL;
863 cp->status = STATUS_READ_ERROR;
864 cp->input_file = NULL;
865 cp->pending_deletion = 0;
867 /* use manual reset event so that select() will function properly */
868 cp->char_avail = CreateEvent (NULL, TRUE, FALSE, NULL);
869 if (cp->char_avail)
871 cp->char_consumed = CreateEvent (NULL, FALSE, FALSE, NULL);
872 if (cp->char_consumed)
874 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
875 It means that the 64K stack we are requesting in the 2nd
876 argument is how much memory should be reserved for the
877 stack. If we don't use this flag, the memory requested
878 by the 2nd argument is the amount actually _committed_,
879 but Windows reserves 8MB of memory for each thread's
880 stack. (The 8MB figure comes from the -stack
881 command-line argument we pass to the linker when building
882 Emacs, but that's because we need a large stack for
883 Emacs's main thread.) Since we request 2GB of reserved
884 memory at startup (see w32heap.c), which is close to the
885 maximum memory available for a 32-bit process on Windows,
886 the 8MB reservation for each thread causes failures in
887 starting subprocesses, because we create a thread running
888 reader_thread for each subprocess. As 8MB of stack is
889 way too much for reader_thread, forcing Windows to
890 reserve less wins the day. */
891 cp->thrd = CreateThread (NULL, 64 * 1024, reader_thread, cp,
892 0x00010000, &id);
893 if (cp->thrd)
894 return cp;
897 delete_child (cp);
898 return NULL;
901 void
902 delete_child (child_process *cp)
904 int i;
906 /* Should not be deleting a child that is still needed. */
907 for (i = 0; i < MAXDESC; i++)
908 if (fd_info[i].cp == cp)
909 emacs_abort ();
911 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
912 return;
914 /* Delete the child's temporary input file, if any, that is pending
915 deletion. */
916 if (cp->input_file)
918 if (cp->pending_deletion)
920 if (unlink (cp->input_file))
921 DebPrint (("delete_child.unlink (%s) failed, errno: %d\n",
922 cp->input_file, errno));
923 cp->pending_deletion = 0;
925 xfree (cp->input_file);
926 cp->input_file = NULL;
929 /* reap thread if necessary */
930 if (cp->thrd)
932 DWORD rc;
934 if (GetExitCodeThread (cp->thrd, &rc) && rc == STILL_ACTIVE)
936 /* let the thread exit cleanly if possible */
937 cp->status = STATUS_READ_ERROR;
938 SetEvent (cp->char_consumed);
939 #if 0
940 /* We used to forcibly terminate the thread here, but it
941 is normally unnecessary, and in abnormal cases, the worst that
942 will happen is we have an extra idle thread hanging around
943 waiting for the zombie process. */
944 if (WaitForSingleObject (cp->thrd, 1000) != WAIT_OBJECT_0)
946 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
947 "with %lu for fd %ld\n", GetLastError (), cp->fd));
948 TerminateThread (cp->thrd, 0);
950 #endif
952 CloseHandle (cp->thrd);
953 cp->thrd = NULL;
955 if (cp->char_avail)
957 CloseHandle (cp->char_avail);
958 cp->char_avail = NULL;
960 if (cp->char_consumed)
962 CloseHandle (cp->char_consumed);
963 cp->char_consumed = NULL;
966 /* update child_proc_count (highest numbered slot in use plus one) */
967 if (cp == child_procs + child_proc_count - 1)
969 for (i = child_proc_count-1; i >= 0; i--)
970 if (CHILD_ACTIVE (&child_procs[i])
971 || child_procs[i].procinfo.hProcess != NULL)
973 child_proc_count = i + 1;
974 break;
977 if (i < 0)
978 child_proc_count = 0;
981 /* Find a child by pid. */
982 static child_process *
983 find_child_pid (DWORD pid)
985 child_process *cp;
987 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
988 if ((CHILD_ACTIVE (cp) || cp->procinfo.hProcess != NULL)
989 && pid == cp->pid)
990 return cp;
991 return NULL;
994 void
995 release_listen_threads (void)
997 int i;
999 for (i = child_proc_count - 1; i >= 0; i--)
1001 if (CHILD_ACTIVE (&child_procs[i])
1002 && (fd_info[child_procs[i].fd].flags & FILE_LISTEN))
1003 child_procs[i].status = STATUS_READ_ERROR;
1007 /* Thread proc for child process and socket reader threads. Each thread
1008 is normally blocked until woken by select() to check for input by
1009 reading one char. When the read completes, char_avail is signaled
1010 to wake up the select emulator and the thread blocks itself again. */
1011 static DWORD WINAPI
1012 reader_thread (void *arg)
1014 child_process *cp;
1016 /* Our identity */
1017 cp = (child_process *)arg;
1019 /* We have to wait for the go-ahead before we can start */
1020 if (cp == NULL
1021 || WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0
1022 || cp->fd < 0)
1023 return 1;
1025 for (;;)
1027 int rc;
1029 if (cp->fd >= 0 && fd_info[cp->fd].flags & FILE_LISTEN)
1030 rc = _sys_wait_accept (cp->fd);
1031 else
1032 rc = _sys_read_ahead (cp->fd);
1034 /* Don't bother waiting for the event if we already have been
1035 told to exit by delete_child. */
1036 if (cp->status == STATUS_READ_ERROR || !cp->char_avail)
1037 break;
1039 /* The name char_avail is a misnomer - it really just means the
1040 read-ahead has completed, whether successfully or not. */
1041 if (!SetEvent (cp->char_avail))
1043 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1044 (DWORD_PTR)cp->char_avail, GetLastError (),
1045 cp->fd, cp->pid));
1046 return 1;
1049 if (rc == STATUS_READ_ERROR)
1050 return 1;
1052 /* If the read died, the child has died so let the thread die */
1053 if (rc == STATUS_READ_FAILED)
1054 break;
1056 /* Don't bother waiting for the acknowledge if we already have
1057 been told to exit by delete_child. */
1058 if (cp->status == STATUS_READ_ERROR || !cp->char_consumed)
1059 break;
1061 /* Wait until our input is acknowledged before reading again */
1062 if (WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
1064 DebPrint (("reader_thread.WaitForSingleObject failed with "
1065 "%lu for fd %ld\n", GetLastError (), cp->fd));
1066 break;
1068 /* delete_child sets status to STATUS_READ_ERROR when it wants
1069 us to exit. */
1070 if (cp->status == STATUS_READ_ERROR)
1071 break;
1073 return 0;
1076 /* To avoid Emacs changing directory, we just record here the directory
1077 the new process should start in. This is set just before calling
1078 sys_spawnve, and is not generally valid at any other time. */
1079 static char * process_dir;
1081 static BOOL
1082 create_child (char *exe, char *cmdline, char *env, int is_gui_app,
1083 int * pPid, child_process *cp)
1085 STARTUPINFO start;
1086 SECURITY_ATTRIBUTES sec_attrs;
1087 #if 0
1088 SECURITY_DESCRIPTOR sec_desc;
1089 #endif
1090 DWORD flags;
1091 char dir[ MAXPATHLEN ];
1093 if (cp == NULL) emacs_abort ();
1095 memset (&start, 0, sizeof (start));
1096 start.cb = sizeof (start);
1098 #ifdef HAVE_NTGUI
1099 if (NILP (Vw32_start_process_show_window) && !is_gui_app)
1100 start.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
1101 else
1102 start.dwFlags = STARTF_USESTDHANDLES;
1103 start.wShowWindow = SW_HIDE;
1105 start.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
1106 start.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
1107 start.hStdError = GetStdHandle (STD_ERROR_HANDLE);
1108 #endif /* HAVE_NTGUI */
1110 #if 0
1111 /* Explicitly specify no security */
1112 if (!InitializeSecurityDescriptor (&sec_desc, SECURITY_DESCRIPTOR_REVISION))
1113 goto EH_Fail;
1114 if (!SetSecurityDescriptorDacl (&sec_desc, TRUE, NULL, FALSE))
1115 goto EH_Fail;
1116 #endif
1117 sec_attrs.nLength = sizeof (sec_attrs);
1118 sec_attrs.lpSecurityDescriptor = NULL /* &sec_desc */;
1119 sec_attrs.bInheritHandle = FALSE;
1121 strcpy (dir, process_dir);
1122 unixtodos_filename (dir);
1124 flags = (!NILP (Vw32_start_process_share_console)
1125 ? CREATE_NEW_PROCESS_GROUP
1126 : CREATE_NEW_CONSOLE);
1127 if (NILP (Vw32_start_process_inherit_error_mode))
1128 flags |= CREATE_DEFAULT_ERROR_MODE;
1129 if (!CreateProcess (exe, cmdline, &sec_attrs, NULL, TRUE,
1130 flags, env, dir, &start, &cp->procinfo))
1131 goto EH_Fail;
1133 cp->pid = (int) cp->procinfo.dwProcessId;
1135 /* Hack for Windows 95, which assigns large (ie negative) pids */
1136 if (cp->pid < 0)
1137 cp->pid = -cp->pid;
1139 *pPid = cp->pid;
1141 return TRUE;
1143 EH_Fail:
1144 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1145 return FALSE;
1148 /* create_child doesn't know what emacs's file handle will be for waiting
1149 on output from the child, so we need to make this additional call
1150 to register the handle with the process
1151 This way the select emulator knows how to match file handles with
1152 entries in child_procs. */
1153 void
1154 register_child (pid_t pid, int fd)
1156 child_process *cp;
1158 cp = find_child_pid ((DWORD)pid);
1159 if (cp == NULL)
1161 DebPrint (("register_child unable to find pid %lu\n", pid));
1162 return;
1165 #ifdef FULL_DEBUG
1166 DebPrint (("register_child registered fd %d with pid %lu\n", fd, pid));
1167 #endif
1169 cp->fd = fd;
1171 /* thread is initially blocked until select is called; set status so
1172 that select will release thread */
1173 cp->status = STATUS_READ_ACKNOWLEDGED;
1175 /* attach child_process to fd_info */
1176 if (fd_info[fd].cp != NULL)
1178 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd));
1179 emacs_abort ();
1182 fd_info[fd].cp = cp;
1185 /* Record INFILE as an input file for process PID. */
1186 void
1187 record_infile (pid_t pid, char *infile)
1189 child_process *cp;
1191 /* INFILE should never be NULL, since xstrdup would have signaled
1192 memory full condition in that case, see callproc.c where this
1193 function is called. */
1194 eassert (infile);
1196 cp = find_child_pid ((DWORD)pid);
1197 if (cp == NULL)
1199 DebPrint (("record_infile is unable to find pid %lu\n", pid));
1200 return;
1203 cp->input_file = infile;
1206 /* Mark the input file INFILE of the corresponding subprocess as
1207 temporary, to be deleted when the subprocess exits. */
1208 void
1209 record_pending_deletion (char *infile)
1211 child_process *cp;
1213 eassert (infile);
1215 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1216 if (CHILD_ACTIVE (cp)
1217 && cp->input_file && xstrcasecmp (cp->input_file, infile) == 0)
1219 cp->pending_deletion = 1;
1220 break;
1224 /* Called from waitpid when a process exits. */
1225 static void
1226 reap_subprocess (child_process *cp)
1228 if (cp->procinfo.hProcess)
1230 /* Reap the process */
1231 #ifdef FULL_DEBUG
1232 /* Process should have already died before we are called. */
1233 if (WaitForSingleObject (cp->procinfo.hProcess, 0) != WAIT_OBJECT_0)
1234 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp->fd));
1235 #endif
1236 CloseHandle (cp->procinfo.hProcess);
1237 cp->procinfo.hProcess = NULL;
1238 CloseHandle (cp->procinfo.hThread);
1239 cp->procinfo.hThread = NULL;
1242 /* If cp->fd was not closed yet, we might be still reading the
1243 process output, so don't free its resources just yet. The call
1244 to delete_child on behalf of this subprocess will be made by
1245 sys_read when the subprocess output is fully read. */
1246 if (cp->fd < 0)
1247 delete_child (cp);
1250 /* Wait for a child process specified by PID, or for any of our
1251 existing child processes (if PID is nonpositive) to die. When it
1252 does, close its handle. Return the pid of the process that died
1253 and fill in STATUS if non-NULL. */
1255 pid_t
1256 waitpid (pid_t pid, int *status, int options)
1258 DWORD active, retval;
1259 int nh;
1260 child_process *cp, *cps[MAX_CHILDREN];
1261 HANDLE wait_hnd[MAX_CHILDREN];
1262 DWORD timeout_ms;
1263 int dont_wait = (options & WNOHANG) != 0;
1265 nh = 0;
1266 /* According to Posix:
1268 PID = -1 means status is requested for any child process.
1270 PID > 0 means status is requested for a single child process
1271 whose pid is PID.
1273 PID = 0 means status is requested for any child process whose
1274 process group ID is equal to that of the calling process. But
1275 since Windows has only a limited support for process groups (only
1276 for console processes and only for the purposes of passing
1277 Ctrl-BREAK signal to them), and since we have no documented way
1278 of determining whether a given process belongs to our group, we
1279 treat 0 as -1.
1281 PID < -1 means status is requested for any child process whose
1282 process group ID is equal to the absolute value of PID. Again,
1283 since we don't support process groups, we treat that as -1. */
1284 if (pid > 0)
1286 int our_child = 0;
1288 /* We are requested to wait for a specific child. */
1289 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1291 /* Some child_procs might be sockets; ignore them. Also
1292 ignore subprocesses whose output is not yet completely
1293 read. */
1294 if (CHILD_ACTIVE (cp)
1295 && cp->procinfo.hProcess
1296 && cp->pid == pid)
1298 our_child = 1;
1299 break;
1302 if (our_child)
1304 if (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1306 wait_hnd[nh] = cp->procinfo.hProcess;
1307 cps[nh] = cp;
1308 nh++;
1310 else if (dont_wait)
1312 /* PID specifies our subprocess, but its status is not
1313 yet available. */
1314 return 0;
1317 if (nh == 0)
1319 /* No such child process, or nothing to wait for, so fail. */
1320 errno = ECHILD;
1321 return -1;
1324 else
1326 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1328 if (CHILD_ACTIVE (cp)
1329 && cp->procinfo.hProcess
1330 && (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0))
1332 wait_hnd[nh] = cp->procinfo.hProcess;
1333 cps[nh] = cp;
1334 nh++;
1337 if (nh == 0)
1339 /* Nothing to wait on, so fail. */
1340 errno = ECHILD;
1341 return -1;
1345 if (dont_wait)
1346 timeout_ms = 0;
1347 else
1348 timeout_ms = 1000; /* check for quit about once a second. */
1352 QUIT;
1353 active = WaitForMultipleObjects (nh, wait_hnd, FALSE, timeout_ms);
1354 } while (active == WAIT_TIMEOUT && !dont_wait);
1356 if (active == WAIT_FAILED)
1358 errno = EBADF;
1359 return -1;
1361 else if (active == WAIT_TIMEOUT && dont_wait)
1363 /* PID specifies our subprocess, but it didn't exit yet, so its
1364 status is not yet available. */
1365 #ifdef FULL_DEBUG
1366 DebPrint (("Wait: PID %d not reap yet\n", cp->pid));
1367 #endif
1368 return 0;
1370 else if (active >= WAIT_OBJECT_0
1371 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1373 active -= WAIT_OBJECT_0;
1375 else if (active >= WAIT_ABANDONED_0
1376 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1378 active -= WAIT_ABANDONED_0;
1380 else
1381 emacs_abort ();
1383 if (!GetExitCodeProcess (wait_hnd[active], &retval))
1385 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1386 GetLastError ()));
1387 retval = 1;
1389 if (retval == STILL_ACTIVE)
1391 /* Should never happen. */
1392 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1393 if (pid > 0 && dont_wait)
1394 return 0;
1395 errno = EINVAL;
1396 return -1;
1399 /* Massage the exit code from the process to match the format expected
1400 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1401 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1403 if (retval == STATUS_CONTROL_C_EXIT)
1404 retval = SIGINT;
1405 else
1406 retval <<= 8;
1408 if (pid > 0 && active != 0)
1409 emacs_abort ();
1410 cp = cps[active];
1411 pid = cp->pid;
1412 #ifdef FULL_DEBUG
1413 DebPrint (("Wait signaled with process pid %d\n", cp->pid));
1414 #endif
1416 if (status)
1417 *status = retval;
1418 reap_subprocess (cp);
1420 return pid;
1423 /* Old versions of w32api headers don't have separate 32-bit and
1424 64-bit defines, but the one they have matches the 32-bit variety. */
1425 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1426 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1427 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1428 #endif
1430 static void
1431 w32_executable_type (char * filename,
1432 int * is_dos_app,
1433 int * is_cygnus_app,
1434 int * is_gui_app)
1436 file_data executable;
1437 char * p;
1439 /* Default values in case we can't tell for sure. */
1440 *is_dos_app = FALSE;
1441 *is_cygnus_app = FALSE;
1442 *is_gui_app = FALSE;
1444 if (!open_input_file (&executable, filename))
1445 return;
1447 p = strrchr (filename, '.');
1449 /* We can only identify DOS .com programs from the extension. */
1450 if (p && xstrcasecmp (p, ".com") == 0)
1451 *is_dos_app = TRUE;
1452 else if (p && (xstrcasecmp (p, ".bat") == 0
1453 || xstrcasecmp (p, ".cmd") == 0))
1455 /* A DOS shell script - it appears that CreateProcess is happy to
1456 accept this (somewhat surprisingly); presumably it looks at
1457 COMSPEC to determine what executable to actually invoke.
1458 Therefore, we have to do the same here as well. */
1459 /* Actually, I think it uses the program association for that
1460 extension, which is defined in the registry. */
1461 p = egetenv ("COMSPEC");
1462 if (p)
1463 w32_executable_type (p, is_dos_app, is_cygnus_app, is_gui_app);
1465 else
1467 /* Look for DOS .exe signature - if found, we must also check that
1468 it isn't really a 16- or 32-bit Windows exe, since both formats
1469 start with a DOS program stub. Note that 16-bit Windows
1470 executables use the OS/2 1.x format. */
1472 IMAGE_DOS_HEADER * dos_header;
1473 IMAGE_NT_HEADERS * nt_header;
1475 dos_header = (PIMAGE_DOS_HEADER) executable.file_base;
1476 if (dos_header->e_magic != IMAGE_DOS_SIGNATURE)
1477 goto unwind;
1479 nt_header = (PIMAGE_NT_HEADERS) ((unsigned char *) dos_header + dos_header->e_lfanew);
1481 if ((char *) nt_header > (char *) dos_header + executable.size)
1483 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1484 *is_dos_app = TRUE;
1486 else if (nt_header->Signature != IMAGE_NT_SIGNATURE
1487 && LOWORD (nt_header->Signature) != IMAGE_OS2_SIGNATURE)
1489 *is_dos_app = TRUE;
1491 else if (nt_header->Signature == IMAGE_NT_SIGNATURE)
1493 IMAGE_DATA_DIRECTORY *data_dir = NULL;
1494 if (nt_header->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)
1496 /* Ensure we are using the 32 bit structure. */
1497 IMAGE_OPTIONAL_HEADER32 *opt
1498 = (IMAGE_OPTIONAL_HEADER32*) &(nt_header->OptionalHeader);
1499 data_dir = opt->DataDirectory;
1500 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1502 /* MingW 3.12 has the required 64 bit structs, but in case older
1503 versions don't, only check 64 bit exes if we know how. */
1504 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1505 else if (nt_header->OptionalHeader.Magic
1506 == IMAGE_NT_OPTIONAL_HDR64_MAGIC)
1508 IMAGE_OPTIONAL_HEADER64 *opt
1509 = (IMAGE_OPTIONAL_HEADER64*) &(nt_header->OptionalHeader);
1510 data_dir = opt->DataDirectory;
1511 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1513 #endif
1514 if (data_dir)
1516 /* Look for cygwin.dll in DLL import list. */
1517 IMAGE_DATA_DIRECTORY import_dir =
1518 data_dir[IMAGE_DIRECTORY_ENTRY_IMPORT];
1519 IMAGE_IMPORT_DESCRIPTOR * imports;
1520 IMAGE_SECTION_HEADER * section;
1522 section = rva_to_section (import_dir.VirtualAddress, nt_header);
1523 imports = RVA_TO_PTR (import_dir.VirtualAddress, section,
1524 executable);
1526 for ( ; imports->Name; imports++)
1528 char * dllname = RVA_TO_PTR (imports->Name, section,
1529 executable);
1531 /* The exact name of the cygwin dll has changed with
1532 various releases, but hopefully this will be reasonably
1533 future proof. */
1534 if (strncmp (dllname, "cygwin", 6) == 0)
1536 *is_cygnus_app = TRUE;
1537 break;
1544 unwind:
1545 close_file_data (&executable);
1548 static int
1549 compare_env (const void *strp1, const void *strp2)
1551 const char *str1 = *(const char **)strp1, *str2 = *(const char **)strp2;
1553 while (*str1 && *str2 && *str1 != '=' && *str2 != '=')
1555 /* Sort order in command.com/cmd.exe is based on uppercasing
1556 names, so do the same here. */
1557 if (toupper (*str1) > toupper (*str2))
1558 return 1;
1559 else if (toupper (*str1) < toupper (*str2))
1560 return -1;
1561 str1++, str2++;
1564 if (*str1 == '=' && *str2 == '=')
1565 return 0;
1566 else if (*str1 == '=')
1567 return -1;
1568 else
1569 return 1;
1572 static void
1573 merge_and_sort_env (char **envp1, char **envp2, char **new_envp)
1575 char **optr, **nptr;
1576 int num;
1578 nptr = new_envp;
1579 optr = envp1;
1580 while (*optr)
1581 *nptr++ = *optr++;
1582 num = optr - envp1;
1584 optr = envp2;
1585 while (*optr)
1586 *nptr++ = *optr++;
1587 num += optr - envp2;
1589 qsort (new_envp, num, sizeof (char *), compare_env);
1591 *nptr = NULL;
1594 /* When a new child process is created we need to register it in our list,
1595 so intercept spawn requests. */
1597 sys_spawnve (int mode, char *cmdname, char **argv, char **envp)
1599 Lisp_Object program, full;
1600 char *cmdline, *env, *parg, **targ;
1601 int arglen, numenv;
1602 pid_t pid;
1603 child_process *cp;
1604 int is_dos_app, is_cygnus_app, is_gui_app;
1605 int do_quoting = 0;
1606 /* We pass our process ID to our children by setting up an environment
1607 variable in their environment. */
1608 char ppid_env_var_buffer[64];
1609 char *extra_env[] = {ppid_env_var_buffer, NULL};
1610 /* These are the characters that cause an argument to need quoting.
1611 Arguments with whitespace characters need quoting to prevent the
1612 argument being split into two or more. Arguments with wildcards
1613 are also quoted, for consistency with posix platforms, where wildcards
1614 are not expanded if we run the program directly without a shell.
1615 Some extra whitespace characters need quoting in Cygwin programs,
1616 so this list is conditionally modified below. */
1617 char *sepchars = " \t*?";
1618 /* This is for native w32 apps; modified below for Cygwin apps. */
1619 char escape_char = '\\';
1621 /* We don't care about the other modes */
1622 if (mode != _P_NOWAIT)
1624 errno = EINVAL;
1625 return -1;
1628 /* Handle executable names without an executable suffix. */
1629 program = build_string (cmdname);
1630 if (NILP (Ffile_executable_p (program)))
1632 struct gcpro gcpro1;
1634 full = Qnil;
1635 GCPRO1 (program);
1636 openp (Vexec_path, program, Vexec_suffixes, &full, make_number (X_OK));
1637 UNGCPRO;
1638 if (NILP (full))
1640 errno = EINVAL;
1641 return -1;
1643 program = full;
1646 /* make sure argv[0] and cmdname are both in DOS format */
1647 cmdname = SDATA (program);
1648 unixtodos_filename (cmdname);
1649 argv[0] = cmdname;
1651 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1652 executable that is implicitly linked to the Cygnus dll (implying it
1653 was compiled with the Cygnus GNU toolchain and hence relies on
1654 cygwin.dll to parse the command line - we use this to decide how to
1655 escape quote chars in command line args that must be quoted).
1657 Also determine whether it is a GUI app, so that we don't hide its
1658 initial window unless specifically requested. */
1659 w32_executable_type (cmdname, &is_dos_app, &is_cygnus_app, &is_gui_app);
1661 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1662 application to start it by specifying the helper app as cmdname,
1663 while leaving the real app name as argv[0]. */
1664 if (is_dos_app)
1666 cmdname = alloca (MAXPATHLEN);
1667 if (egetenv ("CMDPROXY"))
1668 strcpy (cmdname, egetenv ("CMDPROXY"));
1669 else
1671 strcpy (cmdname, SDATA (Vinvocation_directory));
1672 strcat (cmdname, "cmdproxy.exe");
1674 unixtodos_filename (cmdname);
1677 /* we have to do some conjuring here to put argv and envp into the
1678 form CreateProcess wants... argv needs to be a space separated/null
1679 terminated list of parameters, and envp is a null
1680 separated/double-null terminated list of parameters.
1682 Additionally, zero-length args and args containing whitespace or
1683 quote chars need to be wrapped in double quotes - for this to work,
1684 embedded quotes need to be escaped as well. The aim is to ensure
1685 the child process reconstructs the argv array we start with
1686 exactly, so we treat quotes at the beginning and end of arguments
1687 as embedded quotes.
1689 The w32 GNU-based library from Cygnus doubles quotes to escape
1690 them, while MSVC uses backslash for escaping. (Actually the MSVC
1691 startup code does attempt to recognize doubled quotes and accept
1692 them, but gets it wrong and ends up requiring three quotes to get a
1693 single embedded quote!) So by default we decide whether to use
1694 quote or backslash as the escape character based on whether the
1695 binary is apparently a Cygnus compiled app.
1697 Note that using backslash to escape embedded quotes requires
1698 additional special handling if an embedded quote is already
1699 preceded by backslash, or if an arg requiring quoting ends with
1700 backslash. In such cases, the run of escape characters needs to be
1701 doubled. For consistency, we apply this special handling as long
1702 as the escape character is not quote.
1704 Since we have no idea how large argv and envp are likely to be we
1705 figure out list lengths on the fly and allocate them. */
1707 if (!NILP (Vw32_quote_process_args))
1709 do_quoting = 1;
1710 /* Override escape char by binding w32-quote-process-args to
1711 desired character, or use t for auto-selection. */
1712 if (INTEGERP (Vw32_quote_process_args))
1713 escape_char = XINT (Vw32_quote_process_args);
1714 else
1715 escape_char = is_cygnus_app ? '"' : '\\';
1718 /* Cygwin apps needs quoting a bit more often. */
1719 if (escape_char == '"')
1720 sepchars = "\r\n\t\f '";
1722 /* do argv... */
1723 arglen = 0;
1724 targ = argv;
1725 while (*targ)
1727 char * p = *targ;
1728 int need_quotes = 0;
1729 int escape_char_run = 0;
1731 if (*p == 0)
1732 need_quotes = 1;
1733 for ( ; *p; p++)
1735 if (escape_char == '"' && *p == '\\')
1736 /* If it's a Cygwin app, \ needs to be escaped. */
1737 arglen++;
1738 else if (*p == '"')
1740 /* allow for embedded quotes to be escaped */
1741 arglen++;
1742 need_quotes = 1;
1743 /* handle the case where the embedded quote is already escaped */
1744 if (escape_char_run > 0)
1746 /* To preserve the arg exactly, we need to double the
1747 preceding escape characters (plus adding one to
1748 escape the quote character itself). */
1749 arglen += escape_char_run;
1752 else if (strchr (sepchars, *p) != NULL)
1754 need_quotes = 1;
1757 if (*p == escape_char && escape_char != '"')
1758 escape_char_run++;
1759 else
1760 escape_char_run = 0;
1762 if (need_quotes)
1764 arglen += 2;
1765 /* handle the case where the arg ends with an escape char - we
1766 must not let the enclosing quote be escaped. */
1767 if (escape_char_run > 0)
1768 arglen += escape_char_run;
1770 arglen += strlen (*targ++) + 1;
1772 cmdline = alloca (arglen);
1773 targ = argv;
1774 parg = cmdline;
1775 while (*targ)
1777 char * p = *targ;
1778 int need_quotes = 0;
1780 if (*p == 0)
1781 need_quotes = 1;
1783 if (do_quoting)
1785 for ( ; *p; p++)
1786 if ((strchr (sepchars, *p) != NULL) || *p == '"')
1787 need_quotes = 1;
1789 if (need_quotes)
1791 int escape_char_run = 0;
1792 char * first;
1793 char * last;
1795 p = *targ;
1796 first = p;
1797 last = p + strlen (p) - 1;
1798 *parg++ = '"';
1799 #if 0
1800 /* This version does not escape quotes if they occur at the
1801 beginning or end of the arg - this could lead to incorrect
1802 behavior when the arg itself represents a command line
1803 containing quoted args. I believe this was originally done
1804 as a hack to make some things work, before
1805 `w32-quote-process-args' was added. */
1806 while (*p)
1808 if (*p == '"' && p > first && p < last)
1809 *parg++ = escape_char; /* escape embedded quotes */
1810 *parg++ = *p++;
1812 #else
1813 for ( ; *p; p++)
1815 if (*p == '"')
1817 /* double preceding escape chars if any */
1818 while (escape_char_run > 0)
1820 *parg++ = escape_char;
1821 escape_char_run--;
1823 /* escape all quote chars, even at beginning or end */
1824 *parg++ = escape_char;
1826 else if (escape_char == '"' && *p == '\\')
1827 *parg++ = '\\';
1828 *parg++ = *p;
1830 if (*p == escape_char && escape_char != '"')
1831 escape_char_run++;
1832 else
1833 escape_char_run = 0;
1835 /* double escape chars before enclosing quote */
1836 while (escape_char_run > 0)
1838 *parg++ = escape_char;
1839 escape_char_run--;
1841 #endif
1842 *parg++ = '"';
1844 else
1846 strcpy (parg, *targ);
1847 parg += strlen (*targ);
1849 *parg++ = ' ';
1850 targ++;
1852 *--parg = '\0';
1854 /* and envp... */
1855 arglen = 1;
1856 targ = envp;
1857 numenv = 1; /* for end null */
1858 while (*targ)
1860 arglen += strlen (*targ++) + 1;
1861 numenv++;
1863 /* extra env vars... */
1864 sprintf (ppid_env_var_buffer, "EM_PARENT_PROCESS_ID=%lu",
1865 GetCurrentProcessId ());
1866 arglen += strlen (ppid_env_var_buffer) + 1;
1867 numenv++;
1869 /* merge env passed in and extra env into one, and sort it. */
1870 targ = (char **) alloca (numenv * sizeof (char *));
1871 merge_and_sort_env (envp, extra_env, targ);
1873 /* concatenate env entries. */
1874 env = alloca (arglen);
1875 parg = env;
1876 while (*targ)
1878 strcpy (parg, *targ);
1879 parg += strlen (*targ++);
1880 *parg++ = '\0';
1882 *parg++ = '\0';
1883 *parg = '\0';
1885 cp = new_child ();
1886 if (cp == NULL)
1888 errno = EAGAIN;
1889 return -1;
1892 /* Now create the process. */
1893 if (!create_child (cmdname, cmdline, env, is_gui_app, &pid, cp))
1895 delete_child (cp);
1896 errno = ENOEXEC;
1897 return -1;
1900 return pid;
1903 /* Emulate the select call
1904 Wait for available input on any of the given rfds, or timeout if
1905 a timeout is given and no input is detected
1906 wfds and efds are not supported and must be NULL.
1908 For simplicity, we detect the death of child processes here and
1909 synchronously call the SIGCHLD handler. Since it is possible for
1910 children to be created without a corresponding pipe handle from which
1911 to read output, we wait separately on the process handles as well as
1912 the char_avail events for each process pipe. We only call
1913 wait/reap_process when the process actually terminates.
1915 To reduce the number of places in which Emacs can be hung such that
1916 C-g is not able to interrupt it, we always wait on interrupt_handle
1917 (which is signaled by the input thread when C-g is detected). If we
1918 detect that we were woken up by C-g, we return -1 with errno set to
1919 EINTR as on Unix. */
1921 /* From w32console.c */
1922 extern HANDLE keyboard_handle;
1924 /* From w32xfns.c */
1925 extern HANDLE interrupt_handle;
1927 /* From process.c */
1928 extern int proc_buffered_char[];
1931 sys_select (int nfds, SELECT_TYPE *rfds, SELECT_TYPE *wfds, SELECT_TYPE *efds,
1932 struct timespec *timeout, void *ignored)
1934 SELECT_TYPE orfds;
1935 DWORD timeout_ms, start_time;
1936 int i, nh, nc, nr;
1937 DWORD active;
1938 child_process *cp, *cps[MAX_CHILDREN];
1939 HANDLE wait_hnd[MAXDESC + MAX_CHILDREN];
1940 int fdindex[MAXDESC]; /* mapping from wait handles back to descriptors */
1942 timeout_ms =
1943 timeout ? (timeout->tv_sec * 1000 + timeout->tv_nsec / 1000000) : INFINITE;
1945 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1946 if (rfds == NULL && wfds == NULL && efds == NULL && timeout != NULL)
1948 Sleep (timeout_ms);
1949 return 0;
1952 /* Otherwise, we only handle rfds, so fail otherwise. */
1953 if (rfds == NULL || wfds != NULL || efds != NULL)
1955 errno = EINVAL;
1956 return -1;
1959 orfds = *rfds;
1960 FD_ZERO (rfds);
1961 nr = 0;
1963 /* Always wait on interrupt_handle, to detect C-g (quit). */
1964 wait_hnd[0] = interrupt_handle;
1965 fdindex[0] = -1;
1967 /* Build a list of pipe handles to wait on. */
1968 nh = 1;
1969 for (i = 0; i < nfds; i++)
1970 if (FD_ISSET (i, &orfds))
1972 if (i == 0)
1974 if (keyboard_handle)
1976 /* Handle stdin specially */
1977 wait_hnd[nh] = keyboard_handle;
1978 fdindex[nh] = i;
1979 nh++;
1982 /* Check for any emacs-generated input in the queue since
1983 it won't be detected in the wait */
1984 if (detect_input_pending ())
1986 FD_SET (i, rfds);
1987 return 1;
1990 else
1992 /* Child process and socket/comm port input. */
1993 cp = fd_info[i].cp;
1994 if (cp)
1996 int current_status = cp->status;
1998 if (current_status == STATUS_READ_ACKNOWLEDGED)
2000 /* Tell reader thread which file handle to use. */
2001 cp->fd = i;
2002 /* Wake up the reader thread for this process */
2003 cp->status = STATUS_READ_READY;
2004 if (!SetEvent (cp->char_consumed))
2005 DebPrint (("sys_select.SetEvent failed with "
2006 "%lu for fd %ld\n", GetLastError (), i));
2009 #ifdef CHECK_INTERLOCK
2010 /* slightly crude cross-checking of interlock between threads */
2012 current_status = cp->status;
2013 if (WaitForSingleObject (cp->char_avail, 0) == WAIT_OBJECT_0)
2015 /* char_avail has been signaled, so status (which may
2016 have changed) should indicate read has completed
2017 but has not been acknowledged. */
2018 current_status = cp->status;
2019 if (current_status != STATUS_READ_SUCCEEDED
2020 && current_status != STATUS_READ_FAILED)
2021 DebPrint (("char_avail set, but read not completed: status %d\n",
2022 current_status));
2024 else
2026 /* char_avail has not been signaled, so status should
2027 indicate that read is in progress; small possibility
2028 that read has completed but event wasn't yet signaled
2029 when we tested it (because a context switch occurred
2030 or if running on separate CPUs). */
2031 if (current_status != STATUS_READ_READY
2032 && current_status != STATUS_READ_IN_PROGRESS
2033 && current_status != STATUS_READ_SUCCEEDED
2034 && current_status != STATUS_READ_FAILED)
2035 DebPrint (("char_avail reset, but read status is bad: %d\n",
2036 current_status));
2038 #endif
2039 wait_hnd[nh] = cp->char_avail;
2040 fdindex[nh] = i;
2041 if (!wait_hnd[nh]) emacs_abort ();
2042 nh++;
2043 #ifdef FULL_DEBUG
2044 DebPrint (("select waiting on child %d fd %d\n",
2045 cp-child_procs, i));
2046 #endif
2048 else
2050 /* Unable to find something to wait on for this fd, skip */
2052 /* Note that this is not a fatal error, and can in fact
2053 happen in unusual circumstances. Specifically, if
2054 sys_spawnve fails, eg. because the program doesn't
2055 exist, and debug-on-error is t so Fsignal invokes a
2056 nested input loop, then the process output pipe is
2057 still included in input_wait_mask with no child_proc
2058 associated with it. (It is removed when the debugger
2059 exits the nested input loop and the error is thrown.) */
2061 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i));
2066 count_children:
2067 /* Add handles of child processes. */
2068 nc = 0;
2069 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
2070 /* Some child_procs might be sockets; ignore them. Also some
2071 children may have died already, but we haven't finished reading
2072 the process output; ignore them too. */
2073 if ((CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
2074 && (cp->fd < 0
2075 || (fd_info[cp->fd].flags & FILE_SEND_SIGCHLD) == 0
2076 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
2079 wait_hnd[nh + nc] = cp->procinfo.hProcess;
2080 cps[nc] = cp;
2081 nc++;
2084 /* Nothing to look for, so we didn't find anything */
2085 if (nh + nc == 0)
2087 if (timeout)
2088 Sleep (timeout_ms);
2089 return 0;
2092 start_time = GetTickCount ();
2094 /* Wait for input or child death to be signaled. If user input is
2095 allowed, then also accept window messages. */
2096 if (FD_ISSET (0, &orfds))
2097 active = MsgWaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms,
2098 QS_ALLINPUT);
2099 else
2100 active = WaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms);
2102 if (active == WAIT_FAILED)
2104 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2105 nh + nc, timeout_ms, GetLastError ()));
2106 /* don't return EBADF - this causes wait_reading_process_output to
2107 abort; WAIT_FAILED is returned when single-stepping under
2108 Windows 95 after switching thread focus in debugger, and
2109 possibly at other times. */
2110 errno = EINTR;
2111 return -1;
2113 else if (active == WAIT_TIMEOUT)
2115 return 0;
2117 else if (active >= WAIT_OBJECT_0
2118 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
2120 active -= WAIT_OBJECT_0;
2122 else if (active >= WAIT_ABANDONED_0
2123 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
2125 active -= WAIT_ABANDONED_0;
2127 else
2128 emacs_abort ();
2130 /* Loop over all handles after active (now officially documented as
2131 being the first signaled handle in the array). We do this to
2132 ensure fairness, so that all channels with data available will be
2133 processed - otherwise higher numbered channels could be starved. */
2136 if (active == nh + nc)
2138 /* There are messages in the lisp thread's queue; we must
2139 drain the queue now to ensure they are processed promptly,
2140 because if we don't do so, we will not be woken again until
2141 further messages arrive.
2143 NB. If ever we allow window message procedures to callback
2144 into lisp, we will need to ensure messages are dispatched
2145 at a safe time for lisp code to be run (*), and we may also
2146 want to provide some hooks in the dispatch loop to cater
2147 for modeless dialogs created by lisp (ie. to register
2148 window handles to pass to IsDialogMessage).
2150 (*) Note that MsgWaitForMultipleObjects above is an
2151 internal dispatch point for messages that are sent to
2152 windows created by this thread. */
2153 if (drain_message_queue ()
2154 /* If drain_message_queue returns non-zero, that means
2155 we received a WM_EMACS_FILENOTIFY message. If this
2156 is a TTY frame, we must signal the caller that keyboard
2157 input is available, so that w32_console_read_socket
2158 will be called to pick up the notifications. If we
2159 don't do that, file notifications will only work when
2160 the Emacs TTY frame has focus. */
2161 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2162 /* they asked for stdin reads */
2163 && FD_ISSET (0, &orfds)
2164 /* the stdin handle is valid */
2165 && keyboard_handle)
2167 FD_SET (0, rfds);
2168 if (nr == 0)
2169 nr = 1;
2172 else if (active >= nh)
2174 cp = cps[active - nh];
2176 /* We cannot always signal SIGCHLD immediately; if we have not
2177 finished reading the process output, we must delay sending
2178 SIGCHLD until we do. */
2180 if (cp->fd >= 0 && (fd_info[cp->fd].flags & FILE_AT_EOF) == 0)
2181 fd_info[cp->fd].flags |= FILE_SEND_SIGCHLD;
2182 /* SIG_DFL for SIGCHLD is ignore */
2183 else if (sig_handlers[SIGCHLD] != SIG_DFL &&
2184 sig_handlers[SIGCHLD] != SIG_IGN)
2186 #ifdef FULL_DEBUG
2187 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2188 cp->pid));
2189 #endif
2190 sig_handlers[SIGCHLD] (SIGCHLD);
2193 else if (fdindex[active] == -1)
2195 /* Quit (C-g) was detected. */
2196 errno = EINTR;
2197 return -1;
2199 else if (fdindex[active] == 0)
2201 /* Keyboard input available */
2202 FD_SET (0, rfds);
2203 nr++;
2205 else
2207 /* must be a socket or pipe - read ahead should have
2208 completed, either succeeding or failing. */
2209 FD_SET (fdindex[active], rfds);
2210 nr++;
2213 /* Even though wait_reading_process_output only reads from at most
2214 one channel, we must process all channels here so that we reap
2215 all children that have died. */
2216 while (++active < nh + nc)
2217 if (WaitForSingleObject (wait_hnd[active], 0) == WAIT_OBJECT_0)
2218 break;
2219 } while (active < nh + nc);
2221 /* If no input has arrived and timeout hasn't expired, wait again. */
2222 if (nr == 0)
2224 DWORD elapsed = GetTickCount () - start_time;
2226 if (timeout_ms > elapsed) /* INFINITE is MAX_UINT */
2228 if (timeout_ms != INFINITE)
2229 timeout_ms -= elapsed;
2230 goto count_children;
2234 return nr;
2237 /* Substitute for certain kill () operations */
2239 static BOOL CALLBACK
2240 find_child_console (HWND hwnd, LPARAM arg)
2242 child_process * cp = (child_process *) arg;
2243 DWORD thread_id;
2244 DWORD process_id;
2246 thread_id = GetWindowThreadProcessId (hwnd, &process_id);
2247 if (process_id == cp->procinfo.dwProcessId)
2249 char window_class[32];
2251 GetClassName (hwnd, window_class, sizeof (window_class));
2252 if (strcmp (window_class,
2253 (os_subtype == OS_9X)
2254 ? "tty"
2255 : "ConsoleWindowClass") == 0)
2257 cp->hwnd = hwnd;
2258 return FALSE;
2261 /* keep looking */
2262 return TRUE;
2265 /* Emulate 'kill', but only for other processes. */
2267 sys_kill (pid_t pid, int sig)
2269 child_process *cp;
2270 HANDLE proc_hand;
2271 int need_to_free = 0;
2272 int rc = 0;
2274 /* Each process is in its own process group. */
2275 if (pid < 0)
2276 pid = -pid;
2278 /* Only handle signals that will result in the process dying */
2279 if (sig != 0
2280 && sig != SIGINT && sig != SIGKILL && sig != SIGQUIT && sig != SIGHUP)
2282 errno = EINVAL;
2283 return -1;
2286 if (sig == 0)
2288 /* It will take _some_ time before PID 4 or less on Windows will
2289 be Emacs... */
2290 if (pid <= 4)
2292 errno = EPERM;
2293 return -1;
2295 proc_hand = OpenProcess (PROCESS_QUERY_INFORMATION, 0, pid);
2296 if (proc_hand == NULL)
2298 DWORD err = GetLastError ();
2300 switch (err)
2302 case ERROR_ACCESS_DENIED: /* existing process, but access denied */
2303 errno = EPERM;
2304 return -1;
2305 case ERROR_INVALID_PARAMETER: /* process PID does not exist */
2306 errno = ESRCH;
2307 return -1;
2310 else
2311 CloseHandle (proc_hand);
2312 return 0;
2315 cp = find_child_pid (pid);
2316 if (cp == NULL)
2318 /* We were passed a PID of something other than our subprocess.
2319 If that is our own PID, we will send to ourself a message to
2320 close the selected frame, which does not necessarily
2321 terminates Emacs. But then we are not supposed to call
2322 sys_kill with our own PID. */
2323 proc_hand = OpenProcess (PROCESS_TERMINATE, 0, pid);
2324 if (proc_hand == NULL)
2326 errno = EPERM;
2327 return -1;
2329 need_to_free = 1;
2331 else
2333 proc_hand = cp->procinfo.hProcess;
2334 pid = cp->procinfo.dwProcessId;
2336 /* Try to locate console window for process. */
2337 EnumWindows (find_child_console, (LPARAM) cp);
2340 if (sig == SIGINT || sig == SIGQUIT)
2342 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2344 BYTE control_scan_code = (BYTE) MapVirtualKey (VK_CONTROL, 0);
2345 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2346 BYTE vk_break_code = (sig == SIGINT) ? 'C' : VK_CANCEL;
2347 BYTE break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2348 HWND foreground_window;
2350 if (break_scan_code == 0)
2352 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2353 vk_break_code = 'C';
2354 break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2357 foreground_window = GetForegroundWindow ();
2358 if (foreground_window)
2360 /* NT 5.0, and apparently also Windows 98, will not allow
2361 a Window to be set to foreground directly without the
2362 user's involvement. The workaround is to attach
2363 ourselves to the thread that owns the foreground
2364 window, since that is the only thread that can set the
2365 foreground window. */
2366 DWORD foreground_thread, child_thread;
2367 foreground_thread =
2368 GetWindowThreadProcessId (foreground_window, NULL);
2369 if (foreground_thread == GetCurrentThreadId ()
2370 || !AttachThreadInput (GetCurrentThreadId (),
2371 foreground_thread, TRUE))
2372 foreground_thread = 0;
2374 child_thread = GetWindowThreadProcessId (cp->hwnd, NULL);
2375 if (child_thread == GetCurrentThreadId ()
2376 || !AttachThreadInput (GetCurrentThreadId (),
2377 child_thread, TRUE))
2378 child_thread = 0;
2380 /* Set the foreground window to the child. */
2381 if (SetForegroundWindow (cp->hwnd))
2383 /* Generate keystrokes as if user had typed Ctrl-Break or
2384 Ctrl-C. */
2385 keybd_event (VK_CONTROL, control_scan_code, 0, 0);
2386 keybd_event (vk_break_code, break_scan_code,
2387 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY), 0);
2388 keybd_event (vk_break_code, break_scan_code,
2389 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY)
2390 | KEYEVENTF_KEYUP, 0);
2391 keybd_event (VK_CONTROL, control_scan_code,
2392 KEYEVENTF_KEYUP, 0);
2394 /* Sleep for a bit to give time for Emacs frame to respond
2395 to focus change events (if Emacs was active app). */
2396 Sleep (100);
2398 SetForegroundWindow (foreground_window);
2400 /* Detach from the foreground and child threads now that
2401 the foreground switching is over. */
2402 if (foreground_thread)
2403 AttachThreadInput (GetCurrentThreadId (),
2404 foreground_thread, FALSE);
2405 if (child_thread)
2406 AttachThreadInput (GetCurrentThreadId (),
2407 child_thread, FALSE);
2410 /* Ctrl-Break is NT equivalent of SIGINT. */
2411 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT, pid))
2413 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2414 "for pid %lu\n", GetLastError (), pid));
2415 errno = EINVAL;
2416 rc = -1;
2419 else
2421 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2423 #if 1
2424 if (os_subtype == OS_9X)
2427 Another possibility is to try terminating the VDM out-right by
2428 calling the Shell VxD (id 0x17) V86 interface, function #4
2429 "SHELL_Destroy_VM", ie.
2431 mov edx,4
2432 mov ebx,vm_handle
2433 call shellapi
2435 First need to determine the current VM handle, and then arrange for
2436 the shellapi call to be made from the system vm (by using
2437 Switch_VM_and_callback).
2439 Could try to invoke DestroyVM through CallVxD.
2442 #if 0
2443 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2444 to hang when cmdproxy is used in conjunction with
2445 command.com for an interactive shell. Posting
2446 WM_CLOSE pops up a dialog that, when Yes is selected,
2447 does the same thing. TerminateProcess is also less
2448 than ideal in that subprocesses tend to stick around
2449 until the machine is shutdown, but at least it
2450 doesn't freeze the 16-bit subsystem. */
2451 PostMessage (cp->hwnd, WM_QUIT, 0xff, 0);
2452 #endif
2453 if (!TerminateProcess (proc_hand, 0xff))
2455 DebPrint (("sys_kill.TerminateProcess returned %d "
2456 "for pid %lu\n", GetLastError (), pid));
2457 errno = EINVAL;
2458 rc = -1;
2461 else
2462 #endif
2463 PostMessage (cp->hwnd, WM_CLOSE, 0, 0);
2465 /* Kill the process. On W32 this doesn't kill child processes
2466 so it doesn't work very well for shells which is why it's not
2467 used in every case. */
2468 else if (!TerminateProcess (proc_hand, 0xff))
2470 DebPrint (("sys_kill.TerminateProcess returned %d "
2471 "for pid %lu\n", GetLastError (), pid));
2472 errno = EINVAL;
2473 rc = -1;
2477 if (need_to_free)
2478 CloseHandle (proc_hand);
2480 return rc;
2483 /* The following two routines are used to manipulate stdin, stdout, and
2484 stderr of our child processes.
2486 Assuming that in, out, and err are *not* inheritable, we make them
2487 stdin, stdout, and stderr of the child as follows:
2489 - Save the parent's current standard handles.
2490 - Set the std handles to inheritable duplicates of the ones being passed in.
2491 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2492 NT file handle for a crt file descriptor.)
2493 - Spawn the child, which inherits in, out, and err as stdin,
2494 stdout, and stderr. (see Spawnve)
2495 - Close the std handles passed to the child.
2496 - Reset the parent's standard handles to the saved handles.
2497 (see reset_standard_handles)
2498 We assume that the caller closes in, out, and err after calling us. */
2500 void
2501 prepare_standard_handles (int in, int out, int err, HANDLE handles[3])
2503 HANDLE parent;
2504 HANDLE newstdin, newstdout, newstderr;
2506 parent = GetCurrentProcess ();
2508 handles[0] = GetStdHandle (STD_INPUT_HANDLE);
2509 handles[1] = GetStdHandle (STD_OUTPUT_HANDLE);
2510 handles[2] = GetStdHandle (STD_ERROR_HANDLE);
2512 /* make inheritable copies of the new handles */
2513 if (!DuplicateHandle (parent,
2514 (HANDLE) _get_osfhandle (in),
2515 parent,
2516 &newstdin,
2518 TRUE,
2519 DUPLICATE_SAME_ACCESS))
2520 report_file_error ("Duplicating input handle for child", Qnil);
2522 if (!DuplicateHandle (parent,
2523 (HANDLE) _get_osfhandle (out),
2524 parent,
2525 &newstdout,
2527 TRUE,
2528 DUPLICATE_SAME_ACCESS))
2529 report_file_error ("Duplicating output handle for child", Qnil);
2531 if (!DuplicateHandle (parent,
2532 (HANDLE) _get_osfhandle (err),
2533 parent,
2534 &newstderr,
2536 TRUE,
2537 DUPLICATE_SAME_ACCESS))
2538 report_file_error ("Duplicating error handle for child", Qnil);
2540 /* and store them as our std handles */
2541 if (!SetStdHandle (STD_INPUT_HANDLE, newstdin))
2542 report_file_error ("Changing stdin handle", Qnil);
2544 if (!SetStdHandle (STD_OUTPUT_HANDLE, newstdout))
2545 report_file_error ("Changing stdout handle", Qnil);
2547 if (!SetStdHandle (STD_ERROR_HANDLE, newstderr))
2548 report_file_error ("Changing stderr handle", Qnil);
2551 void
2552 reset_standard_handles (int in, int out, int err, HANDLE handles[3])
2554 /* close the duplicated handles passed to the child */
2555 CloseHandle (GetStdHandle (STD_INPUT_HANDLE));
2556 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE));
2557 CloseHandle (GetStdHandle (STD_ERROR_HANDLE));
2559 /* now restore parent's saved std handles */
2560 SetStdHandle (STD_INPUT_HANDLE, handles[0]);
2561 SetStdHandle (STD_OUTPUT_HANDLE, handles[1]);
2562 SetStdHandle (STD_ERROR_HANDLE, handles[2]);
2565 void
2566 set_process_dir (char * dir)
2568 process_dir = dir;
2571 /* To avoid problems with winsock implementations that work over dial-up
2572 connections causing or requiring a connection to exist while Emacs is
2573 running, Emacs no longer automatically loads winsock on startup if it
2574 is present. Instead, it will be loaded when open-network-stream is
2575 first called.
2577 To allow full control over when winsock is loaded, we provide these
2578 two functions to dynamically load and unload winsock. This allows
2579 dial-up users to only be connected when they actually need to use
2580 socket services. */
2582 /* From w32.c */
2583 extern HANDLE winsock_lib;
2584 extern BOOL term_winsock (void);
2585 extern BOOL init_winsock (int load_now);
2587 DEFUN ("w32-has-winsock", Fw32_has_winsock, Sw32_has_winsock, 0, 1, 0,
2588 doc: /* Test for presence of the Windows socket library `winsock'.
2589 Returns non-nil if winsock support is present, nil otherwise.
2591 If the optional argument LOAD-NOW is non-nil, the winsock library is
2592 also loaded immediately if not already loaded. If winsock is loaded,
2593 the winsock local hostname is returned (since this may be different from
2594 the value of `system-name' and should supplant it), otherwise t is
2595 returned to indicate winsock support is present. */)
2596 (Lisp_Object load_now)
2598 int have_winsock;
2600 have_winsock = init_winsock (!NILP (load_now));
2601 if (have_winsock)
2603 if (winsock_lib != NULL)
2605 /* Return new value for system-name. The best way to do this
2606 is to call init_system_name, saving and restoring the
2607 original value to avoid side-effects. */
2608 Lisp_Object orig_hostname = Vsystem_name;
2609 Lisp_Object hostname;
2611 init_system_name ();
2612 hostname = Vsystem_name;
2613 Vsystem_name = orig_hostname;
2614 return hostname;
2616 return Qt;
2618 return Qnil;
2621 DEFUN ("w32-unload-winsock", Fw32_unload_winsock, Sw32_unload_winsock,
2622 0, 0, 0,
2623 doc: /* Unload the Windows socket library `winsock' if loaded.
2624 This is provided to allow dial-up socket connections to be disconnected
2625 when no longer needed. Returns nil without unloading winsock if any
2626 socket connections still exist. */)
2627 (void)
2629 return term_winsock () ? Qt : Qnil;
2633 /* Some miscellaneous functions that are Windows specific, but not GUI
2634 specific (ie. are applicable in terminal or batch mode as well). */
2636 DEFUN ("w32-short-file-name", Fw32_short_file_name, Sw32_short_file_name, 1, 1, 0,
2637 doc: /* Return the short file name version (8.3) of the full path of FILENAME.
2638 If FILENAME does not exist, return nil.
2639 All path elements in FILENAME are converted to their short names. */)
2640 (Lisp_Object filename)
2642 char shortname[MAX_PATH];
2644 CHECK_STRING (filename);
2646 /* first expand it. */
2647 filename = Fexpand_file_name (filename, Qnil);
2649 /* luckily, this returns the short version of each element in the path. */
2650 if (GetShortPathName (SDATA (ENCODE_FILE (filename)), shortname, MAX_PATH) == 0)
2651 return Qnil;
2653 dostounix_filename (shortname, 0);
2655 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2656 return build_string (shortname);
2660 DEFUN ("w32-long-file-name", Fw32_long_file_name, Sw32_long_file_name,
2661 1, 1, 0,
2662 doc: /* Return the long file name version of the full path of FILENAME.
2663 If FILENAME does not exist, return nil.
2664 All path elements in FILENAME are converted to their long names. */)
2665 (Lisp_Object filename)
2667 char longname[ MAX_PATH ];
2668 int drive_only = 0;
2670 CHECK_STRING (filename);
2672 if (SBYTES (filename) == 2
2673 && *(SDATA (filename) + 1) == ':')
2674 drive_only = 1;
2676 /* first expand it. */
2677 filename = Fexpand_file_name (filename, Qnil);
2679 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename)), longname, MAX_PATH))
2680 return Qnil;
2682 dostounix_filename (longname, 0);
2684 /* If we were passed only a drive, make sure that a slash is not appended
2685 for consistency with directories. Allow for drive mapping via SUBST
2686 in case expand-file-name is ever changed to expand those. */
2687 if (drive_only && longname[1] == ':' && longname[2] == '/' && !longname[3])
2688 longname[2] = '\0';
2690 return DECODE_FILE (build_string (longname));
2693 DEFUN ("w32-set-process-priority", Fw32_set_process_priority,
2694 Sw32_set_process_priority, 2, 2, 0,
2695 doc: /* Set the priority of PROCESS to PRIORITY.
2696 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2697 priority of the process whose pid is PROCESS is changed.
2698 PRIORITY should be one of the symbols high, normal, or low;
2699 any other symbol will be interpreted as normal.
2701 If successful, the return value is t, otherwise nil. */)
2702 (Lisp_Object process, Lisp_Object priority)
2704 HANDLE proc_handle = GetCurrentProcess ();
2705 DWORD priority_class = NORMAL_PRIORITY_CLASS;
2706 Lisp_Object result = Qnil;
2708 CHECK_SYMBOL (priority);
2710 if (!NILP (process))
2712 DWORD pid;
2713 child_process *cp;
2715 CHECK_NUMBER (process);
2717 /* Allow pid to be an internally generated one, or one obtained
2718 externally. This is necessary because real pids on Windows 95 are
2719 negative. */
2721 pid = XINT (process);
2722 cp = find_child_pid (pid);
2723 if (cp != NULL)
2724 pid = cp->procinfo.dwProcessId;
2726 proc_handle = OpenProcess (PROCESS_SET_INFORMATION, FALSE, pid);
2729 if (EQ (priority, Qhigh))
2730 priority_class = HIGH_PRIORITY_CLASS;
2731 else if (EQ (priority, Qlow))
2732 priority_class = IDLE_PRIORITY_CLASS;
2734 if (proc_handle != NULL)
2736 if (SetPriorityClass (proc_handle, priority_class))
2737 result = Qt;
2738 if (!NILP (process))
2739 CloseHandle (proc_handle);
2742 return result;
2745 #ifdef HAVE_LANGINFO_CODESET
2746 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2747 char *
2748 nl_langinfo (nl_item item)
2750 /* Conversion of Posix item numbers to their Windows equivalents. */
2751 static const LCTYPE w32item[] = {
2752 LOCALE_IDEFAULTANSICODEPAGE,
2753 LOCALE_SDAYNAME1, LOCALE_SDAYNAME2, LOCALE_SDAYNAME3,
2754 LOCALE_SDAYNAME4, LOCALE_SDAYNAME5, LOCALE_SDAYNAME6, LOCALE_SDAYNAME7,
2755 LOCALE_SMONTHNAME1, LOCALE_SMONTHNAME2, LOCALE_SMONTHNAME3,
2756 LOCALE_SMONTHNAME4, LOCALE_SMONTHNAME5, LOCALE_SMONTHNAME6,
2757 LOCALE_SMONTHNAME7, LOCALE_SMONTHNAME8, LOCALE_SMONTHNAME9,
2758 LOCALE_SMONTHNAME10, LOCALE_SMONTHNAME11, LOCALE_SMONTHNAME12
2761 static char *nl_langinfo_buf = NULL;
2762 static int nl_langinfo_len = 0;
2764 if (nl_langinfo_len <= 0)
2765 nl_langinfo_buf = xmalloc (nl_langinfo_len = 1);
2767 if (item < 0 || item >= _NL_NUM)
2768 nl_langinfo_buf[0] = 0;
2769 else
2771 LCID cloc = GetThreadLocale ();
2772 int need_len = GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2773 NULL, 0);
2775 if (need_len <= 0)
2776 nl_langinfo_buf[0] = 0;
2777 else
2779 if (item == CODESET)
2781 need_len += 2; /* for the "cp" prefix */
2782 if (need_len < 8) /* for the case we call GetACP */
2783 need_len = 8;
2785 if (nl_langinfo_len <= need_len)
2786 nl_langinfo_buf = xrealloc (nl_langinfo_buf,
2787 nl_langinfo_len = need_len);
2788 if (!GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2789 nl_langinfo_buf, nl_langinfo_len))
2790 nl_langinfo_buf[0] = 0;
2791 else if (item == CODESET)
2793 if (strcmp (nl_langinfo_buf, "0") == 0 /* CP_ACP */
2794 || strcmp (nl_langinfo_buf, "1") == 0) /* CP_OEMCP */
2795 sprintf (nl_langinfo_buf, "cp%u", GetACP ());
2796 else
2798 memmove (nl_langinfo_buf + 2, nl_langinfo_buf,
2799 strlen (nl_langinfo_buf) + 1);
2800 nl_langinfo_buf[0] = 'c';
2801 nl_langinfo_buf[1] = 'p';
2806 return nl_langinfo_buf;
2808 #endif /* HAVE_LANGINFO_CODESET */
2810 DEFUN ("w32-get-locale-info", Fw32_get_locale_info,
2811 Sw32_get_locale_info, 1, 2, 0,
2812 doc: /* Return information about the Windows locale LCID.
2813 By default, return a three letter locale code which encodes the default
2814 language as the first two characters, and the country or regional variant
2815 as the third letter. For example, ENU refers to `English (United States)',
2816 while ENC means `English (Canadian)'.
2818 If the optional argument LONGFORM is t, the long form of the locale
2819 name is returned, e.g. `English (United States)' instead; if LONGFORM
2820 is a number, it is interpreted as an LCTYPE constant and the corresponding
2821 locale information is returned.
2823 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2824 (Lisp_Object lcid, Lisp_Object longform)
2826 int got_abbrev;
2827 int got_full;
2828 char abbrev_name[32] = { 0 };
2829 char full_name[256] = { 0 };
2831 CHECK_NUMBER (lcid);
2833 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2834 return Qnil;
2836 if (NILP (longform))
2838 got_abbrev = GetLocaleInfo (XINT (lcid),
2839 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
2840 abbrev_name, sizeof (abbrev_name));
2841 if (got_abbrev)
2842 return build_string (abbrev_name);
2844 else if (EQ (longform, Qt))
2846 got_full = GetLocaleInfo (XINT (lcid),
2847 LOCALE_SLANGUAGE | LOCALE_USE_CP_ACP,
2848 full_name, sizeof (full_name));
2849 if (got_full)
2850 return DECODE_SYSTEM (build_string (full_name));
2852 else if (NUMBERP (longform))
2854 got_full = GetLocaleInfo (XINT (lcid),
2855 XINT (longform),
2856 full_name, sizeof (full_name));
2857 /* GetLocaleInfo's return value includes the terminating null
2858 character, when the returned information is a string, whereas
2859 make_unibyte_string needs the string length without the
2860 terminating null. */
2861 if (got_full)
2862 return make_unibyte_string (full_name, got_full - 1);
2865 return Qnil;
2869 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id,
2870 Sw32_get_current_locale_id, 0, 0, 0,
2871 doc: /* Return Windows locale id for current locale setting.
2872 This is a numerical value; use `w32-get-locale-info' to convert to a
2873 human-readable form. */)
2874 (void)
2876 return make_number (GetThreadLocale ());
2879 static DWORD
2880 int_from_hex (char * s)
2882 DWORD val = 0;
2883 static char hex[] = "0123456789abcdefABCDEF";
2884 char * p;
2886 while (*s && (p = strchr (hex, *s)) != NULL)
2888 unsigned digit = p - hex;
2889 if (digit > 15)
2890 digit -= 6;
2891 val = val * 16 + digit;
2892 s++;
2894 return val;
2897 /* We need to build a global list, since the EnumSystemLocale callback
2898 function isn't given a context pointer. */
2899 Lisp_Object Vw32_valid_locale_ids;
2901 static BOOL CALLBACK
2902 enum_locale_fn (LPTSTR localeNum)
2904 DWORD id = int_from_hex (localeNum);
2905 Vw32_valid_locale_ids = Fcons (make_number (id), Vw32_valid_locale_ids);
2906 return TRUE;
2909 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids,
2910 Sw32_get_valid_locale_ids, 0, 0, 0,
2911 doc: /* Return list of all valid Windows locale ids.
2912 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2913 human-readable form. */)
2914 (void)
2916 Vw32_valid_locale_ids = Qnil;
2918 EnumSystemLocales (enum_locale_fn, LCID_SUPPORTED);
2920 Vw32_valid_locale_ids = Fnreverse (Vw32_valid_locale_ids);
2921 return Vw32_valid_locale_ids;
2925 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id, Sw32_get_default_locale_id, 0, 1, 0,
2926 doc: /* Return Windows locale id for default locale setting.
2927 By default, the system default locale setting is returned; if the optional
2928 parameter USERP is non-nil, the user default locale setting is returned.
2929 This is a numerical value; use `w32-get-locale-info' to convert to a
2930 human-readable form. */)
2931 (Lisp_Object userp)
2933 if (NILP (userp))
2934 return make_number (GetSystemDefaultLCID ());
2935 return make_number (GetUserDefaultLCID ());
2939 DEFUN ("w32-set-current-locale", Fw32_set_current_locale, Sw32_set_current_locale, 1, 1, 0,
2940 doc: /* Make Windows locale LCID be the current locale setting for Emacs.
2941 If successful, the new locale id is returned, otherwise nil. */)
2942 (Lisp_Object lcid)
2944 CHECK_NUMBER (lcid);
2946 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2947 return Qnil;
2949 if (!SetThreadLocale (XINT (lcid)))
2950 return Qnil;
2952 /* Need to set input thread locale if present. */
2953 if (dwWindowsThreadId)
2954 /* Reply is not needed. */
2955 PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETLOCALE, XINT (lcid), 0);
2957 return make_number (GetThreadLocale ());
2961 /* We need to build a global list, since the EnumCodePages callback
2962 function isn't given a context pointer. */
2963 Lisp_Object Vw32_valid_codepages;
2965 static BOOL CALLBACK
2966 enum_codepage_fn (LPTSTR codepageNum)
2968 DWORD id = atoi (codepageNum);
2969 Vw32_valid_codepages = Fcons (make_number (id), Vw32_valid_codepages);
2970 return TRUE;
2973 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages,
2974 Sw32_get_valid_codepages, 0, 0, 0,
2975 doc: /* Return list of all valid Windows codepages. */)
2976 (void)
2978 Vw32_valid_codepages = Qnil;
2980 EnumSystemCodePages (enum_codepage_fn, CP_SUPPORTED);
2982 Vw32_valid_codepages = Fnreverse (Vw32_valid_codepages);
2983 return Vw32_valid_codepages;
2987 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage,
2988 Sw32_get_console_codepage, 0, 0, 0,
2989 doc: /* Return current Windows codepage for console input. */)
2990 (void)
2992 return make_number (GetConsoleCP ());
2996 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage,
2997 Sw32_set_console_codepage, 1, 1, 0,
2998 doc: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2999 This codepage setting affects keyboard input in tty mode.
3000 If successful, the new CP is returned, otherwise nil. */)
3001 (Lisp_Object cp)
3003 CHECK_NUMBER (cp);
3005 if (!IsValidCodePage (XINT (cp)))
3006 return Qnil;
3008 if (!SetConsoleCP (XINT (cp)))
3009 return Qnil;
3011 return make_number (GetConsoleCP ());
3015 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage,
3016 Sw32_get_console_output_codepage, 0, 0, 0,
3017 doc: /* Return current Windows codepage for console output. */)
3018 (void)
3020 return make_number (GetConsoleOutputCP ());
3024 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage,
3025 Sw32_set_console_output_codepage, 1, 1, 0,
3026 doc: /* Make Windows codepage CP be the codepage for Emacs console output.
3027 This codepage setting affects display in tty mode.
3028 If successful, the new CP is returned, otherwise nil. */)
3029 (Lisp_Object cp)
3031 CHECK_NUMBER (cp);
3033 if (!IsValidCodePage (XINT (cp)))
3034 return Qnil;
3036 if (!SetConsoleOutputCP (XINT (cp)))
3037 return Qnil;
3039 return make_number (GetConsoleOutputCP ());
3043 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset,
3044 Sw32_get_codepage_charset, 1, 1, 0,
3045 doc: /* Return charset ID corresponding to codepage CP.
3046 Returns nil if the codepage is not valid. */)
3047 (Lisp_Object cp)
3049 CHARSETINFO info;
3051 CHECK_NUMBER (cp);
3053 if (!IsValidCodePage (XINT (cp)))
3054 return Qnil;
3056 if (TranslateCharsetInfo ((DWORD *) XINT (cp), &info, TCI_SRCCODEPAGE))
3057 return make_number (info.ciCharset);
3059 return Qnil;
3063 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts,
3064 Sw32_get_valid_keyboard_layouts, 0, 0, 0,
3065 doc: /* Return list of Windows keyboard languages and layouts.
3066 The return value is a list of pairs of language id and layout id. */)
3067 (void)
3069 int num_layouts = GetKeyboardLayoutList (0, NULL);
3070 HKL * layouts = (HKL *) alloca (num_layouts * sizeof (HKL));
3071 Lisp_Object obj = Qnil;
3073 if (GetKeyboardLayoutList (num_layouts, layouts) == num_layouts)
3075 while (--num_layouts >= 0)
3077 DWORD kl = (DWORD) layouts[num_layouts];
3079 obj = Fcons (Fcons (make_number (kl & 0xffff),
3080 make_number ((kl >> 16) & 0xffff)),
3081 obj);
3085 return obj;
3089 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout,
3090 Sw32_get_keyboard_layout, 0, 0, 0,
3091 doc: /* Return current Windows keyboard language and layout.
3092 The return value is the cons of the language id and the layout id. */)
3093 (void)
3095 DWORD kl = (DWORD) GetKeyboardLayout (dwWindowsThreadId);
3097 return Fcons (make_number (kl & 0xffff),
3098 make_number ((kl >> 16) & 0xffff));
3102 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout,
3103 Sw32_set_keyboard_layout, 1, 1, 0,
3104 doc: /* Make LAYOUT be the current keyboard layout for Emacs.
3105 The keyboard layout setting affects interpretation of keyboard input.
3106 If successful, the new layout id is returned, otherwise nil. */)
3107 (Lisp_Object layout)
3109 DWORD kl;
3111 CHECK_CONS (layout);
3112 CHECK_NUMBER_CAR (layout);
3113 CHECK_NUMBER_CDR (layout);
3115 kl = (XINT (XCAR (layout)) & 0xffff)
3116 | (XINT (XCDR (layout)) << 16);
3118 /* Synchronize layout with input thread. */
3119 if (dwWindowsThreadId)
3121 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETKEYBOARDLAYOUT,
3122 (WPARAM) kl, 0))
3124 MSG msg;
3125 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
3127 if (msg.wParam == 0)
3128 return Qnil;
3131 else if (!ActivateKeyboardLayout ((HKL) kl, 0))
3132 return Qnil;
3134 return Fw32_get_keyboard_layout ();
3138 void
3139 syms_of_ntproc (void)
3141 DEFSYM (Qhigh, "high");
3142 DEFSYM (Qlow, "low");
3144 defsubr (&Sw32_has_winsock);
3145 defsubr (&Sw32_unload_winsock);
3147 defsubr (&Sw32_short_file_name);
3148 defsubr (&Sw32_long_file_name);
3149 defsubr (&Sw32_set_process_priority);
3150 defsubr (&Sw32_get_locale_info);
3151 defsubr (&Sw32_get_current_locale_id);
3152 defsubr (&Sw32_get_default_locale_id);
3153 defsubr (&Sw32_get_valid_locale_ids);
3154 defsubr (&Sw32_set_current_locale);
3156 defsubr (&Sw32_get_console_codepage);
3157 defsubr (&Sw32_set_console_codepage);
3158 defsubr (&Sw32_get_console_output_codepage);
3159 defsubr (&Sw32_set_console_output_codepage);
3160 defsubr (&Sw32_get_valid_codepages);
3161 defsubr (&Sw32_get_codepage_charset);
3163 defsubr (&Sw32_get_valid_keyboard_layouts);
3164 defsubr (&Sw32_get_keyboard_layout);
3165 defsubr (&Sw32_set_keyboard_layout);
3167 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args,
3168 doc: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3169 Because Windows does not directly pass argv arrays to child processes,
3170 programs have to reconstruct the argv array by parsing the command
3171 line string. For an argument to contain a space, it must be enclosed
3172 in double quotes or it will be parsed as multiple arguments.
3174 If the value is a character, that character will be used to escape any
3175 quote characters that appear, otherwise a suitable escape character
3176 will be chosen based on the type of the program. */);
3177 Vw32_quote_process_args = Qt;
3179 DEFVAR_LISP ("w32-start-process-show-window",
3180 Vw32_start_process_show_window,
3181 doc: /* When nil, new child processes hide their windows.
3182 When non-nil, they show their window in the method of their choice.
3183 This variable doesn't affect GUI applications, which will never be hidden. */);
3184 Vw32_start_process_show_window = Qnil;
3186 DEFVAR_LISP ("w32-start-process-share-console",
3187 Vw32_start_process_share_console,
3188 doc: /* When nil, new child processes are given a new console.
3189 When non-nil, they share the Emacs console; this has the limitation of
3190 allowing only one DOS subprocess to run at a time (whether started directly
3191 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3192 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3193 otherwise respond to interrupts from Emacs. */);
3194 Vw32_start_process_share_console = Qnil;
3196 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3197 Vw32_start_process_inherit_error_mode,
3198 doc: /* When nil, new child processes revert to the default error mode.
3199 When non-nil, they inherit their error mode setting from Emacs, which stops
3200 them blocking when trying to access unmounted drives etc. */);
3201 Vw32_start_process_inherit_error_mode = Qt;
3203 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay,
3204 doc: /* Forced delay before reading subprocess output.
3205 This is done to improve the buffering of subprocess output, by
3206 avoiding the inefficiency of frequently reading small amounts of data.
3208 If positive, the value is the number of milliseconds to sleep before
3209 reading the subprocess output. If negative, the magnitude is the number
3210 of time slices to wait (effectively boosting the priority of the child
3211 process temporarily). A value of zero disables waiting entirely. */);
3212 w32_pipe_read_delay = 50;
3214 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names,
3215 doc: /* Non-nil means convert all-upper case file names to lower case.
3216 This applies when performing completions and file name expansion.
3217 Note that the value of this setting also affects remote file names,
3218 so you probably don't want to set to non-nil if you use case-sensitive
3219 filesystems via ange-ftp. */);
3220 Vw32_downcase_file_names = Qnil;
3222 #if 0
3223 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes,
3224 doc: /* Non-nil means attempt to fake realistic inode values.
3225 This works by hashing the truename of files, and should detect
3226 aliasing between long and short (8.3 DOS) names, but can have
3227 false positives because of hash collisions. Note that determining
3228 the truename of a file can be slow. */);
3229 Vw32_generate_fake_inodes = Qnil;
3230 #endif
3232 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes,
3233 doc: /* Non-nil means determine accurate file attributes in `file-attributes'.
3234 This option controls whether to issue additional system calls to determine
3235 accurate link counts, file type, and ownership information. It is more
3236 useful for files on NTFS volumes, where hard links and file security are
3237 supported, than on volumes of the FAT family.
3239 Without these system calls, link count will always be reported as 1 and file
3240 ownership will be attributed to the current user.
3241 The default value `local' means only issue these system calls for files
3242 on local fixed drives. A value of nil means never issue them.
3243 Any other non-nil value means do this even on remote and removable drives
3244 where the performance impact may be noticeable even on modern hardware. */);
3245 Vw32_get_true_file_attributes = Qlocal;
3247 staticpro (&Vw32_valid_locale_ids);
3248 staticpro (&Vw32_valid_codepages);
3250 /* end of w32proc.c */