src/antlr3convertutf.c(3)

🌸 src/antlr3convertutf.c — an ANTLR3C page, bestie 💖

okay so hi. you found the man page for src/antlr3convertutf.c, which lives under the ANTLR3C manual. it's giving "quiet little C file that does ALL the unicode heavy lifting" and honestly? iconic. no cap. let's get into it 🫶

---

✨ NAME ✨

src/antlr3convertutf.c — the file. that's it. that's the name. short, sweet, slays 💅

---

🌈 SYNOPSIS 🌈

#include 'antlr3convertutf.h'

🦋 Functions 🦋

here's the whole squad of conversion besties — each one takes a ConversionFlags flags and each one returns a ConversionResult:

• 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)
• static ANTLR3_BOOLEAN isLegalUTF8 (const UTF8 *source, int length)
• ANTLR3_BOOLEAN isLegalUTF8Sequence (const UTF8 *source, const UTF8 *sourceEnd)

like. all the UTF permutations?? 16→32, 16→8, 32→16, 32→8, 8→16, 8→32. literally every glow-up route available. obsessed 😭💖

🎀 Variables 🎀

• static const UTF8 firstByteMark [7] = { 0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC }
• static const UTF32 offsetsFromUTF8 [6]
• static const char trailingBytesForUTF8 [256]

three little static lookups carrying the whole operation on their backs. main character energy fr fr 👑

---

💜 Function Documentation 💜

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

this one 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 (const UTF16 ** sourceStart, const UTF16 * sourceEnd, UTF8 ** targetStart, UTF8 * targetEnd, ConversionFlags flags)

this one 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.

and guess what — it's referenced by toUTF8_UTF16(). the way it gets called up by its friends 🥹

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

this one 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 (const UTF32 ** sourceStart, const UTF32 * sourceEnd, UTF8 ** targetStart, UTF8 * targetEnd, ConversionFlags flags)

this one references: conversionOK, firstByteMark, sourceIllegal, strictConversion, targetExhausted, UNI_MAX_LEGAL_UTF32, UNI_REPLACEMENT_CHAR, UNI_SUR_HIGH_START, and UNI_SUR_LOW_END.

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

this one 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.

look at that reference list. it knows EVERYBODY. 💅

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

this one 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 isLegalUTF8 (const UTF8 * source, int length) [static]

the vibe check function!! it references ANTLR3_FALSE, and ANTLR3_TRUE.

and it's referenced by ConvertUTF8toUTF16(), ConvertUTF8toUTF32(), and isLegalUTF8Sequence(). so it's the popular one, lowkey.

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

this one references ANTLR3_FALSE, isLegalUTF8(), and trailingBytesForUTF8.

---

💖 Variable Documentation 💖

⭐ const UTF8 firstByteMark[7] = { 0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC } [static]

Referenced by ConvertUTF16toUTF8(), and ConvertUTF32toUTF8().

⭐ const UTF32 offsetsFromUTF8[6] [static]

Initial value:

= { 0x00000000UL, 0x00003080UL, 0x000E2080UL,
             0x03C82080UL, 0xFA082080UL, 0x82082080UL }

Referenced by antlr3UTF8Consume(), antlr3UTF8LA(), ConvertUTF8toUTF16(), and ConvertUTF8toUTF32().

⭐ const char trailingBytesForUTF8[256] [static]

Initial value:

= {
    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,
    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,
    1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
    2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5
}

Referenced by antlr3UTF8Consume(), antlr3UTF8LA(), ConvertUTF8toUTF16(), ConvertUTF8toUTF32(), and isLegalUTF8Sequence().

256 whole entries. that's a LOT of typing and she did it anyway. respect. 🧚✨

---

🎀 Author 🎀

Generated automatically by Doxygen for ANTLR3C from the source code. so like, a robot wrote this about a robot-adjacent C file. we love a meta moment 💀🦋

---

no cap bestie, everything above is exactly what the page says — I didn't invent a single flag, value or reference, I just gave it the group-chat glow-up it deserved 💖

and that's the whole page!! thanks for reading, you ate that 🌈

Version 3.3.1 — dated Tue Jul 29 2025 00:00:00 — and it's the src/antlr3convertutf.c(3) page. mwah, bye bestie, drink water 💜🌸✨