Mercurial > vim
view src/os_mac_conv.c @ 34394:a400c8f9506f v9.1.0123
patch 9.1.0123: MS-Windows: system() may deadlock
Commit: https://github.com/vim/vim/commit/52ecc76c7fa1865603f27bc838efaeaa03cad77c
Author: GuyBrush <miguel.barro@live.com>
Date: Wed Feb 21 20:16:38 2024 +0100
patch 9.1.0123: MS-Windows: system() may deadlock
Problem: MS-Windows: system() may deadlock when calling binaries that
expect stdin
Solution: Ignore the SHELL_EXPAND flag
(GuyBrush)
This happens on binaries that expect stdin. For example:
:echo system("xxd")
will cause a deadlock.
SHELL_EXPAND is a flag devoted to support the linux implementation of
the backtick-expansion mechanism.
On linux backtic-expansion relies in the function mch_expand_wildchars()
(os_unix.c) that delegates on each specific shell (bash, sh, csh, zsh)
the expansion. Basically it composes a shell command that does the
expansion and redirects the output to a file and call_shell() it. On
windows backtick-expansion is performed by Vim itself.
On linux SHELL_EXPAND modifies how mch_call_shell_fork() (os_unix.c)
works. This function:
- relies on posix fork() to spawn a child process to execute a
external command.
- Child and parent process communicate using pipes (or pseudoterminal
if available).
User input (type ahead content) is processed in a loop only if
!(SHELL_EXPAND || SHELL_COOKED).
Though signals are used to detect Ctrl-C in all cases (the input
loop is not necessary to interrupt the function).
In the backtick-expansion the external command is the shell command
that provides the expansion. For the child redirection:
- SHELL_EXPAND replaces stdin, stdout & stderr to /dev/null. This is
why the shell command composed includes redirection (otherwise
output would be lost).
- !SHELL_EXPAND replaces stdin, stdout & stderr with the parent
created pipes (or pseudoterminal).
Note that the use of SIGINT signal prevents mch_call_shell_fork()
from hanging vim.
On Windows mch_system_piped() (os_win32.c) (which is only used when the
GUI is running) mimics mch_call_shell_fork() (os_unix.c).
Win32 lacks fork() and relies on CreateProcessW() and only has pipe
support (not pseudoterminal) which makes the implementation much
different.
But, the key idea is that windows lacks signals, the OS provides support
for console apps but gvim is not one. The only way of detecting a Ctrl-C
is actually processing user input (type ahead content). By ignoring the
user input under SHELL_EXPAND the function can hang gvim.
Ignoring SHELL_EXPAND flag has no consequence in Windows because as
mentioned above it is only meaningful in linux.
closes: #13988
Signed-off-by: GuyBrush <miguel.barro@live.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Wed, 21 Feb 2024 20:30:02 +0100 |
parents | 50555279168b |
children |
line wrap: on
line source
/* vi:set ts=8 sts=4 sw=4 noet: * * VIM - Vi IMproved by Bram Moolenaar * * Do ":help uganda" in Vim to read copying and usage conditions. * Do ":help credits" in Vim to see a list of people who contributed. * See README.txt for an overview of the Vim source code. */ /* * os_mac_conv.c: Code specifically for Mac string conversions. * * This code has been put in a separate file to avoid the conflicts that are * caused by including both the X11 and Carbon header files. */ #define NO_X11_INCLUDES #include "vim.h" #if !defined(PROTO) # include <CoreServices/CoreServices.h> #endif #if defined(MACOS_CONVERT) || defined(PROTO) # ifdef PROTO // A few dummy types to be able to generate function prototypes. typedef int UniChar; typedef int *TECObjectRef; typedef int CFStringRef; # endif static char_u *mac_utf16_to_utf8(UniChar *from, size_t fromLen, size_t *actualLen); static UniChar *mac_utf8_to_utf16(char_u *from, size_t fromLen, size_t *actualLen); // Converter for composing decomposed HFS+ file paths static TECObjectRef gPathConverter; // Converter used by mac_utf16_to_utf8 static TECObjectRef gUTF16ToUTF8Converter; /* * A Mac version of string_convert_ext() for special cases. */ char_u * mac_string_convert( char_u *ptr, int len, int *lenp, int fail_on_error, int from_enc, int to_enc, int *unconvlenp) { char_u *retval, *d; CFStringRef cfstr; int buflen, in, out, l, i; CFStringEncoding from; CFStringEncoding to; switch (from_enc) { case 'l': from = kCFStringEncodingISOLatin1; break; case 'm': from = kCFStringEncodingMacRoman; break; case 'u': from = kCFStringEncodingUTF8; break; default: return NULL; } switch (to_enc) { case 'l': to = kCFStringEncodingISOLatin1; break; case 'm': to = kCFStringEncodingMacRoman; break; case 'u': to = kCFStringEncodingUTF8; break; default: return NULL; } if (unconvlenp != NULL) *unconvlenp = 0; cfstr = CFStringCreateWithBytes(NULL, ptr, len, from, 0); if (cfstr == NULL) fprintf(stderr, "Encoding failed\n"); // When conversion failed, try excluding bytes from the end, helps when // there is an incomplete byte sequence. Only do up to 6 bytes to avoid // looping a long time when there really is something unconvertible. while (cfstr == NULL && unconvlenp != NULL && len > 1 && *unconvlenp < 6) { --len; ++*unconvlenp; cfstr = CFStringCreateWithBytes(NULL, ptr, len, from, 0); } if (cfstr == NULL) return NULL; if (to == kCFStringEncodingUTF8) buflen = len * 6 + 1; else buflen = len + 1; retval = alloc(buflen); if (retval == NULL) { CFRelease(cfstr); return NULL; } #if 0 CFRange convertRange = CFRangeMake(0, CFStringGetLength(cfstr)); // Determine output buffer size CFStringGetBytes(cfstr, convertRange, to, NULL, FALSE, NULL, 0, (CFIndex *)&buflen); retval = (buflen > 0) ? alloc(buflen) : NULL; if (retval == NULL) { CFRelease(cfstr); return NULL; } if (lenp) *lenp = buflen / sizeof(char_u); if (!CFStringGetBytes(cfstr, convertRange, to, NULL, FALSE, retval, buflen, NULL)) #endif if (!CFStringGetCString(cfstr, (char *)retval, buflen, to)) { CFRelease(cfstr); if (fail_on_error) { vim_free(retval); return NULL; } fprintf(stderr, "Trying char-by-char conversion...\n"); // conversion failed for the whole string, but maybe it will work // for each character for (d = retval, in = 0, out = 0; in < len && out < buflen - 1;) { if (from == kCFStringEncodingUTF8) l = utf_ptr2len(ptr + in); else l = 1; cfstr = CFStringCreateWithBytes(NULL, ptr + in, l, from, 0); if (cfstr == NULL) { *d++ = '?'; out++; } else { if (!CFStringGetCString(cfstr, (char *)d, buflen - out, to)) { *d++ = '?'; out++; } else { i = STRLEN(d); d += i; out += i; } CFRelease(cfstr); } in += l; } *d = NUL; if (lenp != NULL) *lenp = out; return retval; } CFRelease(cfstr); if (lenp != NULL) *lenp = STRLEN(retval); return retval; } /* * Conversion from Apple MacRoman char encoding to UTF-8 or latin1, using * standard Carbon framework. * Input: "ptr[*sizep]". * "real_size" is the size of the buffer that "ptr" points to. * output is in-place, "sizep" is adjusted. * Returns OK or FAIL. */ int macroman2enc( char_u *ptr, long *sizep, long real_size) { CFStringRef cfstr; CFRange r; CFIndex len = *sizep; // MacRoman is an 8-bit encoding, no need to move bytes to // conv_rest[]. cfstr = CFStringCreateWithBytes(NULL, ptr, len, kCFStringEncodingMacRoman, 0); /* * If there is a conversion error, try using another * conversion. */ if (cfstr == NULL) return FAIL; r.location = 0; r.length = CFStringGetLength(cfstr); if (r.length != CFStringGetBytes(cfstr, r, (enc_utf8) ? kCFStringEncodingUTF8 : kCFStringEncodingISOLatin1, 0, // no lossy conversion 0, // not external representation ptr + *sizep, real_size - *sizep, &len)) { CFRelease(cfstr); return FAIL; } CFRelease(cfstr); mch_memmove(ptr, ptr + *sizep, len); *sizep = len; return OK; } /* * Conversion from UTF-8 or latin1 to MacRoman. * Input: "from[fromlen]" * Output: "to[maxtolen]" length in "*tolenp" * Unconverted rest in rest[*restlenp]. * Returns OK or FAIL. */ int enc2macroman( char_u *from, size_t fromlen, char_u *to, int *tolenp, int maxtolen, char_u *rest, int *restlenp) { CFStringRef cfstr; CFRange r; CFIndex l; *restlenp = 0; cfstr = CFStringCreateWithBytes(NULL, from, fromlen, (enc_utf8) ? kCFStringEncodingUTF8 : kCFStringEncodingISOLatin1, 0); while (cfstr == NULL && *restlenp < 3 && fromlen > 1) { rest[*restlenp++] = from[--fromlen]; cfstr = CFStringCreateWithBytes(NULL, from, fromlen, (enc_utf8) ? kCFStringEncodingUTF8 : kCFStringEncodingISOLatin1, 0); } if (cfstr == NULL) return FAIL; r.location = 0; r.length = CFStringGetLength(cfstr); if (r.length != CFStringGetBytes(cfstr, r, kCFStringEncodingMacRoman, 0, // no lossy conversion 0, // not external representation (since vim // handles this internally) to, maxtolen, &l)) { CFRelease(cfstr); return FAIL; } CFRelease(cfstr); *tolenp = l; return OK; } /* * Initializes text converters */ void mac_conv_init(void) { TextEncoding utf8_encoding; TextEncoding utf8_hfsplus_encoding; TextEncoding utf8_canon_encoding; TextEncoding utf16_encoding; utf8_encoding = CreateTextEncoding(kTextEncodingUnicodeDefault, kTextEncodingDefaultVariant, kUnicodeUTF8Format); utf8_hfsplus_encoding = CreateTextEncoding(kTextEncodingUnicodeDefault, kUnicodeHFSPlusCompVariant, kUnicodeUTF8Format); utf8_canon_encoding = CreateTextEncoding(kTextEncodingUnicodeDefault, kUnicodeCanonicalCompVariant, kUnicodeUTF8Format); utf16_encoding = CreateTextEncoding(kTextEncodingUnicodeDefault, kTextEncodingDefaultVariant, kUnicode16BitFormat); if (TECCreateConverter(&gPathConverter, utf8_encoding, utf8_hfsplus_encoding) != noErr) gPathConverter = NULL; if (TECCreateConverter(&gUTF16ToUTF8Converter, utf16_encoding, utf8_canon_encoding) != noErr) { // On pre-10.3, Unicode normalization is not available so // fall back to non-normalizing converter if (TECCreateConverter(&gUTF16ToUTF8Converter, utf16_encoding, utf8_encoding) != noErr) gUTF16ToUTF8Converter = NULL; } } /* * Destroys text converters */ void mac_conv_cleanup(void) { if (gUTF16ToUTF8Converter) { TECDisposeConverter(gUTF16ToUTF8Converter); gUTF16ToUTF8Converter = NULL; } if (gPathConverter) { TECDisposeConverter(gPathConverter); gPathConverter = NULL; } } /* * Conversion from UTF-16 UniChars to 'encoding' * The function signature uses the real type of UniChar (as typedef'ed in * CFBase.h) to avoid clashes with X11 header files in the .pro file */ char_u * mac_utf16_to_enc( unsigned short *from, size_t fromLen, size_t *actualLen) { // Following code borrows somewhat from os_mswin.c vimconv_T conv; size_t utf8_len; char_u *utf8_str; char_u *result = NULL; // Convert to utf-8 first, works better with iconv utf8_len = 0; utf8_str = mac_utf16_to_utf8(from, fromLen, &utf8_len); if (utf8_str) { // We might be called before we have p_enc set up. conv.vc_type = CONV_NONE; // If encoding (p_enc) is any unicode, it is actually in utf-8 (vim // internal unicode is always utf-8) so don't convert in such cases if ((enc_canon_props(p_enc) & ENC_UNICODE) == 0) convert_setup(&conv, (char_u *)"utf-8", p_enc? p_enc: (char_u *)"macroman"); if (conv.vc_type == CONV_NONE) { // p_enc is utf-8, so we're done. result = utf8_str; } else { result = string_convert(&conv, utf8_str, (int *)&utf8_len); vim_free(utf8_str); } convert_setup(&conv, NULL, NULL); if (actualLen) *actualLen = utf8_len; } else if (actualLen) *actualLen = 0; return result; } /* * Conversion from 'encoding' to UTF-16 UniChars * The function return uses the real type of UniChar (as typedef'ed in * CFBase.h) to avoid clashes with X11 header files in the .pro file */ unsigned short * mac_enc_to_utf16( char_u *from, size_t fromLen, size_t *actualLen) { // Following code borrows somewhat from os_mswin.c vimconv_T conv; size_t utf8_len; char_u *utf8_str; UniChar *result = NULL; Boolean should_free_utf8 = FALSE; do { // Use MacRoman by default, we might be called before we have p_enc // set up. Convert to utf-8 first, works better with iconv(). Does // nothing if 'encoding' is "utf-8". conv.vc_type = CONV_NONE; if ((enc_canon_props(p_enc) & ENC_UNICODE) == 0 && convert_setup(&conv, p_enc ? p_enc : (char_u *)"macroman", (char_u *)"utf-8") == FAIL) break; if (conv.vc_type != CONV_NONE) { utf8_len = fromLen; utf8_str = string_convert(&conv, from, (int *)&utf8_len); should_free_utf8 = TRUE; } else { utf8_str = from; utf8_len = fromLen; } if (utf8_str == NULL) break; convert_setup(&conv, NULL, NULL); result = mac_utf8_to_utf16(utf8_str, utf8_len, actualLen); if (should_free_utf8) vim_free(utf8_str); return result; } while (0); if (actualLen) *actualLen = 0; return result; } /* * Converts from UTF-16 UniChars to CFString * The void * return type is actually a CFStringRef */ void * mac_enc_to_cfstring( char_u *from, size_t fromLen) { UniChar *utf16_str; size_t utf16_len; CFStringRef result = NULL; utf16_str = mac_enc_to_utf16(from, fromLen, &utf16_len); if (utf16_str) { result = CFStringCreateWithCharacters(NULL, utf16_str, utf16_len/sizeof(UniChar)); vim_free(utf16_str); } return (void *)result; } /* * Converts a decomposed HFS+ UTF-8 path to precomposed UTF-8 */ char_u * mac_precompose_path( char_u *decompPath, size_t decompLen, size_t *precompLen) { char_u *result = NULL; size_t actualLen = 0; if (gPathConverter) { result = alloc(decompLen); if (result) { if (TECConvertText(gPathConverter, decompPath, decompLen, &decompLen, result, decompLen, &actualLen) != noErr) VIM_CLEAR(result); } } if (precompLen) *precompLen = actualLen; return result; } /* * Converts from UTF-16 UniChars to precomposed UTF-8 */ static char_u * mac_utf16_to_utf8( UniChar *from, size_t fromLen, size_t *actualLen) { ByteCount utf8_len; ByteCount inputRead; char_u *result; if (gUTF16ToUTF8Converter) { result = alloc(fromLen * 6 + 1); if (result && TECConvertText(gUTF16ToUTF8Converter, (ConstTextPtr)from, fromLen, &inputRead, result, (fromLen*6+1)*sizeof(char_u), &utf8_len) == noErr) { TECFlushText(gUTF16ToUTF8Converter, result, (fromLen*6+1)*sizeof(char_u), &inputRead); utf8_len += inputRead; } else VIM_CLEAR(result); } else { result = NULL; } if (actualLen) *actualLen = result ? utf8_len : 0; return result; } /* * Converts from UTF-8 to UTF-16 UniChars */ static UniChar * mac_utf8_to_utf16( char_u *from, size_t fromLen, size_t *actualLen) { CFStringRef utf8_str; CFRange convertRange; UniChar *result = NULL; utf8_str = CFStringCreateWithBytes(NULL, from, fromLen, kCFStringEncodingUTF8, FALSE); if (utf8_str == NULL) { if (actualLen) *actualLen = 0; return NULL; } convertRange = CFRangeMake(0, CFStringGetLength(utf8_str)); result = ALLOC_MULT(UniChar, convertRange.length); CFStringGetCharacters(utf8_str, convertRange, result); CFRelease(utf8_str); if (actualLen) *actualLen = convertRange.length * sizeof(UniChar); return result; } /* * Sets LANG environment variable in Vim from Mac locale */ void mac_lang_init(void) { if (mch_getenv((char_u *)"LANG") != NULL) return; char buf[50]; // $LANG is not set, either because it was unset or Vim was started // from the Dock. Query the system locale. if (LocaleRefGetPartString(NULL, kLocaleLanguageMask | kLocaleLanguageVariantMask | kLocaleRegionMask | kLocaleRegionVariantMask, sizeof(buf) - 10, buf) == noErr && *buf) { if (strcasestr(buf, "utf-8") == NULL) strcat(buf, ".UTF-8"); vim_setenv((char_u *)"LANG", (char_u *)buf); # ifdef HAVE_LOCALE_H setlocale(LC_ALL, ""); # endif # if defined(LC_NUMERIC) // Make sure strtod() uses a decimal point, not a comma. setlocale(LC_NUMERIC, "C"); # endif } } #endif // MACOS_CONVERT