Chris@16: // Boost uuid.hpp header file  ----------------------------------------------//
Chris@16: 
Chris@16: // Copyright 2006 Andy Tompkins.
Chris@16: // Distributed under the Boost Software License, Version 1.0. (See
Chris@16: // accompanying file LICENSE_1_0.txt or copy at
Chris@16: // http://www.boost.org/LICENSE_1_0.txt)
Chris@16: 
Chris@16: // Revision History
Chris@16: //  06 Feb 2006 - Initial Revision
Chris@16: //  09 Nov 2006 - fixed variant and version bits for v4 guids
Chris@16: //  13 Nov 2006 - added serialization
Chris@16: //  17 Nov 2006 - added name-based guid creation
Chris@16: //  20 Nov 2006 - add fixes for gcc (from Tim Blechmann)
Chris@16: //  07 Mar 2007 - converted to header only
Chris@16: //  10 May 2007 - removed need for Boost.Thread
Chris@16: //              - added better seed - thanks Peter Dimov
Chris@16: //              - removed null()
Chris@16: //              - replaced byte_count() and output_bytes() with size() and begin() and end()
Chris@16: //  11 May 2007 - fixed guid(ByteInputIterator first, ByteInputIterator last)
Chris@16: //              - optimized operator>>
Chris@16: //  14 May 2007 - converted from guid to uuid
Chris@16: //  29 May 2007 - uses new implementation of sha1
Chris@16: //  01 Jun 2007 - removed using namespace directives
Chris@16: //  09 Nov 2007 - moved implementation to uuid.ipp file
Chris@16: //  12 Nov 2007 - moved serialize code to uuid_serialize.hpp file
Chris@16: //  25 Feb 2008 - moved to namespace boost::uuids
Chris@16: //  19 Mar 2009 - changed to a POD, reorganized files
Chris@16: //  28 Nov 2009 - disabled deprecated warnings for MSVC
Chris@16: //  30 Nov 2009 - used BOOST_STATIC_CONSTANT
Chris@16: //  02 Dec 2009 - removed BOOST_STATIC_CONSTANT - not all compilers like it
Chris@101: //  29 Apr 2013 - added support for noexcept and constexpr, added optimizations for SSE/AVX
Chris@16: 
Chris@16: #ifndef BOOST_UUID_HPP
Chris@16: #define BOOST_UUID_HPP
Chris@16: 
Chris@101: #include <cstddef>
Chris@16: #include <boost/cstdint.hpp>
Chris@101: #include <boost/uuid/detail/config.hpp>
Chris@16: #ifndef BOOST_UUID_NO_TYPE_TRAITS
Chris@16: #include <boost/type_traits/is_pod.hpp>
Chris@16: #include <boost/type_traits/integral_constant.hpp>
Chris@16: #endif
Chris@16: 
Chris@101: #ifdef BOOST_HAS_PRAGMA_ONCE
Chris@101: #pragma once
Chris@101: #endif
Chris@101: 
Chris@16: #if defined(_MSC_VER)
Chris@16: #pragma warning(push) // Save warning settings.
Chris@16: #pragma warning(disable : 4996) // Disable deprecated std::swap_ranges, std::equal
Chris@16: #endif
Chris@16: 
Chris@16: #ifdef BOOST_NO_STDC_NAMESPACE
Chris@16: namespace std {
Chris@16:     using ::size_t;
Chris@16:     using ::ptrdiff_t;
Chris@16: } //namespace std
Chris@16: #endif //BOOST_NO_STDC_NAMESPACE
Chris@16: 
Chris@16: namespace boost {
Chris@16: namespace uuids {
Chris@16: 
Chris@16: struct uuid
Chris@16: {
Chris@16: public:
Chris@16:     typedef uint8_t value_type;
Chris@16:     typedef uint8_t& reference;
Chris@16:     typedef uint8_t const& const_reference;
Chris@16:     typedef uint8_t* iterator;
Chris@16:     typedef uint8_t const* const_iterator;
Chris@16:     typedef std::size_t size_type;
Chris@16:     typedef std::ptrdiff_t difference_type;
Chris@16: 
Chris@16:     // This does not work on some compilers
Chris@101:     // They seem to want the variable definec in
Chris@16:     // a cpp file
Chris@16:     //BOOST_STATIC_CONSTANT(size_type, static_size = 16);
Chris@101:     static BOOST_CONSTEXPR size_type static_size() BOOST_NOEXCEPT { return 16; }
Chris@16: 
Chris@16: public:
Chris@101:     iterator begin() BOOST_NOEXCEPT { return data; }
Chris@101:     const_iterator begin() const BOOST_NOEXCEPT { return data; }
Chris@101:     iterator end() BOOST_NOEXCEPT { return data+size(); }
Chris@101:     const_iterator end() const BOOST_NOEXCEPT { return data+size(); }
Chris@16: 
Chris@101:     BOOST_CONSTEXPR size_type size() const BOOST_NOEXCEPT { return static_size(); }
Chris@16: 
Chris@101:     bool is_nil() const BOOST_NOEXCEPT;
Chris@16: 
Chris@16:     enum variant_type
Chris@16:     {
Chris@16:         variant_ncs, // NCS backward compatibility
Chris@16:         variant_rfc_4122, // defined in RFC 4122 document
Chris@16:         variant_microsoft, // Microsoft Corporation backward compatibility
Chris@16:         variant_future // future definition
Chris@16:     };
Chris@101:     variant_type variant() const BOOST_NOEXCEPT
Chris@16:     {
Chris@16:         // variant is stored in octet 7
Chris@16:         // which is index 8, since indexes count backwards
Chris@16:         unsigned char octet7 = data[8]; // octet 7 is array index 8
Chris@16:         if ( (octet7 & 0x80) == 0x00 ) { // 0b0xxxxxxx
Chris@16:             return variant_ncs;
Chris@16:         } else if ( (octet7 & 0xC0) == 0x80 ) { // 0b10xxxxxx
Chris@16:             return variant_rfc_4122;
Chris@16:         } else if ( (octet7 & 0xE0) == 0xC0 ) { // 0b110xxxxx
Chris@16:             return variant_microsoft;
Chris@16:         } else {
Chris@16:             //assert( (octet7 & 0xE0) == 0xE0 ) // 0b111xxxx
Chris@16:             return variant_future;
Chris@16:         }
Chris@16:     }
Chris@101: 
Chris@101:     enum version_type
Chris@16:     {
Chris@16:         version_unknown = -1,
Chris@16:         version_time_based = 1,
Chris@16:         version_dce_security = 2,
Chris@16:         version_name_based_md5 = 3,
Chris@16:         version_random_number_based = 4,
Chris@16:         version_name_based_sha1 = 5
Chris@16:     };
Chris@101:     version_type version() const BOOST_NOEXCEPT
Chris@16:     {
Chris@101:         // version is stored in octet 9
Chris@16:         // which is index 6, since indexes count backwards
Chris@101:         uint8_t octet9 = data[6];
Chris@16:         if ( (octet9 & 0xF0) == 0x10 ) {
Chris@16:             return version_time_based;
Chris@16:         } else if ( (octet9 & 0xF0) == 0x20 ) {
Chris@16:             return version_dce_security;
Chris@16:         } else if ( (octet9 & 0xF0) == 0x30 ) {
Chris@16:             return version_name_based_md5;
Chris@16:         } else if ( (octet9 & 0xF0) == 0x40 ) {
Chris@16:             return version_random_number_based;
Chris@16:         } else if ( (octet9 & 0xF0) == 0x50 ) {
Chris@16:             return version_name_based_sha1;
Chris@16:         } else {
Chris@16:             return version_unknown;
Chris@16:         }
Chris@16:     }
Chris@16: 
Chris@16:     // note: linear complexity
Chris@101:     void swap(uuid& rhs) BOOST_NOEXCEPT;
Chris@16: 
Chris@16: public:
Chris@16:     // or should it be array<uint8_t, 16>
Chris@16:     uint8_t data[16];
Chris@16: };
Chris@16: 
Chris@101: bool operator== (uuid const& lhs, uuid const& rhs) BOOST_NOEXCEPT;
Chris@101: bool operator< (uuid const& lhs, uuid const& rhs) BOOST_NOEXCEPT;
Chris@16: 
Chris@101: inline bool operator!=(uuid const& lhs, uuid const& rhs) BOOST_NOEXCEPT
Chris@16: {
Chris@16:     return !(lhs == rhs);
Chris@16: }
Chris@16: 
Chris@101: inline bool operator>(uuid const& lhs, uuid const& rhs) BOOST_NOEXCEPT
Chris@16: {
Chris@16:     return rhs < lhs;
Chris@16: }
Chris@101: inline bool operator<=(uuid const& lhs, uuid const& rhs) BOOST_NOEXCEPT
Chris@16: {
Chris@16:     return !(rhs < lhs);
Chris@16: }
Chris@16: 
Chris@101: inline bool operator>=(uuid const& lhs, uuid const& rhs) BOOST_NOEXCEPT
Chris@16: {
Chris@16:     return !(lhs < rhs);
Chris@16: }
Chris@16: 
Chris@101: inline void swap(uuid& lhs, uuid& rhs) BOOST_NOEXCEPT
Chris@16: {
Chris@16:     lhs.swap(rhs);
Chris@16: }
Chris@16: 
Chris@16: // This is equivalent to boost::hash_range(u.begin(), u.end());
Chris@101: inline std::size_t hash_value(uuid const& u) BOOST_NOEXCEPT
Chris@16: {
Chris@16:     std::size_t seed = 0;
Chris@101:     for(uuid::const_iterator i=u.begin(), e=u.end(); i != e; ++i)
Chris@16:     {
Chris@16:         seed ^= static_cast<std::size_t>(*i) + 0x9e3779b9 + (seed << 6) + (seed >> 2);
Chris@16:     }
Chris@16: 
Chris@16:     return seed;
Chris@16: }
Chris@16: 
Chris@16: }} //namespace boost::uuids
Chris@16: 
Chris@16: #ifndef BOOST_UUID_NO_TYPE_TRAITS
Chris@16: // type traits specializations
Chris@16: namespace boost {
Chris@16: 
Chris@16: template <>
Chris@16: struct is_pod<uuids::uuid> : true_type {};
Chris@16: 
Chris@16: } // namespace boost
Chris@16: #endif
Chris@16: 
Chris@101: #if defined(BOOST_UUID_USE_SSE2)
Chris@101: #include <boost/uuid/detail/uuid_x86.hpp>
Chris@101: #else
Chris@101: #include <boost/uuid/detail/uuid_generic.hpp>
Chris@101: #endif
Chris@101: 
Chris@16: #if defined(_MSC_VER)
Chris@16: #pragma warning(pop) // Restore warnings to previous state.
Chris@16: #endif
Chris@16: 
Chris@16: #endif // BOOST_UUID_HPP