1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/internal/hash.h
卜部昌平 e72b8592d9 internal/hash.h rework
Reduce macros to make them inline functions, as well as mark
MJIT_FUNC_EXPORTED functions explicitly as such.

Definition of ar_hint_t is simplified.  This has been the only possible
definition so far.
2019-12-26 20:45:12 +09:00

228 lines
6.1 KiB
C

#ifndef INTERNAL_HASH_H /* -*- C -*- */
#define INTERNAL_HASH_H
/**
* @file
* @brief Internal header for Hash.
* @author \@shyouhei
* @copyright This file is a part of the programming language Ruby.
* Permission is hereby granted, to either redistribute and/or
* modify this file, provided that the conditions mentioned in the
* file COPYING are met. Consult the file for details.
*/
#include "ruby/config.h"
#include <stddef.h> /* for size_t */
#include "internal/stdbool.h" /* for bool */
#include "ruby/ruby.h" /* for struct RBasic */
#include "ruby/st.h" /* for struct st_table */
#define RHASH_AR_TABLE_MAX_SIZE SIZEOF_VALUE
struct ar_table_struct;
typedef unsigned char ar_hint_t;
enum ruby_rhash_flags {
RHASH_PASS_AS_KEYWORDS = FL_USER1, /* FL 1 */
RHASH_PROC_DEFAULT = FL_USER2, /* FL 2 */
RHASH_ST_TABLE_FLAG = FL_USER3, /* FL 3 */
RHASH_AR_TABLE_SIZE_MASK = (FL_USER4|FL_USER5|FL_USER6|FL_USER7), /* FL 4..7 */
RHASH_AR_TABLE_SIZE_SHIFT = (FL_USHIFT+4),
RHASH_AR_TABLE_BOUND_MASK = (FL_USER8|FL_USER9|FL_USER10|FL_USER11), /* FL 8..11 */
RHASH_AR_TABLE_BOUND_SHIFT = (FL_USHIFT+8),
#if USE_TRANSIENT_HEAP
RHASH_TRANSIENT_FLAG = FL_USER12, /* FL 12 */
#endif
// we can not put it in "enum" because it can exceed "int" range.
#define RHASH_LEV_MASK (FL_USER13 | FL_USER14 | FL_USER15 | /* FL 13..19 */ \
FL_USER16 | FL_USER17 | FL_USER18 | FL_USER19)
RHASH_LEV_SHIFT = (FL_USHIFT + 13),
RHASH_LEV_MAX = 127, /* 7 bits */
};
struct RHash {
struct RBasic basic;
union {
st_table *st;
struct ar_table_struct *ar; /* possibly 0 */
} as;
const VALUE ifnone;
union {
ar_hint_t ary[RHASH_AR_TABLE_MAX_SIZE];
VALUE word;
} ar_hint;
};
#define RHASH(obj) (R_CAST(RHash)(obj))
#undef RHASH_IFNONE
#undef RHASH_SIZE
/* hash.c */
void rb_hash_st_table_set(VALUE hash, st_table *st);
VALUE rb_hash_default_value(VALUE hash, VALUE key);
VALUE rb_hash_set_default_proc(VALUE hash, VALUE proc);
long rb_dbl_long_hash(double d);
st_table *rb_init_identtable(void);
VALUE rb_to_hash_type(VALUE obj);
VALUE rb_hash_key_str(VALUE);
VALUE rb_hash_values(VALUE hash);
VALUE rb_hash_rehash(VALUE hash);
int rb_hash_add_new_element(VALUE hash, VALUE key, VALUE val);
VALUE rb_hash_set_pair(VALUE hash, VALUE pair);
int rb_hash_stlike_delete(VALUE hash, st_data_t *pkey, st_data_t *pval);
int rb_hash_stlike_foreach_with_replace(VALUE hash, st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg);
int rb_hash_stlike_update(VALUE hash, st_data_t key, st_update_callback_func *func, st_data_t arg);
static inline unsigned RHASH_AR_TABLE_SIZE_RAW(VALUE h);
static inline VALUE RHASH_IFNONE(VALUE h);
static inline size_t RHASH_SIZE(VALUE h);
static inline bool RHASH_AR_TABLE_P(VALUE h);
static inline bool RHASH_ST_TABLE_P(VALUE h);
static inline struct ar_table_struct *RHASH_AR_TABLE(VALUE h);
static inline st_table *RHASH_ST_TABLE(VALUE h);
static inline size_t RHASH_ST_SIZE(VALUE h);
static inline void RHASH_ST_CLEAR(VALUE h);
static inline bool RHASH_TRANSIENT_P(VALUE h);
static inline void RHASH_SET_TRANSIENT_FLAG(VALUE h);
static inline void RHASH_UNSET_TRANSIENT_FLAG(VALUE h);
RUBY_SYMBOL_EXPORT_BEGIN
/* hash.c (export) */
VALUE rb_hash_delete_entry(VALUE hash, VALUE key);
VALUE rb_ident_hash_new(void);
int rb_hash_stlike_foreach(VALUE hash, st_foreach_callback_func *func, st_data_t arg);
RUBY_SYMBOL_EXPORT_END
MJIT_SYMBOL_EXPORT_BEGIN
VALUE rb_hash_new_with_size(st_index_t size);
VALUE rb_hash_resurrect(VALUE hash);
int rb_hash_stlike_lookup(VALUE hash, st_data_t key, st_data_t *pval);
VALUE rb_hash_keys(VALUE hash);
VALUE rb_hash_has_key(VALUE hash, VALUE key);
VALUE rb_hash_compare_by_id_p(VALUE hash);
#if RHASH_CONVERT_TABLE_DEBUG
st_table *rb_hash_tbl_raw(VALUE hash, const char *file, int line);
#define RHASH_TBL_RAW(h) rb_hash_tbl_raw(h, __FILE__, __LINE__)
#else
st_table *rb_hash_tbl_raw(VALUE hash);
#define RHASH_TBL_RAW(h) rb_hash_tbl_raw(h)
#endif
MJIT_SYMBOL_EXPORT_END
#if 0 /* for debug */
static inline bool
RHASH_AR_TABLE_P(VALUE h)
{
extern int rb_hash_ar_table_p(VALUE hash);
return rb_hash_ar_table_p(h)
}
static inline struct ar_table_struct *
RHASH_AR_TABLE(VALUE h)
{
extern struct ar_table_struct *rb_hash_ar_table(VALUE hash);
return rb_hash_ar_table(h)
}
static inline st_table *
RHASH_ST_TABLE(VALUE h)
{
extern st_table *rb_hash_st_table(VALUE hash);
return rb_hash_st_table(h)
}
#else
static inline bool
RHASH_AR_TABLE_P(VALUE h)
{
return ! FL_TEST_RAW(h, RHASH_ST_TABLE_FLAG);
}
static inline struct ar_table_struct *
RHASH_AR_TABLE(VALUE h)
{
return RHASH(h)->as.ar;
}
static inline st_table *
RHASH_ST_TABLE(VALUE h)
{
return RHASH(h)->as.st;
}
#endif
static inline VALUE
RHASH_IFNONE(VALUE h)
{
return RHASH(h)->ifnone;
}
static inline size_t
RHASH_SIZE(VALUE h)
{
if (RHASH_AR_TABLE_P(h)) {
return RHASH_AR_TABLE_SIZE_RAW(h);
}
else {
return RHASH_ST_SIZE(h);
}
}
static inline bool
RHASH_ST_TABLE_P(VALUE h)
{
return ! RHASH_AR_TABLE_P(h);
}
static inline size_t
RHASH_ST_SIZE(VALUE h)
{
return RHASH_ST_TABLE(h)->num_entries;
}
static inline void
RHASH_ST_CLEAR(VALUE h)
{
FL_UNSET_RAW(h, RHASH_ST_TABLE_FLAG);
RHASH(h)->as.ar = NULL;
}
static inline unsigned
RHASH_AR_TABLE_SIZE_RAW(VALUE h)
{
unsigned ret = FL_TEST_RAW(h, RHASH_AR_TABLE_SIZE_MASK);
ret >>= RHASH_AR_TABLE_SIZE_SHIFT;
return ret;
}
static inline bool
RHASH_TRANSIENT_P(VALUE h)
{
#if USE_TRANSIENT_HEAP
return FL_TEST_RAW(h, RHASH_TRANSIENT_FLAG);
#else
return false;
#endif
}
static inline void
RHASH_SET_TRANSIENT_FLAG(VALUE h)
{
#if USE_TRANSIENT_HEAP
FL_SET_RAW(h, RHASH_TRANSIENT_FLAG);
#endif
}
static inline void
RHASH_UNSET_TRANSIENT_FLAG(VALUE h)
{
#if USE_TRANSIENT_HEAP
FL_UNSET_RAW(h, RHASH_TRANSIENT_FLAG);
#endif
}
#endif /* INTERNAL_HASH_H */