errors.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/>.
 */
 
// IMPORTANT NOTE:
// By Convention, all the data structures that in anyway may, interacting with
// them may result in an error, must use the ERROR_HEADER macro as the first
// member. For example:
//
// typedef struct foo {
//   ERROR_HEADER
//   bar other;
//   ...
// } foo;
//
// Following this convention let you use the error handling helpers from this
// header uniformly across the runtime library.
 
#pragma once
 
#define ERROR_HEADER srn_error_t *maybe_error
 
typedef struct srn_context_t srn_context_t;
 
#ifdef SRN_WITH_SERENE
typedef struct srn_value_t srn_value_t;
typedef struct srn_metadata_t srn_metadata_t;
#endif
 
typedef enum srn_error_tag_t {
  ABSURD,
  SEQ_LIMIT_REACHED,
  INDEX_OUT_OF_BOUND,
  CORRUPTED_SEQ,        ///< When the memory layout of a seq is incorrect
  FAILED_TO_ADD_MODULE, ///< Failed to add a module to the jit engine
  EMPTY_NAMESPACE_NAME,
  EMPTY_SYMBOL_NAME,
  STRING_LENGTH_LIMIT_EXCEEDED,
} srn_error_tag_t;
 
typedef struct srn_error_t {
  srn_error_tag_t tag;
  char *msg;
} srn_error_t;
 
srn_error_t *srn_errors_make(const srn_context_t *ctx, srn_error_tag_t tag,
                             const char *msg);
 
#ifdef SRN_WITH_SERENE
srn_value_t *srn_errors_err_to_value(srn_context_t *ctx,
                                     srn_metadata_t *metadata,
                                     srn_error_t *err);
/// Create an error as a value. In compare to `srn_errors_make` this function
/// populates the `sr_value_t` data structure, so the returning value can be
/// used in Serene lang directly.
srn_value_t *srn_errors_make_error(srn_context_t *ctx, srn_metadata_t *metadata,
                                   srn_error_tag_t tag, const char *msg);
#endif
 
#define ERR(ctx, err, msg) srn_errors_make(ctx, err, msg)