/* ccapi/server/ccs_array.h */
/*
 * Copyright 2006, 2007 Massachusetts Institute of Technology.
 * All Rights Reserved.
 *
 * Export of this software from the United States of America may
 * require a specific license from the United States Government.
 * It is the responsibility of any person or organization contemplating
 * export to obtain such a license before exporting.
 *
 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
 * distribute this software and its documentation for any purpose and
 * without fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright notice and
 * this permission notice appear in supporting documentation, and that
 * the name of M.I.T. not be used in advertising or publicity pertaining
 * to distribution of the software without specific, written prior
 * permission.  Furthermore if you modify this software you must label
 * your software as modified software and not distribute it in such a
 * fashion that it might be confused with the original M.I.T. software.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is" without express
 * or implied warranty.
 */

#ifndef CCS_ARRAY_H
#define CCS_ARRAY_H

#include "ccs_types.h"

cc_int32 ccs_client_array_new (ccs_client_array_t *out_array);

cc_int32 ccs_client_array_release (ccs_client_array_t io_array);

cc_uint64 ccs_client_array_count (ccs_client_array_t in_array);

ccs_client_t ccs_client_array_object_at_index (ccs_client_array_t io_array,
                                               cc_uint64          in_position);

cc_int32 ccs_client_array_insert (ccs_client_array_t io_array,
                                  ccs_client_t       in_client,
                                  cc_uint64          in_position);

cc_int32 ccs_client_array_remove (ccs_client_array_t io_array,
                                  cc_uint64          in_position);

#ifdef TARGET_OS_MAC
#pragma mark -
#endif

cc_int32 ccs_lock_array_new (ccs_lock_array_t *out_array);

cc_int32 ccs_lock_array_release (ccs_lock_array_t io_array);

cc_uint64 ccs_lock_array_count (ccs_lock_array_t in_array);

ccs_lock_t ccs_lock_array_object_at_index (ccs_lock_array_t io_array,
                                           cc_uint64        in_position);

cc_int32 ccs_lock_array_insert (ccs_lock_array_t io_array,
                                ccs_lock_t       in_lock,
                                cc_uint64        in_position);

cc_int32 ccs_lock_array_remove (ccs_lock_array_t io_array,
                                cc_uint64        in_position);

cc_int32 ccs_lock_array_move (ccs_lock_array_t  io_array,
                              cc_uint64         in_position,
                              cc_uint64         in_new_position,
                              cc_uint64        *out_real_new_position);

#ifdef TARGET_OS_MAC
#pragma mark -
#endif

cc_int32 ccs_callback_array_new (ccs_callback_array_t *out_array);

cc_int32 ccs_callback_array_release (ccs_callback_array_t io_array);

cc_uint64 ccs_callback_array_count (ccs_callback_array_t in_array);

ccs_callback_t ccs_callback_array_object_at_index (ccs_callback_array_t io_array,
						   cc_uint64            in_position);

cc_int32 ccs_callback_array_insert (ccs_callback_array_t io_array,
				    ccs_callback_t       in_callback,
				    cc_uint64            in_position);

cc_int32 ccs_callback_array_remove (ccs_callback_array_t io_array,
				    cc_uint64           in_position);

#ifdef TARGET_OS_MAC
#pragma mark -
#endif

cc_int32 ccs_callbackref_array_new (ccs_callbackref_array_t *out_array);

cc_int32 ccs_callbackref_array_release (ccs_callbackref_array_t io_array);

cc_uint64 ccs_callbackref_array_count (ccs_callbackref_array_t in_array);

ccs_callback_t ccs_callbackref_array_object_at_index (ccs_callbackref_array_t io_array,
						      cc_uint64               in_position);

cc_int32 ccs_callbackref_array_insert (ccs_callbackref_array_t io_array,
				       ccs_callback_t          in_callback,
				       cc_uint64               in_position);

cc_int32 ccs_callbackref_array_remove (ccs_callbackref_array_t io_array,
				       cc_uint64               in_position);

#ifdef TARGET_OS_MAC
#pragma mark -
#endif

cc_int32 ccs_iteratorref_array_new (ccs_iteratorref_array_t *out_array);

cc_int32 ccs_iteratorref_array_release (ccs_iteratorref_array_t io_array);

cc_uint64 ccs_iteratorref_array_count (ccs_iteratorref_array_t in_array);

ccs_generic_list_iterator_t ccs_iteratorref_array_object_at_index (ccs_iteratorref_array_t io_array,
                                                                   cc_uint64               in_position);

cc_int32 ccs_iteratorref_array_insert (ccs_iteratorref_array_t     io_array,
                                       ccs_generic_list_iterator_t in_iterator,
                                       cc_uint64                   in_position);

cc_int32 ccs_iteratorref_array_remove (ccs_iteratorref_array_t io_array,
                                       cc_uint64               in_position);

#endif /* CCS_ARRAY_H */