# Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world.

### boost/vmd/assert_is_array.hpp


//  (C) Copyright Edward Diener 2011-2015
//  Use, modification and distribution are subject to the Boost Software License,
//  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at

#if !defined(BOOST_VMD_ASSERT_IS_ARRAY_HPP)
#define BOOST_VMD_ASSERT_IS_ARRAY_HPP

#include <boost/vmd/detail/setup.hpp>

/*

The succeeding comments in this file are in doxygen format.

*/

/** \file
*/

/** \def BOOST_VMD_ASSERT_IS_ARRAY(sequence)

\brief Asserts that the sequence is a Boost PP array.

The macro checks that the sequence is a Boost PP array.
If it is not a Boost PP array, it forces a compiler error.

The macro normally checks for a Boost PP array only in
debug mode. However an end-user can force the macro
to check or not check by defining the macro
BOOST_VMD_ASSERT_DATA to 1 or 0 respectively.

sequence = a possible Boost PP  array.

@code

returns  = Normally the macro returns nothing.

If the sequence is a Boost PP array, nothing is
output.

For VC++, because there is no sure way of forcing
a compiler error from within a macro without producing
output, if the sequence is not a Boost PP array the
macro forces a compiler error by outputting invalid C++.

For all other compilers a compiler error is forced
without producing output if the sequence is not a
Boost PP array.

@endcode

*/

/** \def BOOST_VMD_ASSERT_IS_ARRAY_D(d,sequence)

\brief Asserts that the sequence is a Boost PP array. Re-entrant version.

The macro checks that the sequence is a Boost PP array.
If it is not a Boost PP array, it forces a compiler error.

The macro normally checks for a Boost PP array only in
debug mode. However an end-user can force the macro
to check or not check by defining the macro
BOOST_VMD_ASSERT_DATA to 1 or 0 respectively.

d        = The next available BOOST_PP_WHILE iteration. <br/>
sequence = a possible Boost PP sequence.

@code

returns  = Normally the macro returns nothing.

If the sequence is a Boost PP array, nothing is
output.

For VC++, because there is no sure way of forcing
a compiler error from within a macro without producing
output, if the sequence is not a Boost PP array the
macro forces a compiler error by outputting invalid C++.

For all other compilers a compiler error is forced
without producing output if the sequence is not a
Boost PP array.

@endcode

*/

#if !BOOST_VMD_ASSERT_DATA

#define BOOST_VMD_ASSERT_IS_ARRAY(sequence)
#define BOOST_VMD_ASSERT_IS_ARRAY_D(d,sequence)

#else

#include <boost/vmd/is_array.hpp>
#include <boost/vmd/assert.hpp>

#define BOOST_VMD_ASSERT_IS_ARRAY(sequence) \
BOOST_VMD_ASSERT \
( \
BOOST_VMD_IS_ARRAY(sequence), \
BOOST_VMD_IS_ARRAY_ASSERT_ERROR \
) \
/**/

#define BOOST_VMD_ASSERT_IS_ARRAY_D(d,sequence) \
BOOST_VMD_ASSERT \
( \
BOOST_VMD_IS_ARRAY_D(d,sequence), \
BOOST_VMD_IS_ARRAY_ASSERT_ERROR \
) \
/**/

#endif /* !BOOST_VMD_ASSERT_DATA */