Rename enum to avoid compilation issue

Author: romainthomas

api/python/lief/MachO/__init__.pyi

@@ -28,9 +28,9 @@ class MACHO_TYPES(enum.Enum):
 
     CIGAM_64 = 3489328638
 
-    FAT_MAGIC = 3405691582
+    MAGIC_FAT = 3405691582
 
-    FAT_CIGAM = 3199925962
+    CIGAM_FAT = 3199925962
 
     NEURAL_MODEL = 3203398350
 

api/python/src/MachO/enums.cpp

@@ -26,12 +26,12 @@ namespace LIEF::MachO::py {
 void init_enums(nb::module_& m) {
 
   enum_<MACHO_TYPES>(m, "MACHO_TYPES")
-    .value(PY_ENUM(MACHO_TYPES::MH_MAGIC))
-    .value(PY_ENUM(MACHO_TYPES::MH_CIGAM))
-    .value(PY_ENUM(MACHO_TYPES::MH_MAGIC_64))
-    .value(PY_ENUM(MACHO_TYPES::MH_CIGAM_64))
-    .value(PY_ENUM(MACHO_TYPES::FAT_MAGIC))
-    .value(PY_ENUM(MACHO_TYPES::FAT_CIGAM))
+    .value(PY_ENUM(MACHO_TYPES::MAGIC))
+    .value(PY_ENUM(MACHO_TYPES::CIGAM))
+    .value(PY_ENUM(MACHO_TYPES::MAGIC_64))
+    .value(PY_ENUM(MACHO_TYPES::CIGAM_64))
+    .value(PY_ENUM(MACHO_TYPES::MAGIC_FAT))
+    .value(PY_ENUM(MACHO_TYPES::CIGAM_FAT))
     .value(PY_ENUM(MACHO_TYPES::NEURAL_MODEL))
   ;
 

doc/sphinx/changelog.rst

@@ -49,6 +49,39 @@
       for rpath in macho.rpaths:
           rpath.path += '/a/very/long/path/that/needs/expansion'
 
+  * To void ``#define`` conflicts with Apple SDK, the following enums have been renamed:
+
+    .. tabs::
+
+       .. tab:: :fa:`brands fa-python` Python
+
+          .. code-block:: diff
+
+            - lief.MachO.FAT_MAGIC
+            + lief.MachO.MAGIC_FAT
+
+            - lief.MachO.FAT_CIGAM
+            + lief.MachO.CIGAM_FAT
+
+
+       .. tab:: :fa:`regular fa-file-code` C++
+
+          .. code-block:: diff
+
+            - MACHO_TYPES::MH_MAGIC
+            - MACHO_TYPES::MH_CIGAM
+            - MACHO_TYPES::MH_MAGIC_64
+            - MACHO_TYPES::MH_CIGAM_64
+            - MACHO_TYPES::FAT_MAGIC
+            - MACHO_TYPES::FAT_CIGAM
+
+            + MACHO_TYPES::MAGIC
+            + MACHO_TYPES::CIGAM
+            + MACHO_TYPES::MAGIC_64
+            + MACHO_TYPES::CIGAM_64
+            + MACHO_TYPES::MAGIC_FAT
+            + MACHO_TYPES::CIGAM_FAT
+
 :ELF:
 
   * LIEF inserted sections are not compatible with a ``strip`` after the

include/LIEF/MachO/BinaryParser.hpp

@@ -269,7 +269,7 @@ class LIEF_API BinaryParser : public LIEF::Parser {
 
   std::unique_ptr<BinaryStream>  stream_;
   std::unique_ptr<Binary>        binary_;
-  MACHO_TYPES                    type_ = MACHO_TYPES::MH_MAGIC_64;
+  MACHO_TYPES                    type_ = MACHO_TYPES::MAGIC_64;
   bool                           is64_ = true;
   ParserConfig                   config_;
   std::set<uint64_t>             visited_;

include/LIEF/MachO/Header.hpp

@@ -195,14 +195,14 @@ class LIEF_API Header : public Object {
 
   /// True if the binary is 32-bit
   bool is_32bit() const {
-    return magic_ == MACHO_TYPES::MH_MAGIC ||
-           magic_ == MACHO_TYPES::MH_CIGAM;
+    return magic_ == MACHO_TYPES::MAGIC ||
+           magic_ == MACHO_TYPES::CIGAM;
   }
 
   /// True if the binary is 64-bit
   bool is_64bit() const {
-    return magic_ == MACHO_TYPES::MH_MAGIC_64 ||
-           magic_ == MACHO_TYPES::MH_CIGAM_64;
+    return magic_ == MACHO_TYPES::MAGIC_64 ||
+           magic_ == MACHO_TYPES::CIGAM_64;
   }
 
   void remove(FLAGS flag);

include/LIEF/MachO/enums.hpp

@@ -21,13 +21,13 @@ namespace LIEF {
 namespace MachO {
 
 enum class MACHO_TYPES: uint32_t {
-  UNKNOWN     = 0,
-  MH_MAGIC    = 0xFEEDFACEu, ///< 32-bit big-endian magic
-  MH_CIGAM    = 0xCEFAEDFEu, ///< 32-bit little-endian magic
-  MH_MAGIC_64 = 0xFEEDFACFu, ///< 64-bit big-endian magic
-  MH_CIGAM_64 = 0xCFFAEDFEu, ///< 64-bit little-endian magic
-  FAT_MAGIC   = 0xCAFEBABEu, ///< big-endian fat magic
-  FAT_CIGAM   = 0xBEBAFECAu,  ///< little-endian fat magic
+  UNKNOWN    = 0,
+  MAGIC      = 0xFEEDFACEu, ///< 32-bit big-endian magic
+  CIGAM      = 0xCEFAEDFEu, ///< 32-bit little-endian magic
+  MAGIC_64   = 0xFEEDFACFu, ///< 64-bit big-endian magic
+  CIGAM_64   = 0xCFFAEDFEu, ///< 64-bit little-endian magic
+  MAGIC_FAT  = 0xCAFEBABEu, ///< big-endian fat magic
+  CIGAM_FAT  = 0xBEBAFECAu,  ///< little-endian fat magic
 
   NEURAL_MODEL = 0xbeeffaceu,
 };

src/Abstract/Header.cpp

@@ -210,14 +210,14 @@ Header Header::from(const MachO::Binary& macho) {
   }
   const MachO::Header& macho_hdr = macho.header();
   const MachO::MACHO_TYPES magic = macho_hdr.magic();
-  if (magic == MachO::MACHO_TYPES::MH_MAGIC_64 ||
-      magic == MachO::MACHO_TYPES::MH_CIGAM_64)
+  if (magic == MachO::MACHO_TYPES::MAGIC_64 ||
+      magic == MachO::MACHO_TYPES::CIGAM_64)
   {
     hdr.modes_ |= MODES::BITS_64;
   }
 
-  if (magic == MachO::MACHO_TYPES::MH_MAGIC ||
-      magic == MachO::MACHO_TYPES::MH_CIGAM)
+  if (magic == MachO::MACHO_TYPES::MAGIC ||
+      magic == MachO::MACHO_TYPES::CIGAM)
   {
     hdr.modes_ |= MODES::BITS_32;
   }

src/MachO/BinaryParser.cpp

@@ -125,16 +125,16 @@ ok_error_t BinaryParser::init_and_parse() {
   }
   const auto type = static_cast<MACHO_TYPES>(*stream_->peek<uint32_t>());
 
-  is64_ = type == MACHO_TYPES::MH_MAGIC_64 ||
-          type == MACHO_TYPES::MH_CIGAM_64 ||
+  is64_ = type == MACHO_TYPES::MAGIC_64 ||
+          type == MACHO_TYPES::CIGAM_64 ||
           type == MACHO_TYPES::NEURAL_MODEL;
 
   binary_->is64_ = is64_;
   type_          = type;
   binary_->original_size_ = stream_->size();
 
-  bool should_swap = type == MACHO_TYPES::MH_CIGAM_64 ||
-                     type == MACHO_TYPES::MH_CIGAM;
+  bool should_swap = type == MACHO_TYPES::CIGAM_64 ||
+                     type == MACHO_TYPES::CIGAM;
 
   stream_->set_endian_swap(should_swap);
 

src/MachO/BinaryParser.tcc

@@ -976,7 +976,7 @@ ok_error_t BinaryParser::parse_load_commands() {
           auto type = static_cast<MACHO_TYPES>(*res_type);
 
           // Fat binary
-          if (type == MACHO_TYPES::FAT_MAGIC || type == MACHO_TYPES::FAT_CIGAM) {
+          if (type == MACHO_TYPES::MAGIC_FAT || type == MACHO_TYPES::CIGAM_FAT) {
             LIEF_ERR("Mach-O is corrupted with a FAT Mach-O inside a fileset ?");
             break;
           }

src/MachO/Builder.cpp

@@ -213,7 +213,7 @@ ok_error_t Builder::build_fat_header() {
 
   std::memset(&header, 0, sizeof(details::fat_header));
 
-  header.magic     = static_cast<uint32_t>(MACHO_TYPES::FAT_CIGAM);
+  header.magic     = static_cast<uint32_t>(MACHO_TYPES::CIGAM_FAT);
   header.nfat_arch = get_swapped_endian<uint32_t>(binaries_.size());
 
   raw_.seekp(0);