bslmf_addvolatile.h

Go to the documentation of this file.

/// @file bslmf_addvolatile.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslmf_addvolatile.h                                                -*-C++-*-
#ifndef INCLUDED_BSLMF_ADDVOLATILE
#define INCLUDED_BSLMF_ADDVOLATILE
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslmf_addvolatile bslmf_addvolatile
/// @brief  Provide a meta-function for adding a `volatile`-qualifier.
/// @addtogroup bsl
/// @{
/// @addtogroup bslmf
/// @{
/// @addtogroup bslmf_addvolatile
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslmf_addvolatile-purpose"> Purpose</a>
/// * <a href="#bslmf_addvolatile-classes"> Classes </a>
/// * <a href="#bslmf_addvolatile-description"> Description </a>
///   * <a href="#bslmf_addvolatile-usage"> Usage </a>
///     * <a href="#bslmf_addvolatile-example-1-adding-a-volatile-qualifier-to-a-type"> Example 1: Adding a volatile-Qualifier to a Type </a>
///
/// # Purpose {#bslmf_addvolatile-purpose}
/// Provide a meta-function for adding a `volatile`-qualifier.
///
/// # Classes {#bslmf_addvolatile-classes}
///
/// -  bsl::add_volatile: meta-function for adding top-level `volatile`-qualifier
/// -  bsl::add_volatile_t: alias to the return type of the `bsl::add_volatile`
///
/// @see  bslmf_removevolatile
///
/// # Description {#bslmf_addvolatile-description}
/// This component defines a meta-function, `bsl::add_volatile`
/// and declares an `bsl::add_volatile_t` alias to the return type of the
/// `bsl::add_volatile`, that may be used to add a top-level
/// `volatile`-qualifier to a type if it is not a reference type, nor a function
/// type, nor already `volatile`-qualified at the top-level.
///
/// `bsl::add_volatile` and `bsl::add_volatile_t` meet the requirements of the
/// @ref add_volatile  template defined in the C++11 standard [meta.trans.cv].
///
/// ## Usage {#bslmf_addvolatile-usage}
///
///
/// In this section we show intended use of this component.
///
/// ### Example 1: Adding a volatile-Qualifier to a Type {#bslmf_addvolatile-example-1-adding-a-volatile-qualifier-to-a-type}
///
///
/// Suppose that we want to add a `volatile`-qualifier to a particular type.
///
/// First, we create two `typedef`s -- a `volatile`-qualified type
/// (`MyVolatileType`) and the same type without the `volatile`-qualifier
/// (`MyType`):
/// @code
/// typedef int          MyType;
/// typedef volatile int MyVolatileType;
/// @endcode
/// Now, we add a `volatile`-qualifier to `MyType` using `bsl::add_volatile` and
/// verify that the resulting type is the same as `MyVolatileType`:
/// @code
/// assert(true ==
///    (bsl::is_same<bsl::add_volatile<MyType>::type, MyVolatileType>::value));
/// @endcode
/// Finally, if the current compiler supports alias templates C++11 feature, we
/// add a `volatile`-qualifier to `MyType` using `bsl::add_volatile_t` and
/// verify that the resulting type is the same as `MyVolatileType`:
/// @code
/// #ifdef BSLS_COMPILERFEATURES_SUPPORT_ALIAS_TEMPLATES
///   assert(true ==
///          (bsl::is_same<bsl::add_volatile_t<MyType>, MyVolatileType>::value));
/// #endif
/// @endcode
/// Note, that the `bsl::add_volatile_t` avoids the `::type` suffix and
/// `typename` prefix when we want to use the result of the `bsl::add_volatile`
/// meta-function in templates.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslmf
 * @{
 */
/** @addtogroup bslmf_addvolatile
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bslmf_isfunction.h>
#include <bslmf_isreference.h>
#include <bslmf_isvolatile.h>
 
#include <bsls_compilerfeatures.h>
 
 
 
namespace bslmf {
 
                         // ======================
                         // struct AddVolatile_Imp
                         // ======================
 
/// This `struct` template provides an alias, `Type`, that adds a
/// `volatile`-qualifier to the (template parameter) `t_TYPE` if the
/// (template parameter) `t_ADD_VOLATILE_FLAG` is `true`.  This generic
/// default template adds the `volatile`-qualifier to `t_TYPE`.  A template
/// specialization (below) leaves `t_TYPE` as-is in its `Type` alias.
///
/// See @ref bslmf_addvolatile 
template <class t_TYPE, bool t_ADD_VOLATILE_FLAG>
struct AddVolatile_Imp {
 
    // PUBLIC TYPES
 
    /// This `typedef` is an alias to a type that is the same as the
    /// (template parameter) `t_TYPE` except that a top-level
    /// `volatile`-qualifier has been added.
    typedef t_TYPE volatile Type;
};
 
                   // =====================================
                   // struct AddVolatile_Imp<t_TYPE, false>
                   // =====================================
 
/// This partial specialization of `AddVolatile_Imp`, for when the (template
/// parameter) `t_ADD_VOLATILE_FLAG` is `false`, provides an alias `Type`
/// that has the same type as the (template parameter) `t_TYPE`.
template <class t_TYPE>
struct AddVolatile_Imp<t_TYPE, false> {
 
    // PUBLIC TYPES
 
    /// This `typedef` is an alias to the (template parameter) `t_TYPE`.
    typedef t_TYPE Type;
};
 
}  // close package namespace
 
 
namespace bsl {
 
                         // ===================
                         // struct add_volatile
                         // ===================
 
/// This `struct` template implements the @ref add_volatile  meta-function
/// defined in the C++11 standard [meta.trans.cv], providing an alias,
/// `type`, that returns the result.  If the (template parameter) `t_TYPE`
/// is not a reference type, nor a function type, nor already
/// `volatile`-qualified at the top-level, then `type` is an alias to
/// `t_TYPE` with a top-level `volatile`-qualifier added; otherwise, `type`
/// is an alias to `t_TYPE`.
///
/// See @ref bslmf_addvolatile 
template <class t_TYPE>
struct add_volatile {
 
    /// This `typedef` is an alias to the (template parameter) `t_TYPE` with
    /// a top-level `volatile`-qualifier added if `t_TYPE` is not a
    /// reference type, nor a function type, nor already
    /// `volatile`-qualified at the top-level; otherwise, `type` is an alias
    /// to `t_TYPE`.
    typedef typename BloombergLP::bslmf::AddVolatile_Imp<
        t_TYPE,
        !is_reference<t_TYPE>::value && !is_function<t_TYPE>::value &&
            !is_volatile<t_TYPE>::value>::Type type;
};
 
#ifdef BSLS_COMPILERFEATURES_SUPPORT_ALIAS_TEMPLATES
 
// ALIASES
 
/// @ref add_volatile_t  is an alias to the return type of the
/// `bsl::add_volatile` meta-function.  Note, that the `bsl::add_volatile_t`
/// avoids the `::type` suffix and `typename` prefix when we want to use the
/// result of the meta-function in templates.
template <class t_TYPE>
using add_volatile_t = typename add_volatile<t_TYPE>::type;
#endif  // BSLS_COMPILERFEATURES_SUPPORT_ALIAS_TEMPLATES
 
}  // close namespace bsl
 
#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 ----------------------------------
 
/** @} */
/** @} */
/** @} */