error.h

Go to the documentation of this file.

#ifndef RBIMPL_INTERN_ERROR_H                        /*-*-C++-*-vi:se ft=cpp:*/
#define RBIMPL_INTERN_ERROR_H
#include "ruby/internal/attr/format.h"
#include "ruby/internal/attr/noreturn.h"
#include "ruby/internal/dllexport.h"
#include "ruby/internal/value.h"
#include "ruby/internal/fl_type.h"
#include "ruby/backward/2/assume.h"
 
#define UNLIMITED_ARGUMENTS     (-1)
 
#define rb_exc_new2             rb_exc_new_cstr  
#define rb_exc_new3             rb_exc_new_str  
#define rb_check_arity          rb_check_arity
RBIMPL_SYMBOL_EXPORT_BEGIN()
 
/* error.c */
 
 
VALUE rb_exc_new(VALUE etype, const char *ptr, long len);
 
RBIMPL_ATTR_NONNULL(())
VALUE rb_exc_new_cstr(VALUE etype, const char *str);
 
VALUE rb_exc_new_str(VALUE etype, VALUE str);
 
RBIMPL_ATTR_NORETURN()
RBIMPL_ATTR_NONNULL((1))
RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
void rb_loaderror(const char *fmt, ...);
 
RBIMPL_ATTR_NORETURN()
RBIMPL_ATTR_NONNULL((2))
RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
void rb_loaderror_with_path(VALUE path, const char *fmt, ...);
 
RBIMPL_ATTR_NORETURN()
RBIMPL_ATTR_NONNULL((2))
RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
void rb_name_error(ID name, const char *fmt, ...);
 
RBIMPL_ATTR_NORETURN()
RBIMPL_ATTR_NONNULL((2))
RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
void rb_name_error_str(VALUE name, const char *fmt, ...);
 
RBIMPL_ATTR_NORETURN()
RBIMPL_ATTR_NONNULL((2))
RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
void rb_frozen_error_raise(VALUE recv, const char *fmt, ...);
 
RBIMPL_ATTR_NORETURN()
RBIMPL_ATTR_NONNULL(())
void rb_invalid_str(const char *str, const char *type);
 
RBIMPL_ATTR_NORETURN()
RBIMPL_ATTR_NONNULL(())
void rb_error_frozen(const char *what);
 
RBIMPL_ATTR_NORETURN()
void rb_error_frozen_object(VALUE what);
 
void rb_check_frozen(VALUE obj);
 
void rb_check_copyable(VALUE obj, VALUE orig);
 
RBIMPL_ATTR_NORETURN()
void rb_error_arity(int argc, int min, int max);
 
void rb_str_modify(VALUE str);
 
RBIMPL_SYMBOL_EXPORT_END()
 
#define rb_check_frozen_internal rb_check_frozen
 
static inline void
rb_check_frozen_inline(VALUE obj)
{
    if (RB_UNLIKELY(RB_OBJ_FROZEN(obj))) {
        rb_error_frozen_object(obj);
    }
 
    /* ref: internal CHILLED_STRING_P()
       This is an implementation detail subject to change. */
    if (RB_UNLIKELY(RB_TYPE_P(obj, T_STRING) && FL_TEST_RAW(obj, RUBY_FL_USER3))) {
        rb_str_modify(obj);
    }
}
 
/* rb_check_frozen() is available as a symbol, but have
 * the inline version take priority for native consumers. */
#define rb_check_frozen rb_check_frozen_inline
 
static inline int
rb_check_arity(int argc, int min, int max)
{
    if ((argc < min) || (max != UNLIMITED_ARGUMENTS && argc > max))
        rb_error_arity(argc, min, max);
    return argc;
}
 
#endif /* RBIMPL_INTERN_ERROR_H */