Abagnale/array.h at master · jDTAUS/Abagnale · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/* $SchulteIT: array.h 15189 2025-10-27 05:41:45Z schulte $ */
/* $JDTAUS: array.h 9629 2026-07-09 04:01:09Z schulte $ */

/*
 * Copyright (c) 2018 - 2026 Christian Schulte <cs@schulte.it>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef ARRAY_H
#define ARRAY_H

#ifdef HAVE_HOST_H
#include "host.h"
#endif

#ifdef MULTI_THREADED
#include <threads.h>
#endif

#include <stdbool.h>
#include <stddef.h>

struct Array;

struct Array *Array_new(const size_t);
void Array_delete(struct Array *restrict const,
                  void (*i_delete)(void *restrict const));

struct Array *Array_copy(const struct Array *restrict const,
                         void *(*i_copy)(void *restrict const));
void Array_cut(struct Array *restrict const, const size_t, const size_t,
               void (*i_delete)(void *restrict const));
void Array_clear(struct Array *restrict const,
                 void (*i_delete)(void *restrict const));
void Array_compact(struct Array *restrict const);

void Array_add_tail(struct Array *restrict const, void *restrict const);
void *Array_tail(const struct Array *restrict const);
void Array_add_head(struct Array *restrict const, void *restrict const);
void *Array_head(const struct Array *);

void *Array_remove_tail(struct Array *restrict const);
void *Array_remove_head(struct Array *restrict const);
void *Array_remove_idx(struct Array *restrict const, const size_t);

const size_t Array_size(const struct Array *restrict const);
void *const *Array_items(const struct Array *restrict const);

#ifdef MULTI_THREADED
mtx_t *Array_mutex(struct Array *restrict const);
void Array_lock(struct Array *restrict const);
bool Array_trylock(struct Array *restrict const);
void Array_unlock(struct Array *restrict const);
#endif
#endif