1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/cx/array_list.h Sat Nov 12 15:56:58 2022 +0100
1.3 @@ -0,0 +1,69 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
1.8 + *
1.9 + * Redistribution and use in source and binary forms, with or without
1.10 + * modification, are permitted provided that the following conditions are met:
1.11 + *
1.12 + * 1. Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * 2. Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 + * POSSIBILITY OF SUCH DAMAGE.
1.30 + */
1.31 +/**
1.32 + * \file array_list.h
1.33 + * \brief Array list implementation.
1.34 + * \details Also provides several low-level functions for custom array list implementations.
1.35 + * \author Mike Becker
1.36 + * \author Olaf Wintermann
1.37 + * \version 3.0
1.38 + * \copyright 2-Clause BSD License
1.39 + */
1.40 +
1.41 +
1.42 +#ifndef UCX_ARRAY_LIST_H
1.43 +#define UCX_ARRAY_LIST_H
1.44 +
1.45 +#include "cx/list.h"
1.46 +
1.47 +#ifdef __cplusplus
1.48 +extern "C" {
1.49 +#endif
1.50 +
1.51 +/**
1.52 + * Allocates an array list for storing elements with \p item_size bytes each.
1.53 + *
1.54 + * @param allocator the allocator for allocating the list memory
1.55 + * @param comparator the comparator for the elements
1.56 + * @param item_size the size of each element in bytes
1.57 + * @param initial_capacity the initial number of elements the array can store
1.58 + * @return the created list
1.59 + */
1.60 +CxList *cxArrayListCreate(
1.61 + CxAllocator const *allocator,
1.62 + CxListComparator comparator,
1.63 + size_t item_size,
1.64 + size_t initial_capacity
1.65 +) __attribute__((__nonnull__));
1.66 +
1.67 +
1.68 +#ifdef __cplusplus
1.69 +} /* extern "C" */
1.70 +#endif
1.71 +
1.72 +#endif /* UCX_ARRAY_LIST_H */
