lists.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/values.h"
// -----------------------------------------------------------------------------
// Pairs/Cons & Lists
// We refer to cons as pairs just to reduce the confusing situations where we
// don't know what cons are we talking about, lisp cons? cons the functions?
// cons the constructor?
// -----------------------------------------------------------------------------
typedef struct srn_pair_t {
  srn_header_t *header;
  srn_value_t left;
  srn_value_t right;
} srn_pair_t;
 
/// Since all the values are immutable and persistent. A List is just a metadata
/// on top of a chain of pairs
typedef struct srn_list_t {
  srn_header_t *header;
  srn_pair_t *head;
  size_t length;
} srn_list_t;
 
static inline bool srn_is_pair(srn_value_t v) {
  return ((v & TAG_PRIM_MASK) == TAG_PAIR);
}
 
static inline bool srn_is_list(srn_value_t v) {
  return ((v & TAG_PRIM_MASK) == TAG_LIST);
}
 
/// Create a new pair of values in the given context `ctx`.
[[gnu::nonnull(1)]] srn_value_t srn_make_pair(srn_context_t *ctx,
                                              srn_src_location_t *loc,
                                              srn_value_t left,
                                              srn_value_t right);
 
/// Create a new list and empty list
[[gnu::nonnull(1)]] srn_value_t srn_make_list(srn_context_t *ctx);
 
/// Add the given value `v` to the front of the list and returns the new list.
[[gnu::nonnull(1)]] srn_value_t srn_conj_list(srn_context_t *ctx,
                                              srn_src_location_t *loc,
                                              srn_list_t *head, srn_value_t v);