strings.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 <stdint.h>
 
// TODO(lxsameer): Implement the WTF8 support based on Rust's implementation
 
typedef struct srn_context_t srn_context_t;
typedef struct srn_error_t srn_error_t;
typedef struct srn_value_t srn_value_t;
typedef struct srn_metadata_t srn_metadata_t;
 
/// On top of my head, no other reason.
#define SRN_STRING_MAX_LEN (1U << 20U)
 
typedef struct srn_string_t {
  /// Size of the buffer
  size_t size;
  /// length of the WTF-8 sequence in bytes
  size_t len;
  /// The buffer that holds the WTF8 sequence.
  uint8_t buffer[];
} srn_string_t;
 
/// Create a string from a null terminated C string. IT HAS TO BE NULL
/// TERMINATED
[[gnu::nonnull(1)]] srn_value_t *
srn_string_make(srn_context_t *ctx, srn_metadata_t *metadata, const char *src);
 
[[gnu::nonnull(1)]]
size_t srn_string_size(const srn_string_t *s);
[[gnu::nonnull(1)]]
size_t srn_string_length(const srn_string_t *s);
 
/// Copy the `src` string to `dst` string. It's important to note that dst has
/// to be allocated already
[[gnu::nonnull(1, 2)]]
srn_string_t *srn_string_copy(srn_context_t *ctx, const srn_string_t *src);
 
bool srn_string_is_empty(const srn_string_t *s);
bool srn_string_eq(const srn_string_t *a, const srn_string_t *b);