memory_block.hpp

/*****************************************************************************
 * \file
 * \brief This header contains implementation for both the memory_block and
 *        the memory_block_cache.
 *****************************************************************************/

/*
  The MIT License (MIT)

  Copyright (c) 2018 Matthew Rodusek

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
#ifndef BIT_MEMORY_UTILITIES_MEMORY_BLOCK_HPP
#define BIT_MEMORY_UTILITIES_MEMORY_BLOCK_HPP

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)

#include <cstdlib> // std::size_t
#include <utility> // std::swap

namespace bit {
  namespace memory {
    namespace detail {
      struct memory_block_arg{};
    } // namespace detail

#ifndef BIT_DOXYGEN_BUILD
    inline void nullblock( detail::memory_block_arg& ){}
#else
    void nullblock( /* implementation defined */ );
#endif

    using nullblock_t = decltype(*nullblock);

    class memory_block
    {
      //----------------------------------------------------------------------
      // Constructors / Assignment
      //----------------------------------------------------------------------
    public:

      constexpr memory_block() noexcept;

      constexpr memory_block( nullblock_t ) noexcept;

      constexpr memory_block( void* data, std::size_t size ) noexcept;

      constexpr memory_block( const memory_block& other ) noexcept = default;

      constexpr memory_block( memory_block&& other ) noexcept = default;

      //----------------------------------------------------------------------

      memory_block& operator=( const memory_block& other ) noexcept = default;

      memory_block& operator=( memory_block&& other ) noexcept = default;

      //----------------------------------------------------------------------
      // Element Access
      //----------------------------------------------------------------------
    public:

      constexpr void* data() const noexcept;

      constexpr void* start_address() const noexcept;

      constexpr void* end_address() const noexcept;

      //----------------------------------------------------------------------
      // Observers
      //----------------------------------------------------------------------
    public:

      constexpr std::size_t size() const noexcept;

      bool contains( const void* ptr ) const noexcept;

      constexpr explicit operator bool() const noexcept;

      //----------------------------------------------------------------------
      // Mutators
      //----------------------------------------------------------------------
    public:

      void swap( memory_block& other ) noexcept;

      //----------------------------------------------------------------------
      // Private Member Types
      //----------------------------------------------------------------------
    private:

      void*       m_data;   
      std::size_t m_size;   
    };

    //------------------------------------------------------------------------
    // Free Functions
    //------------------------------------------------------------------------

    void swap( memory_block& lhs, memory_block& rhs ) noexcept;

    constexpr bool operator == ( const memory_block& lhs, const memory_block& rhs ) noexcept;
    constexpr bool operator == ( nullblock_t, const memory_block& rhs ) noexcept;
    constexpr bool operator == ( const memory_block& lhs, nullblock_t ) noexcept;

    constexpr bool operator != ( const memory_block& lhs, const memory_block& rhs ) noexcept;
    constexpr bool operator != ( nullblock_t, const memory_block& rhs ) noexcept;
    constexpr bool operator != ( const memory_block& lhs, nullblock_t ) noexcept;

    //------------------------------------------------------------------------
    // Utilities
    //------------------------------------------------------------------------

    constexpr bool is_null( memory_block block ) noexcept;

    constexpr bool is_null( nullblock_t ) noexcept;

  } // namespace memory
} // namespace bit

#include "detail/memory_block.inl"

#endif /* BIT_MEMORY_UTILITIES_MEMORY_BLOCK_HPP */