summaryrefslogtreecommitdiff
path: root/boost/vmd/is_array.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'boost/vmd/is_array.hpp')
-rw-r--r--boost/vmd/is_array.hpp73
1 files changed, 73 insertions, 0 deletions
diff --git a/boost/vmd/is_array.hpp b/boost/vmd/is_array.hpp
new file mode 100644
index 0000000000..fc9cf4708e
--- /dev/null
+++ b/boost/vmd/is_array.hpp
@@ -0,0 +1,73 @@
+
+// (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_IS_ARRAY_HPP)
+#define BOOST_VMD_IS_ARRAY_HPP
+
+#include <boost/vmd/detail/setup.hpp>
+
+#if BOOST_PP_VARIADICS
+
+#include <boost/vmd/detail/is_array.hpp>
+
+/*
+
+ The succeeding comments in this file are in doxygen format.
+
+*/
+
+/** \file
+*/
+
+/** \def BOOST_VMD_IS_ARRAY(sequence)
+
+ \brief Determines if a sequence is a Boost PP array.
+
+ The macro checks that the sequence is a Boost PP array.
+ It returns 1 if it is an array, else if returns 0.
+
+ sequence = a possible Boost PP array.
+
+ returns = 1 if it is an array, else returns 0.
+
+ The macro will generate a preprocessing error if the input
+ is in the form of an array but its first tuple element, instead
+ of being a number, is a preprocessor token which VMD cannot parse,
+ as in the example '(&2,(0,1))' which is a valid tuple but an invalid
+ array.
+
+*/
+
+#define BOOST_VMD_IS_ARRAY(sequence) \
+ BOOST_VMD_DETAIL_IS_ARRAY(sequence) \
+/**/
+
+/** \def BOOST_VMD_IS_ARRAY_D(d,sequence)
+
+ \brief Determines if a sequence is a Boost PP array. Re-entrant version.
+
+ The macro checks that the sequence is a Boost PP array.
+ It returns 1 if it is an array, else if returns 0.
+
+ d = The next available BOOST_PP_WHILE iteration.
+ sequence = a possible Boost PP array.
+
+ returns = 1 if it is an array, else returns 0.
+
+ The macro will generate a preprocessing error if the input
+ is in the form of an array but its first tuple element, instead
+ of being a number, is a preprocessor token which VMD cannot parse,
+ as in the example '(&2,(0,1))' which is a valid tuple but an invalid
+ array.
+
+*/
+
+#define BOOST_VMD_IS_ARRAY_D(d,sequence) \
+ BOOST_VMD_DETAIL_IS_ARRAY_D(d,sequence) \
+/**/
+
+#endif /* BOOST_PP_VARIADICS */
+#endif /* BOOST_VMD_IS_ARRAY_HPP */