bslmf_haspointersemantics.h

Go to the documentation of this file.

/// @file bslmf_haspointersemantics.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslmf_haspointersemantics.h                                        -*-C++-*-
#ifndef INCLUDED_BSLMF_HASPOINTERSEMANTICS
#define INCLUDED_BSLMF_HASPOINTERSEMANTICS
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslmf_haspointersemantics bslmf_haspointersemantics
/// @brief  Provide a type trait for pointer semantics.
/// @addtogroup bsl
/// @{
/// @addtogroup bslmf
/// @{
/// @addtogroup bslmf_haspointersemantics
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslmf_haspointersemantics-purpose"> Purpose</a>
/// * <a href="#bslmf_haspointersemantics-classes"> Classes </a>
/// * <a href="#bslmf_haspointersemantics-description"> Description </a>
///
/// # Purpose {#bslmf_haspointersemantics-purpose}
/// Provide a type trait for pointer semantics.
///
/// # Classes {#bslmf_haspointersemantics-classes}
///
/// -  bslmf::HasPointerSemantics: meta-function indicating pointer-like types
///
/// @see 
///  bslmf_nestedtraitdeclaration
///
/// # Description {#bslmf_haspointersemantics-description}
/// This component defines a tag type `HasPointerSemantics` derived
/// from `bsl::true_type` to indicate that a type has pointer semantics, and
/// from `bsl::false_type` otherwise.  A type has pointer-like semantics must
/// define (at a minimum) `operator*` and `operator->`.  All pointer types have
/// pointer semantics; other types must explicitly add this trait, either
/// with the macro `BSLMF_NESTED_TRAIT_DECLARATION`, or by explicit template
/// specialization.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslmf
 * @{
 */
/** @addtogroup bslmf_haspointersemantics
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bslmf_detectnestedtrait.h>
#include <bslmf_integralconstant.h>
#include <bslmf_ispointer.h>
 
#ifndef BDE_DONT_ALLOW_TRANSITIVE_INCLUDES
#include <bslmf_ispointer.h>
#endif // BDE_DONT_ALLOW_TRANSITIVE_INCLUDES
 
 
namespace bslmf {
 
template <class t_TYPE>
struct HasPointerSemantics
: bsl::integral_constant<
      bool,
      bsl::is_pointer<t_TYPE>::value ||
          DetectNestedTrait<t_TYPE, HasPointerSemantics>::value> {
};
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2013 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */