* Boston, MA 02111-1307, USA.
*
* $Id$
+ *
**************************************************************************/
-#ifndef _COMPILER_H
-#define _COMPILER_H
-
-// What this file does.
-// (1) Defines macros for some STL includes which may be affected
-// by file name length limitations.
-// (2) Defines macros for some features not supported by all C++ compilers.
-// (3) Defines 'explicit' as a null macro if the compiler doesn't support
-// the explicit keyword.
-// (4) Defines 'typename' as a null macro if the compiler doesn't support
-// the typename keyword.
-// (5) Defines bool, true and false if the compiler doesn't do so.
-// (6) Defines FG_EXPLICIT_FUNCTION_TMPL_ARGS if the compiler
-// supports calling a function template by providing its template
-// arguments explicitly.
-// (7) Defines FG_NEED_AUTO_PTR if STL doesn't provide auto_ptr<>.
-// (8) Defines FG_NO_ARROW_OPERATOR if the compiler is unable
-// to support operator->() for iterators.
-// (9) Defines FG_USE_EXCEPTIONS if the compiler supports exceptions.
-// Note: no FlightGear code uses exceptions.
-// (10) Define FG_NAMESPACES if the compiler supports namespaces.
-// (11) FG_MATH_FN_IN_NAMESPACE_STD -- not used??
-// (12) Define FG_HAVE_STD if std namespace is supported.
-// (13) Defines FG_CLASS_PARTIAL_SPECIALIZATION if the compiler
-// supports partial specialization of class templates.
-// (14) Defines FG_HAVE_STD_INCLUDES to use ISO C++ Standard headers.
-// (15) Defines FG_HAVE_STREAMBUF if <streambuf> of <streambuf.h> are present.
-// (16) Define FG_MATH_EXCEPTION_CLASH if math.h defines an exception class
-// that clashes with the one defined in <stdexcept>.
+/** \file compiler.h
+ * A set of defines to encapsulate compiler and platform differences.
+ * Please refer to the source code for full documentation on this file.
+ *
+ * Here is a summary of what this file does.
+ *
+ * (1) Defines macros for some STL includes which may be affected
+ * by file name length limitations.
+ *
+ * (2) Defines macros for some features not supported by all C++ compilers.
+ *
+ * (3) Defines 'explicit' as a null macro if the compiler doesn't support
+ * the explicit keyword.
+ *
+ * (4) Defines 'typename' as a null macro if the compiler doesn't support
+ * the typename keyword.
+ *
+ * (5) Defines bool, true and false if the compiler doesn't do so.
+ *
+ * (6) Defines SG_EXPLICIT_FUNCTION_TMPL_ARGS if the compiler
+ * supports calling a function template by providing its template
+ * arguments explicitly.
+ *
+ * (7) Defines SG_NEED_AUTO_PTR if STL doesn't provide auto_ptr<>.
+ *
+ * (8) Defines SG_NO_ARROW_OPERATOR if the compiler is unable
+ * to support operator->() for iterators.
+ *
+ * (9) Defines SG_USE_EXCEPTIONS if the compiler supports exceptions.
+ * Note: no FlightGear code uses exceptions.
+ *
+ * (10) Define SG_NAMESPACES if the compiler supports namespaces.
+ *
+ * (11) SG_MATH_FN_IN_NAMESPACE_STD -- not used??
+ *
+ * (12) Define SG_HAVE_STD if std namespace is supported.
+ *
+ * (13) Defines SG_CLASS_PARTIAL_SPECIALIZATION if the compiler
+ * supports partial specialization of class templates.
+ *
+ * (14) Defines SG_HAVE_STD_INCLUDES to use ISO C++ Standard headers.
+ *
+ * (15) Defines SG_HAVE_STREAMBUF if <streambuf> of <streambuf.h> are present.
+ *
+ * (16) Define SG_MATH_EXCEPTION_CLASH if math.h defines an exception class
+ * that clashes with the one defined in <stdexcept>.
+ */
+
+#ifndef _SG_COMPILER_H
+#define _SG_COMPILER_H
#ifdef __GNUC__
# if __GNUC__ == 2
# define STL_STRING <string>
# define STL_STRSTREAM <strstream.h>
-# define FG_NEED_AUTO_PTR
-# define FG_NO_DEFAULT_TEMPLATE_ARGS
-# define FG_INCOMPLETE_FUNCTIONAL
-# define FG_NO_ARROW_OPERATOR
+# define SG_NEED_AUTO_PTR
+# define SG_NO_DEFAULT_TEMPLATE_ARGS
+# define SG_INCOMPLETE_FUNCTIONAL
+# define SG_NO_ARROW_OPERATOR
# elif __GNUC_MINOR__ >= 8
// g++-2.8.x and egcs-1.x
-# define FG_EXPLICIT_FUNCTION_TMPL_ARGS
-# define FG_NEED_AUTO_PTR
-# define FG_MEMBER_TEMPLATES
-# define FG_NAMESPACES
-# define FG_HAVE_STD
-# define FG_HAVE_STREAMBUF
-# define FG_CLASS_PARTIAL_SPECIALIZATION
+# define SG_EXPLICIT_FUNCTION_TMPL_ARGS
+# define SG_NEED_AUTO_PTR
+# define SG_MEMBER_TEMPLATES
+# define SG_NAMESPACES
+# define SG_HAVE_STD
+# define SG_HAVE_STREAMBUF
+# define SG_CLASS_PARTIAL_SPECIALIZATION
# define STL_ALGORITHM <algorithm>
# define STL_FUNCTIONAL <functional>
/* KAI C++ */
#if defined(__KCC)
-# define FG_NAMESPACES
-# define FG_HAVE_STD
-# define FG_HAVE_STREAMBUF
-# define FG_HAVE_TRAITS
-# define FG_HAVE_STD_INCLUDES
+# define SG_NAMESPACES
+# define SG_HAVE_STD
+# define SG_HAVE_STREAMBUF
+# define SG_HAVE_TRAITS
+# define SG_HAVE_STD_INCLUDES
# define STL_ALGORITHM <algorithm>
# define STL_FUNCTIONAL <functional>
/*
CodeWarrior compiler from Metrowerks, Inc.
*/
-# define FG_HAVE_TRAITS
-# define FG_HAVE_STD_INCLUDES
-# define FG_HAVE_STD
-# define FG_NAMESPACES
+# define SG_HAVE_TRAITS
+# define SG_HAVE_STD_INCLUDES
+# define SG_HAVE_STD
+# define SG_NAMESPACES
# define STL_ALGORITHM <algorithm>
# define STL_FUNCTIONAL <functional>
# define FG_MEM_COPY(to,from,n) memcpy(to, from, n)
# if _MSC_VER == 1200 // msvc++ 6.0
-# define FG_NAMESPACES
-# define FG_HAVE_STD
-# define FG_HAVE_STD_INCLUDES
-# define FG_HAVE_STREAMBUF
+# define SG_NAMESPACES
+# define SG_HAVE_STD
+# define SG_HAVE_STD_INCLUDES
+# define SG_HAVE_STREAMBUF
# define STL_ALGORITHM <algorithm>
# define STL_FUNCTIONAL <functional>
# elif _MSC_VER == 1100 // msvc++ 5.0
# define NEEDNAMESPACESTD
-# define FG_NAMESPACES
-# define FG_HAVE_STD
-# define FG_HAVE_STD_INCLUDES
-# define FG_HAVE_STREAMBUF
+# define SG_NAMESPACES
+# define SG_HAVE_STD
+# define SG_HAVE_STD_INCLUDES
+# define SG_HAVE_STREAMBUF
# define STL_ALGORITHM <algorithm>
# define STL_FUNCTIONAL <functional>
# define STL_ALGORITHM "algorithm"
# define STL_FUNCTIONAL "functional"
-# define FG_MATH_EXCEPTION_CLASH
+# define SG_MATH_EXCEPTION_CLASH
# else
# define STL_STDEXCEPT <stdexcept>
# define STL_STRSTREAM <strstream>
-# define FG_INCOMPLETE_FUNCTIONAL
+# define SG_INCOMPLETE_FUNCTIONAL
# endif // HAVE_SGI_STL_PORT
# define STL_IOSTREAM <iostream>
# define STL_FSTREAM <fstream>
# define STL_STRING <string>
-# define FG_NO_DEFAULT_TEMPLATE_ARGS
-# define FG_NAMESPACES
-// # define FG_HAVE_STD
+# define SG_NO_DEFAULT_TEMPLATE_ARGS
+# define SG_NAMESPACES
+// # define SG_HAVE_STD
#endif // __BORLANDC__
//
#if defined ( sgi ) && !defined( __GNUC__ )
-# define FG_HAVE_NATIVE_SGI_COMPILERS
+# define SG_HAVE_NATIVE_SGI_COMPILERS
-# define FG_EXPLICIT_FUNCTION_TMPL_ARGS
-# define FG_NEED_AUTO_PTR
-# define FG_MEMBER_TEMPLATES
-# define FG_NAMESPACES
-# define FG_HAVE_STD
-# define FG_CLASS_PARTIAL_SPECIALIZATION
-# define FG_HAVE_TRAITS
+# define SG_EXPLICIT_FUNCTION_TMPL_ARGS
+# define SG_NEED_AUTO_PTR
+# define SG_MEMBER_TEMPLATES
+# define SG_NAMESPACES
+# define SG_HAVE_STD
+# define SG_CLASS_PARTIAL_SPECIALIZATION
+# define SG_HAVE_TRAITS
# define STL_ALGORITHM <algorithm>
# define STL_FUNCTIONAL <functional>
# define STL_FSTREAM <fstream.h>
# define STL_STDEXCEPT <stdexcept>
# define STL_STRING <string>
-# define STL_STRSTREAM <strstream>
+# define STL_STRSTREAM <strstream.h>
#endif // Native SGI compilers
// No user modifiable definitions beyond here.
//
-#ifdef FG_NEED_EXPLICIT
+#ifdef SG_NEED_EXPLICIT
# define explicit
#endif
-#ifdef FG_NEED_TYPENAME
+#ifdef SG_NEED_TYPENAME
# define typename
#endif
-#ifdef FG_NEED_MUTABLE
+#ifdef SG_NEED_MUTABLE
# define mutable
#endif
-#ifdef FG_NEED_BOOL
+#ifdef SG_NEED_BOOL
typedef int bool;
# define true 1
# define false 0
#endif
-#ifdef FG_EXPLICIT_FUNCTION_TMPL_ARGS
-# define FG_NULL_TMPL_ARGS <>
+#ifdef SG_EXPLICIT_FUNCTION_TMPL_ARGS
+# define SG_NULL_TMPL_ARGS <>
#else
-# define FG_NULL_TMPL_ARGS
+# define SG_NULL_TMPL_ARGS
#endif
-#ifdef FG_CLASS_PARTIAL_SPECIALIZATION
-# define FG_TEMPLATE_NULL template<>
+#ifdef SG_CLASS_PARTIAL_SPECIALIZATION
+# define SG_TEMPLATE_NULL template<>
#else
-# define FG_TEMPLATE_NULL
+# define SG_TEMPLATE_NULL
#endif
-// FG_NO_NAMESPACES is a hook so that users can disable namespaces
+// SG_NO_NAMESPACES is a hook so that users can disable namespaces
// without having to edit library headers.
-#if defined(FG_NAMESPACES) && !defined(FG_NO_NAMESPACES)
-# define FG_NAMESPACE(X) namespace X {
-# define FG_NAMESPACE_END }
-# define FG_USING_NAMESPACE(X) using namespace X
+#if defined(SG_NAMESPACES) && !defined(SG_NO_NAMESPACES)
+# define SG_NAMESPACE(X) namespace X {
+# define SG_NAMESPACE_END }
+# define SG_USING_NAMESPACE(X) using namespace X
# else
-# define FG_NAMESPACE(X)
-# define FG_NAMESPACE_END
-# define FG_USING_NAMESPACE(X)
+# define SG_NAMESPACE(X)
+# define SG_NAMESPACE_END
+# define SG_USING_NAMESPACE(X)
#endif
-# ifdef FG_HAVE_STD
-# define FG_USING_STD(X) using std::X
+/** \def SG_USING_STD(x)
+ * Expands to using std::x if SG_HAVE_STD is defined
+ */
+# ifdef SG_HAVE_STD
+# define SG_USING_STD(X) using std::X
# define STD std
# else
-# define FG_USING_STD(X)
+# define SG_USING_STD(X)
# define STD
# endif
// Additional <functional> implementation from SGI STL 3.11
// Adapter function objects: pointers to member functions
-#ifdef FG_INCOMPLETE_FUNCTIONAL
+#ifdef SG_INCOMPLETE_FUNCTIONAL
template <class _Ret, class _Tp>
class const_mem_fun_ref_t
inline const_mem_fun_ref_t<_Ret,_Tp> mem_fun_ref(_Ret (_Tp::*__f)() const)
{ return const_mem_fun_ref_t<_Ret,_Tp>(__f); }
-#endif // FG_INCOMPLETE_FUNCTIONAL
+#endif // SG_INCOMPLETE_FUNCTIONAL
-#endif // _COMPILER_H
+#endif // _SG_COMPILER_H