Ruby: id_table.h Source File

Ruby 3.3.7p123 (2025-01-15 revision be31f993d7fa0219d85f7b3c694d454da4ecc10b)

id_table.h
1#ifndef RUBY_ID_TABLE_H
2#define RUBY_ID_TABLE_H 1
3#include "ruby/internal/config.h"
4#include <stddef.h>
5#include "ruby/ruby.h"
6
7struct rb_id_table;
8
9/* compatible with ST_* */
10enum rb_id_table_iterator_result {
11 ID_TABLE_CONTINUE = ST_CONTINUE,
12 ID_TABLE_STOP = ST_STOP,
13 ID_TABLE_DELETE = ST_DELETE,
14 ID_TABLE_REPLACE = ST_REPLACE,
15 ID_TABLE_ITERATOR_RESULT_END
16};
17
18struct rb_id_table *rb_id_table_create(size_t size);
19void rb_id_table_free(struct rb_id_table *tbl);
20void rb_id_table_clear(struct rb_id_table *tbl);
21
22size_t rb_id_table_memsize(const struct rb_id_table *tbl);
23
24int rb_id_table_insert(struct rb_id_table *tbl, ID id, VALUE val);
25int rb_id_table_lookup(struct rb_id_table *tbl, ID id, VALUE *valp);
26int rb_id_table_delete(struct rb_id_table *tbl, ID id);
27
28typedef enum rb_id_table_iterator_result rb_id_table_update_value_callback_func_t(VALUE *val, void *data, int existing);
29typedef enum rb_id_table_iterator_result rb_id_table_foreach_func_t(ID id, VALUE val, void *data);
30typedef enum rb_id_table_iterator_result rb_id_table_foreach_values_func_t(VALUE val, void *data);
31void rb_id_table_foreach(struct rb_id_table *tbl, rb_id_table_foreach_func_t *func, void *data);
32void rb_id_table_foreach_values(struct rb_id_table *tbl, rb_id_table_foreach_values_func_t *func, void *data);
33void rb_id_table_foreach_values_with_replace(struct rb_id_table *tbl, rb_id_table_foreach_values_func_t *func, rb_id_table_update_value_callback_func_t *replace, void *data);
34
35RUBY_SYMBOL_EXPORT_BEGIN
36size_t rb_id_table_size(const struct rb_id_table *tbl);
37RUBY_SYMBOL_EXPORT_END
38
39#endif /* RUBY_ID_TABLE_H */
ruby.h
rb_id_table
Definition id_table.c:41
ID
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40