EnumBitmaskOps.h

Go to the documentation of this file.

/*
 * Copyright 2022 HEAVY.AI, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <type_traits>

template <typename T>
struct EnableBitmaskOps {
  static constexpr bool enable = false;
};

template <typename T>
typename std::enable_if_t<EnableBitmaskOps<T>::enable, T> constexpr operator&(T lhs,
                                                                              T rhs) {
  using type = typename std::underlying_type_t<T>;
  return static_cast<T>(static_cast<type>(lhs) & static_cast<type>(rhs));
}
template <typename T>
typename std::enable_if_t<EnableBitmaskOps<T>::enable, T> constexpr operator|(T lhs,
                                                                              T rhs) {
  using type = typename std::underlying_type_t<T>;
  return static_cast<T>(static_cast<type>(lhs) | static_cast<type>(rhs));
}
template <typename T>
typename std::enable_if_t<EnableBitmaskOps<T>::enable, T> constexpr operator~(T t) {
  return static_cast<T>(~static_cast<std::underlying_type_t<T>>(t));
}
template <typename T>
typename std::enable_if_t<EnableBitmaskOps<T>::enable, T> constexpr operator|=(T& lhs,
                                                                               T rhs) {
  lhs = lhs | rhs;
  return lhs;
}
template <typename T>
typename std::enable_if_t<EnableBitmaskOps<T>::enable, T> constexpr operator&=(T& lhs,
                                                                               T rhs) {
  lhs = lhs & rhs;
  return lhs;
}

template <typename T>
typename std::enable_if_t<EnableBitmaskOps<T>::enable, bool> constexpr any_bits_set(T t) {
  using type = typename std::underlying_type_t<T>;
  constexpr type zero{};
  return static_cast<type>(t) != zero;
}

#define ENABLE_BITMASK_OPS(x)            \
  template <>                            \
  struct EnableBitmaskOps<x> {           \
    static constexpr bool enable = true; \
  };