buffer.hpp

Go to the documentation of this file.

#pragma once

#include <zk/config.hpp>

#include <type_traits>


// \def ZKPP_BUFFER_USE_STD_STRING
//  Set this to 1 to use \c std::string as the backing type for zk::buffer.
//
#ifndef ZKPP_BUFFER_USE_STD_STRING
#   define ZKPP_BUFFER_USE_STD_STRING 0
#endif

#ifndef ZKPP_BUFFER_USE_CUSTOM
#   define ZKPP_BUFFER_USE_CUSTOM 0
#endif

#ifndef ZKPP_BUFFER_USE_STD_VECTOR
#   if ZKPP_BUFFER_USE_STD_STRING || ZKPP_BUFFER_USE_CUSTOM
#       define ZKPP_BUFFER_USE_STD_VECTOR 0
#   else
#       define ZKPP_BUFFER_USE_STD_VECTOR 1
#   endif
#endif

#if ZKPP_BUFFER_USE_STD_VECTOR
#   define ZKPP_BUFFER_INCLUDE <vector>
#   define ZKPP_BUFFER_TYPE std::vector<char>
#elif ZKPP_BUFFER_USE_STD_STRING
#   define ZKPP_BUFFER_INCLUDE <string>
#   define ZKPP_BUFFER_TYPE std::string
#elif ZKPP_BUFFER_USE_CUSTOM
#   if !defined ZKPP_BUFFER_INCLUDE || !defined ZKPP_BUFFER_TYPE
#       error "When ZKPP_BUFFER_USE_CUSTOM is set, you must also define ZKPP_BUFFER_INCLUDE and ZKPP_BUFFER_TYPE"
#   endif
#else
#   error "Unknown type to use for zk::buffer"
#endif


#include ZKPP_BUFFER_INCLUDE

namespace zk
{


using buffer = ZKPP_BUFFER_TYPE;

// Check through static_assert:
static_assert(sizeof(buffer::value_type) == 1, "buffer::value_type must be single-byte elements");
static_assert(std::is_same<std::size_t, buffer::size_type>::value, "buffer::size_type must be std::size_t");
static_assert(std::is_constructible<buffer, ptr<const buffer::value_type>, ptr<const buffer::value_type>>::value,
              "buffer must be constructible with two pointers"
             );
static_assert(std::is_move_constructible<buffer>::value, "buffer must be move-constructible");
static_assert(std::is_same<decltype(std::declval<const buffer&>().size()), buffer::size_type>::value,
              "buffer::size() must return buffer::size_type"
             );
static_assert(std::is_constructible<ptr<const buffer::value_type>,
                                   decltype(std::declval<const buffer&>().data())
                                  >::value,
              "buffer::data() must return ptr<const buffer::value_type>"
             );


}