config.h

/**
 * @file
 *
 * @brief Configuration.
 *
 * @version 1.0
 * @author  Wei Tang <gauchyler@uestc.edu.cn>
 * @date    2017-12-06
 *
 * @copyright Copyright (c) 2017.
 *   National Key Laboratory of Science and Technology on Communications,
 *   University of Electronic Science and Technology of China.
 *   All rights reserved.
 */


#ifndef CONFIG_H__544DA909_13DC_4D4F_AD4F_BE62ECF454E2
#define CONFIG_H__544DA909_13DC_4D4F_AD4F_BE62ECF454E2


////////////////////////////////////////////////////////////////////////////////
#define NSFX_VERSION_MAJOR  2
#define NSFX_VERSION_MINOR  0
#define NSFX_VERSION        (NSFX_VERSION_MAJOR * 1000 + NSFX_VERSION_MINOR)


////////////////////////////////////////////////////////////////////////////////
#ifndef __cplusplus
# error A C++ compiler is required.
#endif // !(__cplusplus)


////////////////////////////////////////////////////////////////////////////////
#define NSFX_OPEN_NAMESPACE  namespace nsfx {
#define NSFX_CLOSE_NAMESPACE } /* namespace nsfx */


////////////////////////////////////////////////////////////////////////////////
#include <boost/version.hpp>
// BOOST 1.58.0 or above
#if (BOOST_VERSION < 105800)
# error BOOST version 1.58.0 or above is required. However, an unsupported version is used.
#endif // (BOOST_VERSION < 105800)


////////////////////////////////////////////////////////////////////////////////
#include <boost/config.hpp>

// NSFX_MSVC
#if defined(BOOST_MSVC)
# define NSFX_MSVC  BOOST_MSVC
// If lower than Microsoft Visual C++ 2010 SP1
# if (NSFX_MSVC < 1600 || _MSC_FULL_VER < 160040219)
#  error Microsoft Visual C++ 2010 SP1 or above version is required.
# endif // (NSFX_MSVC < 1600 || _MSC_FULL_VER < 160040219)

// Disable warning C4200: zero-sized array in struct/union.
# pragma warning(disable : 4200)
// Disable warning C4355: 'this' pointer is used in constructor.
# pragma warning(disable : 4355)
// Disable warning C4819: file contains non-ascii characters.
# pragma warning(disable : 4819)
// Disable warning C4996: deprecated declaration.
# pragma warning(disable : 4996)
#endif // defined(BOOST_MSVC)


////////////////////////////////////////////////////////////////////////////////
// NSFX_GCC
#if defined(BOOST_GCC)
# define NSFX_GCC  BOOST_GCC
# if NSFX_GCC < 40600 // Lower than GCC 4.6.0
#  error GCC version 4.6.0 or above version is required.
# endif // NSFX_GCC < 40700
#endif // defined(BOOST_GCC)


////////////////////////////////////////////////////////////////////////////////
// NSFX_CLANG
#if defined(BOOST_CLANG)
# define NSFX_CLANG  BOOST_CLANG
#endif // defined(BOOST_GCC)


////////////////////////////////////////////////////////////////////////////////
// NSFX_X86
#if defined(_M_IX86) || defined(__i386__)
# define NSFX_X86 1
// NSFX_X64
#elif defined(_M_X64) || defined(__x86_64__) || defined(__amd64__)
# define NSFX_X64 1
// ERROR
#else
# error Unsupported architecture.
#endif


////////////////////////////////////////////////////////////////////////////////
// nullptr_t
#if defined(NSFX_GCC)
# if NSFX_GCC < 40800
typedef decltype(nullptr) nullptr_t;
# endif // GCC_VERSION < 40800
#endif // defined(NSFX_GCC)


////////////////////////////////////////////////////////////////////////////////
// NSFX_OVERRIDE
#if defined(NSFX_MSVC)
# define NSFX_OVERRIDE override
#endif // defined(NSFX_MSVC)


#if defined(NSFX_CLANG)
# define NSFX_OVERRIDE override
#endif // defined(NSFX_CLANG)


#if defined(NSFX_GCC)
# if NSFX_GCC >= 40700
#  define NSFX_OVERRIDE override
# else // if !(NSFX_GCC >= 40700)
#  define NSFX_OVERRIDE
# endif // NSFX_GCC >= 40700
#endif // defined(NSFX_GCC)


////////////////////////////////////////////////////////////////////////////////
// NSFX_FINAL
#if defined(NSFX_MSVC)
# if NSFX_MSVC >= 1700 // Microsoft Visual C++ 2012+
#  define NSFX_FINAL final
# else // if !(NSFX_MSVC >= 1700)
#  define NSFX_FINAL sealed
# endif // NSFX_MSVC >= 1700
#endif // defined(NSFX_MSVC)


#if defined(NSFX_GCC) || defined(NSFX_CLANG)
# define NSFX_FINAL final
#endif // defined(NSFX_GCC)


////////////////////////////////////////////////////////////////////////////////
// NSFX_EXPORT, NSFX_IMPORT
#if defined(NSFX_MSVC)
# define NSFX_EXPORT __declspec(dllexport)
# define NSFX_IMPORT __declspec(dllimport)
#endif // defined(NSFX_MSVC)


////////////////////////////////////////////////////////////////////////////////
// Sometimes, BOOST_STATIC_CONSTANT(type, expr) doesn't work, if the second
// parameter is too complex.
// NSFX_BEGIN_TEMPLATE_CONST(type)
// NSFX_NEXT_TEMPLATE_CONST(type)
// NSFX_END_TEMPLATE_CONST()
#if defined(NSFX_MSVC)
# define NSFX_TEMPLATE_CONST_FIRST(type)   BOOST_STATIC_CONSTEXPR type
# define NSFX_TEMPLATE_CONST_NEXT(type)  ; BOOST_STATIC_CONSTEXPR type
# define NSFX_TEMPLATE_CONST_END()       ;
#endif // defined(NSFX_MSVC)


#if defined(NSFX_GCC)
# if !defined(BOOST_NO_CXX11_CONSTEXPR)
#  define NSFX_TEMPLATE_CONST_FIRST(type)   BOOST_STATIC_CONSTEXPR type
#  define NSFX_TEMPLATE_CONST_NEXT(type)  ; BOOST_STATIC_CONSTEXPR type
#  define NSFX_TEMPLATE_CONST_END()       ;
# else // if defined(BOOST_NO_CXX11_CONSTEXPR)
#  define NSFX_TEMPLATE_CONST_FIRST(type) enum {
#  define NSFX_TEMPLATE_CONST_NEXT(type)  ,
#  define NSFX_TEMPLATE_CONST_END()       };
# endif // !defined(BOOST_NO_CXX11_CONSTEXPR)
#endif // defined(NSFX_GCC)


////////////////////////////////////////////////////////////////////////////////
// Import standard integer types.
#include <boost/cstdint.hpp>
NSFX_OPEN_NAMESPACE
using boost::int8_t;
using boost::int16_t;
using boost::int32_t;
using boost::int64_t;
using boost::int_least8_t;
using boost::int_least16_t;
using boost::int_least32_t;
using boost::int_least64_t;
using boost::int_fast8_t;
using boost::int_fast16_t;
using boost::int_fast32_t;
using boost::int_fast64_t;
using boost::intmax_t;
using boost::intptr_t;

using boost::uint8_t;
using boost::uint16_t;
using boost::uint32_t;
using boost::uint64_t;
using boost::uint_least8_t;
using boost::uint_least16_t;
using boost::uint_least32_t;
using boost::uint_least64_t;
using boost::uint_fast8_t;
using boost::uint_fast16_t;
using boost::uint_fast32_t;
using boost::uint_fast64_t;
using boost::uintmax_t;
using boost::uintptr_t;
NSFX_CLOSE_NAMESPACE


#include <cstddef>
NSFX_OPEN_NAMESPACE

using std::size_t;
using std::ptrdiff_t;

/**
 * @ingroup Component
 * @brief A reference counter that manages the lifetime of an object.
 */
typedef ptrdiff_t  refcount_t;

NSFX_CLOSE_NAMESPACE


////////////////////////////////////////////////////////////////////////////////
// Use `boost::swap()` to support user-defined `void swap(lhs, rhs)` functions.
// There is no need to inject code into the `std` namespace.
#include <boost/core/swap.hpp>

// Use `boost::hash<>` to support user-defined `size_t hash_value(v)` functions.
// There is no need to inject code into the `std` namespace.
// Note that, the third type parameter of `unordered_set` and `unordered_map`
// **shall** be supplied as `boost::hash<T>`.
#include <boost/functional/hash.hpp>

// Import standard containers.
// MSVC && Microsoft Visual C++ 2010
#if defined(NSFX_MSVC) && (NSFX_MSVC <= 1600)
# include <boost/container/vector.hpp>
# include <boost/container/deque.hpp>
# include <boost/container/list.hpp>
# include <boost/container/set.hpp>
# include <boost/container/map.hpp>
# include <boost/unordered_set.hpp>
# include <boost/unordered_map.hpp>

NSFX_OPEN_NAMESPACE
using boost::container::vector;
using boost::container::deque;
using boost::container::list;
using boost::container::set;
using boost::container::map;
using boost::unordered_set;
using boost::unordered_map;
NSFX_CLOSE_NAMESPACE

// MSVC && Microsoft Visual C++ 2012+, GCC, CLANG
#else
# include <vector>
# include <deque>
# include <list>
# include <set>
# include <map>
# include <unordered_set>
# include <unordered_map>

NSFX_OPEN_NAMESPACE
using std::vector;
using std::deque;
using std::list;
using std::set;
using std::map;
using std::unordered_set;
using std::unordered_map;
NSFX_CLOSE_NAMESPACE

#endif

////////////////////////////////////////////////////////////////////////////////
// assert.
/**
 * @brief The assert statement.
 *
 * # About `assert()`.
 * ## Goodness.
 *     `assert()` costs nothing in a release code that defines `NDEBUG` macro.
 *
 * ## Badness.
 *     `assert()` terminates the program with little information.
 *
 * # When to use `assert()`?
 * ## 1. Functions with `noexcept`.
 *     If a function is specified as `noexcept`, then use `assert()` as the
 *     last resort.
 *
 * ## 2. Singleton failure.
 *     If a user retrieves a pointer to a singleton, use `assert()` to check
 *     the returned pointer is not `nullptr`.
 *     Usually, the program is beyond redemption in such condition.
 *
 */
#include <boost/assert.hpp>


////////////////////////////////////////////////////////////////////////////////
// Endian-ness.
#include <boost/predef/other/endian.h>

#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_LITTLE_BYTE
# error  Unsupported endianness.
#endif


////////////////////////////////////////////////////////////////////////////////
// The maximum number of function parameters for variadic template emulation.
#if !defined(NSFX_MAX_ARITY)
# define NSFX_MAX_ARITY  6
#endif // !defined(NSFX_MAX_ARITY)


#endif // CONFIG_H__544DA909_13DC_4D4F_AD4F_BE62ECF454E2