MisraStdC

BitVecByteSize

Macro

BitVecByteSize Description Get u64 of bitvector in bytes. This returns the actual memory used by the bit data.

BitVecCapacity

Macro

BitVecCapacity Description Get capacity of bitvector in bits.

BitVecEmpty

Macro

BitVecEmpty Description Check if bitvector is empty.

Scope Description Run a scoped block and automatically deinitialize the object at the end. Executes scope_body and ensures obj_deinit(obj) is called afterward, regardless of the block’s control flow. This is similar to RAII-style resource management in C++ but implemented manually via a macro. The object is passed by pointer. It is not copied or moved. This macro ensures the object is only evaluated once by capturing it internally using TYPE_OF. The memory pointed to by obj is not cleared after deinitialization; if zeroing is needed, do it inside obj_deinit. Parameters:

ValidateVec

Macro

ValidateVec Description Validate whether a given Vec object is valid. Not foolproof but will work most of the time. Aborts if provided Vec is not valid.

VecAlignedOffsetAt

Macro

VecAlignedOffsetAt Description Vector implementation already manages alignment for stored objects. It makes sure that objects of improper size are stored at alignment of 8 bytes each to avoid UB.

VecAt

Macro

VecAt Description Value at given index in a vector. It’s strongly recommended to always use this instead of directly accessing the data.

VecBegin

Macro

VecBegin Description Pointer to first element in vector

VecClear

Macro

VecClear Description Clear vec contents.

VecDeinit

Macro

VecDeinit Description Deinit vec by freeing all allocations.

VecDelete

Macro

VecDelete Description Delete item at given index

VecDeleteFast

Macro

VecDeleteFast Description Delete item at given index using faster implementation. Order preservation is not guaranteed

VecDeleteLast

Macro

VecDeleteLast Description Delete last item from vec

VecDeleteRange

Macro

VecDeleteRange Description Delete items in given range [start, start + count)

VecDeleteRangeFast

Macro

VecDeleteRangeFast Description Delete items in given range [start, start + count) using faster implementation. Order preservation is not guaranteed

VecEnd

Macro

VecEnd Description Pointer at the end (after last element) of vector

VecFirst

Macro

VecFirst Description Value of first element in vector.

VecForeach

Macro

VecForeach Description Iterate over each element var of the given vector v. This is a convenience macro that iterates forward using an internally managed index. The variable var is declared and defined by this macro.

VecForeachIdx

Macro

VecForeachIdx Description Iterate over each element var of given vector v at each index idx into the vector. The variables var and idx declared and defined by this macro. idx will start from 0 and will go till v->length - 1

VecForeachInRange

Macro

VecForeachInRange Description Iterate over elements in a specific range of the given vector v. This is a convenience macro that iterates over a range using an internally managed index. The variable var is declared and defined by this macro.

VecForeachInRangeIdx

Macro

VecForeachInRangeIdx Description Iterate over elements in a specific range of the given vector v at each index idx. The variables var and idx are declared and defined by this macro. idx will start from start and will go till end - 1

VecForeachPtr

Macro

VecForeachPtr Description Iterate over each element var of the given vector v (as a pointer). This is a convenience macro that iterates forward using an internally managed index and provides a pointer to each element. The variable var is declared and defined by this macro as a pointer to the vector’s data type.

VecForeachPtrIdx

Macro

VecForeachPtrIdx Description Iterate over each element var of given vector v at each index idx into the vector. The variables var and idx declared and defined by this macro. idx will start from 0 and will go till v->length - 1

VecForeachPtrInRange

Macro

VecForeachPtrInRange Description Iterate over elements in a specific range of the given vector v (as pointers). This is a convenience macro that iterates over a range using an internally managed index and provides a pointer to each element. The variable var is declared and defined by this macro as a pointer to the vector’s data type.

VecForeachPtrInRangeIdx

Macro

VecForeachPtrInRangeIdx Description Iterate over elements in a specific range of the given vector v at each index idx (as pointers). The variables var and idx are declared and defined by this macro. idx will start from start and will go till end - 1

VecForeachPtrReverse

Macro

VecForeachPtrReverse Description Iterate over each element var (as a pointer) of the given vector v in reverse order. This is a convenience macro that iterates backward using an internally managed index and provides a pointer to each element. The variable var is declared and defined by this macro as a pointer to the vector’s data type.

VecForeachPtrReverseIdx

Macro

VecForeachPtrReverseIdx Description Iterate over each element var of given vector v at each index idx into the vector. The variables var and idx declared and defined by this macro. idx will start from v->length - 1 and will go till 0

VecForeachReverse

Macro

VecForeachReverse Description Iterate over each element var of the given vector v in reverse order. This is a convenience macro that iterates backward using an internally managed index. The variable var is declared and defined by this macro.

VecForeachReverseIdx

Macro

VecForeachReverseIdx Description Iterate over each element var of given vector v at each index idx into the vector. The variables var and idx declared and defined by this macro. idx will start from v->length - 1 and will go till 0

VecInit

Macro

VecInit Description Initialize vector. Default alignment is 1 It is mandatory to initialize vectors before use. Not doing so is undefined behaviour.

VecInitAligned

Macro

VecInitAligned Description Initialize vector with given alignment. It is mandatory to initialize vectors before use. Not doing so is undefined behaviour. Provided alignment is used to keep all objects at an aligned memory location, avoiding UB in some cases. It’s recommended to use aligned vector when dealing with structs containing unions.

VecInitAlignedStack

Macro

VecInitAlignedStack Description Initialize given vector with given alignment. It is mandatory to initialize vectors before use. Not doing so is undefined behaviour. Provided alignment is used to keep all objects at an aligned memory location, avoiding UB in some cases. It’s recommended to use aligned vector when dealing with structs containing unions. These vectors are best used where user doesn’t get a chance to or does not want to deinit vector, given that no data in vector needs to be deinitialized. Example includes, but does not limit to a Vec(i8), Vec(f32), etc…

VecInitAlignedT

Macro

VecInitAlignedT Description Initialize given vector with given alignment. It is mandatory to initialize vectors before use. Not doing so is undefined behaviour. Provided alignment is used to keep all objects at an aligned memory location, avoiding UB in some cases. It’s recommended to use aligned vector when dealing with structs containing unions.

VecInitAlignedWithDeepCopy

Macro

VecInitAlignedWithDeepCopy Description Initialize vector with given alignment. It is mandatory to initialize vectors before use. Not doing so is undefined behaviour. Provided alignment is used to keep all objects at an aligned memory location, avoiding UB in some cases. It’s recommended to use aligned vector when dealing with structs containing unions.

VecInitAlignedWithDeepCopyStack

Macro

VecInitAlignedWithDeepCopyStack Description Initialize given vector with given alignment. It is mandatory to initialize vectors before use. Not doing so is undefined behaviour. Provided alignment is used to keep all objects at an aligned memory location, avoiding UB in some cases. It’s recommended to use aligned vector when dealing with structs containing unions. These vectors are best used where user doesn’t get a chance to or does not want to deinit vector, given that no data in vector needs to be deinitialized. Example includes, but does not limit to a Vec(i8), Vec(f32), etc…

VecInitClone

Macro

VecInitClone Description Initialize clone of vector from vs to vd.

VecInitStack

Macro

VecInitStack Description Initialize given vector using memory from stack. Such vectors cannot be dynamically resized. Doing so is UB. It is mandatory to initialize vectors before use. Not doing so is undefined behaviour. These vectors are best used where user doesn’t get a chance to or does not want to deinit vector, given that no data in vector needs to be deinitialized. Example includes, but does not limit to a Vec(i8), Vec(f32), etc… Stack inited vectors mustn’t be deinited after use.

VecInitT

Macro

VecInitT Description Initialize given vector. Default alignment is 1 It is mandatory to initialize vectors before use. Not doing so is undefined behaviour.

VecInitWithDeepCopy

Macro

VecInitWithDeepCopy Description Initialize vector. Default alignment is 1 It is mandatory to initialize vectors before use. Not doing so is undefined behaviour.

VecInitWithDeepCopyStack

Macro

VecInitWithDeepCopyStack Description Initialize given vector using memory from stack. Such vectors cannot be dynamically resized. Doing so is UB. It is mandatory to initialize vectors before use. Not doing so is undefined behaviour. These vectors are best used where user doesn’t get a chance to or does not want to deinit vector, given that no data in vector needs to be deinitialized. Example includes, but does not limit to a Vec(i8), Vec(f32), etc… Stack inited vectors mustn’t be deinited after use.

VecInitWithDeepCopyT

Macro

VecInitWithDeepCopyT Description Initialize given vector. Default alignment is 1 It is mandatory to initialize vectors before use. Not doing so is undefined behaviour.

VecInsert

Macro

VecInsert Description Insert by default behaves like VecInsertL, which is to insert an l-value into vector and then take ownership if vector does not have a copy-init method.

VecInsertFast

Macro

VecInsertFast Description By default this behaves like inserting an l-value using VecInsertFastL

VecInsertFastL

Macro

VecInsertFastL Description Quickly insert item into vector. Ordering of elements is not guaranteed to be preserved. This call makes significant difference only for sufficiently large vectors and when idx is quite less than (v)->length. Insertion time is guaranteed to be constant for same data types. Usage is exactly same as VecInsert, just the internal implementation is different.

VecInsertFastR

Macro

VecInsertFastR Description Quickly insert item into vector. Ordering of elements is not guaranteed to be preserved. This call makes significant difference only for sufficiently large vectors and when idx is quite less than (v)->length. Insertion time is guaranteed to be constant for same data types. Usage is exactly same as VecInsert, just the internal implementation is different.

VecInsertL

Macro

VecInsertL Description Insert an l-value into vector of it’s type. Insertion index must not exceed vector length. This preserves the ordering of elements. Best to be used with sorted vectors, if the sorted property is to be preserved.

VecInsertR

Macro

VecInsertR Description Insert an r-value into vector of it’s type. Insertion index must not exceed vector length. This preserves the ordering of elements. Best to be used with sorted vectors, if the sorted property is to be preserved. In worst case this would to to O(n)

VecInsertRange

Macro

VecInsertRange Description Insert array of items into vector of it’s type. By default, this uses L-value semantics (ownership transfer). Insertion index must not exceed vector length. This preserves the ordering of elements. Best to be used with sorted vectors, if the sorted property is to be preserved.

VecInsertRangeFast

Macro

VecInsertRangeFast Description Quickly insert array of items into vector. By default, this uses L-value semantics (ownership transfer). Ordering of elements is not guaranteed to be preserved. This call makes significant difference only for sufficiently large vectors and when idx is quite less than (v)->length. Insertion time is guaranteed to be constant for same data types.

VecInsertRangeFastL

Macro

VecInsertRangeFastL Description Quickly insert array of items into vector, with L-value semantics. Ordering of elements is not guaranteed to be preserved. This call makes significant difference only for sufficiently large vectors and when idx is quite less than (v)->length. Insertion time is guaranteed to be constant for same data types.

VecInsertRangeFastR

Macro

VecInsertRangeFastR Description Quickly insert array of items into vector, with R-value semantics. Ordering of elements is not guaranteed to be preserved. This call makes significant difference only for sufficiently large vectors and when idx is quite less than (v)->length. Insertion time is guaranteed to be constant for same data types.

VecInsertRangeL

Macro

VecInsertRangeL Description Insert array of items into vector, with L-value semantics. Insertion index must not exceed vector length. This preserves the ordering of elements. Best to be used with sorted vectors, if the sorted property is to be preserved.

VecInsertRangeR

Macro

VecInsertRangeR Description Insert array of items into vector, with R-value semantics. Insertion index must not exceed vector length. This preserves the ordering of elements. Best to be used with sorted vectors, if the sorted property is to be preserved.

VecLast

Macro

VecLast Description Value of last element in vector.

VecLen

Macro

VecLen Description Length of vector.

VecMerge

Macro

VecMerge Description Merge two vectors and store the result in the first vector. Data is copied from v2 into v. If a copy_init method is provided in v, each element from v2 will be copied using that method. Otherwise, a raw memory copy is performed, which may be unsafe for complex or pointer-containing data.

VecMergeL

Macro

VecMergeL Description Merge two vectors and store the result in the first vector, with L-value semantics. Data is copied from v2 into v. If a copy_init method is provided in v, each element from v2 will be copied using that method. Otherwise, a raw memory copy is performed, which may be unsafe for complex or pointer-containing data.

VecMergeR

Macro

VecMergeR Description Merge two vectors and store the result in the first vector, with R-value semantics. Data is copied from v2 into v. If a copy_init method is provided in v, each element from v2 will be copied using that method. Otherwise, a raw memory copy is performed, which may be unsafe for complex or pointer-containing data.

VecPopBack

Macro

VecPopBack Description Pop item from vector back.

VecPopFront

Macro

VecPopFront Description Pop item from vector front.

VecPtrAt

Macro

VecPtrAt Description Value at given index in a vector. It’s strongly recommended to always use this instead of directly accessing the data.

VecPushBack

Macro

VecPushBack Description Push item into vector back. Default behaviour is same as VecPushBackL

VecPushBackArr

Macro

VecPushBackArr Description Push a complete array into this vector. By default, this uses L-value semantics (ownership transfer).

VecPushBackArrL

Macro

VecPushBackArrL Description Push a complete array into this vector, with L-value semantics.

VecPushBackArrR

Macro

VecPushBackArrR Description Push a complete array into this vector, with R-value semantics.

VecPushBackL

Macro

VecPushBackL Description Push an l-value into vector back.

VecPushBackR

Macro

VecPushBackR Description Push item into vector back.

VecPushFront

Macro

VecPushFront Description Push item into vector front.

VecPushFrontArr

Macro

VecPushFrontArr Description Push a complete array into this vector front. By default, this uses L-value semantics (ownership transfer).

VecPushFrontArrFast

Macro

VecPushFrontArrFast Description Push a complete array into this vector front without preserving the order of elements in vector. By default, this uses L-value semantics (ownership transfer).

VecPushFrontArrFastL

Macro

VecPushFrontArrFastL Description Push a complete array into this vector front without preserving the order of elements in vector, with L-value semantics.

VecPushFrontArrFastR

Macro

VecPushFrontArrFastR Description Push a complete array into this vector front without preserving the order of elements in vector, with R-value semantics.

VecPushFrontArrL

Macro

VecPushFrontArrL Description Push a complete array into this vector front, with L-value semantics.

VecPushFrontArrR

Macro

VecPushFrontArrR Description Push a complete array into this vector front, with R-value semantics.

VecPushFrontL

Macro

VecPushFrontL Description Push item into vector front.

VecPushFrontR

Macro

VecPushFrontR Description Push item into vector front.

VecRemove

Macro

VecRemove Description Remove item from vector at given index and store in given pointer. Order of elements is guaranteed to be preserved.

VecRemoveFast

Macro

VecRemoveFast Description Remove item from vector at given index and store in given pointer. Order of elements inside vector is not guaranteed to be preserved. The implementation is faster in some scenarios that VecRemove

VecRemoveRange

Macro

VecRemoveRange Description Remove data from vector in given range [start, start + count) Order of elements is guaranteed to be preserved.

VecRemoveRangeFast

Macro

VecRemoveRangeFast Description Remove item from vector at given index and store in given pointer. Order of elements inside vector is not guaranteed to be preserved. The implementation is faster in some scenarios that VecRemove

VecReserve

Macro

VecReserve Description Reserve space for vector.

VecResize

Macro

VecResize Description Resize vector. If length is smaller than current capacity, vector length is shrinked. If length is greater than current capacity, space is reserved and vector is expanded.

VecReverse

Macro

VecReverse Description Reverse contents of this vector.

VecSize

Macro

VecSize Description Size of vector in bytes. Use this instead of multiplying size of item with vector length!

VecSort

Macro

VecSort Description Sort given vector with given comparator using quicksort algorithm.

VecSwapItems

Macro

VecSwapItems Description Swap items at given indices.

VecTryReduceSpace

Macro

VecTryReduceSpace Description Try reducing memory footprint of vector. This is to be used when we know actual allocated memory for vec is large, and we won’t need it in future, so we can reduce it to whatever’s required at the moment.

ALIGN_DOWN

Macro

ALIGN_DOWN Description Aligns the given value down to the nearest multiple of alignment.

ALIGN_DOWN_POW2

Macro

ALIGN_DOWN_POW2 Description Aligns the given value down to the nearest power-of-two multiple.

ALIGN_UP

Macro

ALIGN_UP Description Aligns the given value up to the nearest multiple of alignment.

ALIGN_UP_POW2

Macro

ALIGN_UP_POW2 Description Aligns the given value up to the nearest power-of-two multiple.

APPLY_MACRO_FOREACH

Macro

APPLY_MACRO_FOREACH Description Expand variadic argument list for given macro for each element one by one. This is a macro trick to apply a given macro on a variadic argument list one by one. The only limitiation here is that we cannot expand more than 256 times for the moment. To make it do more than that, we just need to add one more line to the EXPAND macros Also, if you have more than 20-30 arguments in your format strings, you should seriously consider whether you’re doing something wrong Reference : https://www.scs.stanford.edu/~dm/blog/va-opt.html

APPLY_MACRO_FOREACH_AGAIN

Macro

APPLY_MACRO_FOREACH_AGAIN Description Helper macro to delay evaluation in text generation (pre-processing) phase of macro

APPLY_MACRO_FOREACH_HELPER

Macro

APPLY_MACRO_FOREACH_HELPER Description Helper macro to apply given macro to the very first argument in list of variadic macro arguments Then expands to applying the same macro to more arguments only if there are more

BitVecForeach

Macro

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.

BitVecForeachIdx

Macro

BitVecForeachIdx Description Iterate over each bit var of given bitvector bv at each index idx into the bitvector. The variables var and idx declared and defined by this macro. idx will start from 0 and will go till bv->length - 1

BitVecForeachInRange

Macro

BitVecForeachInRange Description Iterate over bits in a specific range of the given bitvector bv. This is a convenience macro that iterates over a range using an internally managed index. The variable var is declared and defined by this macro.

BitVecForeachInRangeIdx

Macro

BitVecForeachInRangeIdx Description Iterate over bits in a specific range of the given bitvector bv at each index idx. The variables var and idx are declared and defined by this macro. idx will start from start and will go till end - 1

BitVecForeachReverse

Macro

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

BitVecForeachReverseIdx

Macro

BitVecForeachReverseIdx Description Iterate over each bit var of given bitvector bv at each index idx into the bitvector. The variables var and idx declared and defined by this macro. idx will start from bv->length - 1 and will go till 0

BitVecLen

Macro

BitVecLen Description Get number of bits currently in bitvector.

CLAMP

Macro

CLAMP Description Clamps the value of x to be within the inclusive range [lo, hi].

FReadFmt

Macro

FReadFmt Description Read formatted data from a file stream. This is a macro wrapper around FReadFmtInternal.

FREE

Macro

FREE Description Safely deallocates memory and nullifies pointer.

FROM_BIG_ENDIAN2

Macro

FROM_BIG_ENDIAN2 Description Conditionally converts value from big-endian to native byte order. On little-endian systems, this inverts the byte order. On big-endian systems, this is a no-op.

FROM_BIG_ENDIAN4

Macro

FROM_BIG_ENDIAN4 Description Conditionally converts value from big-endian to native byte order. On little-endian systems, this inverts the byte order. On big-endian systems, this is a no-op.

FROM_BIG_ENDIAN8

Macro

FROM_BIG_ENDIAN8 Description Conditionally converts value from big-endian to native byte order. On little-endian systems, this inverts the byte order. On big-endian systems, this is a no-op.

FROM_LITTLE_ENDIAN2

Macro

FROM_LITTLE_ENDIAN2 Description Conditionally converts value from little-endian to native byte order. On big-endian systems, this inverts the byte order. On little-endian systems, this is a no-op.

FROM_LITTLE_ENDIAN4

Macro

FROM_LITTLE_ENDIAN4 Description Conditionally converts value from little-endian to native byte order. On big-endian systems, this inverts the byte order. On little-endian systems, this is a no-op.

FROM_LITTLE_ENDIAN8

Macro

FROM_LITTLE_ENDIAN8 Description Conditionally converts value from little-endian to native byte order. On big-endian systems, this inverts the byte order. On little-endian systems, this is a no-op.

FWriteFmt

Macro

FWriteFmt Description Write formatted output to a file stream. This macro internally uses StrWriteFmtInternal to format the string and then writes it to the stream.

FWriteFmtLn

Macro

FWriteFmtLn Description Write formatted output to a file stream followed by a newline character. This macro internally uses StrWriteFmtInternal to format the string and then writes it to the stream followed by a newline.

IN_RANGE

Macro

IN_RANGE Description Checks if the value x is within the inclusive range [lo, hi].

INVERT_ENDIANNESS2

Macro

INVERT_ENDIANNESS2 Description Inverts endianness of 16-bit (2-byte) value.

INVERT_ENDIANNESS4

Macro

INVERT_ENDIANNESS4 Description Inverts endianness of 32-bit (4-byte) value.

INVERT_ENDIANNESS8

Macro

INVERT_ENDIANNESS8 Description Inverts endianness of 64-bit (8-byte) value.

IOFMT_LVAL_APPEND_COMMA

Macro

IOFMT_LVAL_APPEND_COMMA Description Helper macro to append a comma after wrapping given argument in IOFMT Used in following macros

IS_ALPHA

Macro

IS_ALPHA Description Checks if the given character c is an ASCII alphabet.

IS_CAPS_ALPHA

Macro

IS_CAPS_ALPHA Description Checks if the given character c is an uppercase ASCII alphabet.

IS_DIGIT

Macro

IS_DIGIT Description Checks if the given character c is an ASCII digit.

IS_LITTLE_ENDIAN

Macro

IS_LITTLE_ENDIAN Description Compile-time endianness detection.

IS_PRINTABLE

Macro

IS_PRINTABLE Description Checks whether a given character ‘c’ is printable ascii or not.

IS_SPACE

Macro

IS_SPACE Description Checks if the given character c is a whitespace character.

IS_XDIGIT

Macro

IS_XDIGIT Description Checks if the given character c is a hexadecimal digit.

Iter

Macro

Iter Description Memory iterators are there to allow reading regions of memory by remembering current read position and the size limit. With proper checking we can guarantee that we can never overflow or underflow when reading a memory region This also means that Iter objects are created for use with only one reading operation, and one object in their lifetime. The designed API does not allow modifications to the data Iter is iterating over FIELDS: - data : Pointer to memory we’re iterating over - length : Number of objects in memory. - pos : Current iterating position. - size : Alignment requirements (if-any), must be at-least 1 - dir : Iteration direction, -1 or 1

ITER_DATA_TYPE

Macro

ITER_DATA_TYPE Description Get data type of Iter elements

IterInit

Macro

IterInit Description Initialize default Iter object to iterate in forward direction.

IterInitAligned

Macro

IterInitAligned Description Initialize Iter with custom alignment to iterate in forward direction.

IterInitAlignedT

Macro

IterInitAlignedT Description Initialize Iter with custom alignment to iterate in forward direction.

IterInitFromVec

Macro

IterInitFromVec Description Initialize Iter from vector data to iterate in forward direction.

IterInitFromVecT

Macro

IterInitFromVecT Description Initialize Iter from vector data to iterate in forward direction.

IterInitRev

Macro

IterInitRev Description Initialize default Iter object to iterate in backward direction.

IterInitRevAligned

Macro

IterInitRevAligned Description Initialize Iter with custom alignment to iterate in backward direction.

IterInitRevAlignedT

Macro

IterInitRevAlignedT Description Initialize Iter with custom alignment to iterate in backward direction.

IterInitRevFromVec

Macro

IterInitRevFromVec Description Initialize Iter from vector data to iterate in reverse direction.

IterInitRevFromVecT

Macro

IterInitRevFromVecT Description Initialize Iter from vector data starting at back

IterInitRevT

Macro

IterInitRevT Description Initialize default Iter object to iterate in backward direction.

IterInitT

Macro

IterInitT Description Initialize default Iter object to iterate in forward direction.

IterLength

Macro

IterLength Description Get total length of this Iter object

IterMove

Macro

IterMove Description Move current reading position of Iterator.

IterNext

Macro

IterNext Description Move to next element (wrapper for IterMove)

IterPeekAt

Macro

IterPeekAt Description Peek (not read) object from memory iter, given that - Provided Iter object is not NULL_ITER(mi). - There’s space left to read. - Length of object data is being read into is an integral multiple of size of data type this memory iter is iterating over. This is different from reading because it does not change current read position. This is good for making some decisions over data without changing the read position.

IterPos

Macro

IterPos Description If there’s space left to read in memory region we’re iterating over, then return a pointer to current read position.

IterPrev

Macro

IterPrev Description Move to previous element (wrapper for IterMove)

IterRead

Macro

IterRead Description Read object from memory iter, given that - Provided Iter object is not NULL_ITER(mi). - There’s space left to read. - Length of object data is being read into is an integral multiple of size of data type this memory iter is iterating over.

IterRemainingLength

Macro

IterRemainingLength Description Get remaining length left to read this memory iterator.

IterRemainingSize

Macro

IterRemainingSize Description Get remaining size left to read this memory iterator.

IterSize

Macro

IterSize Description Get total size of this Iter object

JR_ARR

Macro

JR_ARR Description Read a JSON array using a custom value reader expression. The macro parses a JSON array and calls the user-provided code block for each element. If the value can’t be parsed or reader fails to advance the iterator, the value is skipped.

JR_ARR_KV

Macro

JR_ARR_KV Description Conditionally parse a JSON array if key matches expected name.

JR_BOOL

Macro

JR_BOOL Description Read a JSON boolean value from stream and assign to target.

JR_BOOL_KV

Macro

JR_BOOL_KV Description Read a boolean key-value pair if key matches.

JR_FLT

Macro

JR_FLT Description Read a JSON float value from stream and assign to target.

JR_FLT_KV

Macro

JR_FLT_KV Description Read a float key-value pair if key matches.

JR_INT

Macro

JR_INT Description Read a JSON integer value from stream and assign to target.

JR_INT_KV

Macro

JR_INT_KV Description Read an integer key-value pair if key matches.

JR_OBJ

Macro

JR_OBJ Description Read a JSON object using a custom field reader expression. The macro parses the object and invokes the provided code block for each key-value pair. If the key is not recognized or parsing fails, the value is skipped.

JR_OBJ_KV

Macro

JR_OBJ_KV Description Conditionally parse a JSON object if key matches expected name.

JR_STR

Macro

JR_STR Description Read a JSON string value from stream and assign to target. The resulting string is dynamically allocated in Str format.

JR_STR_KV

Macro

JR_STR_KV Description Read a string key-value pair if key matches.

JW_ARR

Macro

JW_ARR Description Write a JSON array from a vector. Each item is rendered using the provided writer. Handles inserting commas between elements.

JW_ARR_KV

Macro

JW_ARR_KV Description Write a key and an array value into a JSON object. Intended for use within a JW_OBJ. Adds commas automatically.

JW_BOOL

Macro

JW_BOOL Description Append a boolean value to the JSON as unquoted true/false.

JW_BOOL_KV

Macro

JW_BOOL_KV Description Write a key and boolean value into a JSON object.

JW_FLT

Macro

JW_FLT Description Append a floating-point value to a JSON string.

JW_FLT_KV

Macro

JW_FLT_KV Description Write a key and float value to a JSON object.

JW_INT

Macro

JW_INT Description Append an integer value to a JSON string.

JW_INT_KV

Macro

JW_INT_KV Description Write a key and integer value to a JSON object.

JW_OBJ

Macro

JW_OBJ Description Begin a JSON object and write key-value entries using JW_*_KV macros. This macro must be used as a wrapper for other JW_*_KV macros to generate a JSON object. Tracks whether commas are needed between entries using an internal flag.

JW_OBJ_KV

Macro

JW_OBJ_KV Description Write a key and nested object inside an existing JSON object. Should be called inside JW_OBJ. Adds commas appropriately based on insertion order.

JW_STR

Macro

JW_STR Description Append a string value (quoted) to the JSON.

JW_STR_KV

Macro

JW_STR_KV Description Write a key and string value into a JSON object.

LOG_ERROR

Macro

LOG_ERROR Description Writes an error-level log message. …[in] : Format string and arguments following printf-style syntax.

LOG_FATAL

Macro

LOG_FATAL Description Writes a fatal log message and aborts the program. …[in] : Format string and arguments following printf-style syntax.

LOG_INFO

Macro

LOG_INFO Description Writes an informational log message. …[in] : Format string and arguments following printf-style syntax.

LVAL

Macro

LVAL Description Creates a temporary, addressable l-value from a given expression x.

MAX2

Macro

MAX2 Description Returns the larger of two values x and y.

MIN2

Macro

MIN2 Description Returns the smaller of two values x and y.

NEW

Macro

NEW Description Allocates zero-initialized memory for a type.

NULL_ITER

Macro

NULL_ITER Description Type specific NULL for given Iter object. Use this instead of NULL when comparing for nullity of Iter objects of same type. Null value for Iter objects

NULL_ITER_DATA

Macro

NULL_ITER_DATA Description Type specific NULL for data type Iter object is iterating over. Use this instead of NULL when comparing for nullity of Iter objects of same type. Null value for Iter element pointers

ReadFmt

Macro

ReadFmt Description Read formatted input from the standard input stream (stdin). This is a convenience macro calling FReadFmt with stdin.

StrBegin

Macro

StrBegin Description Get pointer to first character in string

StrCharAt

Macro

StrCharAt Description Access character at given index

StrCharPtrAt

Macro

StrCharPtrAt Description Get pointer to character at given index

StrClear

Macro

StrClear Description Set string length to 0.

StrCmp

Macro

StrCmp Description Compare two Str objects

StrCmpCstr

Macro

StrCmpCstr Description Compare string with another const char* of specified length

StrCmpZstr

Macro

StrCmpZstr Description Compare string with a null-terminated const char* string

StrDelete

Macro

StrDelete Description Delete char at given index

StrDeleteLastChar

Macro

StrDeleteLastChar Description Delete last char from vec

StrDeleteRange

Macro

StrDeleteRange Description Delete chars in given range [start, start + count)

StrEnd

Macro

StrEnd Description Get pointer to one past the last character in string

StrFindCstr

Macro

StrFindCstr Description Find a fixed-length substring in a Str object.

StrFindStr

Macro

StrFindStr Description Find a key in a Str object.

StrFindZstr

Macro

StrFindZstr Description Find a key in a Str object.

StrFirst

Macro

StrFirst Description Access first character in string

StrForeach

Macro

StrForeach Description Iterate over each character chr of the given Str str. This is a convenience macro that iterates forward using an internally managed index. The variable chr is declared and defined by the underlying VecForeach macro.

StrForeachIdx

Macro

StrForeachIdx Description Iterate over each character chr of the given Str str at each index idx. This macro is a direct alias for VecForeachIdx specialized for Str. The variables chr and idx are declared and defined by the underlying macro.

StrForeachInRange

Macro

StrForeachInRange Description Iterate over characters in a specific range of the given Str str. This is a convenience macro that iterates over a range using an internally managed index. The variable chr is declared and defined by the underlying VecForeachInRange macro.

StrForeachInRangeIdx

Macro

StrForeachInRangeIdx 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.

StrForeachPtr

Macro

StrForeachPtr Description Iterate over each character pointer chrptr of the given Str str. This is a convenience macro that iterates forward using an internally managed index and provides a pointer to each character. The variable chrptr is declared and defined by the underlying VecForeachPtr macro as a pointer to the character type.

StrForeachPtrIdx

Macro

StrForeachPtrIdx Description Iterate over each character pointer chrptr of the given Str str at each index idx. This macro is a direct alias for VecForeachPtrIdx specialized for Str. The variables chrptr and idx are declared and defined by the underlying macro.

StrForeachPtrInRange

Macro

StrForeachPtrInRange Description Iterate over characters in a specific range of the given Str str (as pointers). This is a convenience macro that iterates over a range using an internally managed index and provides a pointer to each character. The variable chrptr is declared and defined by the underlying VecForeachPtrInRange macro as a pointer to the character type.

StrForeachPtrInRangeIdx

Macro

StrForeachPtrInRangeIdx Description Iterate over characters in a specific range of the given Str str at each index idx (as pointers). This macro is a direct alias for VecForeachPtrInRangeIdx specialized for Str. The variables chrptr and idx are declared and defined by the underlying macro.

StrForeachPtrReverse

Macro

StrForeachPtrReverse Description Iterate over each character pointer chrptr of the given Str str in reverse order. This is a convenience macro that iterates backward using an internally managed index and provides a pointer to each character. The variable chrptr is declared and defined by the underlying VecForeachPtrReverse macro as a pointer to the character type.

StrForeachReverse

Macro

StrForeachReverse Description Iterate over each character chr of the given Str str in reverse order. This is a convenience macro that iterates backward using an internally managed index. The variable chr is declared and defined by the underlying VecForeachReverse macro.

StrForeachReverseIdx

Macro

StrForeachReverseIdx Description Iterate over each character chr of the given Str str in reverse order at each index idx. This macro is a direct alias for VecForeachReverseIdx specialized for Str. The variables chr and idx are declared and defined by the underlying macro.

StrForeachReversePtrIdx

Macro

StrForeachReversePtrIdx Description Iterate over each character pointer chrptr of the given Str str in reverse order at each index idx. This macro is a direct alias for VecForeachPtrReverseIdx specialized for Str. The variables chrptr and idx are declared and defined by the underlying macro.

StrInitFromStr

Macro

StrInitFromStr Description Initialize a Str object using another one

StrInitFromZstr

Macro

StrInitFromZstr Description Initializes a Str object from a null-terminated C-style string (zstr). This macro calculates the length of zstr using strlen and then calls StrInitFromCstr to create the Str object.

StrInitStack

Macro

StrInitStack Description Initialize given string but use memory from stack. Such strings cannot be dynamically resized!!

StrInsert

Macro

StrInsert Description Insert contents of str2 into str at given index.

StrInsertCharAt

Macro

StrInsertCharAt Description Insert char into string of it’s type. Insertion index must not exceed string length.

StrInsertCstr

Macro

StrInsertCstr Description Insert a string of given length into given Str at given index.

StrInsertZstr

Macro

StrInsertZstr Description Insert a zero-terminated string into given Str at given index.

StrIterFromCstr

Macro

StrIterFromCstr Description Create string iterator from C string with explicit length

StrIterFromStr

Macro

StrIterFromStr Description Create string iterator from Str object

StrIterFromZstr

Macro

StrIterFromZstr Description Create string iterator from null-terminated C string

StrIterLength

Macro

StrIterLength Description Get total length in elements

StrIterMove

Macro

StrIterMove Description Move string iterator position by n elements

StrIterNext

Macro

StrIterNext Description Advance to next character in string iterator

StrIterPeek

Macro

StrIterPeek Description Peek current character without advancing

StrIterPeekAt

Macro

StrIterPeekAt Description Peek character at offset without advancing

StrIterPos

Macro

StrIterPos Description Get current read position pointer

StrIterPrev

Macro

StrIterPrev Description Move to previous character in string iterator

StrIterRead

Macro

StrIterRead Description Read character from iterator

StrIterRemainingLength

Macro

StrIterRemainingLength Description Get remaining elements left to read

StrIterRemainingSize

Macro

StrIterRemainingSize Description Get remaining bytes left to read

StrIterSize

Macro

StrIterSize Description Get total size of string data in bytes

StrLast

Macro

StrLast Description Access last character in string

StrLStrip

Macro

StrLStrip Description Strip only leading whitespace (or optional custom characters) from the given Str object. Returns a new Str object. Original is unmodified.

StrMerge

Macro

StrMerge Description Merge two strings and store the result in first string. By default, this uses R-value semantics (preserves source string). Data is copied from str2 into str. If a copy_init method is provided in str, each element from str2 will be copied using that method. Otherwise, a raw memory copy is performed.

StrMergeL

Macro

StrMergeL Description Merge two strings and store the result in first string, with L-value semantics. Data is copied from str2 into str. If a copy_init method is provided in str, each element from str2 will be copied using that method. Otherwise, a raw memory copy is performed.

StrMergeR

Macro

StrMergeR Description Merge two strings and store the result in first string, with R-value semantics. Data is copied from str2 into str. If a copy_init method is provided in str, each element from str2 will be copied using that method. Otherwise, a raw memory copy is performed.

StrPopBack

Macro

StrPopBack Description Pop char from string back.

StrPopFront

Macro

StrPopFront Description Pop char from string front.

StrPushBack

Macro

StrPushBack Description Push char into string.

StrPushBackCstr

Macro

StrPushBackCstr Description Push an array of chars with given length to the back of this string.

StrPushBackZstr

Macro

StrPushBackZstr Description Push a null-terminated string to the back of string.

StrPushCstr

Macro

StrPushCstr Description Push a array of characters with given length into this string at the given position.

StrPushFront

Macro

StrPushFront Description Push char into string front.

StrPushFrontCstr

Macro

StrPushFrontCstr Description Push a array of characters with given length to the front of this string

StrPushFrontZstr

Macro

StrPushFrontZstr Description Push a null-terminated string to the front of this string.

StrPushZstr

Macro

StrPushZstr Description Push a null-terminated string to this string at given position.

StrReadFmt

Macro

StrReadFmt Description Parse input string according to format string with rust-style placeholders, extracting values into provided arguments. This is a macro wrapper around StrReadFmtInternal.

StrRemove

Macro

StrRemove Description Remove char from string at given index and store in given pointer.

StrRemoveRange

Macro

StrRemoveRange Description Remove data from string in given range [start, start + count)

StrReserve

Macro

StrReserve Description Reserve space for string.

StrResize

Macro

StrResize Description Resize string. If length is smaller than current capacity, string length is shrinked. If length is greater than current capacity, space is reserved and string is expanded.

StrReverse

Macro

StrReverse Description Reverse contents of this string.

StrRStrip

Macro

StrRStrip Description Strip only trailing whitespace (or optional custom characters) from the given Str object. Returns a new Str object. Original is unmodified.

StrStrip

Macro

StrStrip Description Strip leading and trailing whitespace (or optional custom characters) from the given Str object. Returns a new Str object. Original is unmodified. The returned Str must be deinited after use.

StrSwapCharAt

Macro

StrSwapCharAt Description Swap chars at given indices.

StrTryReduceSpace

Macro

StrTryReduceSpace Description Try reducing memory footprint of string. This is to be used when we know actual allocated memory for vec is large, and we won’t need it in future, so we can reduce it to whatever’s required at the moment.

TO_BIG_ENDIAN2

Macro

TO_BIG_ENDIAN2 Description Conditionally converts value from native byte order to big-endian. On little-endian systems, this inverts the byte order. On big-endian systems, this is a no-op.

TO_BIG_ENDIAN4

Macro

TO_BIG_ENDIAN4 Description Conditionally converts value from native byte order to big-endian. On little-endian systems, this inverts the byte order. On big-endian systems, this is a no-op.

TO_BIG_ENDIAN8

Macro

TO_BIG_ENDIAN8 Description Conditionally converts value from native byte order to big-endian. On little-endian systems, this inverts the byte order. On big-endian systems, this is a no-op.

TO_LITTLE_ENDIAN2

Macro

TO_LITTLE_ENDIAN2 Description Conditionally converts value from native byte order to little-endian. On big-endian systems, this inverts the byte order. On little-endian systems, this is a no-op.

TO_LITTLE_ENDIAN4

Macro

TO_LITTLE_ENDIAN4 Description Conditionally converts value from native byte order to little-endian. On big-endian systems, this inverts the byte order. On little-endian systems, this is a no-op.

TO_LITTLE_ENDIAN8

Macro

TO_LITTLE_ENDIAN8 Description Conditionally converts value from native byte order to little-endian. On big-endian systems, this inverts the byte order. On little-endian systems, this is a no-op.

TO_LOWER

Macro

TO_LOWER Description Converts a character to lowercase.

TO_NATIVE_ENDIAN2

Macro

TO_NATIVE_ENDIAN2 Description Maintains native endianness for 16-bit values. This is a no-op that returns the value unchanged.

TO_NATIVE_ENDIAN4

Macro

TO_NATIVE_ENDIAN4 Description Maintains native endianness for 32-bit values. This is a no-op that returns the value unchanged.

TO_NATIVE_ENDIAN8

Macro

TO_NATIVE_ENDIAN8 Description Maintains native endianness for 64-bit values. This is a no-op that returns the value unchanged.

TO_UPPER

Macro

TO_UPPER Description Converts a character to uppercase.

TRICK_PARENS

Macro

TRICK_PARENS Description Part of the parenthesis trick to delay text generation

ValidateIter

Macro

ValidateIter Description Validate whether a given Iter object is valid. Not foolproof but will work most of the time. Aborts if provided Iter is not valid.

ValidateStrIter

Macro

ValidateStrIter Description Validate whether a given StrIter object is valid. Not foolproof but will work most of the time. Aborts if provided StrIter is not valid.

ValidateStrIters

Macro

ValidateStrIters Description Validate whether a given StrIters object is valid. Not foolproof but will work most of the time. Aborts if provided StrIters is not valid.

Vec

Macro

Vec Description Typesafe vector definition. This is much like C++ template std::vector

WriteFmt

Macro

WriteFmt Description Write formatted output to the standard output stream (stdout). This is a convenience macro calling FWriteFmt with stdout.

WriteFmtLn

Macro

WriteFmtLn Description Write formatted output to the standard output stream (stdout) followed by a newline. This is a convenience macro calling FWriteFmtLn with stdout.

Macro