test_stream: basic skeleton

lisp_free will do a shallow clean of any object, freeing its
associated memory.  It won't recur through any containers, nor will it
freakout if you give it something that is constant (symbols, small
integers, NIL, etc).

Makefile

@@ -12,8 +12,10 @@ RFLAGS=-O3
 MODE=release
 ifeq ($(MODE), release)
 CFLAGS=$(GFLAGS) $(RFLAGS)
-else
+else ifeq ($(MODE), debug)
 CFLAGS=$(GFLAGS) $(DFLAGS)
+else ifeq ($(MODE), full)
+CFLAGS=$(GFLAGS) $(DFLAGS) -DTEST_VERBOSE=1
 endif
 
 # Units to compile

alisp.org

@@ -50,6 +50,11 @@ other state do we need to encode?
 *** TODO Write a parser for lists
 *** TODO Write a parser for vectors
 *** TODO Write the general parser
+** WIP Unit tests :tests:
+*** TODO Test streams
+*** DONE Test system registration of allocated units
+In particular, does clean up work as we expect?  Do we have situations
+where we may double free or not clean up something we should've?
 ** Backlog
 *** TODO Design Big Integers
 We currently have 62 bit integers implemented via immediate values
@@ -139,9 +144,6 @@ Latter approach time complexity:
 
 Former approach is better time complexity wise, but latter is way
 better in terms of simplicity of code.  Must deliberate.
-*** TODO Test system registration of allocated units :test:
-In particular, does clean up work as we expect?  Do we have situations
-where we may double free or not clean up something we should've?
 *** TODO Design Strings
 We have ~sv_t~ so our basic C API is done.  We just need pluggable
 functions to construct and deconstruct strings as lisps.
@@ -160,4 +162,4 @@ Test if ~make_vec~ works with ~as_vec~, ~cons~ with ~as_cons~ AND
 We may need to think of effective ways to deal with NILs in ~car~ and
 ~cdr~.  Maybe make functions as well as the macros so I can choose
 between them?
-**** DONE Write more tests
+*** DONE Write more tests

include/alisp/lisp.h

@@ -49,6 +49,8 @@ vec_t *as_vec(lisp_t *);
 lisp_t *car(lisp_t *);
 lisp_t *cdr(lisp_t *);
 
+void lisp_free(lisp_t *);
+
 #endif
 
 /* Copyright (C) 2026 Aryadev Chavali

include/alisp/symtable.h

@@ -22,7 +22,7 @@ typedef struct
 
 void sym_table_init(sym_table_t *);
 char *sym_table_find(sym_table_t *, sv_t);
-void sym_table_cleanup(sym_table_t *);
+void sym_table_free(sym_table_t *);
 
 #endif
 

src/lisp.c

@@ -26,7 +26,7 @@ void sys_free(sys_t *sys)
 {
   static_assert(NUM_TAGS == 5);
 
-  sym_table_cleanup(&sys->symtable);
+  sym_table_free(&sys->symtable);
   if (sys->memory.size == 0)
     return;
 
@@ -34,26 +34,7 @@ void sys_free(sys_t *sys)
   for (size_t i = 0; i < VEC_SIZE(&sys->memory, lisp_t **); ++i)
   {
     lisp_t *allocated = VEC_GET(&sys->memory, i, lisp_t *);
-    switch (get_tag(allocated))
+    lisp_free(allocated);
-    {
-    case TAG_CONS:
-      // Delete the cons
-      free(as_cons(allocated));
-      break;
-    case TAG_VEC:
-    {
-      vec_t *vec = as_vec(allocated);
-      vec_free(vec);
-      free(vec);
-      break;
-    }
-    case TAG_NIL:
-    case TAG_INT:
-    case TAG_SYM:
-    case NUM_TAGS:
-      // shouldn't be dealt with (either constant or dealt with elsewhere)
-      break;
-    }
   }
 
   // Free the container
@@ -110,6 +91,30 @@ lisp_t *cdr(lisp_t *lsp)
     return CDR(lsp);
 }
 
+void lisp_free(lisp_t *item)
+{
+  switch (get_tag(item))
+  {
+  case TAG_CONS:
+    // Delete the cons
+    free(as_cons(item));
+    break;
+  case TAG_VEC:
+  {
+    vec_t *vec = as_vec(item);
+    vec_free(vec);
+    free(vec);
+    break;
+  }
+  case TAG_NIL:
+  case TAG_INT:
+  case TAG_SYM:
+  case NUM_TAGS:
+    // shouldn't be dealt with (either constant or dealt with elsewhere)
+    break;
+  }
+}
+
 /* Copyright (C) 2025, 2026 Aryadev Chavali
 
  * This program is distributed in the hope that it will be useful, but WITHOUT

src/symtable.c

@@ -54,7 +54,7 @@ char *sym_table_find(sym_table_t *table, sv_t sv)
   return ENTRY_GET(table, index).data;
 }
 
-void sym_table_cleanup(sym_table_t *table)
+void sym_table_free(sym_table_t *table)
 {
   // Iterate through the strings and free each of them.
   sv_t current = {0};

test/main.c

@@ -12,11 +12,15 @@
 #include "./test.h"
 
 #include "./test_lisp_api.c"
+#include "./test_sv.c"
+#include "./test_symtable.c"
 #include "./test_vec.c"
 
 test_suite_t SUITES[] = {
-    LISP_API_SUITE,
     VEC_SUITE,
+    SV_SUITE,
+    SYMTABLE_SUITE,
+    LISP_API_SUITE,
 };
 
 int main(void)
@@ -27,7 +31,7 @@ int main(void)
     printf("Suite [%s]\n", suite.name);
     for (u64 j = 0; j < suite.size; ++j)
     {
-      printf("[%s]: Running...\n", suite.tests[j].name);
+      printf("\t[%s]: Running...\n", suite.tests[j].name);
       suite.tests[j].fn();
     }
   }

test/test.h

@@ -10,27 +10,41 @@
 
 #include <alisp/alisp.h>
 
-#define TEST_PASSED() printf("[%s]: Passed\n", __func__)
+#ifndef TEST_VERBOSE
+#define TEST_VERBOSE 0
+#endif
+
+#define TEST_PASSED() printf("\t[%s]: Passed\n", __func__)
+#if TEST_VERBOSE
 #define TEST(COND, ...)                  \
   do                                     \
   {                                      \
     bool cond = (COND);                  \
     if (!cond)                           \
     {                                    \
-      printf("\tFAIL: ");    \
+      printf("\t\tFAIL: ");              \
     }                                    \
     else                                 \
     {                                    \
-      printf("\tPASS: ");    \
+      printf("\t\tPASS: ");              \
     }                                    \
-    printf("%s => ", #COND); \
     printf(__VA_ARGS__);                 \
-    printf("\n");            \
+    printf("\n\t\t      [%s]\n", #COND); \
     if (!cond)                           \
     {                                    \
       assert(0);                         \
     }                                    \
   } while (0)
+#else
+#define TEST(COND, ...) \
+  do                    \
+  {                     \
+    if (!(COND))        \
+    {                   \
+      assert(0);        \
+    }                   \
+  } while (0)
+#endif
 
 typedef struct TestFn
 {

test/test_lisp_api.c

@@ -10,8 +10,10 @@
 
 #include <alisp/lisp.h>
 
-void int_test(void)
+void smi_test(void)
 {
+  // Standard old testing, checking both sides of the number line and our set
+  // bounds.
   i64 ints[] = {
       1, -1, (1 << 10) - 1, (-1) * ((1 << 10) - 1), INT_MIN, INT_MAX,
   };
@@ -28,28 +30,36 @@ void int_test(void)
   TEST_PASSED();
 }
 
-void symtable_test(void)
+void smi_oob_test(void)
 {
-  sym_table_t table = {0};
+  // These are integers that are completely out of the bounds of our standard
-  sym_table_init(&table);
+  // tagging system due to their size.  We need to use big integers for this.
-  for (u64 i = 0; i < ARRSIZE(words); ++i)
+  i64 ints[] = {
-    sym_table_find(&table, SV((char *)words[i], strlen(words[i])));
+      INT_MIN - 1,
+      INT_MAX + 1,
+      INT64_MIN,
+      INT64_MAX,
+  };
 
-  TEST(table.count == ARRSIZE(unique_words), "%lu == %lu", table.count,
+  for (u64 i = 0; i < ARRSIZE(ints); ++i)
-       ARRSIZE(unique_words));
+  {
+    i64 in       = ints[i];
+    lisp_t *lisp = make_int(in);
+    i64 out      = as_int(lisp);
 
-  TEST(table.count < ARRSIZE(unique_words), "%lu < %lu", table.count,
+    TEST(in != out, "%ld != %ld", in, out);
-       ARRSIZE(unique_words));
+  }
 
   TEST_PASSED();
-
-  sym_table_cleanup(&table);
 }
 
-void sym_test(void)
+void sym_fresh_test(void)
 {
   sys_t system = {0};
   sys_init(&system);
+
+  // We expect every interned symbol to get a fresh allocation, but still be a
+  // valid representation of the original symbol.
   for (u64 i = 0; i < ARRSIZE(words); ++i)
   {
     const char *in = words[i];
@@ -57,10 +67,42 @@ void sym_test(void)
     char *out      = as_sym(lisp);
     TEST(in != out, "%p != %p", in, out);
     TEST(strlen(in) == strlen(out), "%zu == %zu", strlen(in), strlen(out));
-    TEST(strncmp(in, out, strlen(in)) == 0, "%d", strncmp(in, out, strlen(in)));
+    TEST(strncmp(in, out, strlen(in)) == 0, "`%s` == `%s`", in, out);
   }
-  TEST_PASSED();
+
   sys_free(&system);
+  TEST_PASSED();
+}
+
+void sym_unique_test(void)
+{
+  sys_t system = {0};
+  sys_init(&system);
+
+  sv_t symbols[] = {
+      SV("hello", 5),
+      SV("goodbye", 7),
+      SV("display", 7),
+      SV("@xs'a_sh;d::a-h]", 16),
+  };
+
+  lisp_t *ptrs[ARRSIZE(symbols)];
+  for (u64 i = 0; i < ARRSIZE(symbols); ++i)
+  {
+    ptrs[i] = intern(&system, symbols[i]);
+    TEST(ptrs[i] != 0, "%p (derived from `" PR_SV "`) is not NIL",
+         (void *)ptrs[i], SV_FMT(symbols[i]));
+  }
+
+  for (u64 i = 0; i < ARRSIZE(symbols); ++i)
+  {
+    lisp_t *newptr = intern(&system, symbols[i]);
+    TEST(newptr == ptrs[i], "interning again (%p) gives us the same (%p)",
+         (void *)newptr, (void *)ptrs[i]);
+  }
+
+  sys_free(&system);
+  TEST_PASSED();
 }
 
 void cons_test(void)
@@ -77,7 +119,13 @@ void cons_test(void)
     lisp             = cons(&system, lword, lisp);
   }
 
-  // Make sure we've essentially reversed the `words` array
+  /*
+    As we've cons'd each word, we'd expect the order to be reversed.  This test
+    will allow us to verify:
+        1) words have actually been added to the linked list.
+        2) words are in the order we expect.
+    in one go.
+   */
   u64 i = ARRSIZE(words);
   for (lisp_t *iter = lisp; iter; iter = cdr(iter), --i)
   {
@@ -89,21 +137,67 @@ void cons_test(void)
     TEST(strncmp(expected, got, size) == 0, "%s == %s", expected, got);
   }
 
-  TEST_PASSED();
-
   sys_free(&system);
+  TEST_PASSED();
 }
 
-const test_fn TESTS_LISP_API[] = {
+void sys_test(void)
-    MAKE_TEST_FN(int_test),
+{
-    MAKE_TEST_FN(sym_test),
+  sys_t sys = {0};
-    MAKE_TEST_FN(cons_test),
+  sys_init(&sys);
-};
+  u64 old_memory_size = sys.memory.size;
+
+  // Creating integers doesn't affect memory size
+  (void)make_int(2000);
+  TEST(sys.memory.size == old_memory_size,
+       "Making integers doesn't affect system memory size");
+
+  // Creating symbols won't affect memory size, but does affect the symbol table
+  (void)intern(&sys, SV("hello world!", 12));
+  TEST(sys.memory.size == old_memory_size,
+       "Interning doesn't affect system memory size");
+  TEST(sys.symtable.count > 0, "Interning affects symbol table");
+
+  // Creating cons' do affect memory size
+  (void)cons(&sys, make_int(1), make_int(2));
+  TEST(sys.memory.size > 0, "Creating cons' affects memory size");
+  old_memory_size = sys.memory.size;
+
+  (void)cons(&sys, intern(&sys, SV("test", 4)), NIL);
+  TEST(sys.memory.size > old_memory_size,
+       "Creating cons' back to back affects memory size");
+  old_memory_size = sys.memory.size;
+
+  // Creating vectors does affect memory size
+  (void)make_vec(&sys, 8);
+  TEST(sys.memory.size > old_memory_size,
+       "Creating vectors (size 8) affects memory size");
+  old_memory_size = sys.memory.size;
+
+  (void)make_vec(&sys, 1000);
+  TEST(sys.memory.size > old_memory_size,
+       "Creating vectors (size 1000) affects memory size");
+  old_memory_size = sys.memory.size;
+
+  sys_free(&sys);
+  TEST(sys.memory.size == 0, "sys_free cleans up memory (shallow check)");
+  TEST(sys.symtable.count == 0, "sys_free cleans up symtable (shallow check)");
+
+  TEST_PASSED();
+}
 
 const test_suite_t LISP_API_SUITE = {
     .name = "Lisp API Tests",
-    .tests = TESTS_LISP_API,
+    .tests =
-    .size  = ARRSIZE(TESTS_LISP_API),
+        (test_fn[]){
+            MAKE_TEST_FN(smi_test),
+            MAKE_TEST_FN(smi_oob_test),
+            MAKE_TEST_FN(sym_fresh_test),
+            MAKE_TEST_FN(sym_unique_test),
+            MAKE_TEST_FN(cons_test),
+            MAKE_TEST_FN(sys_test),
+        },
+    .size = 6,
 };
 
 /* Copyright (C) 2026 Aryadev Chavali

test/test_stream.c

@@ -0,0 +1,78 @@
+/* test_stream.c: Stream tests
+ * Created: 2026-02-05
+ * Author: Aryadev Chavali
+ * License: See end of file
+ * Commentary:
+ */
+
+#include "./data.h"
+#include "./test.h"
+
+void stream_test_string(void)
+{
+  TODO("Not implemented");
+}
+
+void stream_test_file(void)
+{
+  TODO("Not implemented");
+}
+
+void stream_test_peek_next(void)
+{
+  TODO("Not implemented");
+}
+
+void stream_test_seek(void)
+{
+  TODO("Not implemented");
+}
+
+void stream_test_substr(void)
+{
+  TODO("Not implemented");
+}
+
+void stream_test_till(void)
+{
+  TODO("Not implemented");
+}
+
+void stream_test_while(void)
+{
+  TODO("Not implemented");
+}
+
+void stream_test_line_col(void)
+{
+  TODO("Not implemented");
+}
+
+const test_suite_t STREAM_SUITE = {
+    .name = "Stream Tests",
+    .tests =
+        (test_fn[]){
+            MAKE_TEST_FN(stream_test_string),
+            MAKE_TEST_FN(stream_test_file),
+            MAKE_TEST_FN(stream_test_peek_next),
+            MAKE_TEST_FN(stream_test_seek),
+            MAKE_TEST_FN(stream_test_substr),
+            MAKE_TEST_FN(stream_test_till),
+            MAKE_TEST_FN(stream_test_while),
+            MAKE_TEST_FN(stream_test_line_col),
+        },
+    .size = 8,
+};
+
+/* Copyright (C) 2026 Aryadev Chavali
+
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License Version 2 for
+ * details.
+
+ * You may distribute and modify this code under the terms of the GNU General
+ * Public License Version 2, which you should have received a copy of along with
+ * this program.  If not, please go to <https://www.gnu.org/licenses/>.
+
+ */

test/test_sv.c

@@ -0,0 +1,51 @@
+/* test_sv.c: String View tests
+ * Created: 2026-02-05
+ * Author: Aryadev Chavali
+ * License: See end of file
+ * Commentary:
+ */
+
+#include <assert.h>
+#include <malloc.h>
+
+#include "./data.h"
+#include "./test.h"
+
+void sv_copy_test(void)
+{
+  static_assert(ARRSIZE(unique_words) > 3, "Expected at least 3 unique words");
+  for (u64 i = 0; i < 3; ++i)
+  {
+    sv_t word = SV((char *)unique_words[i], strlen(unique_words[i]));
+    sv_t copy = sv_copy(word);
+    TEST(word.data != copy.data, "%p != %p", word.data, copy.data);
+    TEST(word.size == copy.size, "%lu == %lu", word.size, copy.size);
+    TEST(strncmp(word.data, copy.data, copy.size) == 0, "`%s` == `%s`",
+         word.data, copy.data);
+
+    // Obviously we can't just have this lying around.
+    free(copy.data);
+  }
+}
+
+const test_suite_t SV_SUITE = {
+    .name = "String View Tests",
+    .tests =
+        (test_fn[]){
+            MAKE_TEST_FN(sv_copy_test),
+        },
+    .size = 1,
+};
+
+/* Copyright (C) 2026 Aryadev Chavali
+
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License Version 2 for
+ * details.
+
+ * You may distribute and modify this code under the terms of the GNU General
+ * Public License Version 2, which you should have received a copy of along with
+ * this program.  If not, please go to <https://www.gnu.org/licenses/>.
+
+ */

test/test_symtable.c

@@ -0,0 +1,45 @@
+/* test_symtable.c: Symbol table tests
+ * Created: 2026-02-05
+ * Author: Aryadev Chavali
+ * License: See end of file
+ * Commentary:
+ */
+
+#include "./data.h"
+#include "./test.h"
+
+void symtable_test(void)
+{
+  sym_table_t table = {0};
+  sym_table_init(&table);
+  for (u64 i = 0; i < ARRSIZE(words); ++i)
+    sym_table_find(&table, SV((char *)words[i], strlen(words[i])));
+
+  TEST(table.count == ARRSIZE(unique_words), "%lu == %lu", table.count,
+       ARRSIZE(unique_words));
+
+  sym_table_free(&table);
+  TEST_PASSED();
+}
+
+const test_suite_t SYMTABLE_SUITE = {
+    .name = "Symbol Table Tests",
+    .tests =
+        (test_fn[]){
+            MAKE_TEST_FN(symtable_test),
+        },
+    .size = 1,
+};
+
+/* Copyright (C) 2026 Aryadev Chavali
+
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License Version 2 for
+ * details.
+
+ * You may distribute and modify this code under the terms of the GNU General
+ * Public License Version 2, which you should have received a copy of along with
+ * this program.  If not, please go to <https://www.gnu.org/licenses/>.
+
+ */

test/test_vec.c

@@ -8,7 +8,7 @@
 #include "./data.h"
 #include "./test.h"
 
-void vec_test1(void)
+void vec_test_concat(void)
 {
   sys_t system = {0};
   sys_init(&system);
@@ -28,14 +28,15 @@ void vec_test1(void)
 
   TEST(vec->size == ARRSIZE(words_text), "%lu == %lu", vec->size,
        ARRSIZE(words_text));
-  TEST(strncmp((char *)vec_data(vec), words_text, vec->size) == 0, "%d",
+  TEST(strncmp((char *)vec_data(vec), words_text, vec->size) == 0,
-       strncmp((char *)vec_data(vec), words_text, vec->size));
+       "%p@%lu == %p@%lu", (char *)vec_data(vec), vec->size, words_text,
+       strlen(words_text));
 
-  TEST_PASSED();
   sys_free(&system);
+  TEST_PASSED();
 }
 
-void vec_test2(void)
+void vec_test_substr(void)
 {
   sys_t system = {0};
   sys_init(&system);
@@ -60,23 +61,22 @@ void vec_test2(void)
     vec_append(as_vec(lvec), text + test.start, test.size);
     TEST(as_vec(lvec)->size > size, "%lu > %lu", as_vec(lvec)->size, size);
     TEST(strncmp((char *)vec_data(as_vec(lvec)), substr.data, substr.size) == 0,
-         "%d",
+         "%p@%lu == %p@%lu", (char *)vec_data(as_vec(lvec)), as_vec(lvec)->size,
-         strncmp((char *)vec_data(as_vec(lvec)), substr.data, substr.size));
+         substr.data, substr.size);
   }
 
-  TEST_PASSED();
   sys_free(&system);
+  TEST_PASSED();
 }
 
-const test_fn TESTS_VEC[] = {
-    MAKE_TEST_FN(vec_test1),
-    MAKE_TEST_FN(vec_test2),
-};
-
 const test_suite_t VEC_SUITE = {
     .name = "Vector Tests",
-    .tests = TESTS_VEC,
+    .tests =
-    .size  = ARRSIZE(TESTS_VEC),
+        (test_fn[]){
+            MAKE_TEST_FN(vec_test_concat),
+            MAKE_TEST_FN(vec_test_substr),
+        },
+    .size = 2,
 };
 
 /* Copyright (C) 2026 Aryadev Chavali