internal/array.h

   1 #ifndef INTERNAL_ARRAY_H /* -*- C -*- */
   2 #define INTERNAL_ARRAY_H
   3 /**
   4  * @file
   5  * @brief      Internal header for Array.
   6  * @author     \@shyouhei
   7  * @copyright  This  file  is   a  part  of  the   programming  language  Ruby.
   8  *             Permission  is hereby  granted,  to  either redistribute  and/or
   9  *             modify this file, provided that  the conditions mentioned in the
  10  *             file COPYING are met.  Consult the file for details.
  11  */
  12
  13 /* array.c */
  14
  15 #ifndef ARRAY_DEBUG
  16 #define ARRAY_DEBUG (0+RUBY_DEBUG)
  17 #endif
  18
  19 #ifdef ARRAY_DEBUG
  20 #define RARRAY_PTR_IN_USE_FLAG FL_USER14
  21 #define ARY_PTR_USING_P(ary) FL_TEST_RAW((ary), RARRAY_PTR_IN_USE_FLAG)
  22 #else
  23
  24 /* disable debug function */
  25 #undef  RARRAY_PTR_USE_START_TRANSIENT
  26 #undef  RARRAY_PTR_USE_END_TRANSIENT
  27 #define RARRAY_PTR_USE_START_TRANSIENT(a) ((VALUE *)RARRAY_CONST_PTR_TRANSIENT(a))
  28 #define RARRAY_PTR_USE_END_TRANSIENT(a)
  29 #define ARY_PTR_USING_P(ary) 0
  30
  31 #endif
  32
  33 #if USE_TRANSIENT_HEAP
  34 #define RARY_TRANSIENT_SET(ary) FL_SET_RAW((ary), RARRAY_TRANSIENT_FLAG);
  35 #define RARY_TRANSIENT_UNSET(ary) FL_UNSET_RAW((ary), RARRAY_TRANSIENT_FLAG);
  36 #else
  37 #undef RARRAY_TRANSIENT_P
  38 #define RARRAY_TRANSIENT_P(a) 0
  39 #define RARY_TRANSIENT_SET(ary) ((void)0)
  40 #define RARY_TRANSIENT_UNSET(ary) ((void)0)
  41 #endif
  42
  43 VALUE rb_ary_last(int, const VALUE *, VALUE);
  44 void rb_ary_set_len(VALUE, long);
  45 void rb_ary_delete_same(VALUE, VALUE);
  46 VALUE rb_ary_tmp_new_fill(long capa);
  47 VALUE rb_ary_at(VALUE, VALUE);
  48 VALUE rb_ary_aref1(VALUE ary, VALUE i);
  49 size_t rb_ary_memsize(VALUE);
  50 VALUE rb_to_array_type(VALUE obj);
  51 VALUE rb_check_to_array(VALUE ary);
  52 VALUE rb_ary_tmp_new_from_values(VALUE, long, const VALUE *);
  53 VALUE rb_ary_behead(VALUE, long);
  54 #if defined(__GNUC__) && defined(HAVE_VA_ARGS_MACRO)
  55 #define rb_ary_new_from_args(n, ...) \
  56     __extension__ ({ \
  57         const VALUE args_to_new_ary[] = {__VA_ARGS__}; \
  58         if (__builtin_constant_p(n)) { \
  59             STATIC_ASSERT(rb_ary_new_from_args, numberof(args_to_new_ary) == (n)); \
  60         } \
  61         rb_ary_new_from_values(numberof(args_to_new_ary), args_to_new_ary); \
  62     })
  63 #endif
  64
  65 static inline VALUE
  66 rb_ary_entry_internal(VALUE ary, long offset)
  67 {
  68     long len = RARRAY_LEN(ary);
  69     const VALUE *ptr = RARRAY_CONST_PTR_TRANSIENT(ary);
  70     if (len == 0) return Qnil;
  71     if (offset < 0) {
  72         offset += len;
  73         if (offset < 0) return Qnil;
  74     }
  75     else if (len <= offset) {
  76         return Qnil;
  77     }
  78     return ptr[offset];
  79 }
  80
  81 RUBY_SYMBOL_EXPORT_BEGIN
  82 /* array.c (export) */
  83 void rb_ary_detransient(VALUE a);
  84 VALUE *rb_ary_ptr_use_start(VALUE ary);
  85 void rb_ary_ptr_use_end(VALUE ary);
  86 RUBY_SYMBOL_EXPORT_END
  87
  88 #endif /* INTERNAL_ARRAY_H */