Gecko [ naturenectar.co.uk ]

Name	Size	Permission	Date
backward	[ DIR ]	drwxr-xr-x	2025-08-15 19:34
fiber	[ DIR ]	drwxr-xr-x	2025-08-15 19:34
internal	[ DIR ]	drwxr-xr-x	2025-08-15 19:34
io	[ DIR ]	drwxr-xr-x	2025-08-15 19:34
assert.h	10.25 KB	-rw-r--r--	2025-05-29 14:04
atomic.h	27.62 KB	-rw-r--r--	2025-05-29 14:04
backward.h	1.12 KB	-rw-r--r--	2025-05-29 14:04
config.h	14.3 KB	-rw-r--r--	2025-05-29 14:04
debug.h	29.28 KB	-rw-r--r--	2025-05-29 14:04
defines.h	2.76 KB	-rw-r--r--	2025-05-29 14:04
digest.h	3.1 KB	-rw-r--r--	2025-05-29 14:04
encoding.h	1.28 KB	-rw-r--r--	2025-05-29 14:04
intern.h	2.3 KB	-rw-r--r--	2025-05-29 14:04
io.h	36.83 KB	-rw-r--r--	2025-05-29 14:04
memory_view.h	10.78 KB	-rw-r--r--	2025-05-29 14:04
missing.h	6.67 KB	-rw-r--r--	2025-05-29 14:04
onigmo.h	43.9 KB	-rw-r--r--	2025-05-29 14:04
oniguruma.h	262 B	-rw-r--r--	2025-05-29 14:04
ractor.h	8.71 KB	-rw-r--r--	2025-05-29 14:04
random.h	11.51 KB	-rw-r--r--	2025-05-29 14:04
re.h	6.64 KB	-rw-r--r--	2025-05-29 14:04
regex.h	1011 B	-rw-r--r--	2025-05-29 14:04
ruby.h	14.74 KB	-rw-r--r--	2025-05-29 14:04
st.h	7.48 KB	-rw-r--r--	2025-05-29 14:04
subst.h	806 B	-rw-r--r--	2025-05-29 14:04
thread.h	12.29 KB	-rw-r--r--	2025-05-29 14:04
thread_native.h	6.67 KB	-rw-r--r--	2025-05-29 14:04
util.h	8.57 KB	-rw-r--r--	2025-05-29 14:04
version.h	4.76 KB	-rw-r--r--	2025-05-29 14:04
vm.h	2.25 KB	-rw-r--r--	2025-05-29 14:04

Rename

#ifndef RUBY_VM_H                                    /*-*-C++-*-vi:se ft=cpp:*/
#define RUBY_VM_H 1
/**
 * @file
 * @author     $Author$
 * @date       Sat May 31 15:17:36 2008
 * @copyright  Copyright (C) 2008 Yukihiro Matsumoto
 * @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.
 *
 * We  planned to  have multiple  VMs  run side-by-side.   The API  here was  a
 * preparation of that feature.  The topic branch was eventually abandoned, and
 * we now have Ractor.  This file is kind of obsolescent.
 */
#include "ruby/internal/dllexport.h"

RBIMPL_SYMBOL_EXPORT_BEGIN()

/**
 * The opaque struct to hold VM internals.  Its fields are intentionally hidden
 * from extension libraries because it changes drastically time to time.
 */
typedef struct rb_vm_struct ruby_vm_t;

/**
 * Destructs the  passed VM.   You don't  have to call  this API  directly now,
 * because there is  no way to create one.   There is only one VM  at one time.
 * ruby_stop() should just suffice.
 */
int ruby_vm_destruct(ruby_vm_t *vm);

/**
 * ruby_vm_at_exit registers a function _func_ to be invoked when a VM
 * passed away.  Functions registered this way runs in reverse order
 * of registration, just like END {} block does.  The difference is
 * its timing to be triggered. ruby_vm_at_exit functions runs when a
 * VM _passed_ _away_, while END {} blocks runs just _before_ a VM
 * _is_ _passing_ _away_.
 *
 * You cannot register a function to another VM than where you are in.
 * So where to register is intuitive, omitted.  OTOH the argument
 * _func_ cannot know which VM it is in because at the time of
 * invocation, the VM has already died and there is no execution
 * context.  The VM itself is passed as the first argument to it.
 *
 * @param[in] func the function to register.
 */
void ruby_vm_at_exit(void(*func)(ruby_vm_t *));

/**
 * Returns whether the Ruby VM will free all memory at shutdown.
 *
 * @return true if free-at-exit is enabled, false otherwise.
 */
bool ruby_free_at_exit_p(void);

RBIMPL_SYMBOL_EXPORT_END()

#endif /* RUBY_VM_H */