StrForeachInRangeIdx

Documentation

API Reference

Description

Iterate over characters in a specific range of the given Str str at each index idx. This macro is a direct alias for VecForeachInRangeIdx specialized for Str. The variables chr and idx are declared and defined by the underlying macro.

Parameters

Name	Direction	Description
`str`	in,out	Str to iterate over.
`chr`	in	Name of variable to be used which’ll contain character at iterated index `idx`.
`idx`	in	Name of variable to be used for iterating over indices.
`start`	in	Starting index (inclusive).
`end`	in	Ending index (exclusive).

Usage example (Cross-references)

Usage examples (Cross-references)

In Str.c:568:

                    if (start < end) {
                        size_t total_len = 0;
                        StrForeachInRangeIdx(str, ch, idx, start, end) {
                            total_len += 1 + idx;
                        }

In Str.Foreach.c:254:

    // Test StrForeachInRangeIdx macro
    bool test_str_foreach_in_range_idx(void) {
        WriteFmt("Testing StrForeachInRangeIdx\n");
    
        Str s = StrInitFromZstr("Hello World");

In Str.Foreach.c:260:

        // Build a new string by iterating through a range of characters with indices
        Str result = StrInit();
        StrForeachInRangeIdx(&s, chr, idx, 6, 11) {
            // Append the character and its index to the result string
            StrWriteFmt(&result, "{c}{}", chr, idx);

In Str.Foreach.c:270:

        // Test with empty range
        Str empty_result = StrInit();
        StrForeachInRangeIdx(&s, chr, idx, 3, 3) {
            // This block should not execute
            StrPushBack(&empty_result, chr);

In Str.Foreach.c:376:

    // Make idx go out of bounds in StrForeachInRangeIdx by shrinking string during iteration
    bool test_str_foreach_out_of_bounds_access(void) {
        WriteFmt("Testing StrForeachInRangeIdx where idx goes out of bounds\n");
    
        Str s = StrInitFromZstr("Hello World!"); // 12 characters

In Str.Foreach.c:383:

        // Even if we shrink the string, the loop will continue until idx reaches the fixed end
        size original_length = s.length; // Capture this as 12
        StrForeachInRangeIdx(&s, chr, idx, 0, original_length) {
            WriteFmt("Accessing idx {} (s.length={}): '{c}'\n", idx, s.length, chr);

In Str.Foreach.c:409:

    // Make idx go out of bounds in StrForeachInRangeIdx by deleting characters
    bool test_str_foreach_idx_out_of_bounds_access(void) {
        WriteFmt("Testing StrForeachInRangeIdx with character deletion where idx goes out of bounds\n");
    
        Str s = StrInitFromZstr("Programming"); // 11 characters

In Str.Foreach.c:416:

        // when we delete characters during iteration
        size original_length = s.length; // Capture this as 11
        StrForeachInRangeIdx(&s, chr, idx, 0, original_length) {
            WriteFmt("Accessing idx {} (s.length={}): '{c}'\n", idx, s.length, chr);

Last updated on April 20, 2026

StrForeachInRange StrForeachPtr