ccan/junkcode/dongre.avinash@gmail.com-clibutils/src/c_array.c

/** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** **
 *  This file is part of clib library
 *  Copyright (C) 2011 Avinash Dongre ( dongre.avinash@gmail.com )
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 * 
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 * 
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** **/

#include "c_lib.h"
#include <string.h>
#include <stdio.h>


static struct clib_array* 
array_check_and_grow ( struct clib_array* pArray) {
    if ( pArray->no_of_elements >= pArray->no_max_elements ) {
        pArray->no_max_elements  = 2 * pArray->no_max_elements;
        pArray->pElements        = (struct clib_object**) realloc ( pArray->pElements, 
                                      pArray->no_max_elements * sizeof ( struct clib_object*));
    }
    return pArray;
}

struct clib_array* 
new_clib_array(int array_size, clib_compare fn_c, clib_destroy fn_d) {

    struct clib_array* pArray = (struct clib_array*)malloc(sizeof(struct clib_array));
    if ( ! pArray )
        return (struct clib_array*)0;

    pArray->no_max_elements = array_size < 8 ? 8 : array_size;
    pArray->pElements = (struct clib_object**) malloc(pArray->no_max_elements * sizeof(struct clib_object*));
    if ( ! pArray->pElements ){
        free ( pArray );
        return (struct clib_array*)0;
    }
    pArray->compare_fn      = fn_c;
    pArray->destruct_fn     = fn_d;
    pArray->no_of_elements  = 0;

    return pArray;
}

static clib_error 
insert_clib_array ( struct clib_array* pArray, int index, void *elem, size_t elem_size) {

    clib_error rc           = CLIB_ERROR_SUCCESS;
    struct clib_object* pObject = new_clib_object ( elem, elem_size );
    if ( ! pObject )
        return CLIB_ARRAY_INSERT_FAILED;

    pArray->pElements[index] = pObject;
    pArray->no_of_elements++;
    return rc;
}

clib_error 
push_back_clib_array (struct clib_array* pArray, void *elem, size_t elem_size) {
    clib_error rc = CLIB_ERROR_SUCCESS;	

    if ( ! pArray)
        return CLIB_ARRAY_NOT_INITIALIZED;

    array_check_and_grow ( pArray);

    rc = insert_clib_array( pArray, pArray->no_of_elements, elem, elem_size);

    return rc;
}

clib_error 
element_at_clib_array (struct clib_array* pArray, int index, void** elem) {
    clib_error rc = CLIB_ERROR_SUCCESS;

    if ( ! pArray )
        return CLIB_ARRAY_NOT_INITIALIZED;

	if ( index < 0 || index >= pArray->no_of_elements )
        return CLIB_ARRAY_INDEX_OUT_OF_BOUND;

    get_raw_clib_object ( pArray->pElements[index], elem );
    return rc;
}

int
size_clib_array ( struct clib_array* pArray ) {
	if ( pArray == (struct clib_array*)0 )
		return 0;
	return pArray->no_of_elements;
}

int
capacity_clib_array ( struct clib_array* pArray ) {
	if ( pArray == (struct clib_array*)0 )
		return 0;
	return pArray->no_max_elements;
}

clib_bool  
empty_clib_array ( struct clib_array* pArray) {
	if ( pArray == (struct clib_array*)0 )
		return 0;
	if ( pArray->no_of_elements == 0 )
		return clib_true;
	else
		return clib_false;
}

clib_error 
reserve_clib_array ( struct clib_array* pArray, int new_size) {
	if ( pArray == (struct clib_array*)0 )
		return CLIB_ARRAY_NOT_INITIALIZED;

	if ( new_size <= pArray->no_max_elements )
		return CLIB_ERROR_SUCCESS;

	array_check_and_grow ( pArray);
	return CLIB_ERROR_SUCCESS;

}

clib_error 
front_clib_array ( struct clib_array* pArray,void *elem) {
    return element_at_clib_array ( pArray, 0, elem );
}

clib_error 
back_clib_array ( struct clib_array* pArray,void *elem) {
    return element_at_clib_array ( pArray, pArray->no_of_elements - 1, elem );
}

clib_error 
insert_at_clib_array ( struct clib_array* pArray, int index, void *elem, size_t elem_size) {
    clib_error rc = CLIB_ERROR_SUCCESS;
    if ( ! pArray )
        return CLIB_ARRAY_NOT_INITIALIZED;

    if ( index < 0 || index > pArray->no_max_elements )
        return CLIB_ARRAY_INDEX_OUT_OF_BOUND;

    array_check_and_grow ( pArray);

    memmove ( &(pArray->pElements[index + 1]),
              &pArray->pElements[index],
              (pArray->no_of_elements - index ) * sizeof(struct clib_object*));

    rc = insert_clib_array ( pArray, index, elem , elem_size);

    return rc;
}

clib_error     
remove_clib_array ( struct clib_array* pArray, int index) {
    clib_error   rc = CLIB_ERROR_SUCCESS;

    if ( ! pArray )
        return rc;
	if ( index < 0 || index >= pArray->no_of_elements )
        return CLIB_ARRAY_INDEX_OUT_OF_BOUND;

    if ( pArray->destruct_fn ) {
        void *elem;
        if ( CLIB_ERROR_SUCCESS == element_at_clib_array ( pArray, index , &elem ) ) {
            pArray->destruct_fn(elem);
        }
    }
    delete_clib_object ( pArray->pElements[index]);

	if ( index != pArray->no_of_elements - 1 ) {
	    memmove ( &(pArray->pElements[index]),
		          &pArray->pElements[index + 1],
			      (pArray->no_of_elements - index ) * sizeof(struct clib_object*));
	}
    pArray->no_of_elements--;
    return rc;
}

clib_error 
delete_clib_array( struct clib_array* pArray) {
    clib_error rc = CLIB_ERROR_SUCCESS;
    int i = 0;

    if ( pArray == (struct clib_array*)0 )
        return rc;

    if ( pArray->destruct_fn ) {
        for ( i = 0; i < pArray->no_of_elements; i++) {
            void *elem;
            if ( CLIB_ERROR_SUCCESS == element_at_clib_array ( pArray, i , &elem ) )
                pArray->destruct_fn(elem);
        }
    }
    for ( i = 0; i < pArray->no_of_elements; i++) 
        delete_clib_object ( pArray->pElements[i]);    

    free ( pArray->pElements);
    free ( pArray );
    return rc;
}

void 
swap_element_clib_array ( struct clib_array *pArray, int left, int right) {
	struct clib_object *temp = pArray->pElements[left];
	pArray->pElements[left] = pArray->pElements[right];
	pArray->pElements[right] = temp;
}

void for_each_clib_array ( struct clib_array *pArray, void (*fn)(void*)) {
	int size = pArray->no_of_elements;
	int i = 0;
	for ( i = 0; i < size; i++ ) {
		void *elem;
		element_at_clib_array ( pArray, i , &elem);
		(fn)(elem);
		free ( elem );
	}
}