1 /* Process support for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1992, 1995, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3 2006, 2007, 2008, 2009, 2010 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
34 /* must include CRT headers *before* config.h */
45 /* This definition is missing from mingw32 headers. */
46 extern BOOL WINAPI
IsValidLocale (LCID
, DWORD
);
49 #ifdef HAVE_LANGINFO_CODESET
55 #include "character.h"
61 #include "syssignal.h"
63 #include "dispextern.h" /* for xstrcasecmp */
66 #define RVA_TO_PTR(var,section,filedata) \
67 ((void *)((section)->PointerToRawData \
68 + ((DWORD)(var) - (section)->VirtualAddress) \
69 + (filedata).file_base))
71 /* Control whether spawnve quotes arguments as necessary to ensure
72 correct parsing by child process. Because not all uses of spawnve
73 are careful about constructing argv arrays, we make this behavior
74 conditional (off by default). */
75 Lisp_Object Vw32_quote_process_args
;
77 /* Control whether create_child causes the process' window to be
78 hidden. The default is nil. */
79 Lisp_Object Vw32_start_process_show_window
;
81 /* Control whether create_child causes the process to inherit Emacs'
82 console window, or be given a new one of its own. The default is
83 nil, to allow multiple DOS programs to run on Win95. Having separate
84 consoles also allows Emacs to cleanly terminate process groups. */
85 Lisp_Object Vw32_start_process_share_console
;
87 /* Control whether create_child cause the process to inherit Emacs'
88 error mode setting. The default is t, to minimize the possibility of
89 subprocesses blocking when accessing unmounted drives. */
90 Lisp_Object Vw32_start_process_inherit_error_mode
;
92 /* Time to sleep before reading from a subprocess output pipe - this
93 avoids the inefficiency of frequently reading small amounts of data.
94 This is primarily necessary for handling DOS processes on Windows 95,
95 but is useful for W32 processes on both Windows 95 and NT as well. */
96 int w32_pipe_read_delay
;
98 /* Control conversion of upper case file names to lower case.
99 nil means no, t means yes. */
100 Lisp_Object Vw32_downcase_file_names
;
102 /* Control whether stat() attempts to generate fake but hopefully
103 "accurate" inode values, by hashing the absolute truenames of files.
104 This should detect aliasing between long and short names, but still
105 allows the possibility of hash collisions. */
106 Lisp_Object Vw32_generate_fake_inodes
;
108 /* Control whether stat() attempts to determine file type and link count
109 exactly, at the expense of slower operation. Since true hard links
110 are supported on NTFS volumes, this is only relevant on NT. */
111 Lisp_Object Vw32_get_true_file_attributes
;
112 extern Lisp_Object Qlocal
;
114 Lisp_Object Qhigh
, Qlow
;
118 _DebPrint (const char *fmt
, ...)
123 va_start (args
, fmt
);
124 vsprintf (buf
, fmt
, args
);
126 OutputDebugString (buf
);
130 typedef void (_CALLBACK_
*signal_handler
) (int);
132 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
133 static signal_handler sig_handlers
[NSIG
];
135 /* Fake signal implementation to record the SIGCHLD handler. */
137 sys_signal (int sig
, signal_handler handler
)
146 old
= sig_handlers
[sig
];
147 sig_handlers
[sig
] = handler
;
151 /* Defined in <process.h> which conflicts with the local copy */
154 /* Child process management list. */
155 int child_proc_count
= 0;
156 child_process child_procs
[ MAX_CHILDREN
];
157 child_process
*dead_child
= NULL
;
159 static DWORD WINAPI
reader_thread (void *arg
);
161 /* Find an unused process slot. */
168 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
169 if (!CHILD_ACTIVE (cp
))
171 if (child_proc_count
== MAX_CHILDREN
)
173 cp
= &child_procs
[child_proc_count
++];
176 memset (cp
, 0, sizeof (*cp
));
179 cp
->procinfo
.hProcess
= NULL
;
180 cp
->status
= STATUS_READ_ERROR
;
182 /* use manual reset event so that select() will function properly */
183 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
186 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
187 if (cp
->char_consumed
)
189 cp
->thrd
= CreateThread (NULL
, 1024, reader_thread
, cp
, 0, &id
);
199 delete_child (child_process
*cp
)
203 /* Should not be deleting a child that is still needed. */
204 for (i
= 0; i
< MAXDESC
; i
++)
205 if (fd_info
[i
].cp
== cp
)
208 if (!CHILD_ACTIVE (cp
))
211 /* reap thread if necessary */
216 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
218 /* let the thread exit cleanly if possible */
219 cp
->status
= STATUS_READ_ERROR
;
220 SetEvent (cp
->char_consumed
);
222 /* We used to forceably terminate the thread here, but it
223 is normally unnecessary, and in abnormal cases, the worst that
224 will happen is we have an extra idle thread hanging around
225 waiting for the zombie process. */
226 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
228 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
229 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
230 TerminateThread (cp
->thrd
, 0);
234 CloseHandle (cp
->thrd
);
239 CloseHandle (cp
->char_avail
);
240 cp
->char_avail
= NULL
;
242 if (cp
->char_consumed
)
244 CloseHandle (cp
->char_consumed
);
245 cp
->char_consumed
= NULL
;
248 /* update child_proc_count (highest numbered slot in use plus one) */
249 if (cp
== child_procs
+ child_proc_count
- 1)
251 for (i
= child_proc_count
-1; i
>= 0; i
--)
252 if (CHILD_ACTIVE (&child_procs
[i
]))
254 child_proc_count
= i
+ 1;
259 child_proc_count
= 0;
262 /* Find a child by pid. */
263 static child_process
*
264 find_child_pid (DWORD pid
)
268 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
269 if (CHILD_ACTIVE (cp
) && pid
== cp
->pid
)
275 /* Thread proc for child process and socket reader threads. Each thread
276 is normally blocked until woken by select() to check for input by
277 reading one char. When the read completes, char_avail is signaled
278 to wake up the select emulator and the thread blocks itself again. */
280 reader_thread (void *arg
)
285 cp
= (child_process
*)arg
;
287 /* We have to wait for the go-ahead before we can start */
289 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
296 if (fd_info
[cp
->fd
].flags
& FILE_LISTEN
)
297 rc
= _sys_wait_accept (cp
->fd
);
299 rc
= _sys_read_ahead (cp
->fd
);
301 /* The name char_avail is a misnomer - it really just means the
302 read-ahead has completed, whether successfully or not. */
303 if (!SetEvent (cp
->char_avail
))
305 DebPrint (("reader_thread.SetEvent failed with %lu for fd %ld\n",
306 GetLastError (), cp
->fd
));
310 if (rc
== STATUS_READ_ERROR
)
313 /* If the read died, the child has died so let the thread die */
314 if (rc
== STATUS_READ_FAILED
)
317 /* Wait until our input is acknowledged before reading again */
318 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
320 DebPrint (("reader_thread.WaitForSingleObject failed with "
321 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
328 /* To avoid Emacs changing directory, we just record here the directory
329 the new process should start in. This is set just before calling
330 sys_spawnve, and is not generally valid at any other time. */
331 static char * process_dir
;
334 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
335 int * pPid
, child_process
*cp
)
338 SECURITY_ATTRIBUTES sec_attrs
;
340 SECURITY_DESCRIPTOR sec_desc
;
343 char dir
[ MAXPATHLEN
];
345 if (cp
== NULL
) abort ();
347 memset (&start
, 0, sizeof (start
));
348 start
.cb
= sizeof (start
);
351 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
352 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
354 start
.dwFlags
= STARTF_USESTDHANDLES
;
355 start
.wShowWindow
= SW_HIDE
;
357 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
358 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
359 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
360 #endif /* HAVE_NTGUI */
363 /* Explicitly specify no security */
364 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
366 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
369 sec_attrs
.nLength
= sizeof (sec_attrs
);
370 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
371 sec_attrs
.bInheritHandle
= FALSE
;
373 strcpy (dir
, process_dir
);
374 unixtodos_filename (dir
);
376 flags
= (!NILP (Vw32_start_process_share_console
)
377 ? CREATE_NEW_PROCESS_GROUP
378 : CREATE_NEW_CONSOLE
);
379 if (NILP (Vw32_start_process_inherit_error_mode
))
380 flags
|= CREATE_DEFAULT_ERROR_MODE
;
381 if (!CreateProcess (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
382 flags
, env
, dir
, &start
, &cp
->procinfo
))
385 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
387 /* Hack for Windows 95, which assigns large (ie negative) pids */
391 /* pid must fit in a Lisp_Int */
392 cp
->pid
= cp
->pid
& INTMASK
;
399 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
403 /* create_child doesn't know what emacs' file handle will be for waiting
404 on output from the child, so we need to make this additional call
405 to register the handle with the process
406 This way the select emulator knows how to match file handles with
407 entries in child_procs. */
409 register_child (int pid
, int fd
)
413 cp
= find_child_pid (pid
);
416 DebPrint (("register_child unable to find pid %lu\n", pid
));
421 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
426 /* thread is initially blocked until select is called; set status so
427 that select will release thread */
428 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
430 /* attach child_process to fd_info */
431 if (fd_info
[fd
].cp
!= NULL
)
433 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
440 /* When a process dies its pipe will break so the reader thread will
441 signal failure to the select emulator.
442 The select emulator then calls this routine to clean up.
443 Since the thread signaled failure we can assume it is exiting. */
445 reap_subprocess (child_process
*cp
)
447 if (cp
->procinfo
.hProcess
)
449 /* Reap the process */
451 /* Process should have already died before we are called. */
452 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
453 DebPrint (("reap_subprocess: child fpr fd %d has not died yet!", cp
->fd
));
455 CloseHandle (cp
->procinfo
.hProcess
);
456 cp
->procinfo
.hProcess
= NULL
;
457 CloseHandle (cp
->procinfo
.hThread
);
458 cp
->procinfo
.hThread
= NULL
;
461 /* For asynchronous children, the child_proc resources will be freed
462 when the last pipe read descriptor is closed; for synchronous
463 children, we must explicitly free the resources now because
464 register_child has not been called. */
469 /* Wait for any of our existing child processes to die
470 When it does, close its handle
471 Return the pid and fill in the status if non-NULL. */
474 sys_wait (int *status
)
476 DWORD active
, retval
;
479 child_process
*cp
, *cps
[MAX_CHILDREN
];
480 HANDLE wait_hnd
[MAX_CHILDREN
];
483 if (dead_child
!= NULL
)
485 /* We want to wait for a specific child */
486 wait_hnd
[nh
] = dead_child
->procinfo
.hProcess
;
487 cps
[nh
] = dead_child
;
488 if (!wait_hnd
[nh
]) abort ();
495 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
496 /* some child_procs might be sockets; ignore them */
497 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
498 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
500 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
508 /* Nothing to wait on, so fail */
515 /* Check for quit about once a second. */
517 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, 1000);
518 } while (active
== WAIT_TIMEOUT
);
520 if (active
== WAIT_FAILED
)
525 else if (active
>= WAIT_OBJECT_0
526 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
528 active
-= WAIT_OBJECT_0
;
530 else if (active
>= WAIT_ABANDONED_0
531 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
533 active
-= WAIT_ABANDONED_0
;
539 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
541 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
545 if (retval
== STILL_ACTIVE
)
547 /* Should never happen */
548 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
553 /* Massage the exit code from the process to match the format expected
554 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
555 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
557 if (retval
== STATUS_CONTROL_C_EXIT
)
565 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
572 else if (synch_process_alive
)
574 synch_process_alive
= 0;
576 /* Report the status of the synchronous process. */
577 if (WIFEXITED (retval
))
578 synch_process_retcode
= WRETCODE (retval
);
579 else if (WIFSIGNALED (retval
))
581 int code
= WTERMSIG (retval
);
584 synchronize_system_messages_locale ();
585 signame
= strsignal (code
);
590 synch_process_death
= signame
;
593 reap_subprocess (cp
);
596 reap_subprocess (cp
);
601 /* Old versions of w32api headers don't have separate 32-bit and
602 64-bit defines, but the one they have matches the 32-bit variety. */
603 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
604 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
605 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
609 w32_executable_type (char * filename
,
614 file_data executable
;
617 /* Default values in case we can't tell for sure. */
619 *is_cygnus_app
= FALSE
;
622 if (!open_input_file (&executable
, filename
))
625 p
= strrchr (filename
, '.');
627 /* We can only identify DOS .com programs from the extension. */
628 if (p
&& xstrcasecmp (p
, ".com") == 0)
630 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
631 || xstrcasecmp (p
, ".cmd") == 0))
633 /* A DOS shell script - it appears that CreateProcess is happy to
634 accept this (somewhat surprisingly); presumably it looks at
635 COMSPEC to determine what executable to actually invoke.
636 Therefore, we have to do the same here as well. */
637 /* Actually, I think it uses the program association for that
638 extension, which is defined in the registry. */
639 p
= egetenv ("COMSPEC");
641 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
645 /* Look for DOS .exe signature - if found, we must also check that
646 it isn't really a 16- or 32-bit Windows exe, since both formats
647 start with a DOS program stub. Note that 16-bit Windows
648 executables use the OS/2 1.x format. */
650 IMAGE_DOS_HEADER
* dos_header
;
651 IMAGE_NT_HEADERS
* nt_header
;
653 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
654 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
657 nt_header
= (PIMAGE_NT_HEADERS
) ((char *) dos_header
+ dos_header
->e_lfanew
);
659 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
661 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
664 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
665 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
669 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
671 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
672 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
674 /* Ensure we are using the 32 bit structure. */
675 IMAGE_OPTIONAL_HEADER32
*opt
676 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
677 data_dir
= opt
->DataDirectory
;
678 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
680 /* MingW 3.12 has the required 64 bit structs, but in case older
681 versions don't, only check 64 bit exes if we know how. */
682 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
683 else if (nt_header
->OptionalHeader
.Magic
684 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
686 IMAGE_OPTIONAL_HEADER64
*opt
687 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
688 data_dir
= opt
->DataDirectory
;
689 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
694 /* Look for cygwin.dll in DLL import list. */
695 IMAGE_DATA_DIRECTORY import_dir
=
696 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
697 IMAGE_IMPORT_DESCRIPTOR
* imports
;
698 IMAGE_SECTION_HEADER
* section
;
700 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
701 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
704 for ( ; imports
->Name
; imports
++)
706 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
709 /* The exact name of the cygwin dll has changed with
710 various releases, but hopefully this will be reasonably
712 if (strncmp (dllname
, "cygwin", 6) == 0)
714 *is_cygnus_app
= TRUE
;
723 close_file_data (&executable
);
727 compare_env (const void *strp1
, const void *strp2
)
729 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
731 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
733 /* Sort order in command.com/cmd.exe is based on uppercasing
734 names, so do the same here. */
735 if (toupper (*str1
) > toupper (*str2
))
737 else if (toupper (*str1
) < toupper (*str2
))
742 if (*str1
== '=' && *str2
== '=')
744 else if (*str1
== '=')
751 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
767 qsort (new_envp
, num
, sizeof (char *), compare_env
);
772 /* When a new child process is created we need to register it in our list,
773 so intercept spawn requests. */
775 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
777 Lisp_Object program
, full
;
778 char *cmdline
, *env
, *parg
, **targ
;
782 int is_dos_app
, is_cygnus_app
, is_gui_app
;
785 /* We pass our process ID to our children by setting up an environment
786 variable in their environment. */
787 char ppid_env_var_buffer
[64];
788 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
789 /* These are the characters that cause an argument to need quoting.
790 Arguments with whitespace characters need quoting to prevent the
791 argument being split into two or more. Arguments with wildcards
792 are also quoted, for consistency with posix platforms, where wildcards
793 are not expanded if we run the program directly without a shell.
794 Some extra whitespace characters need quoting in Cygwin programs,
795 so this list is conditionally modified below. */
796 char *sepchars
= " \t*?";
798 /* We don't care about the other modes */
799 if (mode
!= _P_NOWAIT
)
805 /* Handle executable names without an executable suffix. */
806 program
= make_string (cmdname
, strlen (cmdname
));
807 if (NILP (Ffile_executable_p (program
)))
813 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
));
823 /* make sure argv[0] and cmdname are both in DOS format */
824 cmdname
= SDATA (program
);
825 unixtodos_filename (cmdname
);
828 /* Determine whether program is a 16-bit DOS executable, or a w32
829 executable that is implicitly linked to the Cygnus dll (implying it
830 was compiled with the Cygnus GNU toolchain and hence relies on
831 cygwin.dll to parse the command line - we use this to decide how to
832 escape quote chars in command line args that must be quoted).
834 Also determine whether it is a GUI app, so that we don't hide its
835 initial window unless specifically requested. */
836 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
838 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
839 application to start it by specifying the helper app as cmdname,
840 while leaving the real app name as argv[0]. */
843 cmdname
= alloca (MAXPATHLEN
);
844 if (egetenv ("CMDPROXY"))
845 strcpy (cmdname
, egetenv ("CMDPROXY"));
848 strcpy (cmdname
, SDATA (Vinvocation_directory
));
849 strcat (cmdname
, "cmdproxy.exe");
851 unixtodos_filename (cmdname
);
854 /* we have to do some conjuring here to put argv and envp into the
855 form CreateProcess wants... argv needs to be a space separated/null
856 terminated list of parameters, and envp is a null
857 separated/double-null terminated list of parameters.
859 Additionally, zero-length args and args containing whitespace or
860 quote chars need to be wrapped in double quotes - for this to work,
861 embedded quotes need to be escaped as well. The aim is to ensure
862 the child process reconstructs the argv array we start with
863 exactly, so we treat quotes at the beginning and end of arguments
866 The w32 GNU-based library from Cygnus doubles quotes to escape
867 them, while MSVC uses backslash for escaping. (Actually the MSVC
868 startup code does attempt to recognise doubled quotes and accept
869 them, but gets it wrong and ends up requiring three quotes to get a
870 single embedded quote!) So by default we decide whether to use
871 quote or backslash as the escape character based on whether the
872 binary is apparently a Cygnus compiled app.
874 Note that using backslash to escape embedded quotes requires
875 additional special handling if an embedded quote is already
876 preceeded by backslash, or if an arg requiring quoting ends with
877 backslash. In such cases, the run of escape characters needs to be
878 doubled. For consistency, we apply this special handling as long
879 as the escape character is not quote.
881 Since we have no idea how large argv and envp are likely to be we
882 figure out list lengths on the fly and allocate them. */
884 if (!NILP (Vw32_quote_process_args
))
887 /* Override escape char by binding w32-quote-process-args to
888 desired character, or use t for auto-selection. */
889 if (INTEGERP (Vw32_quote_process_args
))
890 escape_char
= XINT (Vw32_quote_process_args
);
892 escape_char
= is_cygnus_app
? '"' : '\\';
895 /* Cygwin apps needs quoting a bit more often. */
896 if (escape_char
== '"')
897 sepchars
= "\r\n\t\f '";
906 int escape_char_run
= 0;
912 if (escape_char
== '"' && *p
== '\\')
913 /* If it's a Cygwin app, \ needs to be escaped. */
917 /* allow for embedded quotes to be escaped */
920 /* handle the case where the embedded quote is already escaped */
921 if (escape_char_run
> 0)
923 /* To preserve the arg exactly, we need to double the
924 preceding escape characters (plus adding one to
925 escape the quote character itself). */
926 arglen
+= escape_char_run
;
929 else if (strchr (sepchars
, *p
) != NULL
)
934 if (*p
== escape_char
&& escape_char
!= '"')
942 /* handle the case where the arg ends with an escape char - we
943 must not let the enclosing quote be escaped. */
944 if (escape_char_run
> 0)
945 arglen
+= escape_char_run
;
947 arglen
+= strlen (*targ
++) + 1;
949 cmdline
= alloca (arglen
);
963 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
968 int escape_char_run
= 0;
974 last
= p
+ strlen (p
) - 1;
977 /* This version does not escape quotes if they occur at the
978 beginning or end of the arg - this could lead to incorrect
979 behavior when the arg itself represents a command line
980 containing quoted args. I believe this was originally done
981 as a hack to make some things work, before
982 `w32-quote-process-args' was added. */
985 if (*p
== '"' && p
> first
&& p
< last
)
986 *parg
++ = escape_char
; /* escape embedded quotes */
994 /* double preceding escape chars if any */
995 while (escape_char_run
> 0)
997 *parg
++ = escape_char
;
1000 /* escape all quote chars, even at beginning or end */
1001 *parg
++ = escape_char
;
1003 else if (escape_char
== '"' && *p
== '\\')
1007 if (*p
== escape_char
&& escape_char
!= '"')
1010 escape_char_run
= 0;
1012 /* double escape chars before enclosing quote */
1013 while (escape_char_run
> 0)
1015 *parg
++ = escape_char
;
1023 strcpy (parg
, *targ
);
1024 parg
+= strlen (*targ
);
1034 numenv
= 1; /* for end null */
1037 arglen
+= strlen (*targ
++) + 1;
1040 /* extra env vars... */
1041 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%d",
1042 GetCurrentProcessId ());
1043 arglen
+= strlen (ppid_env_var_buffer
) + 1;
1046 /* merge env passed in and extra env into one, and sort it. */
1047 targ
= (char **) alloca (numenv
* sizeof (char *));
1048 merge_and_sort_env (envp
, extra_env
, targ
);
1050 /* concatenate env entries. */
1051 env
= alloca (arglen
);
1055 strcpy (parg
, *targ
);
1056 parg
+= strlen (*targ
++);
1069 /* Now create the process. */
1070 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
1080 /* Emulate the select call
1081 Wait for available input on any of the given rfds, or timeout if
1082 a timeout is given and no input is detected
1083 wfds and efds are not supported and must be NULL.
1085 For simplicity, we detect the death of child processes here and
1086 synchronously call the SIGCHLD handler. Since it is possible for
1087 children to be created without a corresponding pipe handle from which
1088 to read output, we wait separately on the process handles as well as
1089 the char_avail events for each process pipe. We only call
1090 wait/reap_process when the process actually terminates.
1092 To reduce the number of places in which Emacs can be hung such that
1093 C-g is not able to interrupt it, we always wait on interrupt_handle
1094 (which is signaled by the input thread when C-g is detected). If we
1095 detect that we were woken up by C-g, we return -1 with errno set to
1096 EINTR as on Unix. */
1099 extern HANDLE keyboard_handle
;
1101 /* From w32xfns.c */
1102 extern HANDLE interrupt_handle
;
1104 /* From process.c */
1105 extern int proc_buffered_char
[];
1108 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
1109 EMACS_TIME
*timeout
)
1112 DWORD timeout_ms
, start_time
;
1115 child_process
*cp
, *cps
[MAX_CHILDREN
];
1116 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
1117 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
1119 timeout_ms
= timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_usec
/ 1000) : INFINITE
;
1121 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1122 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
1128 /* Otherwise, we only handle rfds, so fail otherwise. */
1129 if (rfds
== NULL
|| wfds
!= NULL
|| efds
!= NULL
)
1139 /* Always wait on interrupt_handle, to detect C-g (quit). */
1140 wait_hnd
[0] = interrupt_handle
;
1143 /* Build a list of pipe handles to wait on. */
1145 for (i
= 0; i
< nfds
; i
++)
1146 if (FD_ISSET (i
, &orfds
))
1150 if (keyboard_handle
)
1152 /* Handle stdin specially */
1153 wait_hnd
[nh
] = keyboard_handle
;
1158 /* Check for any emacs-generated input in the queue since
1159 it won't be detected in the wait */
1160 if (detect_input_pending ())
1168 /* Child process and socket input */
1172 int current_status
= cp
->status
;
1174 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
1176 /* Tell reader thread which file handle to use. */
1178 /* Wake up the reader thread for this process */
1179 cp
->status
= STATUS_READ_READY
;
1180 if (!SetEvent (cp
->char_consumed
))
1181 DebPrint (("nt_select.SetEvent failed with "
1182 "%lu for fd %ld\n", GetLastError (), i
));
1185 #ifdef CHECK_INTERLOCK
1186 /* slightly crude cross-checking of interlock between threads */
1188 current_status
= cp
->status
;
1189 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
1191 /* char_avail has been signaled, so status (which may
1192 have changed) should indicate read has completed
1193 but has not been acknowledged. */
1194 current_status
= cp
->status
;
1195 if (current_status
!= STATUS_READ_SUCCEEDED
1196 && current_status
!= STATUS_READ_FAILED
)
1197 DebPrint (("char_avail set, but read not completed: status %d\n",
1202 /* char_avail has not been signaled, so status should
1203 indicate that read is in progress; small possibility
1204 that read has completed but event wasn't yet signaled
1205 when we tested it (because a context switch occurred
1206 or if running on separate CPUs). */
1207 if (current_status
!= STATUS_READ_READY
1208 && current_status
!= STATUS_READ_IN_PROGRESS
1209 && current_status
!= STATUS_READ_SUCCEEDED
1210 && current_status
!= STATUS_READ_FAILED
)
1211 DebPrint (("char_avail reset, but read status is bad: %d\n",
1215 wait_hnd
[nh
] = cp
->char_avail
;
1217 if (!wait_hnd
[nh
]) abort ();
1220 DebPrint (("select waiting on child %d fd %d\n",
1221 cp
-child_procs
, i
));
1226 /* Unable to find something to wait on for this fd, skip */
1228 /* Note that this is not a fatal error, and can in fact
1229 happen in unusual circumstances. Specifically, if
1230 sys_spawnve fails, eg. because the program doesn't
1231 exist, and debug-on-error is t so Fsignal invokes a
1232 nested input loop, then the process output pipe is
1233 still included in input_wait_mask with no child_proc
1234 associated with it. (It is removed when the debugger
1235 exits the nested input loop and the error is thrown.) */
1237 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
1243 /* Add handles of child processes. */
1245 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1246 /* Some child_procs might be sockets; ignore them. Also some
1247 children may have died already, but we haven't finished reading
1248 the process output; ignore them too. */
1249 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
1251 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
1252 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1255 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
1260 /* Nothing to look for, so we didn't find anything */
1268 start_time
= GetTickCount ();
1270 /* Wait for input or child death to be signaled. If user input is
1271 allowed, then also accept window messages. */
1272 if (FD_ISSET (0, &orfds
))
1273 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
1276 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
1278 if (active
== WAIT_FAILED
)
1280 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
1281 nh
+ nc
, timeout_ms
, GetLastError ()));
1282 /* don't return EBADF - this causes wait_reading_process_output to
1283 abort; WAIT_FAILED is returned when single-stepping under
1284 Windows 95 after switching thread focus in debugger, and
1285 possibly at other times. */
1289 else if (active
== WAIT_TIMEOUT
)
1293 else if (active
>= WAIT_OBJECT_0
1294 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1296 active
-= WAIT_OBJECT_0
;
1298 else if (active
>= WAIT_ABANDONED_0
1299 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1301 active
-= WAIT_ABANDONED_0
;
1306 /* Loop over all handles after active (now officially documented as
1307 being the first signaled handle in the array). We do this to
1308 ensure fairness, so that all channels with data available will be
1309 processed - otherwise higher numbered channels could be starved. */
1312 if (active
== nh
+ nc
)
1314 /* There are messages in the lisp thread's queue; we must
1315 drain the queue now to ensure they are processed promptly,
1316 because if we don't do so, we will not be woken again until
1317 further messages arrive.
1319 NB. If ever we allow window message procedures to callback
1320 into lisp, we will need to ensure messages are dispatched
1321 at a safe time for lisp code to be run (*), and we may also
1322 want to provide some hooks in the dispatch loop to cater
1323 for modeless dialogs created by lisp (ie. to register
1324 window handles to pass to IsDialogMessage).
1326 (*) Note that MsgWaitForMultipleObjects above is an
1327 internal dispatch point for messages that are sent to
1328 windows created by this thread. */
1329 drain_message_queue ();
1331 else if (active
>= nh
)
1333 cp
= cps
[active
- nh
];
1335 /* We cannot always signal SIGCHLD immediately; if we have not
1336 finished reading the process output, we must delay sending
1337 SIGCHLD until we do. */
1339 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
1340 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
1341 /* SIG_DFL for SIGCHLD is ignore */
1342 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
1343 sig_handlers
[SIGCHLD
] != SIG_IGN
)
1346 DebPrint (("select calling SIGCHLD handler for pid %d\n",
1350 sig_handlers
[SIGCHLD
] (SIGCHLD
);
1354 else if (fdindex
[active
] == -1)
1356 /* Quit (C-g) was detected. */
1360 else if (fdindex
[active
] == 0)
1362 /* Keyboard input available */
1368 /* must be a socket or pipe - read ahead should have
1369 completed, either succeeding or failing. */
1370 FD_SET (fdindex
[active
], rfds
);
1374 /* Even though wait_reading_process_output only reads from at most
1375 one channel, we must process all channels here so that we reap
1376 all children that have died. */
1377 while (++active
< nh
+ nc
)
1378 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
1380 } while (active
< nh
+ nc
);
1382 /* If no input has arrived and timeout hasn't expired, wait again. */
1385 DWORD elapsed
= GetTickCount () - start_time
;
1387 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
1389 if (timeout_ms
!= INFINITE
)
1390 timeout_ms
-= elapsed
;
1391 goto count_children
;
1398 /* Substitute for certain kill () operations */
1400 static BOOL CALLBACK
1401 find_child_console (HWND hwnd
, LPARAM arg
)
1403 child_process
* cp
= (child_process
*) arg
;
1407 thread_id
= GetWindowThreadProcessId (hwnd
, &process_id
);
1408 if (process_id
== cp
->procinfo
.dwProcessId
)
1410 char window_class
[32];
1412 GetClassName (hwnd
, window_class
, sizeof (window_class
));
1413 if (strcmp (window_class
,
1414 (os_subtype
== OS_WIN95
)
1416 : "ConsoleWindowClass") == 0)
1427 sys_kill (int pid
, int sig
)
1431 int need_to_free
= 0;
1434 /* Only handle signals that will result in the process dying */
1435 if (sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
1441 cp
= find_child_pid (pid
);
1444 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
1445 if (proc_hand
== NULL
)
1454 proc_hand
= cp
->procinfo
.hProcess
;
1455 pid
= cp
->procinfo
.dwProcessId
;
1457 /* Try to locate console window for process. */
1458 EnumWindows (find_child_console
, (LPARAM
) cp
);
1461 if (sig
== SIGINT
|| sig
== SIGQUIT
)
1463 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
1465 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
1466 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
1467 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
1468 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
1469 HWND foreground_window
;
1471 if (break_scan_code
== 0)
1473 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
1474 vk_break_code
= 'C';
1475 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
1478 foreground_window
= GetForegroundWindow ();
1479 if (foreground_window
)
1481 /* NT 5.0, and apparently also Windows 98, will not allow
1482 a Window to be set to foreground directly without the
1483 user's involvement. The workaround is to attach
1484 ourselves to the thread that owns the foreground
1485 window, since that is the only thread that can set the
1486 foreground window. */
1487 DWORD foreground_thread
, child_thread
;
1489 GetWindowThreadProcessId (foreground_window
, NULL
);
1490 if (foreground_thread
== GetCurrentThreadId ()
1491 || !AttachThreadInput (GetCurrentThreadId (),
1492 foreground_thread
, TRUE
))
1493 foreground_thread
= 0;
1495 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
1496 if (child_thread
== GetCurrentThreadId ()
1497 || !AttachThreadInput (GetCurrentThreadId (),
1498 child_thread
, TRUE
))
1501 /* Set the foreground window to the child. */
1502 if (SetForegroundWindow (cp
->hwnd
))
1504 /* Generate keystrokes as if user had typed Ctrl-Break or
1506 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
1507 keybd_event (vk_break_code
, break_scan_code
,
1508 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
1509 keybd_event (vk_break_code
, break_scan_code
,
1510 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
1511 | KEYEVENTF_KEYUP
, 0);
1512 keybd_event (VK_CONTROL
, control_scan_code
,
1513 KEYEVENTF_KEYUP
, 0);
1515 /* Sleep for a bit to give time for Emacs frame to respond
1516 to focus change events (if Emacs was active app). */
1519 SetForegroundWindow (foreground_window
);
1521 /* Detach from the foreground and child threads now that
1522 the foreground switching is over. */
1523 if (foreground_thread
)
1524 AttachThreadInput (GetCurrentThreadId (),
1525 foreground_thread
, FALSE
);
1527 AttachThreadInput (GetCurrentThreadId (),
1528 child_thread
, FALSE
);
1531 /* Ctrl-Break is NT equivalent of SIGINT. */
1532 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
1534 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
1535 "for pid %lu\n", GetLastError (), pid
));
1542 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
1545 if (os_subtype
== OS_WIN95
)
1548 Another possibility is to try terminating the VDM out-right by
1549 calling the Shell VxD (id 0x17) V86 interface, function #4
1550 "SHELL_Destroy_VM", ie.
1556 First need to determine the current VM handle, and then arrange for
1557 the shellapi call to be made from the system vm (by using
1558 Switch_VM_and_callback).
1560 Could try to invoke DestroyVM through CallVxD.
1564 /* On Win95, posting WM_QUIT causes the 16-bit subsystem
1565 to hang when cmdproxy is used in conjunction with
1566 command.com for an interactive shell. Posting
1567 WM_CLOSE pops up a dialog that, when Yes is selected,
1568 does the same thing. TerminateProcess is also less
1569 than ideal in that subprocesses tend to stick around
1570 until the machine is shutdown, but at least it
1571 doesn't freeze the 16-bit subsystem. */
1572 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
1574 if (!TerminateProcess (proc_hand
, 0xff))
1576 DebPrint (("sys_kill.TerminateProcess returned %d "
1577 "for pid %lu\n", GetLastError (), pid
));
1584 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
1586 /* Kill the process. On W32 this doesn't kill child processes
1587 so it doesn't work very well for shells which is why it's not
1588 used in every case. */
1589 else if (!TerminateProcess (proc_hand
, 0xff))
1591 DebPrint (("sys_kill.TerminateProcess returned %d "
1592 "for pid %lu\n", GetLastError (), pid
));
1599 CloseHandle (proc_hand
);
1604 /* extern int report_file_error (char *, Lisp_Object); */
1606 /* The following two routines are used to manipulate stdin, stdout, and
1607 stderr of our child processes.
1609 Assuming that in, out, and err are *not* inheritable, we make them
1610 stdin, stdout, and stderr of the child as follows:
1612 - Save the parent's current standard handles.
1613 - Set the std handles to inheritable duplicates of the ones being passed in.
1614 (Note that _get_osfhandle() is an io.h procedure that retrieves the
1615 NT file handle for a crt file descriptor.)
1616 - Spawn the child, which inherits in, out, and err as stdin,
1617 stdout, and stderr. (see Spawnve)
1618 - Close the std handles passed to the child.
1619 - Reset the parent's standard handles to the saved handles.
1620 (see reset_standard_handles)
1621 We assume that the caller closes in, out, and err after calling us. */
1624 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
1627 HANDLE newstdin
, newstdout
, newstderr
;
1629 parent
= GetCurrentProcess ();
1631 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
1632 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
1633 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
1635 /* make inheritable copies of the new handles */
1636 if (!DuplicateHandle (parent
,
1637 (HANDLE
) _get_osfhandle (in
),
1642 DUPLICATE_SAME_ACCESS
))
1643 report_file_error ("Duplicating input handle for child", Qnil
);
1645 if (!DuplicateHandle (parent
,
1646 (HANDLE
) _get_osfhandle (out
),
1651 DUPLICATE_SAME_ACCESS
))
1652 report_file_error ("Duplicating output handle for child", Qnil
);
1654 if (!DuplicateHandle (parent
,
1655 (HANDLE
) _get_osfhandle (err
),
1660 DUPLICATE_SAME_ACCESS
))
1661 report_file_error ("Duplicating error handle for child", Qnil
);
1663 /* and store them as our std handles */
1664 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
1665 report_file_error ("Changing stdin handle", Qnil
);
1667 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
1668 report_file_error ("Changing stdout handle", Qnil
);
1670 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
1671 report_file_error ("Changing stderr handle", Qnil
);
1675 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
1677 /* close the duplicated handles passed to the child */
1678 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
1679 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
1680 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
1682 /* now restore parent's saved std handles */
1683 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
1684 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
1685 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
1689 set_process_dir (char * dir
)
1694 /* To avoid problems with winsock implementations that work over dial-up
1695 connections causing or requiring a connection to exist while Emacs is
1696 running, Emacs no longer automatically loads winsock on startup if it
1697 is present. Instead, it will be loaded when open-network-stream is
1700 To allow full control over when winsock is loaded, we provide these
1701 two functions to dynamically load and unload winsock. This allows
1702 dial-up users to only be connected when they actually need to use
1706 extern HANDLE winsock_lib
;
1707 extern BOOL
term_winsock (void);
1708 extern BOOL
init_winsock (int load_now
);
1710 extern Lisp_Object Vsystem_name
;
1712 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
1713 doc
: /* Test for presence of the Windows socket library `winsock'.
1714 Returns non-nil if winsock support is present, nil otherwise.
1716 If the optional argument LOAD-NOW is non-nil, the winsock library is
1717 also loaded immediately if not already loaded. If winsock is loaded,
1718 the winsock local hostname is returned (since this may be different from
1719 the value of `system-name' and should supplant it), otherwise t is
1720 returned to indicate winsock support is present. */)
1721 (Lisp_Object load_now
)
1725 have_winsock
= init_winsock (!NILP (load_now
));
1728 if (winsock_lib
!= NULL
)
1730 /* Return new value for system-name. The best way to do this
1731 is to call init_system_name, saving and restoring the
1732 original value to avoid side-effects. */
1733 Lisp_Object orig_hostname
= Vsystem_name
;
1734 Lisp_Object hostname
;
1736 init_system_name ();
1737 hostname
= Vsystem_name
;
1738 Vsystem_name
= orig_hostname
;
1746 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
1748 doc
: /* Unload the Windows socket library `winsock' if loaded.
1749 This is provided to allow dial-up socket connections to be disconnected
1750 when no longer needed. Returns nil without unloading winsock if any
1751 socket connections still exist. */)
1754 return term_winsock () ? Qt
: Qnil
;
1758 /* Some miscellaneous functions that are Windows specific, but not GUI
1759 specific (ie. are applicable in terminal or batch mode as well). */
1761 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
1762 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
1763 If FILENAME does not exist, return nil.
1764 All path elements in FILENAME are converted to their short names. */)
1765 (Lisp_Object filename
)
1767 char shortname
[MAX_PATH
];
1769 CHECK_STRING (filename
);
1771 /* first expand it. */
1772 filename
= Fexpand_file_name (filename
, Qnil
);
1774 /* luckily, this returns the short version of each element in the path. */
1775 if (GetShortPathName (SDATA (ENCODE_FILE (filename
)), shortname
, MAX_PATH
) == 0)
1778 dostounix_filename (shortname
);
1780 return build_string (shortname
);
1784 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
1786 doc
: /* Return the long file name version of the full path of FILENAME.
1787 If FILENAME does not exist, return nil.
1788 All path elements in FILENAME are converted to their long names. */)
1789 (Lisp_Object filename
)
1791 char longname
[ MAX_PATH
];
1794 CHECK_STRING (filename
);
1796 if (SBYTES (filename
) == 2
1797 && *(SDATA (filename
) + 1) == ':')
1800 /* first expand it. */
1801 filename
= Fexpand_file_name (filename
, Qnil
);
1803 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename
)), longname
, MAX_PATH
))
1806 dostounix_filename (longname
);
1808 /* If we were passed only a drive, make sure that a slash is not appended
1809 for consistency with directories. Allow for drive mapping via SUBST
1810 in case expand-file-name is ever changed to expand those. */
1811 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
1814 return DECODE_FILE (build_string (longname
));
1817 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
1818 Sw32_set_process_priority
, 2, 2, 0,
1819 doc
: /* Set the priority of PROCESS to PRIORITY.
1820 If PROCESS is nil, the priority of Emacs is changed, otherwise the
1821 priority of the process whose pid is PROCESS is changed.
1822 PRIORITY should be one of the symbols high, normal, or low;
1823 any other symbol will be interpreted as normal.
1825 If successful, the return value is t, otherwise nil. */)
1826 (Lisp_Object process
, Lisp_Object priority
)
1828 HANDLE proc_handle
= GetCurrentProcess ();
1829 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
1830 Lisp_Object result
= Qnil
;
1832 CHECK_SYMBOL (priority
);
1834 if (!NILP (process
))
1839 CHECK_NUMBER (process
);
1841 /* Allow pid to be an internally generated one, or one obtained
1842 externally. This is necessary because real pids on Win95 are
1845 pid
= XINT (process
);
1846 cp
= find_child_pid (pid
);
1848 pid
= cp
->procinfo
.dwProcessId
;
1850 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
1853 if (EQ (priority
, Qhigh
))
1854 priority_class
= HIGH_PRIORITY_CLASS
;
1855 else if (EQ (priority
, Qlow
))
1856 priority_class
= IDLE_PRIORITY_CLASS
;
1858 if (proc_handle
!= NULL
)
1860 if (SetPriorityClass (proc_handle
, priority_class
))
1862 if (!NILP (process
))
1863 CloseHandle (proc_handle
);
1869 #ifdef HAVE_LANGINFO_CODESET
1870 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
1872 nl_langinfo (nl_item item
)
1874 /* Conversion of Posix item numbers to their Windows equivalents. */
1875 static const LCTYPE w32item
[] = {
1876 LOCALE_IDEFAULTANSICODEPAGE
,
1877 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
1878 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
1879 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
1880 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
1881 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
1882 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
1885 static char *nl_langinfo_buf
= NULL
;
1886 static int nl_langinfo_len
= 0;
1888 if (nl_langinfo_len
<= 0)
1889 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
1891 if (item
< 0 || item
>= _NL_NUM
)
1892 nl_langinfo_buf
[0] = 0;
1895 LCID cloc
= GetThreadLocale ();
1896 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
1900 nl_langinfo_buf
[0] = 0;
1903 if (item
== CODESET
)
1905 need_len
+= 2; /* for the "cp" prefix */
1906 if (need_len
< 8) /* for the case we call GetACP */
1909 if (nl_langinfo_len
<= need_len
)
1910 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
1911 nl_langinfo_len
= need_len
);
1912 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
1913 nl_langinfo_buf
, nl_langinfo_len
))
1914 nl_langinfo_buf
[0] = 0;
1915 else if (item
== CODESET
)
1917 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
1918 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
1919 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
1922 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
1923 strlen (nl_langinfo_buf
) + 1);
1924 nl_langinfo_buf
[0] = 'c';
1925 nl_langinfo_buf
[1] = 'p';
1930 return nl_langinfo_buf
;
1932 #endif /* HAVE_LANGINFO_CODESET */
1934 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
1935 Sw32_get_locale_info
, 1, 2, 0,
1936 doc
: /* Return information about the Windows locale LCID.
1937 By default, return a three letter locale code which encodes the default
1938 language as the first two characters, and the country or regional variant
1939 as the third letter. For example, ENU refers to `English (United States)',
1940 while ENC means `English (Canadian)'.
1942 If the optional argument LONGFORM is t, the long form of the locale
1943 name is returned, e.g. `English (United States)' instead; if LONGFORM
1944 is a number, it is interpreted as an LCTYPE constant and the corresponding
1945 locale information is returned.
1947 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
1948 (Lisp_Object lcid
, Lisp_Object longform
)
1952 char abbrev_name
[32] = { 0 };
1953 char full_name
[256] = { 0 };
1955 CHECK_NUMBER (lcid
);
1957 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
1960 if (NILP (longform
))
1962 got_abbrev
= GetLocaleInfo (XINT (lcid
),
1963 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
1964 abbrev_name
, sizeof (abbrev_name
));
1966 return build_string (abbrev_name
);
1968 else if (EQ (longform
, Qt
))
1970 got_full
= GetLocaleInfo (XINT (lcid
),
1971 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
1972 full_name
, sizeof (full_name
));
1974 return DECODE_SYSTEM (build_string (full_name
));
1976 else if (NUMBERP (longform
))
1978 got_full
= GetLocaleInfo (XINT (lcid
),
1980 full_name
, sizeof (full_name
));
1982 return make_unibyte_string (full_name
, got_full
);
1989 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
1990 Sw32_get_current_locale_id
, 0, 0, 0,
1991 doc
: /* Return Windows locale id for current locale setting.
1992 This is a numerical value; use `w32-get-locale-info' to convert to a
1993 human-readable form. */)
1996 return make_number (GetThreadLocale ());
2000 int_from_hex (char * s
)
2003 static char hex
[] = "0123456789abcdefABCDEF";
2006 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
2008 unsigned digit
= p
- hex
;
2011 val
= val
* 16 + digit
;
2017 /* We need to build a global list, since the EnumSystemLocale callback
2018 function isn't given a context pointer. */
2019 Lisp_Object Vw32_valid_locale_ids
;
2021 static BOOL CALLBACK
2022 enum_locale_fn (LPTSTR localeNum
)
2024 DWORD id
= int_from_hex (localeNum
);
2025 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
2029 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
2030 Sw32_get_valid_locale_ids
, 0, 0, 0,
2031 doc
: /* Return list of all valid Windows locale ids.
2032 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2033 human-readable form. */)
2036 Vw32_valid_locale_ids
= Qnil
;
2038 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
2040 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
2041 return Vw32_valid_locale_ids
;
2045 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
2046 doc
: /* Return Windows locale id for default locale setting.
2047 By default, the system default locale setting is returned; if the optional
2048 parameter USERP is non-nil, the user default locale setting is returned.
2049 This is a numerical value; use `w32-get-locale-info' to convert to a
2050 human-readable form. */)
2054 return make_number (GetSystemDefaultLCID ());
2055 return make_number (GetUserDefaultLCID ());
2059 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
2060 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
2061 If successful, the new locale id is returned, otherwise nil. */)
2064 CHECK_NUMBER (lcid
);
2066 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2069 if (!SetThreadLocale (XINT (lcid
)))
2072 /* Need to set input thread locale if present. */
2073 if (dwWindowsThreadId
)
2074 /* Reply is not needed. */
2075 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
2077 return make_number (GetThreadLocale ());
2081 /* We need to build a global list, since the EnumCodePages callback
2082 function isn't given a context pointer. */
2083 Lisp_Object Vw32_valid_codepages
;
2085 static BOOL CALLBACK
2086 enum_codepage_fn (LPTSTR codepageNum
)
2088 DWORD id
= atoi (codepageNum
);
2089 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
2093 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
2094 Sw32_get_valid_codepages
, 0, 0, 0,
2095 doc
: /* Return list of all valid Windows codepages. */)
2098 Vw32_valid_codepages
= Qnil
;
2100 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
2102 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
2103 return Vw32_valid_codepages
;
2107 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
2108 Sw32_get_console_codepage
, 0, 0, 0,
2109 doc
: /* Return current Windows codepage for console input. */)
2112 return make_number (GetConsoleCP ());
2116 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
2117 Sw32_set_console_codepage
, 1, 1, 0,
2118 doc
: /* Make Windows codepage CP be the current codepage setting for Emacs.
2119 The codepage setting affects keyboard input and display in tty mode.
2120 If successful, the new CP is returned, otherwise nil. */)
2125 if (!IsValidCodePage (XINT (cp
)))
2128 if (!SetConsoleCP (XINT (cp
)))
2131 return make_number (GetConsoleCP ());
2135 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
2136 Sw32_get_console_output_codepage
, 0, 0, 0,
2137 doc
: /* Return current Windows codepage for console output. */)
2140 return make_number (GetConsoleOutputCP ());
2144 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
2145 Sw32_set_console_output_codepage
, 1, 1, 0,
2146 doc
: /* Make Windows codepage CP be the current codepage setting for Emacs.
2147 The codepage setting affects keyboard input and display in tty mode.
2148 If successful, the new CP is returned, otherwise nil. */)
2153 if (!IsValidCodePage (XINT (cp
)))
2156 if (!SetConsoleOutputCP (XINT (cp
)))
2159 return make_number (GetConsoleOutputCP ());
2163 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
2164 Sw32_get_codepage_charset
, 1, 1, 0,
2165 doc
: /* Return charset of codepage CP.
2166 Returns nil if the codepage is not valid. */)
2173 if (!IsValidCodePage (XINT (cp
)))
2176 if (TranslateCharsetInfo ((DWORD
*) XINT (cp
), &info
, TCI_SRCCODEPAGE
))
2177 return make_number (info
.ciCharset
);
2183 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
2184 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
2185 doc
: /* Return list of Windows keyboard languages and layouts.
2186 The return value is a list of pairs of language id and layout id. */)
2189 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
2190 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
2191 Lisp_Object obj
= Qnil
;
2193 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
2195 while (--num_layouts
>= 0)
2197 DWORD kl
= (DWORD
) layouts
[num_layouts
];
2199 obj
= Fcons (Fcons (make_number (kl
& 0xffff),
2200 make_number ((kl
>> 16) & 0xffff)),
2209 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
2210 Sw32_get_keyboard_layout
, 0, 0, 0,
2211 doc
: /* Return current Windows keyboard language and layout.
2212 The return value is the cons of the language id and the layout id. */)
2215 DWORD kl
= (DWORD
) GetKeyboardLayout (dwWindowsThreadId
);
2217 return Fcons (make_number (kl
& 0xffff),
2218 make_number ((kl
>> 16) & 0xffff));
2222 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
2223 Sw32_set_keyboard_layout
, 1, 1, 0,
2224 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
2225 The keyboard layout setting affects interpretation of keyboard input.
2226 If successful, the new layout id is returned, otherwise nil. */)
2227 (Lisp_Object layout
)
2231 CHECK_CONS (layout
);
2232 CHECK_NUMBER_CAR (layout
);
2233 CHECK_NUMBER_CDR (layout
);
2235 kl
= (XINT (XCAR (layout
)) & 0xffff)
2236 | (XINT (XCDR (layout
)) << 16);
2238 /* Synchronize layout with input thread. */
2239 if (dwWindowsThreadId
)
2241 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
2245 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
2247 if (msg
.wParam
== 0)
2251 else if (!ActivateKeyboardLayout ((HKL
) kl
, 0))
2254 return Fw32_get_keyboard_layout ();
2259 syms_of_ntproc (void)
2261 DEFSYM (Qhigh
, "high");
2262 DEFSYM (Qlow
, "low");
2264 defsubr (&Sw32_has_winsock
);
2265 defsubr (&Sw32_unload_winsock
);
2267 defsubr (&Sw32_short_file_name
);
2268 defsubr (&Sw32_long_file_name
);
2269 defsubr (&Sw32_set_process_priority
);
2270 defsubr (&Sw32_get_locale_info
);
2271 defsubr (&Sw32_get_current_locale_id
);
2272 defsubr (&Sw32_get_default_locale_id
);
2273 defsubr (&Sw32_get_valid_locale_ids
);
2274 defsubr (&Sw32_set_current_locale
);
2276 defsubr (&Sw32_get_console_codepage
);
2277 defsubr (&Sw32_set_console_codepage
);
2278 defsubr (&Sw32_get_console_output_codepage
);
2279 defsubr (&Sw32_set_console_output_codepage
);
2280 defsubr (&Sw32_get_valid_codepages
);
2281 defsubr (&Sw32_get_codepage_charset
);
2283 defsubr (&Sw32_get_valid_keyboard_layouts
);
2284 defsubr (&Sw32_get_keyboard_layout
);
2285 defsubr (&Sw32_set_keyboard_layout
);
2287 DEFVAR_LISP ("w32-quote-process-args", &Vw32_quote_process_args
,
2288 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
2289 Because Windows does not directly pass argv arrays to child processes,
2290 programs have to reconstruct the argv array by parsing the command
2291 line string. For an argument to contain a space, it must be enclosed
2292 in double quotes or it will be parsed as multiple arguments.
2294 If the value is a character, that character will be used to escape any
2295 quote characters that appear, otherwise a suitable escape character
2296 will be chosen based on the type of the program. */);
2297 Vw32_quote_process_args
= Qt
;
2299 DEFVAR_LISP ("w32-start-process-show-window",
2300 &Vw32_start_process_show_window
,
2301 doc
: /* When nil, new child processes hide their windows.
2302 When non-nil, they show their window in the method of their choice.
2303 This variable doesn't affect GUI applications, which will never be hidden. */);
2304 Vw32_start_process_show_window
= Qnil
;
2306 DEFVAR_LISP ("w32-start-process-share-console",
2307 &Vw32_start_process_share_console
,
2308 doc
: /* When nil, new child processes are given a new console.
2309 When non-nil, they share the Emacs console; this has the limitation of
2310 allowing only one DOS subprocess to run at a time (whether started directly
2311 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
2312 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
2313 otherwise respond to interrupts from Emacs. */);
2314 Vw32_start_process_share_console
= Qnil
;
2316 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
2317 &Vw32_start_process_inherit_error_mode
,
2318 doc
: /* When nil, new child processes revert to the default error mode.
2319 When non-nil, they inherit their error mode setting from Emacs, which stops
2320 them blocking when trying to access unmounted drives etc. */);
2321 Vw32_start_process_inherit_error_mode
= Qt
;
2323 DEFVAR_INT ("w32-pipe-read-delay", &w32_pipe_read_delay
,
2324 doc
: /* Forced delay before reading subprocess output.
2325 This is done to improve the buffering of subprocess output, by
2326 avoiding the inefficiency of frequently reading small amounts of data.
2328 If positive, the value is the number of milliseconds to sleep before
2329 reading the subprocess output. If negative, the magnitude is the number
2330 of time slices to wait (effectively boosting the priority of the child
2331 process temporarily). A value of zero disables waiting entirely. */);
2332 w32_pipe_read_delay
= 50;
2334 DEFVAR_LISP ("w32-downcase-file-names", &Vw32_downcase_file_names
,
2335 doc
: /* Non-nil means convert all-upper case file names to lower case.
2336 This applies when performing completions and file name expansion.
2337 Note that the value of this setting also affects remote file names,
2338 so you probably don't want to set to non-nil if you use case-sensitive
2339 filesystems via ange-ftp. */);
2340 Vw32_downcase_file_names
= Qnil
;
2343 DEFVAR_LISP ("w32-generate-fake-inodes", &Vw32_generate_fake_inodes
,
2344 doc
: /* Non-nil means attempt to fake realistic inode values.
2345 This works by hashing the truename of files, and should detect
2346 aliasing between long and short (8.3 DOS) names, but can have
2347 false positives because of hash collisions. Note that determing
2348 the truename of a file can be slow. */);
2349 Vw32_generate_fake_inodes
= Qnil
;
2352 DEFVAR_LISP ("w32-get-true-file-attributes", &Vw32_get_true_file_attributes
,
2353 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
2354 This option controls whether to issue additional system calls to determine
2355 accurate link counts, file type, and ownership information. It is more
2356 useful for files on NTFS volumes, where hard links and file security are
2357 supported, than on volumes of the FAT family.
2359 Without these system calls, link count will always be reported as 1 and file
2360 ownership will be attributed to the current user.
2361 The default value `local' means only issue these system calls for files
2362 on local fixed drives. A value of nil means never issue them.
2363 Any other non-nil value means do this even on remote and removable drives
2364 where the performance impact may be noticeable even on modern hardware. */);
2365 Vw32_get_true_file_attributes
= Qlocal
;
2367 staticpro (&Vw32_valid_locale_ids
);
2368 staticpro (&Vw32_valid_codepages
);
2370 /* end of w32proc.c */