BitVecForeach

Macro
August 22, 2025

Table of Contents

`BitVecForeach`

Description

Iterate over each bit var of the given bitvector bv. This is a convenience macro that iterates forward using an internally managed index. The variable var is declared and defined by this macro.

Parameters

Name	Direction	Description
`bv`	in,out	Bitvector to iterate over.
`var`	in	Name of the variable to be used which will contain the value of the current bit during iteration. The type of `var` will be `bool`.

Success

The body is executed for each bit of the bitvector bv from the beginning to the end.

Failure

If the bitvector bv is NULL or its length is zero, the loop body will not be executed. Any failures within the BitVecForeachIdx macro (like invalid index access) will result in a fatal log message and program termination.

Usage example (Cross-references)

In _e,

In
In
In
In
In
In
In
In
In rogrammer/MisraStdC/blob/master/Include/Misra/Std/Container/BitVec/Foreach.h#L139 target=_blank>Foreach.h:139:
LOG_FATAL( \ "BitVec range overflow: End index {} exceeds bitvector length {}. " \ "If you intended to iterate over all bits, use BitVecForeach instead.", \ \ (bv)->length \ BitVec.Foreach.c:69:
// Test BitVecForeach macro style=color:#75715e> bool test_bitvec_foreach(void) { printf("Testing BitVecForeach macro\n"); BitVec bv = BitVecInit();BitVec.Foreach.c:82:
u64 false_count = 0; BitVecForeach(&bv, bit, { if (bit) { true_count++; BitVec.Foreach.c:239:
// Test foreach on empty bitvec style=color:#75715e> BitVecForeach(&bv, bit, { (void)bit; count++; // Should not execute BitVec.Foreach.c:248:
BitVecPush(&bv, true); count = 0; BitVecForeach(&bv, bit, { count++; result = result && (bit == true); BitVec.Foreach.c:261:
count = 0; BitVecForeach(&bv, bit, { (void)bit; count++; BitVec.Foreach.c:411:
int count1 = 0, count2 = 0, count3 = 0, count4 = 0; BitVecForeach(&bv, bitval, { (void)bitval; count1++; BitVec.Foreach.c:703:
// This should abort due to ValidateBitVec check style=color:#75715e> int count = 0; BitVecForeach(&bv, bit, { (void)bit; count++; BitVec.Foreach.Simple.c:69:

    // Test BitVecForeach macro style=color:#75715e>    bool test_bitvec_foreach(void) { printf("Testing BitVecForeach macro\n");

BitVec bv = BitVecInit(); BitVec.Foreach.Simple.c:82:

    u64 false_count = 0;

BitVecForeach(&bv, bit, { if (bit) { true_count++; BitVec.Foreach.Simple.c:239: // Test foreach on empty bitvec style=color:#75715e>    BitVecForeach(&bv, bit, { (void)bit; count++; // Should not execute BitVec.Foreach.Simple.c:248:    BitVecPush(&bv, true); count = 0; BitVecForeach(&bv, bit, { count++; result = result && (bit == true); BitVec.Foreach.Simple.c:261: count = 0; BitVecForeach(&bv, bit, { (void)bit; count++; BitVec.Foreach.Simple.c:411:    int count1 = 0, count2 = 0, count3 = 0, count4 = 0;

BitVecForeach(&bv, bitval, { (void)bitval; count1++; BitVec.Foreach.Deadend.c:86:    // This should abort due to ValidateBitVec check style=color:#75715e>    int count = 0; BitVecForeach(&bv, bit, { (void)bit; count++;
Share :