/**********************************************************************

[0] Fix | Delete

[1] Fix | Delete

ruby/vm.h -

[2] Fix | Delete

[3] Fix | Delete

$Author$

[4] Fix | Delete

created at: Sat May 31 15:17:36 2008

[5] Fix | Delete

[6] Fix | Delete

Copyright (C) 2008 Yukihiro Matsumoto

[7] Fix | Delete

[8] Fix | Delete

**********************************************************************/

[9] Fix | Delete

[10] Fix | Delete

#ifndef RUBY_VM_H

[11] Fix | Delete

#define RUBY_VM_H 1

[12] Fix | Delete

[13] Fix | Delete

#if defined(__cplusplus)

[14] Fix | Delete

extern "C" {

[15] Fix | Delete

#if 0

[16] Fix | Delete

} /* satisfy cc-mode */

[17] Fix | Delete

#endif

[18] Fix | Delete

#endif

[19] Fix | Delete

[20] Fix | Delete

RUBY_SYMBOL_EXPORT_BEGIN

[21] Fix | Delete

[22] Fix | Delete

/* Place holder.

[23] Fix | Delete

*

[24] Fix | Delete

* We will prepare VM creation/control APIs on 1.9.2 or later.

[25] Fix | Delete

*

[26] Fix | Delete

*/

[27] Fix | Delete

[28] Fix | Delete

/* VM type declaration */

[29] Fix | Delete

typedef struct rb_vm_struct ruby_vm_t;

[30] Fix | Delete

[31] Fix | Delete

/* core API */

[32] Fix | Delete

int ruby_vm_destruct(ruby_vm_t *vm);

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* ruby_vm_at_exit registers a function _func_ to be invoked when a VM

[36] Fix | Delete

* passed away. Functions registered this way runs in reverse order

[37] Fix | Delete

* of registration, just like END {} block does. The difference is

[38] Fix | Delete

* its timing to be triggered. ruby_vm_at_exit functions runs when a

[39] Fix | Delete

* VM _passed_ _away_, while END {} blocks runs just _before_ a VM

[40] Fix | Delete

* _is_ _passing_ _away_.

[41] Fix | Delete

*

[42] Fix | Delete

* You cannot register a function to another VM than where you are in.

[43] Fix | Delete

* So where to register is intuitive, omitted. OTOH the argument

[44] Fix | Delete

* _func_ cannot know which VM it is in because at the time of

[45] Fix | Delete

* invocation, the VM has already died and there is no execution

[46] Fix | Delete

* context. The VM itself is passed as the first argument to it.

[47] Fix | Delete

*

[48] Fix | Delete

* @param[in] func the function to register.

[49] Fix | Delete

*/

[50] Fix | Delete

void ruby_vm_at_exit(void(*func)(ruby_vm_t *));

[51] Fix | Delete

[52] Fix | Delete

RUBY_SYMBOL_EXPORT_END

[53] Fix | Delete

[54] Fix | Delete

#if defined(__cplusplus)

[55] Fix | Delete

#if 0

[56] Fix | Delete

{ /* satisfy cc-mode */

[57] Fix | Delete

#endif

[58] Fix | Delete

} /* extern "C" { */

[59] Fix | Delete

#endif

[60] Fix | Delete

[61] Fix | Delete

#endif /* RUBY_VM_H */

[62] Fix | Delete

[63] Fix | Delete