enums.hpp

Go to the documentation of this file.

/* Copyright 2021 - 2026 R. Thomas
 * Copyright 2021 - 2026 Quarkslab
 *
 * 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.
 */
#ifndef LIEF_ENUMS_H
#define LIEF_ENUMS_H
#include <type_traits>
 
#define _LIEF_EN(N)         class N : size_t
#define _LIEF_EN_2(N, TYPE) class N : TYPE
#define _LIEF_EI(X)         X
 
#define ENABLE_BITMASK_OPERATORS(X)                                               \
  template<>                                                                      \
  struct EnableBitMaskOperators<X> {                                              \
    static const bool bit_mask_enabled = true;                                    \
  }
 
template<typename Enum>
struct EnableBitMaskOperators {
  static const bool bit_mask_enabled = false;
};
 
template<typename Enum>
std::enable_if_t<EnableBitMaskOperators<Enum>::bit_mask_enabled, Enum>
    operator|(Enum lhs, Enum rhs) {
  using underlying = std::underlying_type_t<Enum>;
  return static_cast<Enum>(static_cast<underlying>(lhs) |
                           static_cast<underlying>(rhs));
}
 
template<typename Enum>
std::enable_if_t<EnableBitMaskOperators<Enum>::bit_mask_enabled, Enum>
    operator&(Enum lhs, Enum rhs) {
  using underlying = std::underlying_type_t<Enum>;
  return static_cast<Enum>(static_cast<underlying>(lhs) &
                           static_cast<underlying>(rhs));
}
 
template<typename Enum>
std::enable_if_t<EnableBitMaskOperators<Enum>::bit_mask_enabled, Enum>
    operator~(Enum e) {
  using underlying = std::underlying_type_t<Enum>;
  return static_cast<Enum>(~static_cast<underlying>(e));
}
 
template<typename Enum>
std::enable_if_t<EnableBitMaskOperators<Enum>::bit_mask_enabled,
                 std::add_lvalue_reference_t<Enum>>
    operator|=(Enum& lhs, Enum rhs) {
  using underlying = std::underlying_type_t<Enum>;
  lhs = static_cast<Enum>(static_cast<underlying>(lhs) |
                          static_cast<underlying>(rhs));
  return lhs;
}
 
template<typename Enum>
std::enable_if_t<EnableBitMaskOperators<Enum>::bit_mask_enabled,
                 std::add_lvalue_reference_t<Enum>>
    operator&=(Enum& lhs, Enum rhs) {
  using underlying = std::underlying_type_t<Enum>;
  lhs = static_cast<Enum>(static_cast<underlying>(lhs) &
                          static_cast<underlying>(rhs));
  return lhs;
}
 
template<typename Enum>
std::enable_if_t<EnableBitMaskOperators<Enum>::bit_mask_enabled, bool>
    is_true(Enum e) {
  using underlying = std::underlying_type_t<Enum>;
  return static_cast<underlying>(e) > 0;
}
#endif