Chris@102: // boost/endian/detail/lightweight_test.hpp --------------------------------------------//
Chris@102: 
Chris@102: #ifndef BOOST_ENDIAN_LIGHTWEIGHT_TEST_HPP
Chris@102: #define BOOST_ENDIAN_LIGHTWEIGHT_TEST_HPP
Chris@102: 
Chris@102: // MS compatible compilers support #pragma once
Chris@102: 
Chris@102: #if defined(_MSC_VER)
Chris@102: # pragma once
Chris@102: #endif
Chris@102: 
Chris@102: //
Chris@102: //  Copyright (c) 2002, 2009, 2014 Peter Dimov
Chris@102: //  Copyright (2) Beman Dawes 2010, 2011, 2015
Chris@102: //  Copyright (3) Ion Gaztanaga 2013
Chris@102: //
Chris@102: //  Distributed under the Boost Software License, Version 1.0.
Chris@102: //  See http://www.boost.org/LICENSE_1_0.txt
Chris@102: //
Chris@102: 
Chris@102: #include <boost/assert.hpp>
Chris@102: #include <boost/current_function.hpp>
Chris@102: #include <boost/core/no_exceptions_support.hpp>
Chris@102: #include <cstring>    // for memcmp
Chris@102: #include <iostream>
Chris@102: 
Chris@102: //  IDE's like Visual Studio perform better if output goes to std::cout or
Chris@102: //  some other stream, so allow user to configure output stream:
Chris@102: #ifndef BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102: # define BOOST_LIGHTWEIGHT_TEST_OSTREAM std::cerr
Chris@102: #endif
Chris@102: 
Chris@102: namespace boost
Chris@102: {
Chris@102: namespace endian
Chris@102: {
Chris@102: namespace detail
Chris@102: {
Chris@102: 
Chris@102: struct report_errors_reminder
Chris@102: {
Chris@102:     bool called_report_errors_function;
Chris@102: 
Chris@102:     report_errors_reminder() : called_report_errors_function(false) {}
Chris@102: 
Chris@102:     ~report_errors_reminder()
Chris@102:     {
Chris@102:         BOOST_ASSERT(called_report_errors_function);  // verify report_errors() was called  
Chris@102:     }
Chris@102: };
Chris@102: 
Chris@102: inline report_errors_reminder& report_errors_remind()
Chris@102: {
Chris@102:     static report_errors_reminder r;
Chris@102:     return r;
Chris@102: }
Chris@102: 
Chris@102: inline int & test_errors()
Chris@102: {
Chris@102:     static int x = 0;
Chris@102:     report_errors_remind();
Chris@102:     return x;
Chris@102: }
Chris@102: 
Chris@102: inline void test_failed_impl(char const * expr, char const * file, int line, char const * function)
Chris@102: {
Chris@102:     BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102:       << file << "(" << line << "): test '" << expr << "' failed in function '"
Chris@102:       << function << "'" << std::endl;
Chris@102:     ++test_errors();
Chris@102: }
Chris@102: 
Chris@102: inline void error_impl(char const * msg, char const * file, int line, char const * function)
Chris@102: {
Chris@102:     BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102:       << file << "(" << line << "): " << msg << " in function '"
Chris@102:       << function << "'" << std::endl;
Chris@102:     ++test_errors();
Chris@102: }
Chris@102: 
Chris@102: inline void throw_failed_impl(char const * excep, char const * file, int line, char const * function)
Chris@102: {
Chris@102:    BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102:     << file << "(" << line << "): Exception '" << excep << "' not thrown in function '"
Chris@102:     << function << "'" << std::endl;
Chris@102:    ++test_errors();
Chris@102: }
Chris@102: 
Chris@102: template<class T, class U> inline void test_eq_impl( char const * expr1, char const * expr2,
Chris@102:   char const * file, int line, char const * function, T const & t, U const & u )
Chris@102: {
Chris@102:     if( t == u )
Chris@102:     {
Chris@102:         report_errors_remind();
Chris@102:     }
Chris@102:     else
Chris@102:     {
Chris@102:         BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102:             << file << "(" << line << "): test '" << expr1 << " == " << expr2
Chris@102:             << "' failed in function '" << function << "': "
Chris@102:             << "'" << t << "' != '" << u << "'" << std::endl;
Chris@102:         ++test_errors();
Chris@102:     }
Chris@102: }
Chris@102: 
Chris@102: template<class T, class U> inline void test_ne_impl( char const * expr1, char const * expr2,
Chris@102:   char const * file, int line, char const * function, T const & t, U const & u )
Chris@102: {
Chris@102:     if( t != u )
Chris@102:     {
Chris@102:         report_errors_remind();
Chris@102:     }
Chris@102:     else
Chris@102:     {
Chris@102:         BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102:             << file << "(" << line << "): test '" << expr1 << " != " << expr2
Chris@102:             << "' failed in function '" << function << "': "
Chris@102:             << "'" << t << "' == '" << u << "'" << std::endl;
Chris@102:         ++test_errors();
Chris@102:     }
Chris@102: }
Chris@102: 
Chris@102: template <class T>
Chris@102: std::string to_hex(const T& x)
Chris@102: {
Chris@102:   const char hex[] = { '0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f' };
Chris@102:   std::string tmp;
Chris@102:   const unsigned char* p = reinterpret_cast<const unsigned char*>(&x);
Chris@102:   const unsigned char* e = p + sizeof(T);
Chris@102: 
Chris@102:   for (; p < e; ++p)
Chris@102:   {
Chris@102:     tmp += hex[*p >> 4];    // high-order nibble
Chris@102:     tmp += hex[*p & 0x0f];  // low-order nibble
Chris@102:   }
Chris@102:   return tmp;
Chris@102: }
Chris@102: 
Chris@102: template<class T, class U> inline bool test_memcmp_eq_impl(char const * expr1,
Chris@102:   char const * expr2, char const * file, int line, char const * function, T const & t,
Chris@102:   U const & u)
Chris@102: {
Chris@102:   BOOST_ASSERT(sizeof(T) == sizeof(U));
Chris@102:   if (sizeof(T) == sizeof(U)
Chris@102:     && std::memcmp(&t, &u, sizeof(T)) == 0)
Chris@102:   {
Chris@102:     report_errors_remind();
Chris@102:     return true;
Chris@102:   }
Chris@102:   else
Chris@102:   {
Chris@102:     BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102:       << file << "(" << line << "): test 'std::memcmp(" << expr1 << ", " << expr2
Chris@102:       << ") == 0' fails in function '" << function << "': "
Chris@102:       << " with values '" << to_hex(t) << "' and '" << to_hex(u) << "'" << std::endl;
Chris@102:     ++test_errors();
Chris@102:     return false;
Chris@102:   }
Chris@102: }
Chris@102: 
Chris@102: } // namespace detail
Chris@102: 
Chris@102: inline int report_errors()
Chris@102: {
Chris@102:     boost::endian::detail::report_errors_remind().called_report_errors_function = true;
Chris@102: 
Chris@102:     int errors = boost::endian::detail::test_errors();
Chris@102: 
Chris@102:     if( errors == 0 )
Chris@102:     {
Chris@102:         BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102:           << "No errors detected." << std::endl;
Chris@102:         return 0;
Chris@102:     }
Chris@102:     else
Chris@102:     {
Chris@102:         BOOST_LIGHTWEIGHT_TEST_OSTREAM
Chris@102:           << errors << " error" << (errors == 1? "": "s") << " detected." << std::endl;
Chris@102:         return 1;
Chris@102:     }
Chris@102: }
Chris@102: 
Chris@102: } // namespace endian
Chris@102: } // namespace boost
Chris@102: 
Chris@102: //////////////////////////////////////////////////////////////////////////////////////////
Chris@102: //  TODO: Should all test macros return bool?  See BOOST_TEST_MEM_EQ usage in fp_exaustive_test,cpp
Chris@102: //////////////////////////////////////////////////////////////////////////////////////////
Chris@102: 
Chris@102: 
Chris@102: #define BOOST_TEST(expr) \
Chris@102:   ((expr)? (void)0: ::boost::endian::detail::test_failed_impl(#expr, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION))
Chris@102: 
Chris@102: #define BOOST_ERROR(msg) \
Chris@102:   ( ::boost::endian::detail::error_impl(msg, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION) )
Chris@102: 
Chris@102: #define BOOST_TEST_EQ(expr1,expr2) \
Chris@102:   ( ::boost::endian::detail::test_eq_impl(#expr1, #expr2, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION, expr1, expr2) )
Chris@102: #define BOOST_TEST_NE(expr1,expr2) \
Chris@102:   ( ::boost::endian::detail::test_ne_impl(#expr1, #expr2, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION, expr1, expr2) )
Chris@102: 
Chris@102: #define BOOST_TEST_MEM_EQ(expr1,expr2) \
Chris@102:   (::boost::endian::detail::test_memcmp_eq_impl(#expr1, #expr2, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION, expr1, expr2))
Chris@102: 
Chris@102: #ifndef BOOST_NO_EXCEPTIONS
Chris@102:    #define BOOST_TEST_THROWS( EXPR, EXCEP )                    \
Chris@102:       try {                                                    \
Chris@102:          EXPR;                                                 \
Chris@102:          ::boost::detail::throw_failed_impl                    \
Chris@102:          (#EXCEP, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION); \
Chris@102:       }                                                        \
Chris@102:       catch(EXCEP const&) {                                    \
Chris@102:       }                                                        \
Chris@102:       catch(...) {                                             \
Chris@102:          ::boost::detail::throw_failed_impl                    \
Chris@102:          (#EXCEP, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION); \
Chris@102:       }                                                        \
Chris@102:    //
Chris@102: #else
Chris@102:    #define BOOST_TEST_THROWS( EXPR, EXCEP )
Chris@102: #endif
Chris@102: 
Chris@102: #endif // #ifndef BOOST_ENDIAN_LIGHTWEIGHT_TEST_HPP