iterator.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef UCX_ITERATOR_H
#define UCX_ITERATOR_H
 
#include "common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct cx_iterator_base_s {
    bool (*valid)(const void *);
 
    void *(*current)(const void *);
 
    void *(*current_impl)(const void *);
 
    void (*next)(void *);
    bool mutating;
    bool remove;
};
 
typedef struct cx_iterator_base_s CxIteratorBase;
 
#define CX_ITERATOR_BASE struct cx_iterator_base_s base
 
struct cx_iterator_s {
    CX_ITERATOR_BASE;
 
    void *elem_handle;
 
    union {
        void *m;
        const void *c;
    } src_handle;
 
    size_t index;
 
    size_t elem_size;
 
    size_t elem_count;
};
 
typedef struct cx_iterator_s CxIterator;
 
#define cxIteratorValid(iter) (iter).base.valid(&(iter))
 
#define cxIteratorCurrent(iter) (iter).base.current(&iter)
 
#define cxIteratorNext(iter) (iter).base.next(&iter)
 
#define cxIteratorFlagRemoval(iter) (iter).base.remove |= (iter).base.mutating
 
#define cxIteratorRef(iter) &((iter).base)
 
#define cx_foreach(type, elem, iter) \
for (type elem; cxIteratorValid(iter) && (elem = (type)cxIteratorCurrent(iter)) != NULL ; cxIteratorNext(iter))
 
 
cx_attr_nodiscard
cx_attr_export
CxIterator cxIterator(
        const void *array,
        size_t elem_size,
        size_t elem_count
);
 
cx_attr_nodiscard
cx_attr_export
CxIterator cxMutIterator(
        void *array,
        size_t elem_size,
        size_t elem_count,
        bool remove_keeps_order
);
 
cx_attr_nodiscard
cx_attr_export
CxIterator cxIteratorPtr(
        const void *array,
        size_t elem_count
);
 
cx_attr_nodiscard
cx_attr_export
CxIterator cxMutIteratorPtr(
        void *array,
        size_t elem_count,
        bool remove_keeps_order
);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // UCX_ITERATOR_H