Create linked list data structureHEADmaster

We will need to have a list to traverse game entities.

The first idea is to implement a mutable list. In case of mutable list
get too bad or error prone. We can easily change it to immutable.

Signed-off-by: Johnny Richard <johnny@johnnyrichard.com>

3 files changed, 246 insertions, 0 deletions

diff --git a/src/list.c b/src/list.c
new file mode 100644
index 0000000..550076a
--- /dev/null
+++ b/src/list.c
@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2022, Johnny Richard
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "list.h"
+
+#include <assert.h>
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+list_t*
+list_new(void* value)
+{
+  list_t* list = (list_t*)malloc(sizeof(list_t));
+  if (list == NULL) {
+    fprintf(stderr, "list_new: Out of memory: %s\n", strerror(errno));
+    exit(EXIT_FAILURE);
+  }
+  list->value = value;
+  list->next = NULL;
+  return list;
+}
+
+bool
+list_is_empty(list_t* list)
+{
+  return list == NULL;
+}
+
+void
+list_push(list_t** list, void* value)
+{
+  list_t* tail = *list;
+  list_t* head = list_new(value);
+  head->next = tail;
+  *list = head;
+}
+
+list_t*
+list_pop(list_t** list)
+{
+  list_t* head = *list;
+  *list = (*list)->next;
+  return head;
+}
+
+void
+list_destroy(list_t** list)
+{
+  if (list == NULL)
+    return;
+
+  for (list_t* head = list_pop(list); head != NULL; head = list_pop(list)) {
+    free(head);
+  }
+}
diff --git a/src/list.h b/src/list.h
new file mode 100644
index 0000000..232ccb4
--- /dev/null
+++ b/src/list.h
@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2022, Johnny Richard
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+#ifndef LIST_H
+#define LIST_H
+
+#include <stdbool.h>
+
+struct list
+{
+  struct list* next;
+  void* value;
+};
+
+typedef struct list list_t;
+
+list_t*
+list_new(void* value);
+
+bool
+list_is_empty();
+
+void
+list_push(list_t** list, void* value);
+
+list_t*
+list_pop(list_t** list);
+
+void
+list_destroy(list_t** list);
+
+#endif /* LIST_H */
diff --git a/test/list-test.c b/test/list-test.c
new file mode 100644
index 0000000..6d4376a
--- /dev/null
+++ b/test/list-test.c
@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2022, Johnny Richard
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#define MUNIT_ENABLE_ASSERT_ALIASES
+
+#include "list.h"
+
+#include <munit/munit.h>
+#include <stdbool.h>
+
+static MunitResult
+test_is_empty(const MunitParameter params[], void* fixture)
+{
+  assert_true(list_is_empty(NULL));
+  return MUNIT_OK;
+}
+
+static MunitResult
+test_push(const MunitParameter params[], void* fixture)
+{
+  list_t* list = NULL;
+
+  int number = 1;
+  list_push(&list, &number);
+
+  assert_false(list_is_empty(list));
+
+  assert_int(*((int*)list->value), ==, 1);
+  assert_true(list->next == NULL);
+
+  return MUNIT_OK;
+}
+
+static MunitResult
+test_pop(const MunitParameter params[], void* fixture)
+{
+  list_t* list = NULL;
+
+  int n1 = 1;
+  int n2 = 2;
+
+  list_push(&list, &n1);
+  list_push(&list, &n2);
+
+  assert_int(*((int*)list->value), ==, 2);
+  assert_int(*((int*)list->next->value), ==, 1);
+  assert_true(list->next->next == NULL);
+
+  list_t* head = list_pop(&list);
+  assert_int(*((int*)head->value), ==, 2);
+  assert_int(*((int*)list->value), ==, 1);
+  assert_true(list->next == NULL);
+
+  return MUNIT_OK;
+}
+
+MunitTest tests[] = {
+  { "/test_is_empty", test_is_empty, NULL, NULL, MUNIT_TEST_OPTION_NONE, NULL },
+  { "/test_push", test_push, NULL, NULL, MUNIT_TEST_OPTION_NONE, NULL },
+  { "/test_pop", test_pop, NULL, NULL, MUNIT_TEST_OPTION_NONE, NULL },
+  { NULL, NULL, NULL, NULL, MUNIT_TEST_OPTION_NONE, NULL }
+};
+
+static const MunitSuite suite = { "/list",
+                                  tests,
+                                  NULL,
+                                  1,
+                                  MUNIT_TEST_OPTION_NONE };
+
+int
+main(int argc, char* argv[])
+{
+  return munit_suite_main(&suite, NULL, argc, argv);
+}