Unicode text processing,
without the baggage.

Normalize a string to the requested Unicode normalization form. If the input is already normalized and no encoding conversion is needed, the input buffer is returned as-is in result->output with result->transformed set to false, without allocating.

Returns

• MJB_STATUS_OK — The string was normalized (or already normal)
• MJB_STATUS_INVALID_ARGUMENT — result is NULL, or buffer is NULL with a non-zero size
• MJB_STATUS_INVALID_FORM — form is not NFC, NFD, NFKC, or NFKD
• MJB_STATUS_OVERFLOW — The output size would overflow
• MJB_STATUS_NO_MEMORY — Allocation failed

Example

const char *input = "Cafe\xCC\x81"; // "Cafe" + U+0301 COMBINING ACUTE ACCENT
mjb_result result;

if(mjb_normalize(input, strlen(input), MJB_ENC_UTF_8, MJB_NORMALIZATION_NFC, MJB_ENC_UTF_8,
    &result) != MJB_STATUS_OK) {
    return 1;
}

// NFC: Café
printf("NFC: %.*s", (int)result.output_size, result.output);

if(result.transformed) {
    mjb_free(result.output);
}

Related

• mjb_string_is_normalized
• mjb_string_filter

Specifications

• UAX #15: Unicode Normalization Forms, Unicode 17.0.0

MJB_FILTER_LIMIT_COMBINING removes combining marks after the first MJB_FILTER_MAX_COMBINING_MARKS consecutive marks in an emitted run. This is useful for reducing Zalgo-style text while keeping ordinary accents and stacked marks.

Example

const char *mixed_whitespace = "Hello\t\t\n\nworld";
mjb_result result;

if(mjb_string_filter(mixed_whitespace, strlen(mixed_whitespace), MJB_ENC_UTF_8,
    MJB_FILTER_COLLAPSE_SPACES, MJB_ENC_UTF_8, &result) != MJB_STATUS_OK) {
    return 1;
}

// Filtered: Hello world
printf("Filtered: %.*s", (int)result.output_size, result.output);

if(result.transformed) {
    mjb_free(result.output);
}

const char *controls = "\x1\x2\t\n\v\f\r\x1f";

if(mjb_string_filter(controls, strlen(controls), MJB_ENC_UTF_8, MJB_FILTER_CONTROLS,
    MJB_ENC_UTF_8, &result) != MJB_STATUS_OK) {
    return 1;
}

// Filtered: \t\n\v\f\r
printf("Filtered: %.*s", (int)result.output_size, result.output);

if(result.transformed) {
    mjb_free(result.output);
}

Related

• mjb_normalize

Apply the normative NFKC_Casefold mapping and normalize the result to NFC. This transform performs compatibility folding, full default case folding, and removal of default-ignorable codepoints. It is intended for identifier comparison and is not locale-sensitive.

Returns

• MJB_STATUS_OK — The transformed string was returned
• MJB_STATUS_INVALID_ARGUMENT — result is NULL, or buffer is NULL with a non-zero size
• MJB_STATUS_OVERFLOW — The output size would overflow
• MJB_STATUS_NO_MEMORY — Allocation failed

Example

const char *input = "Stra\xC3\x9F" "e\xC2\xAD";
mjb_result result;

if(mjb_nfkc_casefold(input, strlen(input), MJB_ENC_UTF_8, MJB_ENC_UTF_8,
    &result) != MJB_STATUS_OK) {
    return 1;
}

// strasse
printf("%.*s", (int)result.output_size, result.output);
mjb_result_free(&result);

Related

• mjb_normalize
• mjb_case
• mjb_string_is_identifier

Specifications

• The Unicode Standard, Version 17.0.0, Section 3.13: Default Case Algorithms
• UAX #31: Unicode Identifiers and Syntax, Unicode 17.0.0
• UAX #44: Unicode Character Database, Unicode 17.0.0

Example

char encoded[4];
unsigned int size = mjb_codepoint_encode(0x20AC, encoded, sizeof(encoded), MJB_ENC_UTF_8);

// € sign uses 3 UTF-8 bytes
printf("%.*s sign uses %u UTF-8 bytes", (int)size, encoded, size);

Convert a string between the supported encodings (UTF-8, UTF-16LE/BE, UTF-32LE/BE). Generic UTF-16/UTF-32 input consumes a leading BOM as the encoding scheme signature and uses it to resolve byte order. Explicit-endian input preserves an initial U+FEFF as text. Generic UTF-16/UTF-32 without a BOM, and generic UTF-16/UTF-32 output, are rejected because the byte order is not specified.

Returns

• MJB_STATUS_OK — The string was converted
• MJB_STATUS_INVALID_ARGUMENT — result is NULL, buffer is NULL with a non-zero size, or the input is not valid in the source encoding
• MJB_STATUS_INVALID_ENCODING — A generic UTF-16/UTF-32 encoding did not provide enough byte order information
• MJB_STATUS_UNSUPPORTED — The requested encoding conversion is not supported
• MJB_STATUS_OVERFLOW — The output size would overflow
• MJB_STATUS_NO_MEMORY — Allocation failed

Example

const char *input = "caf\xC3\xA9";
mjb_result result;

if(mjb_string_convert_encoding(input, strlen(input), MJB_ENC_UTF_8,
    MJB_ENC_UTF_16LE, &result) != MJB_STATUS_OK) {
    return 1;
}

// UTF-16LE bytes: 8
printf("UTF-16LE bytes: %zu", result.output_size);
mjb_result_free(&result);

Related

• mjb_string_encoding
• mjb_codepoint_encode

Convert a string to uppercase, lowercase, titlecase, or its case-folded form. Full case mappings are applied, including special casing and conditional mappings, so the output may have a different length than the input. Titlecase uses UAX #29 word boundaries: the first cased character in each word segment is titlecased, and subsequent characters in that segment are lowercased. Casing is tailored by the process-global locale set with mjb_locale_set: the default MJB_LOCALE_EN uses default non-Turkic mappings. MJB_LOCALE_TR and MJB_LOCALE_AZ apply Turkish/Azerbaijani dotted-I casing and Turkic T case-folding mappings. MJB_LOCALE_LT applies Lithuanian dot-above casing rules, while case folding remains the default non-Turkic mapping.

Returns

• MJB_STATUS_OK — The case conversion succeeded
• MJB_STATUS_INVALID_ARGUMENT — result is NULL, buffer is NULL with a non-zero size, or type is not a valid case type
• MJB_STATUS_NO_MEMORY — Allocation failed

Example

const char *input = "Stra\xC3\x9F""e"; // "Straße"
mjb_result result;

if(mjb_case(input, strlen(input), MJB_ENC_UTF_8, MJB_CASE_UPPER, MJB_ENC_UTF_8,
    &result) != MJB_STATUS_OK) {
    return 1;
}

// Upper: STRASSE
printf("Upper: %.*s", (int)result.output_size, result.output);

if(result.transformed) {
    mjb_free(result.output);
}

Related

• mjb_locale_set
• mjb_codepoint_to_uppercase
• mjb_codepoint_to_lowercase
• mjb_codepoint_to_titlecase

Specifications

• The Unicode Standard, Version 17.0.0, Section 3.13: Default Case Algorithms

Return the lowercase codepoint of a codepoint. If the codepoint has no lowercase equivalent, the original codepoint is returned.

Returns

• codepoint — The lowercase codepoint, or the original codepoint

Example

mjb_codepoint codepoint;

codepoint = mjb_codepoint_to_lowercase(0x0041); // U+0041 = 'A'

// A > a
printf("%c > %c", 'A', codepoint);

codepoint = mjb_codepoint_to_lowercase(0x03A3); // U+03A3 = 'Σ'

// U+03A3 > U+03C3, Σ > σ
printf("U+%04X > U+%04X, %s > %s",  0x03A3, codepoint, "Σ", "σ");

Related

• mjb_codepoint_to_uppercase
• mjb_codepoint_to_titlecase

Return the uppercase codepoint of a codepoint. If the codepoint has no uppercase equivalent, the original codepoint is returned.

Returns

• codepoint — The uppercase codepoint, or the original codepoint

Example

mjb_codepoint uppercase = mjb_codepoint_to_uppercase(0x00E9); // é

// Uppercase: U+00C9
printf("Uppercase: U+%04X", uppercase);

Related

• mjb_codepoint_to_lowercase
• mjb_codepoint_to_titlecase

Return the titlecase codepoint of a codepoint. If the codepoint has no titlecase equivalent, the original codepoint is returned.

Returns

• codepoint — The titlecase codepoint, or the original codepoint

Example

mjb_codepoint titlecase = mjb_codepoint_to_titlecase(0x01F3); // dz

// Titlecase: U+01F2
printf("Titlecase: U+%04X", titlecase);

Related

• mjb_codepoint_to_lowercase
• mjb_codepoint_to_uppercase

Fill character with the Unicode Character Database record of a codepoint: name, category, combining class, bidirectional category, decomposition, numeric values, mirrored flag, and simple case mappings. When the library is compiled with MJB_FEATURE_CHARACTER_NAMES=OFF the name field is reported as Codepoint U+XXXX.

Returns

• MJB_STATUS_OK — The character was found and filled
• MJB_STATUS_INVALID_ARGUMENT — character is NULL or the codepoint is not valid
• MJB_STATUS_NOT_FOUND — The codepoint is not assigned

Example

mjb_character character;

if(mjb_codepoint_character(0x022A, &character) != MJB_STATUS_OK) {
    return 1;
}

// U+022A lowercase: U+022B
printf("U+%04X lowercase: U+%04X", character.codepoint, character.lowercase);

Related

• mjb_codepoint_block
• mjb_codepoint_script
• mjb_codepoint_property_binary
• mjb_codepoint_property_int

Specifications

• UAX #44: Unicode Character Database, Unicode 17.0.0

Run the normalization quick-check on a string without allocating. MJB_QC_MAYBE means the string may still be normalized, and only a full normalization pass with mjb_normalize can decide.

Returns

• MJB_QC_YES — The string is normalized to the requested form
• MJB_QC_NO — The string is not normalized
• MJB_QC_MAYBE — Inconclusive: a full normalization is needed to decide

Example

const char *input = "caf\xC3\xA9";
mjb_quick_check_result check = mjb_string_is_normalized(input, strlen(input),
    MJB_ENC_UTF_8, MJB_NORMALIZATION_NFC);

// NFC normalized: yes
printf("NFC normalized: %s", check == MJB_QC_YES ? "yes" : "no");

Related

• mjb_normalize

Specifications

• UAX #15: Unicode Normalization Forms, Unicode 17.0.0

mjb_string_encoding reports BOM-derived UTF-16/UTF-32 schemes with the generic family bit plus the resolved endian bit. Passing that detected value consumes the leading BOM as a signature. Passing an explicit-endian encoding such as MJB_ENC_UTF_16BE preserves an initial U+FEFF as text. When flags overlap, as with a UTF-32LE BOM that also has the UTF-16LE BOM prefix, decoding gives UTF-32 precedence.

Example

const char utf16le[] = "\xFF\xFEH\0i\0";
mjb_encoding detected = mjb_string_encoding(utf16le, sizeof(utf16le) - 1);
bool is_utf16le = detected == (MJB_ENC_UTF_16 | MJB_ENC_UTF_16LE);

// UTF-16LE detected: yes
printf("UTF-16LE detected: %s", is_utf16le ? "yes" : "no");

Example

const char *input = "Plain ASCII";

// ASCII: yes
printf("ASCII: %s", mjb_string_is_ascii(input, strlen(input)) ? "yes" : "no");

Example

const char *input = "caf\xC3\xA9";

// Valid UTF-8: yes
printf("Valid UTF-8: %s", mjb_string_is_utf8(input, strlen(input)) ? "yes" : "no");

Example

const char utf16be[] = "\xFE\xFF\0H\0i"; // BOM + "Hi" in UTF-16BE

// UTF-16: yes
printf("UTF-16: %s", mjb_string_is_utf16(utf16be, sizeof(utf16be) - 1) ? "yes" : "no");

Return the number of Unicode codepoints in a string, up to max_length bytes.

Example

// The "Héllö" string is five Unicode characters, but has different byte lengths in different encodings.

const char *utf8 = "H\xC3\xA9ll\xC3\xB6"; // 7 bytes
const char utf16le[] = "H\0\xE9\0l\0l\0\xF6\0"; // 10 bytes
const char utf16be[] = "\0H\0\xE9\0l\0l\0\xF6"; // 10 bytes
const char utf32le[] = "H\0\0\0\xE9\0\0\0l\0\0\0l\0\0\0\xF6\0\0\0"; // 20 bytes
const char utf32be[] = "\0\0\0H\0\0\0\xE9\0\0\0l\0\0\0l\0\0\0\xF6"; // 20 bytes

// 5 UTF-8 characters
printf("%zu UTF-8 characters", mjb_string_length(utf8, 7, MJB_ENC_UTF_8));
// 5 UTF-16LE characters
printf("%zu UTF-16LE characters", mjb_string_length(utf16le, 10, MJB_ENC_UTF_16LE));
// 5 UTF-16BE characters
printf("%zu UTF-16BE characters", mjb_string_length(utf16be, 10, MJB_ENC_UTF_16BE));
// 5 UTF-32LE characters
printf("%zu UTF-32LE characters", mjb_string_length(utf32le, 20, MJB_ENC_UTF_32LE));
// 5 UTF-32BE characters
printf("%zu UTF-32BE characters", mjb_string_length(utf32be, 20, MJB_ENC_UTF_32BE));

Example

mjb_status status = mjb_string_each_character("ABC", 3, MJB_ENC_UTF_8, NULL);

// A callback is required: yes
bool callback_required = status == MJB_STATUS_INVALID_ARGUMENT;

// A callback is required: yes
printf("A callback is required: %s", callback_required ? "yes" : "no");

Return true when the codepoint has the binary property and false when it does not. Passing an enumerated property is a type mismatch and returns MJB_STATUS_INVALID_ARGUMENT.

Example

bool is_alphabetic;

if(mjb_codepoint_property_binary('A', MJB_PR_ALPHABETIC,
    &is_alphabetic) != MJB_STATUS_OK) {
    return 1;
}

// U+0041 is alphabetic: yes
printf("U+0041 is alphabetic: %s", is_alphabetic ? "yes" : "no");

Related

• mjb_codepoint_property_int

Specifications

• UAX #44: Unicode Character Database, Unicode 17.0.0

Passing a binary property is a type mismatch and returns MJB_STATUS_INVALID_ARGUMENT. MJB_STATUS_NOT_FOUND means that the codepoint has no stored value for the requested property.

Example

int32_t script;

if(mjb_codepoint_property_int('A', MJB_PR_SCRIPT, &script) != MJB_STATUS_OK) {
    return 1;
}

// U+0041 uses the Latin script: yes
printf("U+0041 uses the Latin script: %s", script == MJB_SC_LATN ? "yes" : "no");

Related

• mjb_codepoint_property_binary

Specifications

• UAX #44: Unicode Character Database, Unicode 17.0.0

Return the numeric value of a codepoint, if any. If the codepoint has no numeric value, value->decimal and value->digit are set to MJB_NUMBER_NOT_VALID (-1).

Returns

• MJB_STATUS_OK — The character was found and filled
• MJB_STATUS_INVALID_ARGUMENT — value is NULL or the codepoint is not valid

Example

mjb_numeric_value num;

if(mjb_codepoint_numeric_value(0x0031, &num) != MJB_STATUS_OK) { // U+0031 = 1
    return 1;
}

// decimal=1, digit=1, numeric=1
printf("decimal=%d, digit=%d, numeric=%s", num.decimal, num.digit, num.numeric);

if(mjb_codepoint_numeric_value(0x00BD, &num) != MJB_STATUS_OK) { // U+00BD = '½'
    return 1;
}

// decimal=-1, digit=-1, numeric=1/2
printf("decimal=%d, digit=%d, numeric=%s", num.decimal, num.digit, num.numeric);

Specifications

• UAX #44: Unicode Character Database, Unicode 17.0.0

Example

mjb_block_info block;

if(mjb_codepoint_block('A', &block) != MJB_STATUS_OK) {
    return 1;
}

// Block: Basic Latin
printf("Block: %s", block.name);

Specifications

• UAX #44: Unicode Character Database, Unicode 17.0.0

Example

mjb_script script = mjb_codepoint_script(0x03A9); // Greek capital omega

// Greek script: yes
printf("Greek script: %s", script == MJB_SC_GREK ? "yes" : "no");

Specifications

• UAX #44: Unicode Character Database, Unicode 17.0.0

Return the explicit Script_Extensions set, or the ordinary Script value when the codepoint has no explicit Script_Extensions entry. Call first with scripts set to NULL to obtain the required count.

Example

size_t count = 0;

if(mjb_codepoint_script_extensions(0x30FC, NULL, &count) != MJB_STATUS_OK) {
    return 1;
}

mjb_script scripts[3];

if(count > 3 || mjb_codepoint_script_extensions(0x30FC, scripts,
    &count) != MJB_STATUS_OK) {
    return 1;
}

// U+30FC has 2 Script_Extensions
printf("U+30FC has %zu Script_Extensions", count);

Related

• mjb_codepoint_script

Specifications

• UAX #24: Unicode Script Property, Unicode 17.0.0

Example

// U+10FFFD valid: yes
printf("U+10FFFD valid: %s", mjb_codepoint_is_valid(0x10FFFD) ? "yes" : "no");

Example

// Letter A is graphic: yes
printf("Letter A is graphic: %s", mjb_codepoint_is_graphic('A') ? "yes" : "no");

Example

// U+0301 is combining: yes
printf("U+0301 is combining: %s", mjb_codepoint_is_combining(0x0301) ? "yes" : "no");

Example

// U+4E00 is a CJK ideograph: yes
printf("U+4E00 is a CJK ideograph: %s", mjb_codepoint_is_cjk_ideograph(0x4E00) ? "yes" : "no");

Example

// U+20000 is a CJK extension ideograph: yes
printf("U+20000 is a CJK extension ideograph: %s", mjb_codepoint_is_cjk_ext(0x20000) ? "yes" : "no");

Example

// Uppercase letters are graphic: yes
bool graphic = mjb_category_is_graphic(MJB_CATEGORY_LU);

// Uppercase letters are graphic: yes
printf("Uppercase letters are graphic: %s", graphic ? "yes" : "no");

Example

// Nonspacing marks are combining: yes
bool combining = mjb_category_is_combining(MJB_CATEGORY_MN);

// Nonspacing marks are combining: yes
printf("Nonspacing marks are combining: %s", combining ? "yes" : "no");

Example

// Greek alpha starts an identifier: yes
bool starts = mjb_codepoint_is_id_start(0x03B1);

// Greek alpha starts an identifier: yes
printf("Greek alpha starts an identifier: %s", starts ? "yes" : "no");

Specifications

• UAX #31: Unicode Identifiers and Syntax, Unicode 17.0.0

Example

// Digit 7 continues an identifier: yes
bool continues = mjb_codepoint_is_id_continue('7');

// Digit 7 continues an identifier: yes
printf("Digit 7 continues an identifier: %s", continues ? "yes" : "no");

Specifications

• UAX #31: Unicode Identifiers and Syntax, Unicode 17.0.0

Example

// Letter A is XID_Start: yes
printf("Letter A is XID_Start: %s", mjb_codepoint_is_xid_start('A') ? "yes" : "no");

Specifications

• UAX #31: Unicode Identifiers and Syntax, Unicode 17.0.0

Example

// Underscore is XID_Continue: yes
bool continues = mjb_codepoint_is_xid_continue('_');

// Underscore is XID_Continue: yes
printf("Underscore is XID_Continue: %s", continues ? "yes" : "no");

Specifications

• UAX #31: Unicode Identifiers and Syntax, Unicode 17.0.0

Example

// Plus sign is Pattern_Syntax: yes
bool syntax = mjb_codepoint_is_pattern_syntax('+');

// Plus sign is Pattern_Syntax: yes
printf("Plus sign is Pattern_Syntax: %s", syntax ? "yes" : "no");

Specifications

• UAX #31: Unicode Identifiers and Syntax, Unicode 17.0.0

Example

// Space is Pattern_White_Space: yes
bool whitespace = mjb_codepoint_is_pattern_white_space(' ');

// Space is Pattern_White_Space: yes
printf("Space is Pattern_White_Space: %s", whitespace ? "yes" : "no");

Specifications

• UAX #31: Unicode Identifiers and Syntax, Unicode 17.0.0

Example

// Red heart is Extended_Pictographic: yes
bool pictographic = mjb_codepoint_is_extended_pictographic(0x2764);

// Red heart is Extended_Pictographic: yes
printf("Red heart is Extended_Pictographic: %s", pictographic ? "yes" : "no");

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

mjb_plane plane = mjb_codepoint_plane(0x1F600);

// U+1F600 is in the SMP: yes
printf("U+1F600 is in the SMP: %s", plane == MJB_PLANE_SMP ? "yes" : "no");

Example

// Plane 16 is valid: yes
printf("Plane 16 is valid: %s", mjb_plane_is_valid(MJB_PLANE_PUA_B) ? "yes" : "no");

Example

// Plane: Basic Multilingual Plane
printf("Plane: %s", mjb_plane_name(MJB_PLANE_BMP, false));

Compare two strings using the Unicode Collation Algorithm and the default collation element table (DUCET), with strcmp-style semantics.

Returns

• < 0 — The first string collates before the second
• 0 — The strings are equal under UCA
• > 0 — The first string collates after the second

Example

int order = mjb_string_compare("apple", 5, MJB_ENC_UTF_8,
    "banana", 6, MJB_ENC_UTF_8, MJB_COLLATION_NON_IGNORABLE);

// apple sorts before banana: yes
printf("apple sorts before banana: %s", order < 0 ? "yes" : "no");

Related

• mjb_collation_key

Specifications

• UTS #10: Unicode Collation Algorithm, Unicode 17.0.0

Generate a binary sort key for a string. Sort keys of different strings can be compared with memcmp and yield the same order as mjb_string_compare. Useful when the same strings are compared many times, such as sorting or database indexing.

Returns

• MJB_STATUS_OK — The sort key was generated
• MJB_STATUS_INVALID_ARGUMENT — result is NULL, or buffer is NULL with a non-zero size
• MJB_STATUS_OVERFLOW — The sort key size would overflow
• MJB_STATUS_NO_MEMORY — Allocation failed

Example

mjb_result key;

if(mjb_collation_key("r\xC3\xA9sum\xC3\xA9", 8, MJB_ENC_UTF_8,
    MJB_COLLATION_NON_IGNORABLE, &key) != MJB_STATUS_OK) {
    return 1;
}

// Sort key is non-empty: yes
printf("Sort key is non-empty: %s", key.output_size > 0 ? "yes" : "no");
mjb_result_free(&key);

Related

• mjb_string_compare

Specifications

• UTS #10: Unicode Collation Algorithm, Unicode 17.0.0

Validate a string as a Unicode identifier: the first character must be a valid identifier start and the following ones valid identifier continuations, using ID_Start/ID_Continue for the DEFAULT profile or XID_Start/XID_Continue for the NFKC profile.

Example

const char *identifier = "delta_2";

bool valid = mjb_string_is_identifier(identifier, strlen(identifier), MJB_ENC_UTF_8,
    MJB_IDENTIFIER_NFKC);

// Valid identifier: yes
printf("Valid identifier: %s", valid ? "yes" : "no");

Related

• mjb_codepoint_is_id_start
• mjb_codepoint_is_id_continue
• mjb_codepoint_is_xid_start
• mjb_codepoint_is_xid_continue

Specifications

• UAX #31: Unicode Identifiers and Syntax, Unicode 17.0.0

Compute the UTS #39 bidiSkeleton(LTR, input): apply the Unicode Bidirectional Algorithm through L4, then NFD, remove default-ignorables, substitute prototypes from confusables.txt, and reapply NFD. Skeletons can be stored or indexed so future confusable checks can compare them directly.

Returns

• MJB_STATUS_OK — The confusable skeleton was returned
• MJB_STATUS_INVALID_ARGUMENT — result is NULL, or buffer is NULL with a non-zero size
• MJB_STATUS_OVERFLOW — The output size would overflow
• MJB_STATUS_NO_MEMORY — Allocation failed

Example

const char *input = "h\xD0\xB5llo"; // Cyrillic U+0435 in place of e
mjb_result result;

if(mjb_confusable_skeleton(input, strlen(input), MJB_ENC_UTF_8, MJB_ENC_UTF_8,
    &result) != MJB_STATUS_OK) {
    return 1;
}

// hello
printf("%.*s", (int)result.output_size, result.output);
mjb_result_free(&result);

Related

• mjb_string_is_confusable
• mjb_string_is_identifier

Specifications

• UTS #39: Unicode Security Mechanisms, Unicode 17.0.0

Compute the confusable skeleton of both strings and return true when the skeletons are equal, meaning the two strings are visually confusable, such as "good" and "gооd" with Cyrillic о.

Example

const char *latin = "hello";
const char *mixed = "h\xD0\xB5llo"; // Cyrillic е

bool confusable = mjb_string_is_confusable(latin, strlen(latin), MJB_ENC_UTF_8,
    mixed, strlen(mixed), MJB_ENC_UTF_8);

// Visually confusable: yes
printf("Visually confusable: %s", confusable ? "yes" : "no");

Related

• mjb_confusable_skeleton
• mjb_string_is_identifier

Specifications

• UTS #39: Unicode Security Mechanisms, Unicode 17.0.0

Example

mjb_next_line_state state;
state.index = 0;
mjb_break_type type = mjb_break_line("Hello world", 11, MJB_ENC_UTF_8, &state);

// First line-break result is set: yes
printf("First line-break result is set: %s", type != MJB_BT_NOT_SET ? "yes" : "no");

Related

• mjb_break_grapheme_cluster
• mjb_break_word
• mjb_break_sentence

Specifications

• UAX #14: Unicode Line Breaking Algorithm, Unicode 17.0.0

Example

mjb_next_word_state state;
state.index = 0;
size_t boundaries = 0;

while(mjb_break_word("Hello world", 11, MJB_ENC_UTF_8, &state) != MJB_BT_NOT_SET) {
    ++boundaries;
}

// Word-break positions: 11
printf("Word-break positions: %zu", boundaries);

Related

• mjb_break_grapheme_cluster
• mjb_break_sentence
• mjb_truncate_word

Specifications

• UAX #29: Unicode Text Segmentation, Unicode 17.0.0

Example

mjb_next_sentence_state state;
state.index = 0;
size_t boundaries = 0;
const char *input = "Hello. Goodbye.";

while(mjb_break_sentence(input, strlen(input), MJB_ENC_UTF_8, &state) != MJB_BT_NOT_SET) {
    ++boundaries;
}

// Sentence-break positions: 15
printf("Sentence-break positions: %zu", boundaries);

Related

• mjb_break_grapheme_cluster
• mjb_break_word

Specifications

• UAX #29: Unicode Text Segmentation, Unicode 17.0.0

Iterate the grapheme cluster (user-perceived character) boundaries of a string. Call repeatedly with the same state until it reports the end of the string.

Example

const char *input = "e\xCC\x81"; // e + combining acute accent
mjb_next_state state;
state.index = 0;
size_t codepoints = 0;

while(mjb_break_grapheme_cluster(input, strlen(input), MJB_ENC_UTF_8,
    &state) != MJB_BT_NOT_SET) {
    ++codepoints;
}

// Codepoints examined: 2
printf("Codepoints examined: %zu", codepoints);

Related

• mjb_break_word
• mjb_break_sentence
• mjb_break_line
• mjb_truncate

Specifications

• UAX #29: Unicode Text Segmentation, Unicode 17.0.0

Example

const char *input = "A\xF0\x9F\x87\xAE\xF0\x9F\x87\xB9Z"; // A🇮🇹Z
size_t bytes = mjb_truncate(input, strlen(input), MJB_ENC_UTF_8, 2);

// First two graphemes use 9 bytes
printf("First two graphemes use %zu bytes", bytes);

Example

const char *input = "Hello world";
size_t bytes = mjb_truncate_word(input, strlen(input), MJB_ENC_UTF_8, 1);

// First word segment uses 5 bytes
printf("First word segment uses %zu bytes", bytes);

Example

const char *input = "Hello world";
size_t bytes = mjb_truncate_word_width(input, strlen(input), MJB_ENC_UTF_8,
    MJB_WIDTH_CONTEXT_WESTERN, 6);

// Six columns include 6 bytes
printf("Six columns include %zu bytes", bytes);

Resolve the embedding levels of a paragraph following the Unicode Bidirectional Algorithm. The resolved paragraph can then be split into lines and reordered visually with mjb_bidi_reorder_line and mjb_bidi_line_runs.

Returns

• MJB_STATUS_OK — The paragraph was resolved
• MJB_STATUS_INVALID_ARGUMENT — result is NULL, or buffer is NULL with a non-zero size
• MJB_STATUS_OVERFLOW — The paragraph size would overflow
• MJB_STATUS_NO_MEMORY — Allocation failed

Example

const char *input = "abc \xD7\x90\xD7\x91\xD7\x92"; // abc אבג
mjb_bidi_paragraph paragraph;

if(mjb_bidi_resolve(input, strlen(input), MJB_ENC_UTF_8, MJB_DIRECTION_AUTO,
    &paragraph) != MJB_STATUS_OK) {
    return 1;
}

// Paragraph codepoints: 7
printf("Paragraph codepoints: %zu", paragraph.count);
mjb_bidi_free(&paragraph);

Related

• mjb_bidi_free
• mjb_bidi_reorder_line
• mjb_bidi_line_runs

Specifications

• UAX #9: Unicode Bidirectional Algorithm, Unicode 17.0.0

Example

const char *input = "\xD7\x90\xD7\x91\xD7\x92"; // אבג
mjb_bidi_paragraph paragraph;
size_t visual_order[3];

if(mjb_bidi_resolve(input, strlen(input), MJB_ENC_UTF_8, MJB_DIRECTION_AUTO,
    &paragraph) != MJB_STATUS_OK ||
    mjb_bidi_reorder_line(&paragraph, 0, paragraph.count,
        visual_order) != MJB_STATUS_OK) {
    return 1;
}

// First visual index: 2
printf("First visual index: %zu", visual_order[0]);
mjb_bidi_free(&paragraph);

Related

• mjb_bidi_resolve
• mjb_bidi_line_runs

Specifications

• UAX #9: Unicode Bidirectional Algorithm, Unicode 17.0.0

Example

mjb_bidi_paragraph paragraph;
size_t visual_order[3];
size_t run_count = 0;

if(mjb_bidi_resolve("abc", 3, MJB_ENC_UTF_8, MJB_DIRECTION_LTR,
    &paragraph) != MJB_STATUS_OK ||
    mjb_bidi_reorder_line(&paragraph, 0, 3, visual_order) != MJB_STATUS_OK ||
    mjb_bidi_line_runs(&paragraph, visual_order, 3, NULL,
        &run_count) != MJB_STATUS_OK) {
    return 1;
}

// Visual runs: 1
printf("Visual runs: %zu", run_count);
mjb_bidi_free(&paragraph);

Related

• mjb_bidi_resolve
• mjb_bidi_reorder_line

Specifications

• UAX #9: Unicode Bidirectional Algorithm, Unicode 17.0.0

Example

mjb_bidi_paragraph paragraph;

if(mjb_bidi_resolve("abc", 3, MJB_ENC_UTF_8, MJB_DIRECTION_LTR,
    &paragraph) != MJB_STATUS_OK) {
    return 1;
}

mjb_bidi_free(&paragraph);

// Paragraph released: yes
printf("Paragraph released: %s", paragraph.chars == NULL ? "yes" : "no");

Related

• mjb_bidi_resolve

Example

mjb_emoji_properties emoji;

if(mjb_codepoint_emoji(0x1F600, &emoji) != MJB_STATUS_OK) {
    return 1;
}

// U+1F600 has Emoji_Presentation: yes
printf("U+1F600 has Emoji_Presentation: %s", emoji.presentation ? "yes" : "no");

Related

• mjb_string_emoji_sequence
• mjb_codepoint_is_emoji

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

// Number sign has the Emoji property: yes
bool emoji = mjb_codepoint_is_emoji('#');

// Number sign has the Emoji property: yes
printf("Number sign has the Emoji property: %s", emoji ? "yes" : "no");

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

// Grinning face defaults to emoji presentation: yes
bool presentation = mjb_codepoint_is_emoji_presentation(0x1F600);

// Grinning face defaults to emoji presentation: yes
printf("Grinning face defaults to emoji presentation: %s", presentation ? "yes" : "no");

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

// Medium skin tone is an emoji modifier: yes
bool modifier = mjb_codepoint_is_emoji_modifier(0x1F3FD);

// Medium skin tone is an emoji modifier: yes
printf("Medium skin tone is an emoji modifier: %s", modifier ? "yes" : "no");

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

// Waving hand accepts an emoji modifier: yes
bool modifier_base = mjb_codepoint_is_emoji_modifier_base(0x1F44B);

// Waving hand accepts an emoji modifier: yes
printf("Waving hand accepts an emoji modifier: %s", modifier_base ? "yes" : "no");

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

// Zero-width joiner is an emoji component: yes
bool component = mjb_codepoint_is_emoji_component(0x200D);

// Zero-width joiner is an emoji component: yes
printf("Zero-width joiner is an emoji component: %s", component ? "yes" : "no");

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

const char *flag = "\xF0\x9F\x87\xAE\xF0\x9F\x87\xB9"; // 🇮🇹
mjb_emoji_sequence emoji;

if(mjb_string_emoji_sequence(flag, strlen(flag), MJB_ENC_UTF_8,
    &emoji) != MJB_STATUS_OK) {
    return 1;
}

// Sequence codepoints: 2
printf("Sequence codepoints: %zu", emoji.codepoint_count);

Related

• mjb_string_is_emoji_sequence
• mjb_string_is_rgi_emoji

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

const char *keycap = "1\xEF\xB8\x8F\xE2\x83\xA3"; // 1️⃣

bool listed = mjb_string_is_emoji_sequence(keycap, strlen(keycap), MJB_ENC_UTF_8);

// Listed emoji sequence: yes
printf("Listed emoji sequence: %s", listed ? "yes" : "no");

Related

• mjb_string_is_rgi_emoji
• mjb_string_emoji_sequence

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

const char *flag = "\xF0\x9F\x87\xAE\xF0\x9F\x87\xB9"; // 🇮🇹

bool rgi = mjb_string_is_rgi_emoji(flag, strlen(flag), MJB_ENC_UTF_8);

// RGI emoji: yes
printf("RGI emoji: %s", rgi ? "yes" : "no");

Related

• mjb_string_is_emoji_sequence
• mjb_string_emoji_sequence

Specifications

• UTS #51: Unicode Emoji, Unicode 17.0.0

Example

const char *input = "A\xE7\x95\x8C"; // A界
size_t bytes = mjb_truncate_width(input, strlen(input), MJB_ENC_UTF_8,
    MJB_WIDTH_CONTEXT_WESTERN, 2);

// Two columns include 1 byte
printf("Two columns include %zu byte", bytes);

Example

mjb_east_asian_width width;

if(mjb_codepoint_east_asian_width(0x754C, &width) != MJB_STATUS_OK) { // 界
    return 1;
}

// U+754C is wide: yes
printf("U+754C is wide: %s", width == MJB_EAW_WIDE ? "yes" : "no");

Related

• mjb_display_width

Specifications

• UAX #11: East Asian Width, Unicode 17.0.0

Compute the number of display columns a string occupies in a terminal, accounting for wide and ambiguous East Asian characters, combining marks, and emoji sequences.

Returns

• MJB_STATUS_OK — The width was computed
• MJB_STATUS_INVALID_ARGUMENT — width is NULL, or buffer is NULL with a non-zero size
• MJB_STATUS_OVERFLOW — The width would overflow

Example

const char *input = "A\xE7\x95\x8C"; // A界
size_t width;

if(mjb_display_width(input, strlen(input), MJB_ENC_UTF_8,
    MJB_WIDTH_CONTEXT_WESTERN, &width) != MJB_STATUS_OK) {
    return 1;
}

// Display columns: 3
printf("Display columns: %zu", width);

Related

• mjb_codepoint_east_asian_width
• mjb_truncate_width

Specifications

• UAX #11: East Asian Width, Unicode 17.0.0

Example

// U+1100 is a leading Jamo: yes
printf("U+1100 is a leading Jamo: %s", mjb_codepoint_is_hangul_l(0x1100) ? "yes" : "no");

Example

// U+1161 is a vowel Jamo: yes
printf("U+1161 is a vowel Jamo: %s", mjb_codepoint_is_hangul_v(0x1161) ? "yes" : "no");

Example

// U+11A8 is a trailing Jamo: yes
printf("U+11A8 is a trailing Jamo: %s", mjb_codepoint_is_hangul_t(0x11A8) ? "yes" : "no");

Example

// U+1100 is Hangul Jamo: yes
printf("U+1100 is Hangul Jamo: %s", mjb_codepoint_is_hangul_jamo(0x1100) ? "yes" : "no");

Example

// U+AC00 is a Hangul syllable: yes
printf("U+AC00 is a Hangul syllable: %s", mjb_codepoint_is_hangul_syllable(0xAC00) ? "yes" : "no");

Example

char name[32];

if(mjb_hangul_syllable_name(0xAC01, name, sizeof(name)) != MJB_STATUS_OK) {
    return 1;
}

// Name: HANGUL SYLLABLE GAG
printf("Name: %s", name);

Example

mjb_codepoint decomposition[3];

if(mjb_hangul_syllable_decomposition(0xAC01,
    decomposition) != MJB_STATUS_OK) {
    return 1;
}

// Decomposition starts with: U+1100
printf("Decomposition starts with: U+%04X", decomposition[0]);

Example

mjb_buffer_character characters[] = {
    { 0x1100, 0 }, // choseong kiyeok
    { 0x1161, 0 }, // jungseong a
    { 0x11A8, 0 }  // jongseong kiyeok
};
size_t length = mjb_hangul_syllable_composition(characters, 3);

// Composition: U+AC01
printf("Composition: U+%04X", length == 1 ? characters[0].codepoint : 0);

Example

const char *name = mjb_property_name(MJB_PR_ALPHABETIC);

// Property: Alphabetic
printf("Property: %s", name);

Specifications

• UAX #44: Unicode Character Database, Unicode 17.0.0

Parse a BCP 47 language tag, such as sr-Latn-RS, into its components: language, extended language, script, region, variant, extensions, private use, and grandfathered tags. Parsing is strict: malformed tags are rejected and error is filled with the failure reason.

Returns

• MJB_STATUS_OK — The tag was parsed and locale filled
• MJB_STATUS_INVALID_ARGUMENT — An argument is NULL or the tag is not a valid BCP 47 language tag
• MJB_STATUS_NO_MEMORY — Allocation failed

Example

mjb_locale_id locale;
mjb_error error;

if(mjb_locale_parse("sr-Latn-RS", 10, MJB_ENC_UTF_8, &locale,
    &error) != MJB_STATUS_OK) {
    return 1;
}

// Locale: sr Latn RS
printf("Locale: %s %s %s", locale.language, locale.script, locale.region);

Related

• mjb_locale_set

Specifications

• BCP 47: Tags for Identifying Languages

Set the process-global locale used by mjb_case. The default locale is MJB_LOCALE_EN, and mjb_shutdown resets it to MJB_LOCALE_EN. Only MJB_LOCALE_TR, MJB_LOCALE_AZ, and MJB_LOCALE_LT currently tailor casing. Other valid locale values are accepted but do not change Unicode algorithm behavior.

Returns

• MJB_STATUS_OK — The locale was set
• MJB_STATUS_INVALID_ARGUMENT — locale is not a valid mjb_locale value

Example

if(mjb_locale_set(MJB_LOCALE_TR) != MJB_STATUS_OK) {
    return 1;
}

// Turkish locale selected: yes
printf("Turkish locale selected: yes");
if(mjb_locale_set(MJB_LOCALE_EN) != MJB_STATUS_OK) {
    return 1;
}

Related

• mjb_case

Free the memory allocated for a mjb_result. The result pointer is set to NULL.

Returns

• MJB_STATUS_OK — The result was freed
• MJB_STATUS_INVALID_ARGUMENT — result is NULL

Example

mjb_result result;

if(mjb_string_convert_encoding("A", 1, MJB_ENC_UTF_8, MJB_ENC_UTF_16LE,
    &result) != MJB_STATUS_OK || mjb_result_free(&result) != MJB_STATUS_OK) {
    return 1;
}

// Result released: yes
printf("Result released: %s", result.output == NULL ? "yes" : "no");

Output the current library version as a string, such as "1.0.0".

Example

const char *version = mjb_version();

// Version is available: yes
printf("Version is available: %s", version[0] != '\0' ? "yes" : "no");

Related

• mjb_version_number
• mjb_unicode_version

Output the current library version number as an unsigned integer.

Example

unsigned int version = mjb_version_number();

// Version number is positive: yes
printf("Version number is positive: %s", version > 0 ? "yes" : "no");

Related

• mjb_version
• mjb_unicode_version

Output the current supported Unicode version as a string, such as "15.0.0".

Example

const char *version = mjb_unicode_version();

// Unicode version: 17.0.0
printf("Unicode version: %s", version);

Related

• mjb_version
• mjb_version_number

Replace the allocator used by the library for all internal allocations and for the buffers returned in mjb_result. Must be called before any other library call.

Example

mjb_shutdown(); // Ensure no allocator is currently locked in.

if(mjb_set_memory_functions(malloc, realloc, free) != MJB_STATUS_OK) {
    return 1;
}

// Standard allocator installed: yes
printf("Standard allocator installed: yes");
mjb_shutdown();

Related

• mjb_alloc
• mjb_realloc
• mjb_free

Example

mjb_shutdown();

// Library state reset: yes
printf("Library state reset: yes");

Allocate memory using the allocator set by mjb_set_memory_functions. If no allocator is set, the default allocator is used.

Example

char *buffer = (char*)mjb_alloc(32);

if(buffer == NULL) {
    return 1;
}

strcpy(buffer, "allocated");

// Buffer: allocated
printf("Buffer: %s", buffer);
mjb_free(buffer);

Related

• mjb_realloc
• mjb_free

Reallocate memory using the allocator set by mjb_set_memory_functions. If no allocator is set, the default allocator is used.

Example

char *buffer = (char*)mjb_alloc(8);

if(buffer == NULL) {
    return 1;
}

char *larger = (char*)mjb_realloc(buffer, 32);

if(larger == NULL) {
    mjb_free(buffer);
    return 1;
}

// Reallocation succeeded: yes
printf("Reallocation succeeded: yes");
mjb_free(larger);

Related

• mjb_alloc
• mjb_free

Free memory using the allocator set by mjb_set_memory_functions. If no allocator is set, the default allocator is used.

Example

void *memory = mjb_alloc(16);

if(memory == NULL) {
    return 1;
}

mjb_free(memory);

// Memory freed: yes
printf("Memory freed: yes");

Related

• mjb_alloc
• mjb_realloc