symbols.h

Go to the documentation of this file.

/* -*- C -*-
 * Serene programming language
 * Copyright (C) 2019-2026 Sameer Rahmani <[email protected]>
 *
 * 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
 
#include "serene/rt/core.h"
#include "serene/rt/engine.h"
 
// Notes:
// - Symbols are usique per namespace.
// - NS/Symbol combinations are unique per engine
// - Symbol's address in memory are their identifier internally
typedef struct srn_string_t srn_string_t;
typedef struct srn_namespace_t srn_namespace_t;
 
typedef struct srn_symbol_t {
  srn_string_t *name;
  srn_namespace_t *ns;
} srn_symbol_t;
 
/// Create a new symbol. IT DOES NOT INTERNALIZE THE SYMBOL.
[[gnu::nonnull(1, 3, 4)]]
srn_value_t *srn_symbol_make(srn_context_t *ctx, srn_metadata_t *metadata,
                             srn_namespace_t *ns, srn_string_t *name);
 
[[gnu::nonnull(1, 3)]]
srn_value_t *srn_symbol_intern(srn_context_t *ctx, srn_metadata_t *metadata,
                               srn_namespace_t *ns, srn_string_t *symbol_name);
 
[[gnu::nonnull(1, 3)]]
srn_value_t *srn_symbol_gen(srn_context_t *ctx, srn_metadata_t *metadata,
                            srn_namespace_t *ns, srn_string_t *optional_name);