ruby/vm_debug.h

#ifndef RUBY_DEBUG_H
#define RUBY_DEBUG_H
/**********************************************************************

  vm_debug.h - YARV Debug function interface

  $Author$
  created at: 04/08/25 02:33:49 JST

  Copyright (C) 2004-2007 Koichi Sasada

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

#include "ruby/ruby.h"
#include "node.h"

RUBY_SYMBOL_EXPORT_BEGIN

#define dpv(h,v) ruby_debug_print_value(-1, 0, (h), (v))
#define dp(v)    ruby_debug_print_value(-1, 0, "", (v))
#define dpi(i)   ruby_debug_print_id(-1, 0, "", (i))
#define dpn(n)   ruby_debug_print_node(-1, 0, "", (n))

VALUE ruby_debug_print_value(int level, int debug_level, const char *header, VALUE v);
ID    ruby_debug_print_id(int level, int debug_level, const char *header, ID id);
NODE *ruby_debug_print_node(int level, int debug_level, const char *header, const NODE *node);
int   ruby_debug_print_indent(int level, int debug_level, int indent_level);
void  ruby_debug_gc_check_func(void);
void ruby_set_debug_option(const char *str);

RUBY_SYMBOL_EXPORT_END

#endif /* RUBY_DEBUG_H */
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-10 08:11:40 +03:00			`#ifndef RUBY_DEBUG_H`
			`#define RUBY_DEBUG_H`
* Merge YARV git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@11439 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2006-12-31 18:02:22 +03:00			`/**********************************************************************`

* include/ruby/debug.h: introdudced. Debugging/profiling features will be located. * vm_trace.c: expose C-level TracePoint APIs. Note that they are experimental. * vm_trace.c, include/ruby/debug.h: rename `rb_hook_flag_t' to `rb_event_hook_flag_t'. Macro names `RUBY_HOOK_FLAG_' are also renamed to `RUBY_EVENT_HOOK_FLAG_'. * debug.h, vm_debug.h: rename debug.h to vm_debug.h. * common.mk: ditto. * debug.c, main.c, vm_core.h: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37765 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2012-11-20 16:57:49 +04:00			`vm_debug.h - YARV Debug function interface`
* Merge YARV git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@11439 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2006-12-31 18:02:22 +03:00
			$Author$
			`created at: 04/08/25 02:33:49 JST`

* blockinlining.c, compile.c, compile.h, debug.c, debug.h, id.c, insnhelper.h, insns.def, thread.c, thread_pthread.ci, thread_pthread.h, thread_win32.ci, thread_win32.h, vm.h, vm_dump.c, vm_evalbody.ci, vm_opts.h: fix comments and copyright year. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@13920 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2007-11-14 01:13:04 +03:00			`Copyright (C) 2004-2007 Koichi Sasada`
* Merge YARV git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@11439 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2006-12-31 18:02:22 +03:00
			`**********************************************************************/`

* include/ruby: moved public headers. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@12501 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2007-06-10 07:06:15 +04:00			`#include "ruby/ruby.h"`
* include/ruby/node.h, node.h: move node.h from include path. This change stop to install node.h beacuase of saving ABI (node.h will be changed. Extensions should not depends on this file). * blockinlining.c, class.c, compile.c, debug.h, enum.c, gc.c, iseq.c, parse.y, ruby.c, signal.c, variable.c, vm.c, vm_core.h, vm_dump.c: ditto. * ext/ripper/depend: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@19500 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2008-09-23 23:52:31 +04:00			`#include "node.h"`
* Merge YARV git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@11439 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2006-12-31 18:02:22 +03:00
defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} * include/ruby/defines.h (RUBY_SYMBOL_EXPORT_{BEGIN,END}): visibility control macros. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40122 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2013-04-05 14:29:38 +04:00			`RUBY_SYMBOL_EXPORT_BEGIN`
* configure.in (XCFLAGS): use -fvisibility=hidden if possible. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28709 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2010-07-22 01:38:25 +04:00
* debug.h: parenthesize macro arguments. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30582 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2011-01-17 16:54:54 +03:00			`#define dpv(h,v) ruby_debug_print_value(-1, 0, (h), (v))`
			`#define dp(v) ruby_debug_print_value(-1, 0, "", (v))`
			`#define dpi(i) ruby_debug_print_id(-1, 0, "", (i))`
			`#define dpn(n) ruby_debug_print_node(-1, 0, "", (n))`
* call_cfunc.ci: removed. * insnhelper.ci: added. this function includes all functions that vm insns need. * common.mk: ditto. * insnhelper.h, vm.h, vm.c: move some declaration. * gc.h: remove GC_CHECK() macro because GC.stress is more useful. * compile.c, iseq.c, vm_dump: ditto. * gc.h, thread.c: move a prototype decalaration. * debug.c, debug.h: rename some functions. * compile.h: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@12605 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2007-06-24 21:19:22 +04:00
* debug.h: constified. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@12666 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2007-06-29 12:10:16 +04:00			`VALUE ruby_debug_print_value(int level, int debug_level, const char *header, VALUE v);`
			`ID ruby_debug_print_id(int level, int debug_level, const char *header, ID id);`
			`NODE ruby_debug_print_node(int level, int debug_level, const char header, const NODE *node);`
* compile.c, compile.h (compile_debug): made runtime option. * debug.c (ruby_debug_print_indent): returns if debug_level exceeds the threashold. * debug.c (ruby_debug_printf): printf to stderr. * iseq.c (make_compile_option, make_compile_option_value): added debug_level option. * vm_core.h (rb_compile_option_t): added debug_level. * vm_core.h (struct iseq_compile_data): added node_level. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@16003 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2008-04-14 09:34:04 +04:00			`int ruby_debug_print_indent(int level, int debug_level, int indent_level);`
* regparse.c, etc.: K&R to ANSI code cleanup patch from Stefan Huehner <stefan at huehner.org>. [ruby-core:10543] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@12095 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2007-03-19 06:58:57 +03:00			`void ruby_debug_gc_check_func(void);`
* debug.h (ruby_set_debug_option): declared. * main.c: include debug.h. * common.mk (main.$(OBJEXT)): dependency updated. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@19475 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2008-09-23 12:03:41 +04:00			`void ruby_set_debug_option(const char *str);`

defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} * include/ruby/defines.h (RUBY_SYMBOL_EXPORT_{BEGIN,END}): visibility control macros. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40122 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2013-04-05 14:29:38 +04:00			`RUBY_SYMBOL_EXPORT_END`
* configure.in (XCFLAGS): use -fvisibility=hidden if possible. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28709 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2010-07-22 01:38:25 +04:00
* debug.h: constified. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@12666 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2007-06-29 12:10:16 +04:00			`#endif /* RUBY_DEBUG_H */`