#include "IccProfLibConf.h"

Include dependency graph for IccConvertUTF.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	UNI_MAX_BMP (UTF32)0x0000FFFF

#define	UNI_MAX_LEGAL_UTF32 (UTF32)0x0010FFFF

#define	UNI_MAX_UTF16 (UTF32)0x0010FFFF

#define	UNI_MAX_UTF32 (UTF32)0x7FFFFFFF

#define	UNI_REPLACEMENT_CHAR (UTF32)0x0000FFFD

Typedefs
typedef unsigned char	Boolean

typedef unsigned short	UTF16

typedef uint32_t	UTF32

typedef unsigned char	UTF8

Enumerations
enum	icUtfConversionFlags { strictConversion = 0 , lenientConversion }

enum	icUtfConversionResult { conversionOK , sourceExhausted , targetExhausted , sourceIllegal }

Functions
icUtfConversionResult	icConvertUTF16toUTF32 (const UTF16 *sourceStart, const UTF16 sourceEnd, UTF32 *targetStart, UTF32 targetEnd, icUtfConversionFlags flags)

icUtfConversionResult	icConvertUTF16toUTF8 (const UTF16 *sourceStart, const UTF16 sourceEnd, UTF8 *targetStart, UTF8 targetEnd, icUtfConversionFlags flags)

icUtfConversionResult	icConvertUTF32toUTF16 (const UTF32 *sourceStart, const UTF32 sourceEnd, UTF16 *targetStart, UTF16 targetEnd, icUtfConversionFlags flags)

icUtfConversionResult	icConvertUTF32toUTF8 (const UTF32 *sourceStart, const UTF32 sourceEnd, UTF8 *targetStart, UTF8 targetEnd, icUtfConversionFlags flags)

icUtfConversionResult	icConvertUTF8toUTF16 (const UTF8 *sourceStart, const UTF8 sourceEnd, UTF16 *targetStart, UTF16 targetEnd, icUtfConversionFlags flags)

icUtfConversionResult	icConvertUTF8toUTF32 (const UTF8 *sourceStart, const UTF8 sourceEnd, UTF32 *targetStart, UTF32 targetEnd, icUtfConversionFlags flags)

Boolean	icIsLegalUTF8Sequence (const UTF8 source, const UTF8 sourceEnd)

Macro Definition Documentation

◆ UNI_MAX_BMP

#define UNI_MAX_BMP (UTF32)0x0000FFFF

Definition at line 113 of file IccConvertUTF.h.

Referenced by icConvertUTF32toUTF16(), icConvertUTF32toUTF16(), icConvertUTF8toUTF16(), and icConvertUTF8toUTF16().

◆ UNI_MAX_LEGAL_UTF32

#define UNI_MAX_LEGAL_UTF32 (UTF32)0x0010FFFF

Definition at line 116 of file IccConvertUTF.h.

Referenced by icConvertUTF32toUTF16(), icConvertUTF32toUTF16(), icConvertUTF32toUTF8(), icConvertUTF32toUTF8(), icConvertUTF8toUTF32(), and icConvertUTF8toUTF32().

◆ UNI_MAX_UTF16

#define UNI_MAX_UTF16 (UTF32)0x0010FFFF

Definition at line 114 of file IccConvertUTF.h.

Referenced by icConvertUTF8toUTF16(), and icConvertUTF8toUTF16().

◆ UNI_MAX_UTF32

#define UNI_MAX_UTF32 (UTF32)0x7FFFFFFF

Definition at line 115 of file IccConvertUTF.h.

◆ UNI_REPLACEMENT_CHAR

#define UNI_REPLACEMENT_CHAR (UTF32)0x0000FFFD

Definition at line 112 of file IccConvertUTF.h.

Referenced by icConvertUTF16toUTF8(), icConvertUTF16toUTF8(), icConvertUTF32toUTF16(), icConvertUTF32toUTF16(), icConvertUTF32toUTF8(), icConvertUTF32toUTF8(), icConvertUTF8toUTF16(), icConvertUTF8toUTF16(), icConvertUTF8toUTF32(), and icConvertUTF8toUTF32().

Typedef Documentation

◆ Boolean

typedef unsigned char Boolean

Definition at line 109 of file IccConvertUTF.h.

◆ UTF16

typedef unsigned short UTF16

Definition at line 107 of file IccConvertUTF.h.

◆ UTF32

typedef uint32_t UTF32

Definition at line 106 of file IccConvertUTF.h.

◆ UTF8

typedef unsigned char UTF8

Definition at line 108 of file IccConvertUTF.h.

Enumeration Type Documentation

◆ icUtfConversionFlags

enum icUtfConversionFlags

Enumerator
strictConversion
lenientConversion

Definition at line 125 of file IccConvertUTF.h.

             {
  strictConversion = 0,
  lenientConversion
} icUtfConversionFlags;

◆ icUtfConversionResult

enum icUtfConversionResult

Enumerator
conversionOK
sourceExhausted
targetExhausted
sourceIllegal

Definition at line 118 of file IccConvertUTF.h.

             {
  conversionOK,         /* conversion successful */
  sourceExhausted,  /* partial character in source, but hit end */
  targetExhausted,  /* insuff. room in target for conversion */
  sourceIllegal     /* source sequence is illegal/malformed */
} icUtfConversionResult;

Function Documentation

◆ icConvertUTF16toUTF32()

icUtfConversionResult icConvertUTF16toUTF32	(	const UTF16 **	sourceStart,
		const UTF16 *	sourceEnd,
		UTF32 **	targetStart,
		UTF32 *	targetEnd,
		icUtfConversionFlags	flags )

Definition at line 147 of file IccConvertUTF.cpp.

{
  icUtfConversionResult result = conversionOK;
  const UTF16* source = *sourceStart;
  UTF32* target = *targetStart;
  UTF32 ch, ch2;
  while (source < sourceEnd) {
    const UTF16* oldSource = source; /*  In case we have to back up because of target overflow. */
    ch = *source++;
    /* If we have a surrogate pair, convert to UTF32 first. */
    if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_HIGH_END) {
      /* If the 16 bits following the high surrogate are in the source buffer... */
      if (source < sourceEnd) {
        ch2 = *source;
        /* If it's a low surrogate, convert to UTF32. */
        if (ch2 >= UNI_SUR_LOW_START && ch2 <= UNI_SUR_LOW_END) {
          ch = ((ch - UNI_SUR_HIGH_START) << halfShift)
            + (ch2 - UNI_SUR_LOW_START) + halfBase;
          ++source;
        } else if (flags == strictConversion) { /* it's an unpaired high surrogate */
          --source; /* return to the illegal value itself */
          result = sourceIllegal;
          break;
        }
      } else { /* We don't have the 16 bits following the high surrogate. */
        --source; /* return to the high surrogate */
        result = sourceExhausted;
        break;
      }
    } else if (flags == strictConversion) {
      /* UTF-16 surrogate values are illegal in UTF-32 */
      if (ch >= UNI_SUR_LOW_START && ch <= UNI_SUR_LOW_END) {
        --source; /* return to the illegal value itself */
        result = sourceIllegal;
        break;
      }
    }
    if (target >= targetEnd) {
      source = oldSource; /* Back up source pointer! */
      result = targetExhausted; break;
    }
    *target++ = ch;
  }
  *sourceStart = source;
  *targetStart = target;
#ifdef CVTUTF_DEBUG
  if (result == sourceIllegal) {
    fprintf(stderr, "ConvertUTF16toUTF32 illegal seq 0x%04x,%04x\n", ch, ch2);
    fflush(stderr);
  }
#endif
  return result;
}

References conversionOK, halfBase, halfShift, sourceExhausted, sourceIllegal, strictConversion, targetExhausted, UNI_SUR_HIGH_END, UNI_SUR_HIGH_START, UNI_SUR_LOW_END, and UNI_SUR_LOW_START.

◆ icConvertUTF16toUTF8()

icUtfConversionResult icConvertUTF16toUTF8	(	const UTF16 **	sourceStart,
		const UTF16 *	sourceEnd,
		UTF8 **	targetStart,
		UTF8 *	targetEnd,
		icUtfConversionFlags	flags )

Definition at line 299 of file IccConvertUTF.cpp.

{
  icUtfConversionResult result = conversionOK;
  const UTF16* source = *sourceStart;
  UTF8* target = *targetStart;
  while (source < sourceEnd) {
    UTF32 ch;
    unsigned short bytesToWrite = 0;
    const UTF32 byteMask = 0xBF;
    const UTF32 byteMark = 0x80; 
    const UTF16* oldSource = source; /* In case we have to back up because of target overflow. */
    ch = *source++;
    /* If we have a surrogate pair, convert to UTF32 first. */
    if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_HIGH_END) {
      /* If the 16 bits following the high surrogate are in the source buffer... */
      if (source < sourceEnd) {
        UTF32 ch2 = *source;
        /* If it's a low surrogate, convert to UTF32. */
        if (ch2 >= UNI_SUR_LOW_START && ch2 <= UNI_SUR_LOW_END) {
          ch = ((ch - UNI_SUR_HIGH_START) << halfShift)
            + (ch2 - UNI_SUR_LOW_START) + halfBase;
          ++source;
        } else if (flags == strictConversion) { /* it's an unpaired high surrogate */
          --source; /* return to the illegal value itself */
          result = sourceIllegal;
          break;
        }
      } else { /* We don't have the 16 bits following the high surrogate. */
        --source; /* return to the high surrogate */
        result = sourceExhausted;
        break;
      }
    } else if (flags == strictConversion) {
      /* UTF-16 surrogate values are illegal in UTF-32 */
      if (ch >= UNI_SUR_LOW_START && ch <= UNI_SUR_LOW_END) {
        --source; /* return to the illegal value itself */
        result = sourceIllegal;
        break;
      }
    }
    /* Figure out how many bytes the result will require */
    if (ch < (UTF32)0x80) {      bytesToWrite = 1;
    } else if (ch < (UTF32)0x800) {     bytesToWrite = 2;
    } else if (ch < (UTF32)0x10000) {   bytesToWrite = 3;
    } else if (ch < (UTF32)0x110000) {  bytesToWrite = 4;
    } else {                bytesToWrite = 3;
    ch = UNI_REPLACEMENT_CHAR;
    }
 
    target += bytesToWrite;
    if (target > targetEnd) {
      source = oldSource; /* Back up source pointer! */
      target -= bytesToWrite; result = targetExhausted; break;
    }
    switch (bytesToWrite) { /* note: everything falls through. */
      case 4: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6;
      case 3: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6;
      case 2: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6;
      case 1: *--target =  (UTF8)(ch | firstByteMark[bytesToWrite]);
    }
    target += bytesToWrite;
  }
  *sourceStart = source;
  *targetStart = target;
  return result;
}

References conversionOK, firstByteMark, halfBase, halfShift, sourceExhausted, sourceIllegal, strictConversion, targetExhausted, UNI_REPLACEMENT_CHAR, UNI_SUR_HIGH_END, UNI_SUR_HIGH_START, UNI_SUR_LOW_END, and UNI_SUR_LOW_START.

Referenced by CIccTagUtf16Text::GetText(), icUtf16ToUtf8(), CIccTagUtf8Text::SetText(), and CIccTagZipUtf8Text::SetText().

Here is the caller graph for this function:

◆ icConvertUTF32toUTF16()

icUtfConversionResult icConvertUTF32toUTF16	(	const UTF32 **	sourceStart,
		const UTF32 *	sourceEnd,
		UTF16 **	targetStart,
		UTF16 *	targetEnd,
		icUtfConversionFlags	flags )

Definition at line 61 of file IccConvertUTF.cpp.

{
  icUtfConversionResult result = conversionOK;
  const UTF32* source = *sourceStart;
  UTF16* target = *targetStart;
  while (source < sourceEnd) {
    UTF32 ch;
    if (target >= targetEnd) {
      result = targetExhausted; break;
    }
    ch = *source++;
    if (ch <= UNI_MAX_BMP) { /* Target is a character <= 0xFFFF */
      /* UTF-16 surrogate values are illegal in UTF-32; 0xffff or 0xfffe are both reserved values */
      if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_LOW_END) {
        if (flags == strictConversion) {
          --source; /* return to the illegal value itself */
          result = sourceIllegal;
          break;
        } else {
          *target++ = UNI_REPLACEMENT_CHAR;
        }
      } else {
        *target++ = (UTF16)ch; /* normal case */
      }
    } else if (ch > UNI_MAX_LEGAL_UTF32) {
      if (flags == strictConversion) {
        result = sourceIllegal;
      } else {
        *target++ = UNI_REPLACEMENT_CHAR;
      }
    } else {
      /* target is a character in range 0xFFFF - 0x10FFFF. */
      if (target + 1 >= targetEnd) {
        --source; /* Back up source pointer! */
        result = targetExhausted; break;
      }
      ch -= halfBase;
      *target++ = (UTF16)((ch >> halfShift) + UNI_SUR_HIGH_START);
      *target++ = (UTF16)((ch & halfMask) + UNI_SUR_LOW_START);
    }
  }
  *sourceStart = source;
  *targetStart = target;
  return result;
}

References conversionOK, halfBase, halfMask, halfShift, sourceIllegal, strictConversion, targetExhausted, UNI_MAX_BMP, UNI_MAX_LEGAL_UTF32, UNI_REPLACEMENT_CHAR, UNI_SUR_HIGH_START, UNI_SUR_LOW_END, and UNI_SUR_LOW_START.

Referenced by CIccLocalizedUnicode::SetText().

Here is the caller graph for this function:

◆ icConvertUTF32toUTF8()

icUtfConversionResult icConvertUTF32toUTF8	(	const UTF32 **	sourceStart,
		const UTF32 *	sourceEnd,
		UTF8 **	targetStart,
		UTF8 *	targetEnd,
		icUtfConversionFlags	flags )

Definition at line 622 of file IccConvertUTF.cpp.

{
  icUtfConversionResult result = conversionOK;
  const UTF32* source = *sourceStart;
  UTF8* target = *targetStart;
  while (source < sourceEnd) {
    UTF32 ch;
    unsigned short bytesToWrite = 0;
    const UTF32 byteMask = 0xBF;
    const UTF32 byteMark = 0x80; 
    ch = *source++;
    if (flags == strictConversion ) {
      /* UTF-16 surrogate values are illegal in UTF-32 */
      if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_LOW_END) {
        --source; /* return to the illegal value itself */
        result = sourceIllegal;
        break;
      }
    }
    /*
    * Figure out how many bytes the result will require. Turn any
    * illegally large UTF32 things (> Plane 17) into replacement chars.
    */
    if (ch < (UTF32)0x80) {      bytesToWrite = 1;
    } else if (ch < (UTF32)0x800) {     bytesToWrite = 2;
    } else if (ch < (UTF32)0x10000) {   bytesToWrite = 3;
    } else if (ch <= UNI_MAX_LEGAL_UTF32) {  bytesToWrite = 4;
    } else {                bytesToWrite = 3;
    ch = UNI_REPLACEMENT_CHAR;
    result = sourceIllegal;
    }
 
    target += bytesToWrite;
    if (target > targetEnd) {
      --source; /* Back up source pointer! */
      target -= bytesToWrite; result = targetExhausted; break;
    }
    switch (bytesToWrite) { /* note: everything falls through. */
      case 4: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6;
      case 3: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6;
      case 2: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6;
      case 1: *--target = (UTF8) (ch | firstByteMark[bytesToWrite]);
    }
    target += bytesToWrite;
  }
  *sourceStart = source;
  *targetStart = target;
  return result;
}

References conversionOK, firstByteMark, sourceIllegal, strictConversion, targetExhausted, UNI_MAX_LEGAL_UTF32, UNI_REPLACEMENT_CHAR, UNI_SUR_HIGH_START, and UNI_SUR_LOW_END.

◆ icConvertUTF8toUTF16()

icUtfConversionResult icConvertUTF8toUTF16	(	const UTF8 **	sourceStart,
		const UTF8 *	sourceEnd,
		UTF16 **	targetStart,
		UTF16 *	targetEnd,
		icUtfConversionFlags	flags )

Definition at line 489 of file IccConvertUTF.cpp.

{
  icUtfConversionResult result = conversionOK;
  const UTF8* source = *sourceStart;
  UTF16* target = *targetStart;
  while (source < sourceEnd) {
    UTF32 ch = 0;
    unsigned short extraBytesToRead = trailingBytesForUTF8[*source];
    if (source + extraBytesToRead >= sourceEnd) {
      result = sourceExhausted; break;
    }
    /* Do this check whether lenient or strict */
    if (! isLegalUTF8(source, extraBytesToRead+1)) {
      result = sourceIllegal;
      break;
    }
    /*
    * The cases all fall through. See "Note A" below.
    */
    switch (extraBytesToRead) {
      case 5: ch += *source++; ch <<= 6; /* remember, illegal UTF-8 */
      case 4: ch += *source++; ch <<= 6; /* remember, illegal UTF-8 */
      case 3: ch += *source++; ch <<= 6;
      case 2: ch += *source++; ch <<= 6;
      case 1: ch += *source++; ch <<= 6;
      case 0: ch += *source++;
    }
    ch -= offsetsFromUTF8[extraBytesToRead];
 
    if (target >= targetEnd) {
      source -= (extraBytesToRead+1); /* Back up source pointer! */
      result = targetExhausted; break;
    }
    if (ch <= UNI_MAX_BMP) { /* Target is a character <= 0xFFFF */
      /* UTF-16 surrogate values are illegal in UTF-32 */
      if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_LOW_END) {
        if (flags == strictConversion) {
          source -= (extraBytesToRead+1); /* return to the illegal value itself */
          result = sourceIllegal;
          break;
        } else {
          *target++ = UNI_REPLACEMENT_CHAR;
        }
      } else {
        *target++ = (UTF16)ch; /* normal case */
      }
    } else if (ch > UNI_MAX_UTF16) {
      if (flags == strictConversion) {
        result = sourceIllegal;
        source -= (extraBytesToRead+1); /* return to the start */
        break; /* Bail out; shouldn't continue */
      } else {
        *target++ = UNI_REPLACEMENT_CHAR;
      }
    } else {
      /* target is a character in range 0xFFFF - 0x10FFFF. */
      if (target + 1 >= targetEnd) {
        source -= (extraBytesToRead+1); /* Back up source pointer! */
        result = targetExhausted; break;
      }
      ch -= halfBase;
      *target++ = (UTF16)((ch >> halfShift) + UNI_SUR_HIGH_START);
      *target++ = (UTF16)((ch & halfMask) + UNI_SUR_LOW_START);
    }
  }
  *sourceStart = source;
  *targetStart = target;
  return result;
}

References conversionOK, halfBase, halfMask, halfShift, isLegalUTF8(), offsetsFromUTF8, sourceExhausted, sourceIllegal, strictConversion, targetExhausted, trailingBytesForUTF8, UNI_MAX_BMP, UNI_MAX_UTF16, UNI_REPLACEMENT_CHAR, UNI_SUR_HIGH_START, UNI_SUR_LOW_END, and UNI_SUR_LOW_START.

Referenced by CIccUTF16String::CIccUTF16String(), CIccUTF16String::FromUtf8(), and CIccTagUtf16Text::SetText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ icConvertUTF8toUTF32()

icUtfConversionResult icConvertUTF8toUTF32	(	const UTF8 **	sourceStart,
		const UTF8 *	sourceEnd,
		UTF32 **	targetStart,
		UTF32 *	targetEnd,
		icUtfConversionFlags	flags )

Definition at line 723 of file IccConvertUTF.cpp.

{
  icUtfConversionResult result = conversionOK;
  const UTF8* source = *sourceStart;
  UTF32* target = *targetStart;
  while (source < sourceEnd) {
    UTF32 ch = 0;
    unsigned short extraBytesToRead = trailingBytesForUTF8[*source];
    if (source + extraBytesToRead >= sourceEnd) {
      result = sourceExhausted; break;
    }
    /* Do this check whether lenient or strict */
    if (! isLegalUTF8(source, extraBytesToRead+1)) {
      result = sourceIllegal;
      break;
    }
    /*
    * The cases all fall through. See "Note A" below.
    */
    switch (extraBytesToRead) {
      case 5: ch += *source++; ch <<= 6;
      case 4: ch += *source++; ch <<= 6;
      case 3: ch += *source++; ch <<= 6;
      case 2: ch += *source++; ch <<= 6;
      case 1: ch += *source++; ch <<= 6;
      case 0: ch += *source++;
    }
    ch -= offsetsFromUTF8[extraBytesToRead];
 
    if (target >= targetEnd) {
      source -= (extraBytesToRead+1); /* Back up the source pointer! */
      result = targetExhausted; break;
    }
    if (ch <= UNI_MAX_LEGAL_UTF32) {
      /*
      * UTF-16 surrogate values are illegal in UTF-32, and anything
      * over Plane 17 (> 0x10FFFF) is illegal.
      */
      if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_LOW_END) {
        if (flags == strictConversion) {
          source -= (extraBytesToRead+1); /* return to the illegal value itself */
          result = sourceIllegal;
          break;
        } else {
          *target++ = UNI_REPLACEMENT_CHAR;
        }
      } else {
        *target++ = ch;
      }
    } else { /* i.e., ch > UNI_MAX_LEGAL_UTF32 */
      result = sourceIllegal;
      *target++ = UNI_REPLACEMENT_CHAR;
    }
  }
  *sourceStart = source;
  *targetStart = target;
  return result;
}

References conversionOK, isLegalUTF8(), offsetsFromUTF8, sourceExhausted, sourceIllegal, strictConversion, targetExhausted, trailingBytesForUTF8, UNI_MAX_LEGAL_UTF32, UNI_REPLACEMENT_CHAR, UNI_SUR_HIGH_START, and UNI_SUR_LOW_END.

Here is the call graph for this function:

◆ icIsLegalUTF8Sequence()

Boolean icIsLegalUTF8Sequence	(	const UTF8 *	source,
		const UTF8 *	sourceEnd )

Definition at line 478 of file IccConvertUTF.cpp.

{
  int length = trailingBytesForUTF8[*source]+1;
  if (source+length > sourceEnd) {
    return false;
  }
  return isLegalUTF8(source, length);
}

References isLegalUTF8(), and trailingBytesForUTF8.

Here is the call graph for this function:

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ UNI_MAX_BMP

◆ UNI_MAX_LEGAL_UTF32

◆ UNI_MAX_UTF16

◆ UNI_MAX_UTF32

◆ UNI_REPLACEMENT_CHAR

Typedef Documentation

◆ Boolean

◆ UTF16

◆ UTF32

◆ UTF8

Enumeration Type Documentation

◆ icUtfConversionFlags

◆ icUtfConversionResult

Function Documentation

◆ icConvertUTF16toUTF32()

◆ icConvertUTF16toUTF8()

◆ icConvertUTF32toUTF16()

◆ icConvertUTF32toUTF8()

◆ icConvertUTF8toUTF16()

◆ icConvertUTF8toUTF32()

◆ icIsLegalUTF8Sequence()