flavor_macros.hpp

Go to the documentation of this file.

// === AUDIT STATUS ===
// internal:    { status: not started, auditors: [], date: YYYY-MM-DD }
// external_1:  { status: not started, auditors: [], date: YYYY-MM-DD }
// external_2:  { status: not started, auditors: [], date: YYYY-MM-DD }
// =====================
 
#pragma once
 
// Macros for defining the flavor classes.
// These are used to derive iterator methods along with the body of a 'flavor' class.
// DEFINE_FLAVOR_MEMBERS lets you define a flavor entity as a collection of individual members, and derive an iterator.
// while DEFINE_COMPOUND_GET_ALL lets you combine the iterators of substructures or base
// classes.
 
#include "barretenberg/common/ref_array.hpp"
#include "barretenberg/common/std_array.hpp"
#include "barretenberg/common/std_string.hpp"
#include "barretenberg/common/std_vector.hpp"
 
#include <array>
#include <iostream>
#include <sstream>
#include <tuple>
#include <type_traits>
 
namespace bb::detail {
 
template <typename T, typename... BaseClass> constexpr std::size_t _sum_base_class_size(const T& arg)
{
    return (static_cast<const BaseClass&>(arg).size() + ...);
}
template <typename T, typename... BaseClass> auto _concatenate_base_class_get_all(T& arg)
{
    return concatenate(static_cast<BaseClass&>(arg).get_all()...);
}
template <typename T, typename... BaseClass> auto _concatenate_base_class_get_all_const(const T& arg)
{
    return concatenate(static_cast<const BaseClass&>(arg).get_all()...);
}
template <typename... BaseClass> auto _static_concatenate_base_class_get_labels()
{
    return concatenate(BaseClass::get_labels()...);
}
 
} // namespace bb::detail
 
// Needed to force expansion of __VA_ARGS__ before converting to string.
#define VARARGS_TO_STRING(...) #__VA_ARGS__
 
// We use std::remove_reference to support a flavor that has references as members. This is an AVM use case.
#define DEFINE_REF_VIEW(...)                                                                                           \
    [[nodiscard]] auto get_all()                                                                                       \
    {                                                                                                                  \
        return RefArray<std::remove_reference_t<DataType>, _members_size>{ __VA_ARGS__ };                              \
    }                                                                                                                  \
    [[nodiscard]] auto get_all() const                                                                                 \
    {                                                                                                                  \
        return RefArray<const std::remove_reference_t<DataType>, _members_size>{ __VA_ARGS__ };                        \
    }
 
#define DEFINE_FLAVOR_MEMBERS(DataType, ...)                                                                           \
    __VA_OPT__(DataType __VA_ARGS__;)                                                                                  \
    static constexpr size_t _members_size = std::tuple_size_v<decltype(std::make_tuple(__VA_ARGS__))>;                 \
    DEFINE_REF_VIEW(__VA_ARGS__)                                                                                       \
    static const std::vector<std::string>& get_labels()                                                                \
    {                                                                                                                  \
        static const std::vector<std::string> labels =                                                                 \
            bb::detail::split_and_trim(VARARGS_TO_STRING(__VA_ARGS__), ',');                                           \
        return labels;                                                                                                 \
    }                                                                                                                  \
    static constexpr std::size_t size()                                                                                \
    {                                                                                                                  \
        return _members_size;                                                                                          \
    }
 
#define DEFINE_COMPOUND_GET_ALL(...)                                                                                   \
    [[nodiscard]] auto get_all()                                                                                       \
    {                                                                                                                  \
        return bb::detail::_concatenate_base_class_get_all<decltype(*this), __VA_ARGS__>(*this);                       \
    }                                                                                                                  \
    [[nodiscard]] auto get_all() const                                                                                 \
    {                                                                                                                  \
        return bb::detail::_concatenate_base_class_get_all_const<decltype(*this), __VA_ARGS__>(*this);                 \
    }                                                                                                                  \
    constexpr std::size_t size() const                                                                                 \
    {                                                                                                                  \
        return bb::detail::_sum_base_class_size<decltype(*this), __VA_ARGS__>(*this);                                  \
    }                                                                                                                  \
    static const std::vector<std::string>& get_labels()                                                                \
    {                                                                                                                  \
        static const auto labels = bb::detail::_static_concatenate_base_class_get_labels<__VA_ARGS__>();               \
        return labels;                                                                                                 \
    }