[ceph.git] / ceph / src / boost / boost / tti / has_function.hpp


//  (C) Copyright Edward Diener 2012,2013
//  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_TTI_HAS_FUNCTION_HPP)
#define BOOST_TTI_HAS_FUNCTION_HPP

#include <boost/config.hpp>
#include <boost/function_types/property_tags.hpp>
#include <boost/mpl/vector.hpp>
#include <boost/preprocessor/cat.hpp>
#include <boost/tti/detail/dfunction.hpp>
#include <boost/tti/gen/has_function_gen.hpp>

/*

  The succeeding comments in this file are in doxygen format.

*/

/** \file
*/

/// A macro which expands to a metafunction which tests whether a member function or a static member function with a particular name and signature exists.
/**

    BOOST_TTI_TRAIT_HAS_FUNCTION is a macro which expands to a metafunction.
    The metafunction tests whether a member function or a static member function with a particular name
    and signature exists. The macro takes the form of BOOST_TTI_TRAIT_HAS_FUNCTION(trait,name) where
    
    trait = the name of the metafunction <br/>
    name  = the name of the inner member.

    BOOST_TTI_TRAIT_HAS_FUNCTION generates a metafunction called "trait" where 'trait' is the macro parameter.
    
  @code
  
              template<class BOOST_TTI_TP_T,class BOOST_TTI_TP_R,class BOOST_TTI_TP_FS,class BOOST_TTI_TP_TAG>
              struct trait
                {
                static const value = unspecified;
                typedef mpl::bool_<true-or-false> type;
                };

              The metafunction types and return:
    
                BOOST_TTI_TP_T   = the enclosing type in which to look for our 'name'.
                                   The enclosing type can be a class, struct, or union.
                
                BOOST_TTI_TP_R   = the return type of the function
                
                BOOST_TTI_TP_FS  = (optional) the parameters of the function as a boost::mpl forward sequence
                          if function parameters are not empty.
                
                BOOST_TTI_TP_TAG = (optional) a boost::function_types tag to apply to the function
                          if the need for a tag exists.
                
                returns = 'value' is true if the 'name' exists, 
                          with the appropriate static member function type,
                          otherwise 'value' is false.
                          
  @endcode
  
*/
#define BOOST_TTI_TRAIT_HAS_FUNCTION(trait,name) \
  BOOST_TTI_DETAIL_TRAIT_HAS_FUNCTION(trait,name) \
  template<class BOOST_TTI_TP_T,class BOOST_TTI_TP_R,class BOOST_TTI_TP_FS = boost::mpl::vector<>,class BOOST_TTI_TP_TAG = boost::function_types::null_tag> \
  struct trait \
    { \
    typedef typename \
    BOOST_PP_CAT(trait,_detail_hf)<BOOST_TTI_TP_T,BOOST_TTI_TP_R,BOOST_TTI_TP_FS,BOOST_TTI_TP_TAG>::type type; \
    BOOST_STATIC_CONSTANT(bool,value=type::value); \
    }; \
/**/

/// A macro which expands to a metafunction which tests whether a member function or a static member function with a particular name and signature exists.
/**

    BOOST_TTI_HAS_FUNCTION is a macro which expands to a metafunction.
    The metafunction tests whether a member function or a static member function with a particular name
    and signature exists. The macro takes the form of BOOST_TTI_HAS_FUNCTION(name) where
    
    name  = the name of the inner member.

    BOOST_TTI_HAS_FUNCTION generates a metafunction called "has_function_name" where 'name' is the macro parameter.
    
  @code
  
              template<class BOOST_TTI_TP_T,class BOOST_TTI_TP_R,class BOOST_TTI_TP_FS,class BOOST_TTI_TP_TAG>
              struct has_function_'name'
                {
                static const value = unspecified;
                typedef mpl::bool_<true-or-false> type;
                };

              The metafunction types and return:
    
                BOOST_TTI_TP_T   = the enclosing type in which to look for our 'name'.
                                   The enclosing type can be a class, struct, or union.
                
                BOOST_TTI_TP_R   = the return type of the function
                
                BOOST_TTI_TP_FS  = (optional) the parameters of the function as a boost::mpl forward sequence
                          if function parameters are not empty.
                
                BOOST_TTI_TP_TAG = (optional) a boost::function_types tag to apply to the function
                          if the need for a tag exists.
                
                returns = 'value' is true if the 'name' exists, 
                          with the appropriate function type,
                          otherwise 'value' is false.
                          
  @endcode
  
*/
#define BOOST_TTI_HAS_FUNCTION(name) \
  BOOST_TTI_TRAIT_HAS_FUNCTION \
  ( \
  BOOST_TTI_HAS_FUNCTION_GEN(name), \
  name \
  ) \
/**/

#endif // BOOST_TTI_HAS_FUNCTION_HPP
Commit	Line	Data
7c673cae FG	1
	2	// (C) Copyright Edward Diener 2012,2013
	3	// Use, modification and distribution are subject to the Boost Software License,
	4	// Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
	5	// http://www.boost.org/LICENSE_1_0.txt).
	6
	7	#if !defined(BOOST_TTI_HAS_FUNCTION_HPP)
	8	#define BOOST_TTI_HAS_FUNCTION_HPP
	9
	10	#include <boost/config.hpp>
	11	#include <boost/function_types/property_tags.hpp>
	12	#include <boost/mpl/vector.hpp>
	13	#include <boost/preprocessor/cat.hpp>
	14	#include <boost/tti/detail/dfunction.hpp>
	15	#include <boost/tti/gen/has_function_gen.hpp>
	16
	17	/*
	18
	19	The succeeding comments in this file are in doxygen format.
	20
	21	*/
	22
	23	/** \file
	24	*/
	25
f67539c2	26	/// A macro which expands to a metafunction which tests whether a member function or a static member function with a particular name and signature exists.
7c673cae FG	27	/**
7c673cae FG	28
f67539c2 TL	29	BOOST_TTI_TRAIT_HAS_FUNCTION is a macro which expands to a metafunction.
	30	The metafunction tests whether a member function or a static member function with a particular name
	31	and signature exists. The macro takes the form of BOOST_TTI_TRAIT_HAS_FUNCTION(trait,name) where
7c673cae	32
f67539c2	33	trait = the name of the metafunction <br/>
7c673cae FG	34	name = the name of the inner member.
7c673cae FG	35
f67539c2	36	BOOST_TTI_TRAIT_HAS_FUNCTION generates a metafunction called "trait" where 'trait' is the macro parameter.
7c673cae	37
f67539c2 TL	38	@code
f67539c2 TL	39
7c673cae FG	40	template<class BOOST_TTI_TP_T,class BOOST_TTI_TP_R,class BOOST_TTI_TP_FS,class BOOST_TTI_TP_TAG>
	41	struct trait
	42	{
	43	static const value = unspecified;
	44	typedef mpl::bool_<true-or-false> type;
	45	};
	46
	47	The metafunction types and return:
	48
	49	BOOST_TTI_TP_T = the enclosing type in which to look for our 'name'.
f67539c2	50	The enclosing type can be a class, struct, or union.
7c673cae FG	51
	52	BOOST_TTI_TP_R = the return type of the function
	53
	54	BOOST_TTI_TP_FS = (optional) the parameters of the function as a boost::mpl forward sequence
	55	if function parameters are not empty.
	56
	57	BOOST_TTI_TP_TAG = (optional) a boost::function_types tag to apply to the function
	58	if the need for a tag exists.
	59
	60	returns = 'value' is true if the 'name' exists,
	61	with the appropriate static member function type,
	62	otherwise 'value' is false.
	63
f67539c2 TL	64	@endcode
f67539c2 TL	65
7c673cae FG	66	*/
	67	#define BOOST_TTI_TRAIT_HAS_FUNCTION(trait,name) \
	68	BOOST_TTI_DETAIL_TRAIT_HAS_FUNCTION(trait,name) \
	69	template<class BOOST_TTI_TP_T,class BOOST_TTI_TP_R,class BOOST_TTI_TP_FS = boost::mpl::vector<>,class BOOST_TTI_TP_TAG = boost::function_types::null_tag> \
	70	struct trait \
	71	{ \
	72	typedef typename \
	73	BOOST_PP_CAT(trait,_detail_hf)<BOOST_TTI_TP_T,BOOST_TTI_TP_R,BOOST_TTI_TP_FS,BOOST_TTI_TP_TAG>::type type; \
	74	BOOST_STATIC_CONSTANT(bool,value=type::value); \
	75	}; \
	76	/**/
	77
f67539c2	78	/// A macro which expands to a metafunction which tests whether a member function or a static member function with a particular name and signature exists.
7c673cae FG	79	/**
7c673cae FG	80
f67539c2 TL	81	BOOST_TTI_HAS_FUNCTION is a macro which expands to a metafunction.
	82	The metafunction tests whether a member function or a static member function with a particular name
	83	and signature exists. The macro takes the form of BOOST_TTI_HAS_FUNCTION(name) where
	84
7c673cae FG	85	name = the name of the inner member.
7c673cae FG	86
f67539c2	87	BOOST_TTI_HAS_FUNCTION generates a metafunction called "has_function_name" where 'name' is the macro parameter.
7c673cae	88
f67539c2 TL	89	@code
f67539c2 TL	90
7c673cae	91	template<class BOOST_TTI_TP_T,class BOOST_TTI_TP_R,class BOOST_TTI_TP_FS,class BOOST_TTI_TP_TAG>
f67539c2	92	struct has_function_'name'
7c673cae FG	93	{
	94	static const value = unspecified;
	95	typedef mpl::bool_<true-or-false> type;
	96	};
	97
	98	The metafunction types and return:
	99
	100	BOOST_TTI_TP_T = the enclosing type in which to look for our 'name'.
f67539c2	101	The enclosing type can be a class, struct, or union.
7c673cae FG	102
	103	BOOST_TTI_TP_R = the return type of the function
	104
	105	BOOST_TTI_TP_FS = (optional) the parameters of the function as a boost::mpl forward sequence
	106	if function parameters are not empty.
	107
	108	BOOST_TTI_TP_TAG = (optional) a boost::function_types tag to apply to the function
	109	if the need for a tag exists.
	110
	111	returns = 'value' is true if the 'name' exists,
	112	with the appropriate function type,
	113	otherwise 'value' is false.
	114
f67539c2 TL	115	@endcode
f67539c2 TL	116
7c673cae FG	117	*/
	118	#define BOOST_TTI_HAS_FUNCTION(name) \
	119	BOOST_TTI_TRAIT_HAS_FUNCTION \
	120	( \
	121	BOOST_TTI_HAS_FUNCTION_GEN(name), \
	122	name \
	123	) \
	124	/**/
	125
	126	#endif // BOOST_TTI_HAS_FUNCTION_HPP