namespaces.h

Go to the documentation of this file.

/* -*- C -*-
 * Serene programming language
 * Copyright (C) 2019-2026 Sameer Rahmani <lxsameer@lxsameer.com>
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <https://www.gnu.org/licenses/>.
 */
#pragma once
 
/** @file
A namespace is an isolation for names nad technically a compilation unit. Typically each namespace
will resolve to a single file on the filesystem. Namespaces maintain a sym table that maps global
names that the namespace provides to their definition.
 */
 
#include <stdatomic.h>
 
#include "serene/rt/context.h"
#include "serene/rt/engine.h"
#include "serene/rt/impl/hashmap.h"
#include "serene/rt/source_manager.h"
#include "serene/utils.h"
 
typedef struct srn_string_t srn_string_t;
typedef struct srn_fiber_mutex_t srn_fiber_mutex_t;
typedef struct srn_term_t srn_term_t;
typedef struct srn_engine_t srn_engine_t;
 
typedef struct srn_namespace_t {
  srn_string_t *name;
  srn_object_id_t id;
  /// Designated buffer id of this namespace on the source manager.
  srn_sm_buffer_id_t buffer_id;
 
  srn_context_t *root_context;
 
  /// A mapping symbol names to `srn_nodet_t` values.
  /// Since `hmap_t` hashes out the name, it's really a mapping from unsigned
  /// 32bit integer to `srn_nodet_t` values
  _Atomic(hmap_t *) sym_table;
  /// Only when setting the sym_table hmap it self
  srn_fiber_mutex_t *sym_table_lock;
 
  /// The top level node of the namespace. Each namespace should have just ONE node at the top which
  /// is the node that describes the namespace itself (Similar to how clojure namespaces work)
  srn_term_t *node;
} srn_namespace_t;
 
/**
 * Create a new and empty namespace if it is not already created in the engine, if it exists, return
 * the namespace. Note that in case of creation, this function will register the new namespace with
 * the `engine`.
 */
[[gnu::nonnull(1, 2)]]
srn_namespace_t *
srn_namespace_get_or_create(srn_engine_t *engine, srn_string_t *name, srn_error_t **err);
 
/**
 * Load the namespace's source from the filesystem into `src_buffer`, parse it, and populate the
 * symbol table. Not implemented, the current body returns null unconditionally, so callers cannot
 * rely on it yet.
 */
[[gnu::nonnull(1)]]
srn_namespace_t *srn_namespace_load(srn_namespace_t *ns);