1 /* Process support for GNU Emacs on the Microsoft Windows API.
3 Copyright (C) 1992, 1995, 1999-2015 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 Drew Bliss Oct 14, 1993
22 Adapted from alarm.c by Tim Fleehart
25 #include <mingw_time.h>
37 /* must include CRT headers *before* config.h */
47 #if defined(__GNUC__) && !defined(__MINGW64__)
48 /* This definition is missing from mingw.org headers, but not MinGW64
50 extern BOOL WINAPI
IsValidLocale (LCID
, DWORD
);
53 #ifdef HAVE_LANGINFO_CODESET
60 #include "w32common.h"
65 #include "syssignal.h"
67 #include "dispextern.h" /* for xstrcasecmp */
70 #define RVA_TO_PTR(var,section,filedata) \
71 ((void *)((section)->PointerToRawData \
72 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
73 + (filedata).file_base))
75 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
76 static signal_handler sig_handlers
[NSIG
];
78 static sigset_t sig_mask
;
80 static CRITICAL_SECTION crit_sig
;
82 /* Improve on the CRT 'signal' implementation so that we could record
83 the SIGCHLD handler and fake interval timers. */
85 sys_signal (int sig
, signal_handler handler
)
89 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
90 below. SIGALRM and SIGPROF are used by setitimer. All the
91 others are the only ones supported by the MS runtime. */
92 if (!(sig
== SIGCHLD
|| sig
== SIGSEGV
|| sig
== SIGILL
93 || sig
== SIGFPE
|| sig
== SIGABRT
|| sig
== SIGTERM
94 || sig
== SIGALRM
|| sig
== SIGPROF
))
99 old
= sig_handlers
[sig
];
100 /* SIGABRT is treated specially because w32.c installs term_ntproc
101 as its handler, so we don't want to override that afterwards.
102 Aborting Emacs works specially anyway: either by calling
103 emacs_abort directly or through terminate_due_to_signal, which
104 calls emacs_abort through emacs_raise. */
105 if (!(sig
== SIGABRT
&& old
== term_ntproc
))
107 sig_handlers
[sig
] = handler
;
108 if (!(sig
== SIGCHLD
|| sig
== SIGALRM
|| sig
== SIGPROF
))
109 signal (sig
, handler
);
114 /* Emulate sigaction. */
116 sigaction (int sig
, const struct sigaction
*act
, struct sigaction
*oact
)
118 signal_handler old
= SIG_DFL
;
122 old
= sys_signal (sig
, act
->sa_handler
);
124 old
= sig_handlers
[sig
];
133 oact
->sa_handler
= old
;
135 oact
->sa_mask
= empty_mask
;
140 /* Emulate signal sets and blocking of signals used by timers. */
143 sigemptyset (sigset_t
*set
)
150 sigaddset (sigset_t
*set
, int signo
)
157 if (signo
< 0 || signo
>= NSIG
)
163 *set
|= (1U << signo
);
169 sigfillset (sigset_t
*set
)
182 sigprocmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
184 if (!(how
== SIG_BLOCK
|| how
== SIG_UNBLOCK
|| how
== SIG_SETMASK
))
205 /* FIXME: Catch signals that are blocked and reissue them when
206 they are unblocked. Important for SIGALRM and SIGPROF only. */
215 pthread_sigmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
217 if (sigprocmask (how
, set
, oset
) == -1)
223 sigismember (const sigset_t
*set
, int signo
)
225 if (signo
< 0 || signo
>= NSIG
)
230 if (signo
> sizeof (*set
) * BITS_PER_CHAR
)
233 return (*set
& (1U << signo
)) != 0;
249 setpgid (pid_t pid
, pid_t pgid
)
260 /* Emulations of interval timers.
262 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
264 Implementation: a separate thread is started for each timer type,
265 the thread calls the appropriate signal handler when the timer
266 expires, after stopping the thread which installed the timer. */
269 volatile ULONGLONG expire
;
270 volatile ULONGLONG reload
;
271 volatile int terminate
;
273 HANDLE caller_thread
;
277 static ULONGLONG ticks_now
;
278 static struct itimer_data real_itimer
, prof_itimer
;
279 static ULONGLONG clocks_min
;
280 /* If non-zero, itimers are disabled. Used during shutdown, when we
281 delete the critical sections used by the timer threads. */
282 static int disable_itimers
;
284 static CRITICAL_SECTION crit_real
, crit_prof
;
286 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
287 typedef BOOL (WINAPI
*GetThreadTimes_Proc
) (
289 LPFILETIME lpCreationTime
,
290 LPFILETIME lpExitTime
,
291 LPFILETIME lpKernelTime
,
292 LPFILETIME lpUserTime
);
294 static GetThreadTimes_Proc s_pfn_Get_Thread_Times
;
296 #define MAX_SINGLE_SLEEP 30
297 #define TIMER_TICKS_PER_SEC 1000
299 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
300 to a thread. If THREAD is NULL or an invalid handle, return the
301 current wall-clock time since January 1, 1601 (UTC). Otherwise,
302 return the sum of kernel and user times used by THREAD since it was
303 created, plus its creation time. */
305 w32_get_timer_time (HANDLE thread
)
308 int use_system_time
= 1;
309 /* The functions below return times in 100-ns units. */
310 const int tscale
= 10 * TIMER_TICKS_PER_SEC
;
312 if (thread
&& thread
!= INVALID_HANDLE_VALUE
313 && s_pfn_Get_Thread_Times
!= NULL
)
315 FILETIME creation_ftime
, exit_ftime
, kernel_ftime
, user_ftime
;
316 ULARGE_INTEGER temp_creation
, temp_kernel
, temp_user
;
318 if (s_pfn_Get_Thread_Times (thread
, &creation_ftime
, &exit_ftime
,
319 &kernel_ftime
, &user_ftime
))
322 temp_creation
.LowPart
= creation_ftime
.dwLowDateTime
;
323 temp_creation
.HighPart
= creation_ftime
.dwHighDateTime
;
324 temp_kernel
.LowPart
= kernel_ftime
.dwLowDateTime
;
325 temp_kernel
.HighPart
= kernel_ftime
.dwHighDateTime
;
326 temp_user
.LowPart
= user_ftime
.dwLowDateTime
;
327 temp_user
.HighPart
= user_ftime
.dwHighDateTime
;
329 temp_creation
.QuadPart
/ tscale
+ temp_kernel
.QuadPart
/ tscale
330 + temp_user
.QuadPart
/ tscale
;
333 DebPrint (("GetThreadTimes failed with error code %lu\n",
339 FILETIME current_ftime
;
342 GetSystemTimeAsFileTime (¤t_ftime
);
344 temp
.LowPart
= current_ftime
.dwLowDateTime
;
345 temp
.HighPart
= current_ftime
.dwHighDateTime
;
347 retval
= temp
.QuadPart
/ tscale
;
353 /* Thread function for a timer thread. */
355 timer_loop (LPVOID arg
)
357 struct itimer_data
*itimer
= (struct itimer_data
*)arg
;
358 int which
= itimer
->type
;
359 int sig
= (which
== ITIMER_REAL
) ? SIGALRM
: SIGPROF
;
360 CRITICAL_SECTION
*crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
361 const DWORD max_sleep
= MAX_SINGLE_SLEEP
* 1000 / TIMER_TICKS_PER_SEC
;
362 HANDLE hth
= (which
== ITIMER_REAL
) ? NULL
: itimer
->caller_thread
;
367 signal_handler handler
;
368 ULONGLONG now
, expire
, reload
;
370 /* Load new values if requested by setitimer. */
371 EnterCriticalSection (crit
);
372 expire
= itimer
->expire
;
373 reload
= itimer
->reload
;
374 LeaveCriticalSection (crit
);
375 if (itimer
->terminate
)
385 if (expire
> (now
= w32_get_timer_time (hth
)))
386 sleep_time
= expire
- now
;
389 /* Don't sleep too long at a time, to be able to see the
390 termination flag without too long a delay. */
391 while (sleep_time
> max_sleep
)
393 if (itimer
->terminate
)
396 EnterCriticalSection (crit
);
397 expire
= itimer
->expire
;
398 LeaveCriticalSection (crit
);
400 (expire
> (now
= w32_get_timer_time (hth
))) ? expire
- now
: 0;
402 if (itimer
->terminate
)
406 Sleep (sleep_time
* 1000 / TIMER_TICKS_PER_SEC
);
407 /* Always sleep past the expiration time, to make sure we
408 never call the handler _before_ the expiration time,
409 always slightly after it. Sleep(5) makes sure we don't
410 hog the CPU by calling 'w32_get_timer_time' with high
411 frequency, and also let other threads work. */
412 while (w32_get_timer_time (hth
) < expire
)
416 EnterCriticalSection (crit
);
417 expire
= itimer
->expire
;
418 LeaveCriticalSection (crit
);
423 handler
= sig_handlers
[sig
];
424 if (!(handler
== SIG_DFL
|| handler
== SIG_IGN
|| handler
== SIG_ERR
)
425 /* FIXME: Don't ignore masked signals. Instead, record that
426 they happened and reissue them when the signal is
428 && !sigismember (&sig_mask
, sig
)
429 /* Simulate masking of SIGALRM and SIGPROF when processing
431 && !fatal_error_in_progress
432 && itimer
->caller_thread
)
434 /* Simulate a signal delivered to the thread which installed
435 the timer, by suspending that thread while the handler
437 HANDLE th
= itimer
->caller_thread
;
438 DWORD result
= SuspendThread (th
);
440 if (result
== (DWORD
)-1)
447 /* Update expiration time and loop. */
448 EnterCriticalSection (crit
);
449 expire
= itimer
->expire
;
452 LeaveCriticalSection (crit
);
455 reload
= itimer
->reload
;
458 now
= w32_get_timer_time (hth
);
461 ULONGLONG lag
= now
- expire
;
463 /* If we missed some opportunities (presumably while
464 sleeping or while the signal handler ran), skip
467 expire
= now
- (lag
% reload
);
473 expire
= 0; /* become idle */
474 itimer
->expire
= expire
;
475 LeaveCriticalSection (crit
);
481 stop_timer_thread (int which
)
483 struct itimer_data
*itimer
=
484 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
486 DWORD err
, exit_code
= 255;
489 /* Signal the thread that it should terminate. */
490 itimer
->terminate
= 1;
492 if (itimer
->timer_thread
== NULL
)
495 /* Wait for the timer thread to terminate voluntarily, then kill it
496 if it doesn't. This loop waits twice more than the maximum
497 amount of time a timer thread sleeps, see above. */
498 for (i
= 0; i
< MAX_SINGLE_SLEEP
/ 5; i
++)
500 if (!((status
= GetExitCodeThread (itimer
->timer_thread
, &exit_code
))
501 && exit_code
== STILL_ACTIVE
))
505 if ((status
== FALSE
&& (err
= GetLastError ()) == ERROR_INVALID_HANDLE
)
506 || exit_code
== STILL_ACTIVE
)
508 if (!(status
== FALSE
&& err
== ERROR_INVALID_HANDLE
))
509 TerminateThread (itimer
->timer_thread
, 0);
513 CloseHandle (itimer
->timer_thread
);
514 itimer
->timer_thread
= NULL
;
515 if (itimer
->caller_thread
)
517 CloseHandle (itimer
->caller_thread
);
518 itimer
->caller_thread
= NULL
;
522 /* This is called at shutdown time from term_ntproc. */
526 if (real_itimer
.timer_thread
)
527 stop_timer_thread (ITIMER_REAL
);
528 if (prof_itimer
.timer_thread
)
529 stop_timer_thread (ITIMER_PROF
);
531 /* We are going to delete the critical sections, so timers cannot
535 DeleteCriticalSection (&crit_real
);
536 DeleteCriticalSection (&crit_prof
);
537 DeleteCriticalSection (&crit_sig
);
540 /* This is called at initialization time from init_ntproc. */
544 /* GetThreadTimes is not available on all versions of Windows, so
545 need to probe for its availability dynamically, and call it
546 through a pointer. */
547 s_pfn_Get_Thread_Times
= NULL
; /* in case dumped Emacs comes with a value */
548 if (os_subtype
!= OS_9X
)
549 s_pfn_Get_Thread_Times
=
550 (GetThreadTimes_Proc
)GetProcAddress (GetModuleHandle ("kernel32.dll"),
553 /* Make sure we start with zeroed out itimer structures, since
554 dumping may have left there traces of threads long dead. */
555 memset (&real_itimer
, 0, sizeof real_itimer
);
556 memset (&prof_itimer
, 0, sizeof prof_itimer
);
558 InitializeCriticalSection (&crit_real
);
559 InitializeCriticalSection (&crit_prof
);
560 InitializeCriticalSection (&crit_sig
);
566 start_timer_thread (int which
)
568 DWORD exit_code
, tid
;
570 struct itimer_data
*itimer
=
571 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
573 if (itimer
->timer_thread
574 && GetExitCodeThread (itimer
->timer_thread
, &exit_code
)
575 && exit_code
== STILL_ACTIVE
)
578 /* Clean up after possibly exited thread. */
579 if (itimer
->timer_thread
)
581 CloseHandle (itimer
->timer_thread
);
582 itimer
->timer_thread
= NULL
;
584 if (itimer
->caller_thread
)
586 CloseHandle (itimer
->caller_thread
);
587 itimer
->caller_thread
= NULL
;
590 /* Start a new thread. */
591 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
592 GetCurrentProcess (), &th
, 0, FALSE
,
593 DUPLICATE_SAME_ACCESS
))
598 itimer
->terminate
= 0;
599 itimer
->type
= which
;
600 itimer
->caller_thread
= th
;
601 /* Request that no more than 64KB of stack be reserved for this
602 thread, to avoid reserving too much memory, which would get in
603 the way of threads we start to wait for subprocesses. See also
605 itimer
->timer_thread
= CreateThread (NULL
, 64 * 1024, timer_loop
,
606 (void *)itimer
, 0x00010000, &tid
);
608 if (!itimer
->timer_thread
)
610 CloseHandle (itimer
->caller_thread
);
611 itimer
->caller_thread
= NULL
;
616 /* This is needed to make sure that the timer thread running for
617 profiling gets CPU as soon as the Sleep call terminates. */
618 if (which
== ITIMER_PROF
)
619 SetThreadPriority (itimer
->timer_thread
, THREAD_PRIORITY_TIME_CRITICAL
);
624 /* Most of the code of getitimer and setitimer (but not of their
625 subroutines) was shamelessly stolen from itimer.c in the DJGPP
626 library, see www.delorie.com/djgpp. */
628 getitimer (int which
, struct itimerval
*value
)
630 volatile ULONGLONG
*t_expire
;
631 volatile ULONGLONG
*t_reload
;
632 ULONGLONG expire
, reload
;
634 CRITICAL_SECTION
*crit
;
635 struct itimer_data
*itimer
;
646 if (which
!= ITIMER_REAL
&& which
!= ITIMER_PROF
)
652 itimer
= (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
654 ticks_now
= w32_get_timer_time ((which
== ITIMER_REAL
)
656 : GetCurrentThread ());
658 t_expire
= &itimer
->expire
;
659 t_reload
= &itimer
->reload
;
660 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
662 EnterCriticalSection (crit
);
665 LeaveCriticalSection (crit
);
670 value
->it_value
.tv_sec
= expire
/ TIMER_TICKS_PER_SEC
;
672 (expire
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
673 value
->it_value
.tv_usec
= usecs
;
674 value
->it_interval
.tv_sec
= reload
/ TIMER_TICKS_PER_SEC
;
676 (reload
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
677 value
->it_interval
.tv_usec
= usecs
;
683 setitimer(int which
, struct itimerval
*value
, struct itimerval
*ovalue
)
685 volatile ULONGLONG
*t_expire
, *t_reload
;
686 ULONGLONG expire
, reload
, expire_old
, reload_old
;
688 CRITICAL_SECTION
*crit
;
689 struct itimerval tem
, *ptem
;
694 /* Posix systems expect timer values smaller than the resolution of
695 the system clock be rounded up to the clock resolution. First
696 time we are called, measure the clock tick resolution. */
701 for (t1
= w32_get_timer_time (NULL
);
702 (t2
= w32_get_timer_time (NULL
)) == t1
; )
704 clocks_min
= t2
- t1
;
712 if (getitimer (which
, ptem
)) /* also sets ticks_now */
713 return -1; /* errno already set */
716 (which
== ITIMER_REAL
) ? &real_itimer
.expire
: &prof_itimer
.expire
;
718 (which
== ITIMER_REAL
) ? &real_itimer
.reload
: &prof_itimer
.reload
;
720 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
723 || (value
->it_value
.tv_sec
== 0 && value
->it_value
.tv_usec
== 0))
725 EnterCriticalSection (crit
);
726 /* Disable the timer. */
729 LeaveCriticalSection (crit
);
733 reload
= value
->it_interval
.tv_sec
* TIMER_TICKS_PER_SEC
;
735 usecs
= value
->it_interval
.tv_usec
;
736 if (value
->it_interval
.tv_sec
== 0
737 && usecs
&& usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
741 usecs
*= TIMER_TICKS_PER_SEC
;
742 reload
+= usecs
/ 1000000;
745 expire
= value
->it_value
.tv_sec
* TIMER_TICKS_PER_SEC
;
746 usecs
= value
->it_value
.tv_usec
;
747 if (value
->it_value
.tv_sec
== 0
748 && usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
752 usecs
*= TIMER_TICKS_PER_SEC
;
753 expire
+= usecs
/ 1000000;
758 EnterCriticalSection (crit
);
759 expire_old
= *t_expire
;
760 reload_old
= *t_reload
;
761 if (!(expire
== expire_old
&& reload
== reload_old
))
766 LeaveCriticalSection (crit
);
768 return start_timer_thread (which
);
774 #ifdef HAVE_SETITIMER
775 struct itimerval new_values
, old_values
;
777 new_values
.it_value
.tv_sec
= seconds
;
778 new_values
.it_value
.tv_usec
= 0;
779 new_values
.it_interval
.tv_sec
= new_values
.it_interval
.tv_usec
= 0;
781 if (setitimer (ITIMER_REAL
, &new_values
, &old_values
) < 0)
783 return old_values
.it_value
.tv_sec
;
791 /* Here's an overview of how support for subprocesses and
792 network/serial streams is implemented on MS-Windows.
794 The management of both subprocesses and network/serial streams
795 circles around the child_procs[] array, which can record up to the
796 grand total of MAX_CHILDREN (= 32) of these. (The reasons for the
797 32 limitation will become clear below.) Each member of
798 child_procs[] is a child_process structure, defined on w32.h.
800 A related data structure is the fd_info[] array, which holds twice
801 as many members, 64, and records the information about file
802 descriptors used for communicating with subprocesses and
803 network/serial devices. Each member of the array is the filedesc
804 structure, which records the Windows handle for communications,
805 such as the read end of the pipe to a subprocess, a socket handle,
808 Both these arrays reference each other: there's a member of
809 child_process structure that records the file corresponding
810 descriptor, and there's a member of filedesc structure that holds a
811 pointer to the corresponding child_process.
813 Whenever Emacs starts a subprocess or opens a network/serial
814 stream, the function new_child is called to prepare a new
815 child_process structure. new_child looks for the first vacant slot
816 in the child_procs[] array, initializes it, and starts a "reader
817 thread" that will watch the output of the subprocess/stream and its
818 status. (If no vacant slot can be found, new_child returns a
819 failure indication to its caller, and the higher-level Emacs
820 primitive will then fail with EMFILE or EAGAIN.)
822 The reader thread started by new_child communicates with the main
823 (a.k.a. "Lisp") thread via two event objects and a status, all of
824 them recorded by the members of the child_process structure in
825 child_procs[]. The event objects serve as semaphores between the
826 reader thread and the 'select' emulation in sys_select, as follows:
828 . Initially, the reader thread is waiting for the char_consumed
829 event to become signaled by sys_select, which is an indication
830 for the reader thread to go ahead and try reading more stuff
831 from the subprocess/stream.
833 . The reader thread then attempts to read by calling a
834 blocking-read function. When the read call returns, either
835 successfully or with some failure indication, the reader thread
836 updates the status of the read accordingly, and signals the 2nd
837 event object, char_avail, on whose handle sys_select is
838 waiting. This tells sys_select that the file descriptor
839 allocated for the subprocess or the the stream is ready to be
842 When the subprocess exits or the network/serial stream is closed,
843 the reader thread sets the status accordingly and exits. It also
844 exits when the main thread sets the ststus to STATUS_READ_ERROR
845 and/or the char_avail and char_consumed event handles are NULL;
846 this is how delete_child, called by Emacs when a subprocess or a
847 stream is terminated, terminates the reader thread as part of
848 deleting the child_process object.
850 The sys_select function emulates the Posix 'pselect' function; it
851 is needed because the Windows 'select' function supports only
852 network sockets, while Emacs expects 'pselect' to work for any file
853 descriptor, including pipes and serial streams.
855 When sys_select is called, it uses the information in fd_info[]
856 array to convert the file descriptors which it was asked to watch
857 into Windows handles. In general, the handle to watch is the
858 handle of the char_avail event of the child_process structure that
859 corresponds to the file descriptor. In addition, for subprocesses,
860 sys_select watches one more handle: the handle for the subprocess,
861 so that it could emulate the SIGCHLD signal when the subprocess
864 If file descriptor zero (stdin) doesn't have its bit set in the
865 'rfds' argument to sys_select, the function always watches for
866 keyboard interrupts, to be able to return when the user presses
869 Having collected the handles to watch, sys_select calls
870 WaitForMultipleObjects to wait for any one of them to become
871 signaled. Since WaitForMultipleObjects can only watch up to 64
872 handles, Emacs on Windows is limited to maximum 32 child_process
873 objects (since a subprocess consumes 2 handles to be watched, see
876 When any of the handles become signaled, sys_select does whatever
877 is appropriate for the corresponding child_process object:
879 . If it's a handle to the char_avail event, sys_select marks the
880 corresponding bit in 'rfds', and Emacs will then read from that
883 . If it's a handle to the process, sys_select calls the SIGCHLD
884 handler, to inform Emacs of the fact that the subprocess
887 The waitpid emulation works very similar to sys_select, except that
888 it only watches handles of subprocesses, and doesn't synchronize
889 with the reader thread.
891 Because socket descriptors on Windows are handles, while Emacs
892 expects them to be file descriptors, all low-level I/O functions,
893 such as 'read' and 'write', and all socket operations, like
894 'connect', 'recvfrom', 'accept', etc., are redirected to the
895 corresponding 'sys_*' functions, which must convert a file
896 descriptor to a handle using the fd_info[] array, and then invoke
897 the corresponding Windows API on the handle. Most of these
898 redirected 'sys_*' functions are implemented on w32.c.
900 When the file descriptor was produced by functions such as 'open',
901 the corresponding handle is obtained by calling _get_osfhandle. To
902 produce a file descriptor for a socket handle, which has no file
903 descriptor as far as Windows is concerned, the function
904 socket_to_fd opens the null device; the resulting file descriptor
905 will never be used directly in any I/O API, but serves as an index
906 into the fd_info[] array, where the socket handle is stored. The
907 SOCK_HANDLE macro retrieves the handle when given the file
910 The function sys_kill emulates the Posix 'kill' functionality to
911 terminate other processes. It does that by attaching to the
912 foreground window of the process and sending a Ctrl-C or Ctrl-BREAK
913 signal to the process; if that doesn't work, then it calls
914 TerminateProcess to forcibly terminate the process. Note that this
915 only terminates the immediate process whose PID was passed to
916 sys_kill; it doesn't terminate the child processes of that process.
917 This means, for example, that an Emacs subprocess run through a
918 shell might not be killed, because sys_kill will only terminate the
919 shell. (In practice, however, such problems are very rare.) */
921 /* Defined in <process.h> which conflicts with the local copy */
924 /* Child process management list. */
925 int child_proc_count
= 0;
926 child_process child_procs
[ MAX_CHILDREN
];
928 static DWORD WINAPI
reader_thread (void *arg
);
930 /* Find an unused process slot. */
937 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
938 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
940 if (child_proc_count
== MAX_CHILDREN
)
943 child_process
*dead_cp
= NULL
;
945 DebPrint (("new_child: No vacant slots, looking for dead processes\n"));
946 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
947 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
)
951 if (!GetExitCodeProcess (cp
->procinfo
.hProcess
, &status
))
953 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
954 GetLastError (), cp
->procinfo
.dwProcessId
));
955 status
= STILL_ACTIVE
;
957 if (status
!= STILL_ACTIVE
958 || WaitForSingleObject (cp
->procinfo
.hProcess
, 0) == WAIT_OBJECT_0
)
960 DebPrint (("new_child: Freeing slot of dead process %d, fd %d\n",
961 cp
->procinfo
.dwProcessId
, cp
->fd
));
962 CloseHandle (cp
->procinfo
.hProcess
);
963 cp
->procinfo
.hProcess
= NULL
;
964 CloseHandle (cp
->procinfo
.hThread
);
965 cp
->procinfo
.hThread
= NULL
;
966 /* Free up to 2 dead slots at a time, so that if we
967 have a lot of them, they will eventually all be
968 freed when the tornado ends. */
982 if (child_proc_count
== MAX_CHILDREN
)
984 cp
= &child_procs
[child_proc_count
++];
987 /* Last opportunity to avoid leaking handles before we forget them
989 if (cp
->procinfo
.hProcess
)
990 CloseHandle (cp
->procinfo
.hProcess
);
991 if (cp
->procinfo
.hThread
)
992 CloseHandle (cp
->procinfo
.hThread
);
993 memset (cp
, 0, sizeof (*cp
));
996 cp
->procinfo
.hProcess
= NULL
;
997 cp
->status
= STATUS_READ_ERROR
;
999 /* use manual reset event so that select() will function properly */
1000 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
1003 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
1004 if (cp
->char_consumed
)
1006 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
1007 It means that the 64K stack we are requesting in the 2nd
1008 argument is how much memory should be reserved for the
1009 stack. If we don't use this flag, the memory requested
1010 by the 2nd argument is the amount actually _committed_,
1011 but Windows reserves 8MB of memory for each thread's
1012 stack. (The 8MB figure comes from the -stack
1013 command-line argument we pass to the linker when building
1014 Emacs, but that's because we need a large stack for
1015 Emacs's main thread.) Since we request 2GB of reserved
1016 memory at startup (see w32heap.c), which is close to the
1017 maximum memory available for a 32-bit process on Windows,
1018 the 8MB reservation for each thread causes failures in
1019 starting subprocesses, because we create a thread running
1020 reader_thread for each subprocess. As 8MB of stack is
1021 way too much for reader_thread, forcing Windows to
1022 reserve less wins the day. */
1023 cp
->thrd
= CreateThread (NULL
, 64 * 1024, reader_thread
, cp
,
1034 delete_child (child_process
*cp
)
1038 /* Should not be deleting a child that is still needed. */
1039 for (i
= 0; i
< MAXDESC
; i
++)
1040 if (fd_info
[i
].cp
== cp
)
1043 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
1046 /* reap thread if necessary */
1051 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
1053 /* let the thread exit cleanly if possible */
1054 cp
->status
= STATUS_READ_ERROR
;
1055 SetEvent (cp
->char_consumed
);
1057 /* We used to forcibly terminate the thread here, but it
1058 is normally unnecessary, and in abnormal cases, the worst that
1059 will happen is we have an extra idle thread hanging around
1060 waiting for the zombie process. */
1061 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
1063 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
1064 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
1065 TerminateThread (cp
->thrd
, 0);
1069 CloseHandle (cp
->thrd
);
1074 CloseHandle (cp
->char_avail
);
1075 cp
->char_avail
= NULL
;
1077 if (cp
->char_consumed
)
1079 CloseHandle (cp
->char_consumed
);
1080 cp
->char_consumed
= NULL
;
1083 /* update child_proc_count (highest numbered slot in use plus one) */
1084 if (cp
== child_procs
+ child_proc_count
- 1)
1086 for (i
= child_proc_count
-1; i
>= 0; i
--)
1087 if (CHILD_ACTIVE (&child_procs
[i
])
1088 || child_procs
[i
].procinfo
.hProcess
!= NULL
)
1090 child_proc_count
= i
+ 1;
1095 child_proc_count
= 0;
1098 /* Find a child by pid. */
1099 static child_process
*
1100 find_child_pid (DWORD pid
)
1104 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1105 if ((CHILD_ACTIVE (cp
) || cp
->procinfo
.hProcess
!= NULL
)
1112 release_listen_threads (void)
1116 for (i
= child_proc_count
- 1; i
>= 0; i
--)
1118 if (CHILD_ACTIVE (&child_procs
[i
])
1119 && (fd_info
[child_procs
[i
].fd
].flags
& FILE_LISTEN
))
1120 child_procs
[i
].status
= STATUS_READ_ERROR
;
1124 /* Thread proc for child process and socket reader threads. Each thread
1125 is normally blocked until woken by select() to check for input by
1126 reading one char. When the read completes, char_avail is signaled
1127 to wake up the select emulator and the thread blocks itself again. */
1129 reader_thread (void *arg
)
1134 cp
= (child_process
*)arg
;
1136 /* We have to wait for the go-ahead before we can start */
1138 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
1146 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_CONNECT
) != 0)
1147 rc
= _sys_wait_connect (cp
->fd
);
1148 else if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_LISTEN
) != 0)
1149 rc
= _sys_wait_accept (cp
->fd
);
1151 rc
= _sys_read_ahead (cp
->fd
);
1153 /* Don't bother waiting for the event if we already have been
1154 told to exit by delete_child. */
1155 if (cp
->status
== STATUS_READ_ERROR
|| !cp
->char_avail
)
1158 /* The name char_avail is a misnomer - it really just means the
1159 read-ahead has completed, whether successfully or not. */
1160 if (!SetEvent (cp
->char_avail
))
1162 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1163 (DWORD_PTR
)cp
->char_avail
, GetLastError (),
1168 if (rc
== STATUS_READ_ERROR
|| rc
== STATUS_CONNECT_FAILED
)
1171 /* If the read died, the child has died so let the thread die */
1172 if (rc
== STATUS_READ_FAILED
)
1175 /* Don't bother waiting for the acknowledge if we already have
1176 been told to exit by delete_child. */
1177 if (cp
->status
== STATUS_READ_ERROR
|| !cp
->char_consumed
)
1180 /* Wait until our input is acknowledged before reading again */
1181 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
1183 DebPrint (("reader_thread.WaitForSingleObject failed with "
1184 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
1187 /* delete_child sets status to STATUS_READ_ERROR when it wants
1189 if (cp
->status
== STATUS_READ_ERROR
)
1195 /* To avoid Emacs changing directory, we just record here the
1196 directory the new process should start in. This is set just before
1197 calling sys_spawnve, and is not generally valid at any other time.
1198 Note that this directory's name is UTF-8 encoded. */
1199 static char * process_dir
;
1202 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
1203 pid_t
* pPid
, child_process
*cp
)
1206 SECURITY_ATTRIBUTES sec_attrs
;
1208 SECURITY_DESCRIPTOR sec_desc
;
1211 char dir
[ MAX_PATH
];
1215 if (cp
== NULL
) emacs_abort ();
1217 memset (&start
, 0, sizeof (start
));
1218 start
.cb
= sizeof (start
);
1221 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
1222 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
1224 start
.dwFlags
= STARTF_USESTDHANDLES
;
1225 start
.wShowWindow
= SW_HIDE
;
1227 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
1228 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
1229 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
1230 #endif /* HAVE_NTGUI */
1233 /* Explicitly specify no security */
1234 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
1236 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
1239 sec_attrs
.nLength
= sizeof (sec_attrs
);
1240 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
1241 sec_attrs
.bInheritHandle
= FALSE
;
1243 filename_to_ansi (process_dir
, dir
);
1244 /* Can't use unixtodos_filename here, since that needs its file name
1245 argument encoded in UTF-8. OTOH, process_dir, which _is_ in
1246 UTF-8, points, to the directory computed by our caller, and we
1247 don't want to modify that, either. */
1248 for (p
= dir
; *p
; p
= CharNextA (p
))
1252 /* CreateProcess handles batch files as exe specially. This special
1253 handling fails when both the batch file and arguments are quoted.
1254 We pass NULL as exe to avoid the special handling. */
1255 if (exe
&& cmdline
[0] == '"' &&
1256 (ext
= strrchr (exe
, '.')) &&
1257 (xstrcasecmp (ext
, ".bat") == 0
1258 || xstrcasecmp (ext
, ".cmd") == 0))
1261 flags
= (!NILP (Vw32_start_process_share_console
)
1262 ? CREATE_NEW_PROCESS_GROUP
1263 : CREATE_NEW_CONSOLE
);
1264 if (NILP (Vw32_start_process_inherit_error_mode
))
1265 flags
|= CREATE_DEFAULT_ERROR_MODE
;
1266 if (!CreateProcessA (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
1267 flags
, env
, dir
, &start
, &cp
->procinfo
))
1270 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
1272 /* Hack for Windows 95, which assigns large (ie negative) pids */
1281 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1285 /* create_child doesn't know what emacs's file handle will be for waiting
1286 on output from the child, so we need to make this additional call
1287 to register the handle with the process
1288 This way the select emulator knows how to match file handles with
1289 entries in child_procs. */
1291 register_child (pid_t pid
, int fd
)
1295 cp
= find_child_pid ((DWORD
)pid
);
1298 DebPrint (("register_child unable to find pid %lu\n", pid
));
1303 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
1308 /* thread is initially blocked until select is called; set status so
1309 that select will release thread */
1310 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
1312 /* attach child_process to fd_info */
1313 if (fd_info
[fd
].cp
!= NULL
)
1315 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
1319 fd_info
[fd
].cp
= cp
;
1322 /* Called from waitpid when a process exits. */
1324 reap_subprocess (child_process
*cp
)
1326 if (cp
->procinfo
.hProcess
)
1328 /* Reap the process */
1330 /* Process should have already died before we are called. */
1331 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
1332 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp
->fd
));
1334 CloseHandle (cp
->procinfo
.hProcess
);
1335 cp
->procinfo
.hProcess
= NULL
;
1336 CloseHandle (cp
->procinfo
.hThread
);
1337 cp
->procinfo
.hThread
= NULL
;
1340 /* If cp->fd was not closed yet, we might be still reading the
1341 process output, so don't free its resources just yet. The call
1342 to delete_child on behalf of this subprocess will be made by
1343 sys_read when the subprocess output is fully read. */
1348 /* Wait for a child process specified by PID, or for any of our
1349 existing child processes (if PID is nonpositive) to die. When it
1350 does, close its handle. Return the pid of the process that died
1351 and fill in STATUS if non-NULL. */
1354 waitpid (pid_t pid
, int *status
, int options
)
1356 DWORD active
, retval
;
1358 child_process
*cp
, *cps
[MAX_CHILDREN
];
1359 HANDLE wait_hnd
[MAX_CHILDREN
];
1361 int dont_wait
= (options
& WNOHANG
) != 0;
1364 /* According to Posix:
1366 PID = -1 means status is requested for any child process.
1368 PID > 0 means status is requested for a single child process
1371 PID = 0 means status is requested for any child process whose
1372 process group ID is equal to that of the calling process. But
1373 since Windows has only a limited support for process groups (only
1374 for console processes and only for the purposes of passing
1375 Ctrl-BREAK signal to them), and since we have no documented way
1376 of determining whether a given process belongs to our group, we
1379 PID < -1 means status is requested for any child process whose
1380 process group ID is equal to the absolute value of PID. Again,
1381 since we don't support process groups, we treat that as -1. */
1386 /* We are requested to wait for a specific child. */
1387 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1389 /* Some child_procs might be sockets; ignore them. Also
1390 ignore subprocesses whose output is not yet completely
1392 if (CHILD_ACTIVE (cp
)
1393 && cp
->procinfo
.hProcess
1402 if (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1404 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1410 /* PID specifies our subprocess, but its status is not
1417 /* No such child process, or nothing to wait for, so fail. */
1424 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1426 if (CHILD_ACTIVE (cp
)
1427 && cp
->procinfo
.hProcess
1428 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
1430 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1437 /* Nothing to wait on, so fail. */
1446 timeout_ms
= 1000; /* check for quit about once a second. */
1451 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, timeout_ms
);
1452 } while (active
== WAIT_TIMEOUT
&& !dont_wait
);
1454 if (active
== WAIT_FAILED
)
1459 else if (active
== WAIT_TIMEOUT
&& dont_wait
)
1461 /* PID specifies our subprocess, but it didn't exit yet, so its
1462 status is not yet available. */
1464 DebPrint (("Wait: PID %d not reap yet\n", cp
->pid
));
1468 else if (active
>= WAIT_OBJECT_0
1469 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1471 active
-= WAIT_OBJECT_0
;
1473 else if (active
>= WAIT_ABANDONED_0
1474 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1476 active
-= WAIT_ABANDONED_0
;
1481 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
1483 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1487 if (retval
== STILL_ACTIVE
)
1489 /* Should never happen. */
1490 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1491 if (pid
> 0 && dont_wait
)
1497 /* Massage the exit code from the process to match the format expected
1498 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1499 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1501 if (retval
== STATUS_CONTROL_C_EXIT
)
1506 if (pid
> 0 && active
!= 0)
1511 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
1516 reap_subprocess (cp
);
1521 /* Old versions of w32api headers don't have separate 32-bit and
1522 64-bit defines, but the one they have matches the 32-bit variety. */
1523 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1524 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1525 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1528 /* Implementation note: This function works with file names encoded in
1529 the current ANSI codepage. */
1531 w32_executable_type (char * filename
,
1533 int * is_cygnus_app
,
1536 file_data executable
;
1539 /* Default values in case we can't tell for sure. */
1540 *is_dos_app
= FALSE
;
1541 *is_cygnus_app
= FALSE
;
1542 *is_gui_app
= FALSE
;
1544 if (!open_input_file (&executable
, filename
))
1547 p
= strrchr (filename
, '.');
1549 /* We can only identify DOS .com programs from the extension. */
1550 if (p
&& xstrcasecmp (p
, ".com") == 0)
1552 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
1553 || xstrcasecmp (p
, ".cmd") == 0))
1555 /* A DOS shell script - it appears that CreateProcess is happy to
1556 accept this (somewhat surprisingly); presumably it looks at
1557 COMSPEC to determine what executable to actually invoke.
1558 Therefore, we have to do the same here as well. */
1559 /* Actually, I think it uses the program association for that
1560 extension, which is defined in the registry. */
1561 p
= egetenv ("COMSPEC");
1563 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
1567 /* Look for DOS .exe signature - if found, we must also check that
1568 it isn't really a 16- or 32-bit Windows exe, since both formats
1569 start with a DOS program stub. Note that 16-bit Windows
1570 executables use the OS/2 1.x format. */
1572 IMAGE_DOS_HEADER
* dos_header
;
1573 IMAGE_NT_HEADERS
* nt_header
;
1575 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
1576 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
1579 nt_header
= (PIMAGE_NT_HEADERS
) ((unsigned char *) dos_header
+ dos_header
->e_lfanew
);
1581 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
1583 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1586 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
1587 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
1591 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
1593 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
1594 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
1596 /* Ensure we are using the 32 bit structure. */
1597 IMAGE_OPTIONAL_HEADER32
*opt
1598 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
1599 data_dir
= opt
->DataDirectory
;
1600 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1602 /* MingW 3.12 has the required 64 bit structs, but in case older
1603 versions don't, only check 64 bit exes if we know how. */
1604 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1605 else if (nt_header
->OptionalHeader
.Magic
1606 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
1608 IMAGE_OPTIONAL_HEADER64
*opt
1609 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
1610 data_dir
= opt
->DataDirectory
;
1611 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1616 /* Look for cygwin.dll in DLL import list. */
1617 IMAGE_DATA_DIRECTORY import_dir
=
1618 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
1619 IMAGE_IMPORT_DESCRIPTOR
* imports
;
1620 IMAGE_SECTION_HEADER
* section
;
1622 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
1623 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
1626 for ( ; imports
->Name
; imports
++)
1628 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
1631 /* The exact name of the cygwin dll has changed with
1632 various releases, but hopefully this will be reasonably
1634 if (strncmp (dllname
, "cygwin", 6) == 0)
1636 *is_cygnus_app
= TRUE
;
1645 close_file_data (&executable
);
1649 compare_env (const void *strp1
, const void *strp2
)
1651 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
1653 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
1655 /* Sort order in command.com/cmd.exe is based on uppercasing
1656 names, so do the same here. */
1657 if (toupper (*str1
) > toupper (*str2
))
1659 else if (toupper (*str1
) < toupper (*str2
))
1664 if (*str1
== '=' && *str2
== '=')
1666 else if (*str1
== '=')
1673 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
1675 char **optr
, **nptr
;
1687 num
+= optr
- envp2
;
1689 qsort (new_envp
, num
, sizeof (char *), compare_env
);
1694 /* When a new child process is created we need to register it in our list,
1695 so intercept spawn requests. */
1697 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
1699 Lisp_Object program
, full
;
1700 char *cmdline
, *env
, *parg
, **targ
;
1704 int is_dos_app
, is_cygnus_app
, is_gui_app
;
1706 /* We pass our process ID to our children by setting up an environment
1707 variable in their environment. */
1708 char ppid_env_var_buffer
[64];
1709 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
1710 /* These are the characters that cause an argument to need quoting.
1711 Arguments with whitespace characters need quoting to prevent the
1712 argument being split into two or more. Arguments with wildcards
1713 are also quoted, for consistency with posix platforms, where wildcards
1714 are not expanded if we run the program directly without a shell.
1715 Some extra whitespace characters need quoting in Cygwin programs,
1716 so this list is conditionally modified below. */
1717 char *sepchars
= " \t*?";
1718 /* This is for native w32 apps; modified below for Cygwin apps. */
1719 char escape_char
= '\\';
1720 char cmdname_a
[MAX_PATH
];
1722 /* We don't care about the other modes */
1723 if (mode
!= _P_NOWAIT
)
1729 /* Handle executable names without an executable suffix. The caller
1730 already searched exec-path and verified the file is executable,
1731 but start-process doesn't do that for file names that are already
1732 absolute. So we double-check this here, just in case. */
1733 if (faccessat (AT_FDCWD
, cmdname
, X_OK
, AT_EACCESS
) != 0)
1735 struct gcpro gcpro1
;
1737 program
= build_string (cmdname
);
1740 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
), 0);
1747 program
= ENCODE_FILE (full
);
1748 cmdname
= SDATA (program
);
1752 char *p
= alloca (strlen (cmdname
) + 1);
1754 /* Don't change the command name we were passed by our caller
1755 (unixtodos_filename below will destructively mirror forward
1757 cmdname
= strcpy (p
, cmdname
);
1760 /* make sure argv[0] and cmdname are both in DOS format */
1761 unixtodos_filename (cmdname
);
1762 /* argv[0] was encoded by caller using ENCODE_FILE, so it is in
1763 UTF-8. All the other arguments are encoded by ENCODE_SYSTEM or
1764 some such, and are in some ANSI codepage. We need to have
1765 argv[0] encoded in ANSI codepage. */
1766 filename_to_ansi (cmdname
, cmdname_a
);
1767 /* We explicitly require that the command's file name be encodable
1768 in the current ANSI codepage, because we will be invoking it via
1770 if (_mbspbrk (cmdname_a
, "?"))
1775 /* From here on, CMDNAME is an ANSI-encoded string. */
1776 cmdname
= cmdname_a
;
1779 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1780 executable that is implicitly linked to the Cygnus dll (implying it
1781 was compiled with the Cygnus GNU toolchain and hence relies on
1782 cygwin.dll to parse the command line - we use this to decide how to
1783 escape quote chars in command line args that must be quoted).
1785 Also determine whether it is a GUI app, so that we don't hide its
1786 initial window unless specifically requested. */
1787 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
1789 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1790 application to start it by specifying the helper app as cmdname,
1791 while leaving the real app name as argv[0]. */
1796 cmdname
= alloca (MAX_PATH
);
1797 if (egetenv ("CMDPROXY"))
1798 strcpy (cmdname
, egetenv ("CMDPROXY"));
1800 strcpy (lispstpcpy (cmdname
, Vinvocation_directory
), "cmdproxy.exe");
1802 /* Can't use unixtodos_filename here, since that needs its file
1803 name argument encoded in UTF-8. */
1804 for (p
= cmdname
; *p
; p
= CharNextA (p
))
1809 /* we have to do some conjuring here to put argv and envp into the
1810 form CreateProcess wants... argv needs to be a space separated/null
1811 terminated list of parameters, and envp is a null
1812 separated/double-null terminated list of parameters.
1814 Additionally, zero-length args and args containing whitespace or
1815 quote chars need to be wrapped in double quotes - for this to work,
1816 embedded quotes need to be escaped as well. The aim is to ensure
1817 the child process reconstructs the argv array we start with
1818 exactly, so we treat quotes at the beginning and end of arguments
1821 The w32 GNU-based library from Cygnus doubles quotes to escape
1822 them, while MSVC uses backslash for escaping. (Actually the MSVC
1823 startup code does attempt to recognize doubled quotes and accept
1824 them, but gets it wrong and ends up requiring three quotes to get a
1825 single embedded quote!) So by default we decide whether to use
1826 quote or backslash as the escape character based on whether the
1827 binary is apparently a Cygnus compiled app.
1829 Note that using backslash to escape embedded quotes requires
1830 additional special handling if an embedded quote is already
1831 preceded by backslash, or if an arg requiring quoting ends with
1832 backslash. In such cases, the run of escape characters needs to be
1833 doubled. For consistency, we apply this special handling as long
1834 as the escape character is not quote.
1836 Since we have no idea how large argv and envp are likely to be we
1837 figure out list lengths on the fly and allocate them. */
1839 if (!NILP (Vw32_quote_process_args
))
1842 /* Override escape char by binding w32-quote-process-args to
1843 desired character, or use t for auto-selection. */
1844 if (INTEGERP (Vw32_quote_process_args
))
1845 escape_char
= XINT (Vw32_quote_process_args
);
1847 escape_char
= is_cygnus_app
? '"' : '\\';
1850 /* Cygwin apps needs quoting a bit more often. */
1851 if (escape_char
== '"')
1852 sepchars
= "\r\n\t\f '";
1860 int need_quotes
= 0;
1861 int escape_char_run
= 0;
1867 if (escape_char
== '"' && *p
== '\\')
1868 /* If it's a Cygwin app, \ needs to be escaped. */
1872 /* allow for embedded quotes to be escaped */
1875 /* handle the case where the embedded quote is already escaped */
1876 if (escape_char_run
> 0)
1878 /* To preserve the arg exactly, we need to double the
1879 preceding escape characters (plus adding one to
1880 escape the quote character itself). */
1881 arglen
+= escape_char_run
;
1884 else if (strchr (sepchars
, *p
) != NULL
)
1889 if (*p
== escape_char
&& escape_char
!= '"')
1892 escape_char_run
= 0;
1897 /* handle the case where the arg ends with an escape char - we
1898 must not let the enclosing quote be escaped. */
1899 if (escape_char_run
> 0)
1900 arglen
+= escape_char_run
;
1902 arglen
+= strlen (*targ
++) + 1;
1904 cmdline
= alloca (arglen
);
1910 int need_quotes
= 0;
1918 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
1923 int escape_char_run
= 0;
1929 /* last = p + strlen (p) - 1; */
1932 /* This version does not escape quotes if they occur at the
1933 beginning or end of the arg - this could lead to incorrect
1934 behavior when the arg itself represents a command line
1935 containing quoted args. I believe this was originally done
1936 as a hack to make some things work, before
1937 `w32-quote-process-args' was added. */
1940 if (*p
== '"' && p
> first
&& p
< last
)
1941 *parg
++ = escape_char
; /* escape embedded quotes */
1949 /* double preceding escape chars if any */
1950 while (escape_char_run
> 0)
1952 *parg
++ = escape_char
;
1955 /* escape all quote chars, even at beginning or end */
1956 *parg
++ = escape_char
;
1958 else if (escape_char
== '"' && *p
== '\\')
1962 if (*p
== escape_char
&& escape_char
!= '"')
1965 escape_char_run
= 0;
1967 /* double escape chars before enclosing quote */
1968 while (escape_char_run
> 0)
1970 *parg
++ = escape_char
;
1978 strcpy (parg
, *targ
);
1979 parg
+= strlen (*targ
);
1989 numenv
= 1; /* for end null */
1992 arglen
+= strlen (*targ
++) + 1;
1995 /* extra env vars... */
1996 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%lu",
1997 GetCurrentProcessId ());
1998 arglen
+= strlen (ppid_env_var_buffer
) + 1;
2001 /* merge env passed in and extra env into one, and sort it. */
2002 targ
= (char **) alloca (numenv
* sizeof (char *));
2003 merge_and_sort_env (envp
, extra_env
, targ
);
2005 /* concatenate env entries. */
2006 env
= alloca (arglen
);
2010 strcpy (parg
, *targ
);
2011 parg
+= strlen (*targ
++);
2024 /* Now create the process. */
2025 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
2035 /* Emulate the select call
2036 Wait for available input on any of the given rfds, or timeout if
2037 a timeout is given and no input is detected
2038 wfds and efds are not supported and must be NULL.
2040 For simplicity, we detect the death of child processes here and
2041 synchronously call the SIGCHLD handler. Since it is possible for
2042 children to be created without a corresponding pipe handle from which
2043 to read output, we wait separately on the process handles as well as
2044 the char_avail events for each process pipe. We only call
2045 wait/reap_process when the process actually terminates.
2047 To reduce the number of places in which Emacs can be hung such that
2048 C-g is not able to interrupt it, we always wait on interrupt_handle
2049 (which is signaled by the input thread when C-g is detected). If we
2050 detect that we were woken up by C-g, we return -1 with errno set to
2051 EINTR as on Unix. */
2053 /* From w32console.c */
2054 extern HANDLE keyboard_handle
;
2056 /* From w32xfns.c */
2057 extern HANDLE interrupt_handle
;
2059 /* From process.c */
2060 extern int proc_buffered_char
[];
2063 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
2064 struct timespec
*timeout
, void *ignored
)
2066 SELECT_TYPE orfds
, owfds
;
2067 DWORD timeout_ms
, start_time
;
2070 child_process
*cp
, *cps
[MAX_CHILDREN
];
2071 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
2072 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
2075 timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_nsec
/ 1000000) : INFINITE
;
2077 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
2078 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
2084 /* Otherwise, we only handle rfds and wfds, so fail otherwise. */
2085 if ((rfds
== NULL
&& wfds
== NULL
) || efds
!= NULL
)
2107 /* If interrupt_handle is available and valid, always wait on it, to
2108 detect C-g (quit). */
2110 if (interrupt_handle
&& interrupt_handle
!= INVALID_HANDLE_VALUE
)
2112 wait_hnd
[0] = interrupt_handle
;
2117 /* Build a list of pipe handles to wait on. */
2118 for (i
= 0; i
< nfds
; i
++)
2119 if (FD_ISSET (i
, &orfds
) || FD_ISSET (i
, &owfds
))
2123 if (keyboard_handle
)
2125 /* Handle stdin specially */
2126 wait_hnd
[nh
] = keyboard_handle
;
2131 /* Check for any emacs-generated input in the queue since
2132 it won't be detected in the wait */
2133 if (rfds
&& detect_input_pending ())
2138 else if (noninteractive
)
2140 if (handle_file_notifications (NULL
))
2146 /* Child process and socket/comm port input. */
2148 if (FD_ISSET (i
, &owfds
)
2150 && (fd_info
[i
].flags
&& FILE_CONNECT
) == 0)
2152 DebPrint (("sys_select: fd %d is in wfds, but FILE_CONNECT is reset!\n", i
));
2157 int current_status
= cp
->status
;
2159 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
2161 /* Tell reader thread which file handle to use. */
2163 /* Zero out the error code. */
2165 /* Wake up the reader thread for this process */
2166 cp
->status
= STATUS_READ_READY
;
2167 if (!SetEvent (cp
->char_consumed
))
2168 DebPrint (("sys_select.SetEvent failed with "
2169 "%lu for fd %ld\n", GetLastError (), i
));
2172 #ifdef CHECK_INTERLOCK
2173 /* slightly crude cross-checking of interlock between threads */
2175 current_status
= cp
->status
;
2176 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
2178 /* char_avail has been signaled, so status (which may
2179 have changed) should indicate read has completed
2180 but has not been acknowledged. */
2181 current_status
= cp
->status
;
2182 if (current_status
!= STATUS_READ_SUCCEEDED
2183 && current_status
!= STATUS_READ_FAILED
)
2184 DebPrint (("char_avail set, but read not completed: status %d\n",
2189 /* char_avail has not been signaled, so status should
2190 indicate that read is in progress; small possibility
2191 that read has completed but event wasn't yet signaled
2192 when we tested it (because a context switch occurred
2193 or if running on separate CPUs). */
2194 if (current_status
!= STATUS_READ_READY
2195 && current_status
!= STATUS_READ_IN_PROGRESS
2196 && current_status
!= STATUS_READ_SUCCEEDED
2197 && current_status
!= STATUS_READ_FAILED
)
2198 DebPrint (("char_avail reset, but read status is bad: %d\n",
2202 wait_hnd
[nh
] = cp
->char_avail
;
2204 if (!wait_hnd
[nh
]) emacs_abort ();
2207 DebPrint (("select waiting on child %d fd %d\n",
2208 cp
-child_procs
, i
));
2213 /* Unable to find something to wait on for this fd, skip */
2215 /* Note that this is not a fatal error, and can in fact
2216 happen in unusual circumstances. Specifically, if
2217 sys_spawnve fails, eg. because the program doesn't
2218 exist, and debug-on-error is t so Fsignal invokes a
2219 nested input loop, then the process output pipe is
2220 still included in input_wait_mask with no child_proc
2221 associated with it. (It is removed when the debugger
2222 exits the nested input loop and the error is thrown.) */
2224 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
2230 /* Add handles of child processes. */
2232 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
2233 /* Some child_procs might be sockets; ignore them. Also some
2234 children may have died already, but we haven't finished reading
2235 the process output; ignore them too. */
2236 if ((CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
)
2238 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
2239 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
2242 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
2247 /* Nothing to look for, so we didn't find anything */
2254 if (handle_file_notifications (NULL
))
2260 start_time
= GetTickCount ();
2262 /* Wait for input or child death to be signaled. If user input is
2263 allowed, then also accept window messages. */
2264 if (FD_ISSET (0, &orfds
))
2265 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
2268 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
2270 if (active
== WAIT_FAILED
)
2272 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2273 nh
+ nc
, timeout_ms
, GetLastError ()));
2274 /* don't return EBADF - this causes wait_reading_process_output to
2275 abort; WAIT_FAILED is returned when single-stepping under
2276 Windows 95 after switching thread focus in debugger, and
2277 possibly at other times. */
2281 else if (active
== WAIT_TIMEOUT
)
2285 if (handle_file_notifications (NULL
))
2290 else if (active
>= WAIT_OBJECT_0
2291 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
2293 active
-= WAIT_OBJECT_0
;
2295 else if (active
>= WAIT_ABANDONED_0
2296 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
2298 active
-= WAIT_ABANDONED_0
;
2303 /* Loop over all handles after active (now officially documented as
2304 being the first signaled handle in the array). We do this to
2305 ensure fairness, so that all channels with data available will be
2306 processed - otherwise higher numbered channels could be starved. */
2309 if (active
== nh
+ nc
)
2311 /* There are messages in the lisp thread's queue; we must
2312 drain the queue now to ensure they are processed promptly,
2313 because if we don't do so, we will not be woken again until
2314 further messages arrive.
2316 NB. If ever we allow window message procedures to callback
2317 into lisp, we will need to ensure messages are dispatched
2318 at a safe time for lisp code to be run (*), and we may also
2319 want to provide some hooks in the dispatch loop to cater
2320 for modeless dialogs created by lisp (ie. to register
2321 window handles to pass to IsDialogMessage).
2323 (*) Note that MsgWaitForMultipleObjects above is an
2324 internal dispatch point for messages that are sent to
2325 windows created by this thread. */
2326 if (drain_message_queue ()
2327 /* If drain_message_queue returns non-zero, that means
2328 we received a WM_EMACS_FILENOTIFY message. If this
2329 is a TTY frame, we must signal the caller that keyboard
2330 input is available, so that w32_console_read_socket
2331 will be called to pick up the notifications. If we
2332 don't do that, file notifications will only work when
2333 the Emacs TTY frame has focus. */
2334 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2335 /* they asked for stdin reads */
2336 && FD_ISSET (0, &orfds
)
2337 /* the stdin handle is valid */
2345 else if (active
>= nh
)
2347 cp
= cps
[active
- nh
];
2349 /* We cannot always signal SIGCHLD immediately; if we have not
2350 finished reading the process output, we must delay sending
2351 SIGCHLD until we do. */
2353 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
2354 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
2355 /* SIG_DFL for SIGCHLD is ignored */
2356 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
2357 sig_handlers
[SIGCHLD
] != SIG_IGN
)
2360 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2363 sig_handlers
[SIGCHLD
] (SIGCHLD
);
2366 else if (fdindex
[active
] == -1)
2368 /* Quit (C-g) was detected. */
2372 else if (rfds
&& fdindex
[active
] == 0)
2374 /* Keyboard input available */
2380 /* Must be a socket or pipe - read ahead should have
2381 completed, either succeeding or failing. If this handle
2382 was waiting for an async 'connect', reset the connect
2383 flag, so it could read from now on. */
2384 if (wfds
&& (fd_info
[fdindex
[active
]].flags
& FILE_CONNECT
) != 0)
2386 cp
= fd_info
[fdindex
[active
]].cp
;
2389 /* Don't reset the FILE_CONNECT bit and don't
2390 acknowledge the read if the status is
2391 STATUS_CONNECT_FAILED or some other
2392 failure. That's because the thread exits in those
2393 cases, so it doesn't need the ACK, and we want to
2394 keep the FILE_CONNECT bit as evidence that the
2395 connect failed, to be checked in sys_read. */
2396 if (cp
->status
== STATUS_READ_SUCCEEDED
)
2398 fd_info
[cp
->fd
].flags
&= ~FILE_CONNECT
;
2399 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
2401 ResetEvent (cp
->char_avail
);
2403 FD_SET (fdindex
[active
], wfds
);
2406 FD_SET (fdindex
[active
], rfds
);
2410 /* Even though wait_reading_process_output only reads from at most
2411 one channel, we must process all channels here so that we reap
2412 all children that have died. */
2413 while (++active
< nh
+ nc
)
2414 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
2416 } while (active
< nh
+ nc
);
2420 if (handle_file_notifications (NULL
))
2424 /* If no input has arrived and timeout hasn't expired, wait again. */
2427 DWORD elapsed
= GetTickCount () - start_time
;
2429 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
2431 if (timeout_ms
!= INFINITE
)
2432 timeout_ms
-= elapsed
;
2433 goto count_children
;
2440 /* Substitute for certain kill () operations */
2442 static BOOL CALLBACK
2443 find_child_console (HWND hwnd
, LPARAM arg
)
2445 child_process
* cp
= (child_process
*) arg
;
2448 GetWindowThreadProcessId (hwnd
, &process_id
);
2449 if (process_id
== cp
->procinfo
.dwProcessId
)
2451 char window_class
[32];
2453 GetClassName (hwnd
, window_class
, sizeof (window_class
));
2454 if (strcmp (window_class
,
2455 (os_subtype
== OS_9X
)
2457 : "ConsoleWindowClass") == 0)
2467 /* Emulate 'kill', but only for other processes. */
2469 sys_kill (pid_t pid
, int sig
)
2473 int need_to_free
= 0;
2476 /* Each process is in its own process group. */
2480 /* Only handle signals that will result in the process dying */
2482 && sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
2490 /* It will take _some_ time before PID 4 or less on Windows will
2497 proc_hand
= OpenProcess (PROCESS_QUERY_INFORMATION
, 0, pid
);
2498 if (proc_hand
== NULL
)
2500 DWORD err
= GetLastError ();
2504 case ERROR_ACCESS_DENIED
: /* existing process, but access denied */
2507 case ERROR_INVALID_PARAMETER
: /* process PID does not exist */
2513 CloseHandle (proc_hand
);
2517 cp
= find_child_pid (pid
);
2520 /* We were passed a PID of something other than our subprocess.
2521 If that is our own PID, we will send to ourself a message to
2522 close the selected frame, which does not necessarily
2523 terminates Emacs. But then we are not supposed to call
2524 sys_kill with our own PID. */
2525 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
2526 if (proc_hand
== NULL
)
2535 proc_hand
= cp
->procinfo
.hProcess
;
2536 pid
= cp
->procinfo
.dwProcessId
;
2538 /* Try to locate console window for process. */
2539 EnumWindows (find_child_console
, (LPARAM
) cp
);
2542 if (sig
== SIGINT
|| sig
== SIGQUIT
)
2544 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2546 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
2547 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2548 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
2549 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2550 HWND foreground_window
;
2552 if (break_scan_code
== 0)
2554 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2555 vk_break_code
= 'C';
2556 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2559 foreground_window
= GetForegroundWindow ();
2560 if (foreground_window
)
2562 /* NT 5.0, and apparently also Windows 98, will not allow
2563 a Window to be set to foreground directly without the
2564 user's involvement. The workaround is to attach
2565 ourselves to the thread that owns the foreground
2566 window, since that is the only thread that can set the
2567 foreground window. */
2568 DWORD foreground_thread
, child_thread
;
2570 GetWindowThreadProcessId (foreground_window
, NULL
);
2571 if (foreground_thread
== GetCurrentThreadId ()
2572 || !AttachThreadInput (GetCurrentThreadId (),
2573 foreground_thread
, TRUE
))
2574 foreground_thread
= 0;
2576 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
2577 if (child_thread
== GetCurrentThreadId ()
2578 || !AttachThreadInput (GetCurrentThreadId (),
2579 child_thread
, TRUE
))
2582 /* Set the foreground window to the child. */
2583 if (SetForegroundWindow (cp
->hwnd
))
2585 /* Generate keystrokes as if user had typed Ctrl-Break or
2587 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
2588 keybd_event (vk_break_code
, break_scan_code
,
2589 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
2590 keybd_event (vk_break_code
, break_scan_code
,
2591 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
2592 | KEYEVENTF_KEYUP
, 0);
2593 keybd_event (VK_CONTROL
, control_scan_code
,
2594 KEYEVENTF_KEYUP
, 0);
2596 /* Sleep for a bit to give time for Emacs frame to respond
2597 to focus change events (if Emacs was active app). */
2600 SetForegroundWindow (foreground_window
);
2602 /* Detach from the foreground and child threads now that
2603 the foreground switching is over. */
2604 if (foreground_thread
)
2605 AttachThreadInput (GetCurrentThreadId (),
2606 foreground_thread
, FALSE
);
2608 AttachThreadInput (GetCurrentThreadId (),
2609 child_thread
, FALSE
);
2612 /* Ctrl-Break is NT equivalent of SIGINT. */
2613 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
2615 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2616 "for pid %lu\n", GetLastError (), pid
));
2623 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2626 if (os_subtype
== OS_9X
)
2629 Another possibility is to try terminating the VDM out-right by
2630 calling the Shell VxD (id 0x17) V86 interface, function #4
2631 "SHELL_Destroy_VM", ie.
2637 First need to determine the current VM handle, and then arrange for
2638 the shellapi call to be made from the system vm (by using
2639 Switch_VM_and_callback).
2641 Could try to invoke DestroyVM through CallVxD.
2645 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2646 to hang when cmdproxy is used in conjunction with
2647 command.com for an interactive shell. Posting
2648 WM_CLOSE pops up a dialog that, when Yes is selected,
2649 does the same thing. TerminateProcess is also less
2650 than ideal in that subprocesses tend to stick around
2651 until the machine is shutdown, but at least it
2652 doesn't freeze the 16-bit subsystem. */
2653 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
2655 if (!TerminateProcess (proc_hand
, 0xff))
2657 DebPrint (("sys_kill.TerminateProcess returned %d "
2658 "for pid %lu\n", GetLastError (), pid
));
2665 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
2667 /* Kill the process. On W32 this doesn't kill child processes
2668 so it doesn't work very well for shells which is why it's not
2669 used in every case. */
2670 else if (!TerminateProcess (proc_hand
, 0xff))
2672 DebPrint (("sys_kill.TerminateProcess returned %d "
2673 "for pid %lu\n", GetLastError (), pid
));
2680 CloseHandle (proc_hand
);
2685 /* The following two routines are used to manipulate stdin, stdout, and
2686 stderr of our child processes.
2688 Assuming that in, out, and err are *not* inheritable, we make them
2689 stdin, stdout, and stderr of the child as follows:
2691 - Save the parent's current standard handles.
2692 - Set the std handles to inheritable duplicates of the ones being passed in.
2693 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2694 NT file handle for a crt file descriptor.)
2695 - Spawn the child, which inherits in, out, and err as stdin,
2696 stdout, and stderr. (see Spawnve)
2697 - Close the std handles passed to the child.
2698 - Reset the parent's standard handles to the saved handles.
2699 (see reset_standard_handles)
2700 We assume that the caller closes in, out, and err after calling us. */
2703 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2706 HANDLE newstdin
, newstdout
, newstderr
;
2708 parent
= GetCurrentProcess ();
2710 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
2711 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
2712 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
2714 /* make inheritable copies of the new handles */
2715 if (!DuplicateHandle (parent
,
2716 (HANDLE
) _get_osfhandle (in
),
2721 DUPLICATE_SAME_ACCESS
))
2722 report_file_error ("Duplicating input handle for child", Qnil
);
2724 if (!DuplicateHandle (parent
,
2725 (HANDLE
) _get_osfhandle (out
),
2730 DUPLICATE_SAME_ACCESS
))
2731 report_file_error ("Duplicating output handle for child", Qnil
);
2733 if (!DuplicateHandle (parent
,
2734 (HANDLE
) _get_osfhandle (err
),
2739 DUPLICATE_SAME_ACCESS
))
2740 report_file_error ("Duplicating error handle for child", Qnil
);
2742 /* and store them as our std handles */
2743 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
2744 report_file_error ("Changing stdin handle", Qnil
);
2746 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
2747 report_file_error ("Changing stdout handle", Qnil
);
2749 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
2750 report_file_error ("Changing stderr handle", Qnil
);
2754 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2756 /* close the duplicated handles passed to the child */
2757 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
2758 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
2759 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
2761 /* now restore parent's saved std handles */
2762 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
2763 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
2764 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
2768 set_process_dir (char * dir
)
2773 /* To avoid problems with winsock implementations that work over dial-up
2774 connections causing or requiring a connection to exist while Emacs is
2775 running, Emacs no longer automatically loads winsock on startup if it
2776 is present. Instead, it will be loaded when open-network-stream is
2779 To allow full control over when winsock is loaded, we provide these
2780 two functions to dynamically load and unload winsock. This allows
2781 dial-up users to only be connected when they actually need to use
2785 extern HANDLE winsock_lib
;
2786 extern BOOL
term_winsock (void);
2787 extern BOOL
init_winsock (int load_now
);
2789 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
2790 doc
: /* Test for presence of the Windows socket library `winsock'.
2791 Returns non-nil if winsock support is present, nil otherwise.
2793 If the optional argument LOAD-NOW is non-nil, the winsock library is
2794 also loaded immediately if not already loaded. If winsock is loaded,
2795 the winsock local hostname is returned (since this may be different from
2796 the value of `system-name' and should supplant it), otherwise t is
2797 returned to indicate winsock support is present. */)
2798 (Lisp_Object load_now
)
2802 have_winsock
= init_winsock (!NILP (load_now
));
2805 if (winsock_lib
!= NULL
)
2807 /* Return new value for system-name. The best way to do this
2808 is to call init_system_name, saving and restoring the
2809 original value to avoid side-effects. */
2810 Lisp_Object orig_hostname
= Vsystem_name
;
2811 Lisp_Object hostname
;
2813 init_system_name ();
2814 hostname
= Vsystem_name
;
2815 Vsystem_name
= orig_hostname
;
2823 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
2825 doc
: /* Unload the Windows socket library `winsock' if loaded.
2826 This is provided to allow dial-up socket connections to be disconnected
2827 when no longer needed. Returns nil without unloading winsock if any
2828 socket connections still exist. */)
2831 return term_winsock () ? Qt
: Qnil
;
2835 /* Some miscellaneous functions that are Windows specific, but not GUI
2836 specific (ie. are applicable in terminal or batch mode as well). */
2838 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
2839 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
2840 If FILENAME does not exist, return nil.
2841 All path elements in FILENAME are converted to their short names. */)
2842 (Lisp_Object filename
)
2844 char shortname
[MAX_PATH
];
2846 CHECK_STRING (filename
);
2848 /* first expand it. */
2849 filename
= Fexpand_file_name (filename
, Qnil
);
2851 /* luckily, this returns the short version of each element in the path. */
2852 if (w32_get_short_filename (SDATA (ENCODE_FILE (filename
)),
2853 shortname
, MAX_PATH
) == 0)
2856 dostounix_filename (shortname
);
2858 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2859 return build_string (shortname
);
2863 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
2865 doc
: /* Return the long file name version of the full path of FILENAME.
2866 If FILENAME does not exist, return nil.
2867 All path elements in FILENAME are converted to their long names. */)
2868 (Lisp_Object filename
)
2870 char longname
[ MAX_UTF8_PATH
];
2873 CHECK_STRING (filename
);
2875 if (SBYTES (filename
) == 2
2876 && *(SDATA (filename
) + 1) == ':')
2879 /* first expand it. */
2880 filename
= Fexpand_file_name (filename
, Qnil
);
2882 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename
)), longname
,
2886 dostounix_filename (longname
);
2888 /* If we were passed only a drive, make sure that a slash is not appended
2889 for consistency with directories. Allow for drive mapping via SUBST
2890 in case expand-file-name is ever changed to expand those. */
2891 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
2894 return DECODE_FILE (build_unibyte_string (longname
));
2897 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
2898 Sw32_set_process_priority
, 2, 2, 0,
2899 doc
: /* Set the priority of PROCESS to PRIORITY.
2900 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2901 priority of the process whose pid is PROCESS is changed.
2902 PRIORITY should be one of the symbols high, normal, or low;
2903 any other symbol will be interpreted as normal.
2905 If successful, the return value is t, otherwise nil. */)
2906 (Lisp_Object process
, Lisp_Object priority
)
2908 HANDLE proc_handle
= GetCurrentProcess ();
2909 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
2910 Lisp_Object result
= Qnil
;
2912 CHECK_SYMBOL (priority
);
2914 if (!NILP (process
))
2919 CHECK_NUMBER (process
);
2921 /* Allow pid to be an internally generated one, or one obtained
2922 externally. This is necessary because real pids on Windows 95 are
2925 pid
= XINT (process
);
2926 cp
= find_child_pid (pid
);
2928 pid
= cp
->procinfo
.dwProcessId
;
2930 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
2933 if (EQ (priority
, Qhigh
))
2934 priority_class
= HIGH_PRIORITY_CLASS
;
2935 else if (EQ (priority
, Qlow
))
2936 priority_class
= IDLE_PRIORITY_CLASS
;
2938 if (proc_handle
!= NULL
)
2940 if (SetPriorityClass (proc_handle
, priority_class
))
2942 if (!NILP (process
))
2943 CloseHandle (proc_handle
);
2949 #ifdef HAVE_LANGINFO_CODESET
2950 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2952 nl_langinfo (nl_item item
)
2954 /* Conversion of Posix item numbers to their Windows equivalents. */
2955 static const LCTYPE w32item
[] = {
2956 LOCALE_IDEFAULTANSICODEPAGE
,
2957 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
2958 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
2959 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
2960 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
2961 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
2962 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
2965 static char *nl_langinfo_buf
= NULL
;
2966 static int nl_langinfo_len
= 0;
2968 if (nl_langinfo_len
<= 0)
2969 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
2971 if (item
< 0 || item
>= _NL_NUM
)
2972 nl_langinfo_buf
[0] = 0;
2975 LCID cloc
= GetThreadLocale ();
2976 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2980 nl_langinfo_buf
[0] = 0;
2983 if (item
== CODESET
)
2985 need_len
+= 2; /* for the "cp" prefix */
2986 if (need_len
< 8) /* for the case we call GetACP */
2989 if (nl_langinfo_len
<= need_len
)
2990 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
2991 nl_langinfo_len
= need_len
);
2992 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2993 nl_langinfo_buf
, nl_langinfo_len
))
2994 nl_langinfo_buf
[0] = 0;
2995 else if (item
== CODESET
)
2997 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
2998 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
2999 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
3002 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
3003 strlen (nl_langinfo_buf
) + 1);
3004 nl_langinfo_buf
[0] = 'c';
3005 nl_langinfo_buf
[1] = 'p';
3010 return nl_langinfo_buf
;
3012 #endif /* HAVE_LANGINFO_CODESET */
3014 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
3015 Sw32_get_locale_info
, 1, 2, 0,
3016 doc
: /* Return information about the Windows locale LCID.
3017 By default, return a three letter locale code which encodes the default
3018 language as the first two characters, and the country or regional variant
3019 as the third letter. For example, ENU refers to `English (United States)',
3020 while ENC means `English (Canadian)'.
3022 If the optional argument LONGFORM is t, the long form of the locale
3023 name is returned, e.g. `English (United States)' instead; if LONGFORM
3024 is a number, it is interpreted as an LCTYPE constant and the corresponding
3025 locale information is returned.
3027 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
3028 (Lisp_Object lcid
, Lisp_Object longform
)
3032 char abbrev_name
[32] = { 0 };
3033 char full_name
[256] = { 0 };
3035 CHECK_NUMBER (lcid
);
3037 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
3040 if (NILP (longform
))
3042 got_abbrev
= GetLocaleInfo (XINT (lcid
),
3043 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
3044 abbrev_name
, sizeof (abbrev_name
));
3046 return build_string (abbrev_name
);
3048 else if (EQ (longform
, Qt
))
3050 got_full
= GetLocaleInfo (XINT (lcid
),
3051 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
3052 full_name
, sizeof (full_name
));
3054 return DECODE_SYSTEM (build_string (full_name
));
3056 else if (NUMBERP (longform
))
3058 got_full
= GetLocaleInfo (XINT (lcid
),
3060 full_name
, sizeof (full_name
));
3061 /* GetLocaleInfo's return value includes the terminating null
3062 character, when the returned information is a string, whereas
3063 make_unibyte_string needs the string length without the
3064 terminating null. */
3066 return make_unibyte_string (full_name
, got_full
- 1);
3073 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
3074 Sw32_get_current_locale_id
, 0, 0, 0,
3075 doc
: /* Return Windows locale id for current locale setting.
3076 This is a numerical value; use `w32-get-locale-info' to convert to a
3077 human-readable form. */)
3080 return make_number (GetThreadLocale ());
3084 int_from_hex (char * s
)
3087 static char hex
[] = "0123456789abcdefABCDEF";
3090 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
3092 unsigned digit
= p
- hex
;
3095 val
= val
* 16 + digit
;
3101 /* We need to build a global list, since the EnumSystemLocale callback
3102 function isn't given a context pointer. */
3103 Lisp_Object Vw32_valid_locale_ids
;
3105 static BOOL CALLBACK ALIGN_STACK
3106 enum_locale_fn (LPTSTR localeNum
)
3108 DWORD id
= int_from_hex (localeNum
);
3109 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
3113 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
3114 Sw32_get_valid_locale_ids
, 0, 0, 0,
3115 doc
: /* Return list of all valid Windows locale ids.
3116 Each id is a numerical value; use `w32-get-locale-info' to convert to a
3117 human-readable form. */)
3120 Vw32_valid_locale_ids
= Qnil
;
3122 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
3124 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
3125 return Vw32_valid_locale_ids
;
3129 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
3130 doc
: /* Return Windows locale id for default locale setting.
3131 By default, the system default locale setting is returned; if the optional
3132 parameter USERP is non-nil, the user default locale setting is returned.
3133 This is a numerical value; use `w32-get-locale-info' to convert to a
3134 human-readable form. */)
3138 return make_number (GetSystemDefaultLCID ());
3139 return make_number (GetUserDefaultLCID ());
3143 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
3144 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
3145 If successful, the new locale id is returned, otherwise nil. */)
3148 CHECK_NUMBER (lcid
);
3150 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
3153 if (!SetThreadLocale (XINT (lcid
)))
3156 /* Need to set input thread locale if present. */
3157 if (dwWindowsThreadId
)
3158 /* Reply is not needed. */
3159 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
3161 return make_number (GetThreadLocale ());
3165 /* We need to build a global list, since the EnumCodePages callback
3166 function isn't given a context pointer. */
3167 Lisp_Object Vw32_valid_codepages
;
3169 static BOOL CALLBACK ALIGN_STACK
3170 enum_codepage_fn (LPTSTR codepageNum
)
3172 DWORD id
= atoi (codepageNum
);
3173 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
3177 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
3178 Sw32_get_valid_codepages
, 0, 0, 0,
3179 doc
: /* Return list of all valid Windows codepages. */)
3182 Vw32_valid_codepages
= Qnil
;
3184 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
3186 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
3187 return Vw32_valid_codepages
;
3191 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
3192 Sw32_get_console_codepage
, 0, 0, 0,
3193 doc
: /* Return current Windows codepage for console input. */)
3196 return make_number (GetConsoleCP ());
3200 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
3201 Sw32_set_console_codepage
, 1, 1, 0,
3202 doc
: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
3203 This codepage setting affects keyboard input in tty mode.
3204 If successful, the new CP is returned, otherwise nil. */)
3209 if (!IsValidCodePage (XINT (cp
)))
3212 if (!SetConsoleCP (XINT (cp
)))
3215 return make_number (GetConsoleCP ());
3219 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
3220 Sw32_get_console_output_codepage
, 0, 0, 0,
3221 doc
: /* Return current Windows codepage for console output. */)
3224 return make_number (GetConsoleOutputCP ());
3228 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
3229 Sw32_set_console_output_codepage
, 1, 1, 0,
3230 doc
: /* Make Windows codepage CP be the codepage for Emacs console output.
3231 This codepage setting affects display in tty mode.
3232 If successful, the new CP is returned, otherwise nil. */)
3237 if (!IsValidCodePage (XINT (cp
)))
3240 if (!SetConsoleOutputCP (XINT (cp
)))
3243 return make_number (GetConsoleOutputCP ());
3247 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
3248 Sw32_get_codepage_charset
, 1, 1, 0,
3249 doc
: /* Return charset ID corresponding to codepage CP.
3250 Returns nil if the codepage is not valid or its charset ID could
3253 Note that this function is only guaranteed to work with ANSI
3254 codepages; most console codepages are not supported and will
3263 if (!IsValidCodePage (XINT (cp
)))
3266 /* Going through a temporary DWORD variable avoids compiler warning
3267 about cast to pointer from integer of different size, when
3268 building --with-wide-int. */
3270 if (TranslateCharsetInfo ((DWORD
*) dwcp
, &info
, TCI_SRCCODEPAGE
))
3271 return make_number (info
.ciCharset
);
3277 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
3278 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
3279 doc
: /* Return list of Windows keyboard languages and layouts.
3280 The return value is a list of pairs of language id and layout id. */)
3283 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
3284 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
3285 Lisp_Object obj
= Qnil
;
3287 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
3289 while (--num_layouts
>= 0)
3291 HKL kl
= layouts
[num_layouts
];
3293 obj
= Fcons (Fcons (make_number (LOWORD (kl
)),
3294 make_number (HIWORD (kl
))),
3303 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
3304 Sw32_get_keyboard_layout
, 0, 0, 0,
3305 doc
: /* Return current Windows keyboard language and layout.
3306 The return value is the cons of the language id and the layout id. */)
3309 HKL kl
= GetKeyboardLayout (dwWindowsThreadId
);
3311 return Fcons (make_number (LOWORD (kl
)),
3312 make_number (HIWORD (kl
)));
3316 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
3317 Sw32_set_keyboard_layout
, 1, 1, 0,
3318 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
3319 The keyboard layout setting affects interpretation of keyboard input.
3320 If successful, the new layout id is returned, otherwise nil. */)
3321 (Lisp_Object layout
)
3325 CHECK_CONS (layout
);
3326 CHECK_NUMBER_CAR (layout
);
3327 CHECK_NUMBER_CDR (layout
);
3329 kl
= (HKL
) (UINT_PTR
) ((XINT (XCAR (layout
)) & 0xffff)
3330 | (XINT (XCDR (layout
)) << 16));
3332 /* Synchronize layout with input thread. */
3333 if (dwWindowsThreadId
)
3335 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
3339 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
3341 if (msg
.wParam
== 0)
3345 else if (!ActivateKeyboardLayout (kl
, 0))
3348 return Fw32_get_keyboard_layout ();
3351 /* Two variables to interface between get_lcid and the EnumLocales
3352 callback function below. */
3353 #ifndef LOCALE_NAME_MAX_LENGTH
3354 # define LOCALE_NAME_MAX_LENGTH 85
3356 static LCID found_lcid
;
3357 static char lname
[3 * LOCALE_NAME_MAX_LENGTH
+ 1 + 1];
3359 /* Callback function for EnumLocales. */
3360 static BOOL CALLBACK
3361 get_lcid_callback (LPTSTR locale_num_str
)
3364 char locval
[2 * LOCALE_NAME_MAX_LENGTH
+ 1 + 1];
3365 LCID try_lcid
= strtoul (locale_num_str
, &endp
, 16);
3367 if (GetLocaleInfo (try_lcid
, LOCALE_SABBREVLANGNAME
,
3368 locval
, LOCALE_NAME_MAX_LENGTH
))
3372 /* This is for when they only specify the language, as in "ENU". */
3373 if (stricmp (locval
, lname
) == 0)
3375 found_lcid
= try_lcid
;
3378 locval_len
= strlen (locval
);
3379 strcpy (locval
+ locval_len
, "_");
3380 if (GetLocaleInfo (try_lcid
, LOCALE_SABBREVCTRYNAME
,
3381 locval
+ locval_len
+ 1, LOCALE_NAME_MAX_LENGTH
))
3383 locval_len
= strlen (locval
);
3384 if (strnicmp (locval
, lname
, locval_len
) == 0
3385 && (lname
[locval_len
] == '.'
3386 || lname
[locval_len
] == '\0'))
3388 found_lcid
= try_lcid
;
3396 /* Return the Locale ID (LCID) number given the locale's name, a
3397 string, in LOCALE_NAME. This works by enumerating all the locales
3398 supported by the system, until we find one whose name matches
3401 get_lcid (const char *locale_name
)
3403 /* A simple cache. */
3404 static LCID last_lcid
;
3405 static char last_locale
[1000];
3407 /* The code below is not thread-safe, as it uses static variables.
3408 But this function is called only from the Lisp thread. */
3409 if (last_lcid
> 0 && strcmp (locale_name
, last_locale
) == 0)
3412 strncpy (lname
, locale_name
, sizeof (lname
) - 1);
3413 lname
[sizeof (lname
) - 1] = '\0';
3415 EnumSystemLocales (get_lcid_callback
, LCID_SUPPORTED
);
3418 last_lcid
= found_lcid
;
3419 strcpy (last_locale
, locale_name
);
3424 #ifndef _NSLCMPERROR
3425 # define _NSLCMPERROR INT_MAX
3427 #ifndef LINGUISTIC_IGNORECASE
3428 # define LINGUISTIC_IGNORECASE 0x00000010
3432 w32_compare_strings (const char *s1
, const char *s2
, char *locname
,
3435 LCID lcid
= GetThreadLocale ();
3436 wchar_t *string1_w
, *string2_w
;
3438 extern BOOL g_b_init_compare_string_w
;
3439 static int (WINAPI
*pCompareStringW
)(LCID
, DWORD
, LPCWSTR
, int, LPCWSTR
, int);
3444 /* The LCID machinery doesn't seem to support the "C" locale, so we
3445 need to do that by hand. */
3447 && ((locname
[0] == 'C' && (locname
[1] == '\0' || locname
[1] == '.'))
3448 || strcmp (locname
, "POSIX") == 0))
3449 return (ignore_case
? stricmp (s1
, s2
) : strcmp (s1
, s2
));
3451 if (!g_b_init_compare_string_w
)
3453 if (os_subtype
== OS_9X
)
3455 pCompareStringW
= GetProcAddress (LoadLibrary ("Unicows.dll"),
3457 if (!pCompareStringW
)
3460 /* This return value is compatible with wcscoll and
3461 other MS CRT functions. */
3462 return _NSLCMPERROR
;
3466 pCompareStringW
= CompareStringW
;
3468 g_b_init_compare_string_w
= 1;
3471 needed
= pMultiByteToWideChar (CP_UTF8
, MB_ERR_INVALID_CHARS
, s1
, -1, NULL
, 0);
3474 SAFE_NALLOCA (string1_w
, 1, needed
+ 1);
3475 pMultiByteToWideChar (CP_UTF8
, MB_ERR_INVALID_CHARS
, s1
, -1,
3481 return _NSLCMPERROR
;
3484 needed
= pMultiByteToWideChar (CP_UTF8
, MB_ERR_INVALID_CHARS
, s2
, -1, NULL
, 0);
3487 SAFE_NALLOCA (string2_w
, 1, needed
+ 1);
3488 pMultiByteToWideChar (CP_UTF8
, MB_ERR_INVALID_CHARS
, s2
, -1,
3495 return _NSLCMPERROR
;
3500 /* Convert locale name string to LCID. We don't want to use
3501 LocaleNameToLCID because (a) it is only available since
3502 Vista, and (b) it doesn't accept locale names returned by
3503 'setlocale' and 'GetLocaleInfo'. */
3504 LCID new_lcid
= get_lcid (locname
);
3509 error ("Invalid locale %s: Invalid argument", locname
);
3514 /* NORM_IGNORECASE ignores any tertiary distinction, not just
3515 case variants. LINGUISTIC_IGNORECASE is more selective, and
3516 is sensitive to the locale's language, but it is not
3517 available before Vista. */
3518 if (w32_major_version
>= 6)
3519 flags
|= LINGUISTIC_IGNORECASE
;
3521 flags
|= NORM_IGNORECASE
;
3523 /* This approximates what glibc collation functions do when the
3524 locale's codeset is UTF-8. */
3525 if (!NILP (Vw32_collate_ignore_punctuation
))
3526 flags
|= NORM_IGNORESYMBOLS
;
3527 val
= pCompareStringW (lcid
, flags
, string1_w
, -1, string2_w
, -1);
3532 return _NSLCMPERROR
;
3539 syms_of_ntproc (void)
3541 DEFSYM (Qhigh
, "high");
3542 DEFSYM (Qlow
, "low");
3544 defsubr (&Sw32_has_winsock
);
3545 defsubr (&Sw32_unload_winsock
);
3547 defsubr (&Sw32_short_file_name
);
3548 defsubr (&Sw32_long_file_name
);
3549 defsubr (&Sw32_set_process_priority
);
3550 defsubr (&Sw32_get_locale_info
);
3551 defsubr (&Sw32_get_current_locale_id
);
3552 defsubr (&Sw32_get_default_locale_id
);
3553 defsubr (&Sw32_get_valid_locale_ids
);
3554 defsubr (&Sw32_set_current_locale
);
3556 defsubr (&Sw32_get_console_codepage
);
3557 defsubr (&Sw32_set_console_codepage
);
3558 defsubr (&Sw32_get_console_output_codepage
);
3559 defsubr (&Sw32_set_console_output_codepage
);
3560 defsubr (&Sw32_get_valid_codepages
);
3561 defsubr (&Sw32_get_codepage_charset
);
3563 defsubr (&Sw32_get_valid_keyboard_layouts
);
3564 defsubr (&Sw32_get_keyboard_layout
);
3565 defsubr (&Sw32_set_keyboard_layout
);
3567 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args
,
3568 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3569 Because Windows does not directly pass argv arrays to child processes,
3570 programs have to reconstruct the argv array by parsing the command
3571 line string. For an argument to contain a space, it must be enclosed
3572 in double quotes or it will be parsed as multiple arguments.
3574 If the value is a character, that character will be used to escape any
3575 quote characters that appear, otherwise a suitable escape character
3576 will be chosen based on the type of the program. */);
3577 Vw32_quote_process_args
= Qt
;
3579 DEFVAR_LISP ("w32-start-process-show-window",
3580 Vw32_start_process_show_window
,
3581 doc
: /* When nil, new child processes hide their windows.
3582 When non-nil, they show their window in the method of their choice.
3583 This variable doesn't affect GUI applications, which will never be hidden. */);
3584 Vw32_start_process_show_window
= Qnil
;
3586 DEFVAR_LISP ("w32-start-process-share-console",
3587 Vw32_start_process_share_console
,
3588 doc
: /* When nil, new child processes are given a new console.
3589 When non-nil, they share the Emacs console; this has the limitation of
3590 allowing only one DOS subprocess to run at a time (whether started directly
3591 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3592 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3593 otherwise respond to interrupts from Emacs. */);
3594 Vw32_start_process_share_console
= Qnil
;
3596 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3597 Vw32_start_process_inherit_error_mode
,
3598 doc
: /* When nil, new child processes revert to the default error mode.
3599 When non-nil, they inherit their error mode setting from Emacs, which stops
3600 them blocking when trying to access unmounted drives etc. */);
3601 Vw32_start_process_inherit_error_mode
= Qt
;
3603 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay
,
3604 doc
: /* Forced delay before reading subprocess output.
3605 This is done to improve the buffering of subprocess output, by
3606 avoiding the inefficiency of frequently reading small amounts of data.
3608 If positive, the value is the number of milliseconds to sleep before
3609 reading the subprocess output. If negative, the magnitude is the number
3610 of time slices to wait (effectively boosting the priority of the child
3611 process temporarily). A value of zero disables waiting entirely. */);
3612 w32_pipe_read_delay
= 50;
3614 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names
,
3615 doc
: /* Non-nil means convert all-upper case file names to lower case.
3616 This applies when performing completions and file name expansion.
3617 Note that the value of this setting also affects remote file names,
3618 so you probably don't want to set to non-nil if you use case-sensitive
3619 filesystems via ange-ftp. */);
3620 Vw32_downcase_file_names
= Qnil
;
3623 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes
,
3624 doc
: /* Non-nil means attempt to fake realistic inode values.
3625 This works by hashing the truename of files, and should detect
3626 aliasing between long and short (8.3 DOS) names, but can have
3627 false positives because of hash collisions. Note that determining
3628 the truename of a file can be slow. */);
3629 Vw32_generate_fake_inodes
= Qnil
;
3632 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes
,
3633 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
3634 This option controls whether to issue additional system calls to determine
3635 accurate link counts, file type, and ownership information. It is more
3636 useful for files on NTFS volumes, where hard links and file security are
3637 supported, than on volumes of the FAT family.
3639 Without these system calls, link count will always be reported as 1 and file
3640 ownership will be attributed to the current user.
3641 The default value `local' means only issue these system calls for files
3642 on local fixed drives. A value of nil means never issue them.
3643 Any other non-nil value means do this even on remote and removable drives
3644 where the performance impact may be noticeable even on modern hardware. */);
3645 Vw32_get_true_file_attributes
= Qlocal
;
3647 DEFVAR_LISP ("w32-collate-ignore-punctuation",
3648 Vw32_collate_ignore_punctuation
,
3649 doc
: /* Non-nil causes string collation functions ignore punctuation on MS-Windows.
3650 On Posix platforms, `string-collate-lessp' and `string-collate-equalp'
3651 ignore punctuation characters when they compare strings, if the
3652 locale's codeset is UTF-8, as in \"en_US.UTF-8\". Binding this option
3653 to a non-nil value will achieve a similar effect on MS-Windows, where
3654 locales with UTF-8 codeset are not supported.
3656 Note that setting this to non-nil will also ignore blanks and symbols
3657 in the strings. So do NOT use this option when comparing file names
3658 for equality, only when you need to sort them. */);
3659 Vw32_collate_ignore_punctuation
= Qnil
;
3661 staticpro (&Vw32_valid_locale_ids
);
3662 staticpro (&Vw32_valid_codepages
);
3664 /* end of w32proc.c */