// bsltf_allocbitwisemoveabletesttype.h                               -*-C++-*-
#ifndef INCLUDED_BSLTF_ALLOCBITWISEMOVEABLETESTTYPE
#define INCLUDED_BSLTF_ALLOCBITWISEMOVEABLETESTTYPE

#include <bsls_ident.h>
BSLS_IDENT("$Id: $")

//@PURPOSE: Provide a class that allocates memory and is bitwise-moveable.
//
//@CLASSES:
//   bsltf::AllocBitwiseMoveableTestType: allocating bitwise-moveable class
//
//@SEE_ALSO: bsltf_templatetestfacility
//
//@DESCRIPTION: This component provides a single, unconstrained
// (value-semantic) attribute class, `AllocBitwiseMoveableTestType`, that is
// bitwise-moveable, uses a `bslma::Allocator` to supply memory, and defines
// the type traits `bslma::UsesBslmaAllocator` and `bslmf::IsBitwiseMoveable`.
//
///Attributes
///----------
//
// | Name   | Type | Default |
// | ------ | ---- | ------- |
// | data   | int  | 0       |
//
// * `data`: representation of the class value
//
///Usage
///-----
// This section illustrates intended use of this component.
//
///Example 1: Printing the Supported Traits
/// - - - - - - - - - - - - - - - - - - - -
// Suppose we wanted to print the supported traits of this test type.
//
// First, we create a function template `printTypeTraits` with a parameterized
// `TYPE`:
// ```
// /// Prints the traits of the parameterized `TYPE` to the console.
// template <class TYPE>
// void printTypeTraits()
// {
//     if (bslma::UsesBslmaAllocator<TYPE>::value) {
//         printf("Type defines bslma::UsesBslmaAllocator.\n");
//     }
//     else {
//         printf(
//             "Type does not define bslma::UsesBslmaAllocator.\n");
//     }
//
//     if (bslmf::IsBitwiseMoveable<TYPE>::value) {
//         printf("Type defines bslmf::IsBitwiseMoveable.\n");
//     }
//     else {
//         printf("Type does not define bslmf::IsBitwiseMoveable.\n");
//     }
// }
// ```
// Now, we invoke the `printTypeTraits` function template using
// `AllocBitwiseMoveableTestType` as the parameterized `TYPE`:
// ```
// printTypeTraits<AllocBitwiseMoveableTestType>();
// ```
// Finally, we observe the console output:
// ```
// Type defines bslma::UsesBslmaAllocator.
// Type defines bslmf::IsBitwiseMoveable.
// ```

#include <bslscm_version.h>

#include <bslma_allocator.h>
#include <bslma_default.h>
#include <bslma_usesbslmaallocator.h>

#include <bslmf_isbitwisemoveable.h>

namespace BloombergLP {
namespace bsltf {

                        // ==================================
                        // class AllocBitwiseMoveableTestType
                        // ==================================

/// This unconstrained (value-semantic) attribute class that is
/// bitwise-moveable, uses a `bslma::Allocator` to supply memory, and defines
/// the type traits `bslma::UsesBslmaAllocator` and `bslmf::IsBitwiseMoveable`.
/// See the [](#Attributes) section for information on the class attributes.
class AllocBitwiseMoveableTestType {

    // DATA
    int              *d_data_p;       // pointer to the integer class value

    bslma::Allocator *d_allocator_p;  // allocator used to supply memory (held,
                                      // not owned)

  public:
    // CREATORS

    /// Create a `AllocBitwiseMoveableTestType` object having the (default)
    /// attribute values:
    /// ```
    /// data() == 0
    /// ```
    /// Optionally specify a `basicAllocator` used to supply memory.  If
    /// `basicAllocator` is 0, the currently installed default allocator is
    /// used.
    AllocBitwiseMoveableTestType();
    explicit AllocBitwiseMoveableTestType(bslma::Allocator *basicAllocator);


    /// Create a `AllocBitwiseMoveableTestType` object having the specified
    /// `data` attribute value.  Optionally specify a `basicAllocator` used to
    /// supply memory.  If `basicAllocator` is 0, the currently installed
    /// default allocator is used.
    explicit AllocBitwiseMoveableTestType(
                                         int               data,
                                         bslma::Allocator *basicAllocator = 0);

    /// Create a `AllocBitwiseMoveableTestType` object having the same value as
    /// the specified `original` object.  Optionally specify a `basicAllocator`
    /// used to supply memory.  If `basicAllocator` is 0, the currently
    /// installed default allocator is used.
    AllocBitwiseMoveableTestType(
                     const AllocBitwiseMoveableTestType&   original,
                     bslma::Allocator                     *basicAllocator = 0);

    /// Destroy this object.
    ~AllocBitwiseMoveableTestType();

    // MANIPULATORS

    /// Assign to this object the value of the specified `rhs` object, and
    /// return a reference providing modifiable access to this object.
    AllocBitwiseMoveableTestType& operator=(
                                      const AllocBitwiseMoveableTestType& rhs);

    /// Set the `data` attribute of this object to the specified `value`.
    void setData(int value);

    // ACCESSORS

    /// Return the value of the `data` attribute of this object.
    int data() const;

                                  // Aspects

    /// Return the allocator used by this object to supply memory.
    bslma::Allocator *allocator() const;
};

// FREE OPERATORS

/// Return `true` if the specified `lhs` and `rhs` objects have the same value,
/// and `false` otherwise.  Two `AllocBitwiseMoveableTestType` objects have the
/// same if their `data` attributes are the same.
bool operator==(const AllocBitwiseMoveableTestType& lhs,
                const AllocBitwiseMoveableTestType& rhs);

/// Return `true` if the specified `lhs` and `rhs` objects do not have the same
/// value, and `false` otherwise.  Two `AllocBitwiseMoveableTestType` objects
/// do not have the same value if their `data` attributes are not the same.
bool operator!=(const AllocBitwiseMoveableTestType& lhs,
                const AllocBitwiseMoveableTestType& rhs);

// ============================================================================
//                  INLINE AND TEMPLATE FUNCTION IMPLEMENTATIONS
// ============================================================================

                        // ----------------------------------
                        // class AllocBitwiseMoveableTestType
                        // ----------------------------------

// CREATORS
inline
AllocBitwiseMoveableTestType::AllocBitwiseMoveableTestType()
: d_allocator_p(bslma::Default::allocator(0))
{
    d_data_p = reinterpret_cast<int *>(d_allocator_p->allocate(sizeof(int)));
    *d_data_p = 0;
}

inline
AllocBitwiseMoveableTestType::AllocBitwiseMoveableTestType(
                                              bslma::Allocator *basicAllocator)
: d_allocator_p(bslma::Default::allocator(basicAllocator))
{
    d_data_p = reinterpret_cast<int *>(d_allocator_p->allocate(sizeof(int)));
    *d_data_p = 0;
}

inline
AllocBitwiseMoveableTestType::AllocBitwiseMoveableTestType(
                                              int              data,
                                              bslma::Allocator *basicAllocator)
: d_allocator_p(bslma::Default::allocator(basicAllocator))
{
    d_data_p = reinterpret_cast<int *>(d_allocator_p->allocate(sizeof(int)));
    *d_data_p = data;
}

inline
AllocBitwiseMoveableTestType::AllocBitwiseMoveableTestType(
                          const AllocBitwiseMoveableTestType&  original,
                          bslma::Allocator                     *basicAllocator)
: d_allocator_p(bslma::Default::allocator(basicAllocator))
{
    d_data_p = reinterpret_cast<int *>(d_allocator_p->allocate(sizeof(int)));
    *d_data_p = *original.d_data_p;
}

inline
AllocBitwiseMoveableTestType::~AllocBitwiseMoveableTestType()
{
    d_allocator_p->deallocate(d_data_p);
}

// MANIPULATORS
inline
AllocBitwiseMoveableTestType& AllocBitwiseMoveableTestType::operator=(
                                       const AllocBitwiseMoveableTestType& rhs)
{
    if (&rhs != this)
    {
        int *newData = reinterpret_cast<int *>(
                                         d_allocator_p->allocate(sizeof(int)));
        d_allocator_p->deallocate(d_data_p);
        d_data_p = newData;
        *d_data_p = *rhs.d_data_p;
    }
    return *this;
}

inline
void AllocBitwiseMoveableTestType::setData(int value)
{
    *d_data_p = value;
}

// ACCESSORS
inline
int AllocBitwiseMoveableTestType::data() const
{
    return *d_data_p;
}

                                  // Aspects

inline
bslma::Allocator *AllocBitwiseMoveableTestType::allocator() const
{
    return d_allocator_p;
}

}  // close package namespace

// FREE OPERATORS
inline
bool bsltf::operator==(const AllocBitwiseMoveableTestType& lhs,
                       const AllocBitwiseMoveableTestType& rhs)
{
    return lhs.data() == rhs.data();
}

inline
bool bsltf::operator!=(const AllocBitwiseMoveableTestType& lhs,
                       const AllocBitwiseMoveableTestType& rhs)
{
    return lhs.data() != rhs.data();
}


// TRAITS
namespace bslma {
template <>
struct UsesBslmaAllocator<bsltf::AllocBitwiseMoveableTestType>
    : bsl::true_type {};
}  // close namespace bslma

namespace bslmf {
template <>
struct IsBitwiseMoveable<bsltf::AllocBitwiseMoveableTestType>
    : bsl::true_type {};
}  // close namespace bslmf

}  // close enterprise 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 ----------------------------------
