foreach.h

Go to the documentation of this file.

/*
 * Macros for iterating over different structures (arrays, strings, sets, ...).
 *
 * To define `foreach` for a data structure in `src/structs`,
 * first include the struct, then this header.
 *
 *
 * Created by MacBook on 23.10.2024.
 */
 
#ifndef CLIBS_FOREACH_H
#define CLIBS_FOREACH_H
 
#include <stdlib.h>
#include <string.h>
 

#define foreach_uni( TYPE, ITEM_NAME, INITIALIZER, ACCESSOR, SIZE ) \
    foreach_helper_init( SIZE, ITEM_NAME )                          \
            foreach_helper_assign( TYPE, ITEM_NAME, INITIALIZER, ACCESSOR )

#define foreach_arr( ITEM_TYPE, ITEM_NAME, ARRAY, COUNT )                \
    foreach_helper_init( COUNT, ITEM_NAME )                              \
            foreach_helper_assign( ITEM_TYPE, ITEM_NAME, ( ARRAY )[ 0 ], \
                                   ( ARRAY )[ foreach_index_##ITEM_NAME ] )

#define foreach_str( ITEM_NAME, STRING )                                   \
    foreach_helper_init( strlen( STRING ), ITEM_NAME )                     \
            foreach_helper_assign( const char, ITEM_NAME, ( STRING )[ 0 ], \
                                   ( STRING )[ foreach_index_##ITEM_NAME ] )
 
 
#if defined( CLIBS_DYNAMIC_ARRAY_H ) || defined( CLIBS__GENERATE_DOCS )
#define foreach_ls( TYPE, ITEM_NAME, LIST )                                      \
    foreach_helper_init( list_size( LIST ), ITEM_NAME )                          \
            foreach_helper_assign( TYPE, ITEM_NAME, list_fetch( LIST, 0, TYPE ), \
                                   list_fetch( LIST, foreach_index_##ITEM_NAME, TYPE ) )
#endif // List
 
 
#if defined( CLIBS_SETS_H ) || defined( CLIBS__GENERATE_DOCS )
#define foreach_set( ENTRY_NAME, SET )                                 \
    for ( SetEnumeratedEntry ENTRY_NAME = set_get_next( ( SET ), -1 ); \
          ENTRY_NAME.index >= 0;                                       \
          ENTRY_NAME = set_get_next( ( SET ), ENTRY_NAME.index ) )
#endif // Set
 
 
#if defined( CLIBS_QUEUE_H ) || defined( CLIBS__GENERATE_DOCS )
#define foreach_que( ENTRY_NAME, QUEUE )                                           \
    for ( const struct queue_node *ENTRY_NAME = queue__iterator_get_head( QUEUE ); \
          ENTRY_NAME != NULL; ENTRY_NAME      = queue__iterator_get_next( ENTRY_NAME ) )
 
#endif // Queue
 

#define foreach_helper_init( SIZE, ITEM_NAME )                                \
    for ( size_t foreach_keep_##ITEM_NAME = 1, foreach_index_##ITEM_NAME = 0, \
                 foreach_cap_##ITEM_NAME = ( SIZE );                          \
          foreach_keep_##ITEM_NAME                                            \
          && foreach_index_##ITEM_NAME < foreach_cap_##ITEM_NAME;             \
          foreach_keep_##ITEM_NAME = !foreach_keep_##ITEM_NAME,               \
                 ++foreach_index_##ITEM_NAME )
 
#define foreach_helper_assign( TYPE, ITEM_NAME, INITIALIZER, ACCESSOR )         \
    for ( TYPE ITEM_NAME = ( foreach_index_##ITEM_NAME == 0 ) ? ( INITIALIZER ) \
                                                              : ( ACCESSOR );   \
          foreach_keep_##ITEM_NAME;                                             \
          foreach_keep_##ITEM_NAME = !foreach_keep_##ITEM_NAME )
 
 
#endif //CLIBS_FOREACH_H