1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/include/ruby/vm.h
卜部昌平 4ff3f20540 add #include guard hack
According to MSVC manual (*1), cl.exe can skip including a header file
when that:

- contains #pragma once, or
- starts with #ifndef, or
- starts with #if ! defined.

GCC has a similar trick (*2), but it acts more stricter (e. g. there
must be _no tokens_ outside of #ifndef...#endif).

Sun C lacked #pragma once for a looong time.  Oracle Developer Studio
12.5 finally implemented it, but we cannot assume such recent version.

This changeset modifies header files so that each of them include
strictly one #ifndef...#endif.  I believe this is the most portable way
to trigger compiler optimizations. [Bug #16770]

*1: https://docs.microsoft.com/en-us/cpp/preprocessor/once
*2: https://gcc.gnu.org/onlinedocs/cppinternals/Guard-Macros.html
2020-04-13 16:06:00 +09:00

49 lines
1.6 KiB
C++

#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.
*/
#include "ruby/3/dllexport.h"
RUBY3_SYMBOL_EXPORT_BEGIN()
/* Place holder.
*
* We will prepare VM creation/control APIs on 1.9.2 or later.
*
*/
/* VM type declaration */
typedef struct rb_vm_struct ruby_vm_t;
/* core API */
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 *));
RUBY3_SYMBOL_EXPORT_END()
#endif /* RUBY_VM_H */