include/antlr3convertutf.h(3)

💖 NAME 💖

okay bestie, this is include/antlr3convertutf.h(3) from ANTLR3C — the header that's lowkey the Unicode translator of the whole operation. It's giving "let me convert your UTF-16 to UTF-32 without breaking a sweat" and honestly? iconic. ✨

---

✨ SYNOPSIS ✨

#include <antlr3defs.h>

🎀 Macros 🎀

#define halfBase   ((UTF32)0x0010000UL)
#define halfMask   ((UTF32)0x3FFUL)
#define halfShift   ((UTF32)10)
#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
#define UNI_SUR_HIGH_END   (UTF32)0xDBFF
#define UNI_SUR_HIGH_START   (UTF32)0xD800
#define UNI_SUR_LOW_END   (UTF32)0xDFFF
#define UNI_SUR_LOW_START   (UTF32)0xDC00

🧚 Typedefs 🧚

typedef ANTLR3_UINT16 UTF16
typedef ANTLR3_UINT32 UTF32
typedef ANTLR3_UINT8 UTF8

🦋 Enumerations 🦋

enum ConversionFlags { strictConversion = 0, lenientConversion }
enum ConversionResult { conversionOK, sourceExhausted, targetExhausted,
    sourceIllegal }

🔥 Functions 🔥

ConversionResult ConvertUTF16toUTF32 (const UTF16 **sourceStart, const
    UTF16 *sourceEnd, UTF32 **targetStart, UTF32 *targetEnd,
    ConversionFlags flags)
ConversionResult ConvertUTF16toUTF8 (const UTF16 **sourceStart, const
    UTF16 *sourceEnd, UTF8 **targetStart, UTF8 *targetEnd,
    ConversionFlags flags)
ConversionResult ConvertUTF32toUTF16 (const UTF32 **sourceStart, const
    UTF32 *sourceEnd, UTF16 **targetStart, UTF16 *targetEnd,
    ConversionFlags flags)
ConversionResult ConvertUTF32toUTF8 (const UTF32 **sourceStart, const UTF32
    *sourceEnd, UTF8 **targetStart, UTF8 *targetEnd, ConversionFlags
    flags)
ConversionResult ConvertUTF8toUTF16 (const UTF8 **sourceStart, const UTF8 *
    sourceEnd, UTF16 **targetStart, UTF16 *targetEnd, ConversionFlags
    flags)
ConversionResult ConvertUTF8toUTF32 (const UTF8 **sourceStart, const UTF8 *
    sourceEnd, UTF32 **targetStart, UTF32 *targetEnd, ConversionFlags
    flags)
ANTLR3_BOOLEAN isLegalUTF8Sequence (const UTF8 *source, const UTF8
    *sourceEnd)

---

🔥 Macro Definition Documentation 🔥

💖 #define halfBase ((UTF32)0x0010000UL) 💖

Referenced by antlr3UTF16LA(), antlr3UTF16LABE(), antlr3UTF16LALE(), ConvertUTF16toUTF32(), ConvertUTF16toUTF8(), ConvertUTF32toUTF16(), and ConvertUTF8toUTF16().

💖 #define halfMask ((UTF32)0x3FFUL) 💖

Referenced by ConvertUTF32toUTF16(), and ConvertUTF8toUTF16().

💖 #define halfShift ((UTF32)10) 💖

Referenced by antlr3UTF16LA(), antlr3UTF16LABE(), antlr3UTF16LALE(), ConvertUTF16toUTF32(), ConvertUTF16toUTF8(), ConvertUTF32toUTF16(), and ConvertUTF8toUTF16().

💖 #define UNI_MAX_BMP (UTF32)0x0000FFFF 💖

Referenced by ConvertUTF32toUTF16(), and ConvertUTF8toUTF16().

💖 #define UNI_MAX_LEGAL_UTF32 (UTF32)0x0010FFFF 💖

Referenced by ConvertUTF32toUTF16(), ConvertUTF32toUTF8(), and ConvertUTF8toUTF32().

💖 #define UNI_MAX_UTF16 (UTF32)0x0010FFFF 💖

Referenced by ConvertUTF8toUTF16().

💖 #define UNI_MAX_UTF32 (UTF32)0x7FFFFFFF 💖

💖 #define UNI_REPLACEMENT_CHAR (UTF32)0x0000FFFD 💖

Referenced by ConvertUTF16toUTF8(), ConvertUTF32toUTF16(), ConvertUTF32toUTF8(), ConvertUTF8toUTF16(), and ConvertUTF8toUTF32().

💖 #define UNI_SUR_HIGH_END (UTF32)0xDBFF 💖

Referenced by antlr3UTF16Consume(), antlr3UTF16ConsumeBE(), antlr3UTF16ConsumeLE(), antlr3UTF16LA(), antlr3UTF16LABE(), antlr3UTF16LALE(), ConvertUTF16toUTF32(), and ConvertUTF16toUTF8().

💖 #define UNI_SUR_HIGH_START (UTF32)0xD800 💖

Referenced by antlr3UTF16Consume(), antlr3UTF16ConsumeBE(), antlr3UTF16ConsumeLE(), antlr3UTF16LA(), antlr3UTF16LABE(), antlr3UTF16LALE(), ConvertUTF16toUTF32(), ConvertUTF16toUTF8(), ConvertUTF32toUTF16(), ConvertUTF32toUTF8(), ConvertUTF8toUTF16(), and ConvertUTF8toUTF32().

💖 #define UNI_SUR_LOW_END (UTF32)0xDFFF 💖

Referenced by antlr3UTF16Consume(), antlr3UTF16ConsumeBE(), antlr3UTF16ConsumeLE(), antlr3UTF16LA(), antlr3UTF16LABE(), antlr3UTF16LALE(), ConvertUTF16toUTF32(), ConvertUTF16toUTF8(), ConvertUTF32toUTF16(), ConvertUTF32toUTF8(), ConvertUTF8toUTF16(), and ConvertUTF8toUTF32().

💖 #define UNI_SUR_LOW_START (UTF32)0xDC00 💖

Referenced by antlr3UTF16Consume(), antlr3UTF16ConsumeBE(), antlr3UTF16ConsumeLE(), antlr3UTF16LA(), antlr3UTF16LABE(), antlr3UTF16LALE(), ConvertUTF16toUTF32(), ConvertUTF16toUTF8(), ConvertUTF32toUTF16(), and ConvertUTF8toUTF16().

---

🧚 Typedef Documentation 🧚

• typedef ANTLR3_UINT16 UTF16
• typedef ANTLR3_UINT32 UTF32
• typedef ANTLR3_UINT8 UTF8

---

🌈 Enumeration Type Documentation 🌈

enum ConversionFlags

Enumerator

• strictConversion
• lenientConversion

enum ConversionResult

Enumerator

• conversionOK
• sourceExhausted
• targetExhausted
• sourceIllegal

---

👑 Function Documentation 👑

🔥 ConversionResult ConvertUTF16toUTF32 🔥

ConversionResult ConvertUTF16toUTF32 (const UTF16 **sourceStart, const
    UTF16 *sourceEnd, UTF32 **targetStart, UTF32 *targetEnd,
    ConversionFlags flags)

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.

🔥 ConversionResult ConvertUTF16toUTF8 🔥

ConversionResult ConvertUTF16toUTF8 (const UTF16 **sourceStart, const UTF16
    *sourceEnd, UTF8 **targetStart, UTF8 *targetEnd, ConversionFlags
    flags)

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 toUTF8_UTF16().

🔥 ConversionResult ConvertUTF32toUTF16 🔥

ConversionResult ConvertUTF32toUTF16 (const UTF32 **sourceStart, const
    UTF32 *sourceEnd, UTF16 **targetStart, UTF16 *targetEnd,
    ConversionFlags flags)

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.

🔥 ConversionResult ConvertUTF32toUTF8 🔥

ConversionResult ConvertUTF32toUTF8 (const UTF32 **sourceStart, const UTF32
    *sourceEnd, UTF8 **targetStart, UTF8 *targetEnd, ConversionFlags
    flags)

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

🔥 ConversionResult ConvertUTF8toUTF16 🔥

ConversionResult ConvertUTF8toUTF16 (const UTF8 **sourceStart, const UTF8 *
    sourceEnd, UTF16 **targetStart, UTF16 *targetEnd, ConversionFlags
    flags)

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.

🔥 ConversionResult ConvertUTF8toUTF32 🔥

ConversionResult ConvertUTF8toUTF32 (const UTF8 **sourceStart, const UTF8 *
    sourceEnd, UTF32 **targetStart, UTF32 *targetEnd, ConversionFlags
    flags)

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.

🔥 ANTLR3_BOOLEAN isLegalUTF8Sequence 🔥

ANTLR3_BOOLEAN isLegalUTF8Sequence (const UTF8 *source, const UTF8 *
    sourceEnd)

References ANTLR3_FALSE, isLegalUTF8(), and trailingBytesForUTF8.

---

💅 Author 💅

Generated automatically by Doxygen for ANTLR3C from the source code.

k that's the whole glow-up bestie — Version 3.3.1, Tue Jul 29 2025 00:00, include/antlr3convertutf.h(3) 💖✨🦋