summaryrefslogtreecommitdiff
path: root/internal/debug.h
diff options
context:
space:
mode:
author卜部昌平 <[email protected]>2019-11-29 15:18:34 +0900
committer卜部昌平 <[email protected]>2019-12-26 20:45:12 +0900
commitb739a63eb41f52d33c33f87ebc44dcf89762cc37 (patch)
tree46e00221c40f90e47c9acca04905d9877a84cc10 /internal/debug.h
parentba78bf9778082795bdb4735ccd7b692b5c3769f9 (diff)
split internal.h into files
One day, I could not resist the way it was written. I finally started to make the code clean. This changeset is the beginning of a series of housekeeping commits. It is a simple refactoring; split internal.h into files, so that we can divide and concur in the upcoming commits. No lines of codes are either added or removed, except the obvious file headers/footers. The generated binary is identical to the one before.
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/2711
Diffstat (limited to 'internal/debug.h')
-rw-r--r--internal/debug.h34
1 files changed, 34 insertions, 0 deletions
diff --git a/internal/debug.h b/internal/debug.h
new file mode 100644
index 0000000000..8fa75fd8c6
--- /dev/null
+++ b/internal/debug.h
@@ -0,0 +1,34 @@
+#ifndef INTERNAL_DEBUG_H /* -*- C -*- */
+#define INTERNAL_DEBUG_H
+/**
+ * @file
+ * @brief Internal header for debugging.
+ * @author \@shyouhei
+ * @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.
+ */
+
+/* MRI debug support */
+void rb_obj_info_dump(VALUE obj);
+void rb_obj_info_dump_loc(VALUE obj, const char *file, int line, const char *func);
+void ruby_debug_breakpoint(void);
+
+// show obj data structure without any side-effect
+#define rp(obj) rb_obj_info_dump_loc((VALUE)(obj), __FILE__, __LINE__, __func__)
+
+// same as rp, but add message header
+#define rp_m(msg, obj) do { \
+ fprintf(stderr, "%s", (msg)); \
+ rb_obj_info_dump((VALUE)obj); \
+} while (0)
+
+// `ruby_debug_breakpoint()` does nothing,
+// but breakpoint is set in run.gdb, so `make gdb` can stop here.
+#define bp() ruby_debug_breakpoint()
+
+/* debug.c */
+PRINTF_ARGS(void ruby_debug_printf(const char*, ...), 1, 2);
+
+#endif /* INTERNAL_DEBUG_H */