symbol_tests.h

Go to the documentation of this file.

/* -*- C -*-
 * Serene programming language
 * Copyright (C) 2019-2026 Sameer Rahmani <lxsameer@lxsameer.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "base.h"
#include "serene/rt/core.h"
#include "serene/rt/namespaces.h"
#include "serene/rt/protocols.h"
#include "serene/rt/strings.h"
#include "serene/rt/symbols.h"
 
#define SYMBOL_TESTS(X)                                                                \
  X("symbol::make", test_symbol_make), X("symbol::intern_symbol", test_symbol_intern), \
    X("symbol::gensym", test_gensym), X("symbol::gensym_freshness", test_gensym_freshness)
 
// Every test here works against one namespace named `serene.tests`.
static srn_namespace_t *make_test_ns(srn_context_t *ctx) {
  srn_value_t *name   = srn_string_make(ctx, &absurd_metadata, "serene.tests");
  srn_error_t *err    = nullptr;
  srn_namespace_t *ns = srn_namespace_get_or_create(ctx->engine, AS_STRING(name), &err);
  TEST_ASSERT(ns != nullptr);
  return ns;
}
 
static size_t sym_table_len(srn_namespace_t *ns) { return atomic_load(&ns->sym_table)->len; }
 
static void test_symbol_make() {
  MAKE_ENGINE(mm, engine);
  MAKE_CONTEXT(engine, ctx);
 
  srn_namespace_t *ns      = make_test_ns(ctx);
  srn_value_t *symbol_name = srn_string_make(ctx, &absurd_metadata, "foo");
  srn_value_t *sym         = srn_symbol_make(ctx, &absurd_metadata, ns, AS_STRING(symbol_name));
 
  TEST_CHECK(IS_A(sym, VSymbol));
  TEST_CHECK(AS_SYMBOL(sym)->ns == ns);
 
  TEST_CHECK(srn_string_eq(AS_SYMBOL(sym)->name, AS_STRING(symbol_name)));
 
  RELEASE_CONTEXT(ctx);
  SHUTDOWN_ENGINE(mm, engine);
}
 
static void test_symbol_intern() {
  MAKE_ENGINE(mm, engine);
  MAKE_CONTEXT(engine, ctx);
 
  srn_value_t *symname = srn_string_make(ctx, &absurd_metadata, "foo");
  srn_namespace_t *ns  = make_test_ns(ctx);
 
  srn_value_t *symbol = srn_symbol_intern(ctx, &absurd_metadata, ns, AS_STRING(symname));
 
  TEST_CHECK(sym_table_len(ns) == 1);
  TEST_CHECK(IS_A(symbol, VSymbol));
  TEST_CHECK(srn_string_eq(AS_SYMBOL(symbol)->name, AS_STRING(symname)));
 
  srn_value_t *symbol1 = srn_symbol_intern(ctx, &absurd_metadata, ns, AS_STRING(symname));
  TEST_CHECK(sym_table_len(ns) == 1);
  TEST_CHECK(IS_A(symbol1, VSymbol));
  TEST_CHECK(srn_string_eq(AS_SYMBOL(symbol1)->name, AS_STRING(symname)));
  srn_value_t *check = srn_value_eq(ctx, symbol, symbol1);
  TEST_CHECK(IS_TRUE(check));
 
  RELEASE_CONTEXT(ctx);
  SHUTDOWN_ENGINE(mm, engine);
}
 
static void test_gensym() {
  MAKE_ENGINE(mm, engine);
  MAKE_CONTEXT(engine, ctx);
 
  srn_namespace_t *ns = make_test_ns(ctx);
 
  srn_value_t *sym1 = srn_symbol_gen(ctx, &absurd_metadata, ns, nullptr);
  srn_value_t *sym2 = srn_symbol_gen(ctx, &absurd_metadata, ns, nullptr);
 
  srn_value_t *sym1_name = srn_string_make(ctx, &absurd_metadata, "gensym_101");
  srn_value_t *sym2_name = srn_string_make(ctx, &absurd_metadata, "gensym_102");
 
  // gensym should intern the symbol
  TEST_CHECK(sym_table_len(ns) == 2);
 
  TEST_CHECK(IS_A(sym1, VSymbol));
  TEST_CHECK(IS_A(sym2, VSymbol));
 
  TEST_CHECK(srn_string_eq(AS_SYMBOL(sym1)->name, AS_STRING(sym1_name)));
  TEST_CHECK(srn_string_eq(AS_SYMBOL(sym2)->name, AS_STRING(sym2_name)));
 
  RELEASE_CONTEXT(ctx);
  SHUTDOWN_ENGINE(mm, engine);
}
 
// A generated symbol must be fresh. The spelling is readable text, so a user
// symbol can occupy the name the next id would produce, and the generator
// has to move to a new id instead of returning the occupant.
static void test_gensym_freshness() {
  MAKE_ENGINE(mm, engine);
  MAKE_CONTEXT(engine, ctx);
 
  srn_namespace_t *ns = make_test_ns(ctx);
 
  // Occupy the exact spelling the next generated symbol would take. The
  // namespace consumed id 100, so the next object id is 101 (the counter
  // behavior symbol::gensym pins).
  srn_value_t *taken    = srn_string_make(ctx, &absurd_metadata, "gensym_101");
  srn_value_t *user_sym = srn_symbol_intern(ctx, &absurd_metadata, ns, AS_STRING(taken));
  TEST_CHECK(IS_A(user_sym, VSymbol));
 
  srn_value_t *g = srn_symbol_gen(ctx, &absurd_metadata, ns, nullptr);
  TEST_CHECK(IS_A(g, VSymbol));
 
  // Not the occupant, not its spelling, and interned alongside it.
  TEST_CHECK(g != user_sym);
  TEST_CHECK(!srn_string_eq(AS_SYMBOL(g)->name, AS_STRING(taken)));
  TEST_CHECK(sym_table_len(ns) == 2);
 
  RELEASE_CONTEXT(ctx);
  SHUTDOWN_ENGINE(mm, engine);
}