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 <stddef.h>
 
#include "serene/rt/core.h"
 
typedef struct srn_context_t srn_context_t;
 
/// A list is a singly linked sequence of values. Nodes hold a value and a
/// pointer to the next node; the list header caches the length and points at
/// the head node. Empty lists are represented by nil_v; a list value with
/// tag `VList` always has at least one element.
typedef struct srn_list_node_t {
  srn_value_t *value;
  struct srn_list_node_t *next;
} srn_list_node_t;
 
typedef struct srn_list_t {
  size_t len;
  srn_list_node_t *head;
} srn_list_t;
 
/// Build a list from an array of elements. When `count == 0`, returns nil_v
/// (empty lists have no allocated representation). Otherwise allocates one
/// node per element plus the list header, all in `ctx`.
[[gnu::nonnull(1)]] srn_value_t *srn_list_make(srn_context_t *ctx,
                                               srn_metadata_t *metadata,
                                               srn_value_t *const *items,
                                               size_t count);
 
/// Prepend `value` to `list`, returning a new list. `list` may be nil_v
/// (treated as the empty list); the input list is not modified — its nodes
/// are shared with the returned list.
[[gnu::nonnull(1, 3, 4)]] srn_value_t *srn_list_cons(srn_context_t *ctx,
                                                     srn_metadata_t *metadata,
                                                     srn_value_t *value,
                                                     srn_value_t *list);