ptr_vector.h

Go to the documentation of this file.

#ifndef PTR_VECTOR_H
#define PTR_VECTOR_H

/***************************************************************************
 *   Copyright (C) 2004, 2006 Symbian Software Ltd.                        *
 *   All rights reserved.                                                  *
 *   Copyright (C) 2007-2011 Mike Kinghan, imk@strudl.org                  *
 *   All rights reserved.                                                  *
 *                                                                         *
 *   Contributed originally by Mike Kinghan, imk@strudl.org                *
 *                                                                         *
 *   Redistribution and use in source and binary forms, with or without    *
 *   modification, are permitted provided that the following conditions    *
 *   are met:                                                              *
 *                                                                         *
 *   Redistributions of source code must retain the above copyright        *
 *   notice, this list of conditions and the following disclaimer.         *
 *                                                                         *
 *   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.  *
 *                                                                         *
 *   Neither the name of Symbian Software Ltd. 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 THE        *
 *   COPYRIGHT OWNER 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.                                                               *
 *                                                                         *
 **************************************************************************/
#include "bool.h"
#include <stddef.h>



typedef ptrdiff_t locator_t;

typedef struct ptr_vector * ptr_vector_h;

typedef struct ptr_vector const * ptr_vector_const_h;

typedef void (*dtor_t)(void *);

typedef void * (*cloner_t)(void const *);

typedef int (*comparator_t)(void const *obj, void const *key, locator_t keylen);

extern ptr_vector_h
ptr_vector_new(dtor_t dtor, cloner_t cloner);

extern void
ptr_vector_dispose(ptr_vector_h pv);

extern void
ptr_vector_drop(ptr_vector_h pv);


extern ptr_vector_h
ptr_vector_copy(ptr_vector_const_h src);

extern void
ptr_vector_swap(ptr_vector_h lhs, ptr_vector_h rhs);

extern void
ptr_vector_assign(ptr_vector_h dest, ptr_vector_const_h src);

extern void
ptr_vector_insert(ptr_vector_h pv, size_t pos, void const *ptr);

extern bool
ptr_vector_delete(ptr_vector_h pv, size_t pos);

extern void
ptr_vector_append(ptr_vector_h pv, void *ptr);

extern dtor_t
ptr_vector_dtor(ptr_vector_const_h pv);

extern cloner_t
ptr_vector_cloner(ptr_vector_const_h pv);

extern size_t
ptr_vector_count(ptr_vector_const_h pv);

extern bool
ptr_vector_equal(       ptr_vector_const_h lhs,
                    ptr_vector_const_h rhs,
                    comparator_t compare);

extern void **
ptr_vector_begin(ptr_vector_h pv);

extern void const **
ptr_vector_begin_const(ptr_vector_const_h pv);

extern void **
ptr_vector_end(ptr_vector_h pv);

extern void const **
ptr_vector_end_const(ptr_vector_const_h pv);


extern void *
ptr_vector_at(ptr_vector_h pv, size_t pos);

extern void const *
ptr_vector_at_const(ptr_vector_const_h pv, size_t pos);

extern locator_t
ptr_vector_search(      ptr_vector_const_h pv,
                    void const *key, locator_t keylen, comparator_t compare,
                    bool ordered);

#endif /* EOF*/