summaryrefslogtreecommitdiff
path: root/include/ruby/backward/rubysig.h
diff options
context:
space:
mode:
author卜部昌平 <shyouhei@ruby-lang.org>2020-04-10 14:11:40 +0900
committer卜部昌平 <shyouhei@ruby-lang.org>2020-04-13 16:06:00 +0900
commit4ff3f205408ff8bb413d69151105d301858136ba (patch)
tree0494fea3f4cdb82ec1d34e462438389dfea8b8da /include/ruby/backward/rubysig.h
parenta3f6f67967644f34226b4424227d2eec52fedd45 (diff)
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
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/3023
Diffstat (limited to 'include/ruby/backward/rubysig.h')
-rw-r--r--include/ruby/backward/rubysig.h27
1 files changed, 12 insertions, 15 deletions
diff --git a/include/ruby/backward/rubysig.h b/include/ruby/backward/rubysig.h
index 7a1ca35f200..b1645cdeb08 100644
--- a/include/ruby/backward/rubysig.h
+++ b/include/ruby/backward/rubysig.h
@@ -1,23 +1,20 @@
-/**********************************************************************
-
- rubysig.h -
-
- $Author$
- $Date$
- created at: Wed Aug 16 01:15:38 JST 1995
-
- Copyright (C) 1993-2008 Yukihiro Matsumoto
-
-**********************************************************************/
-
+#ifndef RUBYSIG_H /*-*-C++-*-vi:se ft=cpp:*/
+#define RUBYSIG_H
+/**
+ * @file
+ * @author $Author$
+ * @date Wed Aug 16 01:15:38 JST 1995
+ * @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.
+ */
#if defined __GNUC__
#warning rubysig.h is obsolete
#elif defined _MSC_VER
#pragma message("warning: rubysig.h is obsolete")
#endif
-#ifndef RUBYSIG_H
-#define RUBYSIG_H
#include "ruby/ruby.h"
#define RUBY_CRITICAL(statements) do {statements;} while (0)
@@ -26,4 +23,4 @@
#define ALLOW_INTS do {CHECK_INTS;} while (0)
#define CHECK_INTS rb_thread_check_ints()
-#endif
+#endif /* RUBYSIG_H */