123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123 |
- // (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
- // http://www.boost.org/LICENSE_1_0.txt).
- #if !defined(BOOST_VMD_GET_TYPE_HPP)
- #define BOOST_VMD_GET_TYPE_HPP
- #include <boost/vmd/detail/setup.hpp>
- #if BOOST_PP_VARIADICS
- #include <boost/vmd/detail/sequence_type.hpp>
- /*
- The succeeding comments in this file are in doxygen format.
- */
- /** \file
- */
- /** \def BOOST_VMD_GET_TYPE(...)
- \brief Returns the type of a sequence as a VMD type.
- ... = variadic parameters.
-
- The first variadic parameter is required and is the sequence whose type we are getting.
-
- The optional variadic parameters are return type parameters.
-
- The macro returns the type of a sequence as a VMD type. The type of an empty sequence
- is always BOOST_VMD_TYPE_EMPTY and the type of a multi-element is always
- BOOST_VMD_TYPE_SEQUENCE. The type of a single-element sequence is the
- type of that single element.
-
- The type returned can be modified by specifying an optional return type parameter.
-
- If BOOST_VMD_RETURN_TYPE, the default, is specified the specific type of the element
- is returned.
-
- If BOOST_VMD_RETURN_TYPE_ARRAY is specified
- an array type is returned if the element is an array, else a tuple
- type is returned if the element is a tuple, else the actual type
- is returned for non-tuple data.
-
- If BOOST_VMD_RETURN_TYPE_LIST is specified
- a list type is returned if the element is a list, else a tuple
- type is returned if the element is a tuple, else the actual type
- is returned for non-tuple data.
-
- If BOOST_VMD_RETURN_TYPE_TUPLE is specified
- a tuple type is returned for all tuple-like data, else the actual type
- is returned for non-tuple data.
-
- If BOOST_VMD_RETURN_NO_TYPE is specified it is ignored since the macro
- always returns the type of the sequence.
-
- If more than one return type optional parameter is specified the last
- one specified determines the return type.
-
- returns = the type of the sequence as a VMD type.
-
- */
- #define BOOST_VMD_GET_TYPE(...) \
- BOOST_VMD_DETAIL_SEQUENCE_TYPE(__VA_ARGS__) \
- /**/
- /** \def BOOST_VMD_GET_TYPE_D(d,...)
- \brief Returns the type of a sequence as a VMD type. Re-entrant version.
- d = The next available BOOST_PP_WHILE iteration.
- ... = variadic parameters.
-
- The first variadic parameter is required and is the sequence whose type we are getting.
-
- The optional variadic parameters are return type parameters.
-
- The macro returns the type of a sequence as a VMD type. The type of an empty sequence
- is always BOOST_VMD_TYPE_EMPTY and the type of a multi-element is always
- BOOST_VMD_TYPE_SEQUENCE. The type of a single-element sequence is the
- type of that single element.
-
- The type returned can be modified by specifying an optional return type parameter.
-
- If BOOST_VMD_RETURN_TYPE, the default, is specified the specific type of the element
- is returned.
-
- If BOOST_VMD_RETURN_TYPE_ARRAY is specified
- an array type is returned if the element is an array, else a tuple
- type is returned if the element is a tuple, else the actual type
- is returned for non-tuple data.
-
- If BOOST_VMD_RETURN_TYPE_LIST is specified
- a list type is returned if the element is a list, else a tuple
- type is returned if the element is a tuple, else the actual type
- is returned for non-tuple data.
-
- If BOOST_VMD_RETURN_TYPE_TUPLE is specified
- a tuple type is returned for all tuple-like data, else the actual type
- is returned for non-tuple data.
-
- If BOOST_VMD_RETURN_NO_TYPE is specified it is ignored since the macro
- always returns the type of the sequence.
-
- If more than one return type optional parameter is specified the last
- one specified determines the return type.
-
- returns = the type of the sequence as a VMD type.
-
- */
- #define BOOST_VMD_GET_TYPE_D(d,...) \
- BOOST_VMD_DETAIL_SEQUENCE_TYPE_D(d,__VA_ARGS__) \
- /**/
- #endif /* BOOST_PP_VARIADICS */
- #endif /* BOOST_VMD_GET_TYPE_HPP */
|