ircd: Split off tuple.h from util.h

include/ircd/stdinc.h

@@ -189,6 +189,7 @@ namespace ircd
 #include "vector_view.h"
 #include "array_view.h"
 #include "byte_view.h"
+#include "tuple.h"
 #include "allocator.h"
 #include "buffer.h"
 #include "date.h"

include/ircd/tuple.h

@@ -0,0 +1,386 @@
+/*
+ * charybdis: 21st Century IRC++d
+ * util.h: Miscellaneous utilities
+ *
+ * Copyright (C) 2016 Charybdis Development Team
+ * Copyright (C) 2016 Jason Volk <jason@zemos.net>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice is present in all copies.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+#pragma once
+#define HAVE_IRCD_TUPLE_H
+
+//
+// Utilities for std::tuple
+//
+
+namespace ircd::util
+{
+
+//
+// Iteration of a tuple
+//
+// for_each(tuple, [](auto&& elem) { ... });
+
+template<size_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == std::tuple_size<std::tuple<args...>>::value, void>::type
+for_each(std::tuple<args...> &t,
+         func&& f)
+{}
+
+template<size_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == std::tuple_size<std::tuple<args...>>::value, void>::type
+for_each(const std::tuple<args...> &t,
+         func&& f)
+{}
+
+template<size_t i = 0,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i < std::tuple_size<std::tuple<args...>>::value, void>::type
+for_each(const std::tuple<args...> &t,
+         func&& f)
+{
+	f(std::get<i>(t));
+	for_each<i+1>(t, std::forward<func>(f));
+}
+
+template<size_t i = 0,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i < std::tuple_size<std::tuple<args...>>::value, void>::type
+for_each(std::tuple<args...> &t,
+         func&& f)
+{
+	f(std::get<i>(t));
+	for_each<i+1>(t, std::forward<func>(f));
+}
+
+//
+// Circuits for reverse iteration of a tuple
+//
+// rfor_each(tuple, [](auto&& elem) { ... });
+
+template<ssize_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == 0, void>::type
+rfor_each(const std::tuple<args...> &t,
+          func&& f)
+{}
+
+template<ssize_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == 0, void>::type
+rfor_each(std::tuple<args...> &t,
+          func&& f)
+{}
+
+template<ssize_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i > 0), void>::type
+rfor_each(const std::tuple<args...> &t,
+          func&& f)
+{
+	f(std::get<i - 1>(t));
+	rfor_each<i - 1>(t, std::forward<func>(f));
+}
+
+template<ssize_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i > 0), void>::type
+rfor_each(std::tuple<args...> &t,
+          func&& f)
+{
+	f(std::get<i - 1>(t));
+	rfor_each<i - 1>(t, std::forward<func>(f));
+}
+
+template<ssize_t i = -1,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i == -1), void>::type
+rfor_each(const std::tuple<args...> &t,
+          func&& f)
+{
+	constexpr const ssize_t size
+	{
+		std::tuple_size<std::tuple<args...>>::value
+	};
+
+	rfor_each<size>(t, std::forward<func>(f));
+}
+
+template<ssize_t i = -1,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i == -1), void>::type
+rfor_each(std::tuple<args...> &t,
+          func&& f)
+{
+	constexpr const ssize_t size
+	{
+		std::tuple_size<std::tuple<args...>>::value
+	};
+
+	rfor_each<size>(t, std::forward<func>(f));
+}
+
+//
+// Iteration of a tuple until() style: your closure returns true to continue, false
+// to break. until() then remains true to the end, or returns false if not.
+
+template<size_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == std::tuple_size<std::tuple<args...>>::value, bool>::type
+until(std::tuple<args...> &t,
+      func&& f)
+{
+	return true;
+}
+
+template<size_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == std::tuple_size<std::tuple<args...>>::value, bool>::type
+until(const std::tuple<args...> &t,
+      func&& f)
+{
+	return true;
+}
+
+template<size_t i = 0,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i < std::tuple_size<std::tuple<args...>>::value, bool>::type
+until(std::tuple<args...> &t,
+      func&& f)
+{
+	using value_type = typename std::tuple_element<i, std::tuple<args...>>::type;
+	return f(static_cast<value_type &>(std::get<i>(t)))? until<i+1>(t, f) : false;
+}
+
+template<size_t i = 0,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i < std::tuple_size<std::tuple<args...>>::value, bool>::type
+until(const std::tuple<args...> &t,
+      func&& f)
+{
+	using value_type = typename std::tuple_element<i, std::tuple<args...>>::type;
+	return f(static_cast<const value_type &>(std::get<i>(t)))? until<i+1>(t, f) : false;
+}
+
+//
+// Circuits for reverse iteration of a tuple
+//
+// runtil(tuple, [](auto&& elem) -> bool { ... });
+
+template<ssize_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == 0, bool>::type
+runtil(const std::tuple<args...> &t,
+       func&& f)
+{
+	return true;
+}
+
+template<ssize_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == 0, bool>::type
+runtil(std::tuple<args...> &t,
+       func&& f)
+{
+	return true;
+}
+
+template<ssize_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i > 0), bool>::type
+runtil(const std::tuple<args...> &t,
+       func&& f)
+{
+	return f(std::get<i - 1>(t))? runtil<i - 1>(t, f) : false;
+}
+
+template<ssize_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i > 0), bool>::type
+runtil(std::tuple<args...> &t,
+       func&& f)
+{
+	return f(std::get<i - 1>(t))? runtil<i - 1>(t, f) : false;
+}
+
+template<ssize_t i = -1,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i == -1), bool>::type
+runtil(const std::tuple<args...> &t,
+       func&& f)
+{
+	constexpr const auto size
+	{
+		std::tuple_size<std::tuple<args...>>::value
+	};
+
+	return runtil<size>(t, std::forward<func>(f));
+}
+
+template<ssize_t i = -1,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i == -1), bool>::type
+runtil(std::tuple<args...> &t,
+       func&& f)
+{
+	constexpr const auto size
+	{
+		std::tuple_size<std::tuple<args...>>::value
+	};
+
+	return runtil<size>(t, std::forward<func>(f));
+}
+
+//
+// Kronecker delta
+//
+
+template<size_t j,
+         size_t i,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == j, void>::type
+kronecker_delta(const std::tuple<args...> &t,
+                func&& f)
+{
+	using value_type = typename std::tuple_element<i, std::tuple<args...>>::type;
+	f(static_cast<const value_type &>(std::get<i>(t)));
+}
+
+template<size_t i,
+         size_t j,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<i == j, void>::type
+kronecker_delta(std::tuple<args...> &t,
+                func&& f)
+{
+	using value_type = typename std::tuple_element<i, std::tuple<args...>>::type;
+	f(static_cast<value_type &>(std::get<i>(t)));
+}
+
+template<size_t j,
+         size_t i = 0,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i < j), void>::type
+kronecker_delta(const std::tuple<args...> &t,
+                func&& f)
+{
+	kronecker_delta<j, i + 1>(t, std::forward<func>(f));
+}
+
+template<size_t j,
+         size_t i = 0,
+         class func,
+         class... args>
+constexpr
+typename std::enable_if<(i < j), void>::type
+kronecker_delta(std::tuple<args...> &t,
+                func&& f)
+{
+	kronecker_delta<j, i + 1>(t, std::forward<func>(f));
+}
+
+//
+// Get the index of a tuple element by address at runtime
+//
+template<class tuple>
+size_t
+indexof(tuple &t, const void *const &ptr)
+{
+	size_t ret(0);
+	const auto closure([&ret, &ptr]
+	(auto &elem)
+	{
+		if(reinterpret_cast<const void *>(std::addressof(elem)) == ptr)
+			return false;
+
+		++ret;
+		return true;
+	});
+
+	if(unlikely(until(t, closure)))
+		throw std::out_of_range("no member of this tuple with that address");
+
+	return ret;
+}
+
+//
+// Tuple layouts are not standard layouts; we can only do this at runtime
+//
+template<size_t index,
+         class tuple>
+off_t
+tuple_offset(const tuple &t)
+{
+	return
+	{
+	      reinterpret_cast<const uint8_t *>(std::addressof(std::get<index>(t))) -
+	      reinterpret_cast<const uint8_t *>(std::addressof(t))
+	};
+}
+
+} // namespace ircd::util

include/ircd/util.h

@@ -241,318 +241,6 @@ template<class T>
 using custom_ptr = std::unique_ptr<T, std::function<void (T *) noexcept>>;
 
 
-//
-// Iteration of a tuple
-//
-// for_each(tuple, [](auto&& elem) { ... });
-
-template<size_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == std::tuple_size<std::tuple<args...>>::value, void>::type
-for_each(std::tuple<args...> &t,
-         func&& f)
-{}
-
-template<size_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == std::tuple_size<std::tuple<args...>>::value, void>::type
-for_each(const std::tuple<args...> &t,
-         func&& f)
-{}
-
-template<size_t i = 0,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i < std::tuple_size<std::tuple<args...>>::value, void>::type
-for_each(const std::tuple<args...> &t,
-         func&& f)
-{
-	f(std::get<i>(t));
-	for_each<i+1>(t, std::forward<func>(f));
-}
-
-template<size_t i = 0,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i < std::tuple_size<std::tuple<args...>>::value, void>::type
-for_each(std::tuple<args...> &t,
-         func&& f)
-{
-	f(std::get<i>(t));
-	for_each<i+1>(t, std::forward<func>(f));
-}
-
-//
-// Circuits for reverse iteration of a tuple
-//
-// rfor_each(tuple, [](auto&& elem) { ... });
-
-template<ssize_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == 0, void>::type
-rfor_each(const std::tuple<args...> &t,
-          func&& f)
-{}
-
-template<ssize_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == 0, void>::type
-rfor_each(std::tuple<args...> &t,
-          func&& f)
-{}
-
-template<ssize_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i > 0), void>::type
-rfor_each(const std::tuple<args...> &t,
-          func&& f)
-{
-	f(std::get<i - 1>(t));
-	rfor_each<i - 1>(t, std::forward<func>(f));
-}
-
-template<ssize_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i > 0), void>::type
-rfor_each(std::tuple<args...> &t,
-          func&& f)
-{
-	f(std::get<i - 1>(t));
-	rfor_each<i - 1>(t, std::forward<func>(f));
-}
-
-template<ssize_t i = -1,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i == -1), void>::type
-rfor_each(const std::tuple<args...> &t,
-          func&& f)
-{
-	constexpr const ssize_t size
-	{
-		std::tuple_size<std::tuple<args...>>::value
-	};
-
-	rfor_each<size>(t, std::forward<func>(f));
-}
-
-template<ssize_t i = -1,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i == -1), void>::type
-rfor_each(std::tuple<args...> &t,
-          func&& f)
-{
-	constexpr const ssize_t size
-	{
-		std::tuple_size<std::tuple<args...>>::value
-	};
-
-	rfor_each<size>(t, std::forward<func>(f));
-}
-
-//
-// Iteration of a tuple until() style: your closure returns true to continue, false
-// to break. until() then remains true to the end, or returns false if not.
-
-template<size_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == std::tuple_size<std::tuple<args...>>::value, bool>::type
-until(std::tuple<args...> &t,
-      func&& f)
-{
-	return true;
-}
-
-template<size_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == std::tuple_size<std::tuple<args...>>::value, bool>::type
-until(const std::tuple<args...> &t,
-      func&& f)
-{
-	return true;
-}
-
-template<size_t i = 0,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i < std::tuple_size<std::tuple<args...>>::value, bool>::type
-until(std::tuple<args...> &t,
-      func&& f)
-{
-	using value_type = typename std::tuple_element<i, std::tuple<args...>>::type;
-	return f(static_cast<value_type &>(std::get<i>(t)))? until<i+1>(t, f) : false;
-}
-
-template<size_t i = 0,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i < std::tuple_size<std::tuple<args...>>::value, bool>::type
-until(const std::tuple<args...> &t,
-      func&& f)
-{
-	using value_type = typename std::tuple_element<i, std::tuple<args...>>::type;
-	return f(static_cast<const value_type &>(std::get<i>(t)))? until<i+1>(t, f) : false;
-}
-
-//
-// Circuits for reverse iteration of a tuple
-//
-// runtil(tuple, [](auto&& elem) -> bool { ... });
-
-template<ssize_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == 0, bool>::type
-runtil(const std::tuple<args...> &t,
-       func&& f)
-{
-	return true;
-}
-
-template<ssize_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == 0, bool>::type
-runtil(std::tuple<args...> &t,
-       func&& f)
-{
-	return true;
-}
-
-template<ssize_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i > 0), bool>::type
-runtil(const std::tuple<args...> &t,
-       func&& f)
-{
-	return f(std::get<i - 1>(t))? runtil<i - 1>(t, f) : false;
-}
-
-template<ssize_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i > 0), bool>::type
-runtil(std::tuple<args...> &t,
-       func&& f)
-{
-	return f(std::get<i - 1>(t))? runtil<i - 1>(t, f) : false;
-}
-
-template<ssize_t i = -1,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i == -1), bool>::type
-runtil(const std::tuple<args...> &t,
-       func&& f)
-{
-	constexpr const auto size
-	{
-		std::tuple_size<std::tuple<args...>>::value
-	};
-
-	return runtil<size>(t, std::forward<func>(f));
-}
-
-template<ssize_t i = -1,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i == -1), bool>::type
-runtil(std::tuple<args...> &t,
-       func&& f)
-{
-	constexpr const auto size
-	{
-		std::tuple_size<std::tuple<args...>>::value
-	};
-
-	return runtil<size>(t, std::forward<func>(f));
-}
-
-//
-// Kronecker delta
-//
-
-template<size_t j,
-         size_t i,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == j, void>::type
-kronecker_delta(const std::tuple<args...> &t,
-                func&& f)
-{
-	using value_type = typename std::tuple_element<i, std::tuple<args...>>::type;
-	f(static_cast<const value_type &>(std::get<i>(t)));
-}
-
-template<size_t i,
-         size_t j,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<i == j, void>::type
-kronecker_delta(std::tuple<args...> &t,
-                func&& f)
-{
-	using value_type = typename std::tuple_element<i, std::tuple<args...>>::type;
-	f(static_cast<value_type &>(std::get<i>(t)));
-}
-
-template<size_t j,
-         size_t i = 0,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i < j), void>::type
-kronecker_delta(const std::tuple<args...> &t,
-                func&& f)
-{
-	kronecker_delta<j, i + 1>(t, std::forward<func>(f));
-}
-
-template<size_t j,
-         size_t i = 0,
-         class func,
-         class... args>
-constexpr
-typename std::enable_if<(i < j), void>::type
-kronecker_delta(std::tuple<args...> &t,
-                func&& f)
-{
-	kronecker_delta<j, i + 1>(t, std::forward<func>(f));
-}
-
-
 // For conforming enums include a _NUM_ as the last element,
 // then num_of<my_enum>() works
 template<class Enum>
@@ -1142,46 +830,6 @@ struct instance_list
 };
 
 
-//
-// Get the index of a tuple element by address at runtime
-//
-template<class tuple>
-size_t
-indexof(tuple &t, const void *const &ptr)
-{
-	size_t ret(0);
-	const auto closure([&ret, &ptr]
-	(auto &elem)
-	{
-		if(reinterpret_cast<const void *>(std::addressof(elem)) == ptr)
-			return false;
-
-		++ret;
-		return true;
-	});
-
-	if(unlikely(until(t, closure)))
-		throw std::out_of_range("no member of this tuple with that address");
-
-	return ret;
-}
-
-//
-// Tuple layouts are not standard layouts; we can only do this at runtime
-//
-template<size_t index,
-         class tuple>
-off_t
-tuple_offset(const tuple &t)
-{
-	return
-	{
-	      reinterpret_cast<const uint8_t *>(std::addressof(std::get<index>(t))) -
-	      reinterpret_cast<const uint8_t *>(std::addressof(t))
-	};
-}
-
-
 //
 // Compile-time comparison of string literals
 //
@@ -1206,7 +854,6 @@ operator!(const std::string_view &str)
 }
 
 
-
 //
 // Iterator based until() matching std::for_each except the function
 // returns a bool to continue rather than void.