source: mainline/uspace/lib/c/include/adt/dyn_array.h@ dda2602

Last change on this file since dda2602 was 4b1c6a4b, checked in by Matthieu Riolo <matthieu.riolo@…>, 6 years ago

libc: Add more dyn_array functions
Conflicts:

boot/Makefile.common

  • Property mode set to 100644
File size: 5.1 KB
Line 
1/*
2 * Copyright (c) 2015 Michal Koutny
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32/** @file
33 */
34
35#ifndef LIBC_DYN_ARRAY_H_
36#define LIBC_DYN_ARRAY_H_
37
38#include <stdbool.h>
39#include <stddef.h>
40
41typedef struct {
42 /** Data buffer of array */
43 uint8_t *_data;
44 /** Size on bytes of a single item */
45 size_t _item_size;
46
47 /** Allocated space (in items) of the array */
48 size_t capacity;
49 /** No. of items in the array */
50 size_t size;
51} dyn_array_t;
52
53/** Initialize dynamic array
54 *
55 * @param[in] capacity initial capacity of array
56 *
57 * @return EOK on success
58 * @return ENOMEM on low memory
59 */
60#define dyn_array_initialize(dyn_array, type, capacity) \
61 _dyn_array_initialize((dyn_array), sizeof(type), capacity)
62
63
64/** Dynamic array accessor
65 *
66 * @return lvalue for the given item
67 */
68#define dyn_array_at(dyn_array, type, index) \
69 (*((type *) (dyn_array)->_data + index))
70
71/** Insert item at given position, shift rest of array
72 *
73 * @return EOK on success
74 * @return ENOMEM on failure
75 */
76#define dyn_array_insert(dyn_array, type, index, value) \
77({ \
78 size_t _index = (index); \
79 dyn_array_t *_da = (dyn_array); \
80 int rc = _dyn_array_reserve(_da, _da->size + 1); \
81 if (!rc) { \
82 _dyn_array_shift(_da, _index, 1); \
83 dyn_array_at(_da, type, _index) = (value); \
84 } \
85 rc; \
86})
87
88/** Insert item at the end of array
89 *
90 * @return EOK on success
91 * @return ENOMEM on failure
92 */
93#define dyn_array_append(dyn_array, type, value) \
94 dyn_array_insert(dyn_array, type, (dyn_array)->size, (value))
95
96
97/** Dynamic array iteration
98 *
99 * @param[in] dyn_array dyn_array_t (not pointer)
100 * @param[in] it name of variable used as iterator, it's pointer
101 * to @p type
102 */
103#define dyn_array_foreach(dyn_array, type, it) \
104 for (type *it = (type *)(dyn_array)._data; \
105 it != ((type *)(dyn_array)._data + (dyn_array).size); ++it)
106
107/** Find first occurence of value
108 *
109 * @param[in] dyn_array dyn_array_t *
110 * @param[in] value value to search for
111 *
112 * @return index of found value or size of array when no found
113 */
114#define dyn_array_find(dyn_array, type, value) \
115({ \
116 size_t _result = (dyn_array)->size; \
117 dyn_array_foreach(*(dyn_array), type, _it) { \
118 if (*_it == value) { \
119 _result = _it - (type *)(dyn_array)->_data; \
120 break; \
121 } \
122 } \
123 _result; \
124})
125
126extern void dyn_array_destroy(dyn_array_t *);
127extern void dyn_array_remove(dyn_array_t *, size_t);
128void dyn_array_clear(dyn_array_t *);
129
130extern int _dyn_array_initialize(dyn_array_t *, size_t, size_t);
131extern int _dyn_array_reserve(dyn_array_t *, size_t);
132extern void _dyn_array_shift(dyn_array_t *, size_t, size_t);
133extern void _dyn_array_unshift(dyn_array_t *, size_t, size_t);
134
135#endif
136
137/** @}
138 */
Note: See TracBrowser for help on using the repository browser.