ptr_set.h

Go to the documentation of this file.

#ifndef PTR_SET_H
#define PTR_SET_H
/***************************************************************************
 *   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 "opts.h"
#include "ptr_vector.h"

typedef struct ptr_set * ptr_set_h;

typedef struct ptr_set const * ptr_set_const_h;


extern ptr_set_h
ptr_set_new(comparator_t compare, dtor_t dtor, cloner_t cloner);

extern void
ptr_set_dispose(ptr_set_h ps);

extern ptr_set_h
ptr_set_copy(ptr_set_const_h src);

extern void
ptr_set_swap(ptr_set_h lhs, ptr_set_h rhs);

extern void
ptr_set_assign(ptr_set_h dest, ptr_set_const_h src);

extern bool
ptr_set_equal(ptr_set_const_h lhs, ptr_set_const_h rhs);

extern comparator_t
ptr_set_comparator(ptr_set_const_h ps);

extern dtor_t
ptr_set_dtor(ptr_set_const_h ps);

extern cloner_t
ptr_set_cloner(ptr_set_const_h ps);

extern size_t
ptr_set_count(ptr_set_const_h ps);

extern void *
ptr_set_search(ptr_set_h ps, char const *key, locator_t keylen);

extern void const *
ptr_set_search_const(ptr_set_const_h ps, char const *key, locator_t keylen);


extern bool
ptr_set_insert(ptr_set_h ps, void const *obj);

extern bool
ptr_set_delete(ptr_set_h ps, locator_t pos);

extern void **
ptr_set_begin(ptr_set_const_h ps);

extern void **
ptr_set_end(ptr_set_const_h ps);

extern void const **
ptr_set_begin_const(ptr_set_const_h ps);

extern void const **
ptr_set_end_const(ptr_set_const_h ps);


#endif /* EOF */