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
33 /* must include CRT headers *before* config.h */
44 /* This definition is missing from mingw32 headers. */
45 extern BOOL WINAPI
IsValidLocale (LCID
, DWORD
);
48 #ifdef HAVE_LANGINFO_CODESET
55 #include "w32common.h"
60 #include "syssignal.h"
62 #include "dispextern.h" /* for xstrcasecmp */
65 #define RVA_TO_PTR(var,section,filedata) \
66 ((void *)((section)->PointerToRawData \
67 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
68 + (filedata).file_base))
70 Lisp_Object Qhigh
, Qlow
;
72 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
73 static signal_handler sig_handlers
[NSIG
];
75 static sigset_t sig_mask
;
77 static CRITICAL_SECTION crit_sig
;
79 /* Improve on the CRT 'signal' implementation so that we could record
80 the SIGCHLD handler and fake interval timers. */
82 sys_signal (int sig
, signal_handler handler
)
86 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
87 below. SIGALRM and SIGPROF are used by setitimer. All the
88 others are the only ones supported by the MS runtime. */
89 if (!(sig
== SIGCHLD
|| sig
== SIGSEGV
|| sig
== SIGILL
90 || sig
== SIGFPE
|| sig
== SIGABRT
|| sig
== SIGTERM
91 || sig
== SIGALRM
|| sig
== SIGPROF
))
96 old
= sig_handlers
[sig
];
97 /* SIGABRT is treated specially because w32.c installs term_ntproc
98 as its handler, so we don't want to override that afterwards.
99 Aborting Emacs works specially anyway: either by calling
100 emacs_abort directly or through terminate_due_to_signal, which
101 calls emacs_abort through emacs_raise. */
102 if (!(sig
== SIGABRT
&& old
== term_ntproc
))
104 sig_handlers
[sig
] = handler
;
105 if (!(sig
== SIGCHLD
|| sig
== SIGALRM
|| sig
== SIGPROF
))
106 signal (sig
, handler
);
111 /* Emulate sigaction. */
113 sigaction (int sig
, const struct sigaction
*act
, struct sigaction
*oact
)
115 signal_handler old
= SIG_DFL
;
119 old
= sys_signal (sig
, act
->sa_handler
);
121 old
= sig_handlers
[sig
];
130 oact
->sa_handler
= old
;
132 oact
->sa_mask
= empty_mask
;
137 /* Emulate signal sets and blocking of signals used by timers. */
140 sigemptyset (sigset_t
*set
)
147 sigaddset (sigset_t
*set
, int signo
)
154 if (signo
< 0 || signo
>= NSIG
)
160 *set
|= (1U << signo
);
166 sigfillset (sigset_t
*set
)
179 sigprocmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
181 if (!(how
== SIG_BLOCK
|| how
== SIG_UNBLOCK
|| how
== SIG_SETMASK
))
202 /* FIXME: Catch signals that are blocked and reissue them when
203 they are unblocked. Important for SIGALRM and SIGPROF only. */
212 pthread_sigmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
214 if (sigprocmask (how
, set
, oset
) == -1)
220 sigismember (const sigset_t
*set
, int signo
)
222 if (signo
< 0 || signo
>= NSIG
)
227 if (signo
> sizeof (*set
) * BITS_PER_CHAR
)
230 return (*set
& (1U << signo
)) != 0;
234 setpgrp (int pid
, int gid
)
246 setpgid (pid_t pid
, pid_t pgid
)
251 /* Emulations of interval timers.
253 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
255 Implementation: a separate thread is started for each timer type,
256 the thread calls the appropriate signal handler when the timer
257 expires, after stopping the thread which installed the timer. */
260 volatile ULONGLONG expire
;
261 volatile ULONGLONG reload
;
262 volatile int terminate
;
264 HANDLE caller_thread
;
268 static ULONGLONG ticks_now
;
269 static struct itimer_data real_itimer
, prof_itimer
;
270 static ULONGLONG clocks_min
;
271 /* If non-zero, itimers are disabled. Used during shutdown, when we
272 delete the critical sections used by the timer threads. */
273 static int disable_itimers
;
275 static CRITICAL_SECTION crit_real
, crit_prof
;
277 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
278 typedef BOOL (WINAPI
*GetThreadTimes_Proc
) (
280 LPFILETIME lpCreationTime
,
281 LPFILETIME lpExitTime
,
282 LPFILETIME lpKernelTime
,
283 LPFILETIME lpUserTime
);
285 static GetThreadTimes_Proc s_pfn_Get_Thread_Times
;
287 #define MAX_SINGLE_SLEEP 30
288 #define TIMER_TICKS_PER_SEC 1000
290 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
291 to a thread. If THREAD is NULL or an invalid handle, return the
292 current wall-clock time since January 1, 1601 (UTC). Otherwise,
293 return the sum of kernel and user times used by THREAD since it was
294 created, plus its creation time. */
296 w32_get_timer_time (HANDLE thread
)
299 int use_system_time
= 1;
300 /* The functions below return times in 100-ns units. */
301 const int tscale
= 10 * TIMER_TICKS_PER_SEC
;
303 if (thread
&& thread
!= INVALID_HANDLE_VALUE
304 && s_pfn_Get_Thread_Times
!= NULL
)
306 FILETIME creation_ftime
, exit_ftime
, kernel_ftime
, user_ftime
;
307 ULARGE_INTEGER temp_creation
, temp_kernel
, temp_user
;
309 if (s_pfn_Get_Thread_Times (thread
, &creation_ftime
, &exit_ftime
,
310 &kernel_ftime
, &user_ftime
))
313 temp_creation
.LowPart
= creation_ftime
.dwLowDateTime
;
314 temp_creation
.HighPart
= creation_ftime
.dwHighDateTime
;
315 temp_kernel
.LowPart
= kernel_ftime
.dwLowDateTime
;
316 temp_kernel
.HighPart
= kernel_ftime
.dwHighDateTime
;
317 temp_user
.LowPart
= user_ftime
.dwLowDateTime
;
318 temp_user
.HighPart
= user_ftime
.dwHighDateTime
;
320 temp_creation
.QuadPart
/ tscale
+ temp_kernel
.QuadPart
/ tscale
321 + temp_user
.QuadPart
/ tscale
;
324 DebPrint (("GetThreadTimes failed with error code %lu\n",
330 FILETIME current_ftime
;
333 GetSystemTimeAsFileTime (¤t_ftime
);
335 temp
.LowPart
= current_ftime
.dwLowDateTime
;
336 temp
.HighPart
= current_ftime
.dwHighDateTime
;
338 retval
= temp
.QuadPart
/ tscale
;
344 /* Thread function for a timer thread. */
346 timer_loop (LPVOID arg
)
348 struct itimer_data
*itimer
= (struct itimer_data
*)arg
;
349 int which
= itimer
->type
;
350 int sig
= (which
== ITIMER_REAL
) ? SIGALRM
: SIGPROF
;
351 CRITICAL_SECTION
*crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
352 const DWORD max_sleep
= MAX_SINGLE_SLEEP
* 1000 / TIMER_TICKS_PER_SEC
;
353 HANDLE hth
= (which
== ITIMER_REAL
) ? NULL
: itimer
->caller_thread
;
358 signal_handler handler
;
359 ULONGLONG now
, expire
, reload
;
361 /* Load new values if requested by setitimer. */
362 EnterCriticalSection (crit
);
363 expire
= itimer
->expire
;
364 reload
= itimer
->reload
;
365 LeaveCriticalSection (crit
);
366 if (itimer
->terminate
)
376 if (expire
> (now
= w32_get_timer_time (hth
)))
377 sleep_time
= expire
- now
;
380 /* Don't sleep too long at a time, to be able to see the
381 termination flag without too long a delay. */
382 while (sleep_time
> max_sleep
)
384 if (itimer
->terminate
)
387 EnterCriticalSection (crit
);
388 expire
= itimer
->expire
;
389 LeaveCriticalSection (crit
);
391 (expire
> (now
= w32_get_timer_time (hth
))) ? expire
- now
: 0;
393 if (itimer
->terminate
)
397 Sleep (sleep_time
* 1000 / TIMER_TICKS_PER_SEC
);
398 /* Always sleep past the expiration time, to make sure we
399 never call the handler _before_ the expiration time,
400 always slightly after it. Sleep(5) makes sure we don't
401 hog the CPU by calling 'w32_get_timer_time' with high
402 frequency, and also let other threads work. */
403 while (w32_get_timer_time (hth
) < expire
)
407 EnterCriticalSection (crit
);
408 expire
= itimer
->expire
;
409 LeaveCriticalSection (crit
);
414 handler
= sig_handlers
[sig
];
415 if (!(handler
== SIG_DFL
|| handler
== SIG_IGN
|| handler
== SIG_ERR
)
416 /* FIXME: Don't ignore masked signals. Instead, record that
417 they happened and reissue them when the signal is
419 && !sigismember (&sig_mask
, sig
)
420 /* Simulate masking of SIGALRM and SIGPROF when processing
422 && !fatal_error_in_progress
423 && itimer
->caller_thread
)
425 /* Simulate a signal delivered to the thread which installed
426 the timer, by suspending that thread while the handler
428 HANDLE th
= itimer
->caller_thread
;
429 DWORD result
= SuspendThread (th
);
431 if (result
== (DWORD
)-1)
438 /* Update expiration time and loop. */
439 EnterCriticalSection (crit
);
440 expire
= itimer
->expire
;
443 LeaveCriticalSection (crit
);
446 reload
= itimer
->reload
;
449 now
= w32_get_timer_time (hth
);
452 ULONGLONG lag
= now
- expire
;
454 /* If we missed some opportunities (presumably while
455 sleeping or while the signal handler ran), skip
458 expire
= now
- (lag
% reload
);
464 expire
= 0; /* become idle */
465 itimer
->expire
= expire
;
466 LeaveCriticalSection (crit
);
472 stop_timer_thread (int which
)
474 struct itimer_data
*itimer
=
475 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
477 DWORD err
, exit_code
= 255;
480 /* Signal the thread that it should terminate. */
481 itimer
->terminate
= 1;
483 if (itimer
->timer_thread
== NULL
)
486 /* Wait for the timer thread to terminate voluntarily, then kill it
487 if it doesn't. This loop waits twice more than the maximum
488 amount of time a timer thread sleeps, see above. */
489 for (i
= 0; i
< MAX_SINGLE_SLEEP
/ 5; i
++)
491 if (!((status
= GetExitCodeThread (itimer
->timer_thread
, &exit_code
))
492 && exit_code
== STILL_ACTIVE
))
496 if ((status
== FALSE
&& (err
= GetLastError ()) == ERROR_INVALID_HANDLE
)
497 || exit_code
== STILL_ACTIVE
)
499 if (!(status
== FALSE
&& err
== ERROR_INVALID_HANDLE
))
500 TerminateThread (itimer
->timer_thread
, 0);
504 CloseHandle (itimer
->timer_thread
);
505 itimer
->timer_thread
= NULL
;
506 if (itimer
->caller_thread
)
508 CloseHandle (itimer
->caller_thread
);
509 itimer
->caller_thread
= NULL
;
513 /* This is called at shutdown time from term_ntproc. */
517 if (real_itimer
.timer_thread
)
518 stop_timer_thread (ITIMER_REAL
);
519 if (prof_itimer
.timer_thread
)
520 stop_timer_thread (ITIMER_PROF
);
522 /* We are going to delete the critical sections, so timers cannot
526 DeleteCriticalSection (&crit_real
);
527 DeleteCriticalSection (&crit_prof
);
528 DeleteCriticalSection (&crit_sig
);
531 /* This is called at initialization time from init_ntproc. */
535 /* GetThreadTimes is not available on all versions of Windows, so
536 need to probe for its availability dynamically, and call it
537 through a pointer. */
538 s_pfn_Get_Thread_Times
= NULL
; /* in case dumped Emacs comes with a value */
539 if (os_subtype
!= OS_9X
)
540 s_pfn_Get_Thread_Times
=
541 (GetThreadTimes_Proc
)GetProcAddress (GetModuleHandle ("kernel32.dll"),
544 /* Make sure we start with zeroed out itimer structures, since
545 dumping may have left there traces of threads long dead. */
546 memset (&real_itimer
, 0, sizeof real_itimer
);
547 memset (&prof_itimer
, 0, sizeof prof_itimer
);
549 InitializeCriticalSection (&crit_real
);
550 InitializeCriticalSection (&crit_prof
);
551 InitializeCriticalSection (&crit_sig
);
557 start_timer_thread (int which
)
561 struct itimer_data
*itimer
=
562 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
564 if (itimer
->timer_thread
565 && GetExitCodeThread (itimer
->timer_thread
, &exit_code
)
566 && exit_code
== STILL_ACTIVE
)
569 /* Clean up after possibly exited thread. */
570 if (itimer
->timer_thread
)
572 CloseHandle (itimer
->timer_thread
);
573 itimer
->timer_thread
= NULL
;
575 if (itimer
->caller_thread
)
577 CloseHandle (itimer
->caller_thread
);
578 itimer
->caller_thread
= NULL
;
581 /* Start a new thread. */
582 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
583 GetCurrentProcess (), &th
, 0, FALSE
,
584 DUPLICATE_SAME_ACCESS
))
589 itimer
->terminate
= 0;
590 itimer
->type
= which
;
591 itimer
->caller_thread
= th
;
592 /* Request that no more than 64KB of stack be reserved for this
593 thread, to avoid reserving too much memory, which would get in
594 the way of threads we start to wait for subprocesses. See also
596 itimer
->timer_thread
= CreateThread (NULL
, 64 * 1024, timer_loop
,
597 (void *)itimer
, 0x00010000, NULL
);
599 if (!itimer
->timer_thread
)
601 CloseHandle (itimer
->caller_thread
);
602 itimer
->caller_thread
= NULL
;
607 /* This is needed to make sure that the timer thread running for
608 profiling gets CPU as soon as the Sleep call terminates. */
609 if (which
== ITIMER_PROF
)
610 SetThreadPriority (itimer
->timer_thread
, THREAD_PRIORITY_TIME_CRITICAL
);
615 /* Most of the code of getitimer and setitimer (but not of their
616 subroutines) was shamelessly stolen from itimer.c in the DJGPP
617 library, see www.delorie.com/djgpp. */
619 getitimer (int which
, struct itimerval
*value
)
621 volatile ULONGLONG
*t_expire
;
622 volatile ULONGLONG
*t_reload
;
623 ULONGLONG expire
, reload
;
625 CRITICAL_SECTION
*crit
;
626 struct itimer_data
*itimer
;
637 if (which
!= ITIMER_REAL
&& which
!= ITIMER_PROF
)
643 itimer
= (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
645 ticks_now
= w32_get_timer_time ((which
== ITIMER_REAL
)
647 : GetCurrentThread ());
649 t_expire
= &itimer
->expire
;
650 t_reload
= &itimer
->reload
;
651 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
653 EnterCriticalSection (crit
);
656 LeaveCriticalSection (crit
);
661 value
->it_value
.tv_sec
= expire
/ TIMER_TICKS_PER_SEC
;
663 (expire
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
664 value
->it_value
.tv_usec
= usecs
;
665 value
->it_interval
.tv_sec
= reload
/ TIMER_TICKS_PER_SEC
;
667 (reload
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
668 value
->it_interval
.tv_usec
= usecs
;
674 setitimer(int which
, struct itimerval
*value
, struct itimerval
*ovalue
)
676 volatile ULONGLONG
*t_expire
, *t_reload
;
677 ULONGLONG expire
, reload
, expire_old
, reload_old
;
679 CRITICAL_SECTION
*crit
;
680 struct itimerval tem
, *ptem
;
685 /* Posix systems expect timer values smaller than the resolution of
686 the system clock be rounded up to the clock resolution. First
687 time we are called, measure the clock tick resolution. */
692 for (t1
= w32_get_timer_time (NULL
);
693 (t2
= w32_get_timer_time (NULL
)) == t1
; )
695 clocks_min
= t2
- t1
;
703 if (getitimer (which
, ptem
)) /* also sets ticks_now */
704 return -1; /* errno already set */
707 (which
== ITIMER_REAL
) ? &real_itimer
.expire
: &prof_itimer
.expire
;
709 (which
== ITIMER_REAL
) ? &real_itimer
.reload
: &prof_itimer
.reload
;
711 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
714 || (value
->it_value
.tv_sec
== 0 && value
->it_value
.tv_usec
== 0))
716 EnterCriticalSection (crit
);
717 /* Disable the timer. */
720 LeaveCriticalSection (crit
);
724 reload
= value
->it_interval
.tv_sec
* TIMER_TICKS_PER_SEC
;
726 usecs
= value
->it_interval
.tv_usec
;
727 if (value
->it_interval
.tv_sec
== 0
728 && usecs
&& usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
732 usecs
*= TIMER_TICKS_PER_SEC
;
733 reload
+= usecs
/ 1000000;
736 expire
= value
->it_value
.tv_sec
* TIMER_TICKS_PER_SEC
;
737 usecs
= value
->it_value
.tv_usec
;
738 if (value
->it_value
.tv_sec
== 0
739 && usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
743 usecs
*= TIMER_TICKS_PER_SEC
;
744 expire
+= usecs
/ 1000000;
749 EnterCriticalSection (crit
);
750 expire_old
= *t_expire
;
751 reload_old
= *t_reload
;
752 if (!(expire
== expire_old
&& reload
== reload_old
))
757 LeaveCriticalSection (crit
);
759 return start_timer_thread (which
);
765 #ifdef HAVE_SETITIMER
766 struct itimerval new_values
, old_values
;
768 new_values
.it_value
.tv_sec
= seconds
;
769 new_values
.it_value
.tv_usec
= 0;
770 new_values
.it_interval
.tv_sec
= new_values
.it_interval
.tv_usec
= 0;
772 if (setitimer (ITIMER_REAL
, &new_values
, &old_values
) < 0)
774 return old_values
.it_value
.tv_sec
;
780 /* Defined in <process.h> which conflicts with the local copy */
783 /* Child process management list. */
784 int child_proc_count
= 0;
785 child_process child_procs
[ MAX_CHILDREN
];
786 child_process
*dead_child
= NULL
;
788 static DWORD WINAPI
reader_thread (void *arg
);
790 /* Find an unused process slot. */
797 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
798 if (!CHILD_ACTIVE (cp
))
800 if (child_proc_count
== MAX_CHILDREN
)
802 cp
= &child_procs
[child_proc_count
++];
805 /* Last opportunity to avoid leaking handles before we forget them
807 if (cp
->procinfo
.hProcess
)
808 CloseHandle (cp
->procinfo
.hProcess
);
809 if (cp
->procinfo
.hThread
)
810 CloseHandle (cp
->procinfo
.hThread
);
811 memset (cp
, 0, sizeof (*cp
));
814 cp
->procinfo
.hProcess
= NULL
;
815 cp
->status
= STATUS_READ_ERROR
;
817 /* use manual reset event so that select() will function properly */
818 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
821 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
822 if (cp
->char_consumed
)
824 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
825 It means that the 64K stack we are requesting in the 2nd
826 argument is how much memory should be reserved for the
827 stack. If we don't use this flag, the memory requested
828 by the 2nd argument is the amount actually _committed_,
829 but Windows reserves 8MB of memory for each thread's
830 stack. (The 8MB figure comes from the -stack
831 command-line argument we pass to the linker when building
832 Emacs, but that's because we need a large stack for
833 Emacs's main thread.) Since we request 2GB of reserved
834 memory at startup (see w32heap.c), which is close to the
835 maximum memory available for a 32-bit process on Windows,
836 the 8MB reservation for each thread causes failures in
837 starting subprocesses, because we create a thread running
838 reader_thread for each subprocess. As 8MB of stack is
839 way too much for reader_thread, forcing Windows to
840 reserve less wins the day. */
841 cp
->thrd
= CreateThread (NULL
, 64 * 1024, reader_thread
, cp
,
852 delete_child (child_process
*cp
)
856 /* Should not be deleting a child that is still needed. */
857 for (i
= 0; i
< MAXDESC
; i
++)
858 if (fd_info
[i
].cp
== cp
)
861 if (!CHILD_ACTIVE (cp
))
864 /* reap thread if necessary */
869 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
871 /* let the thread exit cleanly if possible */
872 cp
->status
= STATUS_READ_ERROR
;
873 SetEvent (cp
->char_consumed
);
875 /* We used to forcibly terminate the thread here, but it
876 is normally unnecessary, and in abnormal cases, the worst that
877 will happen is we have an extra idle thread hanging around
878 waiting for the zombie process. */
879 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
881 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
882 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
883 TerminateThread (cp
->thrd
, 0);
887 CloseHandle (cp
->thrd
);
892 CloseHandle (cp
->char_avail
);
893 cp
->char_avail
= NULL
;
895 if (cp
->char_consumed
)
897 CloseHandle (cp
->char_consumed
);
898 cp
->char_consumed
= NULL
;
901 /* update child_proc_count (highest numbered slot in use plus one) */
902 if (cp
== child_procs
+ child_proc_count
- 1)
904 for (i
= child_proc_count
-1; i
>= 0; i
--)
905 if (CHILD_ACTIVE (&child_procs
[i
]))
907 child_proc_count
= i
+ 1;
912 child_proc_count
= 0;
915 /* Find a child by pid. */
916 static child_process
*
917 find_child_pid (DWORD pid
)
921 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
922 if (CHILD_ACTIVE (cp
) && pid
== cp
->pid
)
928 /* Thread proc for child process and socket reader threads. Each thread
929 is normally blocked until woken by select() to check for input by
930 reading one char. When the read completes, char_avail is signaled
931 to wake up the select emulator and the thread blocks itself again. */
933 reader_thread (void *arg
)
938 cp
= (child_process
*)arg
;
940 /* We have to wait for the go-ahead before we can start */
942 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
950 if (fd_info
[cp
->fd
].flags
& FILE_LISTEN
)
951 rc
= _sys_wait_accept (cp
->fd
);
953 rc
= _sys_read_ahead (cp
->fd
);
955 /* The name char_avail is a misnomer - it really just means the
956 read-ahead has completed, whether successfully or not. */
957 if (!SetEvent (cp
->char_avail
))
959 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
960 (DWORD_PTR
)cp
->char_avail
, GetLastError (),
965 if (rc
== STATUS_READ_ERROR
)
968 /* If the read died, the child has died so let the thread die */
969 if (rc
== STATUS_READ_FAILED
)
972 /* Wait until our input is acknowledged before reading again */
973 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
975 DebPrint (("reader_thread.WaitForSingleObject failed with "
976 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
983 /* To avoid Emacs changing directory, we just record here the directory
984 the new process should start in. This is set just before calling
985 sys_spawnve, and is not generally valid at any other time. */
986 static char * process_dir
;
989 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
990 int * pPid
, child_process
*cp
)
993 SECURITY_ATTRIBUTES sec_attrs
;
995 SECURITY_DESCRIPTOR sec_desc
;
998 char dir
[ MAXPATHLEN
];
1000 if (cp
== NULL
) emacs_abort ();
1002 memset (&start
, 0, sizeof (start
));
1003 start
.cb
= sizeof (start
);
1006 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
1007 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
1009 start
.dwFlags
= STARTF_USESTDHANDLES
;
1010 start
.wShowWindow
= SW_HIDE
;
1012 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
1013 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
1014 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
1015 #endif /* HAVE_NTGUI */
1018 /* Explicitly specify no security */
1019 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
1021 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
1024 sec_attrs
.nLength
= sizeof (sec_attrs
);
1025 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
1026 sec_attrs
.bInheritHandle
= FALSE
;
1028 strcpy (dir
, process_dir
);
1029 unixtodos_filename (dir
);
1031 flags
= (!NILP (Vw32_start_process_share_console
)
1032 ? CREATE_NEW_PROCESS_GROUP
1033 : CREATE_NEW_CONSOLE
);
1034 if (NILP (Vw32_start_process_inherit_error_mode
))
1035 flags
|= CREATE_DEFAULT_ERROR_MODE
;
1036 if (!CreateProcess (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
1037 flags
, env
, dir
, &start
, &cp
->procinfo
))
1040 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
1042 /* Hack for Windows 95, which assigns large (ie negative) pids */
1046 /* pid must fit in a Lisp_Int */
1047 cp
->pid
= cp
->pid
& INTMASK
;
1054 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1058 /* create_child doesn't know what emacs' file handle will be for waiting
1059 on output from the child, so we need to make this additional call
1060 to register the handle with the process
1061 This way the select emulator knows how to match file handles with
1062 entries in child_procs. */
1064 register_child (int pid
, int fd
)
1068 cp
= find_child_pid (pid
);
1071 DebPrint (("register_child unable to find pid %lu\n", pid
));
1076 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
1081 /* thread is initially blocked until select is called; set status so
1082 that select will release thread */
1083 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
1085 /* attach child_process to fd_info */
1086 if (fd_info
[fd
].cp
!= NULL
)
1088 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
1092 fd_info
[fd
].cp
= cp
;
1095 /* When a process dies its pipe will break so the reader thread will
1096 signal failure to the select emulator.
1097 The select emulator then calls this routine to clean up.
1098 Since the thread signaled failure we can assume it is exiting. */
1100 reap_subprocess (child_process
*cp
)
1102 if (cp
->procinfo
.hProcess
)
1104 /* Reap the process */
1106 /* Process should have already died before we are called. */
1107 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
1108 DebPrint (("reap_subprocess: child fpr fd %d has not died yet!", cp
->fd
));
1110 CloseHandle (cp
->procinfo
.hProcess
);
1111 cp
->procinfo
.hProcess
= NULL
;
1112 CloseHandle (cp
->procinfo
.hThread
);
1113 cp
->procinfo
.hThread
= NULL
;
1116 /* For asynchronous children, the child_proc resources will be freed
1117 when the last pipe read descriptor is closed; for synchronous
1118 children, we must explicitly free the resources now because
1119 register_child has not been called. */
1124 /* Wait for any of our existing child processes to die
1125 When it does, close its handle
1126 Return the pid and fill in the status if non-NULL. */
1129 sys_wait (int *status
)
1131 DWORD active
, retval
;
1134 child_process
*cp
, *cps
[MAX_CHILDREN
];
1135 HANDLE wait_hnd
[MAX_CHILDREN
];
1138 if (dead_child
!= NULL
)
1140 /* We want to wait for a specific child */
1141 wait_hnd
[nh
] = dead_child
->procinfo
.hProcess
;
1142 cps
[nh
] = dead_child
;
1143 if (!wait_hnd
[nh
]) emacs_abort ();
1150 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1151 /* some child_procs might be sockets; ignore them */
1152 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
1153 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
1155 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1163 /* Nothing to wait on, so fail */
1170 /* Check for quit about once a second. */
1172 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, 1000);
1173 } while (active
== WAIT_TIMEOUT
);
1175 if (active
== WAIT_FAILED
)
1180 else if (active
>= WAIT_OBJECT_0
1181 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1183 active
-= WAIT_OBJECT_0
;
1185 else if (active
>= WAIT_ABANDONED_0
1186 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1188 active
-= WAIT_ABANDONED_0
;
1194 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
1196 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1200 if (retval
== STILL_ACTIVE
)
1202 /* Should never happen */
1203 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1208 /* Massage the exit code from the process to match the format expected
1209 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1210 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1212 if (retval
== STATUS_CONTROL_C_EXIT
)
1220 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
1227 else if (synch_process_alive
)
1229 synch_process_alive
= 0;
1231 /* Report the status of the synchronous process. */
1232 if (WIFEXITED (retval
))
1233 synch_process_retcode
= WEXITSTATUS (retval
);
1234 else if (WIFSIGNALED (retval
))
1236 int code
= WTERMSIG (retval
);
1237 const char *signame
;
1239 synchronize_system_messages_locale ();
1240 signame
= strsignal (code
);
1243 signame
= "unknown";
1245 synch_process_death
= signame
;
1248 reap_subprocess (cp
);
1251 reap_subprocess (cp
);
1256 /* Old versions of w32api headers don't have separate 32-bit and
1257 64-bit defines, but the one they have matches the 32-bit variety. */
1258 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1259 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1260 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1264 w32_executable_type (char * filename
,
1266 int * is_cygnus_app
,
1269 file_data executable
;
1272 /* Default values in case we can't tell for sure. */
1273 *is_dos_app
= FALSE
;
1274 *is_cygnus_app
= FALSE
;
1275 *is_gui_app
= FALSE
;
1277 if (!open_input_file (&executable
, filename
))
1280 p
= strrchr (filename
, '.');
1282 /* We can only identify DOS .com programs from the extension. */
1283 if (p
&& xstrcasecmp (p
, ".com") == 0)
1285 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
1286 || xstrcasecmp (p
, ".cmd") == 0))
1288 /* A DOS shell script - it appears that CreateProcess is happy to
1289 accept this (somewhat surprisingly); presumably it looks at
1290 COMSPEC to determine what executable to actually invoke.
1291 Therefore, we have to do the same here as well. */
1292 /* Actually, I think it uses the program association for that
1293 extension, which is defined in the registry. */
1294 p
= egetenv ("COMSPEC");
1296 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
1300 /* Look for DOS .exe signature - if found, we must also check that
1301 it isn't really a 16- or 32-bit Windows exe, since both formats
1302 start with a DOS program stub. Note that 16-bit Windows
1303 executables use the OS/2 1.x format. */
1305 IMAGE_DOS_HEADER
* dos_header
;
1306 IMAGE_NT_HEADERS
* nt_header
;
1308 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
1309 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
1312 nt_header
= (PIMAGE_NT_HEADERS
) ((unsigned char *) dos_header
+ dos_header
->e_lfanew
);
1314 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
1316 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1319 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
1320 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
1324 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
1326 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
1327 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
1329 /* Ensure we are using the 32 bit structure. */
1330 IMAGE_OPTIONAL_HEADER32
*opt
1331 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
1332 data_dir
= opt
->DataDirectory
;
1333 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1335 /* MingW 3.12 has the required 64 bit structs, but in case older
1336 versions don't, only check 64 bit exes if we know how. */
1337 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1338 else if (nt_header
->OptionalHeader
.Magic
1339 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
1341 IMAGE_OPTIONAL_HEADER64
*opt
1342 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
1343 data_dir
= opt
->DataDirectory
;
1344 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1349 /* Look for cygwin.dll in DLL import list. */
1350 IMAGE_DATA_DIRECTORY import_dir
=
1351 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
1352 IMAGE_IMPORT_DESCRIPTOR
* imports
;
1353 IMAGE_SECTION_HEADER
* section
;
1355 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
1356 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
1359 for ( ; imports
->Name
; imports
++)
1361 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
1364 /* The exact name of the cygwin dll has changed with
1365 various releases, but hopefully this will be reasonably
1367 if (strncmp (dllname
, "cygwin", 6) == 0)
1369 *is_cygnus_app
= TRUE
;
1378 close_file_data (&executable
);
1382 compare_env (const void *strp1
, const void *strp2
)
1384 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
1386 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
1388 /* Sort order in command.com/cmd.exe is based on uppercasing
1389 names, so do the same here. */
1390 if (toupper (*str1
) > toupper (*str2
))
1392 else if (toupper (*str1
) < toupper (*str2
))
1397 if (*str1
== '=' && *str2
== '=')
1399 else if (*str1
== '=')
1406 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
1408 char **optr
, **nptr
;
1420 num
+= optr
- envp2
;
1422 qsort (new_envp
, num
, sizeof (char *), compare_env
);
1427 /* When a new child process is created we need to register it in our list,
1428 so intercept spawn requests. */
1430 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
1432 Lisp_Object program
, full
;
1433 char *cmdline
, *env
, *parg
, **targ
;
1437 int is_dos_app
, is_cygnus_app
, is_gui_app
;
1439 /* We pass our process ID to our children by setting up an environment
1440 variable in their environment. */
1441 char ppid_env_var_buffer
[64];
1442 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
1443 /* These are the characters that cause an argument to need quoting.
1444 Arguments with whitespace characters need quoting to prevent the
1445 argument being split into two or more. Arguments with wildcards
1446 are also quoted, for consistency with posix platforms, where wildcards
1447 are not expanded if we run the program directly without a shell.
1448 Some extra whitespace characters need quoting in Cygwin programs,
1449 so this list is conditionally modified below. */
1450 char *sepchars
= " \t*?";
1451 /* This is for native w32 apps; modified below for Cygwin apps. */
1452 char escape_char
= '\\';
1454 /* We don't care about the other modes */
1455 if (mode
!= _P_NOWAIT
)
1461 /* Handle executable names without an executable suffix. */
1462 program
= build_string (cmdname
);
1463 if (NILP (Ffile_executable_p (program
)))
1465 struct gcpro gcpro1
;
1469 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
));
1479 /* make sure argv[0] and cmdname are both in DOS format */
1480 cmdname
= SDATA (program
);
1481 unixtodos_filename (cmdname
);
1484 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1485 executable that is implicitly linked to the Cygnus dll (implying it
1486 was compiled with the Cygnus GNU toolchain and hence relies on
1487 cygwin.dll to parse the command line - we use this to decide how to
1488 escape quote chars in command line args that must be quoted).
1490 Also determine whether it is a GUI app, so that we don't hide its
1491 initial window unless specifically requested. */
1492 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
1494 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1495 application to start it by specifying the helper app as cmdname,
1496 while leaving the real app name as argv[0]. */
1499 cmdname
= alloca (MAXPATHLEN
);
1500 if (egetenv ("CMDPROXY"))
1501 strcpy (cmdname
, egetenv ("CMDPROXY"));
1504 strcpy (cmdname
, SDATA (Vinvocation_directory
));
1505 strcat (cmdname
, "cmdproxy.exe");
1507 unixtodos_filename (cmdname
);
1510 /* we have to do some conjuring here to put argv and envp into the
1511 form CreateProcess wants... argv needs to be a space separated/null
1512 terminated list of parameters, and envp is a null
1513 separated/double-null terminated list of parameters.
1515 Additionally, zero-length args and args containing whitespace or
1516 quote chars need to be wrapped in double quotes - for this to work,
1517 embedded quotes need to be escaped as well. The aim is to ensure
1518 the child process reconstructs the argv array we start with
1519 exactly, so we treat quotes at the beginning and end of arguments
1522 The w32 GNU-based library from Cygnus doubles quotes to escape
1523 them, while MSVC uses backslash for escaping. (Actually the MSVC
1524 startup code does attempt to recognize doubled quotes and accept
1525 them, but gets it wrong and ends up requiring three quotes to get a
1526 single embedded quote!) So by default we decide whether to use
1527 quote or backslash as the escape character based on whether the
1528 binary is apparently a Cygnus compiled app.
1530 Note that using backslash to escape embedded quotes requires
1531 additional special handling if an embedded quote is already
1532 preceded by backslash, or if an arg requiring quoting ends with
1533 backslash. In such cases, the run of escape characters needs to be
1534 doubled. For consistency, we apply this special handling as long
1535 as the escape character is not quote.
1537 Since we have no idea how large argv and envp are likely to be we
1538 figure out list lengths on the fly and allocate them. */
1540 if (!NILP (Vw32_quote_process_args
))
1543 /* Override escape char by binding w32-quote-process-args to
1544 desired character, or use t for auto-selection. */
1545 if (INTEGERP (Vw32_quote_process_args
))
1546 escape_char
= XINT (Vw32_quote_process_args
);
1548 escape_char
= is_cygnus_app
? '"' : '\\';
1551 /* Cygwin apps needs quoting a bit more often. */
1552 if (escape_char
== '"')
1553 sepchars
= "\r\n\t\f '";
1561 int need_quotes
= 0;
1562 int escape_char_run
= 0;
1568 if (escape_char
== '"' && *p
== '\\')
1569 /* If it's a Cygwin app, \ needs to be escaped. */
1573 /* allow for embedded quotes to be escaped */
1576 /* handle the case where the embedded quote is already escaped */
1577 if (escape_char_run
> 0)
1579 /* To preserve the arg exactly, we need to double the
1580 preceding escape characters (plus adding one to
1581 escape the quote character itself). */
1582 arglen
+= escape_char_run
;
1585 else if (strchr (sepchars
, *p
) != NULL
)
1590 if (*p
== escape_char
&& escape_char
!= '"')
1593 escape_char_run
= 0;
1598 /* handle the case where the arg ends with an escape char - we
1599 must not let the enclosing quote be escaped. */
1600 if (escape_char_run
> 0)
1601 arglen
+= escape_char_run
;
1603 arglen
+= strlen (*targ
++) + 1;
1605 cmdline
= alloca (arglen
);
1611 int need_quotes
= 0;
1619 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
1624 int escape_char_run
= 0;
1630 last
= p
+ strlen (p
) - 1;
1633 /* This version does not escape quotes if they occur at the
1634 beginning or end of the arg - this could lead to incorrect
1635 behavior when the arg itself represents a command line
1636 containing quoted args. I believe this was originally done
1637 as a hack to make some things work, before
1638 `w32-quote-process-args' was added. */
1641 if (*p
== '"' && p
> first
&& p
< last
)
1642 *parg
++ = escape_char
; /* escape embedded quotes */
1650 /* double preceding escape chars if any */
1651 while (escape_char_run
> 0)
1653 *parg
++ = escape_char
;
1656 /* escape all quote chars, even at beginning or end */
1657 *parg
++ = escape_char
;
1659 else if (escape_char
== '"' && *p
== '\\')
1663 if (*p
== escape_char
&& escape_char
!= '"')
1666 escape_char_run
= 0;
1668 /* double escape chars before enclosing quote */
1669 while (escape_char_run
> 0)
1671 *parg
++ = escape_char
;
1679 strcpy (parg
, *targ
);
1680 parg
+= strlen (*targ
);
1690 numenv
= 1; /* for end null */
1693 arglen
+= strlen (*targ
++) + 1;
1696 /* extra env vars... */
1697 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%lu",
1698 GetCurrentProcessId ());
1699 arglen
+= strlen (ppid_env_var_buffer
) + 1;
1702 /* merge env passed in and extra env into one, and sort it. */
1703 targ
= (char **) alloca (numenv
* sizeof (char *));
1704 merge_and_sort_env (envp
, extra_env
, targ
);
1706 /* concatenate env entries. */
1707 env
= alloca (arglen
);
1711 strcpy (parg
, *targ
);
1712 parg
+= strlen (*targ
++);
1725 /* Now create the process. */
1726 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
1736 /* Emulate the select call
1737 Wait for available input on any of the given rfds, or timeout if
1738 a timeout is given and no input is detected
1739 wfds and efds are not supported and must be NULL.
1741 For simplicity, we detect the death of child processes here and
1742 synchronously call the SIGCHLD handler. Since it is possible for
1743 children to be created without a corresponding pipe handle from which
1744 to read output, we wait separately on the process handles as well as
1745 the char_avail events for each process pipe. We only call
1746 wait/reap_process when the process actually terminates.
1748 To reduce the number of places in which Emacs can be hung such that
1749 C-g is not able to interrupt it, we always wait on interrupt_handle
1750 (which is signaled by the input thread when C-g is detected). If we
1751 detect that we were woken up by C-g, we return -1 with errno set to
1752 EINTR as on Unix. */
1754 /* From w32console.c */
1755 extern HANDLE keyboard_handle
;
1757 /* From w32xfns.c */
1758 extern HANDLE interrupt_handle
;
1760 /* From process.c */
1761 extern int proc_buffered_char
[];
1764 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
1765 EMACS_TIME
*timeout
, void *ignored
)
1768 DWORD timeout_ms
, start_time
;
1771 child_process
*cp
, *cps
[MAX_CHILDREN
];
1772 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
1773 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
1776 timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_nsec
/ 1000000) : INFINITE
;
1778 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1779 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
1785 /* Otherwise, we only handle rfds, so fail otherwise. */
1786 if (rfds
== NULL
|| wfds
!= NULL
|| efds
!= NULL
)
1796 /* Always wait on interrupt_handle, to detect C-g (quit). */
1797 wait_hnd
[0] = interrupt_handle
;
1800 /* Build a list of pipe handles to wait on. */
1802 for (i
= 0; i
< nfds
; i
++)
1803 if (FD_ISSET (i
, &orfds
))
1807 if (keyboard_handle
)
1809 /* Handle stdin specially */
1810 wait_hnd
[nh
] = keyboard_handle
;
1815 /* Check for any emacs-generated input in the queue since
1816 it won't be detected in the wait */
1817 if (detect_input_pending ())
1825 /* Child process and socket input */
1829 int current_status
= cp
->status
;
1831 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
1833 /* Tell reader thread which file handle to use. */
1835 /* Wake up the reader thread for this process */
1836 cp
->status
= STATUS_READ_READY
;
1837 if (!SetEvent (cp
->char_consumed
))
1838 DebPrint (("nt_select.SetEvent failed with "
1839 "%lu for fd %ld\n", GetLastError (), i
));
1842 #ifdef CHECK_INTERLOCK
1843 /* slightly crude cross-checking of interlock between threads */
1845 current_status
= cp
->status
;
1846 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
1848 /* char_avail has been signaled, so status (which may
1849 have changed) should indicate read has completed
1850 but has not been acknowledged. */
1851 current_status
= cp
->status
;
1852 if (current_status
!= STATUS_READ_SUCCEEDED
1853 && current_status
!= STATUS_READ_FAILED
)
1854 DebPrint (("char_avail set, but read not completed: status %d\n",
1859 /* char_avail has not been signaled, so status should
1860 indicate that read is in progress; small possibility
1861 that read has completed but event wasn't yet signaled
1862 when we tested it (because a context switch occurred
1863 or if running on separate CPUs). */
1864 if (current_status
!= STATUS_READ_READY
1865 && current_status
!= STATUS_READ_IN_PROGRESS
1866 && current_status
!= STATUS_READ_SUCCEEDED
1867 && current_status
!= STATUS_READ_FAILED
)
1868 DebPrint (("char_avail reset, but read status is bad: %d\n",
1872 wait_hnd
[nh
] = cp
->char_avail
;
1874 if (!wait_hnd
[nh
]) emacs_abort ();
1877 DebPrint (("select waiting on child %d fd %d\n",
1878 cp
-child_procs
, i
));
1883 /* Unable to find something to wait on for this fd, skip */
1885 /* Note that this is not a fatal error, and can in fact
1886 happen in unusual circumstances. Specifically, if
1887 sys_spawnve fails, eg. because the program doesn't
1888 exist, and debug-on-error is t so Fsignal invokes a
1889 nested input loop, then the process output pipe is
1890 still included in input_wait_mask with no child_proc
1891 associated with it. (It is removed when the debugger
1892 exits the nested input loop and the error is thrown.) */
1894 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
1900 /* Add handles of child processes. */
1902 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1903 /* Some child_procs might be sockets; ignore them. Also some
1904 children may have died already, but we haven't finished reading
1905 the process output; ignore them too. */
1906 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
1908 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
1909 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1912 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
1917 /* Nothing to look for, so we didn't find anything */
1925 start_time
= GetTickCount ();
1927 /* Wait for input or child death to be signaled. If user input is
1928 allowed, then also accept window messages. */
1929 if (FD_ISSET (0, &orfds
))
1930 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
1933 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
1935 if (active
== WAIT_FAILED
)
1937 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
1938 nh
+ nc
, timeout_ms
, GetLastError ()));
1939 /* don't return EBADF - this causes wait_reading_process_output to
1940 abort; WAIT_FAILED is returned when single-stepping under
1941 Windows 95 after switching thread focus in debugger, and
1942 possibly at other times. */
1946 else if (active
== WAIT_TIMEOUT
)
1950 else if (active
>= WAIT_OBJECT_0
1951 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1953 active
-= WAIT_OBJECT_0
;
1955 else if (active
>= WAIT_ABANDONED_0
1956 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1958 active
-= WAIT_ABANDONED_0
;
1963 /* Loop over all handles after active (now officially documented as
1964 being the first signaled handle in the array). We do this to
1965 ensure fairness, so that all channels with data available will be
1966 processed - otherwise higher numbered channels could be starved. */
1969 if (active
== nh
+ nc
)
1971 /* There are messages in the lisp thread's queue; we must
1972 drain the queue now to ensure they are processed promptly,
1973 because if we don't do so, we will not be woken again until
1974 further messages arrive.
1976 NB. If ever we allow window message procedures to callback
1977 into lisp, we will need to ensure messages are dispatched
1978 at a safe time for lisp code to be run (*), and we may also
1979 want to provide some hooks in the dispatch loop to cater
1980 for modeless dialogs created by lisp (ie. to register
1981 window handles to pass to IsDialogMessage).
1983 (*) Note that MsgWaitForMultipleObjects above is an
1984 internal dispatch point for messages that are sent to
1985 windows created by this thread. */
1986 drain_message_queue ();
1988 else if (active
>= nh
)
1990 cp
= cps
[active
- nh
];
1992 /* We cannot always signal SIGCHLD immediately; if we have not
1993 finished reading the process output, we must delay sending
1994 SIGCHLD until we do. */
1996 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
1997 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
1998 /* SIG_DFL for SIGCHLD is ignore */
1999 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
2000 sig_handlers
[SIGCHLD
] != SIG_IGN
)
2003 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2007 sig_handlers
[SIGCHLD
] (SIGCHLD
);
2011 else if (fdindex
[active
] == -1)
2013 /* Quit (C-g) was detected. */
2017 else if (fdindex
[active
] == 0)
2019 /* Keyboard input available */
2025 /* must be a socket or pipe - read ahead should have
2026 completed, either succeeding or failing. */
2027 FD_SET (fdindex
[active
], rfds
);
2031 /* Even though wait_reading_process_output only reads from at most
2032 one channel, we must process all channels here so that we reap
2033 all children that have died. */
2034 while (++active
< nh
+ nc
)
2035 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
2037 } while (active
< nh
+ nc
);
2039 /* If no input has arrived and timeout hasn't expired, wait again. */
2042 DWORD elapsed
= GetTickCount () - start_time
;
2044 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
2046 if (timeout_ms
!= INFINITE
)
2047 timeout_ms
-= elapsed
;
2048 goto count_children
;
2055 /* Substitute for certain kill () operations */
2057 static BOOL CALLBACK
2058 find_child_console (HWND hwnd
, LPARAM arg
)
2060 child_process
* cp
= (child_process
*) arg
;
2064 thread_id
= GetWindowThreadProcessId (hwnd
, &process_id
);
2065 if (process_id
== cp
->procinfo
.dwProcessId
)
2067 char window_class
[32];
2069 GetClassName (hwnd
, window_class
, sizeof (window_class
));
2070 if (strcmp (window_class
,
2071 (os_subtype
== OS_9X
)
2073 : "ConsoleWindowClass") == 0)
2083 /* Emulate 'kill', but only for other processes. */
2085 sys_kill (int pid
, int sig
)
2089 int need_to_free
= 0;
2092 /* Only handle signals that will result in the process dying */
2093 if (sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
2099 cp
= find_child_pid (pid
);
2102 /* We were passed a PID of something other than our subprocess.
2103 If that is our own PID, we will send to ourself a message to
2104 close the selected frame, which does not necessarily
2105 terminates Emacs. But then we are not supposed to call
2106 sys_kill with our own PID. */
2107 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
2108 if (proc_hand
== NULL
)
2117 proc_hand
= cp
->procinfo
.hProcess
;
2118 pid
= cp
->procinfo
.dwProcessId
;
2120 /* Try to locate console window for process. */
2121 EnumWindows (find_child_console
, (LPARAM
) cp
);
2124 if (sig
== SIGINT
|| sig
== SIGQUIT
)
2126 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2128 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
2129 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2130 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
2131 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2132 HWND foreground_window
;
2134 if (break_scan_code
== 0)
2136 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2137 vk_break_code
= 'C';
2138 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2141 foreground_window
= GetForegroundWindow ();
2142 if (foreground_window
)
2144 /* NT 5.0, and apparently also Windows 98, will not allow
2145 a Window to be set to foreground directly without the
2146 user's involvement. The workaround is to attach
2147 ourselves to the thread that owns the foreground
2148 window, since that is the only thread that can set the
2149 foreground window. */
2150 DWORD foreground_thread
, child_thread
;
2152 GetWindowThreadProcessId (foreground_window
, NULL
);
2153 if (foreground_thread
== GetCurrentThreadId ()
2154 || !AttachThreadInput (GetCurrentThreadId (),
2155 foreground_thread
, TRUE
))
2156 foreground_thread
= 0;
2158 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
2159 if (child_thread
== GetCurrentThreadId ()
2160 || !AttachThreadInput (GetCurrentThreadId (),
2161 child_thread
, TRUE
))
2164 /* Set the foreground window to the child. */
2165 if (SetForegroundWindow (cp
->hwnd
))
2167 /* Generate keystrokes as if user had typed Ctrl-Break or
2169 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
2170 keybd_event (vk_break_code
, break_scan_code
,
2171 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
2172 keybd_event (vk_break_code
, break_scan_code
,
2173 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
2174 | KEYEVENTF_KEYUP
, 0);
2175 keybd_event (VK_CONTROL
, control_scan_code
,
2176 KEYEVENTF_KEYUP
, 0);
2178 /* Sleep for a bit to give time for Emacs frame to respond
2179 to focus change events (if Emacs was active app). */
2182 SetForegroundWindow (foreground_window
);
2184 /* Detach from the foreground and child threads now that
2185 the foreground switching is over. */
2186 if (foreground_thread
)
2187 AttachThreadInput (GetCurrentThreadId (),
2188 foreground_thread
, FALSE
);
2190 AttachThreadInput (GetCurrentThreadId (),
2191 child_thread
, FALSE
);
2194 /* Ctrl-Break is NT equivalent of SIGINT. */
2195 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
2197 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2198 "for pid %lu\n", GetLastError (), pid
));
2205 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2208 if (os_subtype
== OS_9X
)
2211 Another possibility is to try terminating the VDM out-right by
2212 calling the Shell VxD (id 0x17) V86 interface, function #4
2213 "SHELL_Destroy_VM", ie.
2219 First need to determine the current VM handle, and then arrange for
2220 the shellapi call to be made from the system vm (by using
2221 Switch_VM_and_callback).
2223 Could try to invoke DestroyVM through CallVxD.
2227 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2228 to hang when cmdproxy is used in conjunction with
2229 command.com for an interactive shell. Posting
2230 WM_CLOSE pops up a dialog that, when Yes is selected,
2231 does the same thing. TerminateProcess is also less
2232 than ideal in that subprocesses tend to stick around
2233 until the machine is shutdown, but at least it
2234 doesn't freeze the 16-bit subsystem. */
2235 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
2237 if (!TerminateProcess (proc_hand
, 0xff))
2239 DebPrint (("sys_kill.TerminateProcess returned %d "
2240 "for pid %lu\n", GetLastError (), pid
));
2247 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
2249 /* Kill the process. On W32 this doesn't kill child processes
2250 so it doesn't work very well for shells which is why it's not
2251 used in every case. */
2252 else if (!TerminateProcess (proc_hand
, 0xff))
2254 DebPrint (("sys_kill.TerminateProcess returned %d "
2255 "for pid %lu\n", GetLastError (), pid
));
2262 CloseHandle (proc_hand
);
2267 /* The following two routines are used to manipulate stdin, stdout, and
2268 stderr of our child processes.
2270 Assuming that in, out, and err are *not* inheritable, we make them
2271 stdin, stdout, and stderr of the child as follows:
2273 - Save the parent's current standard handles.
2274 - Set the std handles to inheritable duplicates of the ones being passed in.
2275 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2276 NT file handle for a crt file descriptor.)
2277 - Spawn the child, which inherits in, out, and err as stdin,
2278 stdout, and stderr. (see Spawnve)
2279 - Close the std handles passed to the child.
2280 - Reset the parent's standard handles to the saved handles.
2281 (see reset_standard_handles)
2282 We assume that the caller closes in, out, and err after calling us. */
2285 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2288 HANDLE newstdin
, newstdout
, newstderr
;
2290 parent
= GetCurrentProcess ();
2292 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
2293 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
2294 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
2296 /* make inheritable copies of the new handles */
2297 if (!DuplicateHandle (parent
,
2298 (HANDLE
) _get_osfhandle (in
),
2303 DUPLICATE_SAME_ACCESS
))
2304 report_file_error ("Duplicating input handle for child", Qnil
);
2306 if (!DuplicateHandle (parent
,
2307 (HANDLE
) _get_osfhandle (out
),
2312 DUPLICATE_SAME_ACCESS
))
2313 report_file_error ("Duplicating output handle for child", Qnil
);
2315 if (!DuplicateHandle (parent
,
2316 (HANDLE
) _get_osfhandle (err
),
2321 DUPLICATE_SAME_ACCESS
))
2322 report_file_error ("Duplicating error handle for child", Qnil
);
2324 /* and store them as our std handles */
2325 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
2326 report_file_error ("Changing stdin handle", Qnil
);
2328 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
2329 report_file_error ("Changing stdout handle", Qnil
);
2331 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
2332 report_file_error ("Changing stderr handle", Qnil
);
2336 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2338 /* close the duplicated handles passed to the child */
2339 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
2340 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
2341 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
2343 /* now restore parent's saved std handles */
2344 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
2345 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
2346 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
2350 set_process_dir (char * dir
)
2355 /* To avoid problems with winsock implementations that work over dial-up
2356 connections causing or requiring a connection to exist while Emacs is
2357 running, Emacs no longer automatically loads winsock on startup if it
2358 is present. Instead, it will be loaded when open-network-stream is
2361 To allow full control over when winsock is loaded, we provide these
2362 two functions to dynamically load and unload winsock. This allows
2363 dial-up users to only be connected when they actually need to use
2367 extern HANDLE winsock_lib
;
2368 extern BOOL
term_winsock (void);
2369 extern BOOL
init_winsock (int load_now
);
2371 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
2372 doc
: /* Test for presence of the Windows socket library `winsock'.
2373 Returns non-nil if winsock support is present, nil otherwise.
2375 If the optional argument LOAD-NOW is non-nil, the winsock library is
2376 also loaded immediately if not already loaded. If winsock is loaded,
2377 the winsock local hostname is returned (since this may be different from
2378 the value of `system-name' and should supplant it), otherwise t is
2379 returned to indicate winsock support is present. */)
2380 (Lisp_Object load_now
)
2384 have_winsock
= init_winsock (!NILP (load_now
));
2387 if (winsock_lib
!= NULL
)
2389 /* Return new value for system-name. The best way to do this
2390 is to call init_system_name, saving and restoring the
2391 original value to avoid side-effects. */
2392 Lisp_Object orig_hostname
= Vsystem_name
;
2393 Lisp_Object hostname
;
2395 init_system_name ();
2396 hostname
= Vsystem_name
;
2397 Vsystem_name
= orig_hostname
;
2405 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
2407 doc
: /* Unload the Windows socket library `winsock' if loaded.
2408 This is provided to allow dial-up socket connections to be disconnected
2409 when no longer needed. Returns nil without unloading winsock if any
2410 socket connections still exist. */)
2413 return term_winsock () ? Qt
: Qnil
;
2417 /* Some miscellaneous functions that are Windows specific, but not GUI
2418 specific (ie. are applicable in terminal or batch mode as well). */
2420 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
2421 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
2422 If FILENAME does not exist, return nil.
2423 All path elements in FILENAME are converted to their short names. */)
2424 (Lisp_Object filename
)
2426 char shortname
[MAX_PATH
];
2428 CHECK_STRING (filename
);
2430 /* first expand it. */
2431 filename
= Fexpand_file_name (filename
, Qnil
);
2433 /* luckily, this returns the short version of each element in the path. */
2434 if (GetShortPathName (SDATA (ENCODE_FILE (filename
)), shortname
, MAX_PATH
) == 0)
2437 dostounix_filename (shortname
);
2439 return build_string (shortname
);
2443 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
2445 doc
: /* Return the long file name version of the full path of FILENAME.
2446 If FILENAME does not exist, return nil.
2447 All path elements in FILENAME are converted to their long names. */)
2448 (Lisp_Object filename
)
2450 char longname
[ MAX_PATH
];
2453 CHECK_STRING (filename
);
2455 if (SBYTES (filename
) == 2
2456 && *(SDATA (filename
) + 1) == ':')
2459 /* first expand it. */
2460 filename
= Fexpand_file_name (filename
, Qnil
);
2462 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename
)), longname
, MAX_PATH
))
2465 dostounix_filename (longname
);
2467 /* If we were passed only a drive, make sure that a slash is not appended
2468 for consistency with directories. Allow for drive mapping via SUBST
2469 in case expand-file-name is ever changed to expand those. */
2470 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
2473 return DECODE_FILE (build_string (longname
));
2476 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
2477 Sw32_set_process_priority
, 2, 2, 0,
2478 doc
: /* Set the priority of PROCESS to PRIORITY.
2479 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2480 priority of the process whose pid is PROCESS is changed.
2481 PRIORITY should be one of the symbols high, normal, or low;
2482 any other symbol will be interpreted as normal.
2484 If successful, the return value is t, otherwise nil. */)
2485 (Lisp_Object process
, Lisp_Object priority
)
2487 HANDLE proc_handle
= GetCurrentProcess ();
2488 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
2489 Lisp_Object result
= Qnil
;
2491 CHECK_SYMBOL (priority
);
2493 if (!NILP (process
))
2498 CHECK_NUMBER (process
);
2500 /* Allow pid to be an internally generated one, or one obtained
2501 externally. This is necessary because real pids on Windows 95 are
2504 pid
= XINT (process
);
2505 cp
= find_child_pid (pid
);
2507 pid
= cp
->procinfo
.dwProcessId
;
2509 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
2512 if (EQ (priority
, Qhigh
))
2513 priority_class
= HIGH_PRIORITY_CLASS
;
2514 else if (EQ (priority
, Qlow
))
2515 priority_class
= IDLE_PRIORITY_CLASS
;
2517 if (proc_handle
!= NULL
)
2519 if (SetPriorityClass (proc_handle
, priority_class
))
2521 if (!NILP (process
))
2522 CloseHandle (proc_handle
);
2528 #ifdef HAVE_LANGINFO_CODESET
2529 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2531 nl_langinfo (nl_item item
)
2533 /* Conversion of Posix item numbers to their Windows equivalents. */
2534 static const LCTYPE w32item
[] = {
2535 LOCALE_IDEFAULTANSICODEPAGE
,
2536 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
2537 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
2538 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
2539 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
2540 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
2541 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
2544 static char *nl_langinfo_buf
= NULL
;
2545 static int nl_langinfo_len
= 0;
2547 if (nl_langinfo_len
<= 0)
2548 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
2550 if (item
< 0 || item
>= _NL_NUM
)
2551 nl_langinfo_buf
[0] = 0;
2554 LCID cloc
= GetThreadLocale ();
2555 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2559 nl_langinfo_buf
[0] = 0;
2562 if (item
== CODESET
)
2564 need_len
+= 2; /* for the "cp" prefix */
2565 if (need_len
< 8) /* for the case we call GetACP */
2568 if (nl_langinfo_len
<= need_len
)
2569 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
2570 nl_langinfo_len
= need_len
);
2571 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2572 nl_langinfo_buf
, nl_langinfo_len
))
2573 nl_langinfo_buf
[0] = 0;
2574 else if (item
== CODESET
)
2576 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
2577 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
2578 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
2581 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
2582 strlen (nl_langinfo_buf
) + 1);
2583 nl_langinfo_buf
[0] = 'c';
2584 nl_langinfo_buf
[1] = 'p';
2589 return nl_langinfo_buf
;
2591 #endif /* HAVE_LANGINFO_CODESET */
2593 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
2594 Sw32_get_locale_info
, 1, 2, 0,
2595 doc
: /* Return information about the Windows locale LCID.
2596 By default, return a three letter locale code which encodes the default
2597 language as the first two characters, and the country or regional variant
2598 as the third letter. For example, ENU refers to `English (United States)',
2599 while ENC means `English (Canadian)'.
2601 If the optional argument LONGFORM is t, the long form of the locale
2602 name is returned, e.g. `English (United States)' instead; if LONGFORM
2603 is a number, it is interpreted as an LCTYPE constant and the corresponding
2604 locale information is returned.
2606 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2607 (Lisp_Object lcid
, Lisp_Object longform
)
2611 char abbrev_name
[32] = { 0 };
2612 char full_name
[256] = { 0 };
2614 CHECK_NUMBER (lcid
);
2616 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2619 if (NILP (longform
))
2621 got_abbrev
= GetLocaleInfo (XINT (lcid
),
2622 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
2623 abbrev_name
, sizeof (abbrev_name
));
2625 return build_string (abbrev_name
);
2627 else if (EQ (longform
, Qt
))
2629 got_full
= GetLocaleInfo (XINT (lcid
),
2630 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
2631 full_name
, sizeof (full_name
));
2633 return DECODE_SYSTEM (build_string (full_name
));
2635 else if (NUMBERP (longform
))
2637 got_full
= GetLocaleInfo (XINT (lcid
),
2639 full_name
, sizeof (full_name
));
2640 /* GetLocaleInfo's return value includes the terminating null
2641 character, when the returned information is a string, whereas
2642 make_unibyte_string needs the string length without the
2643 terminating null. */
2645 return make_unibyte_string (full_name
, got_full
- 1);
2652 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
2653 Sw32_get_current_locale_id
, 0, 0, 0,
2654 doc
: /* Return Windows locale id for current locale setting.
2655 This is a numerical value; use `w32-get-locale-info' to convert to a
2656 human-readable form. */)
2659 return make_number (GetThreadLocale ());
2663 int_from_hex (char * s
)
2666 static char hex
[] = "0123456789abcdefABCDEF";
2669 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
2671 unsigned digit
= p
- hex
;
2674 val
= val
* 16 + digit
;
2680 /* We need to build a global list, since the EnumSystemLocale callback
2681 function isn't given a context pointer. */
2682 Lisp_Object Vw32_valid_locale_ids
;
2684 static BOOL CALLBACK
2685 enum_locale_fn (LPTSTR localeNum
)
2687 DWORD id
= int_from_hex (localeNum
);
2688 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
2692 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
2693 Sw32_get_valid_locale_ids
, 0, 0, 0,
2694 doc
: /* Return list of all valid Windows locale ids.
2695 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2696 human-readable form. */)
2699 Vw32_valid_locale_ids
= Qnil
;
2701 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
2703 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
2704 return Vw32_valid_locale_ids
;
2708 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
2709 doc
: /* Return Windows locale id for default locale setting.
2710 By default, the system default locale setting is returned; if the optional
2711 parameter USERP is non-nil, the user default locale setting is returned.
2712 This is a numerical value; use `w32-get-locale-info' to convert to a
2713 human-readable form. */)
2717 return make_number (GetSystemDefaultLCID ());
2718 return make_number (GetUserDefaultLCID ());
2722 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
2723 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
2724 If successful, the new locale id is returned, otherwise nil. */)
2727 CHECK_NUMBER (lcid
);
2729 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2732 if (!SetThreadLocale (XINT (lcid
)))
2735 /* Need to set input thread locale if present. */
2736 if (dwWindowsThreadId
)
2737 /* Reply is not needed. */
2738 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
2740 return make_number (GetThreadLocale ());
2744 /* We need to build a global list, since the EnumCodePages callback
2745 function isn't given a context pointer. */
2746 Lisp_Object Vw32_valid_codepages
;
2748 static BOOL CALLBACK
2749 enum_codepage_fn (LPTSTR codepageNum
)
2751 DWORD id
= atoi (codepageNum
);
2752 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
2756 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
2757 Sw32_get_valid_codepages
, 0, 0, 0,
2758 doc
: /* Return list of all valid Windows codepages. */)
2761 Vw32_valid_codepages
= Qnil
;
2763 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
2765 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
2766 return Vw32_valid_codepages
;
2770 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
2771 Sw32_get_console_codepage
, 0, 0, 0,
2772 doc
: /* Return current Windows codepage for console input. */)
2775 return make_number (GetConsoleCP ());
2779 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
2780 Sw32_set_console_codepage
, 1, 1, 0,
2781 doc
: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2782 This codepage setting affects keyboard input in tty mode.
2783 If successful, the new CP is returned, otherwise nil. */)
2788 if (!IsValidCodePage (XINT (cp
)))
2791 if (!SetConsoleCP (XINT (cp
)))
2794 return make_number (GetConsoleCP ());
2798 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
2799 Sw32_get_console_output_codepage
, 0, 0, 0,
2800 doc
: /* Return current Windows codepage for console output. */)
2803 return make_number (GetConsoleOutputCP ());
2807 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
2808 Sw32_set_console_output_codepage
, 1, 1, 0,
2809 doc
: /* Make Windows codepage CP be the codepage for Emacs console output.
2810 This codepage setting affects display in tty mode.
2811 If successful, the new CP is returned, otherwise nil. */)
2816 if (!IsValidCodePage (XINT (cp
)))
2819 if (!SetConsoleOutputCP (XINT (cp
)))
2822 return make_number (GetConsoleOutputCP ());
2826 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
2827 Sw32_get_codepage_charset
, 1, 1, 0,
2828 doc
: /* Return charset ID corresponding to codepage CP.
2829 Returns nil if the codepage is not valid. */)
2836 if (!IsValidCodePage (XINT (cp
)))
2839 if (TranslateCharsetInfo ((DWORD
*) XINT (cp
), &info
, TCI_SRCCODEPAGE
))
2840 return make_number (info
.ciCharset
);
2846 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
2847 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
2848 doc
: /* Return list of Windows keyboard languages and layouts.
2849 The return value is a list of pairs of language id and layout id. */)
2852 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
2853 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
2854 Lisp_Object obj
= Qnil
;
2856 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
2858 while (--num_layouts
>= 0)
2860 DWORD kl
= (DWORD
) layouts
[num_layouts
];
2862 obj
= Fcons (Fcons (make_number (kl
& 0xffff),
2863 make_number ((kl
>> 16) & 0xffff)),
2872 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
2873 Sw32_get_keyboard_layout
, 0, 0, 0,
2874 doc
: /* Return current Windows keyboard language and layout.
2875 The return value is the cons of the language id and the layout id. */)
2878 DWORD kl
= (DWORD
) GetKeyboardLayout (dwWindowsThreadId
);
2880 return Fcons (make_number (kl
& 0xffff),
2881 make_number ((kl
>> 16) & 0xffff));
2885 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
2886 Sw32_set_keyboard_layout
, 1, 1, 0,
2887 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
2888 The keyboard layout setting affects interpretation of keyboard input.
2889 If successful, the new layout id is returned, otherwise nil. */)
2890 (Lisp_Object layout
)
2894 CHECK_CONS (layout
);
2895 CHECK_NUMBER_CAR (layout
);
2896 CHECK_NUMBER_CDR (layout
);
2898 kl
= (XINT (XCAR (layout
)) & 0xffff)
2899 | (XINT (XCDR (layout
)) << 16);
2901 /* Synchronize layout with input thread. */
2902 if (dwWindowsThreadId
)
2904 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
2908 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
2910 if (msg
.wParam
== 0)
2914 else if (!ActivateKeyboardLayout ((HKL
) kl
, 0))
2917 return Fw32_get_keyboard_layout ();
2922 syms_of_ntproc (void)
2924 DEFSYM (Qhigh
, "high");
2925 DEFSYM (Qlow
, "low");
2927 defsubr (&Sw32_has_winsock
);
2928 defsubr (&Sw32_unload_winsock
);
2930 defsubr (&Sw32_short_file_name
);
2931 defsubr (&Sw32_long_file_name
);
2932 defsubr (&Sw32_set_process_priority
);
2933 defsubr (&Sw32_get_locale_info
);
2934 defsubr (&Sw32_get_current_locale_id
);
2935 defsubr (&Sw32_get_default_locale_id
);
2936 defsubr (&Sw32_get_valid_locale_ids
);
2937 defsubr (&Sw32_set_current_locale
);
2939 defsubr (&Sw32_get_console_codepage
);
2940 defsubr (&Sw32_set_console_codepage
);
2941 defsubr (&Sw32_get_console_output_codepage
);
2942 defsubr (&Sw32_set_console_output_codepage
);
2943 defsubr (&Sw32_get_valid_codepages
);
2944 defsubr (&Sw32_get_codepage_charset
);
2946 defsubr (&Sw32_get_valid_keyboard_layouts
);
2947 defsubr (&Sw32_get_keyboard_layout
);
2948 defsubr (&Sw32_set_keyboard_layout
);
2950 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args
,
2951 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
2952 Because Windows does not directly pass argv arrays to child processes,
2953 programs have to reconstruct the argv array by parsing the command
2954 line string. For an argument to contain a space, it must be enclosed
2955 in double quotes or it will be parsed as multiple arguments.
2957 If the value is a character, that character will be used to escape any
2958 quote characters that appear, otherwise a suitable escape character
2959 will be chosen based on the type of the program. */);
2960 Vw32_quote_process_args
= Qt
;
2962 DEFVAR_LISP ("w32-start-process-show-window",
2963 Vw32_start_process_show_window
,
2964 doc
: /* When nil, new child processes hide their windows.
2965 When non-nil, they show their window in the method of their choice.
2966 This variable doesn't affect GUI applications, which will never be hidden. */);
2967 Vw32_start_process_show_window
= Qnil
;
2969 DEFVAR_LISP ("w32-start-process-share-console",
2970 Vw32_start_process_share_console
,
2971 doc
: /* When nil, new child processes are given a new console.
2972 When non-nil, they share the Emacs console; this has the limitation of
2973 allowing only one DOS subprocess to run at a time (whether started directly
2974 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
2975 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
2976 otherwise respond to interrupts from Emacs. */);
2977 Vw32_start_process_share_console
= Qnil
;
2979 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
2980 Vw32_start_process_inherit_error_mode
,
2981 doc
: /* When nil, new child processes revert to the default error mode.
2982 When non-nil, they inherit their error mode setting from Emacs, which stops
2983 them blocking when trying to access unmounted drives etc. */);
2984 Vw32_start_process_inherit_error_mode
= Qt
;
2986 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay
,
2987 doc
: /* Forced delay before reading subprocess output.
2988 This is done to improve the buffering of subprocess output, by
2989 avoiding the inefficiency of frequently reading small amounts of data.
2991 If positive, the value is the number of milliseconds to sleep before
2992 reading the subprocess output. If negative, the magnitude is the number
2993 of time slices to wait (effectively boosting the priority of the child
2994 process temporarily). A value of zero disables waiting entirely. */);
2995 w32_pipe_read_delay
= 50;
2997 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names
,
2998 doc
: /* Non-nil means convert all-upper case file names to lower case.
2999 This applies when performing completions and file name expansion.
3000 Note that the value of this setting also affects remote file names,
3001 so you probably don't want to set to non-nil if you use case-sensitive
3002 filesystems via ange-ftp. */);
3003 Vw32_downcase_file_names
= Qnil
;
3006 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes
,
3007 doc
: /* Non-nil means attempt to fake realistic inode values.
3008 This works by hashing the truename of files, and should detect
3009 aliasing between long and short (8.3 DOS) names, but can have
3010 false positives because of hash collisions. Note that determining
3011 the truename of a file can be slow. */);
3012 Vw32_generate_fake_inodes
= Qnil
;
3015 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes
,
3016 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
3017 This option controls whether to issue additional system calls to determine
3018 accurate link counts, file type, and ownership information. It is more
3019 useful for files on NTFS volumes, where hard links and file security are
3020 supported, than on volumes of the FAT family.
3022 Without these system calls, link count will always be reported as 1 and file
3023 ownership will be attributed to the current user.
3024 The default value `local' means only issue these system calls for files
3025 on local fixed drives. A value of nil means never issue them.
3026 Any other non-nil value means do this even on remote and removable drives
3027 where the performance impact may be noticeable even on modern hardware. */);
3028 Vw32_get_true_file_attributes
= Qlocal
;
3030 staticpro (&Vw32_valid_locale_ids
);
3031 staticpro (&Vw32_valid_codepages
);
3033 /* end of w32proc.c */