// bsltf_moveonlyalloctesttype.h -*-C++-*-
#ifndef INCLUDED_BSLTF_MOVEONLYALLOCTESTTYPE
#define INCLUDED_BSLTF_MOVEONLYALLOCTESTTYPE
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
//@PURPOSE: Provide testing type that is move-only & uses 'bslma' allocators.
//
//@CLASSES:
// bsltf::MoveOnlyAllocTestType: move-only, allocating test class
//
//@SEE_ALSO: bsltf_templatetestfacility
//
//@DESCRIPTION: This component provides a single, unconstrained
// (value-semantic) attribute class, 'MoveOnlyAllocTestType', that uses a
// 'bslma::Allocator' to supply memory (defines the type trait
// 'bslma::UsesBslmaAllocator') and provides only a move constructor and
// assignment operator (disables copy constructor and assignment operator).
// Furthermore, this class is not bitwise-moveable, and will assert on
// destruction if it has been moved. This class is primarily provided to
// facilitate testing of templates by defining a simple type representative of
// user-defined types having an allocator that cannot be copied (only moved).
//
///Attributes
///----------
//..
// Name Type Default
// ------------------ ----------- -------
// data int 0
//..
//: o 'data': representation of the object's 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':
//..
// template <class TYPE>
// void printTypeTraits()
// // Prints the traits of the parameterized 'TYPE' to the console.
// {
// 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
// 'MoveOnlyAllocTestType' as the parameterized 'TYPE':
//..
// printTypeTraits<MoveOnlyAllocTestType>();
//..
// Finally, we observe the console output:
//..
// Type defines bslma::UsesBslmaAllocator.
// Type does not define bslmf::IsBitwiseMoveable.
//..
#include <bslscm_version.h>
#include <bsltf_movestate.h>
#include <bslma_usesbslmaallocator.h>
#include <bslmf_movableref.h>
#include <bsls_compilerfeatures.h>
#include <bsls_keyword.h>
namespace BloombergLP {
namespace bslma { class Allocator; }
namespace bsltf {
// ===========================
// class MoveOnlyAllocTestType
// ===========================
class MoveOnlyAllocTestType {
// This unconstrained (value-semantic) attribute class that uses a
// 'bslma::Allocator' to supply memory and defines the type trait
// 'bslma::UsesBslmaAllocator'. This class is primarily provided to
// facilitate testing of templates by defining a simple type representative
// of user-defined types having an allocator. See the Attributes section
// under @DESCRIPTION in the component-level documentation for information
// on the class attributes.
// DATA
int *d_data_p; // pointer to the data value
bslma::Allocator *d_allocator_p; // allocator used to supply memory
// (held, not owned)
MoveOnlyAllocTestType *d_self_p; // pointer to self (to verify this
// object is not bit-wise moved)
MoveState::Enum d_movedFrom; // moved-from state
MoveState::Enum d_movedInto; // moved-from state
#ifndef BSLS_COMPILERFEATURES_SUPPORT_NOEXCEPT
public:
// TRAITS
BSLMF_NESTED_TRAIT_DECLARATION(MoveOnlyAllocTestType,
bsl::is_nothrow_move_constructible);
#endif
private:
// NOT IMPLEMENTED
MoveOnlyAllocTestType& operator=(const MoveOnlyAllocTestType&);
MoveOnlyAllocTestType(const MoveOnlyAllocTestType&);
public:
// CREATORS
explicit MoveOnlyAllocTestType(bslma::Allocator *basicAllocator = 0);
// Create a 'MoveOnlyAllocTestType' 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.
explicit MoveOnlyAllocTestType(int data,
bslma::Allocator *basicAllocator = 0);
// Create a 'MoveOnlyAllocTestType' 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.
MoveOnlyAllocTestType(bslmf::MovableRef<MoveOnlyAllocTestType> original)
BSLS_KEYWORD_NOEXCEPT;
MoveOnlyAllocTestType(
bslmf::MovableRef<MoveOnlyAllocTestType> original,
bslma::Allocator *basicAllocator);
// Create a 'MoveAllocTestType' 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. After construction, this
// object will be in a 'movedInto' state, and 'original' will be in a
// 'movedFrom' state. No allocations shall occur (so no exception will
// be thrown) unless 'basicAllocator' is not the currently installed
// default allocator.
~MoveOnlyAllocTestType();
// Destroy this object.
// MANIPULATORS
MoveOnlyAllocTestType& operator=(
bslmf::MovableRef<MoveOnlyAllocTestType> rhs);
// Assign to this object the value of the specified 'rhs' object, and
// return a reference providing modifiable access to this object. If
// 'rhs' is a reference to this object, there are no other effects;
// otherwise, the object referenced by 'rhs' will be reset to a default
// constructed state, 'rhs' shall be in a 'movedFrom' state, and this
// object will be in a 'movedTo' state. No allocations shall occur
// (so no exception will be thrown) unless this object and 'rhs' have
// different allocators. Note that the moved-from state is specified,
// rather than "valid but unspecified", as this type is intended for
// verifying test drivers that want to ensure that moves occur
// correctly where expected.
void setData(int value);
// Set the 'data' attribute of this object to the specified 'value'.
void setMovedInto(MoveState::Enum value);
// Set the moved-into state of this object to the specified 'value'.
// ACCESSORS
int data() const;
// Return the value of the 'data' attribute of this object.
// Aspects
bslma::Allocator *allocator() const;
// Return the allocator used by this object to supply memory.
MoveState::Enum movedInto() const;
// Return the move state of this object as target of a move operation.
MoveState::Enum movedFrom() const;
// Return the move state of this object as source of a move operation.
};
// FREE OPERATORS
bool operator==(const MoveOnlyAllocTestType& lhs,
const MoveOnlyAllocTestType& rhs);
// Return 'true' if the specified 'lhs' and 'rhs' objects have the same
// value, and 'false' otherwise. Two 'MoveOnlyAllocTestType' objects have
// the same if their 'data' attributes are the same.
bool operator!=(const MoveOnlyAllocTestType& lhs,
const MoveOnlyAllocTestType& rhs);
// Return 'true' if the specified 'lhs' and 'rhs' objects do not have the
// same value, and 'false' otherwise. Two 'MoveOnlyAllocTestType' objects
// do not have the same value if their 'data' attributes are not the same.
// FREE FUNCTIONS
MoveState::Enum getMovedFrom(const MoveOnlyAllocTestType& object);
// Return the move-from state of the specified 'object'.
MoveState::Enum getMovedInto(const MoveOnlyAllocTestType& object);
// Return the move-into state of the specified 'object'.
void setMovedInto(MoveOnlyAllocTestType *object, MoveState::Enum value);
// Set the moved-into state of the specified 'object' to the specified
// 'value'.
void swap(MoveOnlyAllocTestType& a, MoveOnlyAllocTestType& b);
// Exchange the states of the specified 'a' and 'b'. Both 'a' and 'b' will
// be left in a moved-into state. No allocations shall occur (so no
// exceptions will be thrown) unless 'a' and 'b' have different allocators.
// ============================================================================
// INLINE AND TEMPLATE FUNCTION IMPLEMENTATIONS
// ============================================================================
// ---------------------------
// class MoveOnlyAllocTestType
// ---------------------------
// ACCESSORS
inline
int MoveOnlyAllocTestType::data() const
{
return d_data_p ? *d_data_p : 0;
}
// MANIPULATORS
inline
void MoveOnlyAllocTestType::setMovedInto(MoveState::Enum value)
{
d_movedInto = value;
}
// Aspects
inline
bslma::Allocator *MoveOnlyAllocTestType::allocator() const
{
return d_allocator_p;
}
inline
MoveState::Enum MoveOnlyAllocTestType::movedFrom() const
{
return d_movedFrom;
}
inline
MoveState::Enum MoveOnlyAllocTestType::movedInto() const
{
return d_movedInto;
}
// FREE FUNCTIONS
inline
MoveState::Enum getMovedFrom(const MoveOnlyAllocTestType& object)
{
return object.movedFrom();
}
inline
MoveState::Enum getMovedInto(const MoveOnlyAllocTestType& object)
{
return object.movedInto();
}
inline
void setMovedInto(MoveOnlyAllocTestType *object, MoveState::Enum value)
{
object->setMovedInto(value);
}
} // close package namespace
// FREE OPERATORS
inline
bool bsltf::operator==(const MoveOnlyAllocTestType& lhs,
const MoveOnlyAllocTestType& rhs)
{
return lhs.data() == rhs.data();
}
inline
bool bsltf::operator!=(const MoveOnlyAllocTestType& lhs,
const MoveOnlyAllocTestType& rhs)
{
return lhs.data() != rhs.data();
}
// TRAITS
namespace bslma {
template <>
struct UsesBslmaAllocator<bsltf::MoveOnlyAllocTestType>
: bsl::true_type {};
} // close namespace bslma
} // close enterprise namespace
namespace bsl {
template <>
struct is_copy_constructible<BloombergLP::bsltf::MoveOnlyAllocTestType>
: bsl::false_type {};
} // 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 ----------------------------------