// © 2016 and later: Unicode, Inc. and others. // License & terms of use: http://www.unicode.org/copyright.html /* ******************************************************************************* * * Copyright (C) 1999-2010, International Business Machines * Corporation and others. All Rights Reserved. * ******************************************************************************* * file name: uinvchar.c * encoding: UTF-8 * tab size: 8 (not used) * indentation:2 * * created on: 2004sep14 * created by: Markus W. Scherer * * Functions for handling invariant characters, moved here from putil.c * for better modularization. */ #include "unicode/utypes.h" #include "unicode/ustring.h" #include "udataswp.h" #include "cstring.h" #include "cmemory.h" #include "uassert.h" #include "uinvchar.h" /* invariant-character handling --------------------------------------------- */ /* * These maps for ASCII to/from EBCDIC map invariant characters (see utypes.h) * appropriately for most EBCDIC codepages. * * They currently also map most other ASCII graphic characters, * appropriately for codepages 37 and 1047. * Exceptions: The characters for []^ have different codes in 37 & 1047. * Both versions are mapped to ASCII. * * ASCII 37 1047 * [ 5B BA AD * ] 5D BB BD * ^ 5E B0 5F * * There are no mappings for variant characters from Unicode to EBCDIC. * * Currently, C0 control codes are also included in these maps. * Exceptions: S/390 Open Edition swaps LF and NEL codes compared with other * EBCDIC platforms; both codes (15 and 25) are mapped to ASCII LF (0A), * but there is no mapping for ASCII LF back to EBCDIC. * * ASCII EBCDIC S/390-OE * LF 0A 25 15 * NEL 85 15 25 * * The maps below explicitly exclude the variant * control and graphical characters that are in ASCII-based * codepages at 0x80 and above. * "No mapping" is expressed by mapping to a 00 byte. * * These tables do not establish a converter or a codepage. */ static const uint8_t asciiFromEbcdic[256]={ 0x00, 0x01, 0x02, 0x03, 0x00, 0x09, 0x00, 0x7f, 0x00, 0x00, 0x00, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x00, 0x0a, 0x08, 0x00, 0x18, 0x19, 0x00, 0x00, 0x1c, 0x1d, 0x1e, 0x1f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0a, 0x17, 0x1b, 0x00, 0x00, 0x00, 0x00, 0x00, 0x05, 0x06, 0x07, 0x00, 0x00, 0x16, 0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x14, 0x15, 0x00, 0x1a, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x2e, 0x3c, 0x28, 0x2b, 0x7c, 0x26, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x21, 0x24, 0x2a, 0x29, 0x3b, 0x5e, 0x2d, 0x2f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x2c, 0x25, 0x5f, 0x3e, 0x3f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x60, 0x3a, 0x23, 0x40, 0x27, 0x3d, 0x22, 0x00, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7e, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x00, 0x00, 0x00, 0x5b, 0x00, 0x00, 0x5e, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x5b, 0x5d, 0x00, 0x5d, 0x00, 0x00, 0x7b, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7d, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51, 0x52, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x5c, 0x00, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; static const uint8_t ebcdicFromAscii[256]={ 0x00, 0x01, 0x02, 0x03, 0x37, 0x2d, 0x2e, 0x2f, 0x16, 0x05, 0x00, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x3c, 0x3d, 0x32, 0x26, 0x18, 0x19, 0x3f, 0x27, 0x1c, 0x1d, 0x1e, 0x1f, 0x40, 0x00, 0x7f, 0x00, 0x00, 0x6c, 0x50, 0x7d, 0x4d, 0x5d, 0x5c, 0x4e, 0x6b, 0x60, 0x4b, 0x61, 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, 0x7a, 0x5e, 0x4c, 0x7e, 0x6e, 0x6f, 0x00, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8, 0xd9, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, 0xe8, 0xe9, 0x00, 0x00, 0x00, 0x00, 0x6d, 0x00, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xa8, 0xa9, 0x00, 0x00, 0x00, 0x00, 0x07, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }; /* Same as asciiFromEbcdic[] except maps all letters to lowercase. */ static const uint8_t lowercaseAsciiFromEbcdic[256]={ 0x00, 0x01, 0x02, 0x03, 0x00, 0x09, 0x00, 0x7f, 0x00, 0x00, 0x00, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x00, 0x0a, 0x08, 0x00, 0x18, 0x19, 0x00, 0x00, 0x1c, 0x1d, 0x1e, 0x1f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0a, 0x17, 0x1b, 0x00, 0x00, 0x00, 0x00, 0x00, 0x05, 0x06, 0x07, 0x00, 0x00, 0x16, 0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x14, 0x15, 0x00, 0x1a, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x2e, 0x3c, 0x28, 0x2b, 0x7c, 0x26, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x21, 0x24, 0x2a, 0x29, 0x3b, 0x5e, 0x2d, 0x2f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x2c, 0x25, 0x5f, 0x3e, 0x3f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x60, 0x3a, 0x23, 0x40, 0x27, 0x3d, 0x22, 0x00, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7e, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x00, 0x00, 0x00, 0x5b, 0x00, 0x00, 0x5e, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x5b, 0x5d, 0x00, 0x5d, 0x00, 0x00, 0x7b, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7d, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7c, 0x00, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; /* * Bit sets indicating which characters of the ASCII repertoire * (by ASCII/Unicode code) are "invariant". * See utypes.h for more details. * * As invariant are considered the characters of the ASCII repertoire except * for the following: * 21 '!' * 23 '#' * 24 '$' * * 40 '@' * * 5b '[' * 5c '\' * 5d ']' * 5e '^' * * 60 '`' * * 7b '{' * 7c '|' * 7d '}' * 7e '~' */ static const uint32_t invariantChars[4]={ 0xfffffbff, /* 00..1f but not 0a */ 0xffffffe5, /* 20..3f but not 21 23 24 */ 0x87fffffe, /* 40..5f but not 40 5b..5e */ 0x87fffffe /* 60..7f but not 60 7b..7e */ }; /* * test unsigned types (or values known to be non-negative) for invariant characters, * tests ASCII-family character values */ #define UCHAR_IS_INVARIANT(c) (((c)<=0x7f) && (invariantChars[(c)>>5]&((uint32_t)1<<((c)&0x1f)))!=0) /* test signed types for invariant characters, adds test for positive values */ #define SCHAR_IS_INVARIANT(c) ((0<=(c)) && UCHAR_IS_INVARIANT(c)) #if U_CHARSET_FAMILY==U_ASCII_FAMILY #define CHAR_TO_UCHAR(c) c #define UCHAR_TO_CHAR(c) c #elif U_CHARSET_FAMILY==U_EBCDIC_FAMILY #define CHAR_TO_UCHAR(u) asciiFromEbcdic[u] #define UCHAR_TO_CHAR(u) ebcdicFromAscii[u] #else # error U_CHARSET_FAMILY is not valid #endif U_CAPI void U_EXPORT2 u_charsToUChars(const char *cs, UChar *us, int32_t length) { UChar u; uint8_t c; /* * Allow the entire ASCII repertoire to be mapped _to_ Unicode. * For EBCDIC systems, this works for characters with codes from * codepages 37 and 1047 or compatible. */ while(length>0) { c=(uint8_t)(*cs++); u=(UChar)CHAR_TO_UCHAR(c); U_ASSERT((u!=0 || c==0)); /* only invariant chars converted? */ *us++=u; --length; } } U_CAPI void U_EXPORT2 u_UCharsToChars(const UChar *us, char *cs, int32_t length) { UChar u; while(length>0) { u=*us++; if(!UCHAR_IS_INVARIANT(u)) { U_ASSERT(FALSE); /* Variant characters were used. These are not portable in ICU. */ u=0; } *cs++=(char)UCHAR_TO_CHAR(u); --length; } } U_CAPI UBool U_EXPORT2 uprv_isInvariantString(const char *s, int32_t length) { uint8_t c; for(;;) { if(length<0) { /* NUL-terminated */ c=(uint8_t)*s++; if(c==0) { break; } } else { /* count length */ if(length==0) { break; } --length; c=(uint8_t)*s++; if(c==0) { continue; /* NUL is invariant */ } } /* c!=0 now, one branch below checks c==0 for variant characters */ /* * no assertions here because these functions are legitimately called * for strings with variant characters */ #if U_CHARSET_FAMILY==U_ASCII_FAMILY if(!UCHAR_IS_INVARIANT(c)) { return FALSE; /* found a variant char */ } #elif U_CHARSET_FAMILY==U_EBCDIC_FAMILY c=CHAR_TO_UCHAR(c); if(c==0 || !UCHAR_IS_INVARIANT(c)) { return FALSE; /* found a variant char */ } #else # error U_CHARSET_FAMILY is not valid #endif } return TRUE; } U_CAPI UBool U_EXPORT2 uprv_isInvariantUString(const UChar *s, int32_t length) { UChar c; for(;;) { if(length<0) { /* NUL-terminated */ c=*s++; if(c==0) { break; } } else { /* count length */ if(length==0) { break; } --length; c=*s++; } /* * no assertions here because these functions are legitimately called * for strings with variant characters */ if(!UCHAR_IS_INVARIANT(c)) { return FALSE; /* found a variant char */ } } return TRUE; } /* UDataSwapFn implementations used in udataswp.c ------- */ /* convert ASCII to EBCDIC and verify that all characters are invariant */ U_CAPI int32_t U_EXPORT2 uprv_ebcdicFromAscii(const UDataSwapper *ds, const void *inData, int32_t length, void *outData, UErrorCode *pErrorCode) { const uint8_t *s; uint8_t *t; uint8_t c; int32_t count; if(pErrorCode==NULL || U_FAILURE(*pErrorCode)) { return 0; } if(ds==NULL || inData==NULL || length<0 || (length>0 && outData==NULL)) { *pErrorCode=U_ILLEGAL_ARGUMENT_ERROR; return 0; } /* setup and swapping */ s=(const uint8_t *)inData; t=(uint8_t *)outData; count=length; while(count>0) { c=*s++; if(!UCHAR_IS_INVARIANT(c)) { udata_printError(ds, "uprv_ebcdicFromAscii() string[%d] contains a variant character in position %d\n", length, length-count); *pErrorCode=U_INVALID_CHAR_FOUND; return 0; } *t++=ebcdicFromAscii[c]; --count; } return length; } /* this function only checks and copies ASCII strings without conversion */ U_CFUNC int32_t uprv_copyAscii(const UDataSwapper *ds, const void *inData, int32_t length, void *outData, UErrorCode *pErrorCode) { const uint8_t *s; uint8_t c; int32_t count; if(pErrorCode==NULL || U_FAILURE(*pErrorCode)) { return 0; } if(ds==NULL || inData==NULL || length<0 || (length>0 && outData==NULL)) { *pErrorCode=U_ILLEGAL_ARGUMENT_ERROR; return 0; } /* setup and checking */ s=(const uint8_t *)inData; count=length; while(count>0) { c=*s++; if(!UCHAR_IS_INVARIANT(c)) { udata_printError(ds, "uprv_copyFromAscii() string[%d] contains a variant character in position %d\n", length, length-count); *pErrorCode=U_INVALID_CHAR_FOUND; return 0; } --count; } if(length>0 && inData!=outData) { uprv_memcpy(outData, inData, length); } return length; } /* convert EBCDIC to ASCII and verify that all characters are invariant */ U_CFUNC int32_t uprv_asciiFromEbcdic(const UDataSwapper *ds, const void *inData, int32_t length, void *outData, UErrorCode *pErrorCode) { const uint8_t *s; uint8_t *t; uint8_t c; int32_t count; if(pErrorCode==NULL || U_FAILURE(*pErrorCode)) { return 0; } if(ds==NULL || inData==NULL || length<0 || (length>0 && outData==NULL)) { *pErrorCode=U_ILLEGAL_ARGUMENT_ERROR; return 0; } /* setup and swapping */ s=(const uint8_t *)inData; t=(uint8_t *)outData; count=length; while(count>0) { c=*s++; if(c!=0 && ((c=asciiFromEbcdic[c])==0 || !UCHAR_IS_INVARIANT(c))) { udata_printError(ds, "uprv_asciiFromEbcdic() string[%d] contains a variant character in position %d\n", length, length-count); *pErrorCode=U_INVALID_CHAR_FOUND; return 0; } *t++=c; --count; } return length; } /* this function only checks and copies EBCDIC strings without conversion */ U_CFUNC int32_t uprv_copyEbcdic(const UDataSwapper *ds, const void *inData, int32_t length, void *outData, UErrorCode *pErrorCode) { const uint8_t *s; uint8_t c; int32_t count; if(pErrorCode==NULL || U_FAILURE(*pErrorCode)) { return 0; } if(ds==NULL || inData==NULL || length<0 || (length>0 && outData==NULL)) { *pErrorCode=U_ILLEGAL_ARGUMENT_ERROR; return 0; } /* setup and checking */ s=(const uint8_t *)inData; count=length; while(count>0) { c=*s++; if(c!=0 && ((c=asciiFromEbcdic[c])==0 || !UCHAR_IS_INVARIANT(c))) { udata_printError(ds, "uprv_copyEbcdic() string[%] contains a variant character in position %d\n", length, length-count); *pErrorCode=U_INVALID_CHAR_FOUND; return 0; } --count; } if(length>0 && inData!=outData) { uprv_memcpy(outData, inData, length); } return length; } U_CFUNC UBool uprv_isEbcdicAtSign(char c) { static const uint8_t ebcdicAtSigns[] = { 0x7C, 0x44, 0x66, 0x80, 0xAC, 0xAE, 0xAF, 0xB5, 0xEC, 0xEF, 0x00 }; return c != 0 && uprv_strchr((const char *)ebcdicAtSigns, c) != nullptr; } /* compare invariant strings; variant characters compare less than others and unlike each other */ U_CFUNC int32_t uprv_compareInvAscii(const UDataSwapper *ds, const char *outString, int32_t outLength, const UChar *localString, int32_t localLength) { (void)ds; int32_t minLength; UChar32 c1, c2; uint8_t c; if(outString==NULL || outLength<-1 || localString==NULL || localLength<-1) { return 0; } if(outLength<0) { outLength=(int32_t)uprv_strlen(outString); } if(localLength<0) { localLength=u_strlen(localString); } minLength= outLength0) { c=(uint8_t)*outString++; if(UCHAR_IS_INVARIANT(c)) { c1=c; } else { c1=-1; } c2=*localString++; if(!UCHAR_IS_INVARIANT(c2)) { c2=-2; } if((c1-=c2)!=0) { return c1; } --minLength; } /* strings start with same prefix, compare lengths */ return outLength-localLength; } U_CFUNC int32_t uprv_compareInvEbcdic(const UDataSwapper *ds, const char *outString, int32_t outLength, const UChar *localString, int32_t localLength) { (void)ds; int32_t minLength; UChar32 c1, c2; uint8_t c; if(outString==NULL || outLength<-1 || localString==NULL || localLength<-1) { return 0; } if(outLength<0) { outLength=(int32_t)uprv_strlen(outString); } if(localLength<0) { localLength=u_strlen(localString); } minLength= outLength0) { c=(uint8_t)*outString++; if(c==0) { c1=0; } else if((c1=asciiFromEbcdic[c])!=0 && UCHAR_IS_INVARIANT(c1)) { /* c1 is set */ } else { c1=-1; } c2=*localString++; if(!UCHAR_IS_INVARIANT(c2)) { c2=-2; } if((c1-=c2)!=0) { return c1; } --minLength; } /* strings start with same prefix, compare lengths */ return outLength-localLength; } U_CAPI int32_t U_EXPORT2 uprv_compareInvEbcdicAsAscii(const char *s1, const char *s2) { int32_t c1, c2; for(;; ++s1, ++s2) { c1=(uint8_t)*s1; c2=(uint8_t)*s2; if(c1!=c2) { if(c1!=0 && ((c1=asciiFromEbcdic[c1])==0 || !UCHAR_IS_INVARIANT(c1))) { c1=-(int32_t)(uint8_t)*s1; } if(c2!=0 && ((c2=asciiFromEbcdic[c2])==0 || !UCHAR_IS_INVARIANT(c2))) { c2=-(int32_t)(uint8_t)*s2; } return c1-c2; } else if(c1==0) { return 0; } } } U_CAPI char U_EXPORT2 uprv_ebcdicToAscii(char c) { return (char)asciiFromEbcdic[(uint8_t)c]; } U_CAPI char U_EXPORT2 uprv_ebcdicToLowercaseAscii(char c) { return (char)lowercaseAsciiFromEbcdic[(uint8_t)c]; } U_INTERNAL uint8_t* U_EXPORT2 uprv_aestrncpy(uint8_t *dst, const uint8_t *src, int32_t n) { uint8_t *orig_dst = dst; if(n==-1) { n = static_cast(uprv_strlen((const char*)src)+1); /* copy NUL */ } /* copy non-null */ while(*src && n>0) { *(dst++) = asciiFromEbcdic[*(src++)]; n--; } /* pad */ while(n>0) { *(dst++) = 0; n--; } return orig_dst; } U_INTERNAL uint8_t* U_EXPORT2 uprv_eastrncpy(uint8_t *dst, const uint8_t *src, int32_t n) { uint8_t *orig_dst = dst; if(n==-1) { n = static_cast(uprv_strlen((const char*)src)+1); /* copy NUL */ } /* copy non-null */ while(*src && n>0) { char ch = ebcdicFromAscii[*(src++)]; if(ch == 0) { ch = ebcdicFromAscii[0x3f]; /* questionmark (subchar) */ } *(dst++) = ch; n--; } /* pad */ while(n>0) { *(dst++) = 0; n--; } return orig_dst; }