boost/vmd/is_list.hpp

0001
0002 //  (C) Copyright Edward Diener 2011-2015
0003 //  Use, modification and distribution are subject to the Boost Software License,
0004 //  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
0005 //  http://www.boost.org/LICENSE_1_0.txt).
0006
0007 #if !defined(BOOST_VMD_IS_LIST_HPP)
0008 #define BOOST_VMD_IS_LIST_HPP
0009
0010 #include <boost/vmd/detail/setup.hpp>
0011
0012 #if BOOST_PP_VARIADICS
0013
0014 #include <boost/vmd/detail/is_list.hpp>
0015
0016 /*
0017
0018   The succeeding comments in this file are in doxygen format.
0019
0020 */
0021
0022 /** \file
0023 */
0024
0025 /** \def BOOST_VMD_IS_LIST(sequence)
0026
0027     \brief Determines if a sequence is a Boost pplib list.
0028
0029     The macro checks that the sequence is a pplib list.
0030     It returns 1 if it is a list, else if returns 0.
0031
0032     sequence = input as a possible Boost PP list.
0033
0034     returns = 1 if it a list, else returns 0.
0035
0036     The macro will generate a preprocessing error if the input
0037     is in the form of a list but its end-of-list marker, instead
0038     of being an identifier, is a preprocessor token which VMD cannot parse,
0039     as in the example '(anything,&BOOST_PP_NIL)' which is a valid tuple but
0040     an invalid list.
0041
0042 */
0043
0044 #define BOOST_VMD_IS_LIST(sequence) \
0045     BOOST_VMD_DETAIL_IS_LIST(sequence) \
0046 /**/
0047
0048 /** \def BOOST_VMD_IS_LIST_D(d,sequence)
0049
0050     \brief Determines if a sequence is a Boost pplib list. Re-entrant version.
0051
0052     The macro checks that the sequence is a pplib list.
0053     It returns 1 if it is a list, else if returns 0.
0054
0055     d        = The next available BOOST_PP_WHILE iteration. <br/>
0056     sequence = input as a possible Boost PP list.
0057
0058     returns = 1 if it a list, else returns 0.
0059
0060     The macro will generate a preprocessing error if the input
0061     is in the form of a list but its end-of-list marker, instead
0062     of being an identifier, is a preprocessor token which VMD cannot parse,
0063     as in the example '(anything,&BOOST_PP_NIL)' which is a valid tuple but
0064     an invalid list.
0065
0066 */
0067
0068 #define BOOST_VMD_IS_LIST_D(d,sequence) \
0069     BOOST_VMD_DETAIL_IS_LIST_D(d,sequence) \
0070 /**/
0071
0072 #endif /* BOOST_PP_VARIADICS */
0073 #endif /* BOOST_VMD_IS_LIST_HPP */