Merge pull request #467 from PeterMitsis/toolchain

Abstract toolchain capabilities

Author: asarium

code/ai/aiturret.cpp

@@ -1377,7 +1377,7 @@ void turret_ai_update_aim(ai_info *aip, object *En_Objp, ship_subsys *ss)
  */
 int aifft_rotate_turret(ship *shipp, int parent_objnum, ship_subsys *ss, object *objp, object *lep, vec3d *predicted_enemy_pos, vec3d *gvec)
 {
-	int ret_val __attribute__((__unused__)) = 0; // to be used in future, see comment @ end of function
+	int ret_val __UNUSED = 0; // to be used in future, see comment @ end of function
 
 	if (ss->turret_enemy_objnum != -1) {
 		model_subsystem *tp = ss->system_info;

code/freespace2/freespace.cpp

@@ -1265,7 +1265,7 @@ void game_loading_callback_close()
 	// Make sure bar shows all the way over.
 	game_loading_callback(COUNT_ESTIMATE);
 
-	int real_count __attribute__((__unused__)) = game_busy_callback( NULL );
+	int real_count __UNUSED = game_busy_callback( NULL );
  	Mouse_hidden = 0;
 
 	Game_loading_callback_inited = 0;
@@ -1429,7 +1429,7 @@ int game_start_mission()
 {
 	mprintf(( "=================== STARTING LEVEL LOAD ==================\n" ));
 
-	int s1 __attribute__((__unused__)) = timer_get_milliseconds();
+	int s1 __UNUSED = timer_get_milliseconds();
 
 	// clear post processing settings
 	gr_post_process_set_defaults();
@@ -1486,7 +1486,7 @@ int game_start_mission()
 
 	bm_print_bitmaps();
 
-	int e1 __attribute__((__unused__)) = timer_get_milliseconds();
+	int e1 __UNUSED = timer_get_milliseconds();
 
 	mprintf(("Level load took %f seconds.\n", (e1 - s1) / 1000.0f ));
 
@@ -1745,7 +1745,7 @@ char full_path[1024];
  */
 void game_init()
 {
-	int s1 __attribute__((__unused__)), e1 __attribute__((__unused__));
+	int s1 __UNUSED, e1 __UNUSED;
 	const char *ptr;
 	char whee[MAX_PATH_LEN];
 

code/fs2netd/fs2netd_client.cpp

@@ -737,7 +737,7 @@ static void fs2netd_handle_messages()
 
 			case PCKT_SLIST_REPLY: {
 				int numServers = 0;
-				int svr_flags __attribute__((__unused__)); // gcc [-Wunused-but-set-variable] doesn't like MACROs
+				int svr_flags __UNUSED; // gcc [-Wunused-but-set-variable] doesn't like MACROs
 				ushort svr_port;
 				char svr_ip[16];
 				active_game ag;

code/fs2netd/tcp_client.cpp

@@ -218,7 +218,7 @@ int FS2NetD_GetPlayerData(const char *player_name, player *pl, bool can_create,
 		uint rc_total = 0;
 		ubyte reply_type = 0;
 		int si_index = 0;
-		ushort bogus __attribute__((unused));
+		ushort bogus __UNUSED;
 		ushort num_type_kills = 0, num_medals = 0;
 		char ship_name[NAME_LENGTH];
 		int idx;
@@ -489,8 +489,8 @@ int FS2NetD_Login(const char *username, const char *password, bool do_send)
 		int rc;
 		uint rc_total = 0;
 		ubyte login_status = 0;
-		int sid __attribute__((unused));
-		short pilots __attribute__((unused));
+		int sid __UNUSED;
+		short pilots __UNUSED;
 
 		do {
 			rc = FS2NetD_GetData(buffer+rc_total, sizeof(buffer)-rc_total);

code/globalincs/pstypes.h

@@ -17,6 +17,7 @@
 #include <stdlib.h>
 #include <memory.h>
 #include <string.h>
+#include "globalincs/toolchain.h"
 
 #if defined( __x86_64__ ) || defined( _WIN64 )
 #define IAM_64BIT 1
@@ -63,39 +64,6 @@ typedef unsigned short ushort;
 typedef unsigned int uint;
 typedef unsigned long ulong;
 
-// Format specifier macros
-#ifdef DOXYGEN
-// Documentation macros, only used by DOXYGEN
-/**
- * @brief Identifies a printf-style format string
- */
-#define SCP_FORMAT_STRING
-
-/**
- * @brief Specifies which arguments are involved in printf-style string formatting
- *
- * @details Expands to a compiler specific attribute which specify where the
- *          format arguments are located. Parameters are 1-based which also includes
- *          the 'this' parameter at position 1 for class methods.
- *
- * @param formatArg The location of the format string argument in the argument list
- * @param varArgs The location where the variable arguments begin
- */
-#define SCP_FORMAT_STRING_ARGS(formatArg, varArgs)
-#elif defined(_MSC_VER)
-#include <sal.h>
-
-#define SCP_FORMAT_STRING _Printf_format_string_
-#define SCP_FORMAT_STRING_ARGS(x, y)
-#elif defined(__GNUC__) || defined(__clang__)
-// GCC and clang use function attributes
-#define SCP_FORMAT_STRING
-#define SCP_FORMAT_STRING_ARGS(x, y) __attribute__ ((format (printf, x, y)))
-#else
-#define SCP_FORMAT_STRING
-#define SCP_FORMAT_STRING_ARGS(x, y)
-#endif
-
 #define HARDWARE_ONLY
 
 //Stucture to store clipping codes in a word
@@ -264,11 +232,6 @@ extern int Global_error_count;
 
 #include "osapi/outwnd.h"
 
-// remove __attribute__ on non-GCC compilers
-#ifndef __GNUC__
-#	define  __attribute__(x)  /*NOTHING*/
-#endif
-
 // To debug printf do this:
 // mprintf(( "Error opening %s\n", filename ));
 #ifndef NDEBUG
@@ -290,22 +253,10 @@ extern int Global_error_count;
 // Please never uncomment the functionality of Assert in debug
 // The code, as with all development like this is littered with Asserts which are designed to throw
 // up an error message if variables are out of range.
-
-#define ASSUME(x)
-
 // Disabling this functionality is dangerous, crazy values can run rampent unchecked and the longer its disabled
 // the more likely you are to have problems getting it working again.
 #if defined(NDEBUG)
 #	define Assert(expr) do { ASSUME(expr); } while (0)
-#	ifndef _MSC_VER   // non MS compilers
-#		define Assertion(expr, msg, ...) do {} while (0)
-#	else
-#		if _MSC_VER >= 1400	// VC 2005 or greater
-#			define Assertion(expr, msg, ...) do { ASSUME(expr); } while (0)
-#		else
-#			define Assertion(expr, msg) do {} while (0)
-#		endif
-#	endif
 #else
 	void gr_activate(int);
 #	define Assert(expr) do {\
@@ -314,30 +265,6 @@ extern int Global_error_count;
 		}\
 		ASSUME( expr );\
 	} while (0)
-
-	// Assertion can only use its proper fuctionality in compilers that support variadic macro
-#	ifndef _MSC_VER   // non MS compilers
-#		define Assertion(expr, msg, ...) do {\
-			if (!(expr)) {\
-				WinAssert(#expr,__FILE__,__LINE__, msg , ##__VA_ARGS__ );\
-			}\
-		} while (0)
-#	else
-#		if _MSC_VER >= 1400	// VC 2005 or greater
-#			define Assertion(expr, msg, ...) do {\
-				if (!(expr)) {\
-					WinAssert(#expr,__FILE__,__LINE__, msg, __VA_ARGS__ );\
-				}\
-				ASSUME(expr);\
-			} while (0)
-#		else // older MSVC compilers
-#			define Assertion(expr, msg) do {\
-				if (!(expr)) {\
-					WinAssert(#expr,__FILE__,__LINE__);\
-				}\
-			} while (0)
-#		endif
-#	endif
 #endif
 /*******************NEVER COMMENT Assert ************************************************/
 
@@ -693,79 +620,9 @@ class camid
 	bool isValid();
 };
 
-/* Restrict keyword semantics are different under VC and GCC */
-
-#ifndef NO_RESTRICT_USE
-#	ifdef _MSC_VER
-#		if _MSC_VER >= 1400
-#			define RESTRICT __restrict
-#		else
-#			define RESTRICT
-#		endif
-#	else
-#		define RESTRICT restrict
-#	endif
-#else
-#	define RESTRICT
-#endif
-
 #include "globalincs/vmallocator.h"
 #include "globalincs/safe_strings.h"
 
-// Macros for portable printf argument specification
-#ifdef DOXYGEN
-// Special section for doxygen
-/**
- * @brief Format specifier for a @c size_t argument
- * Due to different runtimes using different format specifier for these types
- * it's necessary to hide these changes behind a macro. Use this in place of %zu
- */
-#define SIZE_T_ARG
-/**
- * @brief Format specifier for a @c ptrdiff_t argument
- * Due to different runtimes using different format specifier for these types
- * it's necessary to hide these changes behind a macro. Use this in place of %zd
- */
-#define PTRDIFF_T_ARG
-#elif defined(_MSC_VER)
-#define SIZE_T_ARG "%Iu"
-#define PTRDIFF_T_ARG "%Id"
-#else
-	// Asume C99 compatibility for everyone else
-#define SIZE_T_ARG "%zu"
-#define PTRDIFF_T_ARG "%zd"
-#endif
-
-// c++11 standard detection
-// for GCC with autotools, see AX_CXX_COMPILE_STDCXX_11 macro in configure.ac
-// this sets HAVE_CXX11 & -std=c++0x or -std=c++11 appropriately
-
-#ifndef HAVE_CXX11
-	// Use the visual studio version to detect C++11 support
-	#if _MSC_VER >= 1600
-	#	define HAVE_CXX11
-	#endif
-	// clang doesn't seem to have a feature check for is_trivial
-	// oh well, assume it'll be covered by one of the other two checks...
-	// http://clang.llvm.org/docs/LanguageExtensions.html#feature_check
-	#if defined(__clang__)
-		#if __has_feature(cxx_static_assert)
-			#if __has_feature(cxx_auto_type)
-				#define HAVE_CXX11
-			#endif // __has_feature(cxx_auto_type)
-		#endif // __has_feature(cxx_static_assert)
-	#endif // defined(__clang__)
-	// TODO: sort out cmake/gcc
-#endif // HAVE_CXX11
-
-//	In compilers before VS 2015, the noexcept keyword isn't defined. Nonetheless, we need to define it in VS 2015 and non-MS compilers.
-#if defined(_MSC_VER) && _MSC_VER < 1900
-#	define NOEXCEPT
-#else
-#	define NOEXCEPT noexcept
-#endif
-
-
 // DEBUG compile time catch for dangerous uses of memset/memcpy/memmove
 // would prefer std::is_trivially_copyable but it's not supported by gcc yet
 // ref: http://gcc.gnu.org/onlinedocs/libstdc++/manual/status.html

code/globalincs/toolchain.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) Volition, Inc. 1999.  All rights reserved.
+ *
+ * All source code herein is the property of Volition, Inc. You may not sell
+ * or otherwise commercially exploit the source or things you created based on
+ * the source.
+ */
+
+/**
+ * @file
+ *
+ * @brief Macros to abstract compiler capabilities for various toolchains
+ */
+
+#ifndef _TOOLCHAIN_H
+#define _TOOLCHAIN_H
+
+#if defined(DOXYGEN)
+#	include "globalincs/toolchain/doxygen.h"
+#elif defined(__MINGW32__)
+#	include "globalincs/toolchain/mingw.h"
+#elif defined(__clang__)
+#	include "globalincs/toolchain/clang.h"
+#elif defined(__GNUC__)
+#	include "globalincs/toolchain/gcc.h"
+#elif defined(_MSC_VER)
+#	include "globalincs/toolchain/msvc.h"
+#else
+#	error "Unknown toolchain detected!\n"           \
+		"Currently supported toolchains include:\n" \
+		"\tMingW, Clang, GCC, MSVC\n"               \
+		"Update toolchain.h to add support for additional toolchains.\n"
+#endif
+
+#endif /* _TOOLCHAIN_H */

code/globalincs/toolchain/clang.h

@@ -0,0 +1,67 @@
+/*
+ * Copyright (C) Volition, Inc. 1999.  All rights reserved.
+ *
+ * All source code herein is the property of Volition, Inc. You may not sell
+ * or otherwise commercially exploit the source or things you created based on
+ * the source.
+ */
+
+/**
+ * @file
+ *
+ * @brief Macros to abstract compiler capabilities for the Clang toolchain
+ *
+ * @internal
+ * This file should never be included directly; instead, one should
+ * include toolchain.h which will pull in the file appropriate to
+ * the detected toolchain.
+ */
+
+#define SCP_FORMAT_STRING
+#define SCP_FORMAT_STRING_ARGS(x,y)  __attribute__((format(printf, x, y)))
+
+#define __UNUSED __attribute__((__unused__))
+#define __ALIGNED(x)  __attribute__((__aligned__(x)))
+
+#ifdef NO_RESTRICT_USE
+#	define RESTRICT
+#else
+#	define RESTRICT  restrict
+#endif
+
+#define ASSUME(x)
+
+#if defined(NDEBUG)
+#	define Assertion(expr, msg, ...)  do { } while (0)
+#else
+/*
+ * NOTE: Assertion() can only use its proper functionality in compilers
+ * that support variadic macros.
+ */
+#	define Assertion(expr, msg, ...)                                      \
+		do {                                                              \
+			if (!(expr)) {                                                \
+				WinAssert(#expr, __FILE__, __LINE__, msg, ##__VA_ARGS__); \
+			}                                                             \
+		} while (0)
+#endif
+
+/* C++11 Standard Detection */
+#if !defined(HAVE_CXX11)
+	/*
+	 * Clang does not seem to have a feature check for 'is_trivial'.
+	 * Assume it will be covered by one of the following checks ...
+	 * http://clang.llvm.org/docs/LanguageExtensions.html#feature_check
+	 */
+#	if __has_feature(cxx_static_assert) && __has_feature(cxx_auto_type)
+#		define HAVE_CXX11
+#	endif
+#endif
+
+#define SIZE_T_ARG    "%zu"
+#define PTRDIFF_T_ARG "%zd"
+
+#define NOEXCEPT  noexcept
+
+#define likely(x)    __builtin_expect((long) !!(x), 1L)
+#define unlikely(x)  __builtin_expect((long) !!(x), 0L)