llist.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 2018 Rafael Antoniello
 * 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.
 * 3. Neither the name of copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * 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 COPYRIGHT HOLDERS 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 UTILS_SRC_LLIST_H_
#define UTILS_SRC_LLIST_H_

#include <sys/types.h>
#include <inttypes.h>

/* **** Definitions **** */

typedef struct llist_s llist_t;

typedef struct llist_s {
    void *data;
    llist_t *next;
} llist_t;

/* **** Prototypes **** */

int llist_push(llist_t** ref_llist_head, void *data);

void* llist_pop(llist_t** ref_llist_head);

int llist_len(const llist_t *llist_head);

void* llist_get_nth(const llist_t *llist_head, int index);

int llist_insert_nth(llist_t **ref_llist_head, int index, void *data);

#define LLIST_DUPLICATE(ref_llist_dst, llist_src, node_dup_fxn, \
        node_dup_fxn_t, ret_code) \
do {\
    int i;\
    llist_t **_ref_llist_dst= ref_llist_dst;\
    const llist_t *_llist_src= llist_src;\
    node_dup_fxn_t*(*_node_dup_fxn)(const node_dup_fxn_t*)= node_dup_fxn;\
\
    ret_code= STAT_ERROR;\
\
    CHECK_DO(_ref_llist_dst!= NULL, break);\
    CHECK_DO(_node_dup_fxn!= NULL, break);\
    if(_llist_src== NULL) {\
        ret_code= STAT_SUCCESS;\
        break;\
    }\
\
    for(i= 0;; i++) {\
        void *node, *node_copy;\
\
        node= llist_get_nth(_llist_src, i);\
        if(node== NULL) {\
            ret_code= STAT_SUCCESS;\
            break;\
        }\
\
        node_copy= _node_dup_fxn((const node_dup_fxn_t*)node);\
        CHECK_DO(node_copy!= NULL, break);\
\
CHECK_DO(\
            llist_insert_nth(_ref_llist_dst, i, node_copy)== STAT_SUCCESS,\
            break);\
    }\
} while(0);

#define LLIST_RELEASE(ref_llist_head, node_release_fxn, node_type) \
while((*ref_llist_head)!= NULL) {\
    void (*_node_release_fxn)(node_type**)= node_release_fxn;\
    node_type *node= (node_type*)llist_pop(ref_llist_head);\
    if(node!= NULL) _node_release_fxn(&node);\
    ASSERT(node== NULL);\
}

#endif /* UTILS_SRC_LLIST_H_ */