darray: New dynamic array library

1 files changed, 107 insertions, 0 deletions

diff --git a/darray.h b/darray.h
new file mode 100644
index 0000000..22e4c68
--- /dev/null
+++ b/darray.h
@@ -0,0 +1,107 @@
+/****************************************************************************
+ * bfs                                                                      *
+ * Copyright (C) 2019 Tavian Barnes <tavianator@tavianator.com>             *
+ *                                                                          *
+ * Permission to use, copy, modify, and/or distribute this software for any *
+ * purpose with or without fee is hereby granted.                           *
+ *                                                                          *
+ * 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.           *
+ ****************************************************************************/
+
+/**
+ * A dynamic array library.
+ *
+ *     int ret = 0;
+ *     int *array = NULL;
+ *
+ *     int e = 1;
+ *     if (DARRAY_PUSH(&array, &e) != 0) {
+ *             goto fail;
+ *     }
+ *
+ *     e = 2;
+ *     if (DARRAY_PUSH(&array, &e) != 0) {
+ *             goto fail;
+ *     }
+ *
+ *     for (size_t i = 0; i < darray_length(array); ++i) {
+ *             assert(array[i] == i + 1);
+ *     }
+ *
+ *     ret = 0;
+ *     fail:
+ *     darray_free(array);
+ *     return ret;
+ */
+
+#ifndef BFS_DARRAY_H
+#define BFS_DARRAY_H
+
+#include <stddef.h>
+
+/**
+ * Get the length of a darray.
+ *
+ * @param da
+ *         The array in question.
+ * @return
+ *         The length of the array.
+ */
+size_t darray_length(const void *da);
+
+/**
+ * @internal Use DARRAY_PUSH().
+ *
+ * Push an element into a darray.
+ *
+ * @param da
+ *         The array to append to.
+ * @param item
+ *         The item to append.
+ * @param size
+ *         The size of the item.
+ * @return
+ *         The (new) location of the array.
+ */
+void *darray_push(void *da, const void *item, size_t size);
+
+/**
+ * @internal Use DARRAY_PUSH().
+ *
+ * Check if the last darray_push() call failed.
+ *
+ * @param da
+ *         The darray to check.
+ * @return
+ *         0 on success, -1 on failure.
+ */
+int darray_check(void *da);
+
+/**
+ * Free a darray.
+ *
+ * @param da
+ *         The darray to free.
+ */
+void darray_free(void *da);
+
+/**
+ * Push an item into a darray.
+ *
+ * @param da
+ *         The array to append to.
+ * @param item
+ *         A pointer to the item to append.
+ * @return
+ *         0 on success, -1 on failure.
+ */
+#define DARRAY_PUSH(da, item) \
+	(darray_check(*(da) = darray_push(*(da), (item), sizeof(**(da) = *(item)))))
+
+#endif // BFS_DARRAY_H