protocols.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/engine.h"
 
typedef struct srn_context_t srn_context_t;
typedef struct srn_value_t srn_value_t;
 
// TODO(lxsameer): This is a short term solution. We need to implement protocols
// in Serene and use them to implement `eq` functionality.
 
/// Check to values for equality. Return a boolean
srn_value_t *srn_value_eq(const srn_context_t *ctx, const srn_value_t *a, const srn_value_t *b);
 
/// Compute the xxHash32 of a value using the engine seed. The invariant
/// srn_value_eq(a, b) == true_v  =>  srn_value_hash(a) == srn_value_hash(b)
/// must hold for every tag.
[[gnu::nonnull(1, 2)]]
srn_hash_t srn_value_hash(const srn_context_t *ctx, const srn_value_t *v);
 
/// Whether `v` can be a hash key. srn_value_hash panics on the container and
/// closure tags, so anything keying a map must pass this first and fail as an
/// error value instead.
[[nodiscard]] [[gnu::nonnull(1)]]
bool srn_value_hashable(const srn_value_t *v);